diff --git a/specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.json b/specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.json index cdea4ae70d19..38bf344f842f 100644 --- a/specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.json +++ b/specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.json @@ -1,84 +1,220 @@ { - "openapi": "3.0.0", + "openapi": "3.2.0", "info": { "title": "Microsoft Foundry", "version": "v1" }, "tags": [ { - "name": "Agents" + "name": "Fine-Tuning" }, { - "name": "Agent Session Files" + "name": "Responses Root", + "description": "Responses" }, { - "name": "Agent Invocations" + "name": "Responses", + "parent": "Responses Root", + "description": "Responses (OpenAI)" }, { - "name": "Connections" + "name": "Conversations", + "parent": "Responses Root", + "description": "Conversations (OpenAI)" }, { - "name": "Datasets" + "name": "Agents Root", + "description": "Agents" }, { - "name": "Deployments" + "name": "Agents", + "parent": "Agents Root", + "description": "Agent Management" }, { - "name": "Evaluation Taxonomies" + "name": "Agent Invocations", + "parent": "Agents Root" }, { - "name": "Evaluation Rules" + "name": "Agent Invocations WebSocket", + "parent": "Agents Root", + "description": "Agent Invocations (WebSocket)" }, { - "name": "Evaluators" + "name": "Agent Sessions", + "parent": "Agents Root" }, { - "name": "EvaluatorGenerationJobs" + "name": "Agent Session Files", + "parent": "Agents Root" }, { - "name": "Indexes" + "name": "Agent Versions", + "parent": "Agents Root" }, { - "name": "Insights" + "name": "Agent Containers", + "parent": "Agents Root" }, { - "name": "Models" + "name": "Platform APIs" }, { - "name": "Memory Stores" + "name": "Datasets", + "parent": "Platform APIs" }, { - "name": "Conversations" + "name": "Indexes", + "parent": "Platform APIs" }, { - "name": "Evals" + "name": "Connections", + "parent": "Platform APIs" }, { - "name": "Fine-Tuning" + "name": "Scheduler", + "parent": "Platform APIs" + }, + { + "name": "Fine-tuning", + "parent": "Platform APIs", + "summary": "Fine-Tuning" + }, + { + "name": "Models", + "parent": "Platform APIs" + }, + { + "name": "Memory Stores", + "parent": "Platform APIs" + }, + { + "name": "Chat", + "parent": "Platform APIs" + }, + { + "name": "Assistants", + "parent": "Platform APIs" + }, + { + "name": "Audio", + "parent": "Platform APIs" + }, + { + "name": "Batch", + "parent": "Platform APIs" + }, + { + "name": "Completions", + "parent": "Platform APIs" + }, + { + "name": "Containers", + "parent": "Platform APIs" + }, + { + "name": "Embeddings", + "parent": "Platform APIs" + }, + { + "name": "Files", + "parent": "Platform APIs" + }, + { + "name": "Images", + "parent": "Platform APIs" + }, + { + "name": "Moderations", + "parent": "Platform APIs" + }, + { + "name": "Realtime", + "parent": "Platform APIs" + }, + { + "name": "Threads", + "parent": "Platform APIs" + }, + { + "name": "Uploads", + "parent": "Platform APIs" + }, + { + "name": "Vector stores", + "parent": "Platform APIs", + "summary": "Vector Stores" + }, + { + "name": "Videos", + "parent": "Platform APIs" + }, + { + "name": "Routines", + "parent": "Platform APIs" + }, + { + "name": "Schedules", + "parent": "Platform APIs" + }, + { + "name": "Skills", + "parent": "Platform APIs" }, { - "name": "Responses" + "name": "Toolboxes", + "parent": "Platform APIs" }, { - "name": "Redteams" + "name": "Deployments", + "parent": "Platform APIs" }, { - "name": "Routines" + "name": "DataGenerationJobs", + "parent": "Platform APIs", + "summary": "Data generation jobs" }, { - "name": "Schedules" + "name": "AgentOptimizationJobs", + "parent": "Platform APIs", + "summary": "Agent optimization jobs" }, { - "name": "Skills" + "name": "EvaluatorGenerationJobs", + "parent": "Platform APIs", + "summary": "Evaluator generation jobs" }, { - "name": "Toolboxes" + "name": "Evaluations" }, { - "name": "DataGenerationJobs" + "name": "Evals", + "parent": "Evaluations" }, { - "name": "AgentOptimizationJobs" + "name": "Evaluation Rules", + "parent": "Evaluations" + }, + { + "name": "Evaluators", + "parent": "Evaluations" + }, + { + "name": "Evaluation Taxonomies", + "parent": "Evaluations" + }, + { + "name": "Redteams", + "parent": "Evaluations", + "summary": "Red Teaming" + }, + { + "name": "Evalsuite", + "parent": "Evaluations" + }, + { + "name": "Insights", + "parent": "Evaluations" } ], "paths": { @@ -96,7 +232,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } }, @@ -147,8 +283,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -166,22 +312,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OptimizationJobInputs" + "$ref": "#/components/schemas/OptimizationJob" } } }, - "description": "The optimization job inputs." + "description": "The job to create." }, "x-ms-foundry-meta": { "conditional_previews": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } }, "get": { "operationId": "AgentOptimizationJobs_list", "summary": "Returns a list of agent optimization jobs.", - "description": "List optimization jobs. Supports cursor pagination and optional status / agentName filters.", + "description": "List optimization jobs. Supports cursor pagination and optional status / agent_name filters.", "parameters": [ { "name": "Foundry-Features", @@ -191,7 +337,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } }, @@ -248,7 +394,7 @@ "explode": false }, { - "name": "agentName", + "name": "agent_name", "in": "query", "required": false, "description": "Filter to jobs targeting this agent name.", @@ -283,7 +429,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OptimizationJob" + "$ref": "#/components/schemas/OptimizationJobListItem" }, "description": "The requested list of items." }, @@ -305,8 +451,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -321,7 +477,7 @@ ], "x-ms-foundry-meta": { "conditional_previews": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } } @@ -330,7 +486,7 @@ "get": { "operationId": "AgentOptimizationJobs_get", "summary": "Get info about an agent optimization job.", - "description": "Get an optimization job by id. Returns 202 while in progress, 200 when terminal.", + "description": "Get an optimization job by id.", "parameters": [ { "name": "Foundry-Features", @@ -340,7 +496,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } }, @@ -370,6 +526,7 @@ "headers": { "Retry-After": { "required": false, + "description": "Recommended number of seconds to wait before polling again.", "schema": { "type": "integer", "format": "int32" @@ -384,27 +541,18 @@ } } }, - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Retry-After": { - "required": false, - "schema": { - "type": "integer", - "format": "int32" - } - } - }, + "4XX": { + "description": "Client error", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OptimizationJob" + "$ref": "#/components/schemas/ApiErrorResponse" } } } }, - "default": { - "description": "An unexpected error response.", + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -419,7 +567,7 @@ ], "x-ms-foundry-meta": { "conditional_previews": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } }, @@ -436,7 +584,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } }, @@ -449,16 +597,6 @@ "type": "string" } }, - { - "name": "force", - "in": "query", - "required": false, - "description": "When true, force-delete even if the job is in a non-terminal state.", - "schema": { - "type": "boolean" - }, - "explode": false - }, { "name": "api-version", "in": "query", @@ -474,8 +612,18 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful." }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -490,16 +638,16 @@ ], "x-ms-foundry-meta": { "conditional_previews": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } } }, - "/agent_optimization_jobs/{jobId}/candidates": { - "get": { - "operationId": "AgentOptimizationJobs_listCandidates", - "summary": "Returns a list of candidates for an optimization job.", - "description": "List candidates produced by a job.", + "/agent_optimization_jobs/{jobId}:cancel": { + "post": { + "operationId": "AgentOptimizationJobs_cancel", + "summary": "Cancels an agent optimization job.", + "description": "Request cancellation of a running or queued job. Returns an error if the job is already in a terminal state.", "parameters": [ { "name": "Foundry-Features", @@ -509,7 +657,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } }, @@ -517,11 +665,187 @@ "name": "jobId", "in": "path", "required": true, - "description": "The optimization job id.", + "description": "The ID of the job to cancel.", "schema": { "type": "string" } }, + { + "name": "api-version", + "in": "query", + "required": true, + "description": "The API version to use for this operation.", + "schema": { + "type": "string" + }, + "explode": false + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OptimizationJob" + } + } + } + }, + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "tags": [ + "AgentOptimizationJobs" + ], + "x-ms-foundry-meta": { + "conditional_previews": [ + "AgentsOptimization=V2Preview" + ] + } + } + }, + "/agents": { + "post": { + "operationId": "Agents_createAgent_Agents_createAgentFromCode", + "parameters": [ + { + "name": "Foundry-Features", + "in": "header", + "required": false, + "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", + "schema": { + "$ref": "#/components/schemas/AgentDefinitionOptInKeys" + } + }, + { + "name": "api-version", + "in": "query", + "required": true, + "description": "The API version to use for this operation.", + "schema": { + "type": "string" + }, + "explode": false + }, + { + "name": "x-ms-agent-name", + "in": "header", + "required": false, + "description": "The unique name that identifies the agent. Max 63 chars, must start and end with alphanumeric, hyphens allowed in the middle.", + "schema": { + "type": "string", + "maxLength": 63 + } + }, + { + "name": "x-ms-code-zip-sha256", + "in": "header", + "required": false, + "description": "SHA-256 hex digest of the uploaded code zip. Used for change detection (dedup) and integrity verification.", + "schema": { + "type": "string" + } + } + ], + "description": "Creates a new agent or a new version of an existing agent. Creates a new code-based agent. Uploads the code zip and creates the agent in a single call.\nThe agent name is provided in the `x-ms-agent-name` header since POST /agents has no name in the URL path.\nThe SHA-256 hex digest of the zip is provided in the `x-ms-code-zip-sha256` header for integrity and dedup.\nThe request body is multipart/form-data with a JSON metadata part and a binary code part (part order is irrelevant).\nMaximum upload size is 250 MB.", + "summary": "Create an agent Create a new code-based agent", + "responses": { + "200": { + "description": "The request has succeeded.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AgentObject" + } + } + } + }, + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "x-ms-description-override": "Creates a new agent or a new version of an existing agent.", + "x-ms-summary-override": "Create an agent", + "x-ms-foundry-meta": { + "required_previews": [ + "CodeAgents=V1Preview" + ] + }, + "tags": [ + "Agents" + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateAgentRequest" + } + }, + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/CreateAgentFromCodeContent" + }, + "encoding": { + "metadata": { + "contentType": "application/json" + } + } + } + } + } + }, + "get": { + "operationId": "Agents_listAgents", + "summary": "List agents", + "description": "Returns a paged collection of agent resources.", + "parameters": [ + { + "name": "kind", + "in": "query", + "required": false, + "description": "Filter agents by kind. If not provided, all agents are returned.", + "schema": { + "$ref": "#/components/schemas/AgentKind" + }, + "explode": false + }, { "name": "limit", "in": "query", @@ -590,7 +914,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OptimizationCandidate" + "$ref": "#/components/schemas/AgentObject" }, "description": "The requested list of items." }, @@ -612,166 +936,8 @@ } } }, - "default": { - "description": "An unexpected error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - } - }, - "tags": [ - "AgentOptimizationJobs" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "AgentsOptimization=V1Preview" - ] - } - } - }, - "/agent_optimization_jobs/{jobId}/candidates/{candidateId}": { - "get": { - "operationId": "AgentOptimizationJobs_getCandidate", - "summary": "Get a candidate by id.", - "description": "Get a single candidate's metadata, manifest, and promotion info.", - "parameters": [ - { - "name": "Foundry-Features", - "in": "header", - "required": false, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", - "schema": { - "type": "string", - "enum": [ - "AgentsOptimization=V1Preview" - ] - } - }, - { - "name": "jobId", - "in": "path", - "required": true, - "description": "The optimization job id.", - "schema": { - "type": "string" - } - }, - { - "name": "candidateId", - "in": "path", - "required": true, - "description": "The candidate id.", - "schema": { - "type": "string" - } - }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", - "schema": { - "type": "string" - }, - "explode": false - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CandidateMetadata" - } - } - } - }, - "default": { - "description": "An unexpected error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - } - }, - "tags": [ - "AgentOptimizationJobs" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "AgentsOptimization=V1Preview" - ] - } - } - }, - "/agent_optimization_jobs/{jobId}/candidates/{candidateId}/config": { - "get": { - "operationId": "AgentOptimizationJobs_getCandidateConfig", - "summary": "Get candidate deploy config.", - "description": "Get the candidate's deploy config JSON. Used to compose `agents.create_version(...)` from a candidate.", - "parameters": [ - { - "name": "Foundry-Features", - "in": "header", - "required": false, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", - "schema": { - "type": "string", - "enum": [ - "AgentsOptimization=V1Preview" - ] - } - }, - { - "name": "jobId", - "in": "path", - "required": true, - "description": "The optimization job id.", - "schema": { - "type": "string" - } - }, - { - "name": "candidateId", - "in": "path", - "required": true, - "description": "The candidate id.", - "schema": { - "type": "string" - } - }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", - "schema": { - "type": "string" - }, - "explode": false - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CandidateDeployConfig" - } - } - } - }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", "content": { "application/json": { "schema": { @@ -779,89 +945,9 @@ } } } - } - }, - "tags": [ - "AgentOptimizationJobs" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "AgentsOptimization=V1Preview" - ] - } - } - }, - "/agent_optimization_jobs/{jobId}/candidates/{candidateId}/files": { - "get": { - "operationId": "AgentOptimizationJobs_getCandidateFile", - "summary": "Get a candidate file.", - "description": "Stream a specific file from the candidate's blob directory.", - "parameters": [ - { - "name": "Foundry-Features", - "in": "header", - "required": false, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", - "schema": { - "type": "string", - "enum": [ - "AgentsOptimization=V1Preview" - ] - } - }, - { - "name": "jobId", - "in": "path", - "required": true, - "description": "The optimization job id.", - "schema": { - "type": "string" - } - }, - { - "name": "candidateId", - "in": "path", - "required": true, - "description": "The candidate id.", - "schema": { - "type": "string" - } - }, - { - "name": "path", - "in": "query", - "required": true, - "description": "Relative path of the file to download (e.g. 'files/examples.jsonl').", - "schema": { - "type": "string" - }, - "explode": false - }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", - "schema": { - "type": "string" - }, - "explode": false - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - } - } }, - "default": { - "description": "An unexpected error response.", + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -872,265 +958,23 @@ } }, "tags": [ - "AgentOptimizationJobs" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "AgentsOptimization=V1Preview" - ] - } + "Agents" + ] } }, - "/agent_optimization_jobs/{jobId}/candidates/{candidateId}/results": { + "/agents/{agent_name}": { "get": { - "operationId": "AgentOptimizationJobs_getCandidateResults", - "summary": "Get candidate evaluation results.", - "description": "Get full per-task evaluation results for a candidate.", - "parameters": [ - { - "name": "Foundry-Features", - "in": "header", - "required": false, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", - "schema": { - "type": "string", - "enum": [ - "AgentsOptimization=V1Preview" - ] - } - }, - { - "name": "jobId", - "in": "path", - "required": true, - "description": "The optimization job id.", - "schema": { - "type": "string" - } - }, - { - "name": "candidateId", - "in": "path", - "required": true, - "description": "The candidate id.", - "schema": { - "type": "string" - } - }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", - "schema": { - "type": "string" - }, - "explode": false - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CandidateResults" - } - } - } - }, - "default": { - "description": "An unexpected error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - } - }, - "tags": [ - "AgentOptimizationJobs" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "AgentsOptimization=V1Preview" - ] - } - } - }, - "/agent_optimization_jobs/{jobId}/candidates/{candidateId}:promote": { - "post": { - "operationId": "AgentOptimizationJobs_promoteCandidate", - "summary": "Promote a candidate.", - "description": "Promotes a candidate, recording the deployment timestamp and target agent version.", - "parameters": [ - { - "name": "Foundry-Features", - "in": "header", - "required": false, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", - "schema": { - "type": "string", - "enum": [ - "AgentsOptimization=V1Preview" - ] - } - }, - { - "name": "jobId", - "in": "path", - "required": true, - "description": "The optimization job id.", - "schema": { - "type": "string" - } - }, - { - "name": "candidateId", - "in": "path", - "required": true, - "description": "The candidate id to promote.", - "schema": { - "type": "string" - } - }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", - "schema": { - "type": "string" - }, - "explode": false - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromoteCandidateResponse" - } - } - } - }, - "default": { - "description": "An unexpected error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - } - }, - "tags": [ - "AgentOptimizationJobs" - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromoteCandidateRequest" - } - } - }, - "description": "Promotion details." - }, - "x-ms-foundry-meta": { - "conditional_previews": [ - "AgentsOptimization=V1Preview" - ] - } - } - }, - "/agent_optimization_jobs/{jobId}:cancel": { - "post": { - "operationId": "AgentOptimizationJobs_cancel", - "summary": "Cancels an agent optimization job.", - "description": "Request cancellation. Idempotent on terminal states.", + "operationId": "Agents_getAgent", + "summary": "Get an agent", + "description": "Retrieves an agent definition by its unique name.", "parameters": [ { - "name": "Foundry-Features", - "in": "header", - "required": false, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", - "schema": { - "type": "string", - "enum": [ - "AgentsOptimization=V1Preview" - ] - } - }, - { - "name": "jobId", + "name": "agent_name", "in": "path", "required": true, - "description": "The ID of the job to cancel.", - "schema": { - "type": "string" - } - }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", + "description": "The name of the agent to retrieve.", "schema": { "type": "string" - }, - "explode": false - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OptimizationJob" - } - } - } - }, - "default": { - "description": "An unexpected error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - } - }, - "tags": [ - "AgentOptimizationJobs" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "AgentsOptimization=V1Preview" - ] - } - } - }, - "/agents": { - "post": { - "operationId": "Agents_createAgent_Agents_createAgentFromCode", - "parameters": [ - { - "name": "Foundry-Features", - "in": "header", - "required": false, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", - "schema": { - "$ref": "#/components/schemas/AgentDefinitionOptInKeys" } }, { @@ -1142,28 +986,8 @@ "type": "string" }, "explode": false - }, - { - "name": "x-ms-agent-name", - "in": "header", - "required": false, - "description": "The unique name that identifies the agent. Max 63 chars, must start and end with alphanumeric, hyphens allowed in the middle.", - "schema": { - "type": "string", - "maxLength": 63 - } - }, - { - "name": "x-ms-code-zip-sha256", - "in": "header", - "required": false, - "description": "SHA-256 hex digest of the uploaded code zip. Used for change detection (dedup) and integrity verification.", - "schema": { - "type": "string" - } } ], - "description": "Creates the agent. Creates a new code-based agent. Uploads the code zip and creates the agent in a single call.\nThe agent name is provided in the `x-ms-agent-name` header since POST /agents has no name in the URL path.\nThe SHA-256 hex digest of the zip is provided in the `x-ms-code-zip-sha256` header for integrity and dedup.\nThe request body is multipart/form-data with a JSON metadata part and a binary code part (part order is irrelevant).\nMaximum upload size is 250 MB.", "responses": { "200": { "description": "The request has succeeded.", @@ -1175,8 +999,8 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", "content": { "application/json": { "schema": { @@ -1184,195 +1008,9 @@ } } } - } - }, - "x-ms-foundry-meta": { - "required_previews": [ - "CodeAgents=V1Preview" - ] - }, - "tags": [ - "Agents" - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateAgentRequest" - } - }, - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/CreateAgentFromCodeContent" - }, - "encoding": { - "metadata": { - "contentType": "application/json" - } - } - } - } - } - }, - "get": { - "operationId": "Agents_listAgents", - "description": "Returns the list of all agents.", - "parameters": [ - { - "name": "kind", - "in": "query", - "required": false, - "description": "Filter agents by kind. If not provided, all agents are returned.", - "schema": { - "$ref": "#/components/schemas/AgentKind" - }, - "explode": false }, - { - "name": "limit", - "in": "query", - "required": false, - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", - "schema": { - "type": "integer", - "format": "int32", - "default": 20 - }, - "explode": false - }, - { - "name": "order", - "in": "query", - "required": false, - "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", - "schema": { - "$ref": "#/components/schemas/PageOrder" - }, - "explode": false - }, - { - "name": "after", - "in": "query", - "required": false, - "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", - "schema": { - "type": "string" - }, - "explode": false - }, - { - "name": "before", - "in": "query", - "required": false, - "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "schema": { - "type": "string" - }, - "explode": false - }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", - "schema": { - "type": "string" - }, - "explode": false - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "data", - "has_more" - ], - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AgentObject" - }, - "description": "The requested list of items." - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list." - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list." - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list." - } - }, - "description": "The response data for a requested list of items." - } - } - } - }, - "default": { - "description": "An unexpected error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - } - }, - "tags": [ - "Agents" - ] - } - }, - "/agents/{agent_name}": { - "get": { - "operationId": "Agents_getAgent", - "description": "Retrieves the agent.", - "parameters": [ - { - "name": "agent_name", - "in": "path", - "required": true, - "description": "The name of the agent to retrieve.", - "schema": { - "type": "string" - } - }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", - "schema": { - "type": "string" - }, - "explode": false - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AgentObject" - } - } - } - }, - "default": { - "description": "An unexpected error response.", + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -1428,6 +1066,7 @@ } ], "description": "Updates the agent by adding a new version if there are any changes to the agent definition.\nIf no changes, returns the existing agent version. Updates a code-based agent by uploading new code and creating a new version.\nIf the code and definition are unchanged (matched by x-ms-code-zip-sha256 header), returns the existing version.\nThe request body is multipart/form-data with a JSON metadata part and a binary code part (part order is irrelevant).\nMaximum upload size is 250 MB.", + "summary": "Update an agent Update a code-based agent", "responses": { "200": { "description": "The request has succeeded.", @@ -1439,8 +1078,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -1450,6 +1099,8 @@ } } }, + "x-ms-description-override": "Updates the agent by adding a new version if there are any changes to the agent definition. If no changes, returns the existing agent version.", + "x-ms-summary-override": "Update an agent", "x-ms-foundry-meta": { "required_previews": [ "CodeAgents=V1Preview" @@ -1481,6 +1132,7 @@ }, "delete": { "operationId": "Agents_deleteAgent", + "summary": "Delete an agent", "description": "Deletes an agent. For hosted agents, if any version has active sessions, the request\nis rejected with HTTP 409 unless `force` is set to true. When force is true, all\nassociated sessions are cascade-deleted along with the agent and its versions.", "parameters": [ { @@ -1496,7 +1148,7 @@ "name": "force", "in": "query", "required": false, - "description": "For Hosted Agents, if true, force-deletes the agent even if its versions have active sessions, cascading deletion to all associated sessions. Defaults to `false`. This value is not relevant for other Agent types.", + "description": "For Hosted Agents, if `true`, force-deletes the agent even if its versions have active sessions, cascading deletion to all associated sessions. The service defaults to `false` if a value is not specified by the caller. This value is not relevant for other Agent types.", "schema": { "type": "boolean", "default": false @@ -1525,8 +1177,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -1542,7 +1204,8 @@ }, "patch": { "operationId": "Agents_patchAgentObject", - "description": "Updates an agent endpoint.", + "summary": "Update an agent endpoint", + "description": "Applies a merge-patch update to the specified agent endpoint configuration.", "parameters": [ { "name": "Foundry-Features", @@ -1562,7 +1225,8 @@ "required": true, "description": "The name of the agent to retrieve.", "schema": { - "type": "string" + "type": "string", + "title": "The name of the agent to retrieve" } }, { @@ -1587,8 +1251,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -1621,7 +1295,8 @@ "/agents/{agent_name}/code:download": { "get": { "operationId": "Agents_downloadAgentCode", - "description": "Download the code zip for a code-based hosted agent.\nReturns the previously-uploaded zip (`application/zip`).\n\nIf `agent_version` is supplied, returns that version's code zip; otherwise\nreturns the latest version's code zip.\n\nThe SHA-256 digest of the returned bytes matches the `content_hash` on the\nresolved version's `code_configuration`.", + "summary": "Download agent code", + "description": "Downloads the code zip for a code-based hosted agent.\nReturns the previously-uploaded zip (`application/zip`).\n\nIf `agent_version` is supplied, returns that version's code zip; otherwise\nreturns the latest version's code zip.\n\nThe SHA-256 digest of the returned bytes matches the `content_hash` on the\nresolved version's `code_configuration`.", "parameters": [ { "name": "Foundry-Features", @@ -1680,14 +1355,23 @@ "content": { "application/zip": { "schema": { - "type": "string", - "format": "binary" + "contentMediaType": "application/zip" } } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -1710,6 +1394,7 @@ "/agents/{agent_name}/endpoint/protocols/invocations": { "post": { "operationId": "AgentInvocations_createAgentInvocation", + "summary": "Create an agent invocation", "description": "Creates an invocation for the specified agent version.", "parameters": [ { @@ -1766,109 +1451,130 @@ "responses": { "200": { "description": "The request has succeeded.", - "headers": { - "x-agent-invocation-id": { - "required": true, - "description": "Unique identifier for this invocation.", - "schema": { - "type": "string" - } - }, - "x-agent-session-id": { - "required": true, - "description": "Session ID for this invocation. Returns the provided session ID or an auto-generated one if not provided in the request.", - "schema": { - "type": "string" - } - } - }, - "content": { - "*/*": { - "schema": {} - } - } - }, - "default": { - "description": "An unexpected error response.", + "headers": { + "x-agent-invocation-id": { + "required": true, + "description": "Unique identifier for this invocation.", + "schema": { + "type": "string" + } + }, + "x-agent-session-id": { + "required": true, + "description": "Session ID for this invocation. Returns the provided session ID or an auto-generated one if not provided in the request.", + "schema": { + "type": "string" + } + } + }, + "content": { + "*/*": { + "schema": {} + } + } + }, + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "tags": [ + "Agent Invocations" + ], + "requestBody": { + "required": true, + "content": { + "*/*": { + "schema": {} + } + }, + "description": "The request body." + }, + "x-ms-foundry-meta": { + "required_previews": [ + "HostedAgents=V1Preview" + ] + } + } + }, + "/agents/{agent_name}/endpoint/protocols/invocations/docs/openapi.json": { + "get": { + "operationId": "AgentInvocations_getAgentInvocationOpenApiSpec", + "summary": "Get an agent invocation OpenAPI spec", + "description": "Retrieves the OpenAPI specification for an agent version's invocation contract.\nReturns 404 if the agent does not expose an OpenAPI specification.", + "parameters": [ + { + "name": "agent_name", + "in": "path", + "required": true, + "description": "The name of the agent.", + "schema": { + "type": "string" + } + }, + { + "name": "Foundry-Features", + "in": "header", + "required": true, + "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", + "schema": { + "type": "string", + "enum": [ + "HostedAgents=V1Preview" + ] + } + }, + { + "name": "api-version", + "in": "query", + "required": true, + "description": "The API version to use for this operation.", + "schema": { + "type": "string" + }, + "explode": false + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" + "type": "object", + "unevaluatedProperties": {} } } } - } - }, - "tags": [ - "Agent Invocations" - ], - "requestBody": { - "required": true, - "content": { - "*/*": { - "schema": {} - } - }, - "description": "The request body." - }, - "x-ms-foundry-meta": { - "required_previews": [ - "HostedAgents=V1Preview" - ] - } - } - }, - "/agents/{agent_name}/endpoint/protocols/invocations/docs/openapi.json": { - "get": { - "operationId": "AgentInvocations_getAgentInvocationOpenApiSpec", - "description": "Retrieves the OpenAPI specification for an agent version's invocation contract.\nReturns 404 if the agent does not expose an OpenAPI specification.", - "parameters": [ - { - "name": "agent_name", - "in": "path", - "required": true, - "description": "The name of the agent.", - "schema": { - "type": "string" - } }, - { - "name": "Foundry-Features", - "in": "header", - "required": true, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", - "schema": { - "type": "string", - "enum": [ - "HostedAgents=V1Preview" - ] - } - }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", - "schema": { - "type": "string" - }, - "explode": false - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", + "4XX": { + "description": "Client error", "content": { "application/json": { "schema": { - "type": "object", - "additionalProperties": {} + "$ref": "#/components/schemas/ApiErrorResponse" } } } }, - "default": { - "description": "An unexpected error response.", + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -1891,6 +1597,7 @@ "/agents/{agent_name}/endpoint/protocols/invocations/{invocation_id}": { "get": { "operationId": "AgentInvocations_getAgentInvocation", + "summary": "Get an agent invocation", "description": "Retrieves the invocation with the given ID.\nReturns 404 if the agent does not support this operation or if the invocation ID is not found.", "parameters": [ { @@ -1961,8 +1668,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -1985,6 +1702,7 @@ "/agents/{agent_name}/endpoint/protocols/invocations/{invocation_id}/cancel": { "post": { "operationId": "AgentInvocations_cancelAgentInvocation", + "summary": "Cancel an agent invocation", "description": "Cancels an invocation.\nReturns 404 if the agent does not support this operation or if the invocation ID is not found.", "parameters": [ { @@ -2055,8 +1773,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -2088,6 +1816,7 @@ "/agents/{agent_name}/endpoint/sessions": { "post": { "operationId": "Agents_createSession", + "summary": "Create a session", "description": "Creates a new session for an agent endpoint.\nThe endpoint resolves the backing agent version from `version_indicator` and\nenforces session ownership using the provided isolation key for session-mutating operations.", "parameters": [ { @@ -2142,8 +1871,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -2154,7 +1893,7 @@ } }, "tags": [ - "Agents" + "Agent Sessions" ], "requestBody": { "required": true, @@ -2174,7 +1913,8 @@ }, "get": { "operationId": "Agents_listSessions", - "description": "Returns a list of sessions for the specified agent.", + "summary": "List sessions for an agent", + "description": "Returns a paged collection of sessions associated with the specified agent endpoint.", "parameters": [ { "name": "Foundry-Features", @@ -2296,8 +2036,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -2308,7 +2058,7 @@ } }, "tags": [ - "Agents" + "Agent Sessions" ], "x-ms-foundry-meta": { "required_previews": [ @@ -2320,7 +2070,8 @@ "/agents/{agent_name}/endpoint/sessions/{agent_session_id}/files": { "get": { "operationId": "AgentSessionFiles_listSessionFiles", - "description": "List files and directories at a given path in the session sandbox.\nReturns only the immediate children of the specified directory (non-recursive).", + "summary": "List session files", + "description": "Returns files and directories at the specified path in the session sandbox.\nThe response includes only the immediate children of the target directory and defaults to the session home directory when no path is supplied.", "parameters": [ { "name": "Foundry-Features", @@ -2355,8 +2106,8 @@ { "name": "path", "in": "query", - "required": true, - "description": "The directory path to list, relative to the session home directory.", + "required": false, + "description": "The directory path to list, relative to the session home directory. Defaults to the home directory if not provided.", "schema": { "type": "string" }, @@ -2371,6 +2122,48 @@ "type": "string" } }, + { + "name": "limit", + "in": "query", + "required": false, + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", + "schema": { + "type": "integer", + "format": "int32", + "default": 20 + }, + "explode": false + }, + { + "name": "order", + "in": "query", + "required": false, + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", + "schema": { + "$ref": "#/components/schemas/PageOrder" + }, + "explode": false + }, + { + "name": "after", + "in": "query", + "required": false, + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", + "schema": { + "type": "string" + }, + "explode": false + }, + { + "name": "before", + "in": "query", + "required": false, + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", + "schema": { + "type": "string" + }, + "explode": false + }, { "name": "api-version", "in": "query", @@ -2393,8 +2186,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -2415,7 +2218,8 @@ }, "delete": { "operationId": "AgentSessionFiles_deleteSessionFile", - "description": "Delete a file or directory from the session sandbox.\nIf `recursive` is false (default) and the target is a non-empty directory, the API returns 409 Conflict.", + "summary": "Delete a session file", + "description": "Deletes the specified file or directory from the session sandbox.\nWhen `recursive` is false, deleting a non-empty directory returns 409 Conflict.", "parameters": [ { "name": "Foundry-Features", @@ -2461,7 +2265,7 @@ "name": "recursive", "in": "query", "required": false, - "description": "Whether to recursively delete directory contents. Defaults to false.", + "description": "Whether to recursively delete directory contents. The service defaults to `false` if a value is not specified by the caller.", "schema": { "type": "boolean", "default": false @@ -2492,8 +2296,18 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful. " }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -2516,7 +2330,8 @@ "/agents/{agent_name}/endpoint/sessions/{agent_session_id}/files/content": { "put": { "operationId": "AgentSessionFiles_uploadSessionFile", - "description": "Upload a file to the session sandbox via binary stream.\nMaximum file size is 50 MB. Uploads exceeding this limit return 413 Payload Too Large.", + "summary": "Upload a session file", + "description": "Uploads binary file content to the specified path in the session sandbox.\nThe service stores the file relative to the session home directory and rejects payloads larger than 50 MB.", "parameters": [ { "name": "Foundry-Features", @@ -2589,8 +2404,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -2608,8 +2433,7 @@ "content": { "application/octet-stream": { "schema": { - "type": "string", - "format": "binary" + "contentMediaType": "application/octet-stream" } } } @@ -2622,7 +2446,8 @@ }, "get": { "operationId": "AgentSessionFiles_downloadSessionFile", - "description": "Download a file from the session sandbox as a binary stream.", + "summary": "Download a session file", + "description": "Downloads the file at the specified sandbox path as a binary stream.\nThe path is resolved relative to the session home directory.", "parameters": [ { "name": "Foundry-Features", @@ -2690,14 +2515,23 @@ "content": { "application/octet-stream": { "schema": { - "type": "string", - "format": "binary" + "contentMediaType": "application/octet-stream" } } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -2720,7 +2554,8 @@ "/agents/{agent_name}/endpoint/sessions/{session_id}": { "get": { "operationId": "Agents_getSession", - "description": "Retrieves a session by ID.", + "summary": "Get a session", + "description": "Retrieves the details of a hosted agent session by agent name and session identifier.", "parameters": [ { "name": "Foundry-Features", @@ -2783,8 +2618,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -2795,7 +2640,7 @@ } }, "tags": [ - "Agents" + "Agent Sessions" ], "x-ms-foundry-meta": { "required_previews": [ @@ -2805,6 +2650,7 @@ }, "delete": { "operationId": "Agents_deleteSession", + "summary": "Delete a session", "description": "Deletes a session synchronously.\nReturns 204 No Content when the session is deleted or does not exist.", "parameters": [ { @@ -2861,8 +2707,18 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful." }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -2873,7 +2729,7 @@ } }, "tags": [ - "Agents" + "Agent Sessions" ], "x-ms-foundry-meta": { "required_previews": [ @@ -2885,7 +2741,8 @@ "/agents/{agent_name}/endpoint/sessions/{session_id}:stop": { "post": { "operationId": "Agents_stopSession", - "description": "Stops a session.\nReturns 204 No Content when the stop succeeds.", + "summary": "Stop a session", + "description": "Terminates the specified hosted agent session and returns 204 No Content when the request succeeds.", "parameters": [ { "name": "Foundry-Features", @@ -2932,8 +2789,18 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful." }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -2944,7 +2811,7 @@ } }, "tags": [ - "Agents" + "Agent Sessions" ], "x-ms-foundry-meta": { "required_previews": [ @@ -2956,6 +2823,7 @@ "/agents/{agent_name}/import": { "post": { "operationId": "Agents_updateAgentFromManifest", + "summary": "Update an agent from a manifest", "description": "Updates the agent from a manifest by adding a new version if there are any changes to the agent definition.\nIf no changes, returns the existing agent version.", "parameters": [ { @@ -2989,8 +2857,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -3058,7 +2936,8 @@ } } ], - "description": "Create a new agent version.", + "description": "Creates a new version for the specified agent and returns the created version resource. Creates a new agent version from code. Uploads the code zip and creates a new version\nfor an existing agent. The SHA-256 hex digest of the zip is provided in the\n`x-ms-code-zip-sha256` header for integrity and dedup.\nThe request body is multipart/form-data with a JSON metadata part and a binary code part (part order is irrelevant).\nMaximum upload size is 250 MB.", + "summary": "Create an agent version Create an agent version from code", "responses": { "200": { "description": "The request has succeeded.", @@ -3070,8 +2949,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -3081,13 +2970,15 @@ } } }, + "x-ms-description-override": "Creates a new version for the specified agent and returns the created version resource.", + "x-ms-summary-override": "Create an agent version", "x-ms-foundry-meta": { "required_previews": [ "CodeAgents=V1Preview" ] }, "tags": [ - "Agents" + "Agent Versions" ], "requestBody": { "required": true, @@ -3112,7 +3003,8 @@ }, "get": { "operationId": "Agents_listAgentVersions", - "description": "Returns the list of versions of an agent.", + "summary": "List agent versions", + "description": "Returns a paged collection of versions for the specified agent.", "parameters": [ { "name": "agent_name", @@ -3213,8 +3105,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -3225,14 +3127,15 @@ } }, "tags": [ - "Agents" + "Agent Versions" ] } }, "/agents/{agent_name}/versions/{agent_version}": { "get": { "operationId": "Agents_getAgentVersion", - "description": "Retrieves a specific version of an agent.", + "summary": "Get an agent version", + "description": "Retrieves the specified version of an agent by its agent name and version identifier.", "parameters": [ { "name": "agent_name", @@ -3274,8 +3177,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -3286,11 +3199,12 @@ } }, "tags": [ - "Agents" + "Agent Versions" ] }, "delete": { "operationId": "Agents_deleteAgentVersion", + "summary": "Delete an agent version", "description": "Deletes a specific version of an agent. For hosted agents, if the version has active\nsessions, the request is rejected with HTTP 409 unless `force` is set to true. When\nforce is true, all sessions associated with this version are cascade-deleted.", "parameters": [ { @@ -3315,7 +3229,7 @@ "name": "force", "in": "query", "required": false, - "description": "For Hosted Agents, if true, force-deletes the version even if it has active sessions, cascading deletion to all associated sessions. Defaults to `false`. This value is not relevant for other Agent types.", + "description": "For Hosted Agents, if `true`, force-deletes the version even if it has active sessions, cascading deletion to all associated sessions. The service defaults to `false` if a value is not specified by the caller. This value is not relevant for other Agent types.", "schema": { "type": "boolean", "default": false @@ -3344,8 +3258,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -3356,13 +3280,14 @@ } }, "tags": [ - "Agents" + "Agent Versions" ] } }, "/agents/{agent_name}/versions/{agent_version}/sessions/{session_id}:logstream": { "get": { "operationId": "Agents_getSessionLogStream", + "summary": "Stream console logs for a hosted agent session", "description": "Streams console logs (stdout / stderr) for a specific hosted agent session\nas a Server-Sent Events (SSE) stream.\n\nEach SSE frame contains:\n- `event`: always `\"log\"`\n- `data`: a plain-text log line (currently JSON-formatted, but the schema\nis not contractual and may include additional keys or change format\nover time — clients should treat it as an opaque string)\n\nExample SSE frames:\n```\nevent: log\ndata: {\"timestamp\":\"2026-03-10T09:33:17.121Z\",\"stream\":\"stdout\",\"message\":\"Starting FoundryCBAgent server on port 8088\"}\n\nevent: log\ndata: {\"timestamp\":\"2026-03-10T09:33:17.130Z\",\"stream\":\"stderr\",\"message\":\"INFO: Application startup complete.\"}\n\nevent: log\ndata: {\"timestamp\":\"2026-03-10T09:34:52.714Z\",\"stream\":\"status\",\"message\":\"Successfully connected to container\"}\n\nevent: log\ndata: {\"timestamp\":\"2026-03-10T09:35:52.714Z\",\"stream\":\"status\",\"message\":\"No logs since last 60 seconds\"}\n```\n\nThe stream remains open until the client disconnects or the server\nterminates the connection. Clients should handle reconnection as needed.", "parameters": [ { @@ -3426,8 +3351,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -3438,7 +3373,7 @@ } }, "tags": [ - "Agents" + "Agent Sessions" ], "x-ms-foundry-meta": { "required_previews": [ @@ -3450,7 +3385,8 @@ "/agents/{agent_name}/versions:import": { "post": { "operationId": "Agents_createAgentVersionFromManifest", - "description": "Create a new agent version from a manifest.", + "summary": "Create an agent version from manifest", + "description": "Imports the provided manifest to create a new version for the specified agent.", "parameters": [ { "name": "agent_name", @@ -3484,8 +3420,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -3496,7 +3442,7 @@ } }, "tags": [ - "Agents" + "Agent Versions" ], "requestBody": { "required": true, @@ -3513,7 +3459,8 @@ "/agents:import": { "post": { "operationId": "Agents_createAgentFromManifest", - "description": "Creates an agent from a manifest.", + "summary": "Create an agent from a manifest", + "description": "Imports the provided manifest to create an agent and returns the created resource.", "parameters": [ { "name": "api-version", @@ -3537,8 +3484,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -3566,7 +3523,8 @@ "/connections": { "get": { "operationId": "Connections_list", - "description": "List all connections in the project, without populating connection credentials", + "summary": "List connections", + "description": "Returns the connections available in the current project, optionally filtered by type or default status.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -3575,7 +3533,7 @@ "name": "connectionType", "in": "query", "required": false, - "description": "List connections of this specific type", + "description": "Lists connections of this specific type", "schema": { "$ref": "#/components/schemas/ConnectionType" }, @@ -3585,7 +3543,7 @@ "name": "defaultConnection", "in": "query", "required": false, - "description": "List connections that are default connections", + "description": "Lists connections that are default connections", "schema": { "type": "boolean" }, @@ -3615,8 +3573,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -3643,7 +3620,8 @@ "/connections/{name}": { "get": { "operationId": "Connections_get", - "description": "Get a connection by name, without populating connection credentials", + "summary": "Get a connection", + "description": "Retrieves the specified connection and its configuration details without including credential values.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -3681,8 +3659,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -3709,7 +3706,8 @@ "/connections/{name}/getConnectionWithCredentials": { "post": { "operationId": "Connections_getWithCredentials", - "description": "Get a connection by name, with its connection credentials", + "summary": "Get a connection with credentials", + "description": "Retrieves the specified connection together with its credential values.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -3747,8 +3745,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -3775,7 +3792,7 @@ "/data_generation_jobs": { "get": { "operationId": "DataGenerationJobs_list", - "summary": "Returns a list of data generation jobs", + "summary": "List data generation jobs", "description": "Returns a list of data generation jobs.", "parameters": [ { @@ -3880,8 +3897,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -3902,8 +3929,8 @@ }, "post": { "operationId": "DataGenerationJobs_create", - "summary": "Creates a data generation job.", - "description": "Creates a data generation job.", + "summary": "Create a data generation job", + "description": "Submits a new data generation job for asynchronous execution.", "parameters": [ { "name": "Foundry-Features", @@ -3964,8 +3991,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -3999,8 +4036,8 @@ "/data_generation_jobs/{jobId}": { "get": { "operationId": "DataGenerationJobs_get", - "summary": "Get info about a data generation job.", - "description": "Gets the details of a data generation job by its ID.", + "summary": "Get a data generation job", + "description": "Retrieves the specified data generation job and its current status.", "parameters": [ { "name": "Foundry-Features", @@ -4055,8 +4092,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -4077,8 +4124,8 @@ }, "delete": { "operationId": "DataGenerationJobs_delete", - "summary": "Deletes a data generation job.", - "description": "Deletes a data generation job by its ID.", + "summary": "Delete a data generation job", + "description": "Removes the specified data generation job and its associated output.", "parameters": [ { "name": "Foundry-Features", @@ -4116,8 +4163,18 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful." }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -4140,8 +4197,8 @@ "/data_generation_jobs/{jobId}:cancel": { "post": { "operationId": "DataGenerationJobs_cancel", - "summary": "Cancels a data generation job.", - "description": "Cancels a data generation job by its ID.", + "summary": "Cancel a data generation job", + "description": "Cancels the specified data generation job if it is still in progress.", "parameters": [ { "name": "Foundry-Features", @@ -4186,8 +4243,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -4210,6 +4277,7 @@ "/datasets": { "get": { "operationId": "Datasets_listLatest", + "summary": "List latest versions", "description": "List the latest version of each DatasetVersion", "parameters": [ { @@ -4227,8 +4295,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -4255,6 +4342,7 @@ "/datasets/{name}/versions": { "get": { "operationId": "Datasets_listVersions", + "summary": "List versions", "description": "List all versions of the given DatasetVersion", "parameters": [ { @@ -4281,8 +4369,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -4309,6 +4416,7 @@ "/datasets/{name}/versions/{version}": { "get": { "operationId": "Datasets_getVersion", + "summary": "Get a version", "description": "Get the specific version of the DatasetVersion. The service returns 404 Not Found error if the DatasetVersion does not exist.", "parameters": [ { @@ -4344,8 +4452,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -4370,6 +4497,7 @@ }, "delete": { "operationId": "Datasets_deleteVersion", + "summary": "Delete a version", "description": "Delete the specific version of the DatasetVersion. The service returns 204 No Content if the DatasetVersion was deleted successfully or if the DatasetVersion does not exist.", "parameters": [ { @@ -4398,8 +4526,27 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful." }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -4424,6 +4571,7 @@ }, "patch": { "operationId": "Datasets_createOrUpdateVersion", + "summary": "Create or update a version", "description": "Create a new or update an existing DatasetVersion with the given version id", "parameters": [ { @@ -4469,8 +4617,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -4508,7 +4675,8 @@ "/datasets/{name}/versions/{version}/credentials": { "post": { "operationId": "Datasets_getCredentials", - "description": "Get the SAS credential to access the storage account associated with a Dataset version.", + "summary": "Get dataset credentials", + "description": "Gets the SAS credential to access the storage account associated with a Dataset version.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -4543,8 +4711,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -4571,7 +4758,8 @@ "/datasets/{name}/versions/{version}/startPendingUpload": { "post": { "operationId": "Datasets_startPendingUploadVersion", - "description": "Start a new or get an existing pending upload of a dataset for a specific version.", + "summary": "Start a pending upload", + "description": "Initiates a new pending upload or retrieves an existing one for the specified dataset version.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -4606,8 +4794,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -4645,7 +4852,8 @@ "/deployments": { "get": { "operationId": "Deployments_list", - "description": "List all deployed models in the project", + "summary": "List deployments", + "description": "Returns the deployed models available in the current project, optionally filtered by publisher, model name, or deployment type.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -4704,8 +4912,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -4732,7 +4959,8 @@ "/deployments/{name}": { "get": { "operationId": "Deployments_get", - "description": "Get a deployed model.", + "summary": "Get a deployment", + "description": "Gets a deployed model.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -4770,8 +4998,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -4798,7 +5045,8 @@ "/evaluationrules": { "get": { "operationId": "EvaluationRules_list", - "description": "List all evaluation rules.", + "summary": "List evaluation rules", + "description": "Returns the evaluation rules configured for the project, optionally filtered by action type, agent name, or enabled state.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -4845,8 +5093,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -4873,7 +5140,8 @@ "/evaluationrules/{id}": { "get": { "operationId": "EvaluationRules_get", - "description": "Get an evaluation rule.", + "summary": "Get an evaluation rule", + "description": "Retrieves the specified evaluation rule and its configuration.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -4899,8 +5167,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -4925,7 +5212,8 @@ }, "delete": { "operationId": "EvaluationRules_delete", - "description": "Delete an evaluation rule.", + "summary": "Delete an evaluation rule", + "description": "Removes the specified evaluation rule from the project.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -4944,8 +5232,27 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful." }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -4970,7 +5277,8 @@ }, "put": { "operationId": "EvaluationRules_createOrUpdate", - "description": "Create or update an evaluation rule.", + "summary": "Create or update an evaluation rule", + "description": "Creates a new evaluation rule, or replaces the existing rule when the identifier matches.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -5018,8 +5326,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -5057,7 +5384,8 @@ "/evaluationtaxonomies": { "get": { "operationId": "EvaluationTaxonomies_list", - "description": "List evaluation taxonomies", + "summary": "List evaluation taxonomies", + "description": "Returns the evaluation taxonomies available in the project, optionally filtered by input name or input type.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -5106,8 +5434,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -5134,7 +5481,8 @@ "/evaluationtaxonomies/{name}": { "get": { "operationId": "EvaluationTaxonomies_get", - "description": "Get an evaluation run by name.", + "summary": "Get an evaluation taxonomy", + "description": "Retrieves the specified evaluation taxonomy.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -5172,8 +5520,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -5198,7 +5565,8 @@ }, "delete": { "operationId": "EvaluationTaxonomies_delete", - "description": "Delete an evaluation taxonomy by name.", + "summary": "Delete an evaluation taxonomy", + "description": "Removes the specified evaluation taxonomy from the project.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -5229,8 +5597,27 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful." }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -5255,7 +5642,8 @@ }, "put": { "operationId": "EvaluationTaxonomies_create", - "description": "Create an evaluation taxonomy.", + "summary": "Create an evaluation taxonomy", + "description": "Creates or replaces the specified evaluation taxonomy with the provided definition.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -5303,8 +5691,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -5340,6 +5747,7 @@ }, "patch": { "operationId": "EvaluationTaxonomies_update", + "summary": "Update an evaluation taxonomy", "description": "Update an evaluation taxonomy.", "parameters": [ { @@ -5378,8 +5786,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -5417,7 +5844,7 @@ "/evaluator_generation_jobs": { "post": { "operationId": "EvaluatorGenerationJobs_create", - "summary": "Creates an evaluator generation job.", + "summary": "Create an evaluator generation job", "description": "Creates an evaluator generation job. The service generates rubric-based evaluator\ndefinitions from the provided source materials asynchronously.", "parameters": [ { @@ -5479,8 +5906,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -5512,8 +5949,8 @@ }, "get": { "operationId": "EvaluatorGenerationJobs_list", - "summary": "Returns a list of evaluator generation jobs.", - "description": "Returns a list of evaluator generation jobs.", + "summary": "List evaluator generation jobs", + "description": "Returns a list of evaluator generation jobs. The List API has up to a few\nseconds of propagation delay, so a recently created job may not appear\nimmediately; use the Get evaluator generation job API with the job ID to\nretrieve a specific job without delay.", "parameters": [ { "name": "Foundry-Features", @@ -5617,8 +6054,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -5641,7 +6088,7 @@ "/evaluator_generation_jobs/{jobId}": { "get": { "operationId": "EvaluatorGenerationJobs_get", - "summary": "Get info about an evaluator generation job.", + "summary": "Get an evaluator generation job", "description": "Gets the details of an evaluator generation job by its ID.", "parameters": [ { @@ -5697,8 +6144,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -5719,6 +6176,7 @@ }, "delete": { "operationId": "EvaluatorGenerationJobs_delete", + "summary": "Delete an evaluator generation job", "description": "Deletes an evaluator generation job by its ID. Deletes the job record only;\nthe generated evaluator (if any) is preserved.", "parameters": [ { @@ -5757,8 +6215,18 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful." }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -5781,7 +6249,7 @@ "/evaluator_generation_jobs/{jobId}:cancel": { "post": { "operationId": "EvaluatorGenerationJobs_cancel", - "summary": "Cancels an evaluator generation job.", + "summary": "Cancel an evaluator generation job", "description": "Cancels an evaluator generation job by its ID.", "parameters": [ { @@ -5827,8 +6295,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -5851,7 +6329,8 @@ "/evaluators": { "get": { "operationId": "Evaluators_listLatestVersions", - "description": "List the latest version of each evaluator", + "summary": "List latest evaluator versions", + "description": "Lists the latest version of each evaluator", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -5912,8 +6391,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -5940,7 +6438,8 @@ "/evaluators/{name}/versions": { "get": { "operationId": "Evaluators_listVersions", - "description": "List all versions of the given evaluator", + "summary": "List evaluator versions", + "description": "Returns the available versions for the specified evaluator.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -6010,8 +6509,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -6036,7 +6554,8 @@ }, "post": { "operationId": "Evaluators_createVersion", - "description": "Create a new EvaluatorVersion with auto incremented version id", + "summary": "Create an evaluator version", + "description": "Creates a new evaluator version with an auto-incremented version identifier.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -6074,8 +6593,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -6112,7 +6650,8 @@ "/evaluators/{name}/versions/{version}": { "get": { "operationId": "Evaluators_getVersion", - "description": "Get the specific version of the EvaluatorVersion. The service returns 404 Not Found error if the EvaluatorVersion does not exist.", + "summary": "Get an evaluator version", + "description": "Retrieves the specified evaluator version, returning 404 if it does not exist.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -6159,8 +6698,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -6185,7 +6743,8 @@ }, "delete": { "operationId": "Evaluators_deleteVersion", - "description": "Delete the specific version of the EvaluatorVersion. The service returns 204 No Content if the EvaluatorVersion was deleted successfully or if the EvaluatorVersion does not exist.", + "summary": "Delete an evaluator version", + "description": "Removes the specified evaluator version. Returns 204 whether the version existed or not.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -6225,8 +6784,27 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful." }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -6251,7 +6829,8 @@ }, "patch": { "operationId": "Evaluators_updateVersion", - "description": "Update an existing EvaluatorVersion with the given version id", + "summary": "Update an evaluator version", + "description": "Updates the specified evaluator version in place.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -6298,8 +6877,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -6337,7 +6935,8 @@ "/evaluators/{name}/versions/{version}/credentials": { "post": { "operationId": "Evaluators_getCredentials", - "description": "Get the SAS credential to access the storage account associated with an Evaluator version.", + "summary": "Get evaluator credentials", + "description": "Retrieves SAS credentials for accessing the storage account associated with the specified evaluator version.", "parameters": [ { "name": "Foundry-Features", @@ -6390,8 +6989,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -6425,7 +7034,8 @@ "/evaluators/{name}/versions/{version}/startPendingUpload": { "post": { "operationId": "Evaluators_startPendingUpload", - "description": "Start a new or get an existing pending upload of an evaluator for a specific version.", + "summary": "Start a pending upload", + "description": "Initiates a new pending upload or retrieves an existing one for the specified evaluator version.", "parameters": [ { "name": "Foundry-Features", @@ -6478,8 +7088,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -6513,6 +7133,7 @@ "/indexes": { "get": { "operationId": "Indexes_listLatest", + "summary": "List latest versions", "description": "List the latest version of each Index", "parameters": [ { @@ -6530,8 +7151,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -6558,6 +7198,7 @@ "/indexes/{name}/versions": { "get": { "operationId": "Indexes_listVersions", + "summary": "List versions", "description": "List all versions of the given Index", "parameters": [ { @@ -6584,8 +7225,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -6612,6 +7272,7 @@ "/indexes/{name}/versions/{version}": { "get": { "operationId": "Indexes_getVersion", + "summary": "Get a version", "description": "Get the specific version of the Index. The service returns 404 Not Found error if the Index does not exist.", "parameters": [ { @@ -6647,8 +7308,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -6673,6 +7353,7 @@ }, "delete": { "operationId": "Indexes_deleteVersion", + "summary": "Delete a version", "description": "Delete the specific version of the Index. The service returns 204 No Content if the Index was deleted successfully or if the Index does not exist.", "parameters": [ { @@ -6701,8 +7382,27 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful." }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -6727,6 +7427,7 @@ }, "patch": { "operationId": "Indexes_createOrUpdateVersion", + "summary": "Create or update a version", "description": "Create a new or update an existing Index with the given version id", "parameters": [ { @@ -6772,8 +7473,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -6811,7 +7531,8 @@ "/insights": { "post": { "operationId": "Insights_generate", - "description": "Generate Insights", + "summary": "Generate insights", + "description": "Generates an insights report from the provided evaluation configuration.", "parameters": [ { "name": "Foundry-Features", @@ -6866,8 +7587,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -6894,7 +7625,8 @@ }, "get": { "operationId": "Insights_list", - "description": "List all insights in reverse chronological order (newest first).", + "summary": "List insights", + "description": "Returns insights in reverse chronological order, with the most recent entries first.", "parameters": [ { "name": "Foundry-Features", @@ -6980,8 +7712,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -6999,7 +7741,8 @@ "/insights/{id}": { "get": { "operationId": "Insights_get", - "description": "Get a specific insight by Id.", + "summary": "Get an insight", + "description": "Retrieves the specified insight report and its results.", "parameters": [ { "name": "Foundry-Features", @@ -7054,8 +7797,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -7073,7 +7826,8 @@ "/memory_stores": { "post": { "operationId": "createMemoryStore", - "description": "Create a memory store.", + "summary": "Create a memory store", + "description": "Creates a memory store resource with the provided configuration.", "parameters": [ { "name": "Foundry-Features", @@ -7109,8 +7863,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -7142,7 +7906,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Arbitrary key-value metadata to associate with the memory store." @@ -7172,7 +7936,8 @@ }, "get": { "operationId": "listMemoryStores", - "description": "List all memory stores.", + "summary": "List memory stores", + "description": "Returns the memory stores available to the caller.", "parameters": [ { "name": "Foundry-Features", @@ -7276,8 +8041,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -7300,7 +8075,8 @@ "/memory_stores/{name}": { "post": { "operationId": "updateMemoryStore", - "description": "Update a memory store.", + "summary": "Update a memory store", + "description": "Updates the specified memory store with the supplied configuration changes.", "parameters": [ { "name": "Foundry-Features", @@ -7345,8 +8121,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -7373,7 +8159,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Arbitrary key-value metadata to associate with the memory store." @@ -7391,7 +8177,8 @@ }, "get": { "operationId": "getMemoryStore", - "description": "Retrieve a memory store.", + "summary": "Get a memory store", + "description": "Retrieves the specified memory store and its current configuration.", "parameters": [ { "name": "Foundry-Features", @@ -7436,8 +8223,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -7458,7 +8255,8 @@ }, "delete": { "operationId": "deleteMemoryStore", - "description": "Delete a memory store.", + "summary": "Delete a memory store", + "description": "Deletes the specified memory store.", "parameters": [ { "name": "Foundry-Features", @@ -7503,8 +8301,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -7527,7 +8335,8 @@ "/memory_stores/{name}/items": { "post": { "operationId": "createMemory", - "description": "Create a memory item in a memory store.", + "summary": "Create a memory item", + "description": "Creates a memory item in the specified memory store.", "parameters": [ { "name": "Foundry-Features", @@ -7572,8 +8381,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -7629,7 +8448,8 @@ "/memory_stores/{name}/items/{memory_id}": { "post": { "operationId": "updateMemory", - "description": "Update a memory item in a memory store.", + "summary": "Update a memory item", + "description": "Updates the specified memory item in the memory store.", "parameters": [ { "name": "Foundry-Features", @@ -7683,8 +8503,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -7724,7 +8554,8 @@ }, "get": { "operationId": "getMemory", - "description": "Retrieve a memory item from a memory store.", + "summary": "Get a memory item", + "description": "Retrieves the specified memory item from the memory store.", "parameters": [ { "name": "Foundry-Features", @@ -7778,8 +8609,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -7800,7 +8641,8 @@ }, "delete": { "operationId": "deleteMemory", - "description": "Delete a memory item from a memory store.", + "summary": "Delete a memory item", + "description": "Deletes the specified memory item from the memory store.", "parameters": [ { "name": "Foundry-Features", @@ -7854,8 +8696,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -7878,7 +8730,8 @@ "/memory_stores/{name}/items:list": { "post": { "operationId": "listMemories", - "description": "List all memory items in a memory store.", + "summary": "List memory items", + "description": "Returns memory items from the specified memory store.", "parameters": [ { "name": "Foundry-Features", @@ -8001,8 +8854,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -8044,7 +8907,8 @@ "/memory_stores/{name}/updates/{update_id}": { "get": { "operationId": "getUpdateResult", - "description": "Get memory store update result.", + "summary": "Get an update result", + "description": "Retrieves the status and result of a memory store update operation.", "parameters": [ { "name": "Foundry-Features", @@ -8098,8 +8962,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -8122,7 +8996,8 @@ "/memory_stores/{name}:delete_scope": { "post": { "operationId": "deleteScopeMemories", - "description": "Delete all memories associated with a specific scope from a memory store.", + "summary": "Delete memories by scope", + "description": "Deletes all memories in the specified memory store that are associated with the provided scope.", "parameters": [ { "name": "Foundry-Features", @@ -8167,8 +9042,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -8210,7 +9095,8 @@ "/memory_stores/{name}:search_memories": { "post": { "operationId": "searchMemories", - "description": "Search for relevant memories from a memory store based on conversation context.", + "summary": "Search memories", + "description": "Searches the specified memory store for memories relevant to the provided conversation context.", "parameters": [ { "name": "Foundry-Features", @@ -8255,8 +9141,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -8317,7 +9213,8 @@ "/memory_stores/{name}:update_memories": { "post": { "operationId": "updateMemories", - "description": "Update memory store with conversation memories.", + "summary": "Update memories", + "description": "Starts an update that writes conversation memories into the specified memory store.\nThe operation returns a long-running status location for polling the update result.", "parameters": [ { "name": "Foundry-Features", @@ -8372,8 +9269,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -8432,6 +9339,7 @@ "/models": { "get": { "operationId": "Models_listLatest", + "summary": "List latest versions", "description": "List the latest version of each ModelVersion", "parameters": [ { @@ -8461,8 +9369,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -8489,6 +9416,7 @@ "/models/{name}/versions": { "get": { "operationId": "Models_listVersions", + "summary": "List versions", "description": "List all versions of the given ModelVersion", "parameters": [ { @@ -8527,8 +9455,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -8555,7 +9502,8 @@ "/models/{name}/versions/{version}": { "get": { "operationId": "Models_getVersion", - "description": "Get the specific version of the ModelVersion. The service returns 404 Not Found error if the ModelVersion does not exist.", + "summary": "Get a model version", + "description": "Retrieves the specified model version, returning 404 if it does not exist.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -8602,8 +9550,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -8633,6 +9600,7 @@ }, "delete": { "operationId": "Models_deleteVersion", + "summary": "Delete a model version", "description": "Delete the specific version of the ModelVersion. The service returns 200 OK if the ModelVersion was deleted successfully or if the ModelVersion does not exist.", "parameters": [ { @@ -8673,8 +9641,27 @@ "200": { "description": "The request has succeeded." }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -8704,6 +9691,7 @@ }, "patch": { "operationId": "Models_updateVersion", + "summary": "Update a model version", "description": "Update an existing ModelVersion with the given version id", "parameters": [ { @@ -8761,8 +9749,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -8805,7 +9812,8 @@ "/models/{name}/versions/{version}/createAsync": { "post": { "operationId": "Models_createAsync", - "description": "Creates a model version asynchronously with blob content validation. Returns 202 Accepted with a Location header for polling.", + "summary": "Create a model version async", + "description": "Creates a model version asynchronously with blob content validation. Returns 202 Accepted with a location header for polling the operation status.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -8865,9 +9873,15 @@ "description": "URL to poll for operation status." }, "operationResult": { - "type": "string", - "format": "uri", - "nullable": true, + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ], "description": "URL to the operation result, or null if the operation is still in progress." } } @@ -8875,8 +9889,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -8919,7 +9952,8 @@ "/models/{name}/versions/{version}/credentials": { "post": { "operationId": "Models_getCredentials", - "description": "Get credentials for a model version asset.", + "summary": "Get model asset credentials", + "description": "Retrieves temporary credentials for accessing the storage backing the specified model version.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -8966,8 +10000,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -9009,7 +10062,8 @@ "/models/{name}/versions/{version}/startPendingUpload": { "post": { "operationId": "Models_startPendingUpload", - "description": "Start or retrieve a pending upload for a model version.", + "summary": "Start a pending upload", + "description": "Initiates a new pending upload or retrieves an existing one for the specified model version.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -9056,8 +10110,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -9099,7 +10172,8 @@ "/openai/v1/conversations": { "post": { "operationId": "createConversation", - "description": "Create a conversation.", + "summary": "Create a conversation", + "description": "Creates a new conversation resource.", "parameters": [ { "name": "x-ms-user-isolation-key", @@ -9122,8 +10196,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -9149,7 +10233,8 @@ }, "get": { "operationId": "listConversations", - "description": "Returns the list of all conversations.", + "summary": "List conversations", + "description": "Returns the conversations available in the current project.", "parameters": [ { "name": "limit", @@ -9260,8 +10345,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -9279,7 +10374,8 @@ "/openai/v1/conversations/{conversation_id}": { "post": { "operationId": "updateConversation", - "description": "Update a conversation.", + "summary": "Update a conversation", + "description": "Modifies the specified conversation's properties.", "parameters": [ { "name": "conversation_id", @@ -9311,8 +10407,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -9338,7 +10444,8 @@ }, "get": { "operationId": "getConversation", - "description": "Retrieves a conversation.", + "summary": "Retrieve a conversation", + "description": "Retrieves the specified conversation and its metadata.", "parameters": [ { "name": "conversation_id", @@ -9370,8 +10477,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -9387,7 +10504,8 @@ }, "delete": { "operationId": "deleteConversation", - "description": "Deletes a conversation.", + "summary": "Delete a conversation", + "description": "Removes the specified conversation resource from the current project.", "parameters": [ { "name": "conversation_id", @@ -9419,8 +10537,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -9438,7 +10566,8 @@ "/openai/v1/conversations/{conversation_id}/items": { "post": { "operationId": "createConversationItems", - "description": "Create items in a conversation with the given ID.", + "summary": "Create conversation items", + "description": "Adds one or more items to the specified conversation.", "parameters": [ { "name": "conversation_id", @@ -9483,8 +10612,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -9523,7 +10662,8 @@ }, "get": { "operationId": "listConversationItems", - "description": "List all items for a conversation with the given ID.", + "summary": "List conversation items", + "description": "Returns the items belonging to the specified conversation.", "parameters": [ { "name": "conversation_id", @@ -9633,8 +10773,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -9652,7 +10802,8 @@ "/openai/v1/conversations/{conversation_id}/items/{item_id}": { "get": { "operationId": "getConversationItem", - "description": "Get a single item from a conversation with the given IDs.", + "summary": "Get a conversation item", + "description": "Retrieves a specific item from the specified conversation.", "parameters": [ { "name": "conversation_id", @@ -9693,8 +10844,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -9710,7 +10871,8 @@ }, "delete": { "operationId": "deleteConversationItem", - "description": "Delete an item from a conversation with the given IDs.", + "summary": "Delete a conversation item", + "description": "Removes the specified item from a conversation.", "parameters": [ { "name": "conversation_id", @@ -9751,8 +10913,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -9770,8 +10942,8 @@ "/openai/v1/evals": { "get": { "operationId": "Evals_listEvals", - "summary": "List all evaluations", - "description": "List evaluations for a project.", + "summary": "List evaluations", + "description": "Returns the evaluations configured in the current project.", "parameters": [ { "name": "after", @@ -9789,11 +10961,7 @@ "required": false, "description": "Number of runs to retrieve.", "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/integer" - } - ], + "$ref": "#/components/schemas/integer", "default": 20 }, "explode": false @@ -9865,8 +11033,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -9882,8 +11060,8 @@ }, "post": { "operationId": "Evals_createEval", - "summary": "Create evaluation", - "description": "Create the structure of an evaluation that can be used to test a model's performance.\nAn evaluation is a set of testing criteria and the config for a data source, which dictates the schema of the data used in the evaluation. After creating an evaluation, you can run it on different models and model parameters. We support several types of graders and datasources.\nFor more information, see the [Evals guide](https://platform.openai.com/docs/guides/evals).", + "summary": "Create an evaluation", + "description": "Creates the structure of an evaluation that can be used to test a model's performance.\nAn evaluation is a set of testing criteria and the config for a data source, which dictates the schema of the data used in the evaluation. After creating an evaluation, you can run it on different models and model parameters. We support several types of graders and datasources.\nFor more information, see the [Evals guide](https://platform.openai.com/docs/guides/evals).", "parameters": [], "responses": { "200": { @@ -9896,8 +11074,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -9926,7 +11114,7 @@ "delete": { "operationId": "Evals_deleteEval", "summary": "Delete an evaluation", - "description": "Delete an evaluation.", + "description": "Removes the specified evaluation and its associated data.", "parameters": [ { "name": "eval_id", @@ -9949,8 +11137,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -9967,7 +11165,7 @@ "get": { "operationId": "Evals_getEval", "summary": "Get an evaluation", - "description": "Get an evaluation by ID.", + "description": "Retrieves the specified evaluation and its configuration.", "parameters": [ { "name": "eval_id", @@ -9990,8 +11188,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -10008,7 +11216,7 @@ "post": { "operationId": "Evals_updateEval", "summary": "Update an evaluation", - "description": "Update certain properties of an evaluation.", + "description": "Updates certain properties of an evaluation.", "parameters": [ { "name": "eval_id", @@ -10031,8 +11239,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -10060,8 +11278,8 @@ "/openai/v1/evals/{eval_id}/runs": { "get": { "operationId": "Evals_listRuns", - "summary": "Get a list of runs for an evaluation", - "description": "Get a list of runs for an evaluation.", + "summary": "List evaluation runs", + "description": "Returns the runs associated with the specified evaluation.", "parameters": [ { "name": "eval_id", @@ -10088,11 +11306,7 @@ "required": false, "description": "Number of runs to retrieve.", "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/integer" - } - ], + "$ref": "#/components/schemas/integer", "default": 20 }, "explode": false @@ -10167,8 +11381,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -10184,7 +11408,8 @@ }, "post": { "operationId": "Evals_createEvalRun", - "summary": "Create evaluation run", + "summary": "Create an evaluation run", + "description": "Creates an evaluation run for the specified evaluation.", "parameters": [ { "name": "eval_id", @@ -10207,8 +11432,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -10236,8 +11471,8 @@ "/openai/v1/evals/{eval_id}/runs/{run_id}": { "delete": { "operationId": "Evals_deleteEvalRun", - "summary": "Delete evaluation run", - "description": "Delete an eval run.", + "summary": "Delete an evaluation run", + "description": "Removes the specified evaluation run.", "parameters": [ { "name": "eval_id", @@ -10269,8 +11504,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -10287,7 +11532,7 @@ "get": { "operationId": "Evals_getEvalRun", "summary": "Get an evaluation run", - "description": "Get an evaluation run by ID.", + "description": "Retrieves the specified evaluation run and its current status.", "parameters": [ { "name": "eval_id", @@ -10319,8 +11564,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -10336,8 +11591,8 @@ }, "post": { "operationId": "Evals_cancelEvalRun", - "summary": "Cancel evaluation run", - "description": "Cancel an ongoing evaluation run.", + "summary": "Cancel an evaluation run", + "description": "Cancels an ongoing evaluation run.", "parameters": [ { "name": "eval_id", @@ -10369,8 +11624,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -10388,8 +11653,8 @@ "/openai/v1/evals/{eval_id}/runs/{run_id}/output_items": { "get": { "operationId": "Evals_getEvalRunOutputItems", - "summary": "Get evaluation run output items", - "description": "Get a list of output items for an evaluation run.", + "summary": "List evaluation run output items", + "description": "Returns the output items produced by the specified evaluation run.", "parameters": [ { "name": "eval_id", @@ -10424,11 +11689,7 @@ "required": false, "description": "Number of runs to retrieve.", "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/integer" - } - ], + "$ref": "#/components/schemas/integer", "default": 20 }, "explode": false @@ -10499,8 +11760,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -10519,7 +11790,7 @@ "get": { "operationId": "Evals_getEvalRunOutputItem", "summary": "Get an output item of an evaluation run", - "description": "Get an evaluation run output item by ID.", + "description": "Retrieves a single output item from the specified evaluation run.", "parameters": [ { "name": "eval_id", @@ -10560,8 +11831,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -10579,6 +11860,7 @@ "/openai/v1/fine_tuning/jobs": { "post": { "operationId": "createFineTuningJob", + "summary": "Create a fine-tuning job", "description": "Creates a fine-tuning job which begins the process of creating a new model from a given dataset.\n\nResponse includes details of the enqueued job including job status and the name of the fine-tuned models once complete.\n\n[Learn more about fine-tuning](https://platform.openai.com/docs/guides/fine-tuning)", "parameters": [ { @@ -10603,8 +11885,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -10630,7 +11922,8 @@ }, "get": { "operationId": "listPaginatedFineTuningJobs", - "description": "List your organization's fine-tuning jobs", + "summary": "List fine-tuning jobs", + "description": "Returns the fine-tuning jobs for the current organization.", "parameters": [ { "name": "after", @@ -10676,8 +11969,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -10695,7 +11998,8 @@ "/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}": { "get": { "operationId": "retrieveFineTuningJob", - "description": "Get info about a fine-tuning job.\n\n[Learn more about fine-tuning](https://platform.openai.com/docs/guides/fine-tuning)", + "summary": "Get a fine-tuning job", + "description": "Gets info about a fine-tuning job.\n\n[Learn more about fine-tuning](https://platform.openai.com/docs/guides/fine-tuning)", "parameters": [ { "name": "fine_tuning_job_id", @@ -10728,8 +12032,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -10747,7 +12061,8 @@ "/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel": { "post": { "operationId": "cancelFineTuningJob", - "description": "Immediately cancel a fine-tune job.", + "summary": "Cancel a fine-tuning job", + "description": "Immediately cancels the specified fine-tuning job.", "parameters": [ { "name": "fine_tuning_job_id", @@ -10780,8 +12095,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -10799,7 +12124,8 @@ "/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints": { "get": { "operationId": "listFineTuningJobCheckpoints", - "description": "List checkpoints for a fine-tuning job.", + "summary": "List fine-tuning job checkpoints", + "description": "Returns the checkpoints saved during the specified fine-tuning job.", "parameters": [ { "name": "fine_tuning_job_id", @@ -10854,8 +12180,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -10873,7 +12209,8 @@ "/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events": { "get": { "operationId": "listFineTuningJobEvents", - "description": "Get fine-grained status updates for a fine-tuning job.", + "summary": "List fine-tuning job events", + "description": "Returns the status events emitted during the specified fine-tuning job.", "parameters": [ { "name": "fine_tuning_job_id", @@ -10928,8 +12265,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -10947,7 +12294,8 @@ "/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause": { "post": { "operationId": "pauseFineTuningJob", - "description": "Pause a running fine-tune job.", + "summary": "Pause a fine-tuning job", + "description": "Pauses the specified fine-tuning job while it is running.", "parameters": [ { "name": "fine_tuning_job_id", @@ -10980,8 +12328,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -10999,7 +12357,8 @@ "/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume": { "post": { "operationId": "resumeFineTuningJob", - "description": "Resume a paused fine-tune job.", + "summary": "Resume a fine-tuning job", + "description": "Resumes the specified fine-tuning job after it has been paused.", "parameters": [ { "name": "fine_tuning_job_id", @@ -11032,8 +12391,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -11050,7 +12419,9 @@ }, "/openai/v1/responses": { "post": { - "operationId": "createResponse_createResponseStream", + "operationId": "createResponse", + "summary": "Create a model response", + "description": "Creates a model response. Provide text or image inputs to generate text or JSON outputs. Have the model call your own custom code or use built-in tools like web search or file search to use your own data as input for the model’s response.", "parameters": [ { "name": "x-ms-user-isolation-key", @@ -11062,7 +12433,6 @@ } } ], - "description": "Creates a model response. Creates a model response (streaming response).", "responses": { "200": { "description": "The request has succeeded.", @@ -11078,7 +12448,322 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OpenAI.Response" + "type": "object", + "properties": { + "metadata": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" + } + ] + }, + "top_logprobs": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" + } + ] + }, + "temperature": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.numeric" + }, + { + "type": "null" + } + ], + "default": 1 + }, + "top_p": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.numeric" + }, + { + "type": "null" + } + ], + "default": 1 + }, + "user": { + "type": "string", + "description": "This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations.\n A stable identifier for your end-users.\n Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).", + "deprecated": true + }, + "safety_identifier": { + "type": "string", + "maxLength": 64, + "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." + }, + "prompt_cache_key": { + "type": "string", + "description": "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching)." + }, + "service_tier": { + "$ref": "#/components/schemas/OpenAI.ServiceTier" + }, + "prompt_cache_retention": { + "anyOf": [ + { + "type": "string", + "enum": [ + "in_memory", + "24h" + ] + }, + { + "type": "null" + } + ] + }, + "previous_response_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "model": { + "type": "string", + "description": "The model deployment to use for the creation of this response." + }, + "reasoning": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.Reasoning" + }, + { + "type": "null" + } + ] + }, + "background": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, + "max_tool_calls": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" + } + ] + }, + "text": { + "$ref": "#/components/schemas/OpenAI.ResponseTextParam" + }, + "tools": { + "$ref": "#/components/schemas/OpenAI.ToolsArray" + }, + "tool_choice": { + "oneOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolChoiceOptions" + }, + { + "$ref": "#/components/schemas/OpenAI.ToolChoiceParam" + } + ] + }, + "prompt": { + "$ref": "#/components/schemas/OpenAI.Prompt" + }, + "truncation": { + "anyOf": [ + { + "type": "string", + "enum": [ + "auto", + "disabled" + ] + }, + { + "type": "null" + } + ], + "default": "disabled" + }, + "id": { + "type": "string", + "description": "Unique identifier for this Response." + }, + "object": { + "type": "string", + "enum": [ + "response" + ], + "description": "The object type of this resource - always set to `response`.", + "x-stainless-const": true + }, + "status": { + "type": "string", + "enum": [ + "completed", + "failed", + "in_progress", + "cancelled", + "queued", + "incomplete" + ], + "description": "The status of the response generation. One of `completed`, `failed`,\n `in_progress`, `cancelled`, `queued`, or `incomplete`." + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "Unix timestamp (in seconds) of when this Response was created." + }, + "completed_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "type": "integer", + "format": "unixTimestamp" + }, + "error": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseError" + }, + { + "type": "null" + } + ] + }, + "incomplete_details": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseIncompleteDetails" + }, + { + "type": "null" + } + ] + }, + "output": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.OutputItem" + }, + "description": "An array of content items generated by the model.\n - The length and order of items in the `output` array is dependent\n on the model's response.\n - Rather than accessing the first item in the `output` array and\n assuming it's an `assistant` message with the content generated by\n the model, you might consider using the `output_text` property where\n supported in SDKs." + }, + "instructions": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.InputItem" + } + }, + { + "type": "null" + } + ] + }, + "output_text": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "usage": { + "$ref": "#/components/schemas/OpenAI.ResponseUsage" + }, + "moderation": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.Moderation" + }, + { + "type": "null" + } + ] + }, + "parallel_tool_calls": { + "type": "boolean", + "description": "Whether to allow the model to run tool calls in parallel.", + "default": true + }, + "conversation": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationReference" + }, + { + "type": "null" + } + ] + }, + "max_output_tokens": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" + } + ] + }, + "agent_reference": { + "anyOf": [ + { + "$ref": "#/components/schemas/AgentReference" + }, + { + "type": "null" + } + ], + "description": "The agent used for this response" + }, + "content_filters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ContentFilterResult" + }, + "description": "The content filter evaluation results." + } + }, + "required": [ + "id", + "object", + "created_at", + "error", + "incomplete_details", + "output", + "instructions", + "parallel_tool_calls", + "agent_reference" + ] } }, "text/event-stream": { @@ -11088,8 +12773,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -11107,408 +12802,285 @@ "content": { "application/json": { "schema": { - "anyOf": [ - { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Metadata" - } - ], - "nullable": true - }, - "top_logprobs": { - "type": "integer", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - } - ], - "nullable": true - }, - "temperature": { - "type": "number", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.numeric" - } - ], - "nullable": true, - "default": 1 - }, - "top_p": { - "type": "number", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.numeric" - } - ], - "nullable": true, - "default": 1 - }, - "user": { - "type": "string", - "description": "This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations.\n A stable identifier for your end-users.\n Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).", - "deprecated": true + "type": "object", + "properties": { + "metadata": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.Metadata" }, - "safety_identifier": { - "type": "string", - "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." + { + "type": "null" + } + ] + }, + "top_logprobs": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" }, - "prompt_cache_key": { - "type": "string", - "description": "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching)." + { + "type": "null" + } + ] + }, + "temperature": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.numeric" }, - "service_tier": { - "$ref": "#/components/schemas/OpenAI.ServiceTier" + { + "type": "null" + } + ], + "default": 1 + }, + "top_p": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.numeric" }, - "prompt_cache_retention": { + { + "type": "null" + } + ], + "default": 1 + }, + "user": { + "type": "string", + "description": "This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations.\n A stable identifier for your end-users.\n Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).", + "deprecated": true + }, + "safety_identifier": { + "type": "string", + "maxLength": 64, + "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." + }, + "prompt_cache_key": { + "type": "string", + "description": "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching)." + }, + "service_tier": { + "$ref": "#/components/schemas/OpenAI.ServiceTier" + }, + "prompt_cache_retention": { + "anyOf": [ + { "type": "string", "enum": [ - "in-memory", + "in_memory", "24h" - ], - "nullable": true - }, - "previous_response_id": { - "type": "string", - "nullable": true - }, - "model": { - "type": "string", - "description": "The model deployment to use for the creation of this response." - }, - "reasoning": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Reasoning" - } - ], - "nullable": true - }, - "background": { - "type": "boolean", - "nullable": true - }, - "max_output_tokens": { - "type": "integer", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - } - ], - "nullable": true - }, - "max_tool_calls": { - "type": "integer", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - } - ], - "nullable": true - }, - "text": { - "$ref": "#/components/schemas/OpenAI.ResponseTextParam" - }, - "tools": { - "$ref": "#/components/schemas/OpenAI.ToolsArray" - }, - "tool_choice": { - "oneOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolChoiceOptions" - }, - { - "$ref": "#/components/schemas/OpenAI.ToolChoiceParam" - } ] }, - "prompt": { - "$ref": "#/components/schemas/OpenAI.Prompt" - }, - "truncation": { - "type": "string", - "enum": [ - "auto", - "disabled" - ], - "nullable": true, - "default": "disabled" - }, - "input": { - "$ref": "#/components/schemas/OpenAI.InputParam" - }, - "include": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.IncludeEnum" - }, - "nullable": true - }, - "parallel_tool_calls": { - "type": "boolean", - "nullable": true, - "default": true - }, - "store": { - "type": "boolean", - "nullable": true, - "default": true - }, - "instructions": { - "type": "string", - "nullable": true - }, - "stream": { - "type": "boolean", - "nullable": true - }, - "stream_options": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamOptions" - } - ], - "nullable": true - }, - "conversation": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ConversationParam" - } - ], - "nullable": true - }, - "context_management": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.ContextManagementParam" - }, - "nullable": true, - "description": "Context management configuration for this request." - }, - "agent_reference": { - "allOf": [ - { - "$ref": "#/components/schemas/AgentReference" - } - ], - "description": "The agent to use for generating the response." - }, - "structured_inputs": { - "type": "object", - "additionalProperties": {}, - "description": "The structured inputs to the response that can participate in prompt template substitution or tool argument bindings." + { + "type": "null" } - } + ] }, - { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Metadata" - } - ], - "nullable": true - }, - "top_logprobs": { - "type": "integer", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - } - ], - "nullable": true - }, - "temperature": { - "type": "number", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.numeric" - } - ], - "nullable": true, - "default": 1 - }, - "top_p": { - "type": "number", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.numeric" - } - ], - "nullable": true, - "default": 1 - }, - "user": { - "type": "string", - "description": "This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations.\n A stable identifier for your end-users.\n Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).", - "deprecated": true - }, - "safety_identifier": { - "type": "string", - "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." - }, - "prompt_cache_key": { - "type": "string", - "description": "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching)." - }, - "service_tier": { - "$ref": "#/components/schemas/OpenAI.ServiceTier" - }, - "prompt_cache_retention": { - "type": "string", - "enum": [ - "in-memory", - "24h" - ], - "nullable": true - }, - "previous_response_id": { - "type": "string", - "nullable": true - }, - "model": { - "type": "string", - "description": "The model deployment to use for the creation of this response." - }, - "reasoning": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Reasoning" - } - ], - "nullable": true - }, - "background": { - "type": "boolean", - "nullable": true - }, - "max_output_tokens": { - "type": "integer", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - } - ], - "nullable": true - }, - "max_tool_calls": { - "type": "integer", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - } - ], - "nullable": true + "previous_response_id": { + "anyOf": [ + { + "type": "string" }, - "text": { - "$ref": "#/components/schemas/OpenAI.ResponseTextParam" + { + "type": "null" + } + ] + }, + "model": { + "type": "string", + "description": "The model deployment to use for the creation of this response." + }, + "reasoning": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.Reasoning" }, - "tools": { - "$ref": "#/components/schemas/OpenAI.ToolsArray" + { + "type": "null" + } + ] + }, + "background": { + "anyOf": [ + { + "type": "boolean" }, - "tool_choice": { - "oneOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolChoiceOptions" - }, - { - "$ref": "#/components/schemas/OpenAI.ToolChoiceParam" - } - ] + { + "type": "null" + } + ] + }, + "max_tool_calls": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" }, - "prompt": { - "$ref": "#/components/schemas/OpenAI.Prompt" + { + "type": "null" + } + ] + }, + "text": { + "$ref": "#/components/schemas/OpenAI.ResponseTextParam" + }, + "tools": { + "$ref": "#/components/schemas/OpenAI.ToolsArray" + }, + "tool_choice": { + "oneOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolChoiceOptions" }, - "truncation": { + { + "$ref": "#/components/schemas/OpenAI.ToolChoiceParam" + } + ] + }, + "prompt": { + "$ref": "#/components/schemas/OpenAI.Prompt" + }, + "truncation": { + "anyOf": [ + { "type": "string", "enum": [ "auto", "disabled" - ], - "nullable": true, - "default": "disabled" - }, - "input": { - "$ref": "#/components/schemas/OpenAI.InputParam" + ] }, - "include": { + { + "type": "null" + } + ], + "default": "disabled" + }, + "input": { + "$ref": "#/components/schemas/OpenAI.InputParam" + }, + "include": { + "anyOf": [ + { "type": "array", "items": { "$ref": "#/components/schemas/OpenAI.IncludeEnum" - }, - "nullable": true + } }, - "parallel_tool_calls": { - "type": "boolean", - "nullable": true, - "default": true + { + "type": "null" + } + ] + }, + "parallel_tool_calls": { + "anyOf": [ + { + "type": "boolean" }, - "store": { - "type": "boolean", - "nullable": true, - "default": true + { + "type": "null" + } + ], + "default": true + }, + "store": { + "anyOf": [ + { + "type": "boolean" }, - "instructions": { - "type": "string", - "nullable": true + { + "type": "null" + } + ], + "default": true + }, + "instructions": { + "anyOf": [ + { + "type": "string" }, - "stream": { - "type": "boolean", - "nullable": true + { + "type": "null" + } + ] + }, + "moderation": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.ModerationParam" }, - "stream_options": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamOptions" - } - ], - "nullable": true + { + "type": "null" + } + ] + }, + "stream": { + "anyOf": [ + { + "type": "boolean" }, - "conversation": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ConversationParam" - } - ], - "nullable": true + { + "type": "null" + } + ] + }, + "stream_options": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamOptions" + }, + { + "type": "null" + } + ] + }, + "conversation": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationParam" }, - "context_management": { + { + "type": "null" + } + ] + }, + "context_management": { + "anyOf": [ + { "type": "array", "items": { "$ref": "#/components/schemas/OpenAI.ContextManagementParam" - }, - "nullable": true, - "description": "Context management configuration for this request." + } }, - "agent_reference": { - "allOf": [ - { - "$ref": "#/components/schemas/AgentReference" - } - ], - "description": "The agent to use for generating the response." + { + "type": "null" + } + ], + "description": "Context management configuration for this request." + }, + "max_output_tokens": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" }, - "structured_inputs": { - "type": "object", - "additionalProperties": {}, - "description": "The structured inputs to the response that can participate in prompt template substitution or tool argument bindings." + { + "type": "null" } - } + ] + }, + "agent_reference": { + "allOf": [ + { + "$ref": "#/components/schemas/AgentReference" + } + ], + "description": "The agent to use for generating the response." + }, + "structured_inputs": { + "type": "object", + "unevaluatedProperties": {}, + "description": "The structured inputs to the response that can participate in prompt template substitution or tool argument bindings." } - ] + } } } } @@ -11516,7 +13088,8 @@ }, "get": { "operationId": "listResponses", - "description": "Returns the list of all responses.", + "summary": "List responses", + "description": "Returns a collection of all stored responses matching specified filter criteria.", "parameters": [ { "name": "limit", @@ -11637,8 +13210,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -11656,7 +13239,8 @@ "/openai/v1/responses/compact": { "post": { "operationId": "compactResponseConversation", - "description": "Produces a compaction of a responses conversation.", + "summary": "Compact a conversation", + "description": "Compacts a conversation into a response object suitable for long-running and zero-data-retention scenarios.", "parameters": [], "responses": { "200": { @@ -11669,8 +13253,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -11697,7 +13291,9 @@ }, "/openai/v1/responses/{response_id}": { "get": { - "operationId": "getResponse_getResponseStream", + "operationId": "getResponse", + "summary": "Retrieve a model response", + "description": "Retrieves a model response with the given ID.", "parameters": [ { "name": "response_id", @@ -11747,20 +13343,8 @@ "schema": { "type": "string" } - }, - { - "name": "accept", - "in": "header", - "required": false, - "schema": { - "type": "string", - "enum": [ - "text/event-stream" - ] - } } ], - "description": "Retrieves a model response with the given ID. Retrieves a model response with the given ID (streaming response).", "responses": { "200": { "description": "The request has succeeded.", @@ -11786,8 +13370,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -11803,6 +13397,7 @@ }, "delete": { "operationId": "deleteResponse", + "summary": "Delete a model response", "description": "Deletes a model response.", "parameters": [ { @@ -11844,8 +13439,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -11863,7 +13468,8 @@ "/openai/v1/responses/{response_id}/cancel": { "post": { "operationId": "cancelResponse", - "description": "Cancels a model response.", + "summary": "Cancel a model response", + "description": "Cancels a model response with the given ID. Only responses created with the background parameter set to true can be cancelled.", "parameters": [ { "name": "response_id", @@ -11904,8 +13510,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -11923,7 +13539,8 @@ "/openai/v1/responses/{response_id}/input_items": { "get": { "operationId": "listInputItems", - "description": "Returns a list of input items for a given response.", + "summary": "List input items for a response", + "description": "Retrieves the input items associated with the specified response.", "parameters": [ { "name": "response_id", @@ -12031,8 +13648,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -12050,7 +13677,8 @@ "/redTeams/runs": { "get": { "operationId": "RedTeams_list", - "description": "List a redteam by name.", + "summary": "List redteams", + "description": "Returns the redteams available in the current project.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -12079,8 +13707,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -12107,7 +13754,8 @@ "/redTeams/runs/{name}": { "get": { "operationId": "RedTeams_get", - "description": "Get a redteam by name.", + "summary": "Get a redteam", + "description": "Retrieves the specified redteam and its configuration.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -12145,8 +13793,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -12173,7 +13840,8 @@ "/redTeams/runs:run": { "post": { "operationId": "RedTeams_create", - "description": "Creates a redteam run.", + "summary": "Create a redteam run", + "description": "Submits a new redteam run for execution with the provided configuration.", "parameters": [ { "name": "Foundry-Features", @@ -12209,8 +13877,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -12239,7 +13917,8 @@ "/routines": { "get": { "operationId": "listRoutines", - "description": "List routines.", + "summary": "List routines", + "description": "Returns the routines available in the current project.", "parameters": [ { "name": "Foundry-Features", @@ -12254,46 +13933,16 @@ } }, { - "name": "limit", - "in": "query", - "required": false, - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", - "schema": { - "type": "integer", - "format": "int32", - "default": 20 - }, - "explode": false + "$ref": "#/components/parameters/ListRoutinesParameters.limit" }, { - "name": "order", - "in": "query", - "required": false, - "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", - "schema": { - "$ref": "#/components/schemas/PageOrder" - }, - "explode": false + "$ref": "#/components/parameters/ListRoutinesParameters.after" }, { - "name": "after", - "in": "query", - "required": false, - "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", - "schema": { - "type": "string" - }, - "explode": false + "$ref": "#/components/parameters/ListRoutinesParameters.before" }, { - "name": "before", - "in": "query", - "required": false, - "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "schema": { - "type": "string" - }, - "explode": false + "$ref": "#/components/parameters/ListRoutinesParameters.order" }, { "name": "api-version", @@ -12343,8 +13992,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -12367,7 +14026,8 @@ "/routines/{routine_name}": { "put": { "operationId": "createOrUpdateRoutine", - "description": "Create or update a routine.", + "summary": "Create or update a routine", + "description": "Creates a new routine or replaces an existing routine with the supplied definition.", "parameters": [ { "name": "Foundry-Features", @@ -12406,8 +14066,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -12438,7 +14108,8 @@ }, "get": { "operationId": "getRoutine", - "description": "Retrieve a routine.", + "summary": "Get a routine", + "description": "Retrieves the specified routine and its current configuration.", "parameters": [ { "name": "Foundry-Features", @@ -12477,8 +14148,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -12499,7 +14180,8 @@ }, "delete": { "operationId": "deleteRoutine", - "description": "Delete a routine.", + "summary": "Delete a routine", + "description": "Deletes the specified routine.", "parameters": [ { "name": "Foundry-Features", @@ -12531,8 +14213,18 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful." }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -12555,7 +14247,8 @@ "/routines/{routine_name}/runs": { "get": { "operationId": "listRoutineRuns", - "description": "List prior runs for a routine.", + "summary": "List prior runs for a routine", + "description": "Returns prior runs recorded for the specified routine.", "parameters": [ { "name": "Foundry-Features", @@ -12576,46 +14269,16 @@ "$ref": "#/components/parameters/ListRoutineRunsParameters.filter" }, { - "name": "limit", - "in": "query", - "required": false, - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", - "schema": { - "type": "integer", - "format": "int32", - "default": 20 - }, - "explode": false + "$ref": "#/components/parameters/ListRoutineRunsParameters.limit" }, { - "name": "order", - "in": "query", - "required": false, - "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", - "schema": { - "$ref": "#/components/schemas/PageOrder" - }, - "explode": false + "$ref": "#/components/parameters/ListRoutineRunsParameters.after" }, { - "name": "after", - "in": "query", - "required": false, - "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", - "schema": { - "type": "string" - }, - "explode": false + "$ref": "#/components/parameters/ListRoutineRunsParameters.before" }, { - "name": "before", - "in": "query", - "required": false, - "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "schema": { - "type": "string" - }, - "explode": false + "$ref": "#/components/parameters/ListRoutineRunsParameters.order" }, { "name": "api-version", @@ -12665,8 +14328,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -12689,7 +14362,8 @@ "/routines/{routine_name}:disable": { "post": { "operationId": "disableRoutine", - "description": "Disable a routine.", + "summary": "Disable a routine", + "description": "Disables the specified routine so it no longer runs.", "parameters": [ { "name": "Foundry-Features", @@ -12728,8 +14402,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -12752,7 +14436,8 @@ "/routines/{routine_name}:dispatch_async": { "post": { "operationId": "dispatchRoutineAsync", - "description": "Queue an asynchronous routine dispatch.", + "summary": "Queue an asynchronous routine dispatch", + "description": "Queues an asynchronous dispatch for the specified routine.", "parameters": [ { "name": "Foundry-Features", @@ -12791,8 +14476,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -12825,7 +14520,8 @@ "/routines/{routine_name}:enable": { "post": { "operationId": "enableRoutine", - "description": "Enable a routine.", + "summary": "Enable a routine", + "description": "Enables the specified routine so it can be dispatched.", "parameters": [ { "name": "Foundry-Features", @@ -12864,8 +14560,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -12888,7 +14594,8 @@ "/schedules": { "get": { "operationId": "Schedules_list", - "description": "List all schedules.", + "summary": "List schedules", + "description": "Returns schedules that match the supplied type and enabled filters.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -12937,8 +14644,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -12965,7 +14691,8 @@ "/schedules/{id}": { "delete": { "operationId": "Schedules_delete", - "description": "Delete a schedule.", + "summary": "Delete a schedule", + "description": "Deletes the specified schedule resource.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -12996,8 +14723,27 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful." }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -13022,7 +14768,8 @@ }, "get": { "operationId": "Schedules_get", - "description": "Get a schedule by id.", + "summary": "Get a schedule", + "description": "Retrieves the specified schedule resource.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -13060,8 +14807,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -13086,7 +14852,8 @@ }, "put": { "operationId": "Schedules_createOrUpdate", - "description": "Create or update operation template.", + "summary": "Create or update a schedule", + "description": "Creates a new schedule or updates an existing schedule with the supplied definition.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -13134,8 +14901,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -13173,7 +14959,8 @@ "/schedules/{id}/runs": { "get": { "operationId": "Schedules_listRuns", - "description": "List all schedule runs.", + "summary": "List schedule runs", + "description": "Returns schedule runs that match the supplied filters.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -13231,8 +15018,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -13259,7 +15065,8 @@ "/schedules/{schedule_id}/runs/{run_id}": { "get": { "operationId": "Schedules_getRun", - "description": "Get a schedule run by id.", + "summary": "Get a schedule run", + "description": "Retrieves the specified run for a schedule.", "parameters": [ { "name": "schedule_id", @@ -13313,8 +15120,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -13332,7 +15149,8 @@ "/skills": { "get": { "operationId": "Skills_listSkills", - "description": "Returns the list of all skills.", + "summary": "List skills", + "description": "Returns the skills available in the current project.", "parameters": [ { "name": "limit", @@ -13436,8 +15254,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -13460,7 +15288,8 @@ "/skills/{name}": { "get": { "operationId": "Skills_getSkill", - "description": "Retrieves a skill.", + "summary": "Retrieve a skill", + "description": "Retrieves the specified skill and its current configuration.", "parameters": [ { "name": "name", @@ -13505,8 +15334,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -13527,7 +15366,8 @@ }, "post": { "operationId": "updateSkill", - "description": "Update a skill.", + "summary": "Update a skill", + "description": "Modifies the specified skill's configuration.", "parameters": [ { "name": "name", @@ -13572,8 +15412,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -13613,7 +15463,8 @@ }, "delete": { "operationId": "Skills_deleteSkill", - "description": "Deletes a skill.", + "summary": "Delete a skill", + "description": "Removes the specified skill and its associated versions.", "parameters": [ { "name": "name", @@ -13658,8 +15509,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -13682,7 +15543,8 @@ "/skills/{name}/content": { "get": { "operationId": "getSkillContent", - "description": "Download the zip content for the default version of a skill.", + "summary": "Download the zip content for the default version of a skill", + "description": "Downloads the zip content for the default version of a skill.", "parameters": [ { "name": "name", @@ -13718,87 +15580,107 @@ ], "responses": { "200": { - "description": "The response body for downloading a skill package.", - "content": { - "application/zip": { - "schema": { - "type": "string", - "format": "binary" - } - } - } - }, - "default": { - "description": "An unexpected error response.", + "description": "The response body for downloading a skill package.", + "content": { + "application/zip": { + "schema": { + "contentMediaType": "application/zip" + } + } + } + }, + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "tags": [ + "Skills" + ], + "x-ms-foundry-meta": { + "required_previews": [ + "Skills=V1Preview" + ] + } + } + }, + "/skills/{name}/versions": { + "post": { + "operationId": "createSkillVersion_createSkillVersionFromFiles", + "parameters": [ + { + "name": "name", + "in": "path", + "required": true, + "description": "The name of the skill. If the skill does not exist, it will be created.", + "schema": { + "$ref": "#/components/schemas/SkillName" + } + }, + { + "name": "Foundry-Features", + "in": "header", + "required": true, + "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", + "schema": { + "type": "string", + "enum": [ + "Skills=V1Preview" + ] + } + }, + { + "name": "api-version", + "in": "query", + "required": true, + "description": "The API version to use for this operation.", + "schema": { + "type": "string" + }, + "explode": false + } + ], + "description": "Creates a new version of a skill. If the skill does not exist, it will be created. Creates a new version of a skill from uploaded files via multipart form data.", + "summary": "Create a new version of a skill Create a skill version from uploaded files", + "responses": { + "200": { + "description": "The request has succeeded.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" + "$ref": "#/components/schemas/SkillVersion" } } } - } - }, - "tags": [ - "Skills" - ], - "x-ms-foundry-meta": { - "required_previews": [ - "Skills=V1Preview" - ] - } - } - }, - "/skills/{name}/versions": { - "post": { - "operationId": "createSkillVersion_createSkillVersionFromFiles", - "parameters": [ - { - "name": "name", - "in": "path", - "required": true, - "description": "The name of the skill. If the skill does not exist, it will be created.", - "schema": { - "$ref": "#/components/schemas/SkillName" - } - }, - { - "name": "Foundry-Features", - "in": "header", - "required": true, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", - "schema": { - "type": "string", - "enum": [ - "Skills=V1Preview" - ] - } }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", - "schema": { - "type": "string" - }, - "explode": false - } - ], - "description": "Creates a new version of a skill. If the skill does not exist, it will be created. Creates a new version of a skill from uploaded files via multipart form data.", - "responses": { - "200": { - "description": "The request has succeeded.", + "4XX": { + "description": "Client error", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SkillVersion" + "$ref": "#/components/schemas/ApiErrorResponse" } } } }, - "default": { - "description": "An unexpected error response.", + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -13808,6 +15690,8 @@ } } }, + "x-ms-description-override": "Creates a new version of a skill. If the skill does not exist, it will be created.", + "x-ms-summary-override": "Create a new version of a skill", "x-ms-foundry-meta": { "required_previews": [ "Skills=V1Preview" @@ -13856,7 +15740,8 @@ }, "get": { "operationId": "listSkillVersions", - "description": "List all versions of a skill.", + "summary": "List skill versions", + "description": "Returns the available versions for the specified skill.", "parameters": [ { "name": "name", @@ -13969,8 +15854,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -13993,7 +15888,8 @@ "/skills/{name}/versions/{version}": { "get": { "operationId": "getSkillVersion", - "description": "Retrieve a specific version of a skill.", + "summary": "Retrieve a specific version of a skill", + "description": "Retrieves the specified version of a skill by name and version identifier.", "parameters": [ { "name": "name", @@ -14047,8 +15943,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -14069,7 +15975,8 @@ }, "delete": { "operationId": "deleteSkillVersion", - "description": "Delete a specific version of a skill.", + "summary": "Delete a specific version of a skill", + "description": "Removes the specified version of a skill.", "parameters": [ { "name": "name", @@ -14123,8 +16030,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -14147,7 +16064,8 @@ "/skills/{name}/versions/{version}/content": { "get": { "operationId": "getSkillVersionContent", - "description": "Download the zip content for a specific version of a skill.", + "summary": "Download the zip content for a specific version of a skill", + "description": "Downloads the zip content for a specific version of a skill.", "parameters": [ { "name": "name", @@ -14196,14 +16114,23 @@ "content": { "application/zip": { "schema": { - "type": "string", - "format": "binary" + "contentMediaType": "application/zip" } } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -14226,7 +16153,8 @@ "/toolboxes": { "get": { "operationId": "listToolboxes", - "description": "List all toolboxes.", + "summary": "List toolboxes", + "description": "Returns the toolboxes available in the current project.", "parameters": [ { "name": "limit", @@ -14270,6 +16198,18 @@ }, "explode": false }, + { + "name": "Foundry-Features", + "in": "header", + "required": true, + "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", + "schema": { + "type": "string", + "enum": [ + "Toolboxes=V1Preview" + ] + } + }, { "name": "api-version", "in": "query", @@ -14318,8 +16258,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -14331,13 +16281,19 @@ }, "tags": [ "Toolboxes" - ] + ], + "x-ms-foundry-meta": { + "conditional_previews": [ + "Toolboxes=V1Preview" + ] + } } }, "/toolboxes/{name}": { "get": { "operationId": "getToolbox", - "description": "Retrieve a toolbox.", + "summary": "Retrieve a toolbox", + "description": "Retrieves the specified toolbox and its current configuration.", "parameters": [ { "name": "name", @@ -14348,6 +16304,18 @@ "type": "string" } }, + { + "name": "Foundry-Features", + "in": "header", + "required": true, + "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", + "schema": { + "type": "string", + "enum": [ + "Toolboxes=V1Preview" + ] + } + }, { "name": "api-version", "in": "query", @@ -14370,8 +16338,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -14383,15 +16361,33 @@ }, "tags": [ "Toolboxes" - ] + ], + "x-ms-foundry-meta": { + "conditional_previews": [ + "Toolboxes=V1Preview" + ] + } }, "patch": { "operationId": "updateToolbox", - "description": "Update a toolbox to point to a specific version.", + "summary": "Update a toolbox to point to a specific version", + "description": "Updates the toolbox's default version pointer to the specified version.", "parameters": [ { "$ref": "#/components/parameters/UpdateToolboxRequest.name" }, + { + "name": "Foundry-Features", + "in": "header", + "required": true, + "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", + "schema": { + "type": "string", + "enum": [ + "Toolboxes=V1Preview" + ] + } + }, { "name": "api-version", "in": "query", @@ -14414,8 +16410,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -14437,11 +16443,17 @@ } } } + }, + "x-ms-foundry-meta": { + "conditional_previews": [ + "Toolboxes=V1Preview" + ] } }, "delete": { "operationId": "deleteToolbox", - "description": "Delete a toolbox and all its versions.", + "summary": "Delete a toolbox", + "description": "Removes the specified toolbox along with all of its versions.", "parameters": [ { "name": "name", @@ -14452,6 +16464,18 @@ "type": "string" } }, + { + "name": "Foundry-Features", + "in": "header", + "required": true, + "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", + "schema": { + "type": "string", + "enum": [ + "Toolboxes=V1Preview" + ] + } + }, { "name": "api-version", "in": "query", @@ -14467,8 +16491,18 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful. " }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -14480,13 +16514,19 @@ }, "tags": [ "Toolboxes" - ] + ], + "x-ms-foundry-meta": { + "conditional_previews": [ + "Toolboxes=V1Preview" + ] + } } }, "/toolboxes/{name}/versions": { "post": { "operationId": "createToolboxVersion", - "description": "Create a new version of a toolbox. If the toolbox does not exist, it will be created.", + "summary": "Create a new version of a toolbox", + "description": "Creates a new toolbox version, provisioning the toolbox itself if it does not already exist.", "parameters": [ { "name": "name", @@ -14498,6 +16538,18 @@ "maxLength": 256 } }, + { + "name": "Foundry-Features", + "in": "header", + "required": true, + "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", + "schema": { + "type": "string", + "enum": [ + "Toolboxes=V1Preview" + ] + } + }, { "name": "api-version", "in": "query", @@ -14520,8 +16572,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -14548,7 +16610,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Arbitrary key-value metadata to associate with the toolbox." @@ -14582,11 +16644,17 @@ } } } + }, + "x-ms-foundry-meta": { + "conditional_previews": [ + "Toolboxes=V1Preview" + ] } }, "get": { "operationId": "listToolboxVersions", - "description": "List all versions of a toolbox.", + "summary": "List toolbox versions", + "description": "Returns the available versions for the specified toolbox.", "parameters": [ { "name": "name", @@ -14639,6 +16707,18 @@ }, "explode": false }, + { + "name": "Foundry-Features", + "in": "header", + "required": true, + "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", + "schema": { + "type": "string", + "enum": [ + "Toolboxes=V1Preview" + ] + } + }, { "name": "api-version", "in": "query", @@ -14687,8 +16767,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -14700,13 +16790,19 @@ }, "tags": [ "Toolboxes" - ] + ], + "x-ms-foundry-meta": { + "conditional_previews": [ + "Toolboxes=V1Preview" + ] + } } }, "/toolboxes/{name}/versions/{version}": { "get": { "operationId": "getToolboxVersion", - "description": "Retrieve a specific version of a toolbox.", + "summary": "Retrieve a specific version of a toolbox", + "description": "Retrieves the specified version of a toolbox by name and version identifier.", "parameters": [ { "name": "name", @@ -14726,6 +16822,18 @@ "type": "string" } }, + { + "name": "Foundry-Features", + "in": "header", + "required": true, + "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", + "schema": { + "type": "string", + "enum": [ + "Toolboxes=V1Preview" + ] + } + }, { "name": "api-version", "in": "query", @@ -14748,8 +16856,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -14761,11 +16879,17 @@ }, "tags": [ "Toolboxes" - ] + ], + "x-ms-foundry-meta": { + "conditional_previews": [ + "Toolboxes=V1Preview" + ] + } }, "delete": { "operationId": "deleteToolboxVersion", - "description": "Delete a specific version of a toolbox.", + "summary": "Delete a specific version of a toolbox", + "description": "Removes the specified version of a toolbox.", "parameters": [ { "name": "name", @@ -14785,6 +16909,18 @@ "type": "string" } }, + { + "name": "Foundry-Features", + "in": "header", + "required": true, + "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", + "schema": { + "type": "string", + "enum": [ + "Toolboxes=V1Preview" + ] + } + }, { "name": "api-version", "in": "query", @@ -14800,8 +16936,18 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful. " }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -14813,7 +16959,12 @@ }, "tags": [ "Toolboxes" - ] + ], + "x-ms-foundry-meta": { + "conditional_previews": [ + "Toolboxes=V1Preview" + ] + } } } }, @@ -14906,6 +17057,26 @@ "maxLength": 128 } }, + "ListRoutineRunsParameters.after": { + "name": "after", + "in": "query", + "required": false, + "description": "An opaque cursor returned as last_id by the previous list-runs response.", + "schema": { + "type": "string" + }, + "explode": false + }, + "ListRoutineRunsParameters.before": { + "name": "before", + "in": "query", + "required": false, + "description": "Unsupported. Reserved for future backward pagination support.", + "schema": { + "type": "string" + }, + "explode": false + }, "ListRoutineRunsParameters.filter": { "name": "filter", "in": "query", @@ -14916,6 +17087,27 @@ }, "explode": false }, + "ListRoutineRunsParameters.limit": { + "name": "limit", + "in": "query", + "required": false, + "description": "The maximum number of runs to return.", + "schema": { + "type": "integer", + "format": "int32" + }, + "explode": false + }, + "ListRoutineRunsParameters.order": { + "name": "order", + "in": "query", + "required": false, + "description": "The ordering direction. Supported values are asc and desc.", + "schema": { + "type": "string" + }, + "explode": false + }, "ListRoutineRunsParameters.routine_name": { "name": "routine_name", "in": "path", @@ -14926,6 +17118,47 @@ "maxLength": 128 } }, + "ListRoutinesParameters.after": { + "name": "after", + "in": "query", + "required": false, + "description": "An opaque cursor returned as last_id by the previous list response.", + "schema": { + "type": "string" + }, + "explode": false + }, + "ListRoutinesParameters.before": { + "name": "before", + "in": "query", + "required": false, + "description": "Unsupported. Reserved for future backward pagination support.", + "schema": { + "type": "string" + }, + "explode": false + }, + "ListRoutinesParameters.limit": { + "name": "limit", + "in": "query", + "required": false, + "description": "The maximum number of routines to return.", + "schema": { + "type": "integer", + "format": "int32" + }, + "explode": false + }, + "ListRoutinesParameters.order": { + "name": "order", + "in": "query", + "required": false, + "description": "The ordering direction. Supported values are asc and desc.", + "schema": { + "type": "string" + }, + "explode": false + }, "UpdateToolboxRequest.name": { "name": "name", "in": "path", @@ -14989,8 +17222,7 @@ "type": "string", "enum": [ "a2a_preview" - ], - "description": "The type of the tool. Always `\"a2a_preview`." + ] }, "base_url": { "type": "string", @@ -15671,23 +17903,6 @@ ], "description": "A trace source that selects traces by agent reference with time-based filtering." }, - "AgentIdentifier": { - "type": "object", - "required": [ - "agentName" - ], - "properties": { - "agentName": { - "type": "string", - "description": "Registered Foundry agent name (required)." - }, - "agentVersion": { - "type": "string", - "description": "Pinned agent version. Defaults to latest if omitted." - } - }, - "description": "Identifies the registered Foundry agent to optimize (request-only). Skills, tools, and systemPrompt are specified in options.optimizationConfig." - }, "AgentIdentity": { "type": "object", "required": [ @@ -15842,6 +18057,7 @@ "enum": [ "activity_protocol", "responses", + "a2a", "mcp", "invocations", "invocations_ws" @@ -15943,7 +18159,6 @@ "idle", "updating", "failed", - "stopping", "deleting", "deleted", "expired" @@ -16041,11 +18256,17 @@ ], "properties": { "metadata": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "nullable": true, + "anyOf": [ + { + "type": "object", + "unevaluatedProperties": { + "type": "string" + } + }, + { + "type": "null" + } + ], "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "x-oaiTypeLabel": "map" }, @@ -16907,8 +19128,7 @@ "type": "string", "enum": [ "azure_ai_search" - ], - "description": "The object type, which is always 'azure_ai_search'." + ] }, "azure_ai_search": { "allOf": [ @@ -17390,7 +19610,7 @@ }, "parameters": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The parameters the functions accepts, described as a JSON Schema object." } }, @@ -18174,160 +20394,6 @@ }, "description": "Definition of input parameters for the Browser Automation Tool." }, - "CandidateDeployConfig": { - "type": "object", - "properties": { - "instructions": { - "type": "string", - "description": "System prompt / instructions." - }, - "model": { - "type": "string", - "description": "Foundry deployment name." - }, - "temperature": { - "type": "number", - "format": "float", - "minimum": 0, - "maximum": 2, - "description": "Optional sampling temperature." - }, - "skills": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": {} - }, - "description": "Optional skill overrides." - }, - "tools": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": {} - }, - "description": "Optional tool overrides." - } - }, - "description": "Deploy-config blob for a candidate. Suitable for setting OPTIMIZATION_CONFIG on a hosted-agent version." - }, - "CandidateFileInfo": { - "type": "object", - "required": [ - "path", - "type", - "sizeBytes" - ], - "properties": { - "path": { - "type": "string", - "description": "Relative path of the file." - }, - "type": { - "type": "string", - "description": "File type category (e.g. 'config', 'results')." - }, - "sizeBytes": { - "type": "integer", - "format": "int64", - "description": "File size in bytes." - } - }, - "description": "File entry in a candidate's blob directory." - }, - "CandidateMetadata": { - "type": "object", - "required": [ - "candidateId", - "jobId", - "candidateName", - "status", - "hasResults", - "createdAt", - "updatedAt", - "files" - ], - "properties": { - "candidateId": { - "type": "string", - "description": "Server-assigned candidate identifier." - }, - "jobId": { - "type": "string", - "description": "Owning optimization job id." - }, - "candidateName": { - "type": "string", - "description": "Display name of the candidate." - }, - "status": { - "type": "string", - "description": "Candidate lifecycle status." - }, - "score": { - "type": "number", - "format": "double", - "description": "Candidate's aggregate score." - }, - "hasResults": { - "type": "boolean", - "description": "Whether detailed results are available for this candidate." - }, - "createdAt": { - "allOf": [ - { - "$ref": "#/components/schemas/FoundryTimestamp" - } - ], - "description": "Timestamp when the candidate was created, represented in Unix time." - }, - "updatedAt": { - "allOf": [ - { - "$ref": "#/components/schemas/FoundryTimestamp" - } - ], - "description": "Timestamp when the candidate was last updated, represented in Unix time." - }, - "promotion": { - "allOf": [ - { - "$ref": "#/components/schemas/PromotionInfo" - } - ], - "description": "Promotion metadata. Null if not promoted." - }, - "files": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CandidateFileInfo" - }, - "description": "Files in the candidate's blob directory." - } - }, - "description": "Candidate metadata returned by GET /candidates/{id}." - }, - "CandidateResults": { - "type": "object", - "required": [ - "candidateId", - "results" - ], - "properties": { - "candidateId": { - "type": "string", - "description": "Owning candidate id." - }, - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OptimizationTaskResult" - }, - "description": "Per-task evaluation rows." - } - }, - "description": "Full per-task evaluation results for a candidate, returned by GET /candidates/{id}/results." - }, "CaptureStructuredOutputsTool": { "type": "object", "required": [ @@ -18442,7 +20508,7 @@ }, "coordinates": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/ChartCoordinate" }, "description": " Optional mapping of IDs to 2D coordinates used by the UX for visualization.\n\n The map keys are string identifiers (for example, a cluster id or a sample id)\n and the values are the coordinates and visual size for rendering on a 2D chart.\n\n This property is omitted unless the client requests coordinates (for example,\n by passing `includeCoordinates=true` as a query parameter).\n\n Example:\n ```\n {\n \"cluster-1\": { \"x\": 12, \"y\": 34, \"size\": 8 },\n \"sample-123\": { \"x\": 18, \"y\": 22, \"size\": 4 }\n }\n ```\n\n Coordinates are intended only for client-side visualization and do not\n modify the canonical insights results." @@ -18594,9 +20660,7 @@ "type": "string", "enum": [ "code_interpreter" - ], - "description": "The type of the code interpreter tool. Always `code_interpreter`.", - "x-stainless-const": true + ] }, "container": { "anyOf": [ @@ -18698,7 +20762,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Metadata of the connection", @@ -18739,7 +20803,9 @@ "image": { "type": "string", "description": "The container image for the hosted agent.", - "example": "my-registry.azurecr.io/my-hosted-agent:latest" + "examples": [ + "my-registry.azurecr.io/my-hosted-agent:latest" + ] } }, "description": "Container-based deployment configuration for a hosted agent.", @@ -18801,6 +20867,14 @@ "type": "integer", "format": "int32", "description": "Maximum number of evaluation runs allowed per hour." + }, + "samplingRate": { + "type": "number", + "format": "double", + "maximum": 100, + "description": "Percentage (0-100] chance that a matching event triggers an evaluation. When omitted, the service-default is to evaluate every event, which is equivalent to setting a sampling rate of 100.", + "exclusiveMinimum": 0, + "default": 100 } }, "allOf": [ @@ -18842,7 +20916,7 @@ }, "data_mapping": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Mapping from source fields to response_id field, which is required for retrieving chat history." @@ -18946,8 +21020,6 @@ "description": "JSON metadata including description and hosted definition." }, "code": { - "type": "string", - "format": "binary", "description": "The code zip file (max 250 MB)." } }, @@ -18971,7 +21043,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -18988,7 +21060,7 @@ }, "parameter_values": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The inputs to the manifest that will result in a fully materialized Agent." } } @@ -19007,7 +21079,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -19121,8 +21193,6 @@ "description": "JSON metadata including description and hosted definition." }, "code": { - "type": "string", - "format": "binary", "description": "The code zip file (max 250 MB)." } }, @@ -19144,7 +21214,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -19175,7 +21245,7 @@ "properties": { "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -19192,7 +21262,7 @@ }, "parameter_values": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The inputs to the manifest that will result in a fully materialized Agent." } } @@ -19205,7 +21275,7 @@ "properties": { "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -19267,13 +21337,14 @@ "description": "The name of the evaluation." }, "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "data_source_config": { "oneOf": [ @@ -19323,7 +21394,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of immutable 16 key-value pairs that can be attached to an object for storing additional information.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters." @@ -19342,13 +21413,14 @@ "description": "The name of the run." }, "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "data_source": { "oneOf": [ @@ -19369,7 +21441,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of immutable 16 key-value pairs that can be attached to an object for storing additional information.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters." @@ -19391,10 +21463,7 @@ "properties": { "files": { "type": "array", - "items": { - "type": "string", - "format": "binary" - }, + "items": {}, "description": "Skill files to upload. Upload a single zip file or multiple individual files with relative paths." }, "default": { @@ -19478,7 +21547,7 @@ "readOnly": true } }, - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "allOf": [ @@ -19488,6 +21557,49 @@ ], "description": "Custom credential definition" }, + "CustomRoutineTrigger": { + "type": "object", + "required": [ + "type", + "provider", + "parameters" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "custom" + ], + "description": "The trigger type." + }, + "provider": { + "type": "string", + "maxLength": 128, + "description": "The external provider that emits the custom event." + }, + "event_name": { + "type": "string", + "maxLength": 256, + "description": "The provider-specific event name that fires the routine." + }, + "parameters": { + "type": "object", + "unevaluatedProperties": {}, + "description": "Provider-specific trigger parameters." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/RoutineTrigger" + } + ], + "description": "A custom event routine trigger.", + "x-ms-foundry-meta": { + "conditional_previews": [ + "Routines=V1Preview" + ] + } + }, "DailyRecurrenceSchedule": { "type": "object", "required": [ @@ -19717,7 +21829,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tags to assign to the output. Applies only to dataset outputs (evaluation scenario); ignored for Azure OpenAI file outputs." @@ -19903,13 +22015,15 @@ }, "schema": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The overall object JSON schema for the run data source items." } }, "discriminator": { "propertyName": "type", - "mapping": {} + "mapping": { + "azure_ai_source": "#/components/schemas/AzureAIDataSourceConfig" + } }, "description": "Base class for run data sources with discriminator support." }, @@ -19948,7 +22062,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary of the output dataset.", @@ -19996,50 +22110,6 @@ ], "description": "Dataset source for evaluator generation jobs — reference to a dataset." }, - "DatasetInfo": { - "type": "object", - "required": [ - "taskCount", - "isInline" - ], - "properties": { - "name": { - "type": "string", - "description": "Dataset name when using a registered dataset reference. Null for inline datasets." - }, - "version": { - "type": "string", - "description": "Dataset version when using a registered dataset reference. Null for inline datasets." - }, - "taskCount": { - "type": "integer", - "format": "int32", - "description": "Number of tasks/rows in the dataset." - }, - "isInline": { - "type": "boolean", - "description": "True when the dataset was provided inline in the request body." - } - }, - "description": "Metadata about the dataset used for optimization, surfaced in the response." - }, - "DatasetRef": { - "type": "object", - "required": [ - "name" - ], - "properties": { - "name": { - "type": "string", - "description": "Dataset name." - }, - "version": { - "type": "string", - "description": "Dataset version. If not specified, the latest version is used." - } - }, - "description": "Reference to a registered dataset in the Foundry Dataset Service." - }, "DatasetReference": { "type": "object", "required": [ @@ -20150,7 +22220,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -20505,7 +22575,7 @@ }, "always_applicable": { "type": "boolean", - "description": "When true, the LLM judge always scores this dimension regardless of relevance (skips applicability assessment). The service-generated general quality/policy dimension has this set to true and is non-editable. Users may set this on their own custom dimensions. Defaults to `false`.", + "description": "When true, the LLM judge always scores this dimension regardless of relevance (skips applicability assessment). The service-generated general quality/policy dimension has this set to true and is non-editable. Users may set this on their own custom dimensions. The service defaults to `false` if a value is not specified by the caller.", "default": false } }, @@ -20712,13 +22782,14 @@ "description": "The Unix timestamp (in seconds) for when the eval was created." }, "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "modified_at": { "allOf": [ @@ -20734,7 +22805,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of immutable 16 key-value pairs that can be attached to an object for storing additional information.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters." @@ -20926,13 +22997,14 @@ "description": "Information about the run's data source." }, "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "error": { "$ref": "#/components/schemas/OpenAI.EvalApiError" @@ -20951,7 +23023,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of immutable 16 key-value pairs that can be attached to an object for storing additional information.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters." @@ -21055,7 +23127,7 @@ }, "datasource_item": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "Details of the input data source item." }, "results": { @@ -21111,9 +23183,15 @@ "description": "Whether the grader considered the output a pass." }, "sample": { - "type": "object", - "additionalProperties": {}, - "nullable": true, + "anyOf": [ + { + "type": "object", + "unevaluatedProperties": {} + }, + { + "type": "null" + } + ], "description": "Optional sample or intermediate data produced by the grader." }, "status": { @@ -21143,13 +23221,13 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Additional details about the test criteria metric." } }, - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "A single grader result for an evaluation run output item.", "title": "EvalRunOutputItemResult" }, @@ -21505,7 +23583,7 @@ }, "systemData": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "System metadata for the evaluation rule.", @@ -21668,6 +23746,7 @@ }, "evalRun": { "type": "object", + "unevaluatedProperties": {}, "description": "The evaluation run payload." } }, @@ -21718,7 +23797,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Additional properties for the evaluation taxonomy." @@ -21738,7 +23817,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -21760,7 +23839,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Additional properties for the evaluation taxonomy." @@ -21838,7 +23917,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -21860,7 +23939,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Additional properties for the evaluation taxonomy." @@ -21919,17 +23998,17 @@ }, "init_parameters": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The JSON schema (Draft 2020-12) for the evaluator's input parameters. This includes parameters like type, properties, required." }, "data_schema": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The JSON schema (Draft 2020-12) for the evaluator's input data. This includes parameters like type, properties, required." }, "metrics": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/EvaluatorMetric" }, "description": "List of output metrics produced by this evaluator" @@ -22294,7 +24373,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Metadata about the evaluator" @@ -22314,6 +24393,16 @@ }, "description": "The categories of the evaluator" }, + "supported_evaluation_levels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EvaluationLevel" + }, + "description": "Evaluation levels this evaluator supports (e.g., `turn`, `conversation`). When omitted on create, the service defaults to `[\"turn\"]`. On update, omitting this field leaves it unchanged; an empty list is rejected. Custom code-based evaluators support only `turn`; custom prompt-based evaluators support exactly one level (`turn` or `conversation`).", + "default": [ + "turn" + ] + }, "definition": { "allOf": [ { @@ -22378,7 +24467,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Metadata about the evaluator" @@ -22398,6 +24487,16 @@ }, "description": "The categories of the evaluator" }, + "supported_evaluation_levels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EvaluationLevel" + }, + "description": "Evaluation levels this evaluator supports (e.g., `turn`, `conversation`). When omitted on create, the service defaults to `[\"turn\"]`. On update, omitting this field leaves it unchanged; an empty list is rejected. Custom code-based evaluators support only `turn`; custom prompt-based evaluators support exactly one level (`turn` or `conversation`).", + "default": [ + "turn" + ] + }, "definition": { "allOf": [ { @@ -22412,7 +24511,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -22429,7 +24528,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Metadata about the evaluator" @@ -22441,13 +24540,23 @@ }, "description": "The categories of the evaluator" }, + "supported_evaluation_levels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EvaluationLevel" + }, + "description": "Evaluation levels this evaluator supports (e.g., `turn`, `conversation`). When omitted on create, the service defaults to `[\"turn\"]`. On update, omitting this field leaves it unchanged; an empty list is rejected. Custom code-based evaluators support only `turn`; custom prompt-based evaluators support exactly one level (`turn` or `conversation`).", + "default": [ + "turn" + ] + }, "description": { "type": "string", "description": "The asset description text." }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -22609,17 +24718,13 @@ "require_approval": { "anyOf": [ { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" - } - ], - "nullable": true + "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" }, { - "type": "string", - "nullable": true + "type": "string" + }, + { + "type": "null" } ], "description": "(Optional) Whether the agent requires approval before executing actions. Default is always.", @@ -22652,8 +24757,7 @@ "type": "string", "enum": [ "fabric_iq_preview" - ], - "description": "The object type, which is always 'fabric_iq_preview'." + ] }, "project_connection_id": { "type": "string", @@ -22671,17 +24775,13 @@ "require_approval": { "anyOf": [ { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" - } - ], - "nullable": true + "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" }, { - "type": "string", - "nullable": true + "type": "string" + }, + { + "type": "null" } ], "description": "(Optional) Whether the agent requires approval before executing actions. Default is always.", @@ -22806,10 +24906,7 @@ "type": "string", "enum": [ "file_search" - ], - "description": "The type of the file search tool. Always `file_search`.", - "x-stainless-const": true, - "default": "file_search" + ] }, "max_num_results": { "allOf": [ @@ -22828,12 +24925,14 @@ "description": "Ranking options for search." }, "filters": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Filters" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "vector_store_ids": { "type": "array", @@ -23059,19 +25158,40 @@ }, "description": "Details of a function tool call." }, - "GitHubIssueOpenedRoutineTrigger": { + "GitHubIssueEvent": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "opened", + "closed" + ] + } + ], + "description": "Known GitHub issue events that can fire a routine.", + "x-ms-foundry-meta": { + "conditional_previews": [ + "Routines=V1Preview" + ] + } + }, + "GitHubIssueRoutineTrigger": { "type": "object", "required": [ "type", "connection_id", - "assignee", - "repository" + "owner", + "repository", + "issue_event" ], "properties": { "type": { "type": "string", "enum": [ - "github_issue_opened" + "github_issue" ], "description": "The trigger type." }, @@ -23080,15 +25200,23 @@ "maxLength": 256, "description": "The workspace connection identifier that resolves the GitHub configuration for the trigger." }, - "assignee": { + "owner": { "type": "string", "maxLength": 128, - "description": "The GitHub assignee or organization filter that scopes which issues can fire the trigger." + "description": "The GitHub owner or organization that scopes which issues can fire the trigger." }, "repository": { "type": "string", "maxLength": 128, "description": "The GitHub repository filter that scopes which issues can fire the trigger." + }, + "issue_event": { + "allOf": [ + { + "$ref": "#/components/schemas/GitHubIssueEvent" + } + ], + "description": "The GitHub issue event that fires the routine." } }, "allOf": [ @@ -23096,7 +25224,7 @@ "$ref": "#/components/schemas/RoutineTrigger" } ], - "description": "A GitHub issue-opened routine trigger.", + "description": "A GitHub issue routine trigger.", "x-ms-foundry-meta": { "conditional_previews": [ "Routines=V1Preview" @@ -23146,17 +25274,23 @@ "header_name": { "type": "string", "description": "The name of the HTTP header to inject the secret value into.", - "example": "X-Otlp-Api-Key" + "examples": [ + "X-Otlp-Api-Key" + ] }, "secret_id": { "type": "string", "description": "The identifier of the secret store or connection.", - "example": "my-secret-store" + "examples": [ + "my-secret-store" + ] }, "secret_key": { "type": "string", "description": "The key within the secret to retrieve the authentication value.", - "example": "OTLP_KEY" + "examples": [ + "OTLP_KEY" + ] } }, "allOf": [ @@ -23195,23 +25329,29 @@ "cpu": { "type": "string", "description": "The CPU configuration for the hosted agent.", - "example": "0.25" + "examples": [ + "0.25" + ] }, "memory": { "type": "string", "description": "The memory configuration for the hosted agent.", - "example": "0.5Gi" + "examples": [ + "0.5Gi" + ] }, "environment_variables": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Environment variables to set in the hosted agent container.", - "example": { - "name": "LOG_LEVEL", - "value": "debug" - } + "examples": [ + { + "name": "LOG_LEVEL", + "value": "debug" + } + ] }, "container_configuration": { "allOf": [ @@ -23232,15 +25372,17 @@ "$ref": "#/components/schemas/ProtocolVersionRecord" }, "description": "The protocols that the agent supports for ingress communication.", - "example": [ - { - "protocol": "responses", - "version": "v0.1.1" - }, - { - "protocol": "a2a", - "version": "v0.3.0" - } + "examples": [ + [ + { + "protocol": "responses", + "version": "v0.1.1" + }, + { + "protocol": "a2a", + "version": "v0.3.0" + } + ] ], "x-ms-foundry-meta": { "required_previews": [ @@ -23408,7 +25550,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -23620,12 +25762,12 @@ }, "features": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "Features to help with additional filtering of data in UX." }, "correlationInfo": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "Info about the correlation for the analysis sample." } }, @@ -23744,7 +25886,8 @@ "InvokeAgentInvocationsApiDispatchPayload": { "type": "object", "required": [ - "type" + "type", + "input" ], "properties": { "type": { @@ -23755,9 +25898,7 @@ "description": "The manual dispatch payload type." }, "input": { - "type": "string", - "maxLength": 32768, - "description": "The raw input sent to the downstream invocations target." + "description": "The JSON value sent as the complete downstream invocations input. The value is passed through as-is and can be an object, string, number, boolean, array, or null." } }, "allOf": [ @@ -23775,8 +25916,7 @@ "InvokeAgentInvocationsApiRoutineAction": { "type": "object", "required": [ - "type", - "agent_endpoint_id" + "type" ], "properties": { "type": { @@ -23786,10 +25926,18 @@ ], "description": "The action type." }, + "agent_name": { + "type": "string", + "maxLength": 256, + "description": "The project-scoped agent name for routine dispatch." + }, "agent_endpoint_id": { "type": "string", "maxLength": 256, - "description": "The endpoint-scoped agent identifier for invocations API dispatch." + "description": "Legacy endpoint-scoped agent identifier for routine dispatch." + }, + "input": { + "description": "Static JSON value sent as the complete downstream input when the routine fires. The value is passed through as-is; no templating is applied." }, "session_id": { "type": "string", @@ -23802,7 +25950,7 @@ "$ref": "#/components/schemas/RoutineAction" } ], - "description": "Dispatches a routine through the raw invocations API.", + "description": "Dispatches a routine through the raw invocations API. Exactly one of agent_name or agent_endpoint_id must be provided.", "x-ms-foundry-meta": { "conditional_previews": [ "Routines=V1Preview" @@ -23812,7 +25960,8 @@ "InvokeAgentResponsesApiDispatchPayload": { "type": "object", "required": [ - "type" + "type", + "input" ], "properties": { "type": { @@ -23823,9 +25972,7 @@ "description": "The manual dispatch payload type." }, "input": { - "type": "string", - "maxLength": 32768, - "description": "The user input sent to the downstream responses target." + "description": "The JSON value sent as the complete downstream responses input. The value is passed through as-is and can be an object, string, number, boolean, array, or null." } }, "allOf": [ @@ -23856,14 +26003,17 @@ "agent_name": { "type": "string", "maxLength": 256, - "description": "The project-scoped agent name for responses API dispatch." + "description": "The project-scoped agent name for routine dispatch." }, "agent_endpoint_id": { "type": "string", "maxLength": 256, - "description": "The endpoint-scoped agent identifier for responses API dispatch." + "description": "Legacy endpoint-scoped agent identifier for routine dispatch." }, - "conversation_id": { + "input": { + "description": "Static JSON value sent as the complete downstream input when the routine fires. The value is passed through as-is; no templating is applied." + }, + "conversation": { "type": "string", "maxLength": 256, "description": "An optional existing conversation identifier to continue during the downstream dispatch." @@ -23945,7 +26095,8 @@ "red_team_seed_prompts": "#/components/schemas/RedTeamSeedPromptsItemGenerationParams", "red_team_taxonomy": "#/components/schemas/RedTeamTaxonomyItemGenerationParams", "response_retrieval": "#/components/schemas/ResponseRetrievalItemGenerationParams", - "conversation_gen_preview": "#/components/schemas/ConversationGenPreviewItemGenerationParams" + "conversation_gen_preview": "#/components/schemas/ConversationGenPreviewItemGenerationParams", + "synthetic_data_gen_preview": "#/components/schemas/SyntheticDataGenerationPreviewItemGenerationParams" } }, "description": "Represents the set of parameters used to control item generation operations." @@ -24026,9 +26177,7 @@ "type": "string", "enum": [ "mcp" - ], - "description": "The type of the MCP tool. Always `mcp`.", - "x-stainless-const": true + ] }, "server_label": { "type": "string", @@ -24062,11 +26211,17 @@ "description": "Optional description of the MCP server, used to provide more context." }, "headers": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "nullable": true + "anyOf": [ + { + "type": "object", + "unevaluatedProperties": { + "type": "string" + } + }, + { + "type": "null" + } + ] }, "allowed_tools": { "anyOf": [ @@ -24074,42 +26229,38 @@ "type": "array", "items": { "type": "string" - }, - "nullable": true + } }, { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.MCPToolFilter" - } - ], - "nullable": true + "$ref": "#/components/schemas/OpenAI.MCPToolFilter" + }, + { + "type": "null" } ] }, "require_approval": { "anyOf": [ { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" - } - ], - "nullable": true + "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" }, { "type": "string", "enum": [ "always", "never" - ], - "nullable": true + ] + }, + { + "type": "null" } ], "default": "always" }, + "defer_loading": { + "type": "boolean", + "description": "Whether this MCP tool is deferred and discovered via tool search." + }, "project_connection_id": { "type": "string", "description": "The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server." @@ -24506,11 +26657,17 @@ "description": "The status of the tool call." }, "memories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MemoryItem" - }, - "nullable": true, + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/MemoryItem" + } + }, + { + "type": "null" + } + ], "description": "The results returned from the memory search." } }, @@ -24588,7 +26745,7 @@ }, "procedural_memory_enabled": { "type": "boolean", - "description": "Whether to enable procedural memory extraction and storage. Defaults to `true`.", + "description": "Whether to enable procedural memory extraction and storage. The service defaults to `true` if a value is not specified by the caller.", "default": true }, "default_ttl_seconds": { @@ -24738,7 +26895,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Arbitrary key-value metadata to associate with the memory store." @@ -25045,7 +27202,7 @@ }, "capabilities": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Capabilities of deployed model", @@ -25266,7 +27423,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -25473,8 +27630,7 @@ "create_file" ], "description": "Create a new file with the provided diff.", - "x-stainless-const": true, - "default": "create_file" + "x-stainless-const": true }, "path": { "type": "string", @@ -25507,8 +27663,7 @@ "create_file" ], "description": "The operation type. Always `create_file`.", - "x-stainless-const": true, - "default": "create_file" + "x-stainless-const": true }, "path": { "type": "string", @@ -25542,8 +27697,7 @@ "delete_file" ], "description": "Delete the specified file.", - "x-stainless-const": true, - "default": "delete_file" + "x-stainless-const": true }, "path": { "type": "string", @@ -25571,8 +27725,7 @@ "delete_file" ], "description": "The operation type. Always `delete_file`.", - "x-stainless-const": true, - "default": "delete_file" + "x-stainless-const": true }, "path": { "type": "string", @@ -25672,8 +27825,7 @@ "apply_patch" ], "description": "The type of the tool. Always `apply_patch`.", - "x-stainless-const": true, - "default": "apply_patch" + "x-stainless-const": true } }, "allOf": [ @@ -25698,8 +27850,7 @@ "update_file" ], "description": "Update an existing file with the provided diff.", - "x-stainless-const": true, - "default": "update_file" + "x-stainless-const": true }, "path": { "type": "string", @@ -25732,8 +27883,7 @@ "update_file" ], "description": "The operation type. Always `update_file`.", - "x-stainless-const": true, - "default": "update_file" + "x-stainless-const": true }, "path": { "type": "string", @@ -25770,20 +27920,44 @@ "default": "approximate" }, "country": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "region": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "city": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "timezone": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } } }, @@ -25811,12 +27985,14 @@ "description": "An optional list of uploaded files to make available to your code." }, "memory_limit": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.ContainerMemoryLimit" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "network_policy": { "$ref": "#/components/schemas/OpenAI.ContainerNetworkPolicyParam" @@ -25850,6 +28026,12 @@ "OpenAI.ChatModel": { "type": "string", "enum": [ + "gpt-5.4", + "gpt-5.4-mini", + "gpt-5.4-nano", + "gpt-5.4-mini-2026-03-17", + "gpt-5.4-nano-2026-03-17", + "gpt-5.3-chat-latest", "gpt-5.2", "gpt-5.2-2025-12-11", "gpt-5.2-chat-latest", @@ -25949,8 +28131,7 @@ "click" ], "description": "Specifies the event type. For a click action, this property is always `click`.", - "x-stainless-const": true, - "default": "click" + "x-stainless-const": true }, "button": { "allOf": [ @@ -25975,6 +28156,19 @@ } ], "description": "The y-coordinate where the click occurred." + }, + "keys": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -26141,17 +28335,61 @@ "items": { "$ref": "#/components/schemas/OpenAI.InputItem" } + }, + { + "type": "null" } - ], - "nullable": true + ] }, "previous_response_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "instructions": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "prompt_cache_key": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "prompt_cache_retention": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.PromptCacheRetentionEnum" + }, + { + "type": "null" + } + ] + }, + "service_tier": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.ServiceTierEnum" + }, + { + "type": "null" + } + ] } } }, @@ -26171,7 +28409,9 @@ "gt", "gte", "lt", - "lte" + "lte", + "in", + "nin" ], "description": "Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.\n - `eq`: equals\n - `ne`: not equal\n - `gt`: greater than\n - `gte`: greater than or equal\n - `lt`: less than\n - `lte`: less than or equal\n - `in`: in\n - `nin`: not in", "default": "eq" @@ -26273,6 +28513,14 @@ } } }, + "OpenAI.ComputerActionList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ComputerAction" + }, + "description": "Flattened batched actions for `computer_use`. Each action includes an\n`type` discriminator and action-specific fields.", + "title": "Computer Action List" + }, "OpenAI.ComputerActionType": { "anyOf": [ { @@ -26305,12 +28553,24 @@ "description": "The ID of the pending safety check." }, "code": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "message": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "description": "A pending safety check for the computer call." @@ -26330,7 +28590,8 @@ "required": [ "type", "image_url", - "file_id" + "file_id", + "detail" ], "properties": { "type": { @@ -26339,17 +28600,36 @@ "computer_screenshot" ], "description": "Specifies the event type. For a computer screenshot, this property is always set to `computer_screenshot`.", - "x-stainless-const": true, - "default": "computer_screenshot" + "x-stainless-const": true }, "image_url": { - "type": "string", - "format": "uri", - "nullable": true + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ] }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ImageDetail" + } + ], + "description": "The detail level of the screenshot image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "allOf": [ @@ -26387,6 +28667,29 @@ }, "description": "A computer screenshot image used with the computer use tool." }, + "OpenAI.ComputerTool": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "computer" + ], + "description": "The type of the computer tool. Always `computer`.", + "x-stainless-const": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Tool" + } + ], + "description": "A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).", + "title": "Computer" + }, "OpenAI.ComputerUsePreviewTool": { "type": "object", "required": [ @@ -26402,8 +28705,7 @@ "computer_use_preview" ], "description": "The type of the computer use tool. Always `computer_use_preview`.", - "x-stainless-const": true, - "default": "computer_use_preview" + "x-stainless-const": true }, "environment": { "allOf": [ @@ -26450,8 +28752,7 @@ "container_auto" ], "description": "Automatically creates a container for this request", - "x-stainless-const": true, - "default": "container_auto" + "x-stainless-const": true }, "file_ids": { "type": "array", @@ -26462,12 +28763,14 @@ "description": "An optional list of uploaded files to make available to your code." }, "memory_limit": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.ContainerMemoryLimit" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "skills": { "type": "array", @@ -26504,8 +28807,7 @@ "container_file_citation" ], "description": "The type of the container file citation. Always `container_file_citation`.", - "x-stainless-const": true, - "default": "container_file_citation" + "x-stainless-const": true }, "container_id": { "type": "string", @@ -26566,8 +28868,7 @@ "allowlist" ], "description": "Allow outbound network access only to specified domains. Always `allowlist`.", - "x-stainless-const": true, - "default": "allowlist" + "x-stainless-const": true }, "allowed_domains": { "type": "array", @@ -26576,14 +28877,6 @@ }, "minItems": 1, "description": "A list of allowed domains when type is `allowlist`." - }, - "domain_secrets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.ContainerNetworkPolicyDomainSecretParam" - }, - "minItems": 1, - "description": "Optional domain-scoped secrets for allowlisted domains." } }, "allOf": [ @@ -26604,8 +28897,7 @@ "disabled" ], "description": "Disable outbound network access. Always `disabled`.", - "x-stainless-const": true, - "default": "disabled" + "x-stainless-const": true } }, "allOf": [ @@ -26614,32 +28906,6 @@ } ] }, - "OpenAI.ContainerNetworkPolicyDomainSecretParam": { - "type": "object", - "required": [ - "domain", - "name", - "value" - ], - "properties": { - "domain": { - "type": "string", - "minLength": 1, - "description": "The domain associated with the secret." - }, - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the secret to inject for the domain." - }, - "value": { - "type": "string", - "minLength": 1, - "maxLength": 10485760, - "description": "The secret value to inject for the domain." - } - } - }, "OpenAI.ContainerNetworkPolicyParam": { "type": "object", "required": [ @@ -26686,8 +28952,7 @@ "container_reference" ], "description": "The environment type. Always `container_reference`.", - "x-stainless-const": true, - "default": "container_reference" + "x-stainless-const": true }, "container_id": { "type": "string" @@ -26744,13 +29009,14 @@ "description": "The context management entry type. Currently only 'compaction' is supported." }, "compact_threshold": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] } } }, @@ -26768,14 +29034,18 @@ "propertyName": "type", "mapping": { "message": "#/components/schemas/OpenAI.ConversationItemMessage", - "function_call": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallResource", - "function_call_output": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutputResource", + "function_call": "#/components/schemas/OpenAI.ConversationItemFunctionToolCall", + "function_call_output": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutput", "file_search_call": "#/components/schemas/OpenAI.ConversationItemFileSearchToolCall", "web_search_call": "#/components/schemas/OpenAI.ConversationItemWebSearchToolCall", "image_generation_call": "#/components/schemas/OpenAI.ConversationItemImageGenToolCall", "computer_call": "#/components/schemas/OpenAI.ConversationItemComputerToolCall", - "computer_call_output": "#/components/schemas/OpenAI.ConversationItemComputerToolCallOutputResource", + "computer_call_output": "#/components/schemas/OpenAI.ConversationItemComputerToolCallOutput", + "tool_search_call": "#/components/schemas/OpenAI.ConversationItemToolSearchCall", + "tool_search_output": "#/components/schemas/OpenAI.ConversationItemToolSearchOutput", + "additional_tools": "#/components/schemas/OpenAI.ConversationItemAdditionalTools", "reasoning": "#/components/schemas/OpenAI.ConversationItemReasoningItem", + "compaction": "#/components/schemas/OpenAI.ConversationItemCompactionBody", "code_interpreter_call": "#/components/schemas/OpenAI.ConversationItemCodeInterpreterToolCall", "local_shell_call": "#/components/schemas/OpenAI.ConversationItemLocalShellToolCall", "local_shell_call_output": "#/components/schemas/OpenAI.ConversationItemLocalShellToolCallOutput", @@ -26787,13 +29057,57 @@ "mcp_approval_request": "#/components/schemas/OpenAI.ConversationItemMcpApprovalRequest", "mcp_approval_response": "#/components/schemas/OpenAI.ConversationItemMcpApprovalResponseResource", "mcp_call": "#/components/schemas/OpenAI.ConversationItemMcpToolCall", - "custom_tool_call": "#/components/schemas/OpenAI.ConversationItemCustomToolCall", - "custom_tool_call_output": "#/components/schemas/OpenAI.ConversationItemCustomToolCallOutput" + "custom_tool_call": "#/components/schemas/OpenAI.ConversationItemCustomToolCallResource", + "custom_tool_call_output": "#/components/schemas/OpenAI.ConversationItemCustomToolCallOutputResource" } }, "description": "A single item within a conversation. The set of possible types are the same as the `output` type of a [Response object](/docs/api-reference/responses/object#responses/object-output).", "title": "Conversation item" }, + "OpenAI.ConversationItemAdditionalTools": { + "type": "object", + "required": [ + "type", + "id", + "role", + "tools" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "additional_tools" + ], + "description": "The type of the item. Always `additional_tools`.", + "x-stainless-const": true, + "default": "additional_tools" + }, + "id": { + "type": "string", + "description": "The unique ID of the additional tools item." + }, + "role": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessageRole" + } + ], + "description": "The role that provided the additional tools." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The additional tool definitions made available at this item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationItem" + } + ] + }, "OpenAI.ConversationItemApplyPatchToolCall": { "type": "object", "required": [ @@ -26886,8 +29200,14 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "created_by": { "type": "string", @@ -26942,22 +29262,34 @@ "description": "The ID of the container used to run the code." }, "code": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "outputs": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + "anyOf": [ + { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + } + ] } - ] - }, - "nullable": true + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -26968,13 +29300,50 @@ "description": "A tool call to run code.", "title": "Code interpreter tool call" }, + "OpenAI.ConversationItemCompactionBody": { + "type": "object", + "required": [ + "type", + "id", + "encrypted_content" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "compaction" + ], + "description": "The type of the item. Always `compaction`.", + "x-stainless-const": true, + "default": "compaction" + }, + "id": { + "type": "string", + "description": "The unique ID of the compaction item." + }, + "encrypted_content": { + "type": "string", + "description": "The encrypted content that was produced by compaction." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationItem" + } + ], + "description": "A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact).", + "title": "Compaction item" + }, "OpenAI.ConversationItemComputerToolCall": { "type": "object", "required": [ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -26998,6 +29367,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -27023,10 +29395,11 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.ConversationItemComputerToolCallOutputResource": { + "OpenAI.ConversationItemComputerToolCallOutput": { "type": "object", "required": [ "type", + "id", "call_id", "output" ], @@ -27042,7 +29415,8 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output." + "description": "The ID of the computer tool call output.", + "readOnly": true }, "call_id": { "type": "string", @@ -27072,40 +29446,60 @@ { "$ref": "#/components/schemas/OpenAI.ConversationItem" } - ] + ], + "description": "The output of a computer tool call.", + "title": "Computer tool call output" }, - "OpenAI.ConversationItemCustomToolCall": { + "OpenAI.ConversationItemCustomToolCallOutputResource": { "type": "object", "required": [ "type", "call_id", - "name", - "input" + "output", + "status" ], "properties": { "type": { "type": "string", "enum": [ - "custom_tool_call" + "custom_tool_call_output" ], - "description": "The type of the custom tool call. Always `custom_tool_call`.", + "description": "The type of the custom tool call output. Always `custom_tool_call_output`.", "x-stainless-const": true }, "id": { "type": "string", - "description": "The unique ID of the custom tool call in the OpenAI platform." + "description": "The unique ID of the custom tool call output in the OpenAI platform." }, "call_id": { "type": "string", - "description": "An identifier used to map this custom tool call to a tool call output." + "description": "The call ID, used to map this custom tool call output to a custom tool call." }, - "name": { - "type": "string", - "description": "The name of the custom tool being called." + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." }, - "input": { + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { "type": "string", - "description": "The input for the custom tool call generated by the model." + "description": "The identifier of the actor that created the item." } }, "allOf": [ @@ -27113,46 +29507,57 @@ "$ref": "#/components/schemas/OpenAI.ConversationItem" } ], - "description": "A call to a custom tool created by the model.", - "title": "Custom tool call" + "title": "ResponseCustomToolCallOutputItem" }, - "OpenAI.ConversationItemCustomToolCallOutput": { + "OpenAI.ConversationItemCustomToolCallResource": { "type": "object", "required": [ "type", "call_id", - "output" + "name", + "input", + "status" ], "properties": { "type": { "type": "string", "enum": [ - "custom_tool_call_output" + "custom_tool_call" ], - "description": "The type of the custom tool call output. Always `custom_tool_call_output`.", + "description": "The type of the custom tool call. Always `custom_tool_call`.", "x-stainless-const": true }, "id": { "type": "string", - "description": "The unique ID of the custom tool call output in the OpenAI platform." + "description": "The unique ID of the custom tool call in the OpenAI platform." }, "call_id": { "type": "string", - "description": "The call ID, used to map this custom tool call output to a custom tool call." + "description": "An identifier used to map this custom tool call to a tool call output." }, - "output": { - "oneOf": [ - { - "type": "string" - }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, + "name": { + "type": "string", + "description": "The name of the custom tool being called." + }, + "input": { + "type": "string", + "description": "The input for the custom tool call generated by the model." + }, + "status": { + "allOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" } ], - "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." } }, "allOf": [ @@ -27160,8 +29565,7 @@ "$ref": "#/components/schemas/OpenAI.ConversationItem" } ], - "description": "The output of a custom tool call from your code, being sent back to the model.", - "title": "Custom tool call output" + "title": "ResponseCustomToolCallItem" }, "OpenAI.ConversationItemFileSearchToolCall": { "type": "object", @@ -27203,11 +29607,17 @@ "description": "The queries used to search for files." }, "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -27257,19 +29667,20 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." }, "environment": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallEnvironment" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "created_by": { "type": "string", @@ -27315,7 +29726,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -27328,13 +29739,14 @@ "description": "An array of shell call output contents" }, "max_output_length": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "created_by": { "type": "string", @@ -27349,43 +29761,44 @@ "description": "The output of a shell tool call that was emitted.", "title": "Shell call output" }, - "OpenAI.ConversationItemFunctionToolCallOutputResource": { + "OpenAI.ConversationItemFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", - "output" + "name", + "arguments" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", "enum": [ - "function_call_output" + "function_call" ], - "description": "The type of the function tool call output. Always `function_call_output`.", + "description": "The type of the function tool call. Always `function_call`.", "x-stainless-const": true }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "output": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } - } - ], - "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, + "name": { + "type": "string", + "description": "The name of the function to run." + }, + "arguments": { + "type": "string", + "description": "A JSON string of the arguments to pass to the function." }, "status": { "type": "string", @@ -27401,40 +29814,49 @@ { "$ref": "#/components/schemas/OpenAI.ConversationItem" } - ] + ], + "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", + "title": "Function tool call" }, - "OpenAI.ConversationItemFunctionToolCallResource": { + "OpenAI.ConversationItemFunctionToolCallOutput": { "type": "object", "required": [ + "id", "type", "call_id", - "name", - "arguments" + "output" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", + "readOnly": true }, "type": { "type": "string", "enum": [ - "function_call" + "function_call_output" ], - "description": "The type of the function tool call. Always `function_call`.", + "description": "The type of the function tool call output. Always `function_call_output`.", "x-stainless-const": true }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "name": { - "type": "string", - "description": "The name of the function to run." - }, - "arguments": { - "type": "string", - "description": "A JSON string of the arguments to pass to the function." + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." }, "status": { "type": "string", @@ -27450,7 +29872,9 @@ { "$ref": "#/components/schemas/OpenAI.ConversationItem" } - ] + ], + "description": "The output of a function tool call.", + "title": "Function tool call output" }, "OpenAI.ConversationItemImageGenToolCall": { "type": "object", @@ -27484,8 +29908,14 @@ "description": "The status of the image generation call." }, "result": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -27615,13 +30045,19 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "nullable": true + "anyOf": [ + { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -27705,8 +30141,14 @@ "description": "Whether the request was approved." }, "reason": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -27750,8 +30192,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -27797,12 +30238,18 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "error": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, "status": { "allOf": [ @@ -27813,8 +30260,14 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -27870,6 +30323,16 @@ "$ref": "#/components/schemas/OpenAI.MessageContent" }, "description": "The content of the message" + }, + "phase": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -27901,8 +30364,14 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "summary": { "type": "array", @@ -27936,6 +30405,138 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, + "OpenAI.ConversationItemToolSearchCall": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "arguments", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The type of the item. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search call item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "description": "Arguments used for the tool search call." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the tool search call item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationItem" + } + ] + }, + "OpenAI.ConversationItemToolSearchOutput": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "tools", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The type of the item. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search output item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by tool search." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the tool search output item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationItem" + } + ] + }, "OpenAI.ConversationItemType": { "anyOf": [ { @@ -27952,7 +30553,11 @@ "image_generation_call", "computer_call", "computer_call_output", + "tool_search_call", + "tool_search_output", + "additional_tools", "reasoning", + "compaction", "code_interpreter_call", "local_shell_call", "local_shell_call_output", @@ -28141,7 +30746,8 @@ "propertyName": "type", "mapping": { "text": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText", - "json_object": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject" + "json_object": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject", + "json_schema": "#/components/schemas/OpenAI.ResponseFormatJsonSchema" } }, "description": "An object specifying the format that the model must output.\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables\nStructured Outputs which ensures the model will match your supplied JSON\nschema. Learn more in the [Structured Outputs\nguide](/docs/guides/structured-outputs).\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it." @@ -28211,20 +30817,27 @@ "type": "object", "properties": { "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.InputItem" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.InputItem" + } + }, + { + "type": "null" + } + ] } } }, @@ -28402,7 +31015,7 @@ }, "item_schema": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The json schema for each row in the data source." }, "include_sample_schema": { @@ -28471,7 +31084,7 @@ }, "metadata": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "Metadata filters for the logs data source." } }, @@ -28666,7 +31279,7 @@ }, "metadata": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "Metadata filters for the stored completions data source." } }, @@ -28718,33 +31331,52 @@ "deprecated": true }, "suffix": { - "type": "string", - "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "minLength": 1, "maxLength": 64, "description": "A string of up to 64 characters that will be added to your fine-tuned model name.\n For example, a `suffix` of \"custom-model-name\" would produce a model name like `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`." }, "validation_file": { - "type": "string", - "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "description": "The ID of an uploaded file that contains validation data.\n If you provide this file, the data is used to generate validation\n metrics periodically during fine-tuning. These metrics can be viewed in\n the fine-tuning results file.\n The same data should not be present in both train and validation files.\n Your dataset must be formatted as a JSONL file. You must upload your file with the purpose `fine-tune`.\n See the [fine-tuning guide](/docs/guides/model-optimization) for more details." }, "integrations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.CreateFineTuningJobRequestIntegrations" - }, - "nullable": true, + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.CreateFineTuningJobRequestIntegrations" + } + }, + { + "type": "null" + } + ], "description": "A list of integrations to enable for your fine-tuning job." }, "seed": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } ], - "nullable": true, "minimum": 0, "maximum": 2147483647, "description": "The seed controls the reproducibility of the job. Passing in the same seed and job parameters should produce the same results, but may differ in rare cases.\n If a seed is not specified, one will be generated for you." @@ -28753,13 +31385,14 @@ "$ref": "#/components/schemas/OpenAI.FineTuneMethod" }, "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] } } }, @@ -28839,12 +31472,24 @@ "type": "string" }, "name": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "entity": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "tags": { "type": "array", @@ -29031,8 +31676,7 @@ "grammar" ], "description": "Grammar format. Always `grammar`.", - "x-stainless-const": true, - "default": "grammar" + "x-stainless-const": true }, "syntax": { "allOf": [ @@ -29067,8 +31711,7 @@ "text" ], "description": "Unconstrained text format. Always `text`.", - "x-stainless-const": true, - "default": "text" + "x-stainless-const": true } }, "allOf": [ @@ -29092,8 +31735,7 @@ "custom" ], "description": "The type of the custom tool. Always `custom`.", - "x-stainless-const": true, - "default": "custom" + "x-stainless-const": true }, "name": { "type": "string", @@ -29110,6 +31752,10 @@ } ], "description": "The input format for the custom tool. Default is unconstrained text." + }, + "defer_loading": { + "type": "boolean", + "description": "Whether this tool should be deferred and discovered via tool search." } }, "allOf": [ @@ -29182,7 +31828,8 @@ "enum": [ "low", "high", - "auto" + "auto", + "original" ] }, "OpenAI.DoubleClickAction": { @@ -29190,7 +31837,8 @@ "required": [ "type", "x", - "y" + "y", + "keys" ], "properties": { "type": { @@ -29199,8 +31847,7 @@ "double_click" ], "description": "Specifies the event type. For a double click action, this property is always set to `double_click`.", - "x-stainless-const": true, - "default": "double_click" + "x-stainless-const": true }, "x": { "allOf": [ @@ -29217,6 +31864,19 @@ } ], "description": "The y-coordinate where the double click occurred." + }, + "keys": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -29240,8 +31900,7 @@ "drag" ], "description": "Specifies the event type. For a drag action, this property is always set to `drag`.", - "x-stainless-const": true, - "default": "drag" + "x-stainless-const": true }, "path": { "type": "array", @@ -29249,6 +31908,19 @@ "$ref": "#/components/schemas/OpenAI.CoordParam" }, "description": "An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg\n ```\n [\n { x: 100, y: 200 },\n { x: 200, y: 300 }\n ]\n ```" + }, + "keys": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -29288,6 +31960,16 @@ ], "description": "Text, image, or audio input to the model, used to generate a response.\n Can also contain previous assistant responses." }, + "phase": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + }, + { + "type": "null" + } + ] + }, "type": { "type": "string", "enum": [ @@ -29314,6 +31996,9 @@ "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role. Messages with the\n`assistant` role are presumed to have been generated by the model in previous\ninteractions.", "title": "Input message" }, + "OpenAI.EmptyModelParam": { + "type": "object" + }, "OpenAI.Error": { "type": "object", "required": [ @@ -29322,15 +32007,27 @@ ], "properties": { "code": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "message": { "type": "string" }, "param": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "type": { "type": "string" @@ -29343,11 +32040,11 @@ }, "additionalInfo": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, "debugInfo": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} } } }, @@ -29526,41 +32223,45 @@ "type": "object", "properties": { "seed": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "top_p": { - "type": "number", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" + }, + { + "type": "null" } ], - "nullable": true, "default": 1 }, "temperature": { - "type": "number", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "max_completions_tokens": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "reasoning_effort": { "$ref": "#/components/schemas/OpenAI.ReasoningEffort" @@ -29901,11 +32602,11 @@ "properties": { "item": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, "sample": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} } } }, @@ -29946,75 +32647,111 @@ "description": "The type of run data source. Always `responses`." }, "metadata": { - "type": "object", - "additionalProperties": {}, - "nullable": true + "anyOf": [ + { + "type": "object", + "unevaluatedProperties": {} + }, + { + "type": "null" + } + ] }, "model": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "instructions_search": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "created_after": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "created_before": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "reasoning_effort": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.ReasoningEffort" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "temperature": { - "type": "number", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "top_p": { - "type": "number", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "users": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] }, "tools": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] } }, "description": "A EvalResponsesSource object describing a run data source configuration.", @@ -30214,44 +32951,54 @@ "default": "stored_completions" }, "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "model": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "created_after": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "created_before": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "limit": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "description": "A StoredCompletionsRunDataSource configuration describing a set of filters", @@ -30277,8 +33024,7 @@ "file_citation" ], "description": "The type of the file citation. Always `file_citation`.", - "x-stainless-const": true, - "default": "file_citation" + "x-stainless-const": true }, "file_id": { "type": "string", @@ -30305,6 +33051,13 @@ "description": "A citation to a file.", "title": "File citation" }, + "OpenAI.FileInputDetail": { + "type": "string", + "enum": [ + "low", + "high" + ] + }, "OpenAI.FilePath": { "type": "object", "required": [ @@ -30355,8 +33108,7 @@ "file_search" ], "description": "The type of the file search tool. Always `file_search`.", - "x-stainless-const": true, - "default": "file_search" + "x-stainless-const": true }, "vector_store_ids": { "type": "array", @@ -30382,12 +33134,14 @@ "description": "Ranking options for search." }, "filters": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Filters" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "name": { "type": "string", @@ -30419,13 +33173,14 @@ "type": "string" }, "attributes": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.VectorStoreFileAttributes" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "score": { "type": "number", @@ -30780,12 +33535,24 @@ "type": "string" }, "name": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "entity": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "tags": { "type": "array", @@ -30825,22 +33592,37 @@ "description": "The Unix timestamp (in seconds) for when the fine-tuning job was created." }, "error": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FineTuningJobError" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "fine_tuned_model": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "finished_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "type": "integer", - "format": "unixtime", - "nullable": true + "format": "unixTimestamp" }, "hyperparameters": { "allOf": [ @@ -30886,28 +33668,41 @@ "description": "The current status of the fine-tuning job, which can be either `validating_files`, `queued`, `running`, `succeeded`, `failed`, or `cancelled`." }, "trained_tokens": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "training_file": { "type": "string", "description": "The file ID used for training. You can retrieve the training data with the [Files API](/docs/api-reference/files/retrieve-contents)." }, "validation_file": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "integrations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FineTuningIntegration" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FineTuningIntegration" + } + }, + { + "type": "null" + } + ] }, "seed": { "allOf": [ @@ -30918,21 +33713,30 @@ "description": "The seed used for the fine-tuning job." }, "estimated_finish": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "type": "integer", - "format": "unixtime", - "nullable": true + "format": "unixTimestamp" }, "method": { "$ref": "#/components/schemas/OpenAI.FineTuneMethod" }, "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "description": "The `fine_tuning.job` object represents a fine-tuning job that has been created through the API.", @@ -31044,8 +33848,14 @@ "type": "string" }, "param": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } } }, @@ -31124,17 +33934,13 @@ "type": "string", "enum": [ "auto" - ], - "nullable": true + ] }, { - "type": "integer", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - } - ], - "nullable": true + "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } ], "default": "auto" @@ -31204,21 +34010,35 @@ "default": "input_file" }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "filename": { "type": "string", "description": "The name of the file to be sent to the model." }, + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." + }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "allOf": [ @@ -31246,13 +34066,25 @@ "default": "input_image" }, "image_url": { - "type": "string", - "format": "uri", - "nullable": true + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ] }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "detail": { "allOf": [ @@ -31260,7 +34092,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "allOf": [ @@ -31323,6 +34155,22 @@ "incomplete" ] }, + "OpenAI.FunctionCallOutputStatusEnum": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + "OpenAI.FunctionCallStatus": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, "OpenAI.FunctionObject": { "type": "object", "required": [ @@ -31341,14 +34189,20 @@ "$ref": "#/components/schemas/OpenAI.FunctionParameters" }, "strict": { - "type": "boolean", - "nullable": true + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] } } }, "OpenAI.FunctionParameters": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.\nOmitting `parameters` defines a function with an empty parameter list." }, "OpenAI.FunctionShellAction": { @@ -31366,22 +34220,24 @@ } }, "timeout_ms": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "max_output_length": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "description": "Execute a shell command.", @@ -31401,22 +34257,24 @@ "description": "Ordered shell commands for the execution environment to run." }, "timeout_ms": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "max_output_length": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "description": "Commands and limits describing how to run the shell tool call.", @@ -31630,8 +34488,7 @@ "exit" ], "description": "The outcome type. Always `exit`.", - "x-stainless-const": true, - "default": "exit" + "x-stainless-const": true }, "exit_code": { "allOf": [ @@ -31663,8 +34520,7 @@ "exit" ], "description": "The outcome type. Always `exit`.", - "x-stainless-const": true, - "default": "exit" + "x-stainless-const": true }, "exit_code": { "allOf": [ @@ -31751,6 +34607,14 @@ } ] }, + "OpenAI.FunctionShellCallOutputStatusEnum": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, "OpenAI.FunctionShellCallOutputTimeoutOutcome": { "type": "object", "required": [ @@ -31763,8 +34627,7 @@ "timeout" ], "description": "The outcome type. Always `timeout`.", - "x-stainless-const": true, - "default": "timeout" + "x-stainless-const": true } }, "allOf": [ @@ -31787,8 +34650,7 @@ "timeout" ], "description": "The outcome type. Always `timeout`.", - "x-stainless-const": true, - "default": "timeout" + "x-stainless-const": true } }, "allOf": [ @@ -31799,6 +34661,14 @@ "description": "Indicates that the shell call exceeded its configured time limit.", "title": "Shell call timeout outcome" }, + "OpenAI.FunctionShellCallStatus": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, "OpenAI.FunctionShellToolParam": { "type": "object", "required": [ @@ -31811,17 +34681,17 @@ "shell" ], "description": "The type of the shell tool. Always `shell`.", - "x-stainless-const": true, - "default": "shell" + "x-stainless-const": true }, "environment": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellToolParamEnvironment" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "name": { "type": "string", @@ -31946,25 +34816,46 @@ "function" ], "description": "The type of the function tool. Always `function`.", - "x-stainless-const": true, - "default": "function" + "x-stainless-const": true }, "name": { "type": "string", "description": "The name of the function to call." }, "description": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "parameters": { - "type": "object", - "additionalProperties": {}, - "nullable": true + "anyOf": [ + { + "type": "object", + "unevaluatedProperties": {} + }, + { + "type": "null" + } + ] }, "strict": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, + "defer_loading": { "type": "boolean", - "nullable": true + "description": "Whether this function is deferred and loaded via tool search." } }, "allOf": [ @@ -31975,61 +34866,62 @@ "description": "Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).", "title": "Function" }, - "OpenAI.FunctionToolCallOutput": { + "OpenAI.FunctionToolParam": { "type": "object", "required": [ - "type", - "call_id", - "output" + "name", + "type" ], "properties": { - "id": { + "name": { "type": "string", - "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." + "minLength": 1, + "maxLength": 128, + "pattern": "^[a-zA-Z0-9_-]+$" }, - "type": { - "type": "string", - "enum": [ - "function_call_output" - ], - "description": "The type of the function tool call output. Always `function_call_output`.", - "x-stainless-const": true + "description": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, - "call_id": { - "type": "string", - "description": "The unique ID of the function tool call generated by the model." + "parameters": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.EmptyModelParam" + }, + { + "type": "null" + } + ] }, - "output": { - "oneOf": [ + "strict": { + "anyOf": [ { - "type": "string" + "type": "boolean" }, { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } + "type": "null" } - ], - "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + ] }, - "status": { + "type": { "type": "string", "enum": [ - "in_progress", - "completed", - "incomplete" + "function" ], - "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemField" + "x-stainless-const": true, + "default": "function" + }, + "defer_loading": { + "type": "boolean", + "description": "Whether this function should be deferred and discovered via tool search." } - ], - "description": "The output of a function tool call.", - "title": "Function tool call output" + } }, "OpenAI.GraderLabelModel": { "type": "object", @@ -32377,7 +35269,8 @@ "enum": [ "low", "high", - "auto" + "auto", + "original" ] }, "OpenAI.ImageGenActionEnum": { @@ -32400,8 +35293,7 @@ "image_generation" ], "description": "The type of the image generation tool. Always `image_generation`.", - "x-stainless-const": true, - "default": "image_generation" + "x-stainless-const": true }, "model": { "anyOf": [ @@ -32431,14 +35323,21 @@ "default": "auto" }, "size": { - "type": "string", - "enum": [ - "1024x1024", - "1024x1536", - "1536x1024", - "auto" + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "1024x1024", + "1024x1536", + "1536x1024", + "auto" + ] + } ], - "description": "The size of the generated image. One of `1024x1024`, `1024x1536`,\n `1536x1024`, or `auto`. Default: `auto`.", + "description": "The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.", "default": "auto" }, "output_format": { @@ -32482,12 +35381,14 @@ "default": "auto" }, "input_fidelity": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.InputFidelity" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "input_image_mask": { "allOf": [ @@ -32564,7 +35465,7 @@ ] } ], - "description": "Specify additional output data to include in the model response. Currently supported values are:\n- `web_search_call.action.sources`: Include the sources of the web search tool call.\n- `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n- `file_search_call.results`: Include the search results of the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `message.output_text.logprobs`: Include logprobs with assistant messages.\n- `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program)." + "description": "Specify additional output data to include in the model response. Currently supported values are:\n- `web_search_call.results`: Include the search results of the web search tool call.\n- `web_search_call.action.sources`: Include the sources of the web search tool call.\n- `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n- `file_search_call.results`: Include the search results of the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `message.output_text.logprobs`: Include logprobs with assistant messages.\n- `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program)." }, "OpenAI.InlineSkillParam": { "type": "object", @@ -32581,8 +35482,7 @@ "inline" ], "description": "Defines an inline skill for this request.", - "x-stainless-const": true, - "default": "inline" + "x-stainless-const": true }, "name": { "type": "string", @@ -32723,21 +35623,35 @@ "default": "input_file" }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "filename": { "type": "string", "description": "The name of the file to be sent to the model." }, + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." + }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "allOf": [ @@ -32765,13 +35679,25 @@ "default": "input_image" }, "image_url": { - "type": "string", - "format": "uri", - "nullable": true + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ] }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "detail": { "allOf": [ @@ -32779,7 +35705,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "allOf": [ @@ -32858,21 +35784,35 @@ "default": "input_file" }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "filename": { "type": "string", "description": "The name of the file to be sent to the model." }, + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." + }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "description": "A file input to the model.", @@ -32894,21 +35834,53 @@ "default": "input_file" }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "filename": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "file_data": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "file_url": { - "type": "string", - "format": "uri", - "nullable": true + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ] + }, + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "description": "A file input to the model.", @@ -32931,13 +35903,25 @@ "default": "input_image" }, "image_url": { - "type": "string", - "format": "uri", - "nullable": true + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ] }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "detail": { "allOf": [ @@ -32945,7 +35929,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "description": "An image input to the model. Learn about [image inputs](/docs/guides/vision).", @@ -32967,21 +35951,35 @@ "default": "input_image" }, "image_url": { - "type": "string", - "format": "uri", - "nullable": true + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ] }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "detail": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.DetailEnum" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "description": "An image input to the model. Learn about [image inputs](/docs/guides/vision)", @@ -33009,6 +36007,9 @@ "web_search_call": "#/components/schemas/OpenAI.InputItemWebSearchToolCall", "function_call": "#/components/schemas/OpenAI.InputItemFunctionToolCall", "function_call_output": "#/components/schemas/OpenAI.InputItemFunctionCallOutputItemParam", + "tool_search_call": "#/components/schemas/OpenAI.InputItemToolSearchCallItemParam", + "tool_search_output": "#/components/schemas/OpenAI.InputItemToolSearchOutputItemParam", + "additional_tools": "#/components/schemas/OpenAI.InputItemAdditionalToolsItemParam", "reasoning": "#/components/schemas/OpenAI.InputItemReasoningItem", "compaction": "#/components/schemas/OpenAI.InputItemCompactionSummaryItemParam", "image_generation_call": "#/components/schemas/OpenAI.InputItemImageGenToolCall", @@ -33029,6 +36030,56 @@ }, "description": "An item representing part of the context for the response to be\ngenerated by the model. Can contain text, images, and audio inputs,\nas well as previous assistant responses and tool call outputs." }, + "OpenAI.InputItemAdditionalToolsItemParam": { + "type": "object", + "required": [ + "type", + "role", + "tools" + ], + "properties": { + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "additional_tools" + ], + "description": "The item type. Always `additional_tools`.", + "x-stainless-const": true, + "default": "additional_tools" + }, + "role": { + "type": "string", + "enum": [ + "developer" + ], + "description": "The role that provided the additional tools. Only `developer` is supported.", + "x-stainless-const": true, + "default": "developer" + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "A list of additional tools made available at this item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.InputItem" + } + ] + }, "OpenAI.InputItemApplyPatchToolCallItemParam": { "type": "object", "required": [ @@ -33048,8 +36099,14 @@ "default": "apply_patch_call" }, "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -33100,8 +36157,14 @@ "default": "apply_patch_call_output" }, "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -33118,8 +36181,14 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -33170,22 +36239,34 @@ "description": "The ID of the container used to run the code." }, "code": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "outputs": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + "anyOf": [ + { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + } + ] } - ] - }, - "nullable": true + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -33204,8 +36285,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "type": { "type": "string", @@ -33239,8 +36326,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -33261,19 +36354,27 @@ "$ref": "#/components/schemas/OpenAI.ComputerScreenshotImage" }, "acknowledged_safety_checks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" + } + }, + { + "type": "null" + } + ] }, "status": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "allOf": [ @@ -33290,7 +36391,6 @@ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -33314,6 +36414,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -33364,6 +36467,10 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -33468,11 +36575,17 @@ "description": "The queries used to search for files." }, "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -33492,8 +36605,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -33535,12 +36654,14 @@ "description": "Text, image, or file output of the function tool call." }, "status": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "allOf": [ @@ -33560,8 +36681,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -33587,21 +36714,24 @@ "description": "The shell commands and limits that describe how to run the tool call." }, "status": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemStatus" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "environment": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemParamEnvironment" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "allOf": [ @@ -33621,8 +36751,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -33647,21 +36783,24 @@ "description": "Captured chunks of stdout and stderr output, along with their associated outcomes." }, "status": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemStatus" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "max_output_length": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "allOf": [ @@ -33675,6 +36814,7 @@ "OpenAI.InputItemFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", "name", @@ -33683,7 +36823,8 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", @@ -33697,6 +36838,10 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, "name": { "type": "string", "description": "The name of the function to run." @@ -33755,8 +36900,14 @@ "description": "The status of the image generation call." }, "result": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -33839,13 +36990,19 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "nullable": true + "anyOf": [ + { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -33916,8 +37073,14 @@ "x-stainless-const": true }, "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "approval_request_id": { "type": "string", @@ -33928,8 +37091,14 @@ "description": "Whether the request was approved." }, "reason": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -33973,8 +37142,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -34020,12 +37188,18 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "error": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, "status": { "allOf": [ @@ -34036,8 +37210,14 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -34085,6 +37265,16 @@ }, "description": "The content of the output message." }, + "phase": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + }, + { + "type": "null" + } + ] + }, "status": { "type": "string", "enum": [ @@ -34124,8 +37314,14 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "summary": { "type": "array", @@ -34159,6 +37355,143 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, + "OpenAI.InputItemToolSearchCallItemParam": { + "type": "object", + "required": [ + "type", + "arguments" + ], + "properties": { + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The item type. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.EmptyModelParam" + } + ], + "description": "The arguments supplied to the tool search call." + }, + "status": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + }, + { + "type": "null" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.InputItem" + } + ] + }, + "OpenAI.InputItemToolSearchOutputItemParam": { + "type": "object", + "required": [ + "type", + "tools" + ], + "properties": { + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The item type. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by the tool search output." + }, + "status": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + }, + { + "type": "null" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.InputItem" + } + ] + }, "OpenAI.InputItemType": { "anyOf": [ { @@ -34175,6 +37508,9 @@ "web_search_call", "function_call", "function_call_output", + "tool_search_call", + "tool_search_output", + "additional_tools", "reasoning", "compaction", "image_generation_call", @@ -34250,52 +37586,6 @@ "description": "The results of a web search tool call. See the\n[web search guide](/docs/guides/tools-web-search) for more information.", "title": "Web search tool call" }, - "OpenAI.InputMessage": { - "type": "object", - "required": [ - "type", - "role", - "content" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "message" - ], - "description": "The type of the message input. Always set to `message`.", - "x-stainless-const": true - }, - "role": { - "type": "string", - "enum": [ - "user", - "system", - "developer" - ], - "description": "The role of the message input. One of `user`, `system`, or `developer`." - }, - "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - }, - "content": { - "$ref": "#/components/schemas/OpenAI.InputMessageContentList" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Item" - } - ], - "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role.", - "title": "Input message" - }, "OpenAI.InputMessageContentList": { "type": "array", "items": { @@ -34304,55 +37594,6 @@ "description": "A list of one or many input items to the model, containing different content\ntypes.", "title": "Input item content list" }, - "OpenAI.InputMessageResource": { - "type": "object", - "required": [ - "type", - "role", - "content", - "id" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "message" - ], - "description": "The type of the message input. Always set to `message`.", - "x-stainless-const": true - }, - "role": { - "type": "string", - "enum": [ - "user", - "system", - "developer" - ], - "description": "The role of the message input. One of `user`, `system`, or `developer`." - }, - "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - }, - "content": { - "$ref": "#/components/schemas/OpenAI.InputMessageContentList" - }, - "id": { - "type": "string", - "description": "The unique ID of the message input." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemResource" - } - ] - }, "OpenAI.InputParam": { "oneOf": [ { @@ -34429,7 +37670,7 @@ "discriminator": { "propertyName": "type", "mapping": { - "message": "#/components/schemas/OpenAI.InputMessage", + "message": "#/components/schemas/OpenAI.ItemInputMessage", "output_message": "#/components/schemas/OpenAI.ItemOutputMessage", "file_search_call": "#/components/schemas/OpenAI.ItemFileSearchToolCall", "computer_call": "#/components/schemas/OpenAI.ItemComputerToolCall", @@ -34437,6 +37678,9 @@ "web_search_call": "#/components/schemas/OpenAI.ItemWebSearchToolCall", "function_call": "#/components/schemas/OpenAI.ItemFunctionToolCall", "function_call_output": "#/components/schemas/OpenAI.ItemFunctionCallOutputItemParam", + "tool_search_call": "#/components/schemas/OpenAI.ItemToolSearchCallItemParam", + "tool_search_output": "#/components/schemas/OpenAI.ItemToolSearchOutputItemParam", + "additional_tools": "#/components/schemas/OpenAI.ItemAdditionalToolsItemParam", "reasoning": "#/components/schemas/OpenAI.ItemReasoningItem", "compaction": "#/components/schemas/OpenAI.ItemCompactionSummaryItemParam", "image_generation_call": "#/components/schemas/OpenAI.ItemImageGenToolCall", @@ -34457,6 +37701,56 @@ }, "description": "Content item used to generate a response." }, + "OpenAI.ItemAdditionalToolsItemParam": { + "type": "object", + "required": [ + "type", + "role", + "tools" + ], + "properties": { + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "additional_tools" + ], + "description": "The item type. Always `additional_tools`.", + "x-stainless-const": true, + "default": "additional_tools" + }, + "role": { + "type": "string", + "enum": [ + "developer" + ], + "description": "The role that provided the additional tools. Only `developer` is supported.", + "x-stainless-const": true, + "default": "developer" + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "A list of additional tools made available at this item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Item" + } + ] + }, "OpenAI.ItemApplyPatchToolCallItemParam": { "type": "object", "required": [ @@ -34476,8 +37770,14 @@ "default": "apply_patch_call" }, "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -34528,8 +37828,14 @@ "default": "apply_patch_call_output" }, "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -34546,8 +37852,14 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -34598,22 +37910,34 @@ "description": "The ID of the container used to run the code." }, "code": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "outputs": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + "anyOf": [ + { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + } + ] } - ] - }, - "nullable": true + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -34632,8 +37956,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "type": { "type": "string", @@ -34667,8 +37997,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -34689,19 +38025,27 @@ "$ref": "#/components/schemas/OpenAI.ComputerScreenshotImage" }, "acknowledged_safety_checks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" + } + }, + { + "type": "null" + } + ] }, "status": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "allOf": [ @@ -34718,7 +38062,6 @@ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -34742,6 +38085,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -34792,6 +38138,10 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -34869,14 +38219,17 @@ "discriminator": { "propertyName": "type", "mapping": { - "function_call_output": "#/components/schemas/OpenAI.FunctionToolCallOutput", "message": "#/components/schemas/OpenAI.ItemFieldMessage", "function_call": "#/components/schemas/OpenAI.ItemFieldFunctionToolCall", + "tool_search_call": "#/components/schemas/OpenAI.ItemFieldToolSearchCall", + "tool_search_output": "#/components/schemas/OpenAI.ItemFieldToolSearchOutput", + "additional_tools": "#/components/schemas/OpenAI.ItemFieldAdditionalTools", + "function_call_output": "#/components/schemas/OpenAI.ItemFieldFunctionToolCallOutput", "file_search_call": "#/components/schemas/OpenAI.ItemFieldFileSearchToolCall", "web_search_call": "#/components/schemas/OpenAI.ItemFieldWebSearchToolCall", "image_generation_call": "#/components/schemas/OpenAI.ItemFieldImageGenToolCall", "computer_call": "#/components/schemas/OpenAI.ItemFieldComputerToolCall", - "computer_call_output": "#/components/schemas/OpenAI.ItemFieldComputerToolCallOutputResource", + "computer_call_output": "#/components/schemas/OpenAI.ItemFieldComputerToolCallOutput", "reasoning": "#/components/schemas/OpenAI.ItemFieldReasoningItem", "compaction": "#/components/schemas/OpenAI.ItemFieldCompactionBody", "code_interpreter_call": "#/components/schemas/OpenAI.ItemFieldCodeInterpreterToolCall", @@ -34896,6 +38249,50 @@ }, "description": "An item representing a message, tool call, tool output, reasoning, or other response element." }, + "OpenAI.ItemFieldAdditionalTools": { + "type": "object", + "required": [ + "type", + "id", + "role", + "tools" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "additional_tools" + ], + "description": "The type of the item. Always `additional_tools`.", + "x-stainless-const": true, + "default": "additional_tools" + }, + "id": { + "type": "string", + "description": "The unique ID of the additional tools item." + }, + "role": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessageRole" + } + ], + "description": "The role that provided the additional tools." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The additional tool definitions made available at this item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemField" + } + ] + }, "OpenAI.ItemFieldApplyPatchToolCall": { "type": "object", "required": [ @@ -34988,8 +38385,14 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "created_by": { "type": "string", @@ -35044,22 +38447,34 @@ "description": "The ID of the container used to run the code." }, "code": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "outputs": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + "anyOf": [ + { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + } + ] } - ] - }, - "nullable": true + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -35114,7 +38529,6 @@ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -35138,6 +38552,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -35163,10 +38580,11 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.ItemFieldComputerToolCallOutputResource": { + "OpenAI.ItemFieldComputerToolCallOutput": { "type": "object", "required": [ "type", + "id", "call_id", "output" ], @@ -35182,7 +38600,8 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output." + "description": "The ID of the computer tool call output.", + "readOnly": true }, "call_id": { "type": "string", @@ -35212,7 +38631,9 @@ { "$ref": "#/components/schemas/OpenAI.ItemField" } - ] + ], + "description": "The output of a computer tool call.", + "title": "Computer tool call output" }, "OpenAI.ItemFieldCustomToolCall": { "type": "object", @@ -35239,6 +38660,10 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -35343,11 +38768,17 @@ "description": "The queries used to search for files." }, "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -35397,19 +38828,20 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." }, "environment": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallEnvironment" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "created_by": { "type": "string", @@ -35455,7 +38887,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -35468,13 +38900,14 @@ "description": "An array of shell call output contents" }, "max_output_length": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "created_by": { "type": "string", @@ -35492,6 +38925,7 @@ "OpenAI.ItemFieldFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", "name", @@ -35500,7 +38934,8 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", @@ -35514,6 +38949,10 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, "name": { "type": "string", "description": "The name of the function to run." @@ -35540,6 +38979,64 @@ "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", "title": "Function tool call" }, + "OpenAI.ItemFieldFunctionToolCallOutput": { + "type": "object", + "required": [ + "id", + "type", + "call_id", + "output" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", + "readOnly": true + }, + "type": { + "type": "string", + "enum": [ + "function_call_output" + ], + "description": "The type of the function tool call output. Always `function_call_output`.", + "x-stainless-const": true + }, + "call_id": { + "type": "string", + "description": "The unique ID of the function tool call generated by the model." + }, + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemField" + } + ], + "description": "The output of a function tool call.", + "title": "Function tool call output" + }, "OpenAI.ItemFieldImageGenToolCall": { "type": "object", "required": [ @@ -35572,8 +39069,14 @@ "description": "The status of the image generation call." }, "result": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -35656,13 +39159,19 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "nullable": true + "anyOf": [ + { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -35746,8 +39255,14 @@ "description": "Whether the request was approved." }, "reason": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -35791,8 +39306,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -35838,12 +39352,18 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "error": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, "status": { "allOf": [ @@ -35854,8 +39374,14 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -35911,6 +39437,16 @@ "$ref": "#/components/schemas/OpenAI.MessageContent" }, "description": "The content of the message" + }, + "phase": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -35942,8 +39478,14 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "summary": { "type": "array", @@ -35977,6 +39519,138 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, + "OpenAI.ItemFieldToolSearchCall": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "arguments", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The type of the item. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search call item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "description": "Arguments used for the tool search call." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the tool search call item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemField" + } + ] + }, + "OpenAI.ItemFieldToolSearchOutput": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "tools", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The type of the item. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search output item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by tool search." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the tool search output item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemField" + } + ] + }, "OpenAI.ItemFieldType": { "anyOf": [ { @@ -35987,6 +39661,9 @@ "enum": [ "message", "function_call", + "tool_search_call", + "tool_search_output", + "additional_tools", "function_call_output", "file_search_call", "web_search_call", @@ -36106,11 +39783,17 @@ "description": "The queries used to search for files." }, "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -36130,8 +39813,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -36173,12 +39862,14 @@ "description": "Text, image, or file output of the function tool call." }, "status": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "allOf": [ @@ -36198,8 +39889,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -36225,21 +39922,24 @@ "description": "The shell commands and limits that describe how to run the tool call." }, "status": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemStatus" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "environment": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemParamEnvironment" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "allOf": [ @@ -36259,8 +39959,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -36285,21 +39991,24 @@ "description": "Captured chunks of stdout and stderr output, along with their associated outcomes." }, "status": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemStatus" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "max_output_length": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "allOf": [ @@ -36313,6 +40022,7 @@ "OpenAI.ItemFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", "name", @@ -36321,7 +40031,8 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", @@ -36335,6 +40046,10 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, "name": { "type": "string", "description": "The name of the function to run." @@ -36393,8 +40108,14 @@ "description": "The status of the image generation call." }, "result": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -36405,6 +40126,59 @@ "description": "An image generation request made by the model.", "title": "Image generation call" }, + "OpenAI.ItemInputMessage": { + "type": "object", + "required": [ + "type", + "role", + "content", + "id" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "message" + ], + "description": "The type of the message input. Always set to `message`.", + "x-stainless-const": true, + "default": "message" + }, + "role": { + "type": "string", + "enum": [ + "user", + "system", + "developer" + ], + "description": "The role of the message input. One of `user`, `system`, or `developer`." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "content": { + "$ref": "#/components/schemas/OpenAI.InputMessageContentList" + }, + "id": { + "type": "string", + "description": "The unique ID of the message input.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Item" + } + ], + "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role.", + "title": "Input message" + }, "OpenAI.ItemLocalShellToolCall": { "type": "object", "required": [ @@ -36477,13 +40251,19 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "nullable": true + "anyOf": [ + { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -36554,8 +40334,14 @@ "x-stainless-const": true }, "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "approval_request_id": { "type": "string", @@ -36566,8 +40352,14 @@ "description": "Whether the request was approved." }, "reason": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -36611,8 +40403,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -36658,12 +40449,18 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "error": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, "status": { "allOf": [ @@ -36674,8 +40471,14 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -36723,6 +40526,16 @@ }, "description": "The content of the output message." }, + "phase": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + }, + { + "type": "null" + } + ] + }, "status": { "type": "string", "enum": [ @@ -36762,8 +40575,14 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "summary": { "type": "array", @@ -36810,8 +40629,7 @@ "item_reference" ], "description": "The type of item to reference. Always `item_reference`.", - "x-stainless-const": true, - "default": "item_reference" + "x-stainless-const": true }, "id": { "type": "string", @@ -36839,14 +40657,19 @@ "discriminator": { "propertyName": "type", "mapping": { - "message": "#/components/schemas/OpenAI.InputMessageResource", + "message": "#/components/schemas/OpenAI.ItemResourceInputMessage", "output_message": "#/components/schemas/OpenAI.ItemResourceOutputMessage", "file_search_call": "#/components/schemas/OpenAI.ItemResourceFileSearchToolCall", "computer_call": "#/components/schemas/OpenAI.ItemResourceComputerToolCall", - "computer_call_output": "#/components/schemas/OpenAI.ItemResourceComputerToolCallOutputResource", + "computer_call_output": "#/components/schemas/OpenAI.ItemResourceComputerToolCallOutput", "web_search_call": "#/components/schemas/OpenAI.ItemResourceWebSearchToolCall", - "function_call": "#/components/schemas/OpenAI.ItemResourceFunctionToolCallResource", - "function_call_output": "#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutputResource", + "function_call": "#/components/schemas/OpenAI.ItemResourceFunctionToolCall", + "function_call_output": "#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutput", + "tool_search_call": "#/components/schemas/OpenAI.ItemResourceToolSearchCall", + "tool_search_output": "#/components/schemas/OpenAI.ItemResourceToolSearchOutput", + "additional_tools": "#/components/schemas/OpenAI.ItemResourceAdditionalTools", + "reasoning": "#/components/schemas/OpenAI.ItemResourceReasoningItem", + "compaction": "#/components/schemas/OpenAI.ItemResourceCompactionBody", "image_generation_call": "#/components/schemas/OpenAI.ItemResourceImageGenToolCall", "code_interpreter_call": "#/components/schemas/OpenAI.ItemResourceCodeInterpreterToolCall", "local_shell_call": "#/components/schemas/OpenAI.ItemResourceLocalShellToolCall", @@ -36858,11 +40681,57 @@ "mcp_list_tools": "#/components/schemas/OpenAI.ItemResourceMcpListTools", "mcp_approval_request": "#/components/schemas/OpenAI.ItemResourceMcpApprovalRequest", "mcp_approval_response": "#/components/schemas/OpenAI.ItemResourceMcpApprovalResponseResource", - "mcp_call": "#/components/schemas/OpenAI.ItemResourceMcpToolCall" + "mcp_call": "#/components/schemas/OpenAI.ItemResourceMcpToolCall", + "custom_tool_call": "#/components/schemas/OpenAI.ItemResourceCustomToolCallResource", + "custom_tool_call_output": "#/components/schemas/OpenAI.ItemResourceCustomToolCallOutputResource" } }, "description": "Content item used to generate a response." }, + "OpenAI.ItemResourceAdditionalTools": { + "type": "object", + "required": [ + "type", + "id", + "role", + "tools" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "additional_tools" + ], + "description": "The type of the item. Always `additional_tools`.", + "x-stainless-const": true, + "default": "additional_tools" + }, + "id": { + "type": "string", + "description": "The unique ID of the additional tools item." + }, + "role": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessageRole" + } + ], + "description": "The role that provided the additional tools." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The additional tool definitions made available at this item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ] + }, "OpenAI.ItemResourceApplyPatchToolCall": { "type": "object", "required": [ @@ -36955,8 +40824,14 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "created_by": { "type": "string", @@ -37011,22 +40886,34 @@ "description": "The ID of the container used to run the code." }, "code": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "outputs": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + "anyOf": [ + { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + } + ] } - ] - }, - "nullable": true + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -37037,13 +40924,50 @@ "description": "A tool call to run code.", "title": "Code interpreter tool call" }, + "OpenAI.ItemResourceCompactionBody": { + "type": "object", + "required": [ + "type", + "id", + "encrypted_content" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "compaction" + ], + "description": "The type of the item. Always `compaction`.", + "x-stainless-const": true, + "default": "compaction" + }, + "id": { + "type": "string", + "description": "The unique ID of the compaction item." + }, + "encrypted_content": { + "type": "string", + "description": "The encrypted content that was produced by compaction." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "description": "A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact).", + "title": "Compaction item" + }, "OpenAI.ItemResourceComputerToolCall": { "type": "object", "required": [ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -37067,6 +40991,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -37092,10 +41019,11 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.ItemResourceComputerToolCallOutputResource": { + "OpenAI.ItemResourceComputerToolCallOutput": { "type": "object", "required": [ "type", + "id", "call_id", "output" ], @@ -37111,7 +41039,8 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output." + "description": "The ID of the computer tool call output.", + "readOnly": true }, "call_id": { "type": "string", @@ -37141,7 +41070,126 @@ { "$ref": "#/components/schemas/OpenAI.ItemResource" } - ] + ], + "description": "The output of a computer tool call.", + "title": "Computer tool call output" + }, + "OpenAI.ItemResourceCustomToolCallOutputResource": { + "type": "object", + "required": [ + "type", + "call_id", + "output", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "custom_tool_call_output" + ], + "description": "The type of the custom tool call output. Always `custom_tool_call_output`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the custom tool call output in the OpenAI platform." + }, + "call_id": { + "type": "string", + "description": "The call ID, used to map this custom tool call output to a custom tool call." + }, + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "title": "ResponseCustomToolCallOutputItem" + }, + "OpenAI.ItemResourceCustomToolCallResource": { + "type": "object", + "required": [ + "type", + "call_id", + "name", + "input", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "custom_tool_call" + ], + "description": "The type of the custom tool call. Always `custom_tool_call`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the custom tool call in the OpenAI platform." + }, + "call_id": { + "type": "string", + "description": "An identifier used to map this custom tool call to a tool call output." + }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, + "name": { + "type": "string", + "description": "The name of the custom tool being called." + }, + "input": { + "type": "string", + "description": "The input for the custom tool call generated by the model." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "title": "ResponseCustomToolCallItem" }, "OpenAI.ItemResourceFileSearchToolCall": { "type": "object", @@ -37183,11 +41231,17 @@ "description": "The queries used to search for files." }, "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -37237,19 +41291,20 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." }, "environment": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallEnvironment" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "created_by": { "type": "string", @@ -37295,30 +41350,88 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." }, - "output": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputContent" - }, - "description": "An array of shell call output contents" + "output": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputContent" + }, + "description": "An array of shell call output contents" + }, + "max_output_length": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" + } + ] + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "description": "The output of a shell tool call that was emitted.", + "title": "Shell call output" + }, + "OpenAI.ItemResourceFunctionToolCall": { + "type": "object", + "required": [ + "id", + "type", + "call_id", + "name", + "arguments" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique ID of the function tool call.", + "readOnly": true + }, + "type": { + "type": "string", + "enum": [ + "function_call" + ], + "description": "The type of the function tool call. Always `function_call`.", + "x-stainless-const": true + }, + "call_id": { + "type": "string", + "description": "The unique ID of the function tool call generated by the model." + }, + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, + "name": { + "type": "string", + "description": "The name of the function to run." }, - "max_output_length": { - "type": "integer", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - } - ], - "nullable": true + "arguments": { + "type": "string", + "description": "A JSON string of the arguments to pass to the function." }, - "created_by": { + "status": { "type": "string", - "description": "The identifier of the actor that created the item." + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." } }, "allOf": [ @@ -37326,12 +41439,13 @@ "$ref": "#/components/schemas/OpenAI.ItemResource" } ], - "description": "The output of a shell tool call that was emitted.", - "title": "Shell call output" + "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", + "title": "Function tool call" }, - "OpenAI.ItemResourceFunctionToolCallOutputResource": { + "OpenAI.ItemResourceFunctionToolCallOutput": { "type": "object", "required": [ + "id", "type", "call_id", "output" @@ -37339,7 +41453,8 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", + "readOnly": true }, "type": { "type": "string", @@ -37381,91 +41496,103 @@ { "$ref": "#/components/schemas/OpenAI.ItemResource" } - ] + ], + "description": "The output of a function tool call.", + "title": "Function tool call output" }, - "OpenAI.ItemResourceFunctionToolCallResource": { + "OpenAI.ItemResourceImageGenToolCall": { "type": "object", "required": [ "type", - "call_id", - "name", - "arguments" + "id", + "status", + "result" ], "properties": { - "id": { - "type": "string", - "description": "The unique ID of the function tool call." - }, "type": { "type": "string", "enum": [ - "function_call" + "image_generation_call" ], - "description": "The type of the function tool call. Always `function_call`.", + "description": "The type of the image generation call. Always `image_generation_call`.", "x-stainless-const": true }, - "call_id": { - "type": "string", - "description": "The unique ID of the function tool call generated by the model." - }, - "name": { - "type": "string", - "description": "The name of the function to run." - }, - "arguments": { + "id": { "type": "string", - "description": "A JSON string of the arguments to pass to the function." + "description": "The unique ID of the image generation call." }, "status": { "type": "string", "enum": [ "in_progress", "completed", - "incomplete" + "generating", + "failed" ], - "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + "description": "The status of the image generation call." + }, + "result": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ { "$ref": "#/components/schemas/OpenAI.ItemResource" } - ] + ], + "description": "An image generation request made by the model.", + "title": "Image generation call" }, - "OpenAI.ItemResourceImageGenToolCall": { + "OpenAI.ItemResourceInputMessage": { "type": "object", "required": [ "type", - "id", - "status", - "result" + "role", + "content", + "id" ], "properties": { "type": { "type": "string", "enum": [ - "image_generation_call" + "message" ], - "description": "The type of the image generation call. Always `image_generation_call`.", - "x-stainless-const": true + "description": "The type of the message input. Always set to `message`.", + "x-stainless-const": true, + "default": "message" }, - "id": { + "role": { "type": "string", - "description": "The unique ID of the image generation call." + "enum": [ + "user", + "system", + "developer" + ], + "description": "The role of the message input. One of `user`, `system`, or `developer`." }, "status": { "type": "string", "enum": [ "in_progress", "completed", - "generating", - "failed" + "incomplete" ], - "description": "The status of the image generation call." + "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." }, - "result": { + "content": { + "$ref": "#/components/schemas/OpenAI.InputMessageContentList" + }, + "id": { "type": "string", - "nullable": true + "description": "The unique ID of the message input.", + "readOnly": true } }, "allOf": [ @@ -37473,8 +41600,8 @@ "$ref": "#/components/schemas/OpenAI.ItemResource" } ], - "description": "An image generation request made by the model.", - "title": "Image generation call" + "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role.", + "title": "Input message" }, "OpenAI.ItemResourceLocalShellToolCall": { "type": "object", @@ -37548,13 +41675,19 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "nullable": true + "anyOf": [ + { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -37638,8 +41771,14 @@ "description": "Whether the request was approved." }, "reason": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -37683,8 +41822,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -37730,12 +41868,18 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "error": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, "status": { "allOf": [ @@ -37746,8 +41890,14 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -37795,6 +41945,16 @@ }, "description": "The content of the output message." }, + "phase": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + }, + { + "type": "null" + } + ] + }, "status": { "type": "string", "enum": [ @@ -37813,6 +41973,200 @@ "description": "An output message from the model.", "title": "Output message" }, + "OpenAI.ItemResourceReasoningItem": { + "type": "object", + "required": [ + "type", + "id", + "summary" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "reasoning" + ], + "description": "The type of the object. Always `reasoning`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique identifier of the reasoning content." + }, + "encrypted_content": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "summary": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.SummaryTextContent" + }, + "description": "Reasoning summary content." + }, + "content": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ReasoningTextContent" + }, + "description": "Reasoning text content." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", + "title": "Reasoning" + }, + "OpenAI.ItemResourceToolSearchCall": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "arguments", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The type of the item. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search call item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "description": "Arguments used for the tool search call." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the tool search call item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ] + }, + "OpenAI.ItemResourceToolSearchOutput": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "tools", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The type of the item. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search output item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by tool search." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the tool search output item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ] + }, "OpenAI.ItemResourceType": { "anyOf": [ { @@ -37829,6 +42183,11 @@ "web_search_call", "function_call", "function_call_output", + "tool_search_call", + "tool_search_output", + "additional_tools", + "reasoning", + "compaction", "image_generation_call", "code_interpreter_call", "local_shell_call", @@ -37841,6 +42200,8 @@ "mcp_approval_request", "mcp_approval_response", "mcp_call", + "custom_tool_call", + "custom_tool_call_output", "structured_outputs", "oauth_consent_request", "memory_search_call", @@ -37923,6 +42284,143 @@ "description": "The results of a web search tool call. See the\n[web search guide](/docs/guides/tools-web-search) for more information.", "title": "Web search tool call" }, + "OpenAI.ItemToolSearchCallItemParam": { + "type": "object", + "required": [ + "type", + "arguments" + ], + "properties": { + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The item type. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.EmptyModelParam" + } + ], + "description": "The arguments supplied to the tool search call." + }, + "status": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + }, + { + "type": "null" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Item" + } + ] + }, + "OpenAI.ItemToolSearchOutputItemParam": { + "type": "object", + "required": [ + "type", + "tools" + ], + "properties": { + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The item type. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by the tool search output." + }, + "status": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + }, + { + "type": "null" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Item" + } + ] + }, "OpenAI.ItemType": { "anyOf": [ { @@ -37939,6 +42437,9 @@ "web_search_call", "function_call", "function_call_output", + "tool_search_call", + "tool_search_output", + "additional_tools", "reasoning", "compaction", "image_generation_call", @@ -38050,8 +42551,7 @@ "keypress" ], "description": "Specifies the event type. For a keypress action, this property is always set to `keypress`.", - "x-stainless-const": true, - "default": "keypress" + "x-stainless-const": true }, "keys": { "type": "array", @@ -38092,12 +42592,24 @@ "x-stainless-const": true }, "first_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "last_id": { - "type": "string", - "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "x-ms-list-continuation-token": true }, "has_more": { @@ -38171,8 +42683,7 @@ "local" ], "description": "The environment type. Always `local`.", - "x-stainless-const": true, - "default": "local" + "x-stainless-const": true } }, "allOf": [ @@ -38183,22 +42694,6 @@ "description": "Represents the use of a local environment to perform shell actions.", "title": "Local Environment" }, - "OpenAI.LocalShellCallOutputStatusEnum": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, - "OpenAI.LocalShellCallStatus": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, "OpenAI.LocalShellExecAction": { "type": "object", "required": [ @@ -38224,29 +42719,42 @@ "description": "The command to run." }, "timeout_ms": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "working_directory": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "env": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Environment variables to set for the command.", "x-oaiTypeLabel": "map" }, "user": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "description": "Execute a shell command on the server.", @@ -38264,8 +42772,7 @@ "local_shell" ], "description": "The type of the local shell tool. Always `local_shell`.", - "x-stainless-const": true, - "default": "local_shell" + "x-stainless-const": true }, "name": { "type": "string", @@ -38349,8 +42856,14 @@ "description": "The name of the tool." }, "description": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "input_schema": { "allOf": [ @@ -38361,13 +42874,14 @@ "description": "The JSON schema describing the tool's input." }, "annotations": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.MCPListToolsToolAnnotations" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "description": "A tool available on an MCP server.", @@ -38426,11 +42940,17 @@ "description": "Optional description of the MCP server, used to provide more context." }, "headers": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "nullable": true + "anyOf": [ + { + "type": "object", + "unevaluatedProperties": { + "type": "string" + } + }, + { + "type": "null" + } + ] }, "allowed_tools": { "anyOf": [ @@ -38438,42 +42958,38 @@ "type": "array", "items": { "type": "string" - }, - "nullable": true + } }, { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.MCPToolFilter" - } - ], - "nullable": true + "$ref": "#/components/schemas/OpenAI.MCPToolFilter" + }, + { + "type": "null" } ] }, "require_approval": { "anyOf": [ { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" - } - ], - "nullable": true + "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" }, { "type": "string", "enum": [ "always", "never" - ], - "nullable": true + ] + }, + { + "type": "null" } ], "default": "always" }, + "defer_loading": { + "type": "boolean", + "description": "Whether this MCP tool is deferred and discovered via tool search." + }, "project_connection_id": { "type": "string", "description": "The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server." @@ -38547,7 +43063,8 @@ "reasoning_text": "#/components/schemas/OpenAI.MessageContentReasoningTextContent", "refusal": "#/components/schemas/OpenAI.MessageContentRefusalContent", "input_image": "#/components/schemas/OpenAI.MessageContentInputImageContent", - "input_file": "#/components/schemas/OpenAI.MessageContentInputFileContent" + "input_file": "#/components/schemas/OpenAI.MessageContentInputFileContent", + "summary_text": "#/components/schemas/OpenAI.SummaryTextContent" } }, "description": "A content part that makes up an input or output item." @@ -38568,21 +43085,35 @@ "default": "input_file" }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "filename": { "type": "string", "description": "The name of the file to be sent to the model." }, + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." + }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "allOf": [ @@ -38610,13 +43141,25 @@ "default": "input_image" }, "image_url": { - "type": "string", - "format": "uri", - "nullable": true + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ] }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "detail": { "allOf": [ @@ -38624,7 +43167,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "allOf": [ @@ -38787,6 +43330,14 @@ } ] }, + "OpenAI.MessagePhase": { + "type": "string", + "enum": [ + "commentary", + "final_answer" + ], + "description": "Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`).\nFor models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend\nphase on all assistant messages — dropping it can degrade performance. Not used for user messages." + }, "OpenAI.MessageRole": { "type": "string", "enum": [ @@ -38810,7 +43361,7 @@ }, "OpenAI.Metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -38819,18 +43370,13 @@ "OpenAI.ModelIdsCompaction": { "anyOf": [ { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ModelIdsResponses" - } - ], - "description": "Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models.", - "nullable": true + "$ref": "#/components/schemas/OpenAI.ModelIdsResponses" }, { - "type": "string", - "description": "Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models.", - "nullable": true + "type": "string" + }, + { + "type": "null" } ], "description": "Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models." @@ -38871,6 +43417,182 @@ } ] }, + "OpenAI.Moderation": { + "type": "object", + "required": [ + "input", + "output" + ], + "properties": { + "input": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ModerationEntry" + } + ], + "description": "Moderation for the response input." + }, + "output": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ModerationEntry" + } + ], + "description": "Moderation for the response output." + } + }, + "description": "Moderation results or errors for the response input and output.", + "title": "Moderation" + }, + "OpenAI.ModerationEntry": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/OpenAI.ModerationEntryType" + } + }, + "discriminator": { + "propertyName": "type", + "mapping": { + "moderation_result": "#/components/schemas/OpenAI.ModerationResultBody", + "error": "#/components/schemas/OpenAI.ModerationErrorBody" + } + }, + "description": "Moderation results or an error for a response moderation check." + }, + "OpenAI.ModerationEntryType": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "moderation_result", + "error" + ] + } + ] + }, + "OpenAI.ModerationErrorBody": { + "type": "object", + "required": [ + "type", + "code", + "message" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "error" + ], + "description": "The object type, which was always `error` for moderation failures.", + "x-stainless-const": true + }, + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ModerationEntry" + } + ], + "description": "An error produced while attempting moderation for the response input or output.", + "title": "Moderation error" + }, + "OpenAI.ModerationInputType": { + "type": "string", + "enum": [ + "text", + "image" + ] + }, + "OpenAI.ModerationParam": { + "type": "object", + "required": [ + "model" + ], + "properties": { + "model": { + "type": "string", + "description": "The moderation model to use for moderated completions, e.g. 'omni-moderation-latest'." + } + }, + "description": "Configuration for running moderation on the input and output of this response." + }, + "OpenAI.ModerationResultBody": { + "type": "object", + "required": [ + "type", + "model", + "flagged", + "categories", + "category_scores", + "category_applied_input_types" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "moderation_result" + ], + "description": "The object type, which was always `moderation_result` for successful moderation results.", + "x-stainless-const": true + }, + "model": { + "type": "string", + "description": "The moderation model that produced this result." + }, + "flagged": { + "type": "boolean", + "description": "A boolean indicating whether the content was flagged by any category." + }, + "categories": { + "type": "object", + "unevaluatedProperties": { + "type": "boolean" + }, + "description": "A dictionary of moderation categories to booleans, True if the input is flagged under this category.", + "x-oaiTypeLabel": "map" + }, + "category_scores": { + "type": "object", + "unevaluatedProperties": { + "$ref": "#/components/schemas/OpenAI.numeric" + }, + "description": "A dictionary of moderation categories to scores.", + "x-oaiTypeLabel": "map" + }, + "category_applied_input_types": { + "type": "object", + "unevaluatedProperties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ModerationInputType" + } + }, + "description": "Which modalities of input are reflected by the score for each category.", + "x-oaiTypeLabel": "map" + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ModerationEntry" + } + ], + "description": "A moderation result produced for the response input or output.", + "title": "Moderation result" + }, "OpenAI.MoveParam": { "type": "object", "required": [ @@ -38885,8 +43607,7 @@ "move" ], "description": "Specifies the event type. For a move action, this property is always set to `move`.", - "x-stainless-const": true, - "default": "move" + "x-stainless-const": true }, "x": { "allOf": [ @@ -38903,6 +43624,19 @@ } ], "description": "The y-coordinate to move to." + }, + "keys": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -38913,6 +43647,57 @@ "description": "A mouse move action.", "title": "Move" }, + "OpenAI.NamespaceToolParam": { + "type": "object", + "required": [ + "type", + "name", + "description", + "tools" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "namespace" + ], + "description": "The type of the tool. Always `namespace`.", + "x-stainless-const": true + }, + "name": { + "type": "string", + "minLength": 1, + "description": "The namespace name used in tool calls (for example, `crm`)." + }, + "description": { + "type": "string", + "minLength": 1, + "description": "A description of the namespace shown to the model." + }, + "tools": { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionToolParam" + }, + { + "$ref": "#/components/schemas/OpenAI.CustomToolParam" + } + ] + }, + "minItems": 1, + "description": "The function/custom tools available inside this namespace." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Tool" + } + ], + "description": "Groups function/custom tools under a shared namespace.", + "title": "Namespace" + }, "OpenAI.OutputContent": { "type": "object", "required": [ @@ -39101,13 +43886,19 @@ "output_message": "#/components/schemas/OpenAI.OutputItemOutputMessage", "file_search_call": "#/components/schemas/OpenAI.OutputItemFileSearchToolCall", "function_call": "#/components/schemas/OpenAI.OutputItemFunctionToolCall", + "function_call_output": "#/components/schemas/OpenAI.OutputItemFunctionToolCallOutput", "web_search_call": "#/components/schemas/OpenAI.OutputItemWebSearchToolCall", "computer_call": "#/components/schemas/OpenAI.OutputItemComputerToolCall", + "computer_call_output": "#/components/schemas/OpenAI.OutputItemComputerToolCallOutput", "reasoning": "#/components/schemas/OpenAI.OutputItemReasoningItem", + "tool_search_call": "#/components/schemas/OpenAI.OutputItemToolSearchCall", + "tool_search_output": "#/components/schemas/OpenAI.OutputItemToolSearchOutput", + "additional_tools": "#/components/schemas/OpenAI.OutputItemAdditionalTools", "compaction": "#/components/schemas/OpenAI.OutputItemCompactionBody", "image_generation_call": "#/components/schemas/OpenAI.OutputItemImageGenToolCall", "code_interpreter_call": "#/components/schemas/OpenAI.OutputItemCodeInterpreterToolCall", "local_shell_call": "#/components/schemas/OpenAI.OutputItemLocalShellToolCall", + "local_shell_call_output": "#/components/schemas/OpenAI.OutputItemLocalShellToolCallOutput", "shell_call": "#/components/schemas/OpenAI.OutputItemFunctionShellCall", "shell_call_output": "#/components/schemas/OpenAI.OutputItemFunctionShellCallOutput", "apply_patch_call": "#/components/schemas/OpenAI.OutputItemApplyPatchToolCall", @@ -39115,10 +43906,56 @@ "mcp_call": "#/components/schemas/OpenAI.OutputItemMcpToolCall", "mcp_list_tools": "#/components/schemas/OpenAI.OutputItemMcpListTools", "mcp_approval_request": "#/components/schemas/OpenAI.OutputItemMcpApprovalRequest", - "custom_tool_call": "#/components/schemas/OpenAI.OutputItemCustomToolCall" + "mcp_approval_response": "#/components/schemas/OpenAI.OutputItemMcpApprovalResponseResource", + "custom_tool_call": "#/components/schemas/OpenAI.OutputItemCustomToolCallResource", + "custom_tool_call_output": "#/components/schemas/OpenAI.OutputItemCustomToolCallOutputResource" } } }, + "OpenAI.OutputItemAdditionalTools": { + "type": "object", + "required": [ + "type", + "id", + "role", + "tools" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "additional_tools" + ], + "description": "The type of the item. Always `additional_tools`.", + "x-stainless-const": true, + "default": "additional_tools" + }, + "id": { + "type": "string", + "description": "The unique ID of the additional tools item." + }, + "role": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessageRole" + } + ], + "description": "The role that provided the additional tools." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The additional tool definitions made available at this item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ] + }, "OpenAI.OutputItemApplyPatchToolCall": { "type": "object", "required": [ @@ -39211,8 +44048,14 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "created_by": { "type": "string", @@ -39267,22 +44110,34 @@ "description": "The ID of the container used to run the code." }, "code": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "outputs": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + "anyOf": [ + { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + } + ] } - ] - }, - "nullable": true + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -39337,7 +44192,6 @@ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -39361,6 +44215,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -39386,13 +44243,128 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.OutputItemCustomToolCall": { + "OpenAI.OutputItemComputerToolCallOutput": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "output" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "computer_call_output" + ], + "description": "The type of the computer tool call output. Always `computer_call_output`.", + "x-stainless-const": true, + "default": "computer_call_output" + }, + "id": { + "type": "string", + "description": "The ID of the computer tool call output.", + "readOnly": true + }, + "call_id": { + "type": "string", + "description": "The ID of the computer tool call that produced the output." + }, + "acknowledged_safety_checks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" + }, + "description": "The safety checks reported by the API that have been acknowledged by the\n developer." + }, + "output": { + "$ref": "#/components/schemas/OpenAI.ComputerScreenshotImage" + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of the message input. One of `in_progress`, `completed`, or\n `incomplete`. Populated when input items are returned via API." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "description": "The output of a computer tool call.", + "title": "Computer tool call output" + }, + "OpenAI.OutputItemCustomToolCallOutputResource": { + "type": "object", + "required": [ + "type", + "call_id", + "output", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "custom_tool_call_output" + ], + "description": "The type of the custom tool call output. Always `custom_tool_call_output`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the custom tool call output in the OpenAI platform." + }, + "call_id": { + "type": "string", + "description": "The call ID, used to map this custom tool call output to a custom tool call." + }, + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "title": "ResponseCustomToolCallOutputItem" + }, + "OpenAI.OutputItemCustomToolCallResource": { "type": "object", "required": [ "type", "call_id", "name", - "input" + "input", + "status" ], "properties": { "type": { @@ -39411,6 +44383,10 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -39418,6 +44394,18 @@ "input": { "type": "string", "description": "The input for the custom tool call generated by the model." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." } }, "allOf": [ @@ -39425,8 +44413,7 @@ "$ref": "#/components/schemas/OpenAI.OutputItem" } ], - "description": "A call to a custom tool created by the model.", - "title": "Custom tool call" + "title": "ResponseCustomToolCallItem" }, "OpenAI.OutputItemFileSearchToolCall": { "type": "object", @@ -39468,11 +44455,17 @@ "description": "The queries used to search for files." }, "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -39522,19 +44515,20 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." }, "environment": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallEnvironment" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "created_by": { "type": "string", @@ -39580,7 +44574,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -39593,13 +44587,14 @@ "description": "An array of shell call output contents" }, "max_output_length": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "created_by": { "type": "string", @@ -39617,35 +44612,99 @@ "OpenAI.OutputItemFunctionToolCall": { "type": "object", "required": [ + "id", + "type", + "call_id", + "name", + "arguments" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique ID of the function tool call.", + "readOnly": true + }, + "type": { + "type": "string", + "enum": [ + "function_call" + ], + "description": "The type of the function tool call. Always `function_call`.", + "x-stainless-const": true + }, + "call_id": { + "type": "string", + "description": "The unique ID of the function tool call generated by the model." + }, + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, + "name": { + "type": "string", + "description": "The name of the function to run." + }, + "arguments": { + "type": "string", + "description": "A JSON string of the arguments to pass to the function." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", + "title": "Function tool call" + }, + "OpenAI.OutputItemFunctionToolCallOutput": { + "type": "object", + "required": [ + "id", "type", "call_id", - "name", - "arguments" + "output" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", + "readOnly": true }, "type": { "type": "string", "enum": [ - "function_call" + "function_call_output" ], - "description": "The type of the function tool call. Always `function_call`.", + "description": "The type of the function tool call output. Always `function_call_output`.", "x-stainless-const": true }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "name": { - "type": "string", - "description": "The name of the function to run." - }, - "arguments": { - "type": "string", - "description": "A JSON string of the arguments to pass to the function." + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." }, "status": { "type": "string", @@ -39662,8 +44721,8 @@ "$ref": "#/components/schemas/OpenAI.OutputItem" } ], - "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", - "title": "Function tool call" + "description": "The output of a function tool call.", + "title": "Function tool call output" }, "OpenAI.OutputItemImageGenToolCall": { "type": "object", @@ -39697,8 +44756,14 @@ "description": "The status of the image generation call." }, "result": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -39756,6 +44821,54 @@ "description": "A tool call to run a command on the local shell.", "title": "Local shell call" }, + "OpenAI.OutputItemLocalShellToolCallOutput": { + "type": "object", + "required": [ + "type", + "id", + "output" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "local_shell_call_output" + ], + "description": "The type of the local shell tool call output. Always `local_shell_call_output`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the local shell tool call generated by the model." + }, + "output": { + "type": "string", + "description": "A JSON string of the output of the local shell tool call." + }, + "status": { + "anyOf": [ + { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + { + "type": "null" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "description": "The output of a local shell tool call.", + "title": "Local shell call output" + }, "OpenAI.OutputItemMcpApprovalRequest": { "type": "object", "required": [ @@ -39799,6 +44912,54 @@ "description": "A request for human approval of a tool invocation.", "title": "MCP approval request" }, + "OpenAI.OutputItemMcpApprovalResponseResource": { + "type": "object", + "required": [ + "type", + "id", + "approval_request_id", + "approve" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "mcp_approval_response" + ], + "description": "The type of the item. Always `mcp_approval_response`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the approval response" + }, + "approval_request_id": { + "type": "string", + "description": "The ID of the approval request being answered." + }, + "approve": { + "type": "boolean", + "description": "Whether the request was approved." + }, + "reason": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "description": "A response to an MCP approval request.", + "title": "MCP approval response" + }, "OpenAI.OutputItemMcpListTools": { "type": "object", "required": [ @@ -39832,8 +44993,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -39879,12 +45039,18 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "error": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, "status": { "allOf": [ @@ -39895,8 +45061,14 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -39944,6 +45116,16 @@ }, "description": "The content of the output message." }, + "phase": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + }, + { + "type": "null" + } + ] + }, "status": { "type": "string", "enum": [ @@ -39983,8 +45165,14 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "summary": { "type": "array", @@ -40018,6 +45206,138 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, + "OpenAI.OutputItemToolSearchCall": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "arguments", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The type of the item. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search call item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "description": "Arguments used for the tool search call." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the tool search call item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ] + }, + "OpenAI.OutputItemToolSearchOutput": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "tools", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The type of the item. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search output item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by tool search." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the tool search output item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ] + }, "OpenAI.OutputItemType": { "anyOf": [ { @@ -40029,13 +45349,19 @@ "output_message", "file_search_call", "function_call", + "function_call_output", "web_search_call", "computer_call", + "computer_call_output", "reasoning", + "tool_search_call", + "tool_search_output", + "additional_tools", "compaction", "image_generation_call", "code_interpreter_call", "local_shell_call", + "local_shell_call_output", "shell_call", "shell_call_output", "apply_patch_call", @@ -40043,7 +45369,9 @@ "mcp_call", "mcp_list_tools", "mcp_approval_request", + "mcp_approval_response", "custom_tool_call", + "custom_tool_call_output", "structured_outputs", "oauth_consent_request", "memory_search_call", @@ -40242,21 +45570,35 @@ "description": "The unique identifier of the prompt template to use." }, "version": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "variables": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.ResponsePromptVariables" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "description": "Reference to a prompt template and its variables.\n[Learn more](/docs/guides/text?api-mode=responses#reusable-prompts)." }, + "OpenAI.PromptCacheRetentionEnum": { + "type": "string", + "enum": [ + "in_memory", + "24h" + ] + }, "OpenAI.RankerVersionType": { "type": "string", "enum": [ @@ -40293,46 +45635,181 @@ } } }, - "OpenAI.Reasoning": { + "OpenAI.RealtimeMCPError": { "type": "object", + "required": [ + "type" + ], "properties": { - "effort": { - "$ref": "#/components/schemas/OpenAI.ReasoningEffort" + "type": { + "$ref": "#/components/schemas/OpenAI.RealtimeMcpErrorType" + } + }, + "discriminator": { + "propertyName": "type", + "mapping": { + "protocol_error": "#/components/schemas/OpenAI.RealtimeMCPProtocolError", + "tool_execution_error": "#/components/schemas/OpenAI.RealtimeMCPToolExecutionError", + "http_error": "#/components/schemas/OpenAI.RealtimeMCPHTTPError" + } + } + }, + "OpenAI.RealtimeMCPHTTPError": { + "type": "object", + "required": [ + "type", + "code", + "message" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "http_error" + ], + "x-stainless-const": true }, - "summary": { + "code": { + "$ref": "#/components/schemas/OpenAI.integer" + }, + "message": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + } + ], + "title": "Realtime MCP HTTP error" + }, + "OpenAI.RealtimeMCPProtocolError": { + "type": "object", + "required": [ + "type", + "code", + "message" + ], + "properties": { + "type": { "type": "string", "enum": [ - "auto", - "concise", - "detailed" + "protocol_error" ], - "nullable": true + "x-stainless-const": true }, - "generate_summary": { + "code": { + "$ref": "#/components/schemas/OpenAI.integer" + }, + "message": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + } + ], + "title": "Realtime MCP protocol error" + }, + "OpenAI.RealtimeMCPToolExecutionError": { + "type": "object", + "required": [ + "type", + "message" + ], + "properties": { + "type": { "type": "string", "enum": [ - "auto", - "concise", - "detailed" + "tool_execution_error" ], - "nullable": true + "x-stainless-const": true + }, + "message": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + } + ], + "title": "Realtime MCP tool execution error" + }, + "OpenAI.RealtimeMcpErrorType": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "protocol_error", + "tool_execution_error", + "http_error" + ] + } + ] + }, + "OpenAI.Reasoning": { + "type": "object", + "properties": { + "effort": { + "$ref": "#/components/schemas/OpenAI.ReasoningEffort" + }, + "summary": { + "anyOf": [ + { + "type": "string", + "enum": [ + "auto", + "concise", + "detailed" + ] + }, + { + "type": "null" + } + ] + }, + "generate_summary": { + "anyOf": [ + { + "type": "string", + "enum": [ + "auto", + "concise", + "detailed" + ] + }, + { + "type": "null" + } + ] } }, "description": "**gpt-5 and o-series models only**\nConfiguration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).", "title": "Reasoning" }, "OpenAI.ReasoningEffort": { - "type": "string", - "enum": [ - "none", - "minimal", - "low", - "medium", - "high", - "xhigh" + "anyOf": [ + { + "type": "string", + "enum": [ + "none", + "minimal", + "low", + "medium", + "high", + "xhigh" + ] + }, + { + "type": "null" + } ], - "description": "Constrains effort on reasoning for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\nCurrently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing\nreasoning effort can result in faster responses and fewer tokens used\non reasoning in a response.\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is supported for all models after `gpt-5.1-codex-max`.", - "nullable": true + "description": "Constrains effort on reasoning for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\nCurrently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing\nreasoning effort can result in faster responses and fewer tokens used\non reasoning in a response.\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is supported for all models after `gpt-5.1-codex-max`." }, "OpenAI.ReasoningTextContent": { "type": "object", @@ -40373,41 +45850,45 @@ ], "properties": { "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "top_logprobs": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "temperature": { - "type": "number", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" + }, + { + "type": "null" } ], - "nullable": true, "default": 1 }, "top_p": { - "type": "number", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" + }, + { + "type": "null" } ], - "nullable": true, "default": 1 }, "user": { @@ -40417,7 +45898,8 @@ }, "safety_identifier": { "type": "string", - "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." + "maxLength": 64, + "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." }, "prompt_cache_key": { "type": "string", @@ -40427,51 +45909,62 @@ "$ref": "#/components/schemas/OpenAI.ServiceTier" }, "prompt_cache_retention": { - "type": "string", - "enum": [ - "in-memory", - "24h" - ], - "nullable": true + "anyOf": [ + { + "type": "string", + "enum": [ + "in_memory", + "24h" + ] + }, + { + "type": "null" + } + ] }, "previous_response_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "model": { "type": "string", "description": "The model deployment to use for the creation of this response." }, "reasoning": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Reasoning" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "background": { - "type": "boolean", - "nullable": true - }, - "max_output_tokens": { - "type": "integer", - "allOf": [ + "anyOf": [ { - "$ref": "#/components/schemas/OpenAI.integer" + "type": "boolean" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "max_tool_calls": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "text": { "$ref": "#/components/schemas/OpenAI.ResponseTextParam" @@ -40493,12 +45986,18 @@ "$ref": "#/components/schemas/OpenAI.Prompt" }, "truncation": { - "type": "string", - "enum": [ - "auto", - "disabled" + "anyOf": [ + { + "type": "string", + "enum": [ + "auto", + "disabled" + ] + }, + { + "type": "null" + } ], - "nullable": true, "default": "disabled" }, "id": { @@ -40531,27 +46030,37 @@ "description": "Unix timestamp (in seconds) of when this Response was created." }, "completed_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "type": "integer", - "format": "unixtime", - "nullable": true + "format": "unixTimestamp" }, "error": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.ResponseError" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "incomplete_details": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.ResponseIncompleteDetails" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "output": { "type": "array", @@ -40570,39 +46079,69 @@ "items": { "$ref": "#/components/schemas/OpenAI.InputItem" } + }, + { + "type": "null" } - ], - "nullable": true + ] }, "output_text": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "usage": { "$ref": "#/components/schemas/OpenAI.ResponseUsage" }, + "moderation": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.Moderation" + }, + { + "type": "null" + } + ] + }, "parallel_tool_calls": { "type": "boolean", "description": "Whether to allow the model to run tool calls in parallel.", "default": true }, "conversation": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.ConversationReference" + }, + { + "type": "null" } - ], - "nullable": true + ] + }, + "max_output_tokens": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" + } + ] }, "agent_reference": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/AgentReference" + }, + { + "type": "null" } ], - "nullable": true, "description": "The agent used for this response" }, "content_filters": { @@ -40641,10 +46180,15 @@ }, "delta": { "type": "string", - "format": "base64", + "contentEncoding": "base64", "description": "A chunk of Base64 encoded response audio bytes." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a partial audio response.", "x-oaiMeta": { "name": "response.audio.delta", @@ -40676,6 +46220,11 @@ "description": "The sequence number of the delta." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the audio response is complete.", "x-oaiMeta": { "name": "response.audio.done", @@ -40712,6 +46261,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a partial transcript of audio.", "x-oaiMeta": { "name": "response.audio.transcript.delta", @@ -40743,6 +46297,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the full audio transcript is completed.", "x-oaiMeta": { "name": "response.audio.transcript.done", @@ -40793,6 +46352,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a partial code snippet is streamed by the code interpreter.", "x-oaiMeta": { "name": "response.code_interpreter_call_code.delta", @@ -40843,6 +46407,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the code snippet is finalized by the code interpreter.", "x-oaiMeta": { "name": "response.code_interpreter_call_code.done", @@ -40888,6 +46457,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the code interpreter call is completed.", "x-oaiMeta": { "name": "response.code_interpreter_call.completed", @@ -40933,6 +46507,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a code interpreter call is in progress.", "x-oaiMeta": { "name": "response.code_interpreter_call.in_progress", @@ -40978,6 +46557,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the code interpreter is actively interpreting the code snippet.", "x-oaiMeta": { "name": "response.code_interpreter_call.interpreting", @@ -41018,6 +46602,11 @@ "description": "The sequence number for this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the model response is complete.", "x-oaiMeta": { "name": "response.completed", @@ -41081,6 +46670,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a new content part is added.", "x-oaiMeta": { "name": "response.content_part.added", @@ -41144,6 +46738,11 @@ "description": "The content part that is done." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a content part is done.", "x-oaiMeta": { "name": "response.content_part.done", @@ -41184,6 +46783,11 @@ "description": "The sequence number for this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "An event that is emitted when a response is created.", "x-oaiMeta": { "name": "response.created", @@ -41234,6 +46838,11 @@ "description": "The incremental input data (delta) for the custom tool call." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Event representing a delta (partial update) to the input of a custom tool call.", "title": "ResponseCustomToolCallInputDelta", "x-oaiMeta": { @@ -41285,6 +46894,11 @@ "description": "The complete input data for the custom tool call." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Event indicating that input for a custom tool call is complete.", "title": "ResponseCustomToolCallInputDone", "x-oaiMeta": { @@ -41353,16 +46967,28 @@ "x-stainless-const": true }, "code": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "message": { "type": "string", "description": "The error message." }, "param": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "sequence_number": { "allOf": [ @@ -41373,6 +46999,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an error occurs.", "x-oaiMeta": { "name": "error", @@ -41413,6 +47044,11 @@ "description": "The response that failed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "An event that is emitted when a response fails.", "x-oaiMeta": { "name": "response.failed", @@ -41458,6 +47094,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a file search call is completed (results found).", "x-oaiMeta": { "name": "response.file_search_call.completed", @@ -41503,6 +47144,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a file search call is initiated.", "x-oaiMeta": { "name": "response.file_search_call.in_progress", @@ -41548,6 +47194,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a file search is currently searching.", "x-oaiMeta": { "name": "response.file_search_call.searching", @@ -41622,14 +47273,20 @@ "$ref": "#/components/schemas/OpenAI.ResponseFormatJsonSchemaSchema" }, "strict": { - "type": "boolean", - "nullable": true + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] } } }, "OpenAI.ResponseFormatJsonSchemaSchema": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/).", "title": "JSON schema" }, @@ -41694,6 +47351,11 @@ "description": "The function-call arguments delta that is added." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a partial function-call arguments delta.", "x-oaiMeta": { "name": "response.function_call_arguments.delta", @@ -41748,6 +47410,11 @@ "description": "The function-call arguments." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when function-call arguments are finalized.", "x-oaiMeta": { "name": "response.function_call_arguments.done", @@ -41793,6 +47460,11 @@ "description": "The unique identifier of the image generation item being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an image generation tool call has completed and the final image is available.", "title": "ResponseImageGenCallCompletedEvent", "x-oaiMeta": { @@ -41839,6 +47511,11 @@ "description": "The sequence number of the image generation item being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an image generation tool call is actively generating an image (intermediate state).", "title": "ResponseImageGenCallGeneratingEvent", "x-oaiMeta": { @@ -41885,6 +47562,11 @@ "description": "The sequence number of the image generation item being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an image generation tool call is in progress.", "title": "ResponseImageGenCallInProgressEvent", "x-oaiMeta": { @@ -41945,6 +47627,11 @@ "description": "Base64-encoded partial image data, suitable for rendering as an image." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a partial image is available during image generation streaming.", "title": "ResponseImageGenCallPartialImageEvent", "x-oaiMeta": { @@ -41986,6 +47673,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the response is in progress.", "x-oaiMeta": { "name": "response.in_progress", @@ -42038,6 +47730,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "An event that is emitted when a response finishes as incomplete.", "x-oaiMeta": { "name": "response.incomplete", @@ -42069,7 +47766,7 @@ "items": { "$ref": "#/components/schemas/OpenAI.ResponseLogProbTopLogprobs" }, - "description": "The log probability of the top 20 most likely tokens." + "description": "The log probabilities of up to 20 of the most likely tokens." } }, "description": "A logprob is the logarithmic probability that the model assigns to producing\na particular token at a given position in the sequence. Less-negative (higher)\nlogprob values indicate greater model confidence in that token choice." @@ -42128,6 +47825,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a delta (partial update) to the arguments of an MCP tool call.", "title": "ResponseMCPCallArgumentsDeltaEvent", "x-oaiMeta": { @@ -42179,6 +47881,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the arguments for an MCP tool call are finalized.", "title": "ResponseMCPCallArgumentsDoneEvent", "x-oaiMeta": { @@ -42225,6 +47932,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an MCP tool call has completed successfully.", "title": "ResponseMCPCallCompletedEvent", "x-oaiMeta": { @@ -42271,6 +47983,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an MCP tool call has failed.", "title": "ResponseMCPCallFailedEvent", "x-oaiMeta": { @@ -42317,6 +48034,11 @@ "description": "The unique identifier of the MCP tool call item being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an MCP tool call is in progress.", "title": "ResponseMCPCallInProgressEvent", "x-oaiMeta": { @@ -42363,6 +48085,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the list of available MCP tools has been successfully retrieved.", "title": "ResponseMCPListToolsCompletedEvent", "x-oaiMeta": { @@ -42409,6 +48136,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the attempt to list available MCP tools has failed.", "title": "ResponseMCPListToolsFailedEvent", "x-oaiMeta": { @@ -42455,6 +48187,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the system is in the process of retrieving the list of available MCP tools.", "title": "ResponseMCPListToolsInProgressEvent", "x-oaiMeta": { @@ -42505,6 +48242,11 @@ "description": "The output item that was added." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a new output item is added.", "x-oaiMeta": { "name": "response.output_item.added", @@ -42554,6 +48296,11 @@ "description": "The output item that was marked done." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an output item is marked done.", "x-oaiMeta": { "name": "response.output_item.done", @@ -42626,6 +48373,11 @@ "description": "The annotation object being added. (See annotation schema for details.)" } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an annotation is added to output text content.", "title": "ResponseOutputTextAnnotationAddedEvent", "x-oaiMeta": { @@ -42636,7 +48388,7 @@ }, "OpenAI.ResponsePromptVariables": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "anyOf": [ { "type": "string" @@ -42690,6 +48442,11 @@ "description": "The sequence number for this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a response is queued and waiting to be processed.", "title": "ResponseQueuedEvent", "x-oaiMeta": { @@ -42754,6 +48511,11 @@ "description": "The summary part that was added." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a new reasoning summary part is added.", "x-oaiMeta": { "name": "response.reasoning_summary_part.added", @@ -42836,6 +48598,11 @@ "description": "The completed summary part." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a reasoning summary part is completed.", "x-oaiMeta": { "name": "response.reasoning_summary_part.done", @@ -42914,6 +48681,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a delta is added to a reasoning summary text.", "x-oaiMeta": { "name": "response.reasoning_summary_text.delta", @@ -42973,6 +48745,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a reasoning summary text is completed.", "x-oaiMeta": { "name": "response.reasoning_summary_text.done", @@ -43032,6 +48809,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a delta is added to a reasoning text.", "x-oaiMeta": { "name": "response.reasoning_text.delta", @@ -43091,6 +48873,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a reasoning text is completed.", "x-oaiMeta": { "name": "response.reasoning_text.done", @@ -43150,6 +48937,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a partial refusal text.", "x-oaiMeta": { "name": "response.refusal.delta", @@ -43209,6 +49001,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when refusal text is finalized.", "x-oaiMeta": { "name": "response.refusal.done", @@ -43216,6 +49013,140 @@ "example": "{\n \"type\": \"response.refusal.done\",\n \"item_id\": \"item-abc\",\n \"output_index\": 1,\n \"content_index\": 2,\n \"refusal\": \"final refusal text\",\n \"sequence_number\": 1\n}\n" } }, + "OpenAI.ResponseStreamEvent": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEventType" + } + }, + "discriminator": { + "propertyName": "type", + "mapping": { + "response.audio.transcript.delta": "#/components/schemas/OpenAI.ResponseAudioTranscriptDeltaEvent", + "response.code_interpreter_call_code.delta": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent", + "response.code_interpreter_call.in_progress": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallInProgressEvent", + "response.code_interpreter_call.interpreting": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallInterpretingEvent", + "response.content_part.added": "#/components/schemas/OpenAI.ResponseContentPartAddedEvent", + "response.created": "#/components/schemas/OpenAI.ResponseCreatedEvent", + "error": "#/components/schemas/OpenAI.ResponseErrorEvent", + "response.file_search_call.in_progress": "#/components/schemas/OpenAI.ResponseFileSearchCallInProgressEvent", + "response.file_search_call.searching": "#/components/schemas/OpenAI.ResponseFileSearchCallSearchingEvent", + "response.function_call_arguments.delta": "#/components/schemas/OpenAI.ResponseFunctionCallArgumentsDeltaEvent", + "response.in_progress": "#/components/schemas/OpenAI.ResponseInProgressEvent", + "response.failed": "#/components/schemas/OpenAI.ResponseFailedEvent", + "response.incomplete": "#/components/schemas/OpenAI.ResponseIncompleteEvent", + "response.output_item.added": "#/components/schemas/OpenAI.ResponseOutputItemAddedEvent", + "response.reasoning_summary_part.added": "#/components/schemas/OpenAI.ResponseReasoningSummaryPartAddedEvent", + "response.reasoning_summary_text.delta": "#/components/schemas/OpenAI.ResponseReasoningSummaryTextDeltaEvent", + "response.reasoning_text.delta": "#/components/schemas/OpenAI.ResponseReasoningTextDeltaEvent", + "response.refusal.delta": "#/components/schemas/OpenAI.ResponseRefusalDeltaEvent", + "response.output_text.delta": "#/components/schemas/OpenAI.ResponseTextDeltaEvent", + "response.web_search_call.in_progress": "#/components/schemas/OpenAI.ResponseWebSearchCallInProgressEvent", + "response.web_search_call.searching": "#/components/schemas/OpenAI.ResponseWebSearchCallSearchingEvent", + "response.image_generation_call.generating": "#/components/schemas/OpenAI.ResponseImageGenCallGeneratingEvent", + "response.image_generation_call.in_progress": "#/components/schemas/OpenAI.ResponseImageGenCallInProgressEvent", + "response.image_generation_call.partial_image": "#/components/schemas/OpenAI.ResponseImageGenCallPartialImageEvent", + "response.mcp_call_arguments.delta": "#/components/schemas/OpenAI.ResponseMCPCallArgumentsDeltaEvent", + "response.mcp_call.failed": "#/components/schemas/OpenAI.ResponseMCPCallFailedEvent", + "response.mcp_call.in_progress": "#/components/schemas/OpenAI.ResponseMCPCallInProgressEvent", + "response.mcp_list_tools.failed": "#/components/schemas/OpenAI.ResponseMCPListToolsFailedEvent", + "response.mcp_list_tools.in_progress": "#/components/schemas/OpenAI.ResponseMCPListToolsInProgressEvent", + "response.output_text.annotation.added": "#/components/schemas/OpenAI.ResponseOutputTextAnnotationAddedEvent", + "response.queued": "#/components/schemas/OpenAI.ResponseQueuedEvent", + "response.custom_tool_call_input.delta": "#/components/schemas/OpenAI.ResponseCustomToolCallInputDeltaEvent", + "response.audio.done": "#/components/schemas/OpenAI.ResponseAudioDoneEvent", + "response.audio.transcript.done": "#/components/schemas/OpenAI.ResponseAudioTranscriptDoneEvent", + "response.code_interpreter_call_code.done": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallCodeDoneEvent", + "response.code_interpreter_call.completed": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallCompletedEvent", + "response.completed": "#/components/schemas/OpenAI.ResponseCompletedEvent", + "response.content_part.done": "#/components/schemas/OpenAI.ResponseContentPartDoneEvent", + "response.file_search_call.completed": "#/components/schemas/OpenAI.ResponseFileSearchCallCompletedEvent", + "response.function_call_arguments.done": "#/components/schemas/OpenAI.ResponseFunctionCallArgumentsDoneEvent", + "response.output_item.done": "#/components/schemas/OpenAI.ResponseOutputItemDoneEvent", + "response.reasoning_summary_part.done": "#/components/schemas/OpenAI.ResponseReasoningSummaryPartDoneEvent", + "response.reasoning_summary_text.done": "#/components/schemas/OpenAI.ResponseReasoningSummaryTextDoneEvent", + "response.reasoning_text.done": "#/components/schemas/OpenAI.ResponseReasoningTextDoneEvent", + "response.refusal.done": "#/components/schemas/OpenAI.ResponseRefusalDoneEvent", + "response.output_text.done": "#/components/schemas/OpenAI.ResponseTextDoneEvent", + "response.web_search_call.completed": "#/components/schemas/OpenAI.ResponseWebSearchCallCompletedEvent", + "response.image_generation_call.completed": "#/components/schemas/OpenAI.ResponseImageGenCallCompletedEvent", + "response.mcp_call_arguments.done": "#/components/schemas/OpenAI.ResponseMCPCallArgumentsDoneEvent", + "response.mcp_call.completed": "#/components/schemas/OpenAI.ResponseMCPCallCompletedEvent", + "response.mcp_list_tools.completed": "#/components/schemas/OpenAI.ResponseMCPListToolsCompletedEvent", + "response.custom_tool_call_input.done": "#/components/schemas/OpenAI.ResponseCustomToolCallInputDoneEvent", + "response.audio.delta": "#/components/schemas/OpenAI.ResponseAudioDeltaEvent" + } + } + }, + "OpenAI.ResponseStreamEventType": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "response.audio.delta", + "response.audio.done", + "response.audio.transcript.delta", + "response.audio.transcript.done", + "response.code_interpreter_call_code.delta", + "response.code_interpreter_call_code.done", + "response.code_interpreter_call.completed", + "response.code_interpreter_call.in_progress", + "response.code_interpreter_call.interpreting", + "response.completed", + "response.content_part.added", + "response.content_part.done", + "response.created", + "error", + "response.file_search_call.completed", + "response.file_search_call.in_progress", + "response.file_search_call.searching", + "response.function_call_arguments.delta", + "response.function_call_arguments.done", + "response.in_progress", + "response.failed", + "response.incomplete", + "response.output_item.added", + "response.output_item.done", + "response.reasoning_summary_part.added", + "response.reasoning_summary_part.done", + "response.reasoning_summary_text.delta", + "response.reasoning_summary_text.done", + "response.reasoning_text.delta", + "response.reasoning_text.done", + "response.refusal.delta", + "response.refusal.done", + "response.output_text.delta", + "response.output_text.done", + "response.web_search_call.completed", + "response.web_search_call.in_progress", + "response.web_search_call.searching", + "response.image_generation_call.completed", + "response.image_generation_call.generating", + "response.image_generation_call.in_progress", + "response.image_generation_call.partial_image", + "response.mcp_call_arguments.delta", + "response.mcp_call_arguments.done", + "response.mcp_call.completed", + "response.mcp_call.failed", + "response.mcp_call.in_progress", + "response.mcp_list_tools.completed", + "response.mcp_list_tools.failed", + "response.mcp_list_tools.in_progress", + "response.output_text.annotation.added", + "response.queued", + "response.custom_tool_call_input.delta", + "response.custom_tool_call_input.done" + ] + } + ] + }, "OpenAI.ResponseStreamOptions": { "type": "object", "properties": { @@ -43286,6 +49217,11 @@ "description": "The log probabilities of the tokens in the delta." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is an additional text delta.", "x-oaiMeta": { "name": "response.output_text.delta", @@ -43353,6 +49289,11 @@ "description": "The log probabilities of the tokens in the delta." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when text content is finalized.", "x-oaiMeta": { "name": "response.output_text.done", @@ -43485,6 +49426,11 @@ "description": "The sequence number of the web search call being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a web search call is completed.", "x-oaiMeta": { "name": "response.web_search_call.completed", @@ -43530,6 +49476,11 @@ "description": "The sequence number of the web search call being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a web search call is initiated.", "x-oaiMeta": { "name": "response.web_search_call.in_progress", @@ -43575,6 +49526,11 @@ "description": "The sequence number of the web search call being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a web search call is executing.", "x-oaiMeta": { "name": "response.web_search_call.searching", @@ -43594,8 +49550,7 @@ "screenshot" ], "description": "Specifies the event type. For a screenshot action, this property is always set to `screenshot`.", - "x-stainless-const": true, - "default": "screenshot" + "x-stainless-const": true } }, "allOf": [ @@ -43622,8 +49577,7 @@ "scroll" ], "description": "Specifies the event type. For a scroll action, this property is always set to `scroll`.", - "x-stainless-const": true, - "default": "scroll" + "x-stainless-const": true }, "x": { "allOf": [ @@ -43656,6 +49610,19 @@ } ], "description": "The vertical scroll distance." + }, + "keys": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -43666,6 +49633,13 @@ "description": "A scroll action.", "title": "Scroll" }, + "OpenAI.SearchContentType": { + "type": "string", + "enum": [ + "text", + "image" + ] + }, "OpenAI.SearchContextSize": { "type": "string", "enum": [ @@ -43675,16 +49649,31 @@ ] }, "OpenAI.ServiceTier": { + "anyOf": [ + { + "type": "string", + "enum": [ + "auto", + "default", + "flex", + "scale", + "priority" + ] + }, + { + "type": "null" + } + ], + "description": "Specifies the processing type used for serving the request.\n- If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.\n- If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.\n- If set to '[flex](/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier.\n- When not set, the default behavior is 'auto'.\nWhen the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter." + }, + "OpenAI.ServiceTierEnum": { "type": "string", "enum": [ "auto", "default", "flex", - "scale", "priority" - ], - "description": "Specifies the processing type used for serving the request.\n- If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.\n- If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.\n- If set to '[flex](/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier.\n- When not set, the default behavior is 'auto'.\nWhen the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.", - "nullable": true + ] }, "OpenAI.SkillReferenceParam": { "type": "object", @@ -43699,8 +49688,7 @@ "skill_reference" ], "description": "References a skill created with the /v1/skills endpoint.", - "x-stainless-const": true, - "default": "skill_reference" + "x-stainless-const": true }, "skill_id": { "type": "string", @@ -43731,8 +49719,7 @@ "apply_patch" ], "description": "The tool to call. Always `apply_patch`.", - "x-stainless-const": true, - "default": "apply_patch" + "x-stainless-const": true } }, "allOf": [ @@ -43755,8 +49742,7 @@ "shell" ], "description": "The tool to call. Always `shell`.", - "x-stainless-const": true, - "default": "shell" + "x-stainless-const": true } }, "allOf": [ @@ -43780,8 +49766,7 @@ "summary_text" ], "description": "The type of the object. Always `summary_text`.", - "x-stainless-const": true, - "default": "summary_text" + "x-stainless-const": true }, "text": { "type": "string", @@ -43808,8 +49793,7 @@ "enum": [ "text" ], - "x-stainless-const": true, - "default": "text" + "x-stainless-const": true }, "text": { "type": "string" @@ -43932,8 +49916,14 @@ "$ref": "#/components/schemas/OpenAI.ResponseFormatJsonSchemaSchema" }, "strict": { - "type": "boolean", - "nullable": true + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -43981,7 +49971,10 @@ "shell": "#/components/schemas/OpenAI.FunctionShellToolParam", "custom": "#/components/schemas/OpenAI.CustomToolParam", "web_search_preview": "#/components/schemas/OpenAI.WebSearchPreviewTool", - "apply_patch": "#/components/schemas/OpenAI.ApplyPatchToolParam" + "apply_patch": "#/components/schemas/OpenAI.ApplyPatchToolParam", + "computer": "#/components/schemas/OpenAI.ComputerTool", + "namespace": "#/components/schemas/OpenAI.NamespaceToolParam", + "tool_search": "#/components/schemas/OpenAI.ToolSearchToolParam" } }, "description": "A tool that can be used to generate a response." @@ -44014,7 +50007,7 @@ "type": "array", "items": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, "description": "A list of tool definitions that the model should be allowed to call.\n For the Responses API, the list of tool definitions might look like:\n ```json\n [\n { \"type\": \"function\", \"name\": \"get_weather\" },\n { \"type\": \"mcp\", \"server_label\": \"deepwiki\" },\n { \"type\": \"image_generation\" }\n ]\n ```" } @@ -44047,6 +50040,46 @@ ], "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." }, + "OpenAI.ToolChoiceComputer": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "computer" + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolChoiceParam" + } + ], + "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." + }, + "OpenAI.ToolChoiceComputerUse": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "computer_use" + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolChoiceParam" + } + ], + "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." + }, "OpenAI.ToolChoiceComputerUsePreview": { "type": "object", "required": [ @@ -44183,8 +50216,14 @@ "description": "The label of the MCP server to use." }, "name": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -44229,7 +50268,9 @@ "computer_use_preview": "#/components/schemas/OpenAI.ToolChoiceComputerUsePreview", "web_search_preview_2025_03_11": "#/components/schemas/OpenAI.ToolChoiceWebSearchPreview20250311", "image_generation": "#/components/schemas/OpenAI.ToolChoiceImageGeneration", - "code_interpreter": "#/components/schemas/OpenAI.ToolChoiceCodeInterpreter" + "code_interpreter": "#/components/schemas/OpenAI.ToolChoiceCodeInterpreter", + "computer": "#/components/schemas/OpenAI.ToolChoiceComputer", + "computer_use": "#/components/schemas/OpenAI.ToolChoiceComputerUse" } }, "description": "How the model should select which tool (or tools) to use when generating\na response. See the `tools` parameter to see how to specify which tools\nthe model can call." @@ -44253,7 +50294,9 @@ "computer_use_preview", "web_search_preview_2025_03_11", "image_generation", - "code_interpreter" + "code_interpreter", + "computer", + "computer_use" ] } ] @@ -44298,6 +50341,64 @@ ], "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." }, + "OpenAI.ToolSearchExecutionType": { + "type": "string", + "enum": [ + "server", + "client" + ] + }, + "OpenAI.ToolSearchToolParam": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search" + ], + "description": "The type of the tool. Always `tool_search`.", + "x-stainless-const": true + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search is executed by the server or by the client." + }, + "description": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "parameters": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.EmptyModelParam" + }, + { + "type": "null" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Tool" + } + ], + "description": "Hosted or BYOT tool search configuration for deferred tools.", + "title": "Tool search tool" + }, "OpenAI.ToolType": { "anyOf": [ { @@ -44308,6 +50409,7 @@ "enum": [ "function", "file_search", + "computer", "computer_use_preview", "web_search", "mcp", @@ -44316,6 +50418,8 @@ "local_shell", "shell", "custom", + "namespace", + "tool_search", "web_search_preview", "apply_patch", "a2a_preview", @@ -44379,8 +50483,7 @@ "type" ], "description": "Specifies the event type. For a type action, this property is always set to `type`.", - "x-stainless-const": true, - "default": "type" + "x-stainless-const": true }, "text": { "type": "string", @@ -44402,13 +50505,14 @@ ], "properties": { "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } ], - "nullable": true, "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.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters." } } @@ -44429,8 +50533,7 @@ "url_citation" ], "description": "The type of the URL citation. Always `url_citation`.", - "x-stainless-const": true, - "default": "url_citation" + "x-stainless-const": true }, "url": { "type": "string", @@ -44468,7 +50571,7 @@ }, "OpenAI.VectorStoreFileAttributes": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "anyOf": [ { "type": "string" @@ -44485,14 +50588,20 @@ "x-oaiTypeLabel": "map" }, "OpenAI.Verbosity": { - "type": "string", - "enum": [ - "low", - "medium", - "high" + "anyOf": [ + { + "type": "string", + "enum": [ + "low", + "medium", + "high" + ] + }, + { + "type": "null" + } ], - "description": "Constrains the verbosity of the model's response. Lower values will result in\nmore concise responses, while higher values will result in more verbose responses.\nCurrently supported values are `low`, `medium`, and `high`.", - "nullable": true + "description": "Constrains the verbosity of the model's response. Lower values will result in\nmore concise responses, while higher values will result in more verbose responses.\nCurrently supported values are `low`, `medium`, and `high`." }, "OpenAI.WaitParam": { "type": "object", @@ -44506,8 +50615,7 @@ "wait" ], "description": "Specifies the event type. For a wait action, this property is always set to `wait`.", - "x-stainless-const": true, - "default": "wait" + "x-stainless-const": true } }, "allOf": [ @@ -44562,9 +50670,15 @@ "x-stainless-const": true }, "url": { - "type": "string", - "format": "uri", - "nullable": true, + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ], "description": "The URL opened by the model." } }, @@ -44574,8 +50688,7 @@ "OpenAI.WebSearchActionSearch": { "type": "object", "required": [ - "type", - "query" + "type" ], "properties": { "type": { @@ -44588,7 +50701,7 @@ }, "query": { "type": "string", - "description": "[DEPRECATED] The search query.", + "description": "The search query.", "deprecated": true }, "queries": { @@ -44626,7 +50739,8 @@ "x-stainless-const": true }, "url": { - "type": "string" + "type": "string", + "format": "uri" } } }, @@ -44646,20 +50760,44 @@ "default": "approximate" }, "country": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "region": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "city": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "timezone": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "description": "The approximate location of the user.", @@ -44677,17 +50815,17 @@ "web_search_preview" ], "description": "The type of the web search tool. One of `web_search_preview` or `web_search_preview_2025_03_11`.", - "x-stainless-const": true, - "default": "web_search_preview" + "x-stainless-const": true }, "user_location": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.ApproximateLocation" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "search_context_size": { "allOf": [ @@ -44696,6 +50834,12 @@ } ], "description": "High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default." + }, + "search_content_types": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.SearchContentType" + } } }, "allOf": [ @@ -44717,26 +50861,27 @@ "enum": [ "web_search" ], - "description": "The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.", - "default": "web_search" + "description": "The type of the web search tool. One of `web_search` or `web_search_2025_08_26`." }, "filters": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.WebSearchToolFilters" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "user_location": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.WebSearchApproximateLocation" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "search_context_size": { "type": "string", @@ -44777,11 +50922,17 @@ "type": "object", "properties": { "allowed_domains": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] } } }, @@ -44873,7 +51024,7 @@ }, "spec": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The openapi function shape, described as a JSON Schema object." }, "auth": { @@ -44906,7 +51057,7 @@ }, "parameters": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The parameters the functions accepts, described as a JSON Schema object." } }, @@ -45139,8 +51290,7 @@ "type": "string", "enum": [ "openapi" - ], - "description": "The object type, which is always 'openapi'." + ] }, "openapi": { "allOf": [ @@ -45158,58 +51308,32 @@ ], "description": "An OpenAPI tool stored in a toolbox." }, - "OptimizationAgentDefinition": { + "OptimizationAgentIdentifier": { "type": "object", + "required": [ + "agent_name" + ], "properties": { - "agentName": { - "type": "string", - "description": "Agent name." - }, - "agentVersion": { - "type": "string", - "description": "Agent version." - }, - "model": { + "agent_name": { "type": "string", - "description": "Model deployment name." + "description": "Registered Foundry agent name (required)." }, - "systemPrompt": { + "agent_version": { "type": "string", - "description": "System prompt / instructions." - }, - "skills": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": {} - }, - "description": "Agent skills." - }, - "tools": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": {} - }, - "description": "Agent tools." + "description": "Pinned agent version. Defaults to latest if omitted." } }, - "description": "Agent definition returned in response payloads (includes resolved config)." + "description": "Identifies the registered Foundry agent to optimize (request-only). Skills, tools, and system_prompt are specified in options.optimization_config." }, "OptimizationCandidate": { "type": "object", "required": [ "name", - "config", - "mutations", - "avgScore", - "avgTokens", - "passRate", - "taskScores", - "isParetoOptimal" + "avg_score", + "avg_tokens" ], "properties": { - "candidateId": { + "candidate_id": { "type": "string", "description": "Server-assigned candidate identifier. Use with GET /candidates/{id} sub-endpoints." }, @@ -45217,50 +51341,26 @@ "type": "string", "description": "Display name of the candidate (e.g., 'baseline', 'instruction-v2')." }, - "config": { - "allOf": [ - { - "$ref": "#/components/schemas/OptimizationAgentDefinition" - } - ], - "description": "The agent configuration that produced this candidate." - }, "mutations": { "type": "object", - "additionalProperties": {}, - "description": "What was mutated from the baseline (e.g., {systemPrompt: 'new prompt'})." + "unevaluatedProperties": {}, + "description": "What was mutated from the baseline (e.g., {system_prompt: 'new prompt'})." }, - "avgScore": { + "avg_score": { "type": "number", "format": "double", "description": "Average composite score across all tasks." }, - "avgTokens": { + "avg_tokens": { "type": "number", "format": "double", "description": "Average token usage across all tasks." }, - "passRate": { - "type": "number", - "format": "double", - "description": "Fraction of tasks that met the pass threshold." - }, - "taskScores": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OptimizationTaskResult" - }, - "description": "Individual task-level scores." - }, - "isParetoOptimal": { - "type": "boolean", - "description": "Whether this candidate is on the Pareto frontier (score vs cost)." - }, - "evalId": { + "eval_id": { "type": "string", "description": "Foundry evaluation identifier used to score this candidate." }, - "evalRunId": { + "eval_run_id": { "type": "string", "description": "Foundry evaluation run identifier for this candidate's scoring run." }, @@ -45275,12 +51375,144 @@ }, "description": "Aggregated evaluation result for a single candidate agent configuration across all tasks." }, + "OptimizationDatasetCriterion": { + "type": "object", + "required": [ + "name", + "instruction" + ], + "properties": { + "name": { + "type": "string", + "description": "Criterion name." + }, + "instruction": { + "type": "string", + "description": "Criterion instruction / description." + } + }, + "description": "Evaluation criterion: a name + instruction pair used for per-item scoring." + }, + "OptimizationDatasetInput": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "allOf": [ + { + "$ref": "#/components/schemas/OptimizationDatasetInputType" + } + ], + "description": "Dataset input type discriminator." + } + }, + "discriminator": { + "propertyName": "type", + "mapping": { + "inline": "#/components/schemas/OptimizationInlineDatasetInput", + "reference": "#/components/schemas/OptimizationReferenceDatasetInput" + } + }, + "description": "Base discriminated model for dataset input. Either inline items or a registered reference." + }, + "OptimizationDatasetInputType": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "inline", + "reference" + ] + } + ], + "description": "Discriminator values for the dataset input union." + }, + "OptimizationDatasetItem": { + "type": "object", + "properties": { + "query": { + "type": "string", + "description": "The user query / prompt." + }, + "ground_truth": { + "type": "string", + "description": "Expected ground truth answer." + }, + "desired_num_turns": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 20, + "description": "Desired number of conversation turns for simulation mode (1-20)." + }, + "criteria": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OptimizationDatasetCriterion" + }, + "description": "Per-item evaluation criteria." + } + }, + "description": "A single item in an inline dataset." + }, + "OptimizationEvaluatorRef": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "Evaluator name." + }, + "version": { + "type": "string", + "description": "Evaluator version. If not specified, the latest version is used." + } + }, + "description": "Reference to a named evaluator, optionally pinned to a version." + }, + "OptimizationInlineDatasetInput": { + "type": "object", + "required": [ + "type", + "items" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "inline" + ], + "description": "Dataset input type discriminator." + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OptimizationDatasetItem" + }, + "description": "Dataset items." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OptimizationDatasetInput" + } + ], + "description": "Inline dataset — items supplied directly in the request body." + }, "OptimizationJob": { "type": "object", "required": [ "id", "status", - "createdAt" + "created_at", + "updated_at" ], "properties": { "id": { @@ -45288,42 +51520,42 @@ "description": "Server-assigned unique identifier.", "readOnly": true }, - "status": { + "inputs": { "allOf": [ { - "$ref": "#/components/schemas/JobStatus" + "$ref": "#/components/schemas/OptimizationJobInputs" } ], - "description": "Current lifecycle status.", - "readOnly": true + "description": "Caller-supplied inputs." }, - "error": { + "result": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.Error" + "$ref": "#/components/schemas/OptimizationJobResult" } ], - "description": "Error details — populated only on failure.", + "description": "Result produced on success.", "readOnly": true }, - "result": { + "status": { "allOf": [ { - "$ref": "#/components/schemas/OptimizationJobResult" + "$ref": "#/components/schemas/JobStatus" } ], - "description": "Result produced on success.", + "description": "Current lifecycle status.", "readOnly": true }, - "inputs": { + "error": { "allOf": [ { - "$ref": "#/components/schemas/OptimizationJobInputs" + "$ref": "#/components/schemas/OpenAI.Error" } ], - "description": "Caller-supplied inputs." + "description": "Error details — populated only on failure.", + "readOnly": true }, - "createdAt": { + "created_at": { "allOf": [ { "$ref": "#/components/schemas/FoundryTimestamp" @@ -45332,7 +51564,7 @@ "description": "The timestamp when the job was created, represented in Unix time.", "readOnly": true }, - "updatedAt": { + "updated_at": { "allOf": [ { "$ref": "#/components/schemas/FoundryTimestamp" @@ -45347,16 +51579,15 @@ "$ref": "#/components/schemas/OptimizationJobProgress" } ], - "description": "Progress while in flight. Absent in terminal states.", + "description": "Progress snapshot. May be present in terminal states reflecting last-known progress.", "readOnly": true }, - "dataset": { - "allOf": [ - { - "$ref": "#/components/schemas/DatasetInfo" - } - ], - "description": "Metadata about the dataset used for this optimization job.", + "warnings": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Non-fatal warnings emitted at any point during optimization.", "readOnly": true } }, @@ -45366,29 +51597,30 @@ "type": "object", "required": [ "agent", - "trainDatasetReference" + "train_dataset", + "evaluators" ], "properties": { "agent": { "allOf": [ { - "$ref": "#/components/schemas/AgentIdentifier" + "$ref": "#/components/schemas/OptimizationAgentIdentifier" } ], "description": "The agent (and pinned version) being optimized." }, - "trainDatasetReference": { + "train_dataset": { "allOf": [ { - "$ref": "#/components/schemas/DatasetRef" + "$ref": "#/components/schemas/OptimizationDatasetInput" } ], - "description": "Reference to a registered training dataset (required)." + "description": "Training dataset — either inline items or a reference to a registered dataset. Required." }, - "validationDatasetReference": { + "validation_dataset": { "allOf": [ { - "$ref": "#/components/schemas/DatasetRef" + "$ref": "#/components/schemas/OptimizationDatasetInput" } ], "description": "Optional held-out validation dataset for measuring generalization of the final candidate." @@ -45396,9 +51628,9 @@ "evaluators": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/OptimizationEvaluatorRef" }, - "description": "Job-level evaluators (referenced by name). Per-task criteria may override. Default: ['task_adherence']." + "description": "Job-level evaluators referenced by name and optional version. Required; at least one must be provided." }, "options": { "allOf": [ @@ -45411,25 +51643,96 @@ }, "description": "Caller-supplied inputs for an optimization job." }, + "OptimizationJobListItem": { + "type": "object", + "required": [ + "id", + "status", + "created_at", + "updated_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Server-assigned unique identifier.", + "readOnly": true + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/JobStatus" + } + ], + "description": "Current lifecycle status.", + "readOnly": true + }, + "error": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Error" + } + ], + "description": "Error details — populated only on failure.", + "readOnly": true + }, + "created_at": { + "allOf": [ + { + "$ref": "#/components/schemas/FoundryTimestamp" + } + ], + "description": "The timestamp when the job was created, represented in Unix time.", + "readOnly": true + }, + "updated_at": { + "allOf": [ + { + "$ref": "#/components/schemas/FoundryTimestamp" + } + ], + "description": "The timestamp when the job was last updated, represented in Unix time.", + "readOnly": true + }, + "progress": { + "allOf": [ + { + "$ref": "#/components/schemas/OptimizationJobProgress" + } + ], + "description": "Progress snapshot. May be present in terminal states reflecting last-known progress.", + "readOnly": true + }, + "agent": { + "allOf": [ + { + "$ref": "#/components/schemas/OptimizationAgentIdentifier" + } + ], + "description": "The agent targeted by this optimization job.", + "readOnly": true + } + }, + "description": "Slim job representation returned by the LIST endpoint." + }, "OptimizationJobProgress": { "type": "object", "required": [ - "currentIteration", - "bestScore", - "elapsedSeconds" + "candidates_completed", + "best_score", + "elapsed_seconds" ], "properties": { - "currentIteration": { + "candidates_completed": { "type": "integer", "format": "int32", - "description": "1-based current iteration index." + "description": "Number of candidates whose evaluation has completed so far." }, - "bestScore": { + "best_score": { "type": "number", "format": "double", "description": "Best score observed so far across all candidates." }, - "elapsedSeconds": { + "elapsed_seconds": { "type": "number", "format": "double", "description": "Wall-clock time elapsed in seconds since the job began executing." @@ -45441,20 +51744,12 @@ "type": "object", "properties": { "baseline": { - "allOf": [ - { - "$ref": "#/components/schemas/OptimizationCandidate" - } - ], - "description": "Evaluation scores for the original (un-optimized) agent configuration." + "type": "string", + "description": "Candidate ID of the original (un-optimized) baseline evaluation." }, "best": { - "allOf": [ - { - "$ref": "#/components/schemas/OptimizationCandidate" - } - ], - "description": "The highest-scoring candidate found during optimization." + "type": "string", + "description": "Candidate ID of the highest-scoring candidate found during optimization." }, "candidates": { "type": "array", @@ -45462,25 +51757,6 @@ "$ref": "#/components/schemas/OptimizationCandidate" }, "description": "All evaluated candidates including baseline." - }, - "options": { - "allOf": [ - { - "$ref": "#/components/schemas/OptimizationOptions" - } - ], - "description": "The options used for this optimization run." - }, - "warnings": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Non-fatal warnings from the optimization run (e.g., target attribute failures that were skipped)." - }, - "allTargetAttributesFailed": { - "type": "boolean", - "description": "True when all target attributes failed — only the baseline was evaluated." } }, "description": "Terminal-state result body. Populated when status is succeeded or failed." @@ -45488,26 +51764,27 @@ "OptimizationOptions": { "type": "object", "properties": { - "maxIterations": { + "max_candidates": { "type": "integer", "format": "int32", - "description": "Maximum optimization iterations per strategy. Must be >= 1. Default: 5.", + "minimum": 1, + "description": "Maximum number of optimization candidates to generate. Must be >= 1. Default: 5.", "default": 5 }, - "optimizationConfig": { + "optimization_config": { "type": "object", - "additionalProperties": {}, - "description": "Per-target-attribute configuration overrides. Contains skills, tools, systemPrompt for the agent, plus model space for model optimization." + "unevaluatedProperties": {}, + "description": "Per-target-attribute configuration overrides. Contains skills, tools, system_prompt for the agent, plus model space for model optimization." }, - "evalModel": { + "eval_model": { "type": "string", "description": "Model deployment used for evaluation. Defaults to server config (typically 'gpt-4o')." }, - "optimizationModel": { + "optimization_model": { "type": "string", "description": "Model deployment for optimization reasoning (must be gpt-5 family). Falls back to the default eval model when not set." }, - "evaluationLevel": { + "evaluation_level": { "allOf": [ { "$ref": "#/components/schemas/EvaluationLevel" @@ -45518,73 +51795,35 @@ }, "description": "Tuning knobs and run-mode for an optimization job." }, - "OptimizationTaskResult": { + "OptimizationReferenceDatasetInput": { "type": "object", "required": [ - "taskName", - "scores", - "compositeScore", - "tokens", - "durationSeconds", - "passed" + "type", + "name" ], "properties": { - "taskName": { - "type": "string", - "description": "Task name (from the dataset)." - }, - "query": { - "type": "string", - "description": "The user query / input for the task." - }, - "scores": { - "type": "object", - "additionalProperties": { - "type": "number", - "format": "double" - }, - "description": "Per-evaluator scores keyed by evaluator name." - }, - "compositeScore": { - "type": "number", - "format": "double", - "description": "Composite score combining all evaluator scores." - }, - "tokens": { - "type": "integer", - "format": "int32", - "description": "Total tokens consumed during the agent run for this task." - }, - "durationSeconds": { - "type": "number", - "format": "double", - "description": "Wall-clock seconds for this task's agent execution." - }, - "passed": { - "type": "boolean", - "description": "Whether the task met the pass threshold." - }, - "errorMessage": { + "type": { "type": "string", - "description": "Error message if the task failed during execution." - }, - "rationales": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Per-evaluator reasoning keyed by evaluator name." + "enum": [ + "reference" + ], + "description": "Dataset input type discriminator." }, - "response": { + "name": { "type": "string", - "description": "Raw agent response text." + "description": "Registered dataset name." }, - "runId": { + "version": { "type": "string", - "description": "Identifier of the agent run that produced this result." + "description": "Dataset version. If not specified, the latest version is used." } }, - "description": "Per-task evaluation result for a single candidate." + "allOf": [ + { + "$ref": "#/components/schemas/OptimizationDatasetInput" + } + ], + "description": "Reference to a registered Foundry dataset." }, "OtlpTelemetryEndpoint": { "type": "object", @@ -45604,7 +51843,9 @@ "endpoint": { "type": "string", "description": "The OTLP collector endpoint URL.", - "example": "https://my-collector.example.com/otlp" + "examples": [ + "https://my-collector.example.com/otlp" + ] }, "protocol": { "allOf": [ @@ -45613,7 +51854,9 @@ } ], "description": "The transport protocol for the OTLP endpoint.", - "example": "Http" + "examples": [ + "Http" + ] } }, "allOf": [ @@ -45997,70 +52240,15 @@ ] } }, - "PromoteCandidateRequest": { - "type": "object", - "required": [ - "agentName", - "agentVersion" - ], - "properties": { - "agentName": { - "type": "string", - "description": "Name of the Foundry agent to promote to." - }, - "agentVersion": { - "type": "string", - "description": "Version of the Foundry agent to promote to." - } - }, - "description": "Request body for promoting a candidate to a Foundry agent version." - }, - "PromoteCandidateResponse": { - "type": "object", - "required": [ - "candidateId", - "status", - "promotedAt", - "agentName", - "agentVersion" - ], - "properties": { - "candidateId": { - "type": "string", - "description": "The promoted candidate id." - }, - "status": { - "type": "string", - "description": "Status after promotion." - }, - "promotedAt": { - "allOf": [ - { - "$ref": "#/components/schemas/FoundryTimestamp" - } - ], - "description": "Timestamp when promotion occurred, represented in Unix time." - }, - "agentName": { - "type": "string", - "description": "Name of the Foundry agent promoted to." - }, - "agentVersion": { - "type": "string", - "description": "Version of the Foundry agent promoted to." - } - }, - "description": "Response after successfully promoting a candidate." - }, "PromotionInfo": { "type": "object", "required": [ - "promotedAt", - "agentName", - "agentVersion" + "promoted_at", + "agent_name", + "agent_version" ], "properties": { - "promotedAt": { + "promoted_at": { "allOf": [ { "$ref": "#/components/schemas/FoundryTimestamp" @@ -46068,11 +52256,11 @@ ], "description": "Timestamp when promotion occurred, represented in Unix time." }, - "agentName": { + "agent_name": { "type": "string", "description": "Name of the Foundry agent this candidate was promoted to." }, - "agentVersion": { + "agent_version": { "type": "string", "description": "Version of the Foundry agent this candidate was promoted to." } @@ -46097,36 +52285,55 @@ "description": "The model deployment to use for this agent." }, "instructions": { - "type": "string", - "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "description": "A system (or developer) message inserted into the model's context." }, "temperature": { - "type": "number", - "format": "float", - "nullable": true, + "anyOf": [ + { + "type": "number", + "format": "float" + }, + { + "type": "null" + } + ], "minimum": 0, "maximum": 2, "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nWe generally recommend altering this or `top_p` but not both. Defaults to `1`.", "default": 1 }, "top_p": { - "type": "number", - "format": "float", - "nullable": true, + "anyOf": [ + { + "type": "number", + "format": "float" + }, + { + "type": "null" + } + ], "minimum": 0, "maximum": 1, "description": "An alternative to sampling with temperature, called nucleus sampling,\nwhere the model considers the results of the tokens with top_p probability\nmass. So 0.1 means only the tokens comprising the top 10% probability mass\nare considered. We generally recommend altering this or `temperature` but not both.\nDefaults to `1`.", "default": 1 }, "reasoning": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Reasoning" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "tools": { "type": "array", @@ -46156,7 +52363,7 @@ }, "structured_inputs": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/StructuredInputDefinition" }, "description": "Set of structured inputs that can participate in prompt template substitution or tool argument bindings." @@ -46420,7 +52627,7 @@ }, "simulationOnly": { "type": "boolean", - "description": "Simulation-only or Simulation + Evaluation. Default false, if true the scan outputs conversation not evaluation result.", + "description": "Simulation-only or Simulation + Evaluation. If `true` the scan outputs conversation not evaluation result. The service defaults to `false` if a value is not specified by the caller.", "default": false }, "riskCategories": { @@ -46436,14 +52643,14 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Red team's tags. Unlike properties, tags are fully mutable." }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed." @@ -46671,7 +52878,7 @@ }, "data_mapping": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Mapping from source fields to response_id field, required for retrieving chat history." @@ -46721,10 +52928,7 @@ "Routine": { "type": "object", "required": [ - "name", - "enabled", - "triggers", - "action" + "enabled" ], "properties": { "name": { @@ -46743,7 +52947,7 @@ }, "triggers": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/RoutineTrigger" }, "description": "The triggers configured for the routine." @@ -46854,10 +53058,6 @@ }, "RoutineCreateOrUpdateRequest": { "type": "object", - "required": [ - "triggers", - "action" - ], "properties": { "description": { "type": "string", @@ -46870,7 +53070,7 @@ }, "triggers": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/RoutineTrigger" }, "description": "The triggers configured for the routine. In v1, exactly one trigger entry is supported." @@ -46943,19 +53143,21 @@ "RoutineRun": { "type": "object", "required": [ - "id", - "status", - "trigger_type", - "started_at" + "id" ], "properties": { "id": { "type": "string", - "description": "The MLflow run identifier for the routine attempt." + "description": "The unique run identifier for the routine attempt.", + "readOnly": true }, "status": { - "type": "string", - "description": "The underlying MLflow run status." + "allOf": [ + { + "$ref": "#/components/schemas/RoutineRunStatus" + } + ], + "description": "The run status." }, "phase": { "allOf": [ @@ -46973,6 +53175,10 @@ ], "description": "The trigger type that produced the routine attempt." }, + "trigger_name": { + "type": "string", + "description": "The configured trigger name that produced the routine attempt." + }, "attempt_source": { "allOf": [ { @@ -46989,6 +53195,22 @@ ], "description": "The action type dispatched for the routine attempt." }, + "agent_id": { + "type": "string", + "description": "The project-scoped agent identifier recorded for the routine attempt." + }, + "agent_endpoint_id": { + "type": "string", + "description": "The legacy endpoint-scoped agent identifier recorded for the routine attempt." + }, + "conversation_id": { + "type": "string", + "description": "The conversation identifier used by a responses API dispatch." + }, + "session_id": { + "type": "string", + "description": "The hosted-agent session identifier used by an invocations API dispatch." + }, "triggered_at": { "allOf": [ { @@ -46997,6 +53219,14 @@ ], "description": "The logical trigger time recorded for the routine attempt." }, + "scheduled_fire_at": { + "allOf": [ + { + "$ref": "#/components/schemas/FoundryTimestamp" + } + ], + "description": "The scheduled fire time recorded for timer and schedule deliveries." + }, "started_at": { "allOf": [ { @@ -47029,6 +53259,11 @@ "type": "string", "description": "The workspace task identifier linked to the routine attempt, when available." }, + "error_status_code": { + "type": "integer", + "format": "int32", + "description": "The downstream error status code captured for a failed attempt, when available." + }, "error_type": { "type": "string", "description": "The fully qualified error type captured for a failed attempt, when available." @@ -47036,14 +53271,6 @@ "error_message": { "type": "string", "description": "The truncated failure message captured for a failed attempt, when available." - }, - "diagnostics": { - "allOf": [ - { - "$ref": "#/components/schemas/RoutineRunDiagnostics" - } - ], - "description": "Diagnostic data captured for the routine attempt." } }, "description": "A single routine run returned from the run history API.", @@ -47053,44 +53280,6 @@ ] } }, - "RoutineRunDiagnostics": { - "type": "object", - "required": [ - "parameters", - "tags", - "metrics" - ], - "properties": { - "parameters": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "MLflow parameters recorded on the run, keyed by parameter name." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "MLflow tags recorded on the run, keyed by tag name." - }, - "metrics": { - "type": "object", - "additionalProperties": { - "type": "number", - "format": "double" - }, - "description": "Latest MLflow metric values recorded on the run, keyed by metric name." - } - }, - "description": "Generic diagnostics captured on a routine run.", - "x-ms-foundry-meta": { - "conditional_previews": [ - "Routines=V1Preview" - ] - } - }, "RoutineRunPhase": { "anyOf": [ { @@ -47113,6 +53302,15 @@ ] } }, + "RoutineRunStatus": { + "type": "string", + "description": "The status of a routine run.", + "x-ms-foundry-meta": { + "conditional_previews": [ + "Routines=V1Preview" + ] + } + }, "RoutineTrigger": { "type": "object", "required": [ @@ -47133,7 +53331,8 @@ "mapping": { "schedule": "#/components/schemas/ScheduleRoutineTrigger", "timer": "#/components/schemas/TimerRoutineTrigger", - "github_issue_opened": "#/components/schemas/GitHubIssueOpenedRoutineTrigger" + "github_issue": "#/components/schemas/GitHubIssueRoutineTrigger", + "custom": "#/components/schemas/CustomRoutineTrigger" } }, "description": "Base model for a routine trigger.", @@ -47151,7 +53350,8 @@ { "type": "string", "enum": [ - "github_issue_opened", + "custom", + "github_issue", "schedule", "timer" ] @@ -47318,21 +53518,21 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Schedule's tags. Unlike properties, tags are fully mutable." }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Schedule's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed." }, "systemData": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "System metadata for the resource.", @@ -47429,7 +53629,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Properties of the schedule run.", @@ -47454,7 +53654,7 @@ }, "configuration": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Configuration for the task." @@ -47518,10 +53718,23 @@ "SessionDirectoryListResponse": { "type": "object", "required": [ + "has_more", "path", "entries" ], "properties": { + "first_id": { + "type": "string", + "description": "The first ID represented in this list." + }, + "last_id": { + "type": "string", + "description": "The last ID represented in this list." + }, + "has_more": { + "type": "boolean", + "description": "A value indicating whether there are additional values available not captured in this list." + }, "path": { "type": "string", "description": "The path that was listed, relative to the session home directory." @@ -47533,8 +53746,7 @@ }, "description": "The directory entries." } - }, - "description": "Response from listing a directory in a session sandbox." + } }, "SessionFileWriteResponse": { "type": "object", @@ -47569,12 +53781,16 @@ } ], "description": "The SSE event type. Currently `log`, but additional event types may be added in the future. Clients should ignore unrecognized event types.", - "example": "log" + "examples": [ + "log" + ] }, "data": { "type": "string", "description": "The event payload as plain text. Currently JSON-formatted but the schema is not contractual and may change.", - "example": "{\"timestamp\":\"2026-03-10T09:33:17.121467567+00:00\",\"stream\":\"stdout\",\"message\":\"Starting server on port 18080\"}" + "examples": [ + "{\"timestamp\":\"2026-03-10T09:33:17.121467567+00:00\",\"stream\":\"stdout\",\"message\":\"Starting server on port 18080\"}" + ] } }, "description": "A single Server-Sent Event frame emitted by the hosted agent session log stream.\n\nEach frame contains an `event` field identifying the event type and a `data`\nfield carrying the payload as plain text. Although the current `data` payload\nis JSON-formatted, its schema is not contractual — additional keys may appear\nand the format may change over time. Clients should treat `data` as an\nopaque string and optionally attempt JSON parsing.\n\nNew event types may be added in the future. Clients should gracefully\nignore unrecognized event types.\n\nWire format:\n```\nevent: log\ndata: {\"timestamp\":\"2026-03-10T09:33:17.121Z\",\"stream\":\"stdout\",\"message\":\"Starting server on port 18080\"}\n\nevent: log\ndata: {\"timestamp\":\"2026-03-10T09:34:52.714Z\",\"stream\":\"status\",\"message\":\"Successfully connected to container\"}\n```", @@ -47853,7 +54069,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Arbitrary key-value metadata for additional properties." @@ -47967,12 +54183,12 @@ }, "schema": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The JSON schema for the structured input (optional)." }, "required": { "type": "boolean", - "description": "Whether the input property is required when the agent is invoked. Defaults to `false`.", + "description": "Whether the input property is required when the agent is invoked. The service defaults to `false` if a value is not specified by the caller.", "default": false } }, @@ -47997,12 +54213,18 @@ }, "schema": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The JSON schema for the structured output." }, "strict": { - "type": "boolean", - "nullable": true, + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], "description": "Whether to enforce strict validation. Default `true`." } }, @@ -48297,7 +54519,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Additional properties for the taxonomy category." @@ -48331,7 +54553,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Additional properties for the taxonomy sub-category." @@ -48404,10 +54626,12 @@ "$ref": "#/components/schemas/TelemetryDataKind" }, "description": "Data types to export to this endpoint. Use an empty array to export no data.", - "example": [ - "ContainerStdoutStderr", - "ContainerOtel", - "Metrics" + "examples": [ + [ + "ContainerStdoutStderr", + "ContainerOtel", + "Metrics" + ] ] }, "auth": { @@ -48547,11 +54771,12 @@ }, "initialization_parameters": { "type": "object", + "unevaluatedProperties": {}, "description": "The initialization parameters for the evaluation. Must support structured outputs." }, "data_mapping": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "The model to use for the evaluation. Must support structured outputs." @@ -48563,8 +54788,7 @@ "TimerRoutineTrigger": { "type": "object", "required": [ - "type", - "at" + "type" ], "properties": { "type": { @@ -48575,12 +54799,12 @@ "description": "The trigger type." }, "at": { - "type": "string", - "description": "A future timer expression. Supported values include an ISO-8601 timestamp with an explicit offset, a local timestamp paired with time_zone, or a positive duration from now." - }, - "time_zone": { - "type": "string", - "description": "An optional IANA or Windows time zone identifier when the timer uses a local timestamp." + "allOf": [ + { + "$ref": "#/components/schemas/FoundryTimestamp" + } + ], + "description": "The UTC date and time at which the timer fires." } }, "allOf": [ @@ -48599,7 +54823,7 @@ "anyOf": [ { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, { "type": "string" @@ -48820,7 +55044,7 @@ }, "tool_configs": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -48871,11 +55095,17 @@ ], "properties": { "metadata": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "nullable": true, + "anyOf": [ + { + "type": "object", + "unevaluatedProperties": { + "type": "string" + } + }, + { + "type": "null" + } + ], "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "x-oaiTypeLabel": "map" }, @@ -49263,7 +55493,7 @@ "properties": { "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -49280,7 +55510,7 @@ }, "parameter_values": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The inputs to the manifest that will result in a fully materialized Agent." } } @@ -49293,7 +55523,7 @@ "properties": { "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -49342,17 +55572,18 @@ "type": "string" }, "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of immutable 16 key-value pairs that can be attached to an object for storing additional information.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters." @@ -49368,7 +55599,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -49600,27 +55831,27 @@ "type": "string", "enum": [ "web_search" - ], - "description": "The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.", - "default": "web_search" + ] }, "filters": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.WebSearchToolFilters" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "user_location": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.WebSearchApproximateLocation" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "search_context_size": { "type": "string", @@ -49722,8 +55953,7 @@ "type": "string", "enum": [ "work_iq_preview" - ], - "description": "The object type, which is always 'work_iq_preview'." + ] }, "project_connection_id": { "type": "string", diff --git a/specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.yaml b/specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.yaml index 9dae869e1981..cd2e3ce92afb 100644 --- a/specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.yaml +++ b/specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.yaml @@ -1,33 +1,117 @@ -openapi: 3.0.0 +openapi: 3.2.0 info: title: Microsoft Foundry version: v1 tags: + - name: Fine-Tuning + - name: Responses Root + description: Responses + - name: Responses + parent: Responses Root + description: Responses (OpenAI) + - name: Conversations + parent: Responses Root + description: Conversations (OpenAI) + - name: Agents Root + description: Agents - name: Agents - - name: Agent Session Files + parent: Agents Root + description: Agent Management - name: Agent Invocations - - name: Connections + parent: Agents Root + - name: Agent Invocations WebSocket + parent: Agents Root + description: Agent Invocations (WebSocket) + - name: Agent Sessions + parent: Agents Root + - name: Agent Session Files + parent: Agents Root + - name: Agent Versions + parent: Agents Root + - name: Agent Containers + parent: Agents Root + - name: Platform APIs - name: Datasets - - name: Deployments - - name: Evaluation Taxonomies - - name: Evaluation Rules - - name: Evaluators - - name: EvaluatorGenerationJobs + parent: Platform APIs - name: Indexes - - name: Insights + parent: Platform APIs + - name: Connections + parent: Platform APIs + - name: Scheduler + parent: Platform APIs + - name: Fine-tuning + parent: Platform APIs + summary: Fine-Tuning - name: Models + parent: Platform APIs - name: Memory Stores - - name: Conversations - - name: Evals - - name: Fine-Tuning - - name: Responses - - name: Redteams + parent: Platform APIs + - name: Chat + parent: Platform APIs + - name: Assistants + parent: Platform APIs + - name: Audio + parent: Platform APIs + - name: Batch + parent: Platform APIs + - name: Completions + parent: Platform APIs + - name: Containers + parent: Platform APIs + - name: Embeddings + parent: Platform APIs + - name: Files + parent: Platform APIs + - name: Images + parent: Platform APIs + - name: Moderations + parent: Platform APIs + - name: Realtime + parent: Platform APIs + - name: Threads + parent: Platform APIs + - name: Uploads + parent: Platform APIs + - name: Vector stores + parent: Platform APIs + summary: Vector Stores + - name: Videos + parent: Platform APIs - name: Routines + parent: Platform APIs - name: Schedules + parent: Platform APIs - name: Skills + parent: Platform APIs - name: Toolboxes + parent: Platform APIs + - name: Deployments + parent: Platform APIs - name: DataGenerationJobs + parent: Platform APIs + summary: Data generation jobs - name: AgentOptimizationJobs + parent: Platform APIs + summary: Agent optimization jobs + - name: EvaluatorGenerationJobs + parent: Platform APIs + summary: Evaluator generation jobs + - name: Evaluations + - name: Evals + parent: Evaluations + - name: Evaluation Rules + parent: Evaluations + - name: Evaluators + parent: Evaluations + - name: Evaluation Taxonomies + parent: Evaluations + - name: Redteams + parent: Evaluations + summary: Red Teaming + - name: Evalsuite + parent: Evaluations + - name: Insights + parent: Evaluations paths: /agent_optimization_jobs: post: @@ -42,7 +126,7 @@ paths: schema: type: string enum: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview - name: Operation-Id in: header required: false @@ -74,8 +158,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OptimizationJob' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -87,15 +177,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/OptimizationJobInputs' - description: The optimization job inputs. + $ref: '#/components/schemas/OptimizationJob' + description: The job to create. x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview get: operationId: AgentOptimizationJobs_list summary: Returns a list of agent optimization jobs. - description: List optimization jobs. Supports cursor pagination and optional status / agentName filters. + description: List optimization jobs. Supports cursor pagination and optional status / agent_name filters. parameters: - name: Foundry-Features in: header @@ -104,7 +194,7 @@ paths: schema: type: string enum: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview - name: limit in: query required: false @@ -152,7 +242,7 @@ paths: schema: $ref: '#/components/schemas/JobStatus' explode: false - - name: agentName + - name: agent_name in: query required: false description: Filter to jobs targeting this agent name. @@ -180,7 +270,7 @@ paths: data: type: array items: - $ref: '#/components/schemas/OptimizationJob' + $ref: '#/components/schemas/OptimizationJobListItem' description: The requested list of items. first_id: type: string @@ -192,8 +282,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -202,12 +298,12 @@ paths: - AgentOptimizationJobs x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview /agent_optimization_jobs/{jobId}: get: operationId: AgentOptimizationJobs_get summary: Get info about an agent optimization job. - description: Get an optimization job by id. Returns 202 while in progress, 200 when terminal. + description: Get an optimization job by id. parameters: - name: Foundry-Features in: header @@ -216,7 +312,7 @@ paths: schema: type: string enum: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview - name: jobId in: path required: true @@ -236,6 +332,7 @@ paths: headers: Retry-After: required: false + description: Recommended number of seconds to wait before polling again. schema: type: integer format: int32 @@ -243,20 +340,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OptimizationJob' - '202': - description: The request has been accepted for processing, but processing has not yet completed. - headers: - Retry-After: - required: false - schema: - type: integer - format: int32 + 4XX: + description: Client error content: application/json: schema: - $ref: '#/components/schemas/OptimizationJob' - default: - description: An unexpected error response. + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -265,7 +356,7 @@ paths: - AgentOptimizationJobs x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview delete: operationId: AgentOptimizationJobs_delete summary: Deletes an agent optimization job. @@ -278,20 +369,13 @@ paths: schema: type: string enum: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview - name: jobId in: path required: true description: The ID of the job to delete. schema: type: string - - name: force - in: query - required: false - description: When true, force-delete even if the job is in a non-terminal state. - schema: - type: boolean - explode: false - name: api-version in: query required: true @@ -302,214 +386,14 @@ paths: responses: '204': description: There is no content to send for this request, but the headers may be useful. - default: - description: An unexpected error response. - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - tags: - - AgentOptimizationJobs - x-ms-foundry-meta: - conditional_previews: - - AgentsOptimization=V1Preview - /agent_optimization_jobs/{jobId}/candidates: - get: - operationId: AgentOptimizationJobs_listCandidates - summary: Returns a list of candidates for an optimization job. - description: List candidates produced by a job. - parameters: - - name: Foundry-Features - in: header - required: false - description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. - schema: - type: string - enum: - - AgentsOptimization=V1Preview - - name: jobId - in: path - required: true - description: The optimization job id. - schema: - type: string - - name: limit - in: query - required: false - description: |- - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the - default is 20. - schema: - type: integer - format: int32 - default: 20 - explode: false - - name: order - in: query - required: false - description: |- - Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc` - for descending order. - schema: - $ref: '#/components/schemas/PageOrder' - explode: false - - name: after - in: query - required: false - description: |- - A cursor for use in pagination. `after` is an object ID that defines your place in the list. - For instance, if you make a list request and receive 100 objects, ending with obj_foo, your - subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - explode: false - - name: before - in: query - required: false - description: |- - A cursor for use in pagination. `before` is an object ID that defines your place in the list. - For instance, if you make a list request and receive 100 objects, ending with obj_foo, your - subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - explode: false - - name: api-version - in: query - required: true - description: The API version to use for this operation. - schema: - type: string - explode: false - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - type: object - required: - - data - - has_more - properties: - data: - type: array - items: - $ref: '#/components/schemas/OptimizationCandidate' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - default: - description: An unexpected error response. - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - tags: - - AgentOptimizationJobs - x-ms-foundry-meta: - conditional_previews: - - AgentsOptimization=V1Preview - /agent_optimization_jobs/{jobId}/candidates/{candidateId}: - get: - operationId: AgentOptimizationJobs_getCandidate - summary: Get a candidate by id. - description: Get a single candidate's metadata, manifest, and promotion info. - parameters: - - name: Foundry-Features - in: header - required: false - description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. - schema: - type: string - enum: - - AgentsOptimization=V1Preview - - name: jobId - in: path - required: true - description: The optimization job id. - schema: - type: string - - name: candidateId - in: path - required: true - description: The candidate id. - schema: - type: string - - name: api-version - in: query - required: true - description: The API version to use for this operation. - schema: - type: string - explode: false - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - $ref: '#/components/schemas/CandidateMetadata' - default: - description: An unexpected error response. + 4XX: + description: Client error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' - tags: - - AgentOptimizationJobs - x-ms-foundry-meta: - conditional_previews: - - AgentsOptimization=V1Preview - /agent_optimization_jobs/{jobId}/candidates/{candidateId}/config: - get: - operationId: AgentOptimizationJobs_getCandidateConfig - summary: Get candidate deploy config. - description: Get the candidate's deploy config JSON. Used to compose `agents.create_version(...)` from a candidate. - parameters: - - name: Foundry-Features - in: header - required: false - description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. - schema: - type: string - enum: - - AgentsOptimization=V1Preview - - name: jobId - in: path - required: true - description: The optimization job id. - schema: - type: string - - name: candidateId - in: path - required: true - description: The candidate id. - schema: - type: string - - name: api-version - in: query - required: true - description: The API version to use for this operation. - schema: - type: string - explode: false - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - $ref: '#/components/schemas/CandidateDeployConfig' - default: - description: An unexpected error response. + 5XX: + description: Server error content: application/json: schema: @@ -518,180 +402,12 @@ paths: - AgentOptimizationJobs x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V1Preview - /agent_optimization_jobs/{jobId}/candidates/{candidateId}/files: - get: - operationId: AgentOptimizationJobs_getCandidateFile - summary: Get a candidate file. - description: Stream a specific file from the candidate's blob directory. - parameters: - - name: Foundry-Features - in: header - required: false - description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. - schema: - type: string - enum: - - AgentsOptimization=V1Preview - - name: jobId - in: path - required: true - description: The optimization job id. - schema: - type: string - - name: candidateId - in: path - required: true - description: The candidate id. - schema: - type: string - - name: path - in: query - required: true - description: Relative path of the file to download (e.g. 'files/examples.jsonl'). - schema: - type: string - explode: false - - name: api-version - in: query - required: true - description: The API version to use for this operation. - schema: - type: string - explode: false - responses: - '200': - description: The request has succeeded. - content: - application/octet-stream: - schema: - type: string - format: binary - default: - description: An unexpected error response. - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - tags: - - AgentOptimizationJobs - x-ms-foundry-meta: - conditional_previews: - - AgentsOptimization=V1Preview - /agent_optimization_jobs/{jobId}/candidates/{candidateId}/results: - get: - operationId: AgentOptimizationJobs_getCandidateResults - summary: Get candidate evaluation results. - description: Get full per-task evaluation results for a candidate. - parameters: - - name: Foundry-Features - in: header - required: false - description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. - schema: - type: string - enum: - - AgentsOptimization=V1Preview - - name: jobId - in: path - required: true - description: The optimization job id. - schema: - type: string - - name: candidateId - in: path - required: true - description: The candidate id. - schema: - type: string - - name: api-version - in: query - required: true - description: The API version to use for this operation. - schema: - type: string - explode: false - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - $ref: '#/components/schemas/CandidateResults' - default: - description: An unexpected error response. - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - tags: - - AgentOptimizationJobs - x-ms-foundry-meta: - conditional_previews: - - AgentsOptimization=V1Preview - /agent_optimization_jobs/{jobId}/candidates/{candidateId}:promote: - post: - operationId: AgentOptimizationJobs_promoteCandidate - summary: Promote a candidate. - description: Promotes a candidate, recording the deployment timestamp and target agent version. - parameters: - - name: Foundry-Features - in: header - required: false - description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. - schema: - type: string - enum: - - AgentsOptimization=V1Preview - - name: jobId - in: path - required: true - description: The optimization job id. - schema: - type: string - - name: candidateId - in: path - required: true - description: The candidate id to promote. - schema: - type: string - - name: api-version - in: query - required: true - description: The API version to use for this operation. - schema: - type: string - explode: false - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - $ref: '#/components/schemas/PromoteCandidateResponse' - default: - description: An unexpected error response. - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - tags: - - AgentOptimizationJobs - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/PromoteCandidateRequest' - description: Promotion details. - x-ms-foundry-meta: - conditional_previews: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview /agent_optimization_jobs/{jobId}:cancel: post: operationId: AgentOptimizationJobs_cancel summary: Cancels an agent optimization job. - description: Request cancellation. Idempotent on terminal states. + description: Request cancellation of a running or queued job. Returns an error if the job is already in a terminal state. parameters: - name: Foundry-Features in: header @@ -700,7 +416,7 @@ paths: schema: type: string enum: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview - name: jobId in: path required: true @@ -721,8 +437,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OptimizationJob' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -731,7 +453,7 @@ paths: - AgentOptimizationJobs x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview /agents: post: operationId: Agents_createAgent_Agents_createAgentFromCode @@ -763,11 +485,12 @@ paths: schema: type: string description: |- - Creates the agent. Creates a new code-based agent. Uploads the code zip and creates the agent in a single call. + Creates a new agent or a new version of an existing agent. Creates a new code-based agent. Uploads the code zip and creates the agent in a single call. The agent name is provided in the `x-ms-agent-name` header since POST /agents has no name in the URL path. The SHA-256 hex digest of the zip is provided in the `x-ms-code-zip-sha256` header for integrity and dedup. The request body is multipart/form-data with a JSON metadata part and a binary code part (part order is irrelevant). Maximum upload size is 250 MB. + summary: Create an agent Create a new code-based agent responses: '200': description: The request has succeeded. @@ -775,12 +498,20 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' + x-ms-description-override: Creates a new agent or a new version of an existing agent. + x-ms-summary-override: Create an agent x-ms-foundry-meta: required_previews: - CodeAgents=V1Preview @@ -800,7 +531,8 @@ paths: contentType: application/json get: operationId: Agents_listAgents - description: Returns the list of all agents. + summary: List agents + description: Returns a paged collection of agent resources. parameters: - name: kind in: query @@ -882,8 +614,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -893,7 +631,8 @@ paths: /agents/{agent_name}: get: operationId: Agents_getAgent - description: Retrieves the agent. + summary: Get an agent + description: Retrieves an agent definition by its unique name. parameters: - name: agent_name in: path @@ -915,8 +654,14 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -957,6 +702,7 @@ paths: If the code and definition are unchanged (matched by x-ms-code-zip-sha256 header), returns the existing version. The request body is multipart/form-data with a JSON metadata part and a binary code part (part order is irrelevant). Maximum upload size is 250 MB. + summary: Update an agent Update a code-based agent responses: '200': description: The request has succeeded. @@ -964,12 +710,20 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' + x-ms-description-override: Updates the agent by adding a new version if there are any changes to the agent definition. If no changes, returns the existing agent version. + x-ms-summary-override: Update an agent x-ms-foundry-meta: required_previews: - CodeAgents=V1Preview @@ -989,6 +743,7 @@ paths: contentType: application/json delete: operationId: Agents_deleteAgent + summary: Delete an agent description: |- Deletes an agent. For hosted agents, if any version has active sessions, the request is rejected with HTTP 409 unless `force` is set to true. When force is true, all @@ -1003,7 +758,7 @@ paths: - name: force in: query required: false - description: For Hosted Agents, if true, force-deletes the agent even if its versions have active sessions, cascading deletion to all associated sessions. Defaults to `false`. This value is not relevant for other Agent types. + description: For Hosted Agents, if `true`, force-deletes the agent even if its versions have active sessions, cascading deletion to all associated sessions. The service defaults to `false` if a value is not specified by the caller. This value is not relevant for other Agent types. schema: type: boolean default: false @@ -1022,8 +777,14 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteAgentResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -1032,7 +793,8 @@ paths: - Agents patch: operationId: Agents_patchAgentObject - description: Updates an agent endpoint. + summary: Update an agent endpoint + description: Applies a merge-patch update to the specified agent endpoint configuration. parameters: - name: Foundry-Features in: header @@ -1048,6 +810,7 @@ paths: description: The name of the agent to retrieve. schema: type: string + title: The name of the agent to retrieve - name: api-version in: query required: true @@ -1062,8 +825,14 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -1082,8 +851,9 @@ paths: /agents/{agent_name}/code:download: get: operationId: Agents_downloadAgentCode + summary: Download agent code description: |- - Download the code zip for a code-based hosted agent. + Downloads the code zip for a code-based hosted agent. Returns the previously-uploaded zip (`application/zip`). If `agent_version` is supplied, returns that version's code zip; otherwise @@ -1138,10 +908,15 @@ paths: content: application/zip: schema: - type: string - format: binary - default: - description: An unexpected error response. + contentMediaType: application/zip + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -1154,6 +929,7 @@ paths: /agents/{agent_name}/endpoint/protocols/invocations: post: operationId: AgentInvocations_createAgentInvocation + summary: Create an agent invocation description: Creates an invocation for the specified agent version. parameters: - name: agent_name @@ -1207,8 +983,14 @@ paths: content: '*/*': schema: {} - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -1227,6 +1009,7 @@ paths: /agents/{agent_name}/endpoint/protocols/invocations/docs/openapi.json: get: operationId: AgentInvocations_getAgentInvocationOpenApiSpec + summary: Get an agent invocation OpenAPI spec description: |- Retrieves the OpenAPI specification for an agent version's invocation contract. Returns 404 if the agent does not expose an OpenAPI specification. @@ -1259,9 +1042,15 @@ paths: application/json: schema: type: object - additionalProperties: {} - default: - description: An unexpected error response. + unevaluatedProperties: {} + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -1274,6 +1063,7 @@ paths: /agents/{agent_name}/endpoint/protocols/invocations/{invocation_id}: get: operationId: AgentInvocations_getAgentInvocation + summary: Get an agent invocation description: |- Retrieves the invocation with the given ID. Returns 404 if the agent does not support this operation or if the invocation ID is not found. @@ -1323,8 +1113,14 @@ paths: content: '*/*': schema: {} - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -1337,6 +1133,7 @@ paths: /agents/{agent_name}/endpoint/protocols/invocations/{invocation_id}/cancel: post: operationId: AgentInvocations_cancelAgentInvocation + summary: Cancel an agent invocation description: |- Cancels an invocation. Returns 404 if the agent does not support this operation or if the invocation ID is not found. @@ -1386,8 +1183,14 @@ paths: content: '*/*': schema: {} - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -1406,6 +1209,7 @@ paths: /agents/{agent_name}/endpoint/sessions: post: operationId: Agents_createSession + summary: Create a session description: |- Creates a new session for an agent endpoint. The endpoint resolves the backing agent version from `version_indicator` and @@ -1445,14 +1249,20 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentSessionResource' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Sessions requestBody: required: true content: @@ -1464,7 +1274,8 @@ paths: - AgentEndpoints=V1Preview get: operationId: Agents_listSessions - description: Returns a list of sessions for the specified agent. + summary: List sessions for an agent + description: Returns a paged collection of sessions associated with the specified agent endpoint. parameters: - name: Foundry-Features in: header @@ -1559,23 +1370,294 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Sessions x-ms-foundry-meta: required_previews: - AgentEndpoints=V1Preview /agents/{agent_name}/endpoint/sessions/{agent_session_id}/files: get: operationId: AgentSessionFiles_listSessionFiles + summary: List session files + description: |- + Returns files and directories at the specified path in the session sandbox. + The response includes only the immediate children of the target directory and defaults to the session home directory when no path is supplied. + parameters: + - name: Foundry-Features + in: header + required: false + description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. + schema: + type: string + enum: + - HostedAgents=V1Preview + - name: agent_name + in: path + required: true + description: The name of the agent. + schema: + type: string + - name: agent_session_id + in: path + required: true + description: The session ID. + schema: + type: string + - name: path + in: query + required: false + description: The directory path to list, relative to the session home directory. Defaults to the home directory if not provided. + schema: + type: string + explode: false + - name: x-ms-user-isolation-key + in: header + required: false + description: Opaque per-user isolation key used to scope endpoint-scoped data (responses, conversations, sessions) to a specific end user. + schema: + type: string + - name: limit + in: query + required: false + description: |- + A limit on the number of objects to be returned. Limit can range between 1 and 100, and the + default is 20. + schema: + type: integer + format: int32 + default: 20 + explode: false + - name: order + in: query + required: false + description: |- + Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc` + for descending order. + schema: + $ref: '#/components/schemas/PageOrder' + explode: false + - name: after + in: query + required: false + description: |- + A cursor for use in pagination. `after` is an object ID that defines your place in the list. + For instance, if you make a list request and receive 100 objects, ending with obj_foo, your + subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + explode: false + - name: before + in: query + required: false + description: |- + A cursor for use in pagination. `before` is an object ID that defines your place in the list. + For instance, if you make a list request and receive 100 objects, ending with obj_foo, your + subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + explode: false + - name: api-version + in: query + required: true + description: The API version to use for this operation. + schema: + type: string + explode: false + responses: + '200': + description: The request has succeeded. + content: + application/json: + schema: + $ref: '#/components/schemas/SessionDirectoryListResponse' + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + tags: + - Agent Session Files + x-ms-foundry-meta: + required_previews: + - HostedAgents=V1Preview + delete: + operationId: AgentSessionFiles_deleteSessionFile + summary: Delete a session file + description: |- + Deletes the specified file or directory from the session sandbox. + When `recursive` is false, deleting a non-empty directory returns 409 Conflict. + parameters: + - name: Foundry-Features + in: header + required: false + description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. + schema: + type: string + enum: + - HostedAgents=V1Preview + - name: agent_name + in: path + required: true + description: The name of the agent. + schema: + type: string + - name: agent_session_id + in: path + required: true + description: The session ID. + schema: + type: string + - name: path + in: query + required: true + description: The file or directory path to delete, relative to the session home directory. + schema: + type: string + explode: false + - name: recursive + in: query + required: false + description: Whether to recursively delete directory contents. The service defaults to `false` if a value is not specified by the caller. + schema: + type: boolean + default: false + explode: false + - name: x-ms-user-isolation-key + in: header + required: false + description: Opaque per-user isolation key used to scope endpoint-scoped data (responses, conversations, sessions) to a specific end user. + schema: + type: string + - name: api-version + in: query + required: true + description: The API version to use for this operation. + schema: + type: string + explode: false + responses: + '204': + description: 'There is no content to send for this request, but the headers may be useful. ' + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + tags: + - Agent Session Files + x-ms-foundry-meta: + required_previews: + - HostedAgents=V1Preview + /agents/{agent_name}/endpoint/sessions/{agent_session_id}/files/content: + put: + operationId: AgentSessionFiles_uploadSessionFile + summary: Upload a session file + description: |- + Uploads binary file content to the specified path in the session sandbox. + The service stores the file relative to the session home directory and rejects payloads larger than 50 MB. + parameters: + - name: Foundry-Features + in: header + required: false + description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. + schema: + type: string + enum: + - HostedAgents=V1Preview + - name: agent_name + in: path + required: true + description: The name of the agent. + schema: + type: string + - name: agent_session_id + in: path + required: true + description: The session ID. + schema: + type: string + - name: path + in: query + required: true + description: The destination file path within the sandbox, relative to the session home directory. + schema: + type: string + explode: false + - name: x-ms-user-isolation-key + in: header + required: false + description: Opaque per-user isolation key used to scope endpoint-scoped data (responses, conversations, sessions) to a specific end user. + schema: + type: string + - name: api-version + in: query + required: true + description: The API version to use for this operation. + schema: + type: string + explode: false + responses: + '201': + description: The request has succeeded and a new resource has been created as a result. + content: + application/json: + schema: + $ref: '#/components/schemas/SessionFileWriteResponse' + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + tags: + - Agent Session Files + requestBody: + required: true + content: + application/octet-stream: + schema: + contentMediaType: application/octet-stream + x-ms-foundry-meta: + required_previews: + - HostedAgents=V1Preview + get: + operationId: AgentSessionFiles_downloadSessionFile + summary: Download a session file description: |- - List files and directories at a given path in the session sandbox. - Returns only the immediate children of the specified directory (non-recursive). + Downloads the file at the specified sandbox path as a binary stream. + The path is resolved relative to the session home directory. parameters: - name: Foundry-Features in: header @@ -1600,7 +1682,7 @@ paths: - name: path in: query required: true - description: The directory path to list, relative to the session home directory. + description: The file path to download from the sandbox, relative to the session home directory. schema: type: string explode: false @@ -1621,214 +1703,17 @@ paths: '200': description: The request has succeeded. content: - application/json: + application/octet-stream: schema: - $ref: '#/components/schemas/SessionDirectoryListResponse' - default: - description: An unexpected error response. + contentMediaType: application/octet-stream + 4XX: + description: Client error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' - tags: - - Agent Session Files - x-ms-foundry-meta: - required_previews: - - HostedAgents=V1Preview - delete: - operationId: AgentSessionFiles_deleteSessionFile - description: |- - Delete a file or directory from the session sandbox. - If `recursive` is false (default) and the target is a non-empty directory, the API returns 409 Conflict. - parameters: - - name: Foundry-Features - in: header - required: false - description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. - schema: - type: string - enum: - - HostedAgents=V1Preview - - name: agent_name - in: path - required: true - description: The name of the agent. - schema: - type: string - - name: agent_session_id - in: path - required: true - description: The session ID. - schema: - type: string - - name: path - in: query - required: true - description: The file or directory path to delete, relative to the session home directory. - schema: - type: string - explode: false - - name: recursive - in: query - required: false - description: Whether to recursively delete directory contents. Defaults to false. - schema: - type: boolean - default: false - explode: false - - name: x-ms-user-isolation-key - in: header - required: false - description: Opaque per-user isolation key used to scope endpoint-scoped data (responses, conversations, sessions) to a specific end user. - schema: - type: string - - name: api-version - in: query - required: true - description: The API version to use for this operation. - schema: - type: string - explode: false - responses: - '204': - description: 'There is no content to send for this request, but the headers may be useful. ' - default: - description: An unexpected error response. - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - tags: - - Agent Session Files - x-ms-foundry-meta: - required_previews: - - HostedAgents=V1Preview - /agents/{agent_name}/endpoint/sessions/{agent_session_id}/files/content: - put: - operationId: AgentSessionFiles_uploadSessionFile - description: |- - Upload a file to the session sandbox via binary stream. - Maximum file size is 50 MB. Uploads exceeding this limit return 413 Payload Too Large. - parameters: - - name: Foundry-Features - in: header - required: false - description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. - schema: - type: string - enum: - - HostedAgents=V1Preview - - name: agent_name - in: path - required: true - description: The name of the agent. - schema: - type: string - - name: agent_session_id - in: path - required: true - description: The session ID. - schema: - type: string - - name: path - in: query - required: true - description: The destination file path within the sandbox, relative to the session home directory. - schema: - type: string - explode: false - - name: x-ms-user-isolation-key - in: header - required: false - description: Opaque per-user isolation key used to scope endpoint-scoped data (responses, conversations, sessions) to a specific end user. - schema: - type: string - - name: api-version - in: query - required: true - description: The API version to use for this operation. - schema: - type: string - explode: false - responses: - '201': - description: The request has succeeded and a new resource has been created as a result. - content: - application/json: - schema: - $ref: '#/components/schemas/SessionFileWriteResponse' - default: - description: An unexpected error response. - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - tags: - - Agent Session Files - requestBody: - required: true - content: - application/octet-stream: - schema: - type: string - format: binary - x-ms-foundry-meta: - required_previews: - - HostedAgents=V1Preview - get: - operationId: AgentSessionFiles_downloadSessionFile - description: Download a file from the session sandbox as a binary stream. - parameters: - - name: Foundry-Features - in: header - required: false - description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. - schema: - type: string - enum: - - HostedAgents=V1Preview - - name: agent_name - in: path - required: true - description: The name of the agent. - schema: - type: string - - name: agent_session_id - in: path - required: true - description: The session ID. - schema: - type: string - - name: path - in: query - required: true - description: The file path to download from the sandbox, relative to the session home directory. - schema: - type: string - explode: false - - name: x-ms-user-isolation-key - in: header - required: false - description: Opaque per-user isolation key used to scope endpoint-scoped data (responses, conversations, sessions) to a specific end user. - schema: - type: string - - name: api-version - in: query - required: true - description: The API version to use for this operation. - schema: - type: string - explode: false - responses: - '200': - description: The request has succeeded. - content: - application/octet-stream: - schema: - type: string - format: binary - default: - description: An unexpected error response. + 5XX: + description: Server error content: application/json: schema: @@ -1841,7 +1726,8 @@ paths: /agents/{agent_name}/endpoint/sessions/{session_id}: get: operationId: Agents_getSession - description: Retrieves a session by ID. + summary: Get a session + description: Retrieves the details of a hosted agent session by agent name and session identifier. parameters: - name: Foundry-Features in: header @@ -1883,19 +1769,26 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentSessionResource' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Sessions x-ms-foundry-meta: required_previews: - AgentEndpoints=V1Preview delete: operationId: Agents_deleteSession + summary: Delete a session description: |- Deletes a session synchronously. Returns 204 No Content when the session is deleted or does not exist. @@ -1936,23 +1829,28 @@ paths: responses: '204': description: There is no content to send for this request, but the headers may be useful. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Sessions x-ms-foundry-meta: required_previews: - AgentEndpoints=V1Preview /agents/{agent_name}/endpoint/sessions/{session_id}:stop: post: operationId: Agents_stopSession - description: |- - Stops a session. - Returns 204 No Content when the stop succeeds. + summary: Stop a session + description: Terminates the specified hosted agent session and returns 204 No Content when the request succeeds. parameters: - name: Foundry-Features in: header @@ -1984,20 +1882,27 @@ paths: responses: '204': description: There is no content to send for this request, but the headers may be useful. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Sessions x-ms-foundry-meta: required_previews: - AgentEndpoints=V1Preview /agents/{agent_name}/import: post: operationId: Agents_updateAgentFromManifest + summary: Update an agent from a manifest description: |- Updates the agent from a manifest by adding a new version if there are any changes to the agent definition. If no changes, returns the existing agent version. @@ -2022,8 +1927,14 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -2070,7 +1981,13 @@ paths: description: SHA-256 hex digest of the uploaded code zip. Used for change detection (dedup) and integrity verification. schema: type: string - description: Create a new agent version. + description: |- + Creates a new version for the specified agent and returns the created version resource. Creates a new agent version from code. Uploads the code zip and creates a new version + for an existing agent. The SHA-256 hex digest of the zip is provided in the + `x-ms-code-zip-sha256` header for integrity and dedup. + The request body is multipart/form-data with a JSON metadata part and a binary code part (part order is irrelevant). + Maximum upload size is 250 MB. + summary: Create an agent version Create an agent version from code responses: '200': description: The request has succeeded. @@ -2078,17 +1995,25 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentVersionObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' + x-ms-description-override: Creates a new version for the specified agent and returns the created version resource. + x-ms-summary-override: Create an agent version x-ms-foundry-meta: required_previews: - CodeAgents=V1Preview tags: - - Agents + - Agent Versions requestBody: required: true content: @@ -2103,7 +2028,8 @@ paths: contentType: application/json get: operationId: Agents_listAgentVersions - description: Returns the list of versions of an agent. + summary: List agent versions + description: Returns a paged collection of versions for the specified agent. parameters: - name: agent_name in: path @@ -2184,18 +2110,25 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Versions /agents/{agent_name}/versions/{agent_version}: get: operationId: Agents_getAgentVersion - description: Retrieves a specific version of an agent. + summary: Get an agent version + description: Retrieves the specified version of an agent by its agent name and version identifier. parameters: - name: agent_name in: path @@ -2223,16 +2156,23 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentVersionObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Versions delete: operationId: Agents_deleteAgentVersion + summary: Delete an agent version description: |- Deletes a specific version of an agent. For hosted agents, if the version has active sessions, the request is rejected with HTTP 409 unless `force` is set to true. When @@ -2253,7 +2193,7 @@ paths: - name: force in: query required: false - description: For Hosted Agents, if true, force-deletes the version even if it has active sessions, cascading deletion to all associated sessions. Defaults to `false`. This value is not relevant for other Agent types. + description: For Hosted Agents, if `true`, force-deletes the version even if it has active sessions, cascading deletion to all associated sessions. The service defaults to `false` if a value is not specified by the caller. This value is not relevant for other Agent types. schema: type: boolean default: false @@ -2272,17 +2212,24 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteAgentVersionResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Versions /agents/{agent_name}/versions/{agent_version}/sessions/{session_id}:logstream: get: operationId: Agents_getSessionLogStream + summary: Stream console logs for a hosted agent session description: |- Streams console logs (stdout / stderr) for a specific hosted agent session as a Server-Sent Events (SSE) stream. @@ -2351,21 +2298,28 @@ paths: text/event-stream: schema: $ref: '#/components/schemas/SessionLogEvent' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Sessions x-ms-foundry-meta: required_previews: - HostedAgents=V1Preview /agents/{agent_name}/versions:import: post: operationId: Agents_createAgentVersionFromManifest - description: Create a new agent version from a manifest. + summary: Create an agent version from manifest + description: Imports the provided manifest to create a new version for the specified agent. parameters: - name: agent_name in: path @@ -2392,14 +2346,20 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentVersionObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Versions requestBody: required: true content: @@ -2409,7 +2369,8 @@ paths: /agents:import: post: operationId: Agents_createAgentFromManifest - description: Creates an agent from a manifest. + summary: Create an agent from a manifest + description: Imports the provided manifest to create an agent and returns the created resource. parameters: - name: api-version in: query @@ -2425,8 +2386,14 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -2442,20 +2409,21 @@ paths: /connections: get: operationId: Connections_list - description: List all connections in the project, without populating connection credentials + summary: List connections + description: Returns the connections available in the current project, optionally filtered by type or default status. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: connectionType in: query required: false - description: List connections of this specific type + description: Lists connections of this specific type schema: $ref: '#/components/schemas/ConnectionType' explode: false - name: defaultConnection in: query required: false - description: List connections that are default connections + description: Lists connections that are default connections schema: type: boolean explode: false @@ -2473,8 +2441,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedConnection' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -2490,7 +2470,8 @@ paths: /connections/{name}: get: operationId: Connections_get - description: Get a connection by name, without populating connection credentials + summary: Get a connection + description: Retrieves the specified connection and its configuration details without including credential values. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -2513,8 +2494,20 @@ paths: application/json: schema: $ref: '#/components/schemas/Connection' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -2530,7 +2523,8 @@ paths: /connections/{name}/getConnectionWithCredentials: post: operationId: Connections_getWithCredentials - description: Get a connection by name, with its connection credentials + summary: Get a connection with credentials + description: Retrieves the specified connection together with its credential values. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -2553,8 +2547,20 @@ paths: application/json: schema: $ref: '#/components/schemas/Connection' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -2570,7 +2576,7 @@ paths: /data_generation_jobs: get: operationId: DataGenerationJobs_list - summary: Returns a list of data generation jobs + summary: List data generation jobs description: Returns a list of data generation jobs. parameters: - name: Foundry-Features @@ -2654,8 +2660,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -2667,8 +2679,8 @@ paths: - DataGenerationJobs=V1Preview post: operationId: DataGenerationJobs_create - summary: Creates a data generation job. - description: Creates a data generation job. + summary: Create a data generation job + description: Submits a new data generation job for asynchronous execution. parameters: - name: Foundry-Features in: header @@ -2709,8 +2721,14 @@ paths: application/json: schema: $ref: '#/components/schemas/DataGenerationJob' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -2730,8 +2748,8 @@ paths: /data_generation_jobs/{jobId}: get: operationId: DataGenerationJobs_get - summary: Get info about a data generation job. - description: Gets the details of a data generation job by its ID. + summary: Get a data generation job + description: Retrieves the specified data generation job and its current status. parameters: - name: Foundry-Features in: header @@ -2768,8 +2786,14 @@ paths: application/json: schema: $ref: '#/components/schemas/DataGenerationJob' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -2781,8 +2805,8 @@ paths: - DataGenerationJobs=V1Preview delete: operationId: DataGenerationJobs_delete - summary: Deletes a data generation job. - description: Deletes a data generation job by its ID. + summary: Delete a data generation job + description: Removes the specified data generation job and its associated output. parameters: - name: Foundry-Features in: header @@ -2808,8 +2832,14 @@ paths: responses: '204': description: There is no content to send for this request, but the headers may be useful. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -2822,8 +2852,8 @@ paths: /data_generation_jobs/{jobId}:cancel: post: operationId: DataGenerationJobs_cancel - summary: Cancels a data generation job. - description: Cancels a data generation job by its ID. + summary: Cancel a data generation job + description: Cancels the specified data generation job if it is still in progress. parameters: - name: Foundry-Features in: header @@ -2853,8 +2883,14 @@ paths: application/json: schema: $ref: '#/components/schemas/DataGenerationJob' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -2867,6 +2903,7 @@ paths: /datasets: get: operationId: Datasets_listLatest + summary: List latest versions description: List the latest version of each DatasetVersion parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -2877,8 +2914,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedDatasetVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -2894,6 +2943,7 @@ paths: /datasets/{name}/versions: get: operationId: Datasets_listVersions + summary: List versions description: List all versions of the given DatasetVersion parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -2910,8 +2960,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedDatasetVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -2927,6 +2989,7 @@ paths: /datasets/{name}/versions/{version}: get: operationId: Datasets_getVersion + summary: Get a version description: Get the specific version of the DatasetVersion. The service returns 404 Not Found error if the DatasetVersion does not exist. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -2949,8 +3012,20 @@ paths: application/json: schema: $ref: '#/components/schemas/DatasetVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -2965,6 +3040,7 @@ paths: - Datasets delete: operationId: Datasets_deleteVersion + summary: Delete a version description: Delete the specific version of the DatasetVersion. The service returns 204 No Content if the DatasetVersion was deleted successfully or if the DatasetVersion does not exist. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -2983,8 +3059,20 @@ paths: responses: '204': description: There is no content to send for this request, but the headers may be useful. - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -2999,6 +3087,7 @@ paths: - Datasets patch: operationId: Datasets_createOrUpdateVersion + summary: Create or update a version description: Create a new or update an existing DatasetVersion with the given version id parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -3027,8 +3116,20 @@ paths: application/json: schema: $ref: '#/components/schemas/DatasetVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -3051,7 +3152,8 @@ paths: /datasets/{name}/versions/{version}/credentials: post: operationId: Datasets_getCredentials - description: Get the SAS credential to access the storage account associated with a Dataset version. + summary: Get dataset credentials + description: Gets the SAS credential to access the storage account associated with a Dataset version. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -3073,8 +3175,20 @@ paths: application/json: schema: $ref: '#/components/schemas/AssetCredentialResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -3090,7 +3204,8 @@ paths: /datasets/{name}/versions/{version}/startPendingUpload: post: operationId: Datasets_startPendingUploadVersion - description: Start a new or get an existing pending upload of a dataset for a specific version. + summary: Start a pending upload + description: Initiates a new pending upload or retrieves an existing one for the specified dataset version. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -3112,8 +3227,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PendingUploadResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -3136,7 +3263,8 @@ paths: /deployments: get: operationId: Deployments_list - description: List all deployed models in the project + summary: List deployments + description: Returns the deployed models available in the current project, optionally filtered by publisher, model name, or deployment type. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: modelPublisher @@ -3174,8 +3302,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedDeployment' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -3191,7 +3331,8 @@ paths: /deployments/{name}: get: operationId: Deployments_get - description: Get a deployed model. + summary: Get a deployment + description: Gets a deployed model. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -3214,8 +3355,20 @@ paths: application/json: schema: $ref: '#/components/schemas/Deployment' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -3231,7 +3384,8 @@ paths: /evaluationrules: get: operationId: EvaluationRules_list - description: List all evaluation rules. + summary: List evaluation rules + description: Returns the evaluation rules configured for the project, optionally filtered by action type, agent name, or enabled state. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: actionType @@ -3262,8 +3416,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedEvaluationRule' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -3279,7 +3445,8 @@ paths: /evaluationrules/{id}: get: operationId: EvaluationRules_get - description: Get an evaluation rule. + summary: Get an evaluation rule + description: Retrieves the specified evaluation rule and its configuration. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: id @@ -3295,8 +3462,20 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluationRule' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -3311,7 +3490,8 @@ paths: - Evaluation Rules delete: operationId: EvaluationRules_delete - description: Delete an evaluation rule. + summary: Delete an evaluation rule + description: Removes the specified evaluation rule from the project. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: id @@ -3323,8 +3503,20 @@ paths: responses: '204': description: There is no content to send for this request, but the headers may be useful. - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -3339,7 +3531,8 @@ paths: - Evaluation Rules put: operationId: EvaluationRules_createOrUpdate - description: Create or update an evaluation rule. + summary: Create or update an evaluation rule + description: Creates a new evaluation rule, or replaces the existing rule when the identifier matches. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: id @@ -3369,8 +3562,20 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluationRule' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -3393,7 +3598,8 @@ paths: /evaluationtaxonomies: get: operationId: EvaluationTaxonomies_list - description: List evaluation taxonomies + summary: List evaluation taxonomies + description: Returns the evaluation taxonomies available in the project, optionally filtered by input name or input type. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: inputName @@ -3425,8 +3631,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedEvaluationTaxonomy' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -3442,7 +3660,8 @@ paths: /evaluationtaxonomies/{name}: get: operationId: EvaluationTaxonomies_get - description: Get an evaluation run by name. + summary: Get an evaluation taxonomy + description: Retrieves the specified evaluation taxonomy. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -3466,8 +3685,20 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluationTaxonomy' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -3482,7 +3713,8 @@ paths: - Evaluation Taxonomies delete: operationId: EvaluationTaxonomies_delete - description: Delete an evaluation taxonomy by name. + summary: Delete an evaluation taxonomy + description: Removes the specified evaluation taxonomy from the project. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -3502,8 +3734,20 @@ paths: responses: '204': description: There is no content to send for this request, but the headers may be useful. - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -3518,7 +3762,8 @@ paths: - Evaluation Taxonomies put: operationId: EvaluationTaxonomies_create - description: Create an evaluation taxonomy. + summary: Create an evaluation taxonomy + description: Creates or replaces the specified evaluation taxonomy with the provided definition. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: Foundry-Features @@ -3548,8 +3793,20 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluationTaxonomy' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -3571,6 +3828,7 @@ paths: description: The evaluation taxonomy. patch: operationId: EvaluationTaxonomies_update + summary: Update an evaluation taxonomy description: Update an evaluation taxonomy. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -3595,8 +3853,20 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluationTaxonomy' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -3619,7 +3889,7 @@ paths: /evaluator_generation_jobs: post: operationId: EvaluatorGenerationJobs_create - summary: Creates an evaluator generation job. + summary: Create an evaluator generation job description: |- Creates an evaluator generation job. The service generates rubric-based evaluator definitions from the provided source materials asynchronously. @@ -3663,8 +3933,14 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluatorGenerationJob' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -3683,8 +3959,12 @@ paths: - Evaluations=V1Preview get: operationId: EvaluatorGenerationJobs_list - summary: Returns a list of evaluator generation jobs. - description: Returns a list of evaluator generation jobs. + summary: List evaluator generation jobs + description: |- + Returns a list of evaluator generation jobs. The List API has up to a few + seconds of propagation delay, so a recently created job may not appear + immediately; use the Get evaluator generation job API with the job ID to + retrieve a specific job without delay. parameters: - name: Foundry-Features in: header @@ -3767,8 +4047,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -3781,7 +4067,7 @@ paths: /evaluator_generation_jobs/{jobId}: get: operationId: EvaluatorGenerationJobs_get - summary: Get info about an evaluator generation job. + summary: Get an evaluator generation job description: Gets the details of an evaluator generation job by its ID. parameters: - name: Foundry-Features @@ -3819,8 +4105,14 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluatorGenerationJob' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -3832,6 +4124,7 @@ paths: - Evaluations=V1Preview delete: operationId: EvaluatorGenerationJobs_delete + summary: Delete an evaluator generation job description: |- Deletes an evaluator generation job by its ID. Deletes the job record only; the generated evaluator (if any) is preserved. @@ -3860,8 +4153,14 @@ paths: responses: '204': description: There is no content to send for this request, but the headers may be useful. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -3874,7 +4173,7 @@ paths: /evaluator_generation_jobs/{jobId}:cancel: post: operationId: EvaluatorGenerationJobs_cancel - summary: Cancels an evaluator generation job. + summary: Cancel an evaluator generation job description: Cancels an evaluator generation job by its ID. parameters: - name: Foundry-Features @@ -3905,8 +4204,14 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluatorGenerationJob' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -3919,7 +4224,8 @@ paths: /evaluators: get: operationId: Evaluators_listLatestVersions - description: List the latest version of each evaluator + summary: List latest evaluator versions + description: Lists the latest version of each evaluator parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: type @@ -3957,8 +4263,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedEvaluatorVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -3974,7 +4292,8 @@ paths: /evaluators/{name}/versions: get: operationId: Evaluators_listVersions - description: List all versions of the given evaluator + summary: List evaluator versions + description: Returns the available versions for the specified evaluator. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -4018,8 +4337,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedEvaluatorVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -4034,7 +4365,8 @@ paths: - Evaluators post: operationId: Evaluators_createVersion - description: Create a new EvaluatorVersion with auto incremented version id + summary: Create an evaluator version + description: Creates a new evaluator version with an auto-incremented version identifier. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -4058,8 +4390,20 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluatorVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -4081,7 +4425,8 @@ paths: /evaluators/{name}/versions/{version}: get: operationId: Evaluators_getVersion - description: Get the specific version of the EvaluatorVersion. The service returns 404 Not Found error if the EvaluatorVersion does not exist. + summary: Get an evaluator version + description: Retrieves the specified evaluator version, returning 404 if it does not exist. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -4111,8 +4456,20 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluatorVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -4127,7 +4484,8 @@ paths: - Evaluators delete: operationId: Evaluators_deleteVersion - description: Delete the specific version of the EvaluatorVersion. The service returns 204 No Content if the EvaluatorVersion was deleted successfully or if the EvaluatorVersion does not exist. + summary: Delete an evaluator version + description: Removes the specified evaluator version. Returns 204 whether the version existed or not. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -4153,8 +4511,20 @@ paths: responses: '204': description: There is no content to send for this request, but the headers may be useful. - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -4169,7 +4539,8 @@ paths: - Evaluators patch: operationId: Evaluators_updateVersion - description: Update an existing EvaluatorVersion with the given version id + summary: Update an evaluator version + description: Updates the specified evaluator version in place. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -4199,8 +4570,20 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluatorVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -4223,7 +4606,8 @@ paths: /evaluators/{name}/versions/{version}/credentials: post: operationId: Evaluators_getCredentials - description: Get the SAS credential to access the storage account associated with an Evaluator version. + summary: Get evaluator credentials + description: Retrieves SAS credentials for accessing the storage account associated with the specified evaluator version. parameters: - name: Foundry-Features in: header @@ -4258,8 +4642,14 @@ paths: application/json: schema: $ref: '#/components/schemas/AssetCredentialResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -4279,7 +4669,8 @@ paths: /evaluators/{name}/versions/{version}/startPendingUpload: post: operationId: Evaluators_startPendingUpload - description: Start a new or get an existing pending upload of an evaluator for a specific version. + summary: Start a pending upload + description: Initiates a new pending upload or retrieves an existing one for the specified evaluator version. parameters: - name: Foundry-Features in: header @@ -4314,8 +4705,14 @@ paths: application/json: schema: $ref: '#/components/schemas/PendingUploadResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -4335,6 +4732,7 @@ paths: /indexes: get: operationId: Indexes_listLatest + summary: List latest versions description: List the latest version of each Index parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -4345,8 +4743,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedIndex' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -4362,6 +4772,7 @@ paths: /indexes/{name}/versions: get: operationId: Indexes_listVersions + summary: List versions description: List all versions of the given Index parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -4378,8 +4789,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedIndex' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -4395,6 +4818,7 @@ paths: /indexes/{name}/versions/{version}: get: operationId: Indexes_getVersion + summary: Get a version description: Get the specific version of the Index. The service returns 404 Not Found error if the Index does not exist. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -4417,8 +4841,20 @@ paths: application/json: schema: $ref: '#/components/schemas/Index' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -4433,6 +4869,7 @@ paths: - Indexes delete: operationId: Indexes_deleteVersion + summary: Delete a version description: Delete the specific version of the Index. The service returns 204 No Content if the Index was deleted successfully or if the Index does not exist. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -4451,8 +4888,20 @@ paths: responses: '204': description: There is no content to send for this request, but the headers may be useful. - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -4467,6 +4916,7 @@ paths: - Indexes patch: operationId: Indexes_createOrUpdateVersion + summary: Create or update a version description: Create a new or update an existing Index with the given version id parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -4495,8 +4945,20 @@ paths: application/json: schema: $ref: '#/components/schemas/Index' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -4519,7 +4981,8 @@ paths: /insights: post: operationId: Insights_generate - description: Generate Insights + summary: Generate insights + description: Generates an insights report from the provided evaluation configuration. parameters: - name: Foundry-Features in: header @@ -4556,8 +5019,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Insight' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -4573,7 +5042,8 @@ paths: description: Complete evaluation configuration including data source, evaluators, and result settings get: operationId: Insights_list - description: List all insights in reverse chronological order (newest first). + summary: List insights + description: Returns insights in reverse chronological order, with the most recent entries first. parameters: - name: Foundry-Features in: header @@ -4632,8 +5102,14 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedInsight' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -4643,7 +5119,8 @@ paths: /insights/{id}: get: operationId: Insights_get - description: Get a specific insight by Id. + summary: Get an insight + description: Retrieves the specified insight report and its results. parameters: - name: Foundry-Features in: header @@ -4680,8 +5157,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Insight' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -4691,7 +5174,8 @@ paths: /memory_stores: post: operationId: createMemoryStore - description: Create a memory store. + summary: Create a memory store + description: Creates a memory store resource with the provided configuration. parameters: - name: Foundry-Features in: header @@ -4715,8 +5199,14 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryStoreObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -4740,7 +5230,7 @@ paths: description: A human-readable description of the memory store. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Arbitrary key-value metadata to associate with the memory store. definition: @@ -4755,7 +5245,8 @@ paths: - MemoryStores=V1Preview get: operationId: listMemoryStores - description: List all memory stores. + summary: List memory stores + description: Returns the memory stores available to the caller. parameters: - name: Foundry-Features in: header @@ -4838,8 +5329,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -4852,7 +5349,8 @@ paths: /memory_stores/{name}: post: operationId: updateMemoryStore - description: Update a memory store. + summary: Update a memory store + description: Updates the specified memory store with the supplied configuration changes. parameters: - name: Foundry-Features in: header @@ -4882,8 +5380,14 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryStoreObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -4903,7 +5407,7 @@ paths: description: A human-readable description of the memory store. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Arbitrary key-value metadata to associate with the memory store. x-ms-foundry-meta: @@ -4911,7 +5415,8 @@ paths: - MemoryStores=V1Preview get: operationId: getMemoryStore - description: Retrieve a memory store. + summary: Get a memory store + description: Retrieves the specified memory store and its current configuration. parameters: - name: Foundry-Features in: header @@ -4941,8 +5446,14 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryStoreObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -4954,7 +5465,8 @@ paths: - MemoryStores=V1Preview delete: operationId: deleteMemoryStore - description: Delete a memory store. + summary: Delete a memory store + description: Deletes the specified memory store. parameters: - name: Foundry-Features in: header @@ -4984,8 +5496,14 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteMemoryStoreResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -4998,7 +5516,8 @@ paths: /memory_stores/{name}/items: post: operationId: createMemory - description: Create a memory item in a memory store. + summary: Create a memory item + description: Creates a memory item in the specified memory store. parameters: - name: Foundry-Features in: header @@ -5028,8 +5547,14 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryItem' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -5063,7 +5588,8 @@ paths: /memory_stores/{name}/items/{memory_id}: post: operationId: updateMemory - description: Update a memory item in a memory store. + summary: Update a memory item + description: Updates the specified memory item in the memory store. parameters: - name: Foundry-Features in: header @@ -5099,8 +5625,14 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryItem' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -5124,7 +5656,8 @@ paths: - MemoryStores=V1Preview get: operationId: getMemory - description: Retrieve a memory item from a memory store. + summary: Get a memory item + description: Retrieves the specified memory item from the memory store. parameters: - name: Foundry-Features in: header @@ -5160,8 +5693,14 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryItem' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -5173,7 +5712,8 @@ paths: - MemoryStores=V1Preview delete: operationId: deleteMemory - description: Delete a memory item from a memory store. + summary: Delete a memory item + description: Deletes the specified memory item from the memory store. parameters: - name: Foundry-Features in: header @@ -5209,8 +5749,14 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteMemoryResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -5223,7 +5769,8 @@ paths: /memory_stores/{name}/items:list: post: operationId: listMemories - description: List all memory items in a memory store. + summary: List memory items + description: Returns memory items from the specified memory store. parameters: - name: Foundry-Features in: header @@ -5319,8 +5866,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -5345,7 +5898,8 @@ paths: /memory_stores/{name}/updates/{update_id}: get: operationId: getUpdateResult - description: Get memory store update result. + summary: Get an update result + description: Retrieves the status and result of a memory store update operation. parameters: - name: Foundry-Features in: header @@ -5381,8 +5935,14 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryStoreUpdateResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -5395,7 +5955,8 @@ paths: /memory_stores/{name}:delete_scope: post: operationId: deleteScopeMemories - description: Delete all memories associated with a specific scope from a memory store. + summary: Delete memories by scope + description: Deletes all memories in the specified memory store that are associated with the provided scope. parameters: - name: Foundry-Features in: header @@ -5425,8 +5986,14 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryStoreDeleteScopeResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -5451,7 +6018,8 @@ paths: /memory_stores/{name}:search_memories: post: operationId: searchMemories - description: Search for relevant memories from a memory store based on conversation context. + summary: Search memories + description: Searches the specified memory store for memories relevant to the provided conversation context. parameters: - name: Foundry-Features in: header @@ -5481,8 +6049,14 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryStoreSearchResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -5519,7 +6093,10 @@ paths: /memory_stores/{name}:update_memories: post: operationId: updateMemories - description: Update memory store with conversation memories. + summary: Update memories + description: |- + Starts an update that writes conversation memories into the specified memory store. + The operation returns a long-running status location for polling the update result. parameters: - name: Foundry-Features in: header @@ -5556,8 +6133,14 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryStoreUpdateResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -5599,6 +6182,7 @@ paths: /models: get: operationId: Models_listLatest + summary: List latest versions description: List the latest version of each ModelVersion parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -5617,8 +6201,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedModelVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -5634,6 +6230,7 @@ paths: /models/{name}/versions: get: operationId: Models_listVersions + summary: List versions description: List all versions of the given ModelVersion parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -5658,8 +6255,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedModelVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -5675,7 +6284,8 @@ paths: /models/{name}/versions/{version}: get: operationId: Models_getVersion - description: Get the specific version of the ModelVersion. The service returns 404 Not Found error if the ModelVersion does not exist. + summary: Get a model version + description: Retrieves the specified model version, returning 404 if it does not exist. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -5705,8 +6315,20 @@ paths: application/json: schema: $ref: '#/components/schemas/ModelVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -5724,6 +6346,7 @@ paths: - Models=V1Preview delete: operationId: Models_deleteVersion + summary: Delete a model version description: Delete the specific version of the ModelVersion. The service returns 200 OK if the ModelVersion was deleted successfully or if the ModelVersion does not exist. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -5750,8 +6373,20 @@ paths: responses: '200': description: The request has succeeded. - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -5769,6 +6404,7 @@ paths: - Models=V1Preview patch: operationId: Models_updateVersion + summary: Update a model version description: Update an existing ModelVersion with the given version id parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -5805,8 +6441,20 @@ paths: application/json: schema: $ref: '#/components/schemas/ModelVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -5832,7 +6480,8 @@ paths: /models/{name}/versions/{version}/createAsync: post: operationId: Models_createAsync - description: Creates a model version asynchronously with blob content validation. Returns 202 Accepted with a Location header for polling. + summary: Create a model version async + description: Creates a model version asynchronously with blob content validation. Returns 202 Accepted with a location header for polling the operation status. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: Foundry-Features @@ -5875,12 +6524,25 @@ paths: format: uri description: URL to poll for operation status. operationResult: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' description: URL to the operation result, or null if the operation is still in progress. - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -5906,7 +6568,8 @@ paths: /models/{name}/versions/{version}/credentials: post: operationId: Models_getCredentials - description: Get credentials for a model version asset. + summary: Get model asset credentials + description: Retrieves temporary credentials for accessing the storage backing the specified model version. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: Foundry-Features @@ -5936,8 +6599,20 @@ paths: application/json: schema: $ref: '#/components/schemas/AssetCredentialResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -5962,7 +6637,8 @@ paths: /models/{name}/versions/{version}/startPendingUpload: post: operationId: Models_startPendingUpload - description: Start or retrieve a pending upload for a model version. + summary: Start a pending upload + description: Initiates a new pending upload or retrieves an existing one for the specified model version. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: Foundry-Features @@ -5992,8 +6668,20 @@ paths: application/json: schema: $ref: '#/components/schemas/ModelPendingUploadResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -6018,7 +6706,8 @@ paths: /openai/v1/conversations: post: operationId: createConversation - description: Create a conversation. + summary: Create a conversation + description: Creates a new conversation resource. parameters: - name: x-ms-user-isolation-key in: header @@ -6033,8 +6722,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ConversationResource' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6049,7 +6744,8 @@ paths: $ref: '#/components/schemas/OpenAI.CreateConversationBody' get: operationId: listConversations - description: Returns the list of all conversations. + summary: List conversations + description: Returns the conversations available in the current project. parameters: - name: limit in: query @@ -6137,8 +6833,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6148,7 +6850,8 @@ paths: /openai/v1/conversations/{conversation_id}: post: operationId: updateConversation - description: Update a conversation. + summary: Update a conversation + description: Modifies the specified conversation's properties. parameters: - name: conversation_id in: path @@ -6169,8 +6872,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ConversationResource' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6185,7 +6894,8 @@ paths: $ref: '#/components/schemas/OpenAI.UpdateConversationBody' get: operationId: getConversation - description: Retrieves a conversation. + summary: Retrieve a conversation + description: Retrieves the specified conversation and its metadata. parameters: - name: conversation_id in: path @@ -6206,8 +6916,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ConversationResource' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6216,7 +6932,8 @@ paths: - Conversations delete: operationId: deleteConversation - description: Deletes a conversation. + summary: Delete a conversation + description: Removes the specified conversation resource from the current project. parameters: - name: conversation_id in: path @@ -6237,8 +6954,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.DeletedConversationResource' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6248,7 +6971,8 @@ paths: /openai/v1/conversations/{conversation_id}/items: post: operationId: createConversationItems - description: Create items in a conversation with the given ID. + summary: Create conversation items + description: Adds one or more items to the specified conversation. parameters: - name: conversation_id in: path @@ -6280,8 +7004,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ConversationItemList' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6305,7 +7035,8 @@ paths: - items get: operationId: listConversationItems - description: List all items for a conversation with the given ID. + summary: List conversation items + description: Returns the items belonging to the specified conversation. parameters: - name: conversation_id in: path @@ -6392,8 +7123,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6403,7 +7140,8 @@ paths: /openai/v1/conversations/{conversation_id}/items/{item_id}: get: operationId: getConversationItem - description: Get a single item from a conversation with the given IDs. + summary: Get a conversation item + description: Retrieves a specific item from the specified conversation. parameters: - name: conversation_id in: path @@ -6430,8 +7168,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.OutputItem' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6440,7 +7184,8 @@ paths: - Conversations delete: operationId: deleteConversationItem - description: Delete an item from a conversation with the given IDs. + summary: Delete a conversation item + description: Removes the specified item from a conversation. parameters: - name: conversation_id in: path @@ -6467,8 +7212,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ConversationResource' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6478,8 +7229,8 @@ paths: /openai/v1/evals: get: operationId: Evals_listEvals - summary: List all evaluations - description: List evaluations for a project. + summary: List evaluations + description: Returns the evaluations configured in the current project. parameters: - name: after in: query @@ -6493,8 +7244,7 @@ paths: required: false description: Number of runs to retrieve. schema: - allOf: - - $ref: '#/components/schemas/integer' + $ref: '#/components/schemas/integer' default: 20 explode: false - name: order @@ -6546,8 +7296,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6556,9 +7312,9 @@ paths: - Evals post: operationId: Evals_createEval - summary: Create evaluation + summary: Create an evaluation description: |- - Create the structure of an evaluation that can be used to test a model's performance. + Creates the structure of an evaluation that can be used to test a model's performance. An evaluation is a set of testing criteria and the config for a data source, which dictates the schema of the data used in the evaluation. After creating an evaluation, you can run it on different models and model parameters. We support several types of graders and datasources. For more information, see the [Evals guide](https://platform.openai.com/docs/guides/evals). parameters: [] @@ -6569,8 +7325,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Eval' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6587,7 +7349,7 @@ paths: delete: operationId: Evals_deleteEval summary: Delete an evaluation - description: Delete an evaluation. + description: Removes the specified evaluation and its associated data. parameters: - name: eval_id in: path @@ -6602,8 +7364,14 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteEvalResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6613,7 +7381,7 @@ paths: get: operationId: Evals_getEval summary: Get an evaluation - description: Get an evaluation by ID. + description: Retrieves the specified evaluation and its configuration. parameters: - name: eval_id in: path @@ -6628,8 +7396,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Eval' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6639,7 +7413,7 @@ paths: post: operationId: Evals_updateEval summary: Update an evaluation - description: Update certain properties of an evaluation. + description: Updates certain properties of an evaluation. parameters: - name: eval_id in: path @@ -6654,8 +7428,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Eval' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6671,8 +7451,8 @@ paths: /openai/v1/evals/{eval_id}/runs: get: operationId: Evals_listRuns - summary: Get a list of runs for an evaluation - description: Get a list of runs for an evaluation. + summary: List evaluation runs + description: Returns the runs associated with the specified evaluation. parameters: - name: eval_id in: path @@ -6692,8 +7472,7 @@ paths: required: false description: Number of runs to retrieve. schema: - allOf: - - $ref: '#/components/schemas/integer' + $ref: '#/components/schemas/integer' default: 20 explode: false - name: order @@ -6746,8 +7525,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6756,7 +7541,8 @@ paths: - Evals post: operationId: Evals_createEvalRun - summary: Create evaluation run + summary: Create an evaluation run + description: Creates an evaluation run for the specified evaluation. parameters: - name: eval_id in: path @@ -6771,8 +7557,14 @@ paths: application/json: schema: $ref: '#/components/schemas/EvalRun' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6788,8 +7580,8 @@ paths: /openai/v1/evals/{eval_id}/runs/{run_id}: delete: operationId: Evals_deleteEvalRun - summary: Delete evaluation run - description: Delete an eval run. + summary: Delete an evaluation run + description: Removes the specified evaluation run. parameters: - name: eval_id in: path @@ -6810,8 +7602,14 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteEvalRunResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6821,7 +7619,7 @@ paths: get: operationId: Evals_getEvalRun summary: Get an evaluation run - description: Get an evaluation run by ID. + description: Retrieves the specified evaluation run and its current status. parameters: - name: eval_id in: path @@ -6842,8 +7640,14 @@ paths: application/json: schema: $ref: '#/components/schemas/EvalRun' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6852,8 +7656,8 @@ paths: - Evals post: operationId: Evals_cancelEvalRun - summary: Cancel evaluation run - description: Cancel an ongoing evaluation run. + summary: Cancel an evaluation run + description: Cancels an ongoing evaluation run. parameters: - name: eval_id in: path @@ -6874,8 +7678,14 @@ paths: application/json: schema: $ref: '#/components/schemas/EvalRun' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6885,8 +7695,8 @@ paths: /openai/v1/evals/{eval_id}/runs/{run_id}/output_items: get: operationId: Evals_getEvalRunOutputItems - summary: Get evaluation run output items - description: Get a list of output items for an evaluation run. + summary: List evaluation run output items + description: Returns the output items produced by the specified evaluation run. parameters: - name: eval_id in: path @@ -6911,8 +7721,7 @@ paths: required: false description: Number of runs to retrieve. schema: - allOf: - - $ref: '#/components/schemas/integer' + $ref: '#/components/schemas/integer' default: 20 explode: false - name: order @@ -6963,8 +7772,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6975,7 +7790,7 @@ paths: get: operationId: Evals_getEvalRunOutputItem summary: Get an output item of an evaluation run - description: Get an evaluation run output item by ID. + description: Retrieves a single output item from the specified evaluation run. parameters: - name: eval_id in: path @@ -7002,8 +7817,14 @@ paths: application/json: schema: $ref: '#/components/schemas/EvalRunOutputItem' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -7013,6 +7834,7 @@ paths: /openai/v1/fine_tuning/jobs: post: operationId: createFineTuningJob + summary: Create a fine-tuning job description: |- Creates a fine-tuning job which begins the process of creating a new model from a given dataset. @@ -7034,8 +7856,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.FineTuningJob' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -7050,7 +7878,8 @@ paths: $ref: '#/components/schemas/OpenAI.CreateFineTuningJobRequest' get: operationId: listPaginatedFineTuningJobs - description: List your organization's fine-tuning jobs + summary: List fine-tuning jobs + description: Returns the fine-tuning jobs for the current organization. parameters: - name: after in: query @@ -7082,8 +7911,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ListPaginatedFineTuningJobsResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -7093,8 +7928,9 @@ paths: /openai/v1/fine_tuning/jobs/{fine_tuning_job_id}: get: operationId: retrieveFineTuningJob + summary: Get a fine-tuning job description: |- - Get info about a fine-tuning job. + Gets info about a fine-tuning job. [Learn more about fine-tuning](https://platform.openai.com/docs/guides/fine-tuning) parameters: @@ -7118,8 +7954,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.FineTuningJob' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -7129,7 +7971,8 @@ paths: /openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel: post: operationId: cancelFineTuningJob - description: Immediately cancel a fine-tune job. + summary: Cancel a fine-tuning job + description: Immediately cancels the specified fine-tuning job. parameters: - name: fine_tuning_job_id in: path @@ -7151,8 +7994,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.FineTuningJob' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -7162,7 +8011,8 @@ paths: /openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints: get: operationId: listFineTuningJobCheckpoints - description: List checkpoints for a fine-tuning job. + summary: List fine-tuning job checkpoints + description: Returns the checkpoints saved during the specified fine-tuning job. parameters: - name: fine_tuning_job_id in: path @@ -7200,8 +8050,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ListFineTuningJobCheckpointsResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -7211,7 +8067,8 @@ paths: /openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events: get: operationId: listFineTuningJobEvents - description: Get fine-grained status updates for a fine-tuning job. + summary: List fine-tuning job events + description: Returns the status events emitted during the specified fine-tuning job. parameters: - name: fine_tuning_job_id in: path @@ -7249,8 +8106,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ListFineTuningJobEventsResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -7260,7 +8123,8 @@ paths: /openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause: post: operationId: pauseFineTuningJob - description: Pause a running fine-tune job. + summary: Pause a fine-tuning job + description: Pauses the specified fine-tuning job while it is running. parameters: - name: fine_tuning_job_id in: path @@ -7282,8 +8146,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.FineTuningJob' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -7293,7 +8163,8 @@ paths: /openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume: post: operationId: resumeFineTuningJob - description: Resume a paused fine-tune job. + summary: Resume a fine-tuning job + description: Resumes the specified fine-tuning job after it has been paused. parameters: - name: fine_tuning_job_id in: path @@ -7315,8 +8186,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.FineTuningJob' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -7325,7 +8202,9 @@ paths: - Fine-Tuning /openai/v1/responses: post: - operationId: createResponse_createResponseStream + operationId: createResponse + summary: Create a model response + description: Creates a model response. Provide text or image inputs to generate text or JSON outputs. Have the model call your own custom code or use built-in tools like web search or file search to use your own data as input for the model’s response. parameters: - name: x-ms-user-isolation-key in: header @@ -7333,7 +8212,6 @@ paths: description: Opaque per-user isolation key used to scope endpoint-scoped data (responses, conversations, sessions) to a specific end user. schema: type: string - description: Creates a model response. Creates a model response (streaming response). responses: '200': description: The request has succeeded. @@ -7346,12 +8224,200 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/OpenAI.Response' + type: object + properties: + metadata: + anyOf: + - $ref: '#/components/schemas/OpenAI.Metadata' + - type: 'null' + top_logprobs: + anyOf: + - $ref: '#/components/schemas/OpenAI.integer' + - type: 'null' + temperature: + anyOf: + - $ref: '#/components/schemas/OpenAI.numeric' + - type: 'null' + default: 1 + top_p: + anyOf: + - $ref: '#/components/schemas/OpenAI.numeric' + - type: 'null' + default: 1 + user: + type: string + description: |- + This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. + A stable identifier for your end-users. + Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). + deprecated: true + safety_identifier: + type: string + maxLength: 64 + description: |- + A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. + The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). + prompt_cache_key: + type: string + description: Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching). + service_tier: + $ref: '#/components/schemas/OpenAI.ServiceTier' + prompt_cache_retention: + anyOf: + - type: string + enum: + - in_memory + - 24h + - type: 'null' + previous_response_id: + anyOf: + - type: string + - type: 'null' + model: + type: string + description: The model deployment to use for the creation of this response. + reasoning: + anyOf: + - $ref: '#/components/schemas/OpenAI.Reasoning' + - type: 'null' + background: + anyOf: + - type: boolean + - type: 'null' + max_tool_calls: + anyOf: + - $ref: '#/components/schemas/OpenAI.integer' + - type: 'null' + text: + $ref: '#/components/schemas/OpenAI.ResponseTextParam' + tools: + $ref: '#/components/schemas/OpenAI.ToolsArray' + tool_choice: + oneOf: + - $ref: '#/components/schemas/OpenAI.ToolChoiceOptions' + - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' + prompt: + $ref: '#/components/schemas/OpenAI.Prompt' + truncation: + anyOf: + - type: string + enum: + - auto + - disabled + - type: 'null' + default: disabled + id: + type: string + description: Unique identifier for this Response. + object: + type: string + enum: + - response + description: The object type of this resource - always set to `response`. + x-stainless-const: true + status: + type: string + enum: + - completed + - failed + - in_progress + - cancelled + - queued + - incomplete + description: |- + The status of the response generation. One of `completed`, `failed`, + `in_progress`, `cancelled`, `queued`, or `incomplete`. + created_at: + type: integer + format: unixtime + description: Unix timestamp (in seconds) of when this Response was created. + completed_at: + anyOf: + - type: string + format: date-time + - type: 'null' + type: integer + format: unixTimestamp + error: + anyOf: + - $ref: '#/components/schemas/OpenAI.ResponseError' + - type: 'null' + incomplete_details: + anyOf: + - $ref: '#/components/schemas/OpenAI.ResponseIncompleteDetails' + - type: 'null' + output: + type: array + items: + $ref: '#/components/schemas/OpenAI.OutputItem' + description: |- + An array of content items generated by the model. + - The length and order of items in the `output` array is dependent + on the model's response. + - Rather than accessing the first item in the `output` array and + assuming it's an `assistant` message with the content generated by + the model, you might consider using the `output_text` property where + supported in SDKs. + instructions: + anyOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.InputItem' + - type: 'null' + output_text: + anyOf: + - type: string + - type: 'null' + usage: + $ref: '#/components/schemas/OpenAI.ResponseUsage' + moderation: + anyOf: + - $ref: '#/components/schemas/OpenAI.Moderation' + - type: 'null' + parallel_tool_calls: + type: boolean + description: Whether to allow the model to run tool calls in parallel. + default: true + conversation: + anyOf: + - $ref: '#/components/schemas/OpenAI.ConversationReference' + - type: 'null' + max_output_tokens: + anyOf: + - $ref: '#/components/schemas/OpenAI.integer' + - type: 'null' + agent_reference: + anyOf: + - $ref: '#/components/schemas/AgentReference' + - type: 'null' + description: The agent used for this response + content_filters: + type: array + items: + $ref: '#/components/schemas/ContentFilterResult' + description: The content filter evaluation results. + required: + - id + - object + - created_at + - error + - incomplete_details + - output + - instructions + - parallel_tool_calls + - agent_reference text/event-stream: schema: $ref: '#/components/schemas/OpenAI.CreateResponseStreamingResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -7363,274 +8429,149 @@ paths: content: application/json: schema: - anyOf: - - type: object - properties: - metadata: - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true - top_logprobs: - type: integer - allOf: - - $ref: '#/components/schemas/OpenAI.integer' - nullable: true - temperature: - type: number - allOf: - - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true - default: 1 - top_p: - type: number - allOf: - - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true - default: 1 - user: - type: string - description: |- - This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. - A stable identifier for your end-users. - Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). - deprecated: true - safety_identifier: - type: string - description: |- - A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. - The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). - prompt_cache_key: - type: string - description: Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching). - service_tier: - $ref: '#/components/schemas/OpenAI.ServiceTier' - prompt_cache_retention: - type: string - enum: - - in-memory - - 24h - nullable: true - previous_response_id: - type: string - nullable: true - model: - type: string - description: The model deployment to use for the creation of this response. - reasoning: - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.Reasoning' - nullable: true - background: - type: boolean - nullable: true - max_output_tokens: - type: integer - allOf: - - $ref: '#/components/schemas/OpenAI.integer' - nullable: true - max_tool_calls: - type: integer - allOf: - - $ref: '#/components/schemas/OpenAI.integer' - nullable: true - text: - $ref: '#/components/schemas/OpenAI.ResponseTextParam' - tools: - $ref: '#/components/schemas/OpenAI.ToolsArray' - tool_choice: - oneOf: - - $ref: '#/components/schemas/OpenAI.ToolChoiceOptions' - - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' - prompt: - $ref: '#/components/schemas/OpenAI.Prompt' - truncation: - type: string - enum: - - auto - - disabled - nullable: true - default: disabled - input: - $ref: '#/components/schemas/OpenAI.InputParam' - include: - type: array - items: - $ref: '#/components/schemas/OpenAI.IncludeEnum' - nullable: true - parallel_tool_calls: - type: boolean - nullable: true - default: true - store: - type: boolean - nullable: true - default: true - instructions: - type: string - nullable: true - stream: - type: boolean - nullable: true - stream_options: - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamOptions' - nullable: true - conversation: - allOf: - - $ref: '#/components/schemas/OpenAI.ConversationParam' - nullable: true - context_management: - type: array - items: - $ref: '#/components/schemas/OpenAI.ContextManagementParam' - nullable: true - description: Context management configuration for this request. - agent_reference: - allOf: - - $ref: '#/components/schemas/AgentReference' - description: The agent to use for generating the response. - structured_inputs: - type: object - additionalProperties: {} - description: The structured inputs to the response that can participate in prompt template substitution or tool argument bindings. - - type: object - properties: - metadata: - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true - top_logprobs: - type: integer - allOf: - - $ref: '#/components/schemas/OpenAI.integer' - nullable: true - temperature: - type: number - allOf: - - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true - default: 1 - top_p: - type: number - allOf: - - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true - default: 1 - user: - type: string - description: |- - This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. - A stable identifier for your end-users. - Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). - deprecated: true - safety_identifier: - type: string - description: |- - A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. - The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). - prompt_cache_key: - type: string - description: Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching). - service_tier: - $ref: '#/components/schemas/OpenAI.ServiceTier' - prompt_cache_retention: - type: string + type: object + properties: + metadata: + anyOf: + - $ref: '#/components/schemas/OpenAI.Metadata' + - type: 'null' + top_logprobs: + anyOf: + - $ref: '#/components/schemas/OpenAI.integer' + - type: 'null' + temperature: + anyOf: + - $ref: '#/components/schemas/OpenAI.numeric' + - type: 'null' + default: 1 + top_p: + anyOf: + - $ref: '#/components/schemas/OpenAI.numeric' + - type: 'null' + default: 1 + user: + type: string + description: |- + This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. + A stable identifier for your end-users. + Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). + deprecated: true + safety_identifier: + type: string + maxLength: 64 + description: |- + A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. + The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). + prompt_cache_key: + type: string + description: Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching). + service_tier: + $ref: '#/components/schemas/OpenAI.ServiceTier' + prompt_cache_retention: + anyOf: + - type: string enum: - - in-memory + - in_memory - 24h - nullable: true - previous_response_id: - type: string - nullable: true - model: - type: string - description: The model deployment to use for the creation of this response. - reasoning: - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.Reasoning' - nullable: true - background: - type: boolean - nullable: true - max_output_tokens: - type: integer - allOf: - - $ref: '#/components/schemas/OpenAI.integer' - nullable: true - max_tool_calls: - type: integer - allOf: - - $ref: '#/components/schemas/OpenAI.integer' - nullable: true - text: - $ref: '#/components/schemas/OpenAI.ResponseTextParam' - tools: - $ref: '#/components/schemas/OpenAI.ToolsArray' - tool_choice: - oneOf: - - $ref: '#/components/schemas/OpenAI.ToolChoiceOptions' - - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' - prompt: - $ref: '#/components/schemas/OpenAI.Prompt' - truncation: - type: string + - type: 'null' + previous_response_id: + anyOf: + - type: string + - type: 'null' + model: + type: string + description: The model deployment to use for the creation of this response. + reasoning: + anyOf: + - $ref: '#/components/schemas/OpenAI.Reasoning' + - type: 'null' + background: + anyOf: + - type: boolean + - type: 'null' + max_tool_calls: + anyOf: + - $ref: '#/components/schemas/OpenAI.integer' + - type: 'null' + text: + $ref: '#/components/schemas/OpenAI.ResponseTextParam' + tools: + $ref: '#/components/schemas/OpenAI.ToolsArray' + tool_choice: + oneOf: + - $ref: '#/components/schemas/OpenAI.ToolChoiceOptions' + - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' + prompt: + $ref: '#/components/schemas/OpenAI.Prompt' + truncation: + anyOf: + - type: string enum: - auto - disabled - nullable: true - default: disabled - input: - $ref: '#/components/schemas/OpenAI.InputParam' - include: - type: array + - type: 'null' + default: disabled + input: + $ref: '#/components/schemas/OpenAI.InputParam' + include: + anyOf: + - type: array items: $ref: '#/components/schemas/OpenAI.IncludeEnum' - nullable: true - parallel_tool_calls: - type: boolean - nullable: true - default: true - store: - type: boolean - nullable: true - default: true - instructions: - type: string - nullable: true - stream: - type: boolean - nullable: true - stream_options: - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamOptions' - nullable: true - conversation: - allOf: - - $ref: '#/components/schemas/OpenAI.ConversationParam' - nullable: true - context_management: - type: array + - type: 'null' + parallel_tool_calls: + anyOf: + - type: boolean + - type: 'null' + default: true + store: + anyOf: + - type: boolean + - type: 'null' + default: true + instructions: + anyOf: + - type: string + - type: 'null' + moderation: + anyOf: + - $ref: '#/components/schemas/OpenAI.ModerationParam' + - type: 'null' + stream: + anyOf: + - type: boolean + - type: 'null' + stream_options: + anyOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamOptions' + - type: 'null' + conversation: + anyOf: + - $ref: '#/components/schemas/OpenAI.ConversationParam' + - type: 'null' + context_management: + anyOf: + - type: array items: $ref: '#/components/schemas/OpenAI.ContextManagementParam' - nullable: true - description: Context management configuration for this request. - agent_reference: - allOf: - - $ref: '#/components/schemas/AgentReference' - description: The agent to use for generating the response. - structured_inputs: - type: object - additionalProperties: {} - description: The structured inputs to the response that can participate in prompt template substitution or tool argument bindings. + - type: 'null' + description: Context management configuration for this request. + max_output_tokens: + anyOf: + - $ref: '#/components/schemas/OpenAI.integer' + - type: 'null' + agent_reference: + allOf: + - $ref: '#/components/schemas/AgentReference' + description: The agent to use for generating the response. + structured_inputs: + type: object + unevaluatedProperties: {} + description: The structured inputs to the response that can participate in prompt template substitution or tool argument bindings. get: operationId: listResponses - description: Returns the list of all responses. + summary: List responses + description: Returns a collection of all stored responses matching specified filter criteria. parameters: - name: limit in: query @@ -7725,8 +8666,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -7736,7 +8683,8 @@ paths: /openai/v1/responses/compact: post: operationId: compactResponseConversation - description: Produces a compaction of a responses conversation. + summary: Compact a conversation + description: Compacts a conversation into a response object suitable for long-running and zero-data-retention scenarios. parameters: [] responses: '200': @@ -7745,8 +8693,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.CompactResource' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -7761,7 +8715,9 @@ paths: $ref: '#/components/schemas/OpenAI.CompactResponseMethodPublicBody' /openai/v1/responses/{response_id}: get: - operationId: getResponse_getResponseStream + operationId: getResponse + summary: Retrieve a model response + description: Retrieves a model response with the given ID. parameters: - name: response_id in: path @@ -7796,14 +8752,6 @@ paths: description: Opaque per-user isolation key used to scope endpoint-scoped data (responses, conversations, sessions) to a specific end user. schema: type: string - - name: accept - in: header - required: false - schema: - type: string - enum: - - text/event-stream - description: Retrieves a model response with the given ID. Retrieves a model response with the given ID (streaming response). responses: '200': description: The request has succeeded. @@ -7820,8 +8768,14 @@ paths: text/event-stream: schema: $ref: '#/components/schemas/OpenAI.CreateResponseStreamingResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -7830,6 +8784,7 @@ paths: - Responses delete: operationId: deleteResponse + summary: Delete a model response description: Deletes a model response. parameters: - name: response_id @@ -7857,8 +8812,14 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteResponseResult' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -7868,7 +8829,8 @@ paths: /openai/v1/responses/{response_id}/cancel: post: operationId: cancelResponse - description: Cancels a model response. + summary: Cancel a model response + description: Cancels a model response with the given ID. Only responses created with the background parameter set to true can be cancelled. parameters: - name: response_id in: path @@ -7895,8 +8857,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.Response' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -7906,7 +8874,8 @@ paths: /openai/v1/responses/{response_id}/input_items: get: operationId: listInputItems - description: Returns a list of input items for a given response. + summary: List input items for a response + description: Retrieves the input items associated with the specified response. parameters: - name: response_id in: path @@ -7991,8 +8960,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8002,7 +8977,8 @@ paths: /redTeams/runs: get: operationId: RedTeams_list - description: List a redteam by name. + summary: List redteams + description: Returns the redteams available in the current project. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: Foundry-Features @@ -8020,8 +8996,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedRedTeam' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -8037,7 +9025,8 @@ paths: /redTeams/runs/{name}: get: operationId: RedTeams_get - description: Get a redteam by name. + summary: Get a redteam + description: Retrieves the specified redteam and its configuration. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -8061,8 +9050,20 @@ paths: application/json: schema: $ref: '#/components/schemas/RedTeam' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -8078,7 +9079,8 @@ paths: /redTeams/runs:run: post: operationId: RedTeams_create - description: Creates a redteam run. + summary: Create a redteam run + description: Submits a new redteam run for execution with the provided configuration. parameters: - name: Foundry-Features in: header @@ -8102,8 +9104,14 @@ paths: application/json: schema: $ref: '#/components/schemas/RedTeam' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8120,7 +9128,8 @@ paths: /routines: get: operationId: listRoutines - description: List routines. + summary: List routines + description: Returns the routines available in the current project. parameters: - name: Foundry-Features in: header @@ -8130,46 +9139,10 @@ paths: type: string enum: - Routines=V1Preview - - name: limit - in: query - required: false - description: |- - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the - default is 20. - schema: - type: integer - format: int32 - default: 20 - explode: false - - name: order - in: query - required: false - description: |- - Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc` - for descending order. - schema: - $ref: '#/components/schemas/PageOrder' - explode: false - - name: after - in: query - required: false - description: |- - A cursor for use in pagination. `after` is an object ID that defines your place in the list. - For instance, if you make a list request and receive 100 objects, ending with obj_foo, your - subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - explode: false - - name: before - in: query - required: false - description: |- - A cursor for use in pagination. `before` is an object ID that defines your place in the list. - For instance, if you make a list request and receive 100 objects, ending with obj_foo, your - subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - explode: false + - $ref: '#/components/parameters/ListRoutinesParameters.limit' + - $ref: '#/components/parameters/ListRoutinesParameters.after' + - $ref: '#/components/parameters/ListRoutinesParameters.before' + - $ref: '#/components/parameters/ListRoutinesParameters.order' - name: api-version in: query required: true @@ -8203,8 +9176,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8217,7 +9196,8 @@ paths: /routines/{routine_name}: put: operationId: createOrUpdateRoutine - description: Create or update a routine. + summary: Create or update a routine + description: Creates a new routine or replaces an existing routine with the supplied definition. parameters: - name: Foundry-Features in: header @@ -8242,8 +9222,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Routine' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8261,7 +9247,8 @@ paths: - Routines=V1Preview get: operationId: getRoutine - description: Retrieve a routine. + summary: Get a routine + description: Retrieves the specified routine and its current configuration. parameters: - name: Foundry-Features in: header @@ -8286,8 +9273,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Routine' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8299,7 +9292,8 @@ paths: - Routines=V1Preview delete: operationId: deleteRoutine - description: Delete a routine. + summary: Delete a routine + description: Deletes the specified routine. parameters: - name: Foundry-Features in: header @@ -8320,8 +9314,14 @@ paths: responses: '204': description: There is no content to send for this request, but the headers may be useful. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8334,7 +9334,8 @@ paths: /routines/{routine_name}/runs: get: operationId: listRoutineRuns - description: List prior runs for a routine. + summary: List prior runs for a routine + description: Returns prior runs recorded for the specified routine. parameters: - name: Foundry-Features in: header @@ -8346,46 +9347,10 @@ paths: - Routines=V1Preview - $ref: '#/components/parameters/ListRoutineRunsParameters.routine_name' - $ref: '#/components/parameters/ListRoutineRunsParameters.filter' - - name: limit - in: query - required: false - description: |- - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the - default is 20. - schema: - type: integer - format: int32 - default: 20 - explode: false - - name: order - in: query - required: false - description: |- - Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc` - for descending order. - schema: - $ref: '#/components/schemas/PageOrder' - explode: false - - name: after - in: query - required: false - description: |- - A cursor for use in pagination. `after` is an object ID that defines your place in the list. - For instance, if you make a list request and receive 100 objects, ending with obj_foo, your - subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - explode: false - - name: before - in: query - required: false - description: |- - A cursor for use in pagination. `before` is an object ID that defines your place in the list. - For instance, if you make a list request and receive 100 objects, ending with obj_foo, your - subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - explode: false + - $ref: '#/components/parameters/ListRoutineRunsParameters.limit' + - $ref: '#/components/parameters/ListRoutineRunsParameters.after' + - $ref: '#/components/parameters/ListRoutineRunsParameters.before' + - $ref: '#/components/parameters/ListRoutineRunsParameters.order' - name: api-version in: query required: true @@ -8419,8 +9384,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8433,7 +9404,8 @@ paths: /routines/{routine_name}:disable: post: operationId: disableRoutine - description: Disable a routine. + summary: Disable a routine + description: Disables the specified routine so it no longer runs. parameters: - name: Foundry-Features in: header @@ -8458,8 +9430,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Routine' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8472,7 +9450,8 @@ paths: /routines/{routine_name}:dispatch_async: post: operationId: dispatchRoutineAsync - description: Queue an asynchronous routine dispatch. + summary: Queue an asynchronous routine dispatch + description: Queues an asynchronous dispatch for the specified routine. parameters: - name: Foundry-Features in: header @@ -8497,8 +9476,14 @@ paths: application/json: schema: $ref: '#/components/schemas/DispatchRoutineResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8517,7 +9502,8 @@ paths: /routines/{routine_name}:enable: post: operationId: enableRoutine - description: Enable a routine. + summary: Enable a routine + description: Enables the specified routine so it can be dispatched. parameters: - name: Foundry-Features in: header @@ -8542,8 +9528,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Routine' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8556,7 +9548,8 @@ paths: /schedules: get: operationId: Schedules_list - description: List all schedules. + summary: List schedules + description: Returns schedules that match the supplied type and enabled filters. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: type @@ -8588,8 +9581,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedSchedule' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -8605,7 +9610,8 @@ paths: /schedules/{id}: delete: operationId: Schedules_delete - description: Delete a schedule. + summary: Delete a schedule + description: Deletes the specified schedule resource. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: id @@ -8625,8 +9631,20 @@ paths: responses: '204': description: There is no content to send for this request, but the headers may be useful. - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -8641,7 +9659,8 @@ paths: - Schedules get: operationId: Schedules_get - description: Get a schedule by id. + summary: Get a schedule + description: Retrieves the specified schedule resource. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: id @@ -8665,8 +9684,20 @@ paths: application/json: schema: $ref: '#/components/schemas/Schedule' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -8681,7 +9712,8 @@ paths: - Schedules put: operationId: Schedules_createOrUpdate - description: Create or update operation template. + summary: Create or update a schedule + description: Creates a new schedule or updates an existing schedule with the supplied definition. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: id @@ -8711,8 +9743,20 @@ paths: application/json: schema: $ref: '#/components/schemas/Schedule' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -8735,7 +9779,8 @@ paths: /schedules/{id}/runs: get: operationId: Schedules_listRuns - description: List all schedule runs. + summary: List schedule runs + description: Returns schedule runs that match the supplied filters. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: id @@ -8773,8 +9818,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedScheduleRun' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -8790,7 +9847,8 @@ paths: /schedules/{schedule_id}/runs/{run_id}: get: operationId: Schedules_getRun - description: Get a schedule run by id. + summary: Get a schedule run + description: Retrieves the specified run for a schedule. parameters: - name: schedule_id in: path @@ -8826,8 +9884,14 @@ paths: application/json: schema: $ref: '#/components/schemas/ScheduleRun' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8837,7 +9901,8 @@ paths: /skills: get: operationId: Skills_listSkills - description: Returns the list of all skills. + summary: List skills + description: Returns the skills available in the current project. parameters: - name: limit in: query @@ -8920,8 +9985,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8934,7 +10005,8 @@ paths: /skills/{name}: get: operationId: Skills_getSkill - description: Retrieves a skill. + summary: Retrieve a skill + description: Retrieves the specified skill and its current configuration. parameters: - name: name in: path @@ -8964,8 +10036,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Skill' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8977,7 +10055,8 @@ paths: - Skills=V1Preview post: operationId: updateSkill - description: Update a skill. + summary: Update a skill + description: Modifies the specified skill's configuration. parameters: - name: name in: path @@ -9007,8 +10086,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Skill' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -9032,7 +10117,8 @@ paths: - Skills=V1Preview delete: operationId: Skills_deleteSkill - description: Deletes a skill. + summary: Delete a skill + description: Removes the specified skill and its associated versions. parameters: - name: name in: path @@ -9062,8 +10148,14 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteSkillResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -9076,7 +10168,8 @@ paths: /skills/{name}/content: get: operationId: getSkillContent - description: Download the zip content for the default version of a skill. + summary: Download the zip content for the default version of a skill + description: Downloads the zip content for the default version of a skill. parameters: - name: name in: path @@ -9105,10 +10198,15 @@ paths: content: application/zip: schema: - type: string - format: binary - default: - description: An unexpected error response. + contentMediaType: application/zip + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -9144,6 +10242,7 @@ paths: type: string explode: false description: Creates a new version of a skill. If the skill does not exist, it will be created. Creates a new version of a skill from uploaded files via multipart form data. + summary: Create a new version of a skill Create a skill version from uploaded files responses: '200': description: The request has succeeded. @@ -9151,12 +10250,20 @@ paths: application/json: schema: $ref: '#/components/schemas/SkillVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' + x-ms-description-override: Creates a new version of a skill. If the skill does not exist, it will be created. + x-ms-summary-override: Create a new version of a skill x-ms-foundry-meta: required_previews: - Skills=V1Preview @@ -9186,7 +10293,8 @@ paths: contentType: text/plain get: operationId: listSkillVersions - description: List all versions of a skill. + summary: List skill versions + description: Returns the available versions for the specified skill. parameters: - name: name in: path @@ -9275,8 +10383,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -9289,7 +10403,8 @@ paths: /skills/{name}/versions/{version}: get: operationId: getSkillVersion - description: Retrieve a specific version of a skill. + summary: Retrieve a specific version of a skill + description: Retrieves the specified version of a skill by name and version identifier. parameters: - name: name in: path @@ -9325,8 +10440,14 @@ paths: application/json: schema: $ref: '#/components/schemas/SkillVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -9338,7 +10459,8 @@ paths: - Skills=V1Preview delete: operationId: deleteSkillVersion - description: Delete a specific version of a skill. + summary: Delete a specific version of a skill + description: Removes the specified version of a skill. parameters: - name: name in: path @@ -9374,8 +10496,14 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteSkillVersionResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -9388,7 +10516,8 @@ paths: /skills/{name}/versions/{version}/content: get: operationId: getSkillVersionContent - description: Download the zip content for a specific version of a skill. + summary: Download the zip content for a specific version of a skill + description: Downloads the zip content for a specific version of a skill. parameters: - name: name in: path @@ -9423,10 +10552,15 @@ paths: content: application/zip: schema: - type: string - format: binary - default: - description: An unexpected error response. + contentMediaType: application/zip + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -9439,7 +10573,8 @@ paths: /toolboxes: get: operationId: listToolboxes - description: List all toolboxes. + summary: List toolboxes + description: Returns the toolboxes available in the current project. parameters: - name: limit in: query @@ -9481,6 +10616,14 @@ paths: schema: type: string explode: false + - name: Foundry-Features + in: header + required: true + description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. + schema: + type: string + enum: + - Toolboxes=V1Preview - name: api-version in: query required: true @@ -9514,18 +10657,28 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - Toolboxes + x-ms-foundry-meta: + conditional_previews: + - Toolboxes=V1Preview /toolboxes/{name}: get: operationId: getToolbox - description: Retrieve a toolbox. + summary: Retrieve a toolbox + description: Retrieves the specified toolbox and its current configuration. parameters: - name: name in: path @@ -9533,6 +10686,14 @@ paths: description: The name of the toolbox to retrieve. schema: type: string + - name: Foundry-Features + in: header + required: true + description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. + schema: + type: string + enum: + - Toolboxes=V1Preview - name: api-version in: query required: true @@ -9547,19 +10708,37 @@ paths: application/json: schema: $ref: '#/components/schemas/ToolboxObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - Toolboxes + x-ms-foundry-meta: + conditional_previews: + - Toolboxes=V1Preview patch: operationId: updateToolbox - description: Update a toolbox to point to a specific version. + summary: Update a toolbox to point to a specific version + description: Updates the toolbox's default version pointer to the specified version. parameters: - $ref: '#/components/parameters/UpdateToolboxRequest.name' + - name: Foundry-Features + in: header + required: true + description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. + schema: + type: string + enum: + - Toolboxes=V1Preview - name: api-version in: query required: true @@ -9574,8 +10753,14 @@ paths: application/json: schema: $ref: '#/components/schemas/ToolboxObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -9588,9 +10773,13 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateToolboxRequest' + x-ms-foundry-meta: + conditional_previews: + - Toolboxes=V1Preview delete: operationId: deleteToolbox - description: Delete a toolbox and all its versions. + summary: Delete a toolbox + description: Removes the specified toolbox along with all of its versions. parameters: - name: name in: path @@ -9598,6 +10787,14 @@ paths: description: The name of the toolbox to delete. schema: type: string + - name: Foundry-Features + in: header + required: true + description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. + schema: + type: string + enum: + - Toolboxes=V1Preview - name: api-version in: query required: true @@ -9608,18 +10805,28 @@ paths: responses: '204': description: 'There is no content to send for this request, but the headers may be useful. ' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - Toolboxes + x-ms-foundry-meta: + conditional_previews: + - Toolboxes=V1Preview /toolboxes/{name}/versions: post: operationId: createToolboxVersion - description: Create a new version of a toolbox. If the toolbox does not exist, it will be created. + summary: Create a new version of a toolbox + description: Creates a new toolbox version, provisioning the toolbox itself if it does not already exist. parameters: - name: name in: path @@ -9628,6 +10835,14 @@ paths: schema: type: string maxLength: 256 + - name: Foundry-Features + in: header + required: true + description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. + schema: + type: string + enum: + - Toolboxes=V1Preview - name: api-version in: query required: true @@ -9642,8 +10857,14 @@ paths: application/json: schema: $ref: '#/components/schemas/ToolboxVersionObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -9663,7 +10884,7 @@ paths: description: A human-readable description of the toolbox. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Arbitrary key-value metadata to associate with the toolbox. tools: @@ -9682,9 +10903,13 @@ paths: description: Policy configuration for this toolbox version. required: - tools + x-ms-foundry-meta: + conditional_previews: + - Toolboxes=V1Preview get: operationId: listToolboxVersions - description: List all versions of a toolbox. + summary: List toolbox versions + description: Returns the available versions for the specified toolbox. parameters: - name: name in: path @@ -9732,6 +10957,14 @@ paths: schema: type: string explode: false + - name: Foundry-Features + in: header + required: true + description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. + schema: + type: string + enum: + - Toolboxes=V1Preview - name: api-version in: query required: true @@ -9765,18 +10998,28 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - Toolboxes + x-ms-foundry-meta: + conditional_previews: + - Toolboxes=V1Preview /toolboxes/{name}/versions/{version}: get: operationId: getToolboxVersion - description: Retrieve a specific version of a toolbox. + summary: Retrieve a specific version of a toolbox + description: Retrieves the specified version of a toolbox by name and version identifier. parameters: - name: name in: path @@ -9790,6 +11033,14 @@ paths: description: The version identifier to retrieve. schema: type: string + - name: Foundry-Features + in: header + required: true + description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. + schema: + type: string + enum: + - Toolboxes=V1Preview - name: api-version in: query required: true @@ -9804,17 +11055,27 @@ paths: application/json: schema: $ref: '#/components/schemas/ToolboxVersionObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - Toolboxes + x-ms-foundry-meta: + conditional_previews: + - Toolboxes=V1Preview delete: operationId: deleteToolboxVersion - description: Delete a specific version of a toolbox. + summary: Delete a specific version of a toolbox + description: Removes the specified version of a toolbox. parameters: - name: name in: path @@ -9828,6 +11089,14 @@ paths: description: The version identifier to delete. schema: type: string + - name: Foundry-Features + in: header + required: true + description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. + schema: + type: string + enum: + - Toolboxes=V1Preview - name: api-version in: query required: true @@ -9838,14 +11107,23 @@ paths: responses: '204': description: 'There is no content to send for this request, but the headers may be useful. ' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - Toolboxes + x-ms-foundry-meta: + conditional_previews: + - Toolboxes=V1Preview security: - OAuth2Auth: - https://ai.azure.com/.default @@ -9915,6 +11193,22 @@ components: schema: type: string maxLength: 128 + ListRoutineRunsParameters.after: + name: after + in: query + required: false + description: An opaque cursor returned as last_id by the previous list-runs response. + schema: + type: string + explode: false + ListRoutineRunsParameters.before: + name: before + in: query + required: false + description: Unsupported. Reserved for future backward pagination support. + schema: + type: string + explode: false ListRoutineRunsParameters.filter: name: filter in: query @@ -9923,6 +11217,23 @@ components: schema: type: string explode: false + ListRoutineRunsParameters.limit: + name: limit + in: query + required: false + description: The maximum number of runs to return. + schema: + type: integer + format: int32 + explode: false + ListRoutineRunsParameters.order: + name: order + in: query + required: false + description: The ordering direction. Supported values are asc and desc. + schema: + type: string + explode: false ListRoutineRunsParameters.routine_name: name: routine_name in: path @@ -9931,6 +11242,39 @@ components: schema: type: string maxLength: 128 + ListRoutinesParameters.after: + name: after + in: query + required: false + description: An opaque cursor returned as last_id by the previous list response. + schema: + type: string + explode: false + ListRoutinesParameters.before: + name: before + in: query + required: false + description: Unsupported. Reserved for future backward pagination support. + schema: + type: string + explode: false + ListRoutinesParameters.limit: + name: limit + in: query + required: false + description: The maximum number of routines to return. + schema: + type: integer + format: int32 + explode: false + ListRoutinesParameters.order: + name: order + in: query + required: false + description: The ordering direction. Supported values are asc and desc. + schema: + type: string + explode: false UpdateToolboxRequest.name: name: name in: path @@ -9981,7 +11325,6 @@ components: type: string enum: - a2a_preview - description: The type of the tool. Always `"a2a_preview`. base_url: type: string format: uri @@ -10431,18 +11774,6 @@ components: allOf: - $ref: '#/components/schemas/TraceSource' description: A trace source that selects traces by agent reference with time-based filtering. - AgentIdentifier: - type: object - required: - - agentName - properties: - agentName: - type: string - description: Registered Foundry agent name (required). - agentVersion: - type: string - description: Pinned agent version. Defaults to latest if omitted. - description: Identifies the registered Foundry agent to optimize (request-only). Skills, tools, and systemPrompt are specified in options.optimizationConfig. AgentIdentity: type: object required: @@ -10539,6 +11870,7 @@ components: enum: - activity_protocol - responses + - a2a - mcp - invocations - invocations_ws @@ -10609,7 +11941,6 @@ components: - idle - updating - failed - - stopping - deleting - deleted - expired @@ -10673,10 +12004,11 @@ components: - definition properties: metadata: - type: object - additionalProperties: - type: string - nullable: true + anyOf: + - type: object + unevaluatedProperties: + type: string + - type: 'null' description: |- Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured @@ -11248,7 +12580,6 @@ components: type: string enum: - azure_ai_search - description: The object type, which is always 'azure_ai_search'. azure_ai_search: allOf: - $ref: '#/components/schemas/AzureAISearchToolResource' @@ -11558,7 +12889,7 @@ components: description: A description of what the function does, used by the model to choose when and how to call the function. parameters: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The parameters the functions accepts, described as a JSON Schema object. required: - name @@ -12062,116 +13393,6 @@ components: - $ref: '#/components/schemas/BrowserAutomationToolConnectionParameters' description: The project connection parameters associated with the Browser Automation Tool. description: Definition of input parameters for the Browser Automation Tool. - CandidateDeployConfig: - type: object - properties: - instructions: - type: string - description: System prompt / instructions. - model: - type: string - description: Foundry deployment name. - temperature: - type: number - format: float - minimum: 0 - maximum: 2 - description: Optional sampling temperature. - skills: - type: array - items: - type: object - additionalProperties: {} - description: Optional skill overrides. - tools: - type: array - items: - type: object - additionalProperties: {} - description: Optional tool overrides. - description: Deploy-config blob for a candidate. Suitable for setting OPTIMIZATION_CONFIG on a hosted-agent version. - CandidateFileInfo: - type: object - required: - - path - - type - - sizeBytes - properties: - path: - type: string - description: Relative path of the file. - type: - type: string - description: File type category (e.g. 'config', 'results'). - sizeBytes: - type: integer - format: int64 - description: File size in bytes. - description: File entry in a candidate's blob directory. - CandidateMetadata: - type: object - required: - - candidateId - - jobId - - candidateName - - status - - hasResults - - createdAt - - updatedAt - - files - properties: - candidateId: - type: string - description: Server-assigned candidate identifier. - jobId: - type: string - description: Owning optimization job id. - candidateName: - type: string - description: Display name of the candidate. - status: - type: string - description: Candidate lifecycle status. - score: - type: number - format: double - description: Candidate's aggregate score. - hasResults: - type: boolean - description: Whether detailed results are available for this candidate. - createdAt: - allOf: - - $ref: '#/components/schemas/FoundryTimestamp' - description: Timestamp when the candidate was created, represented in Unix time. - updatedAt: - allOf: - - $ref: '#/components/schemas/FoundryTimestamp' - description: Timestamp when the candidate was last updated, represented in Unix time. - promotion: - allOf: - - $ref: '#/components/schemas/PromotionInfo' - description: Promotion metadata. Null if not promoted. - files: - type: array - items: - $ref: '#/components/schemas/CandidateFileInfo' - description: Files in the candidate's blob directory. - description: Candidate metadata returned by GET /candidates/{id}. - CandidateResults: - type: object - required: - - candidateId - - results - properties: - candidateId: - type: string - description: Owning candidate id. - results: - type: array - items: - $ref: '#/components/schemas/OptimizationTaskResult' - description: Per-task evaluation rows. - description: Full per-task evaluation results for a candidate, returned by GET /candidates/{id}/results. CaptureStructuredOutputsTool: type: object required: @@ -12249,7 +13470,7 @@ components: description: List of clusters identified in the insights. coordinates: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ChartCoordinate' description: |2- Optional mapping of IDs to 2D coordinates used by the UX for visualization. @@ -12374,8 +13595,6 @@ components: type: string enum: - code_interpreter - description: The type of the code interpreter tool. Always `code_interpreter`. - x-stainless-const: true container: anyOf: - type: string @@ -12446,7 +13665,7 @@ components: readOnly: true metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Metadata of the connection readOnly: true @@ -12475,7 +13694,8 @@ components: image: type: string description: The container image for the hosted agent. - example: my-registry.azurecr.io/my-hosted-agent:latest + examples: + - my-registry.azurecr.io/my-hosted-agent:latest description: Container-based deployment configuration for a hosted agent. x-ms-foundry-meta: required_previews: @@ -12518,6 +13738,13 @@ components: type: integer format: int32 description: Maximum number of evaluation runs allowed per hour. + samplingRate: + type: number + format: double + maximum: 100 + description: Percentage (0-100] chance that a matching event triggers an evaluation. When omitted, the service-default is to evaluate every event, which is equivalent to setting a sampling rate of 100. + exclusiveMinimum: 0 + default: 100 allOf: - $ref: '#/components/schemas/EvaluationRuleAction' description: Evaluation rule action for continuous evaluation. @@ -12547,7 +13774,7 @@ components: default: 5 data_mapping: type: object - additionalProperties: + unevaluatedProperties: type: string description: Mapping from source fields to response_id field, which is required for retrieving chat history. sampling_params: @@ -12610,8 +13837,6 @@ components: - $ref: '#/components/schemas/CreateAgentVersionFromCodeMetadata' description: JSON metadata including description and hosted definition. code: - type: string - format: binary description: The code zip file (max 250 MB). required: - metadata @@ -12633,7 +13858,7 @@ components: - Must not exceed 63 characters. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -12652,7 +13877,7 @@ components: description: The manifest ID to import the agent version from. parameter_values: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The inputs to the manifest that will result in a fully materialized Agent. CreateAgentRequest: type: object @@ -12670,7 +13895,7 @@ components: - Must not exceed 63 characters. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -12745,8 +13970,6 @@ components: - $ref: '#/components/schemas/CreateAgentVersionFromCodeMetadata' description: JSON metadata including description and hosted definition. code: - type: string - format: binary description: The code zip file (max 250 MB). required: - metadata @@ -12762,7 +13985,7 @@ components: description: A human-readable description of the agent. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -12792,7 +14015,7 @@ components: properties: metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -12811,7 +14034,7 @@ components: description: The manifest ID to import the agent version from. parameter_values: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The inputs to the manifest that will result in a fully materialized Agent. CreateAgentVersionRequest: type: object @@ -12820,7 +14043,7 @@ components: properties: metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -12867,10 +14090,9 @@ components: type: string description: The name of the evaluation. metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' data_source_config: oneOf: - $ref: '#/components/schemas/OpenAI.CreateEvalCustomDataSourceConfig' @@ -12892,7 +14114,7 @@ components: description: A list of graders for all eval runs in this group. Graders can reference variables in the data source using double curly braces notation, like `{{item.variable_name}}`. To reference the model's output, use the `sample` namespace (ie, `{{sample.output_text}}`). properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -12907,10 +14129,9 @@ components: type: string description: The name of the run. metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' data_source: oneOf: - $ref: '#/components/schemas/OpenAI.CreateEvalJsonlRunDataSource' @@ -12920,7 +14141,7 @@ components: description: Details about the run's data source. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -12936,9 +14157,7 @@ components: properties: files: type: array - items: - type: string - format: binary + items: {} description: Skill files to upload. Upload a single zip file or multiple individual files with relative paths. default: type: boolean @@ -12994,11 +14213,41 @@ components: - CustomKeys description: The credential type readOnly: true - additionalProperties: + unevaluatedProperties: type: string allOf: - $ref: '#/components/schemas/BaseCredentials' description: Custom credential definition + CustomRoutineTrigger: + type: object + required: + - type + - provider + - parameters + properties: + type: + type: string + enum: + - custom + description: The trigger type. + provider: + type: string + maxLength: 128 + description: The external provider that emits the custom event. + event_name: + type: string + maxLength: 256 + description: The provider-specific event name that fires the routine. + parameters: + type: object + unevaluatedProperties: {} + description: Provider-specific trigger parameters. + allOf: + - $ref: '#/components/schemas/RoutineTrigger' + description: A custom event routine trigger. + x-ms-foundry-meta: + conditional_previews: + - Routines=V1Preview DailyRecurrenceSchedule: type: object required: @@ -13146,7 +14395,7 @@ components: description: Description to assign to the output. Applies only to dataset outputs (evaluation scenario); ignored for Azure OpenAI file outputs. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tags to assign to the output. Applies only to dataset outputs (evaluation scenario); ignored for Azure OpenAI file outputs. description: Output options for data generation job. @@ -13268,11 +14517,12 @@ components: description: The data source type discriminator. schema: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The overall object JSON schema for the run data source items. discriminator: propertyName: type - mapping: {} + mapping: + azure_ai_source: '#/components/schemas/AzureAIDataSourceConfig' description: Base class for run data sources with discriminator support. DatasetDataGenerationJobOutput: type: object @@ -13302,7 +14552,7 @@ components: readOnly: true tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary of the output dataset. readOnly: true @@ -13332,38 +14582,6 @@ components: allOf: - $ref: '#/components/schemas/EvaluatorGenerationJobSource' description: Dataset source for evaluator generation jobs — reference to a dataset. - DatasetInfo: - type: object - required: - - taskCount - - isInline - properties: - name: - type: string - description: Dataset name when using a registered dataset reference. Null for inline datasets. - version: - type: string - description: Dataset version when using a registered dataset reference. Null for inline datasets. - taskCount: - type: integer - format: int32 - description: Number of tasks/rows in the dataset. - isInline: - type: boolean - description: True when the dataset was provided inline in the request body. - description: Metadata about the dataset used for optimization, surfaced in the response. - DatasetRef: - type: object - required: - - name - properties: - name: - type: string - description: Dataset name. - version: - type: string - description: Dataset version. If not specified, the latest version is used. - description: Reference to a registered dataset in the Foundry Dataset Service. DatasetReference: type: object required: @@ -13441,7 +14659,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. discriminator: @@ -13689,7 +14907,7 @@ components: description: Relative weight of this dimension (1-10). The generation pipeline assigns exactly one dimension weight 8-10; all others use 1-6. User edits are not constrained by this heuristic. always_applicable: type: boolean - description: When true, the LLM judge always scores this dimension regardless of relevance (skips applicability assessment). The service-generated general quality/policy dimension has this set to true and is non-editable. Users may set this on their own custom dimensions. Defaults to `false`. + description: When true, the LLM judge always scores this dimension regardless of relevance (skips applicability assessment). The service-generated general quality/policy dimension has this set to true and is non-editable. Users may set this on their own custom dimensions. The service defaults to `false` if a value is not specified by the caller. default: false description: A single dimension — one independent, measurable quality dimension within a rubric evaluator's scoring blueprint. DispatchRoutineRequest: @@ -13813,10 +15031,9 @@ components: format: unixtime description: The Unix timestamp (in seconds) for when the eval was created. metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' modified_at: allOf: - $ref: '#/components/schemas/integer' @@ -13826,7 +15043,7 @@ components: description: the name of the person who created the run. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -13997,10 +15214,9 @@ components: - $ref: '#/components/schemas/EvalRunDataSource' description: Information about the run's data source. metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' error: $ref: '#/components/schemas/OpenAI.EvalApiError' modified_at: @@ -14012,7 +15228,7 @@ components: description: the name of the person who created the run. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -14271,7 +15487,7 @@ components: description: The identifier for the data source item. datasource_item: type: object - additionalProperties: {} + unevaluatedProperties: {} description: Details of the input data source item. results: type: array @@ -14361,9 +15577,10 @@ components: type: boolean description: Whether the grader considered the output a pass. sample: - type: object - additionalProperties: {} - nullable: true + anyOf: + - type: object + unevaluatedProperties: {} + - type: 'null' description: Optional sample or intermediate data produced by the grader. status: allOf: @@ -14384,10 +15601,10 @@ components: description: The reason for the test criteria metric. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Additional details about the test criteria metric. - additionalProperties: {} + unevaluatedProperties: {} description: A single grader result for an evaluation run output item. title: EvalRunOutputItemResult EvalRunOutputItemResultStatus: @@ -14627,7 +15844,7 @@ components: description: Indicates whether the evaluation rule is enabled. Default is true. systemData: type: object - additionalProperties: + unevaluatedProperties: type: string description: System metadata for the evaluation rule. readOnly: true @@ -14731,6 +15948,7 @@ components: description: Identifier of the evaluation group. evalRun: type: object + unevaluatedProperties: {} description: The evaluation run payload. allOf: - $ref: '#/components/schemas/ScheduleTask' @@ -14765,7 +15983,7 @@ components: description: List of taxonomy categories. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Additional properties for the evaluation taxonomy. description: Evaluation Taxonomy Definition @@ -14779,7 +15997,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. taxonomyInput: @@ -14793,7 +16011,7 @@ components: description: List of taxonomy categories. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Additional properties for the evaluation taxonomy. description: Evaluation Taxonomy Definition @@ -14841,7 +16059,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. taxonomyInput: @@ -14855,7 +16073,7 @@ components: description: List of taxonomy categories. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Additional properties for the evaluation taxonomy. description: Evaluation Taxonomy Definition @@ -14892,15 +16110,15 @@ components: description: The type of evaluator definition init_parameters: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The JSON schema (Draft 2020-12) for the evaluator's input parameters. This includes parameters like type, properties, required. data_schema: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The JSON schema (Draft 2020-12) for the evaluator's input data. This includes parameters like type, properties, required. metrics: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/EvaluatorMetric' description: List of output metrics produced by this evaluator discriminator: @@ -15137,7 +16355,7 @@ components: description: Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Metadata about the evaluator evaluator_type: @@ -15149,6 +16367,13 @@ components: items: $ref: '#/components/schemas/EvaluatorCategory' description: The categories of the evaluator + supported_evaluation_levels: + type: array + items: + $ref: '#/components/schemas/EvaluationLevel' + description: Evaluation levels this evaluator supports (e.g., `turn`, `conversation`). When omitted on create, the service defaults to `["turn"]`. On update, omitting this field leaves it unchanged; an empty list is rejected. Custom code-based evaluators support only `turn`; custom prompt-based evaluators support exactly one level (`turn` or `conversation`). + default: + - turn definition: allOf: - $ref: '#/components/schemas/EvaluatorDefinition' @@ -15195,7 +16420,7 @@ components: description: Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Metadata about the evaluator evaluator_type: @@ -15207,6 +16432,13 @@ components: items: $ref: '#/components/schemas/EvaluatorCategory' description: The categories of the evaluator + supported_evaluation_levels: + type: array + items: + $ref: '#/components/schemas/EvaluationLevel' + description: Evaluation levels this evaluator supports (e.g., `turn`, `conversation`). When omitted on create, the service defaults to `["turn"]`. On update, omitting this field leaves it unchanged; an empty list is rejected. Custom code-based evaluators support only `turn`; custom prompt-based evaluators support exactly one level (`turn` or `conversation`). + default: + - turn definition: allOf: - $ref: '#/components/schemas/EvaluatorDefinition' @@ -15216,7 +16448,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Evaluator Definition @@ -15228,7 +16460,7 @@ components: description: Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Metadata about the evaluator categories: @@ -15236,12 +16468,19 @@ components: items: $ref: '#/components/schemas/EvaluatorCategory' description: The categories of the evaluator + supported_evaluation_levels: + type: array + items: + $ref: '#/components/schemas/EvaluationLevel' + description: Evaluation levels this evaluator supports (e.g., `turn`, `conversation`). When omitted on create, the service defaults to `["turn"]`. On update, omitting this field leaves it unchanged; an empty list is rejected. Custom code-based evaluators support only `turn`; custom prompt-based evaluators support exactly one level (`turn` or `conversation`). + default: + - turn description: type: string description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Evaluator Definition @@ -15356,12 +16595,9 @@ components: description: (Optional) The URL of the FabricIQ MCP server. If not provided, the URL from the project connection will be used. require_approval: anyOf: - - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' - nullable: true + - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' - type: string - nullable: true + - type: 'null' description: (Optional) Whether the agent requires approval before executing actions. Default is always. default: always name: @@ -15383,7 +16619,6 @@ components: type: string enum: - fabric_iq_preview - description: The object type, which is always 'fabric_iq_preview'. project_connection_id: type: string description: The ID of the FabricIQ project connection. @@ -15396,12 +16631,9 @@ components: description: (Optional) The URL of the FabricIQ MCP server. If not provided, the URL from the project connection will be used. require_approval: anyOf: - - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' - nullable: true + - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' - type: string - nullable: true + - type: 'null' description: (Optional) Whether the agent requires approval before executing actions. Default is always. default: always allOf: @@ -15482,9 +16714,6 @@ components: type: string enum: - file_search - description: The type of the file search tool. Always `file_search`. - x-stainless-const: true - default: file_search max_num_results: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -15494,9 +16723,9 @@ components: - $ref: '#/components/schemas/OpenAI.RankingOptions' description: Ranking options for search. filters: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Filters' - nullable: true + - type: 'null' vector_store_ids: type: array items: @@ -15632,34 +16861,50 @@ components: type: string description: The arguments to call the function with, as generated by the model in JSON format. description: Details of a function tool call. - GitHubIssueOpenedRoutineTrigger: + GitHubIssueEvent: + anyOf: + - type: string + - type: string + enum: + - opened + - closed + description: Known GitHub issue events that can fire a routine. + x-ms-foundry-meta: + conditional_previews: + - Routines=V1Preview + GitHubIssueRoutineTrigger: type: object required: - type - connection_id - - assignee + - owner - repository + - issue_event properties: type: type: string enum: - - github_issue_opened + - github_issue description: The trigger type. connection_id: type: string maxLength: 256 description: The workspace connection identifier that resolves the GitHub configuration for the trigger. - assignee: + owner: type: string maxLength: 128 - description: The GitHub assignee or organization filter that scopes which issues can fire the trigger. + description: The GitHub owner or organization that scopes which issues can fire the trigger. repository: type: string maxLength: 128 description: The GitHub repository filter that scopes which issues can fire the trigger. + issue_event: + allOf: + - $ref: '#/components/schemas/GitHubIssueEvent' + description: The GitHub issue event that fires the routine. allOf: - $ref: '#/components/schemas/RoutineTrigger' - description: A GitHub issue-opened routine trigger. + description: A GitHub issue routine trigger. x-ms-foundry-meta: conditional_previews: - Routines=V1Preview @@ -15693,15 +16938,18 @@ components: header_name: type: string description: The name of the HTTP header to inject the secret value into. - example: X-Otlp-Api-Key + examples: + - X-Otlp-Api-Key secret_id: type: string description: The identifier of the secret store or connection. - example: my-secret-store + examples: + - my-secret-store secret_key: type: string description: The key within the secret to retrieve the authentication value. - example: OTLP_KEY + examples: + - OTLP_KEY allOf: - $ref: '#/components/schemas/TelemetryEndpointAuth' description: Header-based secret authentication for a telemetry endpoint. The resolved secret value is injected as an HTTP header. @@ -15729,19 +16977,21 @@ components: cpu: type: string description: The CPU configuration for the hosted agent. - example: '0.25' + examples: + - '0.25' memory: type: string description: The memory configuration for the hosted agent. - example: 0.5Gi + examples: + - 0.5Gi environment_variables: type: object - additionalProperties: + unevaluatedProperties: type: string description: Environment variables to set in the hosted agent container. - example: - name: LOG_LEVEL - value: debug + examples: + - name: LOG_LEVEL + value: debug container_configuration: allOf: - $ref: '#/components/schemas/ContainerConfiguration' @@ -15754,11 +17004,11 @@ components: items: $ref: '#/components/schemas/ProtocolVersionRecord' description: The protocols that the agent supports for ingress communication. - example: - - protocol: responses - version: v0.1.1 - - protocol: a2a - version: v0.3.0 + examples: + - - protocol: responses + version: v0.1.1 + - protocol: a2a + version: v0.3.0 x-ms-foundry-meta: required_previews: - CodeAgents=V1Preview @@ -15860,7 +17110,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. discriminator: @@ -16004,11 +17254,11 @@ components: description: Sample type features: type: object - additionalProperties: {} + unevaluatedProperties: {} description: Features to help with additional filtering of data in UX. correlationInfo: type: object - additionalProperties: {} + unevaluatedProperties: {} description: Info about the correlation for the analysis sample. discriminator: propertyName: type @@ -16088,6 +17338,7 @@ components: type: object required: - type + - input properties: type: type: string @@ -16095,9 +17346,7 @@ components: - invoke_agent_invocations_api description: The manual dispatch payload type. input: - type: string - maxLength: 32768 - description: The raw input sent to the downstream invocations target. + description: The JSON value sent as the complete downstream invocations input. The value is passed through as-is and can be an object, string, number, boolean, array, or null. allOf: - $ref: '#/components/schemas/RoutineDispatchPayload' description: A manual payload used to test an invocations API routine dispatch. @@ -16108,24 +17357,29 @@ components: type: object required: - type - - agent_endpoint_id properties: type: type: string enum: - invoke_agent_invocations_api description: The action type. + agent_name: + type: string + maxLength: 256 + description: The project-scoped agent name for routine dispatch. agent_endpoint_id: type: string maxLength: 256 - description: The endpoint-scoped agent identifier for invocations API dispatch. + description: Legacy endpoint-scoped agent identifier for routine dispatch. + input: + description: Static JSON value sent as the complete downstream input when the routine fires. The value is passed through as-is; no templating is applied. session_id: type: string maxLength: 256 description: An optional existing hosted-agent session identifier to continue during the downstream dispatch. allOf: - $ref: '#/components/schemas/RoutineAction' - description: Dispatches a routine through the raw invocations API. + description: Dispatches a routine through the raw invocations API. Exactly one of agent_name or agent_endpoint_id must be provided. x-ms-foundry-meta: conditional_previews: - Routines=V1Preview @@ -16133,6 +17387,7 @@ components: type: object required: - type + - input properties: type: type: string @@ -16140,9 +17395,7 @@ components: - invoke_agent_responses_api description: The manual dispatch payload type. input: - type: string - maxLength: 32768 - description: The user input sent to the downstream responses target. + description: The JSON value sent as the complete downstream responses input. The value is passed through as-is and can be an object, string, number, boolean, array, or null. allOf: - $ref: '#/components/schemas/RoutineDispatchPayload' description: A manual payload used to test a responses API routine dispatch. @@ -16162,12 +17415,14 @@ components: agent_name: type: string maxLength: 256 - description: The project-scoped agent name for responses API dispatch. + description: The project-scoped agent name for routine dispatch. agent_endpoint_id: type: string maxLength: 256 - description: The endpoint-scoped agent identifier for responses API dispatch. - conversation_id: + description: Legacy endpoint-scoped agent identifier for routine dispatch. + input: + description: Static JSON value sent as the complete downstream input when the routine fires. The value is passed through as-is; no templating is applied. + conversation: type: string maxLength: 256 description: An optional existing conversation identifier to continue during the downstream dispatch. @@ -16219,6 +17474,7 @@ components: red_team_taxonomy: '#/components/schemas/RedTeamTaxonomyItemGenerationParams' response_retrieval: '#/components/schemas/ResponseRetrievalItemGenerationParams' conversation_gen_preview: '#/components/schemas/ConversationGenPreviewItemGenerationParams' + synthetic_data_gen_preview: '#/components/schemas/SyntheticDataGenerationPreviewItemGenerationParams' description: Represents the set of parameters used to control item generation operations. ItemGenerationParamsType: anyOf: @@ -16274,8 +17530,6 @@ components: type: string enum: - mcp - description: The type of the MCP tool. Always `mcp`. - x-stainless-const: true server_label: type: string description: A label for this MCP server, used to identify it in tool calls. @@ -16319,32 +17573,30 @@ components: type: string description: Optional description of the MCP server, used to provide more context. headers: - type: object - additionalProperties: - type: string - nullable: true + anyOf: + - type: object + unevaluatedProperties: + type: string + - type: 'null' allowed_tools: anyOf: - type: array items: type: string - nullable: true - - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.MCPToolFilter' - nullable: true + - $ref: '#/components/schemas/OpenAI.MCPToolFilter' + - type: 'null' require_approval: anyOf: - - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' - nullable: true + - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' - type: string enum: - always - never - nullable: true + - type: 'null' default: always + defer_loading: + type: boolean + description: Whether this MCP tool is deferred and discovered via tool search. project_connection_id: type: string description: The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server. @@ -16597,10 +17849,11 @@ components: - $ref: '#/components/schemas/ToolCallStatus' description: The status of the tool call. memories: - type: array - items: - $ref: '#/components/schemas/MemoryItem' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/MemoryItem' + - type: 'null' description: The results returned from the memory search. allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' @@ -16652,7 +17905,7 @@ components: default: true procedural_memory_enabled: type: boolean - description: Whether to enable procedural memory extraction and storage. Defaults to `true`. + description: Whether to enable procedural memory extraction and storage. The service defaults to `true` if a value is not specified by the caller. default: true default_ttl_seconds: type: integer @@ -16752,7 +18005,7 @@ components: description: A human-readable description of the memory store. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Arbitrary key-value metadata to associate with the memory store. definition: @@ -16948,7 +18201,7 @@ components: readOnly: true capabilities: type: object - additionalProperties: + unevaluatedProperties: type: string description: Capabilities of deployed model readOnly: true @@ -17097,7 +18350,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Model Version Definition @@ -17239,7 +18492,6 @@ components: - create_file description: Create a new file with the provided diff. x-stainless-const: true - default: create_file path: type: string description: Path of the file to create. @@ -17263,7 +18515,6 @@ components: - create_file description: The operation type. Always `create_file`. x-stainless-const: true - default: create_file path: type: string minLength: 1 @@ -17288,7 +18539,6 @@ components: - delete_file description: Delete the specified file. x-stainless-const: true - default: delete_file path: type: string description: Path of the file to delete. @@ -17308,7 +18558,6 @@ components: - delete_file description: The operation type. Always `delete_file`. x-stainless-const: true - default: delete_file path: type: string minLength: 1 @@ -17374,7 +18623,6 @@ components: - apply_patch description: The type of the tool. Always `apply_patch`. x-stainless-const: true - default: apply_patch allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: Allows the assistant to create, delete, or update files using unified diffs. @@ -17392,7 +18640,6 @@ components: - update_file description: Update an existing file with the provided diff. x-stainless-const: true - default: update_file path: type: string description: Path of the file to update. @@ -17416,7 +18663,6 @@ components: - update_file description: The operation type. Always `update_file`. x-stainless-const: true - default: update_file path: type: string minLength: 1 @@ -17442,17 +18688,21 @@ components: x-stainless-const: true default: approximate country: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' region: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' city: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' timezone: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' OpenAI.AutoCodeInterpreterToolParam: type: object required: @@ -17472,9 +18722,9 @@ components: maxItems: 50 description: An optional list of uploaded files to make available to your code. memory_limit: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ContainerMemoryLimit' - nullable: true + - type: 'null' network_policy: $ref: '#/components/schemas/OpenAI.ContainerNetworkPolicyParam' description: Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. @@ -17498,6 +18748,12 @@ components: OpenAI.ChatModel: type: string enum: + - gpt-5.4 + - gpt-5.4-mini + - gpt-5.4-nano + - gpt-5.4-mini-2026-03-17 + - gpt-5.4-nano-2026-03-17 + - gpt-5.3-chat-latest - gpt-5.2 - gpt-5.2-2025-12-11 - gpt-5.2-chat-latest @@ -17592,7 +18848,6 @@ components: - click description: Specifies the event type. For a click action, this property is always `click`. x-stainless-const: true - default: click button: allOf: - $ref: '#/components/schemas/OpenAI.ClickButtonType' @@ -17605,6 +18860,12 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The y-coordinate where the click occurred. + keys: + anyOf: + - type: array + items: + type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A click action. @@ -17722,13 +18983,27 @@ components: - type: array items: $ref: '#/components/schemas/OpenAI.InputItem' - nullable: true + - type: 'null' previous_response_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' instructions: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' + prompt_cache_key: + anyOf: + - type: string + - type: 'null' + prompt_cache_retention: + anyOf: + - $ref: '#/components/schemas/OpenAI.PromptCacheRetentionEnum' + - type: 'null' + service_tier: + anyOf: + - $ref: '#/components/schemas/OpenAI.ServiceTierEnum' + - type: 'null' OpenAI.ComparisonFilter: type: object required: @@ -17745,6 +19020,8 @@ components: - gte - lt - lte + - in + - nin description: |- Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`. - `eq`: equals @@ -17816,6 +19093,14 @@ components: scroll: '#/components/schemas/OpenAI.ScrollParam' type: '#/components/schemas/OpenAI.TypeParam' wait: '#/components/schemas/OpenAI.WaitParam' + OpenAI.ComputerActionList: + type: array + items: + $ref: '#/components/schemas/OpenAI.ComputerAction' + description: |- + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + title: Computer Action List OpenAI.ComputerActionType: anyOf: - type: string @@ -17839,11 +19124,13 @@ components: type: string description: The ID of the pending safety check. code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' message: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' description: A pending safety check for the computer call. OpenAI.ComputerEnvironment: type: string @@ -17859,6 +19146,7 @@ components: - type - image_url - file_id + - detail properties: type: type: string @@ -17866,14 +19154,19 @@ components: - computer_screenshot description: Specifies the event type. For a computer screenshot, this property is always set to `computer_screenshot`. x-stainless-const: true - default: computer_screenshot image_url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' + detail: + allOf: + - $ref: '#/components/schemas/OpenAI.ImageDetail' + description: The detail level of the screenshot image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. allOf: - $ref: '#/components/schemas/OpenAI.MessageContent' description: A screenshot of a computer. @@ -17900,6 +19193,21 @@ components: type: string description: The identifier of an uploaded file that contains the screenshot. description: A computer screenshot image used with the computer use tool. + OpenAI.ComputerTool: + type: object + required: + - type + properties: + type: + type: string + enum: + - computer + description: The type of the computer tool. Always `computer`. + x-stainless-const: true + allOf: + - $ref: '#/components/schemas/OpenAI.Tool' + description: A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + title: Computer OpenAI.ComputerUsePreviewTool: type: object required: @@ -17914,7 +19222,6 @@ components: - computer_use_preview description: The type of the computer use tool. Always `computer_use_preview`. x-stainless-const: true - default: computer_use_preview environment: allOf: - $ref: '#/components/schemas/OpenAI.ComputerEnvironment' @@ -17942,7 +19249,6 @@ components: - container_auto description: Automatically creates a container for this request x-stainless-const: true - default: container_auto file_ids: type: array items: @@ -17950,9 +19256,9 @@ components: maxItems: 50 description: An optional list of uploaded files to make available to your code. memory_limit: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ContainerMemoryLimit' - nullable: true + - type: 'null' skills: type: array items: @@ -17979,7 +19285,6 @@ components: - container_file_citation description: The type of the container file citation. Always `container_file_citation`. x-stainless-const: true - default: container_file_citation container_id: type: string description: The ID of the container file. @@ -18020,19 +19325,12 @@ components: - allowlist description: Allow outbound network access only to specified domains. Always `allowlist`. x-stainless-const: true - default: allowlist allowed_domains: type: array items: type: string minItems: 1 description: A list of allowed domains when type is `allowlist`. - domain_secrets: - type: array - items: - $ref: '#/components/schemas/OpenAI.ContainerNetworkPolicyDomainSecretParam' - minItems: 1 - description: Optional domain-scoped secrets for allowlisted domains. allOf: - $ref: '#/components/schemas/OpenAI.ContainerNetworkPolicyParam' OpenAI.ContainerNetworkPolicyDisabledParam: @@ -18046,29 +19344,8 @@ components: - disabled description: Disable outbound network access. Always `disabled`. x-stainless-const: true - default: disabled allOf: - $ref: '#/components/schemas/OpenAI.ContainerNetworkPolicyParam' - OpenAI.ContainerNetworkPolicyDomainSecretParam: - type: object - required: - - domain - - name - - value - properties: - domain: - type: string - minLength: 1 - description: The domain associated with the secret. - name: - type: string - minLength: 1 - description: The name of the secret to inject for the domain. - value: - type: string - minLength: 1 - maxLength: 10485760 - description: The secret value to inject for the domain. OpenAI.ContainerNetworkPolicyParam: type: object required: @@ -18101,7 +19378,6 @@ components: - container_reference description: The environment type. Always `container_reference`. x-stainless-const: true - default: container_reference container_id: type: string allOf: @@ -18136,10 +19412,9 @@ components: type: string description: The context management entry type. Currently only 'compaction' is supported. compact_threshold: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' OpenAI.ConversationItem: type: object required: @@ -18151,14 +19426,18 @@ components: propertyName: type mapping: message: '#/components/schemas/OpenAI.ConversationItemMessage' - function_call: '#/components/schemas/OpenAI.ConversationItemFunctionToolCallResource' - function_call_output: '#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutputResource' + function_call: '#/components/schemas/OpenAI.ConversationItemFunctionToolCall' + function_call_output: '#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutput' file_search_call: '#/components/schemas/OpenAI.ConversationItemFileSearchToolCall' web_search_call: '#/components/schemas/OpenAI.ConversationItemWebSearchToolCall' image_generation_call: '#/components/schemas/OpenAI.ConversationItemImageGenToolCall' computer_call: '#/components/schemas/OpenAI.ConversationItemComputerToolCall' - computer_call_output: '#/components/schemas/OpenAI.ConversationItemComputerToolCallOutputResource' + computer_call_output: '#/components/schemas/OpenAI.ConversationItemComputerToolCallOutput' + tool_search_call: '#/components/schemas/OpenAI.ConversationItemToolSearchCall' + tool_search_output: '#/components/schemas/OpenAI.ConversationItemToolSearchOutput' + additional_tools: '#/components/schemas/OpenAI.ConversationItemAdditionalTools' reasoning: '#/components/schemas/OpenAI.ConversationItemReasoningItem' + compaction: '#/components/schemas/OpenAI.ConversationItemCompactionBody' code_interpreter_call: '#/components/schemas/OpenAI.ConversationItemCodeInterpreterToolCall' local_shell_call: '#/components/schemas/OpenAI.ConversationItemLocalShellToolCall' local_shell_call_output: '#/components/schemas/OpenAI.ConversationItemLocalShellToolCallOutput' @@ -18170,10 +19449,39 @@ components: mcp_approval_request: '#/components/schemas/OpenAI.ConversationItemMcpApprovalRequest' mcp_approval_response: '#/components/schemas/OpenAI.ConversationItemMcpApprovalResponseResource' mcp_call: '#/components/schemas/OpenAI.ConversationItemMcpToolCall' - custom_tool_call: '#/components/schemas/OpenAI.ConversationItemCustomToolCall' - custom_tool_call_output: '#/components/schemas/OpenAI.ConversationItemCustomToolCallOutput' + custom_tool_call: '#/components/schemas/OpenAI.ConversationItemCustomToolCallResource' + custom_tool_call_output: '#/components/schemas/OpenAI.ConversationItemCustomToolCallOutputResource' description: A single item within a conversation. The set of possible types are the same as the `output` type of a [Response object](/docs/api-reference/responses/object#responses/object-output). title: Conversation item + OpenAI.ConversationItemAdditionalTools: + type: object + required: + - type + - id + - role + - tools + properties: + type: + type: string + enum: + - additional_tools + description: The type of the item. Always `additional_tools`. + x-stainless-const: true + default: additional_tools + id: + type: string + description: The unique ID of the additional tools item. + role: + allOf: + - $ref: '#/components/schemas/OpenAI.MessageRole' + description: The role that provided the additional tools. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The additional tool definitions made available at this item. + allOf: + - $ref: '#/components/schemas/OpenAI.ConversationItem' OpenAI.ConversationItemApplyPatchToolCall: type: object required: @@ -18238,8 +19546,9 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call output. @@ -18280,26 +19589,54 @@ components: type: string description: The ID of the container used to run the code. code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' outputs: - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - nullable: true + anyOf: + - type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: A tool call to run code. title: Code interpreter tool call + OpenAI.ConversationItemCompactionBody: + type: object + required: + - type + - id + - encrypted_content + properties: + type: + type: string + enum: + - compaction + description: The type of the item. Always `compaction`. + x-stainless-const: true + default: compaction + id: + type: string + description: The unique ID of the compaction item. + encrypted_content: + type: string + description: The encrypted content that was produced by compaction. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ConversationItem' + description: A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact). + title: Compaction item OpenAI.ConversationItemComputerToolCall: type: object required: - type - id - call_id - - action - pending_safety_checks - status properties: @@ -18317,6 +19654,8 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' + actions: + $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -18337,10 +19676,11 @@ components: A tool call to a computer use tool. See the [computer use guide](/docs/guides/tools-computer-use) for more information. title: Computer tool call - OpenAI.ConversationItemComputerToolCallOutputResource: + OpenAI.ConversationItemComputerToolCallOutput: type: object required: - type + - id - call_id - output properties: @@ -18354,6 +19694,7 @@ components: id: type: string description: The ID of the computer tool call output. + readOnly: true call_id: type: string description: The ID of the computer tool call that produced the output. @@ -18377,68 +19718,91 @@ components: `incomplete`. Populated when input items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - OpenAI.ConversationItemCustomToolCall: + description: The output of a computer tool call. + title: Computer tool call output + OpenAI.ConversationItemCustomToolCallOutputResource: type: object required: - type - call_id - - name - - input + - output + - status properties: type: type: string enum: - - custom_tool_call - description: The type of the custom tool call. Always `custom_tool_call`. + - custom_tool_call_output + description: The type of the custom tool call output. Always `custom_tool_call_output`. x-stainless-const: true id: type: string - description: The unique ID of the custom tool call in the OpenAI platform. + description: The unique ID of the custom tool call output in the OpenAI platform. call_id: type: string - description: An identifier used to map this custom tool call to a tool call output. - name: - type: string - description: The name of the custom tool being called. - input: + description: The call ID, used to map this custom tool call output to a custom tool call. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + created_by: type: string - description: The input for the custom tool call generated by the model. + description: The identifier of the actor that created the item. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - description: A call to a custom tool created by the model. - title: Custom tool call - OpenAI.ConversationItemCustomToolCallOutput: + title: ResponseCustomToolCallOutputItem + OpenAI.ConversationItemCustomToolCallResource: type: object required: - type - call_id - - output + - name + - input + - status properties: type: type: string enum: - - custom_tool_call_output - description: The type of the custom tool call output. Always `custom_tool_call_output`. + - custom_tool_call + description: The type of the custom tool call. Always `custom_tool_call`. x-stainless-const: true id: type: string - description: The unique ID of the custom tool call output in the OpenAI platform. + description: The unique ID of the custom tool call in the OpenAI platform. call_id: type: string - description: The call ID, used to map this custom tool call output to a custom tool call. - output: - oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: An identifier used to map this custom tool call to a tool call output. + namespace: + type: string + description: The namespace of the custom tool being called. + name: + type: string + description: The name of the custom tool being called. + input: + type: string + description: The input for the custom tool call generated by the model. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' description: |- - The output from the custom tool call generated by your code. - Can be a string or an list of output content. + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + created_by: + type: string + description: The identifier of the actor that created the item. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - description: The output of a custom tool call from your code, being sent back to the model. - title: Custom tool call output + title: ResponseCustomToolCallItem OpenAI.ConversationItemFileSearchToolCall: type: object required: @@ -18473,10 +19837,11 @@ components: type: string description: The queries used to search for files. results: - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: |- @@ -18512,13 +19877,12 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - nullable: true + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call. @@ -18551,7 +19915,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -18559,10 +19923,9 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' created_by: type: string description: The identifier of the actor that created the item. @@ -18570,36 +19933,37 @@ components: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: The output of a shell tool call that was emitted. title: Shell call output - OpenAI.ConversationItemFunctionToolCallOutputResource: + OpenAI.ConversationItemFunctionToolCall: type: object required: + - id - type - call_id - - output + - name + - arguments properties: id: type: string - description: |- - The unique ID of the function tool call output. Populated when this item - is returned via API. + description: The unique ID of the function tool call. + readOnly: true type: type: string enum: - - function_call_output - description: The type of the function tool call output. Always `function_call_output`. + - function_call + description: The type of the function tool call. Always `function_call`. x-stainless-const: true call_id: type: string description: The unique ID of the function tool call generated by the model. - output: - oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' - description: |- - The output from the function call generated by your code. - Can be a string or an list of output content. + namespace: + type: string + description: The namespace of the function to run. + name: + type: string + description: The name of the function to run. + arguments: + type: string + description: A JSON string of the arguments to pass to the function. status: type: string enum: @@ -18611,32 +19975,42 @@ components: `incomplete`. Populated when items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - OpenAI.ConversationItemFunctionToolCallResource: + description: |- + A tool call to run a function. See the + [function calling guide](/docs/guides/function-calling) for more information. + title: Function tool call + OpenAI.ConversationItemFunctionToolCallOutput: type: object required: + - id - type - call_id - - name - - arguments + - output properties: id: type: string - description: The unique ID of the function tool call. + description: |- + The unique ID of the function tool call output. Populated when this item + is returned via API. + readOnly: true type: type: string enum: - - function_call - description: The type of the function tool call. Always `function_call`. + - function_call_output + description: The type of the function tool call output. Always `function_call_output`. x-stainless-const: true call_id: type: string description: The unique ID of the function tool call generated by the model. - name: - type: string - description: The name of the function to run. - arguments: - type: string - description: A JSON string of the arguments to pass to the function. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the function call generated by your code. + Can be a string or an list of output content. status: type: string enum: @@ -18648,6 +20022,8 @@ components: `incomplete`. Populated when items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' + description: The output of a function tool call. + title: Function tool call output OpenAI.ConversationItemImageGenToolCall: type: object required: @@ -18674,8 +20050,9 @@ components: - failed description: The status of the image generation call. result: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: An image generation request made by the model. @@ -18770,12 +20147,13 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - type: string - enum: - - in_progress - - completed - - incomplete - nullable: true + anyOf: + - type: string + enum: + - in_progress + - completed + - incomplete + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: The output of a local shell tool call. @@ -18835,8 +20213,9 @@ components: type: boolean description: Whether the request was approved. reason: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: A response to an MCP approval request. @@ -18867,8 +20246,7 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - type: string - nullable: true + $ref: '#/components/schemas/OpenAI.RealtimeMCPError' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: A list of tools available on an MCP server. @@ -18901,18 +20279,20 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' error: type: object - additionalProperties: {} + unevaluatedProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: An invocation of a tool on an MCP server. @@ -18949,6 +20329,10 @@ components: items: $ref: '#/components/schemas/OpenAI.MessageContent' description: The content of the message + phase: + anyOf: + - $ref: '#/components/schemas/OpenAI.MessagePhase' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: A message to or from the model. @@ -18970,8 +20354,9 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' summary: type: array items: @@ -18999,6 +20384,87 @@ components: for subsequent turns of a conversation if you are manually [managing context](/docs/guides/conversation-state). title: Reasoning + OpenAI.ConversationItemToolSearchCall: + type: object + required: + - type + - id + - call_id + - execution + - arguments + - status + properties: + type: + type: string + enum: + - tool_search_call + description: The type of the item. Always `tool_search_call`. + x-stainless-const: true + default: tool_search_call + id: + type: string + description: The unique ID of the tool search call item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + arguments: + description: Arguments used for the tool search call. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' + description: The status of the tool search call item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ConversationItem' + OpenAI.ConversationItemToolSearchOutput: + type: object + required: + - type + - id + - call_id + - execution + - tools + - status + properties: + type: + type: string + enum: + - tool_search_output + description: The type of the item. Always `tool_search_output`. + x-stainless-const: true + default: tool_search_output + id: + type: string + description: The unique ID of the tool search output item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The loaded tool definitions returned by tool search. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' + description: The status of the tool search output item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ConversationItem' OpenAI.ConversationItemType: anyOf: - type: string @@ -19012,7 +20478,11 @@ components: - image_generation_call - computer_call - computer_call_output + - tool_search_call + - tool_search_output + - additional_tools - reasoning + - compaction - code_interpreter_call - local_shell_call - local_shell_call_output @@ -19148,6 +20618,7 @@ components: mapping: text: '#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText' json_object: '#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject' + json_schema: '#/components/schemas/OpenAI.ResponseFormatJsonSchema' description: |- An object specifying the format that the model must output. Setting to `{ "type": "json_schema", "json_schema": {...} }` enables @@ -19203,15 +20674,15 @@ components: type: object properties: metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' items: - type: array - items: - $ref: '#/components/schemas/OpenAI.InputItem' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.InputItem' + - type: 'null' OpenAI.CreateEvalCompletionsRunDataSource: type: object required: @@ -19332,7 +20803,7 @@ components: default: custom item_schema: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The json schema for each row in the data source. include_sample_schema: type: boolean @@ -19404,7 +20875,7 @@ components: default: logs metadata: type: object - additionalProperties: {} + unevaluatedProperties: {} description: Metadata filters for the logs data source. description: |- A data source config which specifies the metadata property of your logs query. @@ -19549,7 +21020,7 @@ components: default: stored_completions metadata: type: object - additionalProperties: {} + unevaluatedProperties: {} description: Metadata filters for the stored completions data source. description: Deprecated in favor of LogsDataSourceConfig. title: StoredCompletionsDataSourceConfig @@ -19599,16 +21070,18 @@ components: This value is now deprecated in favor of `method`, and should be passed in under the `method` parameter. deprecated: true suffix: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' minLength: 1 maxLength: 64 description: |- A string of up to 64 characters that will be added to your fine-tuned model name. For example, a `suffix` of "custom-model-name" would produce a model name like `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`. validation_file: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' description: |- The ID of an uploaded file that contains validation data. If you provide this file, the data is used to generate validation @@ -19618,16 +21091,16 @@ components: Your dataset must be formatted as a JSONL file. You must upload your file with the purpose `fine-tune`. See the [fine-tuning guide](/docs/guides/model-optimization) for more details. integrations: - type: array - items: - $ref: '#/components/schemas/OpenAI.CreateFineTuningJobRequestIntegrations' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.CreateFineTuningJobRequestIntegrations' + - type: 'null' description: A list of integrations to enable for your fine-tuning job. seed: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' minimum: 0 maximum: 2147483647 description: |- @@ -19636,10 +21109,9 @@ components: method: $ref: '#/components/schemas/OpenAI.FineTuneMethod' metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' OpenAI.CreateFineTuningJobRequestHyperparameters: type: object properties: @@ -19685,11 +21157,13 @@ components: project: type: string name: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' entity: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' tags: type: array items: @@ -19762,7 +21236,6 @@ components: - grammar description: Grammar format. Always `grammar`. x-stainless-const: true - default: grammar syntax: allOf: - $ref: '#/components/schemas/OpenAI.GrammarSyntax1' @@ -19785,7 +21258,6 @@ components: - text description: Unconstrained text format. Always `text`. x-stainless-const: true - default: text allOf: - $ref: '#/components/schemas/OpenAI.CustomToolParamFormat' description: Unconstrained free-form text. @@ -19802,7 +21274,6 @@ components: - custom description: The type of the custom tool. Always `custom`. x-stainless-const: true - default: custom name: type: string description: The name of the custom tool, used to identify it in tool calls. @@ -19813,6 +21284,9 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.CustomToolParamFormat' description: The input format for the custom tool. Default is unconstrained text. + defer_loading: + type: boolean + description: Whether this tool should be deferred and discovered via tool search. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools) @@ -19860,12 +21334,14 @@ components: - low - high - auto + - original OpenAI.DoubleClickAction: type: object required: - type - x - 'y' + - keys properties: type: type: string @@ -19873,7 +21349,6 @@ components: - double_click description: Specifies the event type. For a double click action, this property is always set to `double_click`. x-stainless-const: true - default: double_click x: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -19882,6 +21357,12 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The y-coordinate where the double click occurred. + keys: + anyOf: + - type: array + items: + type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A double click action. @@ -19898,7 +21379,6 @@ components: - drag description: Specifies the event type. For a drag action, this property is always set to `drag`. x-stainless-const: true - default: drag path: type: array items: @@ -19911,6 +21391,12 @@ components: { x: 200, y: 300 } ] ``` + keys: + anyOf: + - type: array + items: + type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A drag action. @@ -19939,6 +21425,10 @@ components: description: |- Text, image, or audio input to the model, used to generate a response. Can also contain previous assistant responses. + phase: + anyOf: + - $ref: '#/components/schemas/OpenAI.MessagePhase' + - type: 'null' type: type: string enum: @@ -19963,6 +21453,8 @@ components: `assistant` role are presumed to have been generated by the model in previous interactions. title: Input message + OpenAI.EmptyModelParam: + type: object OpenAI.Error: type: object required: @@ -19970,13 +21462,15 @@ components: - message properties: code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' message: type: string param: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' type: type: string details: @@ -19985,10 +21479,10 @@ components: $ref: '#/components/schemas/OpenAI.Error' additionalInfo: type: object - additionalProperties: {} + unevaluatedProperties: {} debugInfo: type: object - additionalProperties: {} + unevaluatedProperties: {} OpenAI.EvalApiError: type: object required: @@ -20118,26 +21612,22 @@ components: type: object properties: seed: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' top_p: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' default: 1 temperature: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' max_completions_tokens: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' reasoning_effort: $ref: '#/components/schemas/OpenAI.ReasoningEffort' OpenAI.EvalGraderStringCheck: @@ -20390,10 +21880,10 @@ components: properties: item: type: object - additionalProperties: {} + unevaluatedProperties: {} sample: type: object - additionalProperties: {} + unevaluatedProperties: {} OpenAI.EvalJsonlFileIdSource: type: object required: @@ -20422,49 +21912,50 @@ components: - responses description: The type of run data source. Always `responses`. metadata: - type: object - additionalProperties: {} - nullable: true + anyOf: + - type: object + unevaluatedProperties: {} + - type: 'null' model: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' instructions_search: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' created_after: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' created_before: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' reasoning_effort: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ReasoningEffort' - nullable: true + - type: 'null' temperature: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' top_p: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' users: - type: array - items: - type: string - nullable: true + anyOf: + - type: array + items: + type: string + - type: 'null' tools: - type: array - items: - type: string - nullable: true + anyOf: + - type: array + items: + type: string + - type: 'null' description: A EvalResponsesSource object describing a run data source configuration. title: EvalResponsesSource x-oaiMeta: @@ -20610,28 +22101,25 @@ components: x-stainless-const: true default: stored_completions metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' model: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' created_after: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' created_before: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' limit: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' description: A StoredCompletionsRunDataSource configuration describing a set of filters title: StoredCompletionsRunDataSource x-oaiMeta: @@ -20660,7 +22148,6 @@ components: - file_citation description: The type of the file citation. Always `file_citation`. x-stainless-const: true - default: file_citation file_id: type: string description: The ID of the file. @@ -20675,6 +22162,11 @@ components: - $ref: '#/components/schemas/OpenAI.Annotation' description: A citation to a file. title: File citation + OpenAI.FileInputDetail: + type: string + enum: + - low + - high OpenAI.FilePath: type: object required: @@ -20711,7 +22203,6 @@ components: - file_search description: The type of the file search tool. Always `file_search`. x-stainless-const: true - default: file_search vector_store_ids: type: array items: @@ -20726,9 +22217,9 @@ components: - $ref: '#/components/schemas/OpenAI.RankingOptions' description: Ranking options for search. filters: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Filters' - nullable: true + - type: 'null' name: type: string description: Optional user-defined name for this tool or configuration. @@ -20749,10 +22240,9 @@ components: filename: type: string attributes: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.VectorStoreFileAttributes' - nullable: true + - type: 'null' score: type: number format: float @@ -20960,11 +22450,13 @@ components: project: type: string name: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' entity: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' tags: type: array items: @@ -20996,17 +22488,20 @@ components: format: unixtime description: The Unix timestamp (in seconds) for when the fine-tuning job was created. error: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FineTuningJobError' - nullable: true + - type: 'null' fine_tuned_model: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' finished_at: + anyOf: + - type: string + format: date-time + - type: 'null' type: integer - format: unixtime - nullable: true + format: unixTimestamp hyperparameters: allOf: - $ref: '#/components/schemas/OpenAI.FineTuningJobHyperparameters' @@ -21039,36 +22534,39 @@ components: - cancelled description: The current status of the fine-tuning job, which can be either `validating_files`, `queued`, `running`, `succeeded`, `failed`, or `cancelled`. trained_tokens: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' training_file: type: string description: The file ID used for training. You can retrieve the training data with the [Files API](/docs/api-reference/files/retrieve-contents). validation_file: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' integrations: - type: array - items: - $ref: '#/components/schemas/OpenAI.FineTuningIntegration' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.FineTuningIntegration' + - type: 'null' seed: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The seed used for the fine-tuning job. estimated_finish: + anyOf: + - type: string + format: date-time + - type: 'null' type: integer - format: unixtime - nullable: true + format: unixTimestamp method: $ref: '#/components/schemas/OpenAI.FineTuneMethod' metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' description: The `fine_tuning.job` object represents a fine-tuning job that has been created through the API. title: FineTuningJob x-oaiMeta: @@ -21200,8 +22698,9 @@ components: message: type: string param: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' OpenAI.FineTuningJobEvent: type: object required: @@ -21267,11 +22766,8 @@ components: - type: string enum: - auto - nullable: true - - type: integer - allOf: - - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - $ref: '#/components/schemas/OpenAI.integer' + - type: 'null' default: auto learning_rate_multiplier: oneOf: @@ -21313,18 +22809,23 @@ components: x-stainless-const: true default: input_file file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' filename: type: string description: The name of the file to be sent to the model. + file_data: + type: string + description: The content of the file to be sent to the model. file_url: type: string format: uri description: The URL of the file to be sent to the model. - file_data: - type: string - description: The content of the file to be sent to the model. + detail: + allOf: + - $ref: '#/components/schemas/OpenAI.FileInputDetail' + description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. allOf: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' description: A file input to the model. @@ -21343,16 +22844,18 @@ components: x-stainless-const: true default: input_image image_url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. allOf: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' description: An image input to the model. Learn about [image inputs](/docs/guides/vision). @@ -21391,6 +22894,18 @@ components: - in_progress - completed - incomplete + OpenAI.FunctionCallOutputStatusEnum: + type: string + enum: + - in_progress + - completed + - incomplete + OpenAI.FunctionCallStatus: + type: string + enum: + - in_progress + - completed + - incomplete OpenAI.FunctionObject: type: object required: @@ -21405,11 +22920,12 @@ components: parameters: $ref: '#/components/schemas/OpenAI.FunctionParameters' strict: - type: boolean - nullable: true + anyOf: + - type: boolean + - type: 'null' OpenAI.FunctionParameters: type: object - additionalProperties: {} + unevaluatedProperties: {} description: |- The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. @@ -21425,15 +22941,13 @@ components: items: type: string timeout_ms: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' description: Execute a shell command. title: Shell exec action OpenAI.FunctionShellActionParam: @@ -21447,15 +22961,13 @@ components: type: string description: Ordered shell commands for the execution environment to run. timeout_ms: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' description: Commands and limits describing how to run the shell tool call. title: Shell action OpenAI.FunctionShellCallEnvironment: @@ -21599,7 +23111,6 @@ components: - exit description: The outcome type. Always `exit`. x-stainless-const: true - default: exit exit_code: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -21620,7 +23131,6 @@ components: - exit description: The outcome type. Always `exit`. x-stainless-const: true - default: exit exit_code: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -21671,6 +23181,12 @@ components: enum: - timeout - exit + OpenAI.FunctionShellCallOutputStatusEnum: + type: string + enum: + - in_progress + - completed + - incomplete OpenAI.FunctionShellCallOutputTimeoutOutcome: type: object required: @@ -21682,7 +23198,6 @@ components: - timeout description: The outcome type. Always `timeout`. x-stainless-const: true - default: timeout allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputOutcome' description: Indicates that the shell call exceeded its configured time limit. @@ -21698,11 +23213,16 @@ components: - timeout description: The outcome type. Always `timeout`. x-stainless-const: true - default: timeout allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputOutcomeParam' description: Indicates that the shell call exceeded its configured time limit. title: Shell call timeout outcome + OpenAI.FunctionShellCallStatus: + type: string + enum: + - in_progress + - completed + - incomplete OpenAI.FunctionShellToolParam: type: object required: @@ -21714,12 +23234,10 @@ components: - shell description: The type of the shell tool. Always `shell`. x-stainless-const: true - default: shell environment: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellToolParamEnvironment' - nullable: true + - type: 'null' name: type: string description: Optional user-defined name for this tool or configuration. @@ -21803,67 +23321,61 @@ components: - function description: The type of the function tool. Always `function`. x-stainless-const: true - default: function name: type: string description: The name of the function to call. description: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' parameters: - type: object - additionalProperties: {} - nullable: true + anyOf: + - type: object + unevaluatedProperties: {} + - type: 'null' strict: + anyOf: + - type: boolean + - type: 'null' + defer_loading: type: boolean - nullable: true + description: Whether this function is deferred and loaded via tool search. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling). title: Function - OpenAI.FunctionToolCallOutput: + OpenAI.FunctionToolParam: type: object required: + - name - type - - call_id - - output properties: - id: + name: type: string - description: |- - The unique ID of the function tool call output. Populated when this item - is returned via API. + minLength: 1 + maxLength: 128 + pattern: ^[a-zA-Z0-9_-]+$ + description: + anyOf: + - type: string + - type: 'null' + parameters: + anyOf: + - $ref: '#/components/schemas/OpenAI.EmptyModelParam' + - type: 'null' + strict: + anyOf: + - type: boolean + - type: 'null' type: type: string enum: - - function_call_output - description: The type of the function tool call output. Always `function_call_output`. + - function x-stainless-const: true - call_id: - type: string - description: The unique ID of the function tool call generated by the model. - output: - oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' - description: |- - The output from the function call generated by your code. - Can be a string or an list of output content. - status: - type: string - enum: - - in_progress - - completed - - incomplete - description: |- - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemField' - description: The output of a function tool call. - title: Function tool call output + default: function + defer_loading: + type: boolean + description: Whether this function should be deferred and discovered via tool search. OpenAI.GraderLabelModel: type: object required: @@ -22240,6 +23752,7 @@ components: - low - high - auto + - original OpenAI.ImageGenActionEnum: type: string enum: @@ -22257,7 +23770,6 @@ components: - image_generation description: The type of the image generation tool. Always `image_generation`. x-stainless-const: true - default: image_generation model: anyOf: - type: string @@ -22279,15 +23791,15 @@ components: or `auto`. Default: `auto`. default: auto size: - type: string - enum: - - 1024x1024 - - 1024x1536 - - 1536x1024 - - auto - description: |- - The size of the generated image. One of `1024x1024`, `1024x1536`, - `1536x1024`, or `auto`. Default: `auto`. + anyOf: + - type: string + - type: string + enum: + - 1024x1024 + - 1024x1536 + - 1536x1024 + - auto + description: The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`. default: auto output_format: type: string @@ -22324,9 +23836,9 @@ components: `opaque`, or `auto`. Default: `auto`. default: auto input_fidelity: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.InputFidelity' - nullable: true + - type: 'null' input_image_mask: allOf: - $ref: '#/components/schemas/OpenAI.ImageGenToolInputImageMask' @@ -22377,6 +23889,7 @@ components: - memory_search_call.results description: |- Specify additional output data to include in the model response. Currently supported values are: + - `web_search_call.results`: Include the search results of the web search tool call. - `web_search_call.action.sources`: Include the sources of the web search tool call. - `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items. - `computer_call_output.output.image_url`: Include image urls from the computer call output. @@ -22398,7 +23911,6 @@ components: - inline description: Defines an inline skill for this request. x-stainless-const: true - default: inline name: type: string description: The name of the skill. @@ -22495,18 +24007,23 @@ components: x-stainless-const: true default: input_file file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' filename: type: string description: The name of the file to be sent to the model. + file_data: + type: string + description: The content of the file to be sent to the model. file_url: type: string format: uri description: The URL of the file to be sent to the model. - file_data: - type: string - description: The content of the file to be sent to the model. + detail: + allOf: + - $ref: '#/components/schemas/OpenAI.FileInputDetail' + description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. allOf: - $ref: '#/components/schemas/OpenAI.InputContent' description: A file input to the model. @@ -22525,16 +24042,18 @@ components: x-stainless-const: true default: input_image image_url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. allOf: - $ref: '#/components/schemas/OpenAI.InputContent' description: An image input to the model. Learn about [image inputs](/docs/guides/vision). @@ -22586,18 +24105,23 @@ components: x-stainless-const: true default: input_file file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' filename: type: string description: The name of the file to be sent to the model. + file_data: + type: string + description: The content of the file to be sent to the model. file_url: type: string format: uri description: The URL of the file to be sent to the model. - file_data: - type: string - description: The content of the file to be sent to the model. + detail: + allOf: + - $ref: '#/components/schemas/OpenAI.FileInputDetail' + description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. description: A file input to the model. title: Input file OpenAI.InputFileContentParam: @@ -22613,18 +24137,26 @@ components: x-stainless-const: true default: input_file file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' filename: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' file_data: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' file_url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' + detail: + allOf: + - $ref: '#/components/schemas/OpenAI.FileInputDetail' + description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. description: A file input to the model. title: Input file OpenAI.InputImageContent: @@ -22641,16 +24173,18 @@ components: x-stainless-const: true default: input_image image_url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. description: An image input to the model. Learn about [image inputs](/docs/guides/vision). title: Input image OpenAI.InputImageContentParamAutoParam: @@ -22666,16 +24200,18 @@ components: x-stainless-const: true default: input_image image_url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' detail: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.DetailEnum' - nullable: true + - type: 'null' description: An image input to the model. Learn about [image inputs](/docs/guides/vision) title: Input image OpenAI.InputItem: @@ -22697,6 +24233,9 @@ components: web_search_call: '#/components/schemas/OpenAI.InputItemWebSearchToolCall' function_call: '#/components/schemas/OpenAI.InputItemFunctionToolCall' function_call_output: '#/components/schemas/OpenAI.InputItemFunctionCallOutputItemParam' + tool_search_call: '#/components/schemas/OpenAI.InputItemToolSearchCallItemParam' + tool_search_output: '#/components/schemas/OpenAI.InputItemToolSearchOutputItemParam' + additional_tools: '#/components/schemas/OpenAI.InputItemAdditionalToolsItemParam' reasoning: '#/components/schemas/OpenAI.InputItemReasoningItem' compaction: '#/components/schemas/OpenAI.InputItemCompactionSummaryItemParam' image_generation_call: '#/components/schemas/OpenAI.InputItemImageGenToolCall' @@ -22717,6 +24256,38 @@ components: An item representing part of the context for the response to be generated by the model. Can contain text, images, and audio inputs, as well as previous assistant responses and tool call outputs. + OpenAI.InputItemAdditionalToolsItemParam: + type: object + required: + - type + - role + - tools + properties: + id: + anyOf: + - type: string + - type: 'null' + type: + type: string + enum: + - additional_tools + description: The item type. Always `additional_tools`. + x-stainless-const: true + default: additional_tools + role: + type: string + enum: + - developer + description: The role that provided the additional tools. Only `developer` is supported. + x-stainless-const: true + default: developer + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: A list of additional tools made available at this item. + allOf: + - $ref: '#/components/schemas/OpenAI.InputItem' OpenAI.InputItemApplyPatchToolCallItemParam: type: object required: @@ -22733,8 +24304,9 @@ components: x-stainless-const: true default: apply_patch_call id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -22767,8 +24339,9 @@ components: x-stainless-const: true default: apply_patch_call_output id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -22779,8 +24352,9 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatusParam' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The streamed output emitted by an apply patch tool call. @@ -22818,15 +24392,17 @@ components: type: string description: The ID of the container used to run the code. code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' outputs: - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - nullable: true + anyOf: + - type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A tool call to run code. @@ -22838,8 +24414,9 @@ components: - encrypted_content properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' type: type: string enum: @@ -22863,8 +24440,9 @@ components: - output properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -22880,14 +24458,15 @@ components: output: $ref: '#/components/schemas/OpenAI.ComputerScreenshotImage' acknowledged_safety_checks: - type: array - items: - $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' + - type: 'null' status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The output of a computer tool call. @@ -22898,7 +24477,6 @@ components: - type - id - call_id - - action - pending_safety_checks - status properties: @@ -22916,6 +24494,8 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' + actions: + $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -22956,6 +24536,9 @@ components: call_id: type: string description: An identifier used to map this custom tool call to a tool call output. + namespace: + type: string + description: The namespace of the custom tool being called. name: type: string description: The name of the custom tool being called. @@ -23032,10 +24615,11 @@ components: type: string description: The queries used to search for files. results: - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: |- @@ -23050,8 +24634,9 @@ components: - output properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -23075,9 +24660,9 @@ components: - $ref: '#/components/schemas/OpenAI.InputFileContentParam' description: Text, image, or file output of the function tool call. status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The output of a function tool call. @@ -23090,8 +24675,9 @@ components: - action properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -23109,14 +24695,13 @@ components: - $ref: '#/components/schemas/OpenAI.FunctionShellActionParam' description: The shell commands and limits that describe how to run the tool call. status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - nullable: true + - type: 'null' environment: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemParamEnvironment' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A tool representing a request to execute one or more shell commands. @@ -23129,8 +24714,9 @@ components: - output properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -23149,14 +24735,13 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContentParam' description: Captured chunks of stdout and stderr output, along with their associated outcomes. status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - nullable: true + - type: 'null' max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The streamed output items emitted by a shell tool call. @@ -23164,6 +24749,7 @@ components: OpenAI.InputItemFunctionToolCall: type: object required: + - id - type - call_id - name @@ -23172,6 +24758,7 @@ components: id: type: string description: The unique ID of the function tool call. + readOnly: true type: type: string enum: @@ -23181,6 +24768,9 @@ components: call_id: type: string description: The unique ID of the function tool call generated by the model. + namespace: + type: string + description: The namespace of the function to run. name: type: string description: The name of the function to run. @@ -23228,8 +24818,9 @@ components: - failed description: The status of the image generation call. result: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: An image generation request made by the model. @@ -23288,12 +24879,13 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - type: string - enum: - - in_progress - - completed - - incomplete - nullable: true + anyOf: + - type: string + enum: + - in_progress + - completed + - incomplete + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The output of a local shell tool call. @@ -23343,8 +24935,9 @@ components: description: The type of the item. Always `mcp_approval_response`. x-stainless-const: true id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' approval_request_id: type: string description: The ID of the approval request being answered. @@ -23352,8 +24945,9 @@ components: type: boolean description: Whether the request was approved. reason: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A response to an MCP approval request. @@ -23384,8 +24978,7 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - type: string - nullable: true + $ref: '#/components/schemas/OpenAI.RealtimeMCPError' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A list of tools available on an MCP server. @@ -23418,18 +25011,20 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' error: type: object - additionalProperties: {} + unevaluatedProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: An invocation of a tool on an MCP server. @@ -23463,6 +25058,10 @@ components: items: $ref: '#/components/schemas/OpenAI.OutputMessageContent' description: The content of the output message. + phase: + anyOf: + - $ref: '#/components/schemas/OpenAI.MessagePhase' + - type: 'null' status: type: string enum: @@ -23493,8 +25092,9 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' summary: type: array items: @@ -23522,6 +25122,77 @@ components: for subsequent turns of a conversation if you are manually [managing context](/docs/guides/conversation-state). title: Reasoning + OpenAI.InputItemToolSearchCallItemParam: + type: object + required: + - type + - arguments + properties: + id: + anyOf: + - type: string + - type: 'null' + call_id: + anyOf: + - type: string + - type: 'null' + type: + type: string + enum: + - tool_search_call + description: The item type. Always `tool_search_call`. + x-stainless-const: true + default: tool_search_call + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + arguments: + allOf: + - $ref: '#/components/schemas/OpenAI.EmptyModelParam' + description: The arguments supplied to the tool search call. + status: + anyOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' + - type: 'null' + allOf: + - $ref: '#/components/schemas/OpenAI.InputItem' + OpenAI.InputItemToolSearchOutputItemParam: + type: object + required: + - type + - tools + properties: + id: + anyOf: + - type: string + - type: 'null' + call_id: + anyOf: + - type: string + - type: 'null' + type: + type: string + enum: + - tool_search_output + description: The item type. Always `tool_search_output`. + x-stainless-const: true + default: tool_search_output + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The loaded tool definitions returned by the tool search output. + status: + anyOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' + - type: 'null' + allOf: + - $ref: '#/components/schemas/OpenAI.InputItem' OpenAI.InputItemType: anyOf: - type: string @@ -23535,6 +25206,9 @@ components: - web_search_call - function_call - function_call_output + - tool_search_call + - tool_search_output + - additional_tools - reasoning - compaction - image_generation_call @@ -23591,44 +25265,6 @@ components: The results of a web search tool call. See the [web search guide](/docs/guides/tools-web-search) for more information. title: Web search tool call - OpenAI.InputMessage: - type: object - required: - - type - - role - - content - properties: - type: - type: string - enum: - - message - description: The type of the message input. Always set to `message`. - x-stainless-const: true - role: - type: string - enum: - - user - - system - - developer - description: The role of the message input. One of `user`, `system`, or `developer`. - status: - type: string - enum: - - in_progress - - completed - - incomplete - description: |- - The status of item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - content: - $ref: '#/components/schemas/OpenAI.InputMessageContentList' - allOf: - - $ref: '#/components/schemas/OpenAI.Item' - description: |- - A message input to the model with a role indicating instruction following - hierarchy. Instructions given with the `developer` or `system` role take - precedence over instructions given with the `user` role. - title: Input message OpenAI.InputMessageContentList: type: array items: @@ -23637,43 +25273,6 @@ components: A list of one or many input items to the model, containing different content types. title: Input item content list - OpenAI.InputMessageResource: - type: object - required: - - type - - role - - content - - id - properties: - type: - type: string - enum: - - message - description: The type of the message input. Always set to `message`. - x-stainless-const: true - role: - type: string - enum: - - user - - system - - developer - description: The role of the message input. One of `user`, `system`, or `developer`. - status: - type: string - enum: - - in_progress - - completed - - incomplete - description: |- - The status of item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - content: - $ref: '#/components/schemas/OpenAI.InputMessageContentList' - id: - type: string - description: The unique ID of the message input. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemResource' OpenAI.InputParam: oneOf: - type: string @@ -23735,7 +25334,7 @@ components: discriminator: propertyName: type mapping: - message: '#/components/schemas/OpenAI.InputMessage' + message: '#/components/schemas/OpenAI.ItemInputMessage' output_message: '#/components/schemas/OpenAI.ItemOutputMessage' file_search_call: '#/components/schemas/OpenAI.ItemFileSearchToolCall' computer_call: '#/components/schemas/OpenAI.ItemComputerToolCall' @@ -23743,6 +25342,9 @@ components: web_search_call: '#/components/schemas/OpenAI.ItemWebSearchToolCall' function_call: '#/components/schemas/OpenAI.ItemFunctionToolCall' function_call_output: '#/components/schemas/OpenAI.ItemFunctionCallOutputItemParam' + tool_search_call: '#/components/schemas/OpenAI.ItemToolSearchCallItemParam' + tool_search_output: '#/components/schemas/OpenAI.ItemToolSearchOutputItemParam' + additional_tools: '#/components/schemas/OpenAI.ItemAdditionalToolsItemParam' reasoning: '#/components/schemas/OpenAI.ItemReasoningItem' compaction: '#/components/schemas/OpenAI.ItemCompactionSummaryItemParam' image_generation_call: '#/components/schemas/OpenAI.ItemImageGenToolCall' @@ -23760,6 +25362,38 @@ components: custom_tool_call_output: '#/components/schemas/OpenAI.ItemCustomToolCallOutput' custom_tool_call: '#/components/schemas/OpenAI.ItemCustomToolCall' description: Content item used to generate a response. + OpenAI.ItemAdditionalToolsItemParam: + type: object + required: + - type + - role + - tools + properties: + id: + anyOf: + - type: string + - type: 'null' + type: + type: string + enum: + - additional_tools + description: The item type. Always `additional_tools`. + x-stainless-const: true + default: additional_tools + role: + type: string + enum: + - developer + description: The role that provided the additional tools. Only `developer` is supported. + x-stainless-const: true + default: developer + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: A list of additional tools made available at this item. + allOf: + - $ref: '#/components/schemas/OpenAI.Item' OpenAI.ItemApplyPatchToolCallItemParam: type: object required: @@ -23776,8 +25410,9 @@ components: x-stainless-const: true default: apply_patch_call id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -23810,8 +25445,9 @@ components: x-stainless-const: true default: apply_patch_call_output id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -23822,8 +25458,9 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatusParam' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The streamed output emitted by an apply patch tool call. @@ -23861,15 +25498,17 @@ components: type: string description: The ID of the container used to run the code. code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' outputs: - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - nullable: true + anyOf: + - type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A tool call to run code. @@ -23881,8 +25520,9 @@ components: - encrypted_content properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' type: type: string enum: @@ -23906,8 +25546,9 @@ components: - output properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -23923,14 +25564,15 @@ components: output: $ref: '#/components/schemas/OpenAI.ComputerScreenshotImage' acknowledged_safety_checks: - type: array - items: - $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' + - type: 'null' status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The output of a computer tool call. @@ -23941,7 +25583,6 @@ components: - type - id - call_id - - action - pending_safety_checks - status properties: @@ -23959,6 +25600,8 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' + actions: + $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -23999,6 +25642,9 @@ components: call_id: type: string description: An identifier used to map this custom tool call to a tool call output. + namespace: + type: string + description: The namespace of the custom tool being called. name: type: string description: The name of the custom tool being called. @@ -24051,14 +25697,17 @@ components: discriminator: propertyName: type mapping: - function_call_output: '#/components/schemas/OpenAI.FunctionToolCallOutput' message: '#/components/schemas/OpenAI.ItemFieldMessage' function_call: '#/components/schemas/OpenAI.ItemFieldFunctionToolCall' + tool_search_call: '#/components/schemas/OpenAI.ItemFieldToolSearchCall' + tool_search_output: '#/components/schemas/OpenAI.ItemFieldToolSearchOutput' + additional_tools: '#/components/schemas/OpenAI.ItemFieldAdditionalTools' + function_call_output: '#/components/schemas/OpenAI.ItemFieldFunctionToolCallOutput' file_search_call: '#/components/schemas/OpenAI.ItemFieldFileSearchToolCall' web_search_call: '#/components/schemas/OpenAI.ItemFieldWebSearchToolCall' image_generation_call: '#/components/schemas/OpenAI.ItemFieldImageGenToolCall' computer_call: '#/components/schemas/OpenAI.ItemFieldComputerToolCall' - computer_call_output: '#/components/schemas/OpenAI.ItemFieldComputerToolCallOutputResource' + computer_call_output: '#/components/schemas/OpenAI.ItemFieldComputerToolCallOutput' reasoning: '#/components/schemas/OpenAI.ItemFieldReasoningItem' compaction: '#/components/schemas/OpenAI.ItemFieldCompactionBody' code_interpreter_call: '#/components/schemas/OpenAI.ItemFieldCodeInterpreterToolCall' @@ -24075,6 +25724,35 @@ components: custom_tool_call: '#/components/schemas/OpenAI.ItemFieldCustomToolCall' custom_tool_call_output: '#/components/schemas/OpenAI.ItemFieldCustomToolCallOutput' description: An item representing a message, tool call, tool output, reasoning, or other response element. + OpenAI.ItemFieldAdditionalTools: + type: object + required: + - type + - id + - role + - tools + properties: + type: + type: string + enum: + - additional_tools + description: The type of the item. Always `additional_tools`. + x-stainless-const: true + default: additional_tools + id: + type: string + description: The unique ID of the additional tools item. + role: + allOf: + - $ref: '#/components/schemas/OpenAI.MessageRole' + description: The role that provided the additional tools. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The additional tool definitions made available at this item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemField' OpenAI.ItemFieldApplyPatchToolCall: type: object required: @@ -24139,8 +25817,9 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call output. @@ -24181,15 +25860,17 @@ components: type: string description: The ID of the container used to run the code. code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' outputs: - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - nullable: true + anyOf: + - type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A tool call to run code. @@ -24227,7 +25908,6 @@ components: - type - id - call_id - - action - pending_safety_checks - status properties: @@ -24245,6 +25925,8 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' + actions: + $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -24265,10 +25947,11 @@ components: A tool call to a computer use tool. See the [computer use guide](/docs/guides/tools-computer-use) for more information. title: Computer tool call - OpenAI.ItemFieldComputerToolCallOutputResource: + OpenAI.ItemFieldComputerToolCallOutput: type: object required: - type + - id - call_id - output properties: @@ -24282,6 +25965,7 @@ components: id: type: string description: The ID of the computer tool call output. + readOnly: true call_id: type: string description: The ID of the computer tool call that produced the output. @@ -24305,6 +25989,8 @@ components: `incomplete`. Populated when input items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ItemField' + description: The output of a computer tool call. + title: Computer tool call output OpenAI.ItemFieldCustomToolCall: type: object required: @@ -24325,6 +26011,9 @@ components: call_id: type: string description: An identifier used to map this custom tool call to a tool call output. + namespace: + type: string + description: The namespace of the custom tool being called. name: type: string description: The name of the custom tool being called. @@ -24401,10 +26090,11 @@ components: type: string description: The queries used to search for files. results: - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: |- @@ -24440,13 +26130,12 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - nullable: true + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call. @@ -24479,7 +26168,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -24487,10 +26176,9 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' created_by: type: string description: The identifier of the actor that created the item. @@ -24501,6 +26189,7 @@ components: OpenAI.ItemFieldFunctionToolCall: type: object required: + - id - type - call_id - name @@ -24509,6 +26198,7 @@ components: id: type: string description: The unique ID of the function tool call. + readOnly: true type: type: string enum: @@ -24518,6 +26208,9 @@ components: call_id: type: string description: The unique ID of the function tool call generated by the model. + namespace: + type: string + description: The namespace of the function to run. name: type: string description: The name of the function to run. @@ -24539,6 +26232,51 @@ components: A tool call to run a function. See the [function calling guide](/docs/guides/function-calling) for more information. title: Function tool call + OpenAI.ItemFieldFunctionToolCallOutput: + type: object + required: + - id + - type + - call_id + - output + properties: + id: + type: string + description: |- + The unique ID of the function tool call output. Populated when this item + is returned via API. + readOnly: true + type: + type: string + enum: + - function_call_output + description: The type of the function tool call output. Always `function_call_output`. + x-stainless-const: true + call_id: + type: string + description: The unique ID of the function tool call generated by the model. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the function call generated by your code. + Can be a string or an list of output content. + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemField' + description: The output of a function tool call. + title: Function tool call output OpenAI.ItemFieldImageGenToolCall: type: object required: @@ -24565,8 +26303,9 @@ components: - failed description: The status of the image generation call. result: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: An image generation request made by the model. @@ -24625,12 +26364,13 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - type: string - enum: - - in_progress - - completed - - incomplete - nullable: true + anyOf: + - type: string + enum: + - in_progress + - completed + - incomplete + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: The output of a local shell tool call. @@ -24690,8 +26430,9 @@ components: type: boolean description: Whether the request was approved. reason: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A response to an MCP approval request. @@ -24722,8 +26463,7 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - type: string - nullable: true + $ref: '#/components/schemas/OpenAI.RealtimeMCPError' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A list of tools available on an MCP server. @@ -24756,18 +26496,20 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' error: type: object - additionalProperties: {} + unevaluatedProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: An invocation of a tool on an MCP server. @@ -24804,6 +26546,10 @@ components: items: $ref: '#/components/schemas/OpenAI.MessageContent' description: The content of the message + phase: + anyOf: + - $ref: '#/components/schemas/OpenAI.MessagePhase' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A message to or from the model. @@ -24825,8 +26571,9 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' summary: type: array items: @@ -24854,6 +26601,87 @@ components: for subsequent turns of a conversation if you are manually [managing context](/docs/guides/conversation-state). title: Reasoning + OpenAI.ItemFieldToolSearchCall: + type: object + required: + - type + - id + - call_id + - execution + - arguments + - status + properties: + type: + type: string + enum: + - tool_search_call + description: The type of the item. Always `tool_search_call`. + x-stainless-const: true + default: tool_search_call + id: + type: string + description: The unique ID of the tool search call item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + arguments: + description: Arguments used for the tool search call. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' + description: The status of the tool search call item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemField' + OpenAI.ItemFieldToolSearchOutput: + type: object + required: + - type + - id + - call_id + - execution + - tools + - status + properties: + type: + type: string + enum: + - tool_search_output + description: The type of the item. Always `tool_search_output`. + x-stainless-const: true + default: tool_search_output + id: + type: string + description: The unique ID of the tool search output item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The loaded tool definitions returned by tool search. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' + description: The status of the tool search output item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemField' OpenAI.ItemFieldType: anyOf: - type: string @@ -24861,6 +26689,9 @@ components: enum: - message - function_call + - tool_search_call + - tool_search_output + - additional_tools - function_call_output - file_search_call - web_search_call @@ -24955,10 +26786,11 @@ components: type: string description: The queries used to search for files. results: - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: |- @@ -24973,8 +26805,9 @@ components: - output properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -24998,9 +26831,9 @@ components: - $ref: '#/components/schemas/OpenAI.InputFileContentParam' description: Text, image, or file output of the function tool call. status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The output of a function tool call. @@ -25013,8 +26846,9 @@ components: - action properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -25032,14 +26866,13 @@ components: - $ref: '#/components/schemas/OpenAI.FunctionShellActionParam' description: The shell commands and limits that describe how to run the tool call. status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - nullable: true + - type: 'null' environment: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemParamEnvironment' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A tool representing a request to execute one or more shell commands. @@ -25052,8 +26885,9 @@ components: - output properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -25072,14 +26906,13 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContentParam' description: Captured chunks of stdout and stderr output, along with their associated outcomes. status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - nullable: true + - type: 'null' max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The streamed output items emitted by a shell tool call. @@ -25087,6 +26920,7 @@ components: OpenAI.ItemFunctionToolCall: type: object required: + - id - type - call_id - name @@ -25095,6 +26929,7 @@ components: id: type: string description: The unique ID of the function tool call. + readOnly: true type: type: string enum: @@ -25104,6 +26939,9 @@ components: call_id: type: string description: The unique ID of the function tool call generated by the model. + namespace: + type: string + description: The namespace of the function to run. name: type: string description: The name of the function to run. @@ -25151,12 +26989,57 @@ components: - failed description: The status of the image generation call. result: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: An image generation request made by the model. title: Image generation call + OpenAI.ItemInputMessage: + type: object + required: + - type + - role + - content + - id + properties: + type: + type: string + enum: + - message + description: The type of the message input. Always set to `message`. + x-stainless-const: true + default: message + role: + type: string + enum: + - user + - system + - developer + description: The role of the message input. One of `user`, `system`, or `developer`. + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + content: + $ref: '#/components/schemas/OpenAI.InputMessageContentList' + id: + type: string + description: The unique ID of the message input. + readOnly: true + allOf: + - $ref: '#/components/schemas/OpenAI.Item' + description: |- + A message input to the model with a role indicating instruction following + hierarchy. Instructions given with the `developer` or `system` role take + precedence over instructions given with the `user` role. + title: Input message OpenAI.ItemLocalShellToolCall: type: object required: @@ -25211,12 +27094,13 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - type: string - enum: - - in_progress - - completed - - incomplete - nullable: true + anyOf: + - type: string + enum: + - in_progress + - completed + - incomplete + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The output of a local shell tool call. @@ -25266,8 +27150,9 @@ components: description: The type of the item. Always `mcp_approval_response`. x-stainless-const: true id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' approval_request_id: type: string description: The ID of the approval request being answered. @@ -25275,8 +27160,9 @@ components: type: boolean description: Whether the request was approved. reason: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A response to an MCP approval request. @@ -25307,8 +27193,7 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - type: string - nullable: true + $ref: '#/components/schemas/OpenAI.RealtimeMCPError' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A list of tools available on an MCP server. @@ -25341,18 +27226,20 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' error: type: object - additionalProperties: {} + unevaluatedProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: An invocation of a tool on an MCP server. @@ -25386,6 +27273,10 @@ components: items: $ref: '#/components/schemas/OpenAI.OutputMessageContent' description: The content of the output message. + phase: + anyOf: + - $ref: '#/components/schemas/OpenAI.MessagePhase' + - type: 'null' status: type: string enum: @@ -25416,8 +27307,9 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' summary: type: array items: @@ -25457,7 +27349,6 @@ components: - item_reference description: The type of item to reference. Always `item_reference`. x-stainless-const: true - default: item_reference id: type: string description: The ID of the item to reference. @@ -25475,14 +27366,19 @@ components: discriminator: propertyName: type mapping: - message: '#/components/schemas/OpenAI.InputMessageResource' + message: '#/components/schemas/OpenAI.ItemResourceInputMessage' output_message: '#/components/schemas/OpenAI.ItemResourceOutputMessage' file_search_call: '#/components/schemas/OpenAI.ItemResourceFileSearchToolCall' computer_call: '#/components/schemas/OpenAI.ItemResourceComputerToolCall' - computer_call_output: '#/components/schemas/OpenAI.ItemResourceComputerToolCallOutputResource' + computer_call_output: '#/components/schemas/OpenAI.ItemResourceComputerToolCallOutput' web_search_call: '#/components/schemas/OpenAI.ItemResourceWebSearchToolCall' - function_call: '#/components/schemas/OpenAI.ItemResourceFunctionToolCallResource' - function_call_output: '#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutputResource' + function_call: '#/components/schemas/OpenAI.ItemResourceFunctionToolCall' + function_call_output: '#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutput' + tool_search_call: '#/components/schemas/OpenAI.ItemResourceToolSearchCall' + tool_search_output: '#/components/schemas/OpenAI.ItemResourceToolSearchOutput' + additional_tools: '#/components/schemas/OpenAI.ItemResourceAdditionalTools' + reasoning: '#/components/schemas/OpenAI.ItemResourceReasoningItem' + compaction: '#/components/schemas/OpenAI.ItemResourceCompactionBody' image_generation_call: '#/components/schemas/OpenAI.ItemResourceImageGenToolCall' code_interpreter_call: '#/components/schemas/OpenAI.ItemResourceCodeInterpreterToolCall' local_shell_call: '#/components/schemas/OpenAI.ItemResourceLocalShellToolCall' @@ -25495,7 +27391,38 @@ components: mcp_approval_request: '#/components/schemas/OpenAI.ItemResourceMcpApprovalRequest' mcp_approval_response: '#/components/schemas/OpenAI.ItemResourceMcpApprovalResponseResource' mcp_call: '#/components/schemas/OpenAI.ItemResourceMcpToolCall' + custom_tool_call: '#/components/schemas/OpenAI.ItemResourceCustomToolCallResource' + custom_tool_call_output: '#/components/schemas/OpenAI.ItemResourceCustomToolCallOutputResource' description: Content item used to generate a response. + OpenAI.ItemResourceAdditionalTools: + type: object + required: + - type + - id + - role + - tools + properties: + type: + type: string + enum: + - additional_tools + description: The type of the item. Always `additional_tools`. + x-stainless-const: true + default: additional_tools + id: + type: string + description: The unique ID of the additional tools item. + role: + allOf: + - $ref: '#/components/schemas/OpenAI.MessageRole' + description: The role that provided the additional tools. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The additional tool definitions made available at this item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' OpenAI.ItemResourceApplyPatchToolCall: type: object required: @@ -25560,8 +27487,9 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call output. @@ -25602,26 +27530,54 @@ components: type: string description: The ID of the container used to run the code. code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' outputs: - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - nullable: true + anyOf: + - type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: A tool call to run code. title: Code interpreter tool call + OpenAI.ItemResourceCompactionBody: + type: object + required: + - type + - id + - encrypted_content + properties: + type: + type: string + enum: + - compaction + description: The type of the item. Always `compaction`. + x-stainless-const: true + default: compaction + id: + type: string + description: The unique ID of the compaction item. + encrypted_content: + type: string + description: The encrypted content that was produced by compaction. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' + description: A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact). + title: Compaction item OpenAI.ItemResourceComputerToolCall: type: object required: - type - id - call_id - - action - pending_safety_checks - status properties: @@ -25639,6 +27595,8 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' + actions: + $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -25659,10 +27617,11 @@ components: A tool call to a computer use tool. See the [computer use guide](/docs/guides/tools-computer-use) for more information. title: Computer tool call - OpenAI.ItemResourceComputerToolCallOutputResource: + OpenAI.ItemResourceComputerToolCallOutput: type: object required: - type + - id - call_id - output properties: @@ -25676,6 +27635,7 @@ components: id: type: string description: The ID of the computer tool call output. + readOnly: true call_id: type: string description: The ID of the computer tool call that produced the output. @@ -25699,6 +27659,91 @@ components: `incomplete`. Populated when input items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' + description: The output of a computer tool call. + title: Computer tool call output + OpenAI.ItemResourceCustomToolCallOutputResource: + type: object + required: + - type + - call_id + - output + - status + properties: + type: + type: string + enum: + - custom_tool_call_output + description: The type of the custom tool call output. Always `custom_tool_call_output`. + x-stainless-const: true + id: + type: string + description: The unique ID of the custom tool call output in the OpenAI platform. + call_id: + type: string + description: The call ID, used to map this custom tool call output to a custom tool call. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' + title: ResponseCustomToolCallOutputItem + OpenAI.ItemResourceCustomToolCallResource: + type: object + required: + - type + - call_id + - name + - input + - status + properties: + type: + type: string + enum: + - custom_tool_call + description: The type of the custom tool call. Always `custom_tool_call`. + x-stainless-const: true + id: + type: string + description: The unique ID of the custom tool call in the OpenAI platform. + call_id: + type: string + description: An identifier used to map this custom tool call to a tool call output. + namespace: + type: string + description: The namespace of the custom tool being called. + name: + type: string + description: The name of the custom tool being called. + input: + type: string + description: The input for the custom tool call generated by the model. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' + title: ResponseCustomToolCallItem OpenAI.ItemResourceFileSearchToolCall: type: object required: @@ -25733,10 +27778,11 @@ components: type: string description: The queries used to search for files. results: - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: |- @@ -25772,13 +27818,12 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - nullable: true + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call. @@ -25811,7 +27856,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -25819,10 +27864,9 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' created_by: type: string description: The identifier of the actor that created the item. @@ -25830,36 +27874,37 @@ components: - $ref: '#/components/schemas/OpenAI.ItemResource' description: The output of a shell tool call that was emitted. title: Shell call output - OpenAI.ItemResourceFunctionToolCallOutputResource: + OpenAI.ItemResourceFunctionToolCall: type: object required: + - id - type - call_id - - output + - name + - arguments properties: id: type: string - description: |- - The unique ID of the function tool call output. Populated when this item - is returned via API. + description: The unique ID of the function tool call. + readOnly: true type: type: string enum: - - function_call_output - description: The type of the function tool call output. Always `function_call_output`. + - function_call + description: The type of the function tool call. Always `function_call`. x-stainless-const: true call_id: type: string description: The unique ID of the function tool call generated by the model. - output: - oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' - description: |- - The output from the function call generated by your code. - Can be a string or an list of output content. + namespace: + type: string + description: The namespace of the function to run. + name: + type: string + description: The name of the function to run. + arguments: + type: string + description: A JSON string of the arguments to pass to the function. status: type: string enum: @@ -25871,32 +27916,42 @@ components: `incomplete`. Populated when items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' - OpenAI.ItemResourceFunctionToolCallResource: + description: |- + A tool call to run a function. See the + [function calling guide](/docs/guides/function-calling) for more information. + title: Function tool call + OpenAI.ItemResourceFunctionToolCallOutput: type: object required: + - id - type - call_id - - name - - arguments + - output properties: id: type: string - description: The unique ID of the function tool call. + description: |- + The unique ID of the function tool call output. Populated when this item + is returned via API. + readOnly: true type: type: string enum: - - function_call - description: The type of the function tool call. Always `function_call`. + - function_call_output + description: The type of the function tool call output. Always `function_call_output`. x-stainless-const: true call_id: type: string description: The unique ID of the function tool call generated by the model. - name: - type: string - description: The name of the function to run. - arguments: - type: string - description: A JSON string of the arguments to pass to the function. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the function call generated by your code. + Can be a string or an list of output content. status: type: string enum: @@ -25908,6 +27963,8 @@ components: `incomplete`. Populated when items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' + description: The output of a function tool call. + title: Function tool call output OpenAI.ItemResourceImageGenToolCall: type: object required: @@ -25934,12 +27991,57 @@ components: - failed description: The status of the image generation call. result: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: An image generation request made by the model. title: Image generation call + OpenAI.ItemResourceInputMessage: + type: object + required: + - type + - role + - content + - id + properties: + type: + type: string + enum: + - message + description: The type of the message input. Always set to `message`. + x-stainless-const: true + default: message + role: + type: string + enum: + - user + - system + - developer + description: The role of the message input. One of `user`, `system`, or `developer`. + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + content: + $ref: '#/components/schemas/OpenAI.InputMessageContentList' + id: + type: string + description: The unique ID of the message input. + readOnly: true + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' + description: |- + A message input to the model with a role indicating instruction following + hierarchy. Instructions given with the `developer` or `system` role take + precedence over instructions given with the `user` role. + title: Input message OpenAI.ItemResourceLocalShellToolCall: type: object required: @@ -25994,12 +28096,13 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - type: string - enum: - - in_progress - - completed - - incomplete - nullable: true + anyOf: + - type: string + enum: + - in_progress + - completed + - incomplete + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: The output of a local shell tool call. @@ -26059,8 +28162,9 @@ components: type: boolean description: Whether the request was approved. reason: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: A response to an MCP approval request. @@ -26091,8 +28195,7 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - type: string - nullable: true + $ref: '#/components/schemas/OpenAI.RealtimeMCPError' allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: A list of tools available on an MCP server. @@ -26125,18 +28228,20 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' error: type: object - additionalProperties: {} + unevaluatedProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: An invocation of a tool on an MCP server. @@ -26170,6 +28275,10 @@ components: items: $ref: '#/components/schemas/OpenAI.OutputMessageContent' description: The content of the output message. + phase: + anyOf: + - $ref: '#/components/schemas/OpenAI.MessagePhase' + - type: 'null' status: type: string enum: @@ -26183,6 +28292,134 @@ components: - $ref: '#/components/schemas/OpenAI.ItemResource' description: An output message from the model. title: Output message + OpenAI.ItemResourceReasoningItem: + type: object + required: + - type + - id + - summary + properties: + type: + type: string + enum: + - reasoning + description: The type of the object. Always `reasoning`. + x-stainless-const: true + id: + type: string + description: The unique identifier of the reasoning content. + encrypted_content: + anyOf: + - type: string + - type: 'null' + summary: + type: array + items: + $ref: '#/components/schemas/OpenAI.SummaryTextContent' + description: Reasoning summary content. + content: + type: array + items: + $ref: '#/components/schemas/OpenAI.ReasoningTextContent' + description: Reasoning text content. + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' + description: |- + A description of the chain of thought used by a reasoning model while generating + a response. Be sure to include these items in your `input` to the Responses API + for subsequent turns of a conversation if you are manually + [managing context](/docs/guides/conversation-state). + title: Reasoning + OpenAI.ItemResourceToolSearchCall: + type: object + required: + - type + - id + - call_id + - execution + - arguments + - status + properties: + type: + type: string + enum: + - tool_search_call + description: The type of the item. Always `tool_search_call`. + x-stainless-const: true + default: tool_search_call + id: + type: string + description: The unique ID of the tool search call item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + arguments: + description: Arguments used for the tool search call. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' + description: The status of the tool search call item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' + OpenAI.ItemResourceToolSearchOutput: + type: object + required: + - type + - id + - call_id + - execution + - tools + - status + properties: + type: + type: string + enum: + - tool_search_output + description: The type of the item. Always `tool_search_output`. + x-stainless-const: true + default: tool_search_output + id: + type: string + description: The unique ID of the tool search output item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The loaded tool definitions returned by tool search. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' + description: The status of the tool search output item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' OpenAI.ItemResourceType: anyOf: - type: string @@ -26196,6 +28433,11 @@ components: - web_search_call - function_call - function_call_output + - tool_search_call + - tool_search_output + - additional_tools + - reasoning + - compaction - image_generation_call - code_interpreter_call - local_shell_call @@ -26208,6 +28450,8 @@ components: - mcp_approval_request - mcp_approval_response - mcp_call + - custom_tool_call + - custom_tool_call_output - structured_outputs - oauth_consent_request - memory_search_call @@ -26271,6 +28515,77 @@ components: The results of a web search tool call. See the [web search guide](/docs/guides/tools-web-search) for more information. title: Web search tool call + OpenAI.ItemToolSearchCallItemParam: + type: object + required: + - type + - arguments + properties: + id: + anyOf: + - type: string + - type: 'null' + call_id: + anyOf: + - type: string + - type: 'null' + type: + type: string + enum: + - tool_search_call + description: The item type. Always `tool_search_call`. + x-stainless-const: true + default: tool_search_call + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + arguments: + allOf: + - $ref: '#/components/schemas/OpenAI.EmptyModelParam' + description: The arguments supplied to the tool search call. + status: + anyOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' + - type: 'null' + allOf: + - $ref: '#/components/schemas/OpenAI.Item' + OpenAI.ItemToolSearchOutputItemParam: + type: object + required: + - type + - tools + properties: + id: + anyOf: + - type: string + - type: 'null' + call_id: + anyOf: + - type: string + - type: 'null' + type: + type: string + enum: + - tool_search_output + description: The item type. Always `tool_search_output`. + x-stainless-const: true + default: tool_search_output + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The loaded tool definitions returned by the tool search output. + status: + anyOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' + - type: 'null' + allOf: + - $ref: '#/components/schemas/OpenAI.Item' OpenAI.ItemType: anyOf: - type: string @@ -26284,6 +28599,9 @@ components: - web_search_call - function_call - function_call_output + - tool_search_call + - tool_search_output + - additional_tools - reasoning - compaction - image_generation_call @@ -26375,7 +28693,6 @@ components: - keypress description: Specifies the event type. For a keypress action, this property is always set to `keypress`. x-stainless-const: true - default: keypress keys: type: array items: @@ -26403,11 +28720,13 @@ components: - list x-stainless-const: true first_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' last_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' x-ms-list-continuation-token: true has_more: type: boolean @@ -26460,23 +28779,10 @@ components: - local description: The environment type. Always `local`. x-stainless-const: true - default: local allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' description: Represents the use of a local environment to perform shell actions. title: Local Environment - OpenAI.LocalShellCallOutputStatusEnum: - type: string - enum: - - in_progress - - completed - - incomplete - OpenAI.LocalShellCallStatus: - type: string - enum: - - in_progress - - completed - - incomplete OpenAI.LocalShellExecAction: type: object required: @@ -26497,22 +28803,23 @@ components: type: string description: The command to run. timeout_ms: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' working_directory: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' env: type: object - additionalProperties: + unevaluatedProperties: type: string description: Environment variables to set for the command. x-oaiTypeLabel: map user: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' description: Execute a shell command on the server. title: Local shell exec action OpenAI.LocalShellToolParam: @@ -26526,7 +28833,6 @@ components: - local_shell description: The type of the local shell tool. Always `local_shell`. x-stainless-const: true - default: local_shell name: type: string description: Optional user-defined name for this tool or configuration. @@ -26585,17 +28891,17 @@ components: type: string description: The name of the tool. description: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' input_schema: allOf: - $ref: '#/components/schemas/OpenAI.MCPListToolsToolInputSchema' description: The JSON schema describing the tool's input. annotations: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.MCPListToolsToolAnnotations' - nullable: true + - type: 'null' description: A tool available on an MCP server. title: MCP list tools tool OpenAI.MCPListToolsToolAnnotations: @@ -26657,32 +28963,30 @@ components: type: string description: Optional description of the MCP server, used to provide more context. headers: - type: object - additionalProperties: - type: string - nullable: true + anyOf: + - type: object + unevaluatedProperties: + type: string + - type: 'null' allowed_tools: anyOf: - type: array items: type: string - nullable: true - - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.MCPToolFilter' - nullable: true + - $ref: '#/components/schemas/OpenAI.MCPToolFilter' + - type: 'null' require_approval: anyOf: - - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' - nullable: true + - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' - type: string enum: - always - never - nullable: true + - type: 'null' default: always + defer_loading: + type: boolean + description: Whether this MCP tool is deferred and discovered via tool search. project_connection_id: type: string description: The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server. @@ -26742,6 +29046,7 @@ components: refusal: '#/components/schemas/OpenAI.MessageContentRefusalContent' input_image: '#/components/schemas/OpenAI.MessageContentInputImageContent' input_file: '#/components/schemas/OpenAI.MessageContentInputFileContent' + summary_text: '#/components/schemas/OpenAI.SummaryTextContent' description: A content part that makes up an input or output item. OpenAI.MessageContentInputFileContent: type: object @@ -26756,18 +29061,23 @@ components: x-stainless-const: true default: input_file file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' filename: type: string description: The name of the file to be sent to the model. + file_data: + type: string + description: The content of the file to be sent to the model. file_url: type: string format: uri description: The URL of the file to be sent to the model. - file_data: - type: string - description: The content of the file to be sent to the model. + detail: + allOf: + - $ref: '#/components/schemas/OpenAI.FileInputDetail' + description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. allOf: - $ref: '#/components/schemas/OpenAI.MessageContent' description: A file input to the model. @@ -26786,16 +29096,18 @@ components: x-stainless-const: true default: input_image image_url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. allOf: - $ref: '#/components/schemas/OpenAI.MessageContent' description: An image input to the model. Learn about [image inputs](/docs/guides/vision). @@ -26905,6 +29217,15 @@ components: - input_image - computer_screenshot - input_file + OpenAI.MessagePhase: + type: string + enum: + - commentary + - final_answer + description: |- + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. OpenAI.MessageRole: type: string enum: @@ -26924,7 +29245,7 @@ components: - incomplete OpenAI.Metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -26935,13 +29256,9 @@ components: x-oaiTypeLabel: map OpenAI.ModelIdsCompaction: anyOf: - - allOf: - - $ref: '#/components/schemas/OpenAI.ModelIdsResponses' - description: Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models. - nullable: true + - $ref: '#/components/schemas/OpenAI.ModelIdsResponses' - type: string - description: Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models. - nullable: true + - type: 'null' description: Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models. OpenAI.ModelIdsResponses: anyOf: @@ -26966,6 +29283,125 @@ components: anyOf: - type: string - $ref: '#/components/schemas/OpenAI.ChatModel' + OpenAI.Moderation: + type: object + required: + - input + - output + properties: + input: + allOf: + - $ref: '#/components/schemas/OpenAI.ModerationEntry' + description: Moderation for the response input. + output: + allOf: + - $ref: '#/components/schemas/OpenAI.ModerationEntry' + description: Moderation for the response output. + description: Moderation results or errors for the response input and output. + title: Moderation + OpenAI.ModerationEntry: + type: object + required: + - type + properties: + type: + $ref: '#/components/schemas/OpenAI.ModerationEntryType' + discriminator: + propertyName: type + mapping: + moderation_result: '#/components/schemas/OpenAI.ModerationResultBody' + error: '#/components/schemas/OpenAI.ModerationErrorBody' + description: Moderation results or an error for a response moderation check. + OpenAI.ModerationEntryType: + anyOf: + - type: string + - type: string + enum: + - moderation_result + - error + OpenAI.ModerationErrorBody: + type: object + required: + - type + - code + - message + properties: + type: + type: string + enum: + - error + description: The object type, which was always `error` for moderation failures. + x-stainless-const: true + code: + type: string + description: The error code. + message: + type: string + description: The error message. + allOf: + - $ref: '#/components/schemas/OpenAI.ModerationEntry' + description: An error produced while attempting moderation for the response input or output. + title: Moderation error + OpenAI.ModerationInputType: + type: string + enum: + - text + - image + OpenAI.ModerationParam: + type: object + required: + - model + properties: + model: + type: string + description: The moderation model to use for moderated completions, e.g. 'omni-moderation-latest'. + description: Configuration for running moderation on the input and output of this response. + OpenAI.ModerationResultBody: + type: object + required: + - type + - model + - flagged + - categories + - category_scores + - category_applied_input_types + properties: + type: + type: string + enum: + - moderation_result + description: The object type, which was always `moderation_result` for successful moderation results. + x-stainless-const: true + model: + type: string + description: The moderation model that produced this result. + flagged: + type: boolean + description: A boolean indicating whether the content was flagged by any category. + categories: + type: object + unevaluatedProperties: + type: boolean + description: A dictionary of moderation categories to booleans, True if the input is flagged under this category. + x-oaiTypeLabel: map + category_scores: + type: object + unevaluatedProperties: + $ref: '#/components/schemas/OpenAI.numeric' + description: A dictionary of moderation categories to scores. + x-oaiTypeLabel: map + category_applied_input_types: + type: object + unevaluatedProperties: + type: array + items: + $ref: '#/components/schemas/OpenAI.ModerationInputType' + description: Which modalities of input are reflected by the score for each category. + x-oaiTypeLabel: map + allOf: + - $ref: '#/components/schemas/OpenAI.ModerationEntry' + description: A moderation result produced for the response input or output. + title: Moderation result OpenAI.MoveParam: type: object required: @@ -26979,7 +29415,6 @@ components: - move description: Specifies the event type. For a move action, this property is always set to `move`. x-stainless-const: true - default: move x: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -26988,10 +29423,50 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The y-coordinate to move to. + keys: + anyOf: + - type: array + items: + type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A mouse move action. title: Move + OpenAI.NamespaceToolParam: + type: object + required: + - type + - name + - description + - tools + properties: + type: + type: string + enum: + - namespace + description: The type of the tool. Always `namespace`. + x-stainless-const: true + name: + type: string + minLength: 1 + description: The namespace name used in tool calls (for example, `crm`). + description: + type: string + minLength: 1 + description: A description of the namespace shown to the model. + tools: + type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.FunctionToolParam' + - $ref: '#/components/schemas/OpenAI.CustomToolParam' + minItems: 1 + description: The function/custom tools available inside this namespace. + allOf: + - $ref: '#/components/schemas/OpenAI.Tool' + description: Groups function/custom tools under a shared namespace. + title: Namespace OpenAI.OutputContent: type: object required: @@ -27128,13 +29603,19 @@ components: output_message: '#/components/schemas/OpenAI.OutputItemOutputMessage' file_search_call: '#/components/schemas/OpenAI.OutputItemFileSearchToolCall' function_call: '#/components/schemas/OpenAI.OutputItemFunctionToolCall' + function_call_output: '#/components/schemas/OpenAI.OutputItemFunctionToolCallOutput' web_search_call: '#/components/schemas/OpenAI.OutputItemWebSearchToolCall' computer_call: '#/components/schemas/OpenAI.OutputItemComputerToolCall' + computer_call_output: '#/components/schemas/OpenAI.OutputItemComputerToolCallOutput' reasoning: '#/components/schemas/OpenAI.OutputItemReasoningItem' + tool_search_call: '#/components/schemas/OpenAI.OutputItemToolSearchCall' + tool_search_output: '#/components/schemas/OpenAI.OutputItemToolSearchOutput' + additional_tools: '#/components/schemas/OpenAI.OutputItemAdditionalTools' compaction: '#/components/schemas/OpenAI.OutputItemCompactionBody' image_generation_call: '#/components/schemas/OpenAI.OutputItemImageGenToolCall' code_interpreter_call: '#/components/schemas/OpenAI.OutputItemCodeInterpreterToolCall' local_shell_call: '#/components/schemas/OpenAI.OutputItemLocalShellToolCall' + local_shell_call_output: '#/components/schemas/OpenAI.OutputItemLocalShellToolCallOutput' shell_call: '#/components/schemas/OpenAI.OutputItemFunctionShellCall' shell_call_output: '#/components/schemas/OpenAI.OutputItemFunctionShellCallOutput' apply_patch_call: '#/components/schemas/OpenAI.OutputItemApplyPatchToolCall' @@ -27142,7 +29623,38 @@ components: mcp_call: '#/components/schemas/OpenAI.OutputItemMcpToolCall' mcp_list_tools: '#/components/schemas/OpenAI.OutputItemMcpListTools' mcp_approval_request: '#/components/schemas/OpenAI.OutputItemMcpApprovalRequest' - custom_tool_call: '#/components/schemas/OpenAI.OutputItemCustomToolCall' + mcp_approval_response: '#/components/schemas/OpenAI.OutputItemMcpApprovalResponseResource' + custom_tool_call: '#/components/schemas/OpenAI.OutputItemCustomToolCallResource' + custom_tool_call_output: '#/components/schemas/OpenAI.OutputItemCustomToolCallOutputResource' + OpenAI.OutputItemAdditionalTools: + type: object + required: + - type + - id + - role + - tools + properties: + type: + type: string + enum: + - additional_tools + description: The type of the item. Always `additional_tools`. + x-stainless-const: true + default: additional_tools + id: + type: string + description: The unique ID of the additional tools item. + role: + allOf: + - $ref: '#/components/schemas/OpenAI.MessageRole' + description: The role that provided the additional tools. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The additional tool definitions made available at this item. + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' OpenAI.OutputItemApplyPatchToolCall: type: object required: @@ -27207,8 +29719,9 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call output. @@ -27249,15 +29762,17 @@ components: type: string description: The ID of the container used to run the code. code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' outputs: - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - nullable: true + anyOf: + - type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: A tool call to run code. @@ -27295,7 +29810,6 @@ components: - type - id - call_id - - action - pending_safety_checks - status properties: @@ -27313,6 +29827,8 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' + actions: + $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -27333,13 +29849,99 @@ components: A tool call to a computer use tool. See the [computer use guide](/docs/guides/tools-computer-use) for more information. title: Computer tool call - OpenAI.OutputItemCustomToolCall: + OpenAI.OutputItemComputerToolCallOutput: + type: object + required: + - type + - id + - call_id + - output + properties: + type: + type: string + enum: + - computer_call_output + description: The type of the computer tool call output. Always `computer_call_output`. + x-stainless-const: true + default: computer_call_output + id: + type: string + description: The ID of the computer tool call output. + readOnly: true + call_id: + type: string + description: The ID of the computer tool call that produced the output. + acknowledged_safety_checks: + type: array + items: + $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' + description: |- + The safety checks reported by the API that have been acknowledged by the + developer. + output: + $ref: '#/components/schemas/OpenAI.ComputerScreenshotImage' + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' + description: The output of a computer tool call. + title: Computer tool call output + OpenAI.OutputItemCustomToolCallOutputResource: + type: object + required: + - type + - call_id + - output + - status + properties: + type: + type: string + enum: + - custom_tool_call_output + description: The type of the custom tool call output. Always `custom_tool_call_output`. + x-stainless-const: true + id: + type: string + description: The unique ID of the custom tool call output in the OpenAI platform. + call_id: + type: string + description: The call ID, used to map this custom tool call output to a custom tool call. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' + title: ResponseCustomToolCallOutputItem + OpenAI.OutputItemCustomToolCallResource: type: object required: - type - call_id - name - input + - status properties: type: type: string @@ -27353,16 +29955,27 @@ components: call_id: type: string description: An identifier used to map this custom tool call to a tool call output. + namespace: + type: string + description: The namespace of the custom tool being called. name: type: string description: The name of the custom tool being called. input: type: string description: The input for the custom tool call generated by the model. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + created_by: + type: string + description: The identifier of the actor that created the item. allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' - description: A call to a custom tool created by the model. - title: Custom tool call + title: ResponseCustomToolCallItem OpenAI.OutputItemFileSearchToolCall: type: object required: @@ -27397,10 +30010,11 @@ components: type: string description: The queries used to search for files. results: - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: |- @@ -27436,13 +30050,12 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - nullable: true + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call. @@ -27475,7 +30088,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -27483,10 +30096,9 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' created_by: type: string description: The identifier of the actor that created the item. @@ -27497,6 +30109,7 @@ components: OpenAI.OutputItemFunctionToolCall: type: object required: + - id - type - call_id - name @@ -27505,6 +30118,7 @@ components: id: type: string description: The unique ID of the function tool call. + readOnly: true type: type: string enum: @@ -27514,6 +30128,9 @@ components: call_id: type: string description: The unique ID of the function tool call generated by the model. + namespace: + type: string + description: The namespace of the function to run. name: type: string description: The name of the function to run. @@ -27535,6 +30152,51 @@ components: A tool call to run a function. See the [function calling guide](/docs/guides/function-calling) for more information. title: Function tool call + OpenAI.OutputItemFunctionToolCallOutput: + type: object + required: + - id + - type + - call_id + - output + properties: + id: + type: string + description: |- + The unique ID of the function tool call output. Populated when this item + is returned via API. + readOnly: true + type: + type: string + enum: + - function_call_output + description: The type of the function tool call output. Always `function_call_output`. + x-stainless-const: true + call_id: + type: string + description: The unique ID of the function tool call generated by the model. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the function call generated by your code. + Can be a string or an list of output content. + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' + description: The output of a function tool call. + title: Function tool call output OpenAI.OutputItemImageGenToolCall: type: object required: @@ -27561,8 +30223,9 @@ components: - failed description: The status of the image generation call. result: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: An image generation request made by the model. @@ -27601,6 +30264,37 @@ components: - $ref: '#/components/schemas/OpenAI.OutputItem' description: A tool call to run a command on the local shell. title: Local shell call + OpenAI.OutputItemLocalShellToolCallOutput: + type: object + required: + - type + - id + - output + properties: + type: + type: string + enum: + - local_shell_call_output + description: The type of the local shell tool call output. Always `local_shell_call_output`. + x-stainless-const: true + id: + type: string + description: The unique ID of the local shell tool call generated by the model. + output: + type: string + description: A JSON string of the output of the local shell tool call. + status: + anyOf: + - type: string + enum: + - in_progress + - completed + - incomplete + - type: 'null' + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' + description: The output of a local shell tool call. + title: Local shell call output OpenAI.OutputItemMcpApprovalRequest: type: object required: @@ -27632,6 +30326,37 @@ components: - $ref: '#/components/schemas/OpenAI.OutputItem' description: A request for human approval of a tool invocation. title: MCP approval request + OpenAI.OutputItemMcpApprovalResponseResource: + type: object + required: + - type + - id + - approval_request_id + - approve + properties: + type: + type: string + enum: + - mcp_approval_response + description: The type of the item. Always `mcp_approval_response`. + x-stainless-const: true + id: + type: string + description: The unique ID of the approval response + approval_request_id: + type: string + description: The ID of the approval request being answered. + approve: + type: boolean + description: Whether the request was approved. + reason: + anyOf: + - type: string + - type: 'null' + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' + description: A response to an MCP approval request. + title: MCP approval response OpenAI.OutputItemMcpListTools: type: object required: @@ -27658,8 +30383,7 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - type: string - nullable: true + $ref: '#/components/schemas/OpenAI.RealtimeMCPError' allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: A list of tools available on an MCP server. @@ -27692,18 +30416,20 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' error: type: object - additionalProperties: {} + unevaluatedProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: An invocation of a tool on an MCP server. @@ -27737,6 +30463,10 @@ components: items: $ref: '#/components/schemas/OpenAI.OutputMessageContent' description: The content of the output message. + phase: + anyOf: + - $ref: '#/components/schemas/OpenAI.MessagePhase' + - type: 'null' status: type: string enum: @@ -27767,8 +30497,9 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' summary: type: array items: @@ -27796,6 +30527,87 @@ components: for subsequent turns of a conversation if you are manually [managing context](/docs/guides/conversation-state). title: Reasoning + OpenAI.OutputItemToolSearchCall: + type: object + required: + - type + - id + - call_id + - execution + - arguments + - status + properties: + type: + type: string + enum: + - tool_search_call + description: The type of the item. Always `tool_search_call`. + x-stainless-const: true + default: tool_search_call + id: + type: string + description: The unique ID of the tool search call item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + arguments: + description: Arguments used for the tool search call. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' + description: The status of the tool search call item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' + OpenAI.OutputItemToolSearchOutput: + type: object + required: + - type + - id + - call_id + - execution + - tools + - status + properties: + type: + type: string + enum: + - tool_search_output + description: The type of the item. Always `tool_search_output`. + x-stainless-const: true + default: tool_search_output + id: + type: string + description: The unique ID of the tool search output item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The loaded tool definitions returned by tool search. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' + description: The status of the tool search output item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' OpenAI.OutputItemType: anyOf: - type: string @@ -27804,13 +30616,19 @@ components: - output_message - file_search_call - function_call + - function_call_output - web_search_call - computer_call + - computer_call_output - reasoning + - tool_search_call + - tool_search_output + - additional_tools - compaction - image_generation_call - code_interpreter_call - local_shell_call + - local_shell_call_output - shell_call - shell_call_output - apply_patch_call @@ -27818,7 +30636,9 @@ components: - mcp_call - mcp_list_tools - mcp_approval_request + - mcp_approval_response - custom_tool_call + - custom_tool_call_output - structured_outputs - oauth_consent_request - memory_search_call @@ -27961,16 +30781,21 @@ components: type: string description: The unique identifier of the prompt template to use. version: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' variables: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ResponsePromptVariables' - nullable: true + - type: 'null' description: |- Reference to a prompt template and its variables. [Learn more](/docs/guides/text?api-mode=responses#reusable-prompts). + OpenAI.PromptCacheRetentionEnum: + type: string + enum: + - in_memory + - 24h OpenAI.RankerVersionType: type: string enum: @@ -27991,39 +30816,118 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.HybridSearchOptions' description: Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + OpenAI.RealtimeMCPError: + type: object + required: + - type + properties: + type: + $ref: '#/components/schemas/OpenAI.RealtimeMcpErrorType' + discriminator: + propertyName: type + mapping: + protocol_error: '#/components/schemas/OpenAI.RealtimeMCPProtocolError' + tool_execution_error: '#/components/schemas/OpenAI.RealtimeMCPToolExecutionError' + http_error: '#/components/schemas/OpenAI.RealtimeMCPHTTPError' + OpenAI.RealtimeMCPHTTPError: + type: object + required: + - type + - code + - message + properties: + type: + type: string + enum: + - http_error + x-stainless-const: true + code: + $ref: '#/components/schemas/OpenAI.integer' + message: + type: string + allOf: + - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + title: Realtime MCP HTTP error + OpenAI.RealtimeMCPProtocolError: + type: object + required: + - type + - code + - message + properties: + type: + type: string + enum: + - protocol_error + x-stainless-const: true + code: + $ref: '#/components/schemas/OpenAI.integer' + message: + type: string + allOf: + - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + title: Realtime MCP protocol error + OpenAI.RealtimeMCPToolExecutionError: + type: object + required: + - type + - message + properties: + type: + type: string + enum: + - tool_execution_error + x-stainless-const: true + message: + type: string + allOf: + - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + title: Realtime MCP tool execution error + OpenAI.RealtimeMcpErrorType: + anyOf: + - type: string + - type: string + enum: + - protocol_error + - tool_execution_error + - http_error OpenAI.Reasoning: type: object properties: effort: $ref: '#/components/schemas/OpenAI.ReasoningEffort' summary: - type: string - enum: - - auto - - concise - - detailed - nullable: true + anyOf: + - type: string + enum: + - auto + - concise + - detailed + - type: 'null' generate_summary: - type: string - enum: - - auto - - concise - - detailed - nullable: true + anyOf: + - type: string + enum: + - auto + - concise + - detailed + - type: 'null' description: |- **gpt-5 and o-series models only** Configuration options for [reasoning models](https://platform.openai.com/docs/guides/reasoning). title: Reasoning OpenAI.ReasoningEffort: - type: string - enum: - - none - - minimal - - low - - medium - - high - - xhigh + anyOf: + - type: string + enum: + - none + - minimal + - low + - medium + - high + - xhigh + - type: 'null' description: |- Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). @@ -28034,7 +30938,6 @@ components: - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`. - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. - `xhigh` is supported for all models after `gpt-5.1-codex-max`. - nullable: true OpenAI.ReasoningTextContent: type: object required: @@ -28067,26 +30970,22 @@ components: - agent_reference properties: metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' top_logprobs: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' temperature: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' default: 1 top_p: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' default: 1 user: type: string @@ -28097,44 +30996,41 @@ components: deprecated: true safety_identifier: type: string + maxLength: 64 description: |- A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. - The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). + The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). prompt_cache_key: type: string description: Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching). service_tier: $ref: '#/components/schemas/OpenAI.ServiceTier' prompt_cache_retention: - type: string - enum: - - in-memory - - 24h - nullable: true + anyOf: + - type: string + enum: + - in_memory + - 24h + - type: 'null' previous_response_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' model: type: string description: The model deployment to use for the creation of this response. reasoning: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Reasoning' - nullable: true + - type: 'null' background: - type: boolean - nullable: true - max_output_tokens: - type: integer - allOf: - - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + anyOf: + - type: boolean + - type: 'null' max_tool_calls: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' text: $ref: '#/components/schemas/OpenAI.ResponseTextParam' tools: @@ -28146,11 +31042,12 @@ components: prompt: $ref: '#/components/schemas/OpenAI.Prompt' truncation: - type: string - enum: - - auto - - disabled - nullable: true + anyOf: + - type: string + enum: + - auto + - disabled + - type: 'null' default: disabled id: type: string @@ -28178,19 +31075,20 @@ components: format: unixtime description: Unix timestamp (in seconds) of when this Response was created. completed_at: + anyOf: + - type: string + format: date-time + - type: 'null' type: integer - format: unixtime - nullable: true + format: unixTimestamp error: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ResponseError' - nullable: true + - type: 'null' incomplete_details: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ResponseIncompleteDetails' - nullable: true + - type: 'null' output: type: array items: @@ -28209,26 +31107,33 @@ components: - type: array items: $ref: '#/components/schemas/OpenAI.InputItem' - nullable: true + - type: 'null' output_text: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' usage: $ref: '#/components/schemas/OpenAI.ResponseUsage' + moderation: + anyOf: + - $ref: '#/components/schemas/OpenAI.Moderation' + - type: 'null' parallel_tool_calls: type: boolean description: Whether to allow the model to run tool calls in parallel. default: true conversation: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ConversationReference' - nullable: true + - type: 'null' + max_output_tokens: + anyOf: + - $ref: '#/components/schemas/OpenAI.integer' + - type: 'null' agent_reference: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/AgentReference' - nullable: true + - type: 'null' description: The agent used for this response content_filters: type: array @@ -28255,8 +31160,10 @@ components: description: A sequence number for this chunk of the stream response. delta: type: string - format: base64 + contentEncoding: base64 description: A chunk of Base64 encoded response audio bytes. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a partial audio response. x-oaiMeta: name: response.audio.delta @@ -28284,6 +31191,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the delta. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the audio response is complete. x-oaiMeta: name: response.audio.done @@ -28314,6 +31223,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a partial transcript of audio. x-oaiMeta: name: response.audio.transcript.delta @@ -28341,6 +31252,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the full audio transcript is completed. x-oaiMeta: name: response.audio.transcript.done @@ -28380,6 +31293,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a partial code snippet is streamed by the code interpreter. x-oaiMeta: name: response.code_interpreter_call_code.delta @@ -28421,6 +31336,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the code snippet is finalized by the code interpreter. x-oaiMeta: name: response.code_interpreter_call_code.done @@ -28458,6 +31375,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the code interpreter call is completed. x-oaiMeta: name: response.code_interpreter_call.completed @@ -28494,6 +31413,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a code interpreter call is in progress. x-oaiMeta: name: response.code_interpreter_call.in_progress @@ -28530,6 +31451,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the code interpreter is actively interpreting the code snippet. x-oaiMeta: name: response.code_interpreter_call.interpreting @@ -28562,6 +31485,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number for this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the model response is complete. x-oaiMeta: name: response.completed @@ -28656,6 +31581,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a new content part is added. x-oaiMeta: name: response.content_part.added @@ -28708,6 +31635,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.OutputContent' description: The content part that is done. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a content part is done. x-oaiMeta: name: response.content_part.done @@ -28746,6 +31675,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number for this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: An event that is emitted when a response is created. x-oaiMeta: name: response.created @@ -28817,6 +31748,8 @@ components: delta: type: string description: The incremental input data (delta) for the custom tool call. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Event representing a delta (partial update) to the input of a custom tool call. title: ResponseCustomToolCallInputDelta x-oaiMeta: @@ -28858,6 +31791,8 @@ components: input: type: string description: The complete input data for the custom tool call. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Event indicating that input for a custom tool call is complete. title: ResponseCustomToolCallInputDone x-oaiMeta: @@ -28920,18 +31855,22 @@ components: description: The type of the event. Always `error`. x-stainless-const: true code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' message: type: string description: The error message. param: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' sequence_number: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an error occurs. x-oaiMeta: name: error @@ -28965,6 +31904,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.Response' description: The response that failed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: An event that is emitted when a response fails. x-oaiMeta: name: response.failed @@ -29030,6 +31971,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a file search call is completed (results found). x-oaiMeta: name: response.file_search_call.completed @@ -29066,6 +32009,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a file search call is initiated. x-oaiMeta: name: response.file_search_call.in_progress @@ -29102,6 +32047,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a file search is currently searching. x-oaiMeta: name: response.file_search_call.searching @@ -29165,11 +32112,12 @@ components: schema: $ref: '#/components/schemas/OpenAI.ResponseFormatJsonSchemaSchema' strict: - type: boolean - nullable: true + anyOf: + - type: boolean + - type: 'null' OpenAI.ResponseFormatJsonSchemaSchema: type: object - additionalProperties: {} + unevaluatedProperties: {} description: |- The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). @@ -29216,6 +32164,8 @@ components: delta: type: string description: The function-call arguments delta that is added. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a partial function-call arguments delta. x-oaiMeta: name: response.function_call_arguments.delta @@ -29260,6 +32210,8 @@ components: arguments: type: string description: The function-call arguments. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when function-call arguments are finalized. x-oaiMeta: name: response.function_call_arguments.done @@ -29298,6 +32250,8 @@ components: item_id: type: string description: The unique identifier of the image generation item being processed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an image generation tool call has completed and the final image is available. title: ResponseImageGenCallCompletedEvent x-oaiMeta: @@ -29335,6 +32289,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the image generation item being processed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an image generation tool call is actively generating an image (intermediate state). title: ResponseImageGenCallGeneratingEvent x-oaiMeta: @@ -29372,6 +32328,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the image generation item being processed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an image generation tool call is in progress. title: ResponseImageGenCallInProgressEvent x-oaiMeta: @@ -29418,6 +32376,8 @@ components: partial_image_b64: type: string description: Base64-encoded partial image data, suitable for rendering as an image. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a partial image is available during image generation streaming. title: ResponseImageGenCallPartialImageEvent x-oaiMeta: @@ -29453,6 +32413,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the response is in progress. x-oaiMeta: name: response.in_progress @@ -29524,6 +32486,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: An event that is emitted when a response finishes as incomplete. x-oaiMeta: name: response.incomplete @@ -29581,7 +32545,7 @@ components: type: array items: $ref: '#/components/schemas/OpenAI.ResponseLogProbTopLogprobs' - description: The log probability of the top 20 most likely tokens. + description: The log probabilities of up to 20 of the most likely tokens. description: |- A logprob is the logarithmic probability that the model assigns to producing a particular token at a given position in the sequence. Less-negative (higher) @@ -29622,6 +32586,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a delta (partial update) to the arguments of an MCP tool call. title: ResponseMCPCallArgumentsDeltaEvent x-oaiMeta: @@ -29664,6 +32630,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the arguments for an MCP tool call are finalized. title: ResponseMCPCallArgumentsDoneEvent x-oaiMeta: @@ -29702,6 +32670,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an MCP tool call has completed successfully. title: ResponseMCPCallCompletedEvent x-oaiMeta: @@ -29739,6 +32709,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an MCP tool call has failed. title: ResponseMCPCallFailedEvent x-oaiMeta: @@ -29776,6 +32748,8 @@ components: item_id: type: string description: The unique identifier of the MCP tool call item being processed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an MCP tool call is in progress. title: ResponseMCPCallInProgressEvent x-oaiMeta: @@ -29813,6 +32787,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the list of available MCP tools has been successfully retrieved. title: ResponseMCPListToolsCompletedEvent x-oaiMeta: @@ -29850,6 +32826,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the attempt to list available MCP tools has failed. title: ResponseMCPListToolsFailedEvent x-oaiMeta: @@ -29887,6 +32865,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the system is in the process of retrieving the list of available MCP tools. title: ResponseMCPListToolsInProgressEvent x-oaiMeta: @@ -29925,6 +32905,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: The output item that was added. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a new output item is added. x-oaiMeta: name: response.output_item.added @@ -29968,6 +32950,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: The output item that was marked done. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an output item is marked done. x-oaiMeta: name: response.output_item.done @@ -30031,6 +33015,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.Annotation' description: The annotation object being added. (See annotation schema for details.) + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an annotation is added to output text content. title: ResponseOutputTextAnnotationAddedEvent x-oaiMeta: @@ -30053,7 +33039,7 @@ components: } OpenAI.ResponsePromptVariables: type: object - additionalProperties: + unevaluatedProperties: anyOf: - type: string - $ref: '#/components/schemas/OpenAI.InputTextContent' @@ -30087,6 +33073,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number for this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a response is queued and waiting to be processed. title: ResponseQueuedEvent x-oaiMeta: @@ -30138,6 +33126,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.ResponseReasoningSummaryPartAddedEventPart' description: The summary part that was added. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a new reasoning summary part is added. x-oaiMeta: name: response.reasoning_summary_part.added @@ -30202,6 +33192,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.ResponseReasoningSummaryPartDoneEventPart' description: The completed summary part. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a reasoning summary part is completed. x-oaiMeta: name: response.reasoning_summary_part.done @@ -30267,6 +33259,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a delta is added to a reasoning summary text. x-oaiMeta: name: response.reasoning_summary_text.delta @@ -30316,6 +33310,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a reasoning summary text is completed. x-oaiMeta: name: response.reasoning_summary_text.done @@ -30365,6 +33361,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a delta is added to a reasoning text. x-oaiMeta: name: response.reasoning_text.delta @@ -30412,6 +33410,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a reasoning text is completed. x-oaiMeta: name: response.reasoning_text.done @@ -30459,6 +33459,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a partial refusal text. x-oaiMeta: name: response.refusal.delta @@ -30506,6 +33508,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when refusal text is finalized. x-oaiMeta: name: response.refusal.done @@ -30519,6 +33523,127 @@ components: "refusal": "final refusal text", "sequence_number": 1 } + OpenAI.ResponseStreamEvent: + type: object + required: + - type + properties: + type: + $ref: '#/components/schemas/OpenAI.ResponseStreamEventType' + discriminator: + propertyName: type + mapping: + response.audio.transcript.delta: '#/components/schemas/OpenAI.ResponseAudioTranscriptDeltaEvent' + response.code_interpreter_call_code.delta: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent' + response.code_interpreter_call.in_progress: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallInProgressEvent' + response.code_interpreter_call.interpreting: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallInterpretingEvent' + response.content_part.added: '#/components/schemas/OpenAI.ResponseContentPartAddedEvent' + response.created: '#/components/schemas/OpenAI.ResponseCreatedEvent' + error: '#/components/schemas/OpenAI.ResponseErrorEvent' + response.file_search_call.in_progress: '#/components/schemas/OpenAI.ResponseFileSearchCallInProgressEvent' + response.file_search_call.searching: '#/components/schemas/OpenAI.ResponseFileSearchCallSearchingEvent' + response.function_call_arguments.delta: '#/components/schemas/OpenAI.ResponseFunctionCallArgumentsDeltaEvent' + response.in_progress: '#/components/schemas/OpenAI.ResponseInProgressEvent' + response.failed: '#/components/schemas/OpenAI.ResponseFailedEvent' + response.incomplete: '#/components/schemas/OpenAI.ResponseIncompleteEvent' + response.output_item.added: '#/components/schemas/OpenAI.ResponseOutputItemAddedEvent' + response.reasoning_summary_part.added: '#/components/schemas/OpenAI.ResponseReasoningSummaryPartAddedEvent' + response.reasoning_summary_text.delta: '#/components/schemas/OpenAI.ResponseReasoningSummaryTextDeltaEvent' + response.reasoning_text.delta: '#/components/schemas/OpenAI.ResponseReasoningTextDeltaEvent' + response.refusal.delta: '#/components/schemas/OpenAI.ResponseRefusalDeltaEvent' + response.output_text.delta: '#/components/schemas/OpenAI.ResponseTextDeltaEvent' + response.web_search_call.in_progress: '#/components/schemas/OpenAI.ResponseWebSearchCallInProgressEvent' + response.web_search_call.searching: '#/components/schemas/OpenAI.ResponseWebSearchCallSearchingEvent' + response.image_generation_call.generating: '#/components/schemas/OpenAI.ResponseImageGenCallGeneratingEvent' + response.image_generation_call.in_progress: '#/components/schemas/OpenAI.ResponseImageGenCallInProgressEvent' + response.image_generation_call.partial_image: '#/components/schemas/OpenAI.ResponseImageGenCallPartialImageEvent' + response.mcp_call_arguments.delta: '#/components/schemas/OpenAI.ResponseMCPCallArgumentsDeltaEvent' + response.mcp_call.failed: '#/components/schemas/OpenAI.ResponseMCPCallFailedEvent' + response.mcp_call.in_progress: '#/components/schemas/OpenAI.ResponseMCPCallInProgressEvent' + response.mcp_list_tools.failed: '#/components/schemas/OpenAI.ResponseMCPListToolsFailedEvent' + response.mcp_list_tools.in_progress: '#/components/schemas/OpenAI.ResponseMCPListToolsInProgressEvent' + response.output_text.annotation.added: '#/components/schemas/OpenAI.ResponseOutputTextAnnotationAddedEvent' + response.queued: '#/components/schemas/OpenAI.ResponseQueuedEvent' + response.custom_tool_call_input.delta: '#/components/schemas/OpenAI.ResponseCustomToolCallInputDeltaEvent' + response.audio.done: '#/components/schemas/OpenAI.ResponseAudioDoneEvent' + response.audio.transcript.done: '#/components/schemas/OpenAI.ResponseAudioTranscriptDoneEvent' + response.code_interpreter_call_code.done: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallCodeDoneEvent' + response.code_interpreter_call.completed: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallCompletedEvent' + response.completed: '#/components/schemas/OpenAI.ResponseCompletedEvent' + response.content_part.done: '#/components/schemas/OpenAI.ResponseContentPartDoneEvent' + response.file_search_call.completed: '#/components/schemas/OpenAI.ResponseFileSearchCallCompletedEvent' + response.function_call_arguments.done: '#/components/schemas/OpenAI.ResponseFunctionCallArgumentsDoneEvent' + response.output_item.done: '#/components/schemas/OpenAI.ResponseOutputItemDoneEvent' + response.reasoning_summary_part.done: '#/components/schemas/OpenAI.ResponseReasoningSummaryPartDoneEvent' + response.reasoning_summary_text.done: '#/components/schemas/OpenAI.ResponseReasoningSummaryTextDoneEvent' + response.reasoning_text.done: '#/components/schemas/OpenAI.ResponseReasoningTextDoneEvent' + response.refusal.done: '#/components/schemas/OpenAI.ResponseRefusalDoneEvent' + response.output_text.done: '#/components/schemas/OpenAI.ResponseTextDoneEvent' + response.web_search_call.completed: '#/components/schemas/OpenAI.ResponseWebSearchCallCompletedEvent' + response.image_generation_call.completed: '#/components/schemas/OpenAI.ResponseImageGenCallCompletedEvent' + response.mcp_call_arguments.done: '#/components/schemas/OpenAI.ResponseMCPCallArgumentsDoneEvent' + response.mcp_call.completed: '#/components/schemas/OpenAI.ResponseMCPCallCompletedEvent' + response.mcp_list_tools.completed: '#/components/schemas/OpenAI.ResponseMCPListToolsCompletedEvent' + response.custom_tool_call_input.done: '#/components/schemas/OpenAI.ResponseCustomToolCallInputDoneEvent' + response.audio.delta: '#/components/schemas/OpenAI.ResponseAudioDeltaEvent' + OpenAI.ResponseStreamEventType: + anyOf: + - type: string + - type: string + enum: + - response.audio.delta + - response.audio.done + - response.audio.transcript.delta + - response.audio.transcript.done + - response.code_interpreter_call_code.delta + - response.code_interpreter_call_code.done + - response.code_interpreter_call.completed + - response.code_interpreter_call.in_progress + - response.code_interpreter_call.interpreting + - response.completed + - response.content_part.added + - response.content_part.done + - response.created + - error + - response.file_search_call.completed + - response.file_search_call.in_progress + - response.file_search_call.searching + - response.function_call_arguments.delta + - response.function_call_arguments.done + - response.in_progress + - response.failed + - response.incomplete + - response.output_item.added + - response.output_item.done + - response.reasoning_summary_part.added + - response.reasoning_summary_part.done + - response.reasoning_summary_text.delta + - response.reasoning_summary_text.done + - response.reasoning_text.delta + - response.reasoning_text.done + - response.refusal.delta + - response.refusal.done + - response.output_text.delta + - response.output_text.done + - response.web_search_call.completed + - response.web_search_call.in_progress + - response.web_search_call.searching + - response.image_generation_call.completed + - response.image_generation_call.generating + - response.image_generation_call.in_progress + - response.image_generation_call.partial_image + - response.mcp_call_arguments.delta + - response.mcp_call_arguments.done + - response.mcp_call.completed + - response.mcp_call.failed + - response.mcp_call.in_progress + - response.mcp_list_tools.completed + - response.mcp_list_tools.failed + - response.mcp_list_tools.in_progress + - response.output_text.annotation.added + - response.queued + - response.custom_tool_call_input.delta + - response.custom_tool_call_input.done OpenAI.ResponseStreamOptions: type: object properties: @@ -30573,6 +33698,8 @@ components: items: $ref: '#/components/schemas/OpenAI.ResponseLogProb' description: The log probabilities of the tokens in the delta. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is an additional text delta. x-oaiMeta: name: response.output_text.delta @@ -30626,6 +33753,8 @@ components: items: $ref: '#/components/schemas/OpenAI.ResponseLogProb' description: The log probabilities of the tokens in the delta. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when text content is finalized. x-oaiMeta: name: response.output_text.done @@ -30722,6 +33851,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the web search call being processed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a web search call is completed. x-oaiMeta: name: response.web_search_call.completed @@ -30758,6 +33889,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the web search call being processed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a web search call is initiated. x-oaiMeta: name: response.web_search_call.in_progress @@ -30794,6 +33927,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the web search call being processed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a web search call is executing. x-oaiMeta: name: response.web_search_call.searching @@ -30816,7 +33951,6 @@ components: - screenshot description: Specifies the event type. For a screenshot action, this property is always set to `screenshot`. x-stainless-const: true - default: screenshot allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A screenshot action. @@ -30836,7 +33970,6 @@ components: - scroll description: Specifies the event type. For a scroll action, this property is always set to `scroll`. x-stainless-const: true - default: scroll x: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -30853,10 +33986,21 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The vertical scroll distance. + keys: + anyOf: + - type: array + items: + type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A scroll action. title: Scroll + OpenAI.SearchContentType: + type: string + enum: + - text + - image OpenAI.SearchContextSize: type: string enum: @@ -30864,13 +34008,15 @@ components: - medium - high OpenAI.ServiceTier: - type: string - enum: - - auto - - default - - flex - - scale - - priority + anyOf: + - type: string + enum: + - auto + - default + - flex + - scale + - priority + - type: 'null' description: |- Specifies the processing type used for serving the request. - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. @@ -30878,7 +34024,13 @@ components: - If set to '[flex](/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier. - When not set, the default behavior is 'auto'. When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter. - nullable: true + OpenAI.ServiceTierEnum: + type: string + enum: + - auto + - default + - flex + - priority OpenAI.SkillReferenceParam: type: object required: @@ -30891,7 +34043,6 @@ components: - skill_reference description: References a skill created with the /v1/skills endpoint. x-stainless-const: true - default: skill_reference skill_id: type: string minLength: 1 @@ -30913,7 +34064,6 @@ components: - apply_patch description: The tool to call. Always `apply_patch`. x-stainless-const: true - default: apply_patch allOf: - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' description: Forces the model to call the apply_patch tool when executing a tool call. @@ -30929,7 +34079,6 @@ components: - shell description: The tool to call. Always `shell`. x-stainless-const: true - default: shell allOf: - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' description: Forces the model to call the shell tool when a tool call is required. @@ -30946,7 +34095,6 @@ components: - summary_text description: The type of the object. Always `summary_text`. x-stainless-const: true - default: summary_text text: type: string description: A summary of the reasoning output from the model so far. @@ -30965,7 +34113,6 @@ components: enum: - text x-stainless-const: true - default: text text: type: string allOf: @@ -31063,8 +34210,9 @@ components: schema: $ref: '#/components/schemas/OpenAI.ResponseFormatJsonSchemaSchema' strict: - type: boolean - nullable: true + anyOf: + - type: boolean + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.TextResponseFormatConfiguration' description: |- @@ -31106,6 +34254,9 @@ components: custom: '#/components/schemas/OpenAI.CustomToolParam' web_search_preview: '#/components/schemas/OpenAI.WebSearchPreviewTool' apply_patch: '#/components/schemas/OpenAI.ApplyPatchToolParam' + computer: '#/components/schemas/OpenAI.ComputerTool' + namespace: '#/components/schemas/OpenAI.NamespaceToolParam' + tool_search: '#/components/schemas/OpenAI.ToolSearchToolParam' description: A tool that can be used to generate a response. OpenAI.ToolChoiceAllowed: type: object @@ -31134,7 +34285,7 @@ components: type: array items: type: object - additionalProperties: {} + unevaluatedProperties: {} description: |- A list of tool definitions that the model should be allowed to call. For the Responses API, the list of tool definitions might look like: @@ -31163,6 +34314,34 @@ components: description: |- Indicates that the model should use a built-in tool to generate a response. [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools). + OpenAI.ToolChoiceComputer: + type: object + required: + - type + properties: + type: + type: string + enum: + - computer + allOf: + - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' + description: |- + Indicates that the model should use a built-in tool to generate a response. + [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools). + OpenAI.ToolChoiceComputerUse: + type: object + required: + - type + properties: + type: + type: string + enum: + - computer_use + allOf: + - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' + description: |- + Indicates that the model should use a built-in tool to generate a response. + [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools). OpenAI.ToolChoiceComputerUsePreview: type: object required: @@ -31259,8 +34438,9 @@ components: type: string description: The label of the MCP server to use. name: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' description: Use this option to force the model to call a specific tool on a remote MCP server. @@ -31300,6 +34480,8 @@ components: web_search_preview_2025_03_11: '#/components/schemas/OpenAI.ToolChoiceWebSearchPreview20250311' image_generation: '#/components/schemas/OpenAI.ToolChoiceImageGeneration' code_interpreter: '#/components/schemas/OpenAI.ToolChoiceCodeInterpreter' + computer: '#/components/schemas/OpenAI.ToolChoiceComputer' + computer_use: '#/components/schemas/OpenAI.ToolChoiceComputerUse' description: |- How the model should select which tool (or tools) to use when generating a response. See the `tools` parameter to see how to specify which tools @@ -31321,6 +34503,8 @@ components: - web_search_preview_2025_03_11 - image_generation - code_interpreter + - computer + - computer_use OpenAI.ToolChoiceWebSearchPreview: type: object required: @@ -31349,6 +34533,38 @@ components: description: |- Indicates that the model should use a built-in tool to generate a response. [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools). + OpenAI.ToolSearchExecutionType: + type: string + enum: + - server + - client + OpenAI.ToolSearchToolParam: + type: object + required: + - type + properties: + type: + type: string + enum: + - tool_search + description: The type of the tool. Always `tool_search`. + x-stainless-const: true + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search is executed by the server or by the client. + description: + anyOf: + - type: string + - type: 'null' + parameters: + anyOf: + - $ref: '#/components/schemas/OpenAI.EmptyModelParam' + - type: 'null' + allOf: + - $ref: '#/components/schemas/OpenAI.Tool' + description: Hosted or BYOT tool search configuration for deferred tools. + title: Tool search tool OpenAI.ToolType: anyOf: - type: string @@ -31356,6 +34572,7 @@ components: enum: - function - file_search + - computer - computer_use_preview - web_search - mcp @@ -31364,6 +34581,8 @@ components: - local_shell - shell - custom + - namespace + - tool_search - web_search_preview - apply_patch - a2a_preview @@ -31428,7 +34647,6 @@ components: - type description: Specifies the event type. For a type action, this property is always set to `type`. x-stainless-const: true - default: type text: type: string description: The text to type. @@ -31442,10 +34660,9 @@ components: - metadata properties: metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' description: |- Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. @@ -31464,7 +34681,6 @@ components: - url_citation description: The type of the URL citation. Always `url_citation`. x-stainless-const: true - default: url_citation url: type: string format: uri @@ -31486,7 +34702,7 @@ components: title: URL citation OpenAI.VectorStoreFileAttributes: type: object - additionalProperties: + unevaluatedProperties: anyOf: - type: string - $ref: '#/components/schemas/OpenAI.numeric' @@ -31499,16 +34715,17 @@ components: length of 512 characters, booleans, or numbers. x-oaiTypeLabel: map OpenAI.Verbosity: - type: string - enum: - - low - - medium - - high + anyOf: + - type: string + enum: + - low + - medium + - high + - type: 'null' description: |- Constrains the verbosity of the model's response. Lower values will result in more concise responses, while higher values will result in more verbose responses. Currently supported values are `low`, `medium`, and `high`. - nullable: true OpenAI.WaitParam: type: object required: @@ -31520,7 +34737,6 @@ components: - wait description: Specifies the event type. For a wait action, this property is always set to `wait`. x-stainless-const: true - default: wait allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A wait action. @@ -31559,9 +34775,10 @@ components: description: The action type. x-stainless-const: true url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' description: The URL opened by the model. description: Action type "open_page" - Opens a specific URL from search results. title: Open page action @@ -31569,7 +34786,6 @@ components: type: object required: - type - - query properties: type: type: string @@ -31579,7 +34795,7 @@ components: x-stainless-const: true query: type: string - description: '[DEPRECATED] The search query.' + description: The search query. deprecated: true queries: type: array @@ -31608,6 +34824,7 @@ components: x-stainless-const: true url: type: string + format: uri OpenAI.WebSearchApproximateLocation: type: object required: @@ -31621,17 +34838,21 @@ components: x-stainless-const: true default: approximate country: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' region: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' city: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' timezone: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' description: The approximate location of the user. title: Web search approximate location OpenAI.WebSearchPreviewTool: @@ -31645,16 +34866,18 @@ components: - web_search_preview description: The type of the web search tool. One of `web_search_preview` or `web_search_preview_2025_03_11`. x-stainless-const: true - default: web_search_preview user_location: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ApproximateLocation' - nullable: true + - type: 'null' search_context_size: allOf: - $ref: '#/components/schemas/OpenAI.SearchContextSize' description: High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default. + search_content_types: + type: array + items: + $ref: '#/components/schemas/OpenAI.SearchContentType' allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: This tool searches the web for relevant results to use in a response. Learn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search). @@ -31669,17 +34892,14 @@ components: enum: - web_search description: The type of the web search tool. One of `web_search` or `web_search_2025_08_26`. - default: web_search filters: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.WebSearchToolFilters' - nullable: true + - type: 'null' user_location: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.WebSearchApproximateLocation' - nullable: true + - type: 'null' search_context_size: type: string enum: @@ -31710,10 +34930,11 @@ components: type: object properties: allowed_domains: - type: array - items: - type: string - nullable: true + anyOf: + - type: array + items: + type: string + - type: 'null' OpenAI.integer: type: integer format: int64 @@ -31777,7 +34998,7 @@ components: description: A description of what the function does, used by the model to choose when and how to call the function. spec: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The openapi function shape, described as a JSON Schema object. auth: allOf: @@ -31801,7 +35022,7 @@ components: description: A description of what the function does, used by the model to choose when and how to call the function. parameters: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The parameters the functions accepts, described as a JSON Schema object. required: - name @@ -31949,7 +35170,6 @@ components: type: string enum: - openapi - description: The object type, which is always 'openapi'. openapi: allOf: - $ref: '#/components/schemas/OpenApiFunctionDefinition' @@ -31957,84 +35177,47 @@ components: allOf: - $ref: '#/components/schemas/ToolboxTool' description: An OpenAPI tool stored in a toolbox. - OptimizationAgentDefinition: + OptimizationAgentIdentifier: type: object + required: + - agent_name properties: - agentName: - type: string - description: Agent name. - agentVersion: - type: string - description: Agent version. - model: + agent_name: type: string - description: Model deployment name. - systemPrompt: + description: Registered Foundry agent name (required). + agent_version: type: string - description: System prompt / instructions. - skills: - type: array - items: - type: object - additionalProperties: {} - description: Agent skills. - tools: - type: array - items: - type: object - additionalProperties: {} - description: Agent tools. - description: Agent definition returned in response payloads (includes resolved config). + description: Pinned agent version. Defaults to latest if omitted. + description: Identifies the registered Foundry agent to optimize (request-only). Skills, tools, and system_prompt are specified in options.optimization_config. OptimizationCandidate: type: object required: - name - - config - - mutations - - avgScore - - avgTokens - - passRate - - taskScores - - isParetoOptimal + - avg_score + - avg_tokens properties: - candidateId: + candidate_id: type: string description: Server-assigned candidate identifier. Use with GET /candidates/{id} sub-endpoints. name: type: string description: Display name of the candidate (e.g., 'baseline', 'instruction-v2'). - config: - allOf: - - $ref: '#/components/schemas/OptimizationAgentDefinition' - description: The agent configuration that produced this candidate. mutations: type: object - additionalProperties: {} - description: "What was mutated from the baseline (e.g., {systemPrompt: 'new prompt'})." - avgScore: + unevaluatedProperties: {} + description: "What was mutated from the baseline (e.g., {system_prompt: 'new prompt'})." + avg_score: type: number format: double description: Average composite score across all tasks. - avgTokens: + avg_tokens: type: number format: double description: Average token usage across all tasks. - passRate: - type: number - format: double - description: Fraction of tasks that met the pass threshold. - taskScores: - type: array - items: - $ref: '#/components/schemas/OptimizationTaskResult' - description: Individual task-level scores. - isParetoOptimal: - type: boolean - description: Whether this candidate is on the Pareto frontier (score vs cost). - evalId: + eval_id: type: string description: Foundry evaluation identifier used to score this candidate. - evalRunId: + eval_run_id: type: string description: Foundry evaluation run identifier for this candidate's scoring run. promotion: @@ -32042,17 +35225,115 @@ components: - $ref: '#/components/schemas/PromotionInfo' description: Promotion metadata. Null if the candidate has not been promoted. description: Aggregated evaluation result for a single candidate agent configuration across all tasks. + OptimizationDatasetCriterion: + type: object + required: + - name + - instruction + properties: + name: + type: string + description: Criterion name. + instruction: + type: string + description: Criterion instruction / description. + description: 'Evaluation criterion: a name + instruction pair used for per-item scoring.' + OptimizationDatasetInput: + type: object + required: + - type + properties: + type: + allOf: + - $ref: '#/components/schemas/OptimizationDatasetInputType' + description: Dataset input type discriminator. + discriminator: + propertyName: type + mapping: + inline: '#/components/schemas/OptimizationInlineDatasetInput' + reference: '#/components/schemas/OptimizationReferenceDatasetInput' + description: Base discriminated model for dataset input. Either inline items or a registered reference. + OptimizationDatasetInputType: + anyOf: + - type: string + - type: string + enum: + - inline + - reference + description: Discriminator values for the dataset input union. + OptimizationDatasetItem: + type: object + properties: + query: + type: string + description: The user query / prompt. + ground_truth: + type: string + description: Expected ground truth answer. + desired_num_turns: + type: integer + format: int32 + minimum: 1 + maximum: 20 + description: Desired number of conversation turns for simulation mode (1-20). + criteria: + type: array + items: + $ref: '#/components/schemas/OptimizationDatasetCriterion' + description: Per-item evaluation criteria. + description: A single item in an inline dataset. + OptimizationEvaluatorRef: + type: object + required: + - name + properties: + name: + type: string + description: Evaluator name. + version: + type: string + description: Evaluator version. If not specified, the latest version is used. + description: Reference to a named evaluator, optionally pinned to a version. + OptimizationInlineDatasetInput: + type: object + required: + - type + - items + properties: + type: + type: string + enum: + - inline + description: Dataset input type discriminator. + items: + type: array + items: + $ref: '#/components/schemas/OptimizationDatasetItem' + description: Dataset items. + allOf: + - $ref: '#/components/schemas/OptimizationDatasetInput' + description: Inline dataset — items supplied directly in the request body. OptimizationJob: type: object required: - id - status - - createdAt + - created_at + - updated_at properties: id: type: string description: Server-assigned unique identifier. readOnly: true + inputs: + allOf: + - $ref: '#/components/schemas/OptimizationJobInputs' + description: Caller-supplied inputs. + result: + allOf: + - $ref: '#/components/schemas/OptimizationJobResult' + description: Result produced on success. + readOnly: true status: allOf: - $ref: '#/components/schemas/JobStatus' @@ -32063,21 +35344,12 @@ components: - $ref: '#/components/schemas/OpenAI.Error' description: Error details — populated only on failure. readOnly: true - result: - allOf: - - $ref: '#/components/schemas/OptimizationJobResult' - description: Result produced on success. - readOnly: true - inputs: - allOf: - - $ref: '#/components/schemas/OptimizationJobInputs' - description: Caller-supplied inputs. - createdAt: + created_at: allOf: - $ref: '#/components/schemas/FoundryTimestamp' description: The timestamp when the job was created, represented in Unix time. readOnly: true - updatedAt: + updated_at: allOf: - $ref: '#/components/schemas/FoundryTimestamp' description: The timestamp when the job was last updated, represented in Unix time. @@ -32085,58 +35357,103 @@ components: progress: allOf: - $ref: '#/components/schemas/OptimizationJobProgress' - description: Progress while in flight. Absent in terminal states. + description: Progress snapshot. May be present in terminal states reflecting last-known progress. readOnly: true - dataset: - allOf: - - $ref: '#/components/schemas/DatasetInfo' - description: Metadata about the dataset used for this optimization job. + warnings: + type: array + items: + type: string + description: Non-fatal warnings emitted at any point during optimization. readOnly: true description: Agent optimization job resource — a long-running job that optimizes an agent's configuration (instructions, model, skills, tools) to maximize evaluation scores. On success, the result contains scored candidates. OptimizationJobInputs: type: object required: - agent - - trainDatasetReference + - train_dataset + - evaluators properties: agent: allOf: - - $ref: '#/components/schemas/AgentIdentifier' + - $ref: '#/components/schemas/OptimizationAgentIdentifier' description: The agent (and pinned version) being optimized. - trainDatasetReference: + train_dataset: allOf: - - $ref: '#/components/schemas/DatasetRef' - description: Reference to a registered training dataset (required). - validationDatasetReference: + - $ref: '#/components/schemas/OptimizationDatasetInput' + description: Training dataset — either inline items or a reference to a registered dataset. Required. + validation_dataset: allOf: - - $ref: '#/components/schemas/DatasetRef' + - $ref: '#/components/schemas/OptimizationDatasetInput' description: Optional held-out validation dataset for measuring generalization of the final candidate. evaluators: type: array items: - type: string - description: "Job-level evaluators (referenced by name). Per-task criteria may override. Default: ['task_adherence']." + $ref: '#/components/schemas/OptimizationEvaluatorRef' + description: Job-level evaluators referenced by name and optional version. Required; at least one must be provided. options: allOf: - $ref: '#/components/schemas/OptimizationOptions' description: Tuning knobs and run-mode. description: Caller-supplied inputs for an optimization job. + OptimizationJobListItem: + type: object + required: + - id + - status + - created_at + - updated_at + properties: + id: + type: string + description: Server-assigned unique identifier. + readOnly: true + status: + allOf: + - $ref: '#/components/schemas/JobStatus' + description: Current lifecycle status. + readOnly: true + error: + allOf: + - $ref: '#/components/schemas/OpenAI.Error' + description: Error details — populated only on failure. + readOnly: true + created_at: + allOf: + - $ref: '#/components/schemas/FoundryTimestamp' + description: The timestamp when the job was created, represented in Unix time. + readOnly: true + updated_at: + allOf: + - $ref: '#/components/schemas/FoundryTimestamp' + description: The timestamp when the job was last updated, represented in Unix time. + readOnly: true + progress: + allOf: + - $ref: '#/components/schemas/OptimizationJobProgress' + description: Progress snapshot. May be present in terminal states reflecting last-known progress. + readOnly: true + agent: + allOf: + - $ref: '#/components/schemas/OptimizationAgentIdentifier' + description: The agent targeted by this optimization job. + readOnly: true + description: Slim job representation returned by the LIST endpoint. OptimizationJobProgress: type: object required: - - currentIteration - - bestScore - - elapsedSeconds + - candidates_completed + - best_score + - elapsed_seconds properties: - currentIteration: + candidates_completed: type: integer format: int32 - description: 1-based current iteration index. - bestScore: + description: Number of candidates whose evaluation has completed so far. + best_score: type: number format: double description: Best score observed so far across all candidates. - elapsedSeconds: + elapsed_seconds: type: number format: double description: Wall-clock time elapsed in seconds since the job began executing. @@ -32145,106 +35462,61 @@ components: type: object properties: baseline: - allOf: - - $ref: '#/components/schemas/OptimizationCandidate' - description: Evaluation scores for the original (un-optimized) agent configuration. + type: string + description: Candidate ID of the original (un-optimized) baseline evaluation. best: - allOf: - - $ref: '#/components/schemas/OptimizationCandidate' - description: The highest-scoring candidate found during optimization. + type: string + description: Candidate ID of the highest-scoring candidate found during optimization. candidates: type: array items: $ref: '#/components/schemas/OptimizationCandidate' description: All evaluated candidates including baseline. - options: - allOf: - - $ref: '#/components/schemas/OptimizationOptions' - description: The options used for this optimization run. - warnings: - type: array - items: - type: string - description: Non-fatal warnings from the optimization run (e.g., target attribute failures that were skipped). - allTargetAttributesFailed: - type: boolean - description: True when all target attributes failed — only the baseline was evaluated. description: Terminal-state result body. Populated when status is succeeded or failed. OptimizationOptions: type: object properties: - maxIterations: + max_candidates: type: integer format: int32 - description: 'Maximum optimization iterations per strategy. Must be >= 1. Default: 5.' + minimum: 1 + description: 'Maximum number of optimization candidates to generate. Must be >= 1. Default: 5.' default: 5 - optimizationConfig: + optimization_config: type: object - additionalProperties: {} - description: Per-target-attribute configuration overrides. Contains skills, tools, systemPrompt for the agent, plus model space for model optimization. - evalModel: + unevaluatedProperties: {} + description: Per-target-attribute configuration overrides. Contains skills, tools, system_prompt for the agent, plus model space for model optimization. + eval_model: type: string description: Model deployment used for evaluation. Defaults to server config (typically 'gpt-4o'). - optimizationModel: + optimization_model: type: string description: Model deployment for optimization reasoning (must be gpt-5 family). Falls back to the default eval model when not set. - evaluationLevel: + evaluation_level: allOf: - $ref: '#/components/schemas/EvaluationLevel' description: Evaluation granularity. Null/omitted means per-item single-turn. Set to 'conversation' for per-conversation multi-turn simulation scoring. description: Tuning knobs and run-mode for an optimization job. - OptimizationTaskResult: + OptimizationReferenceDatasetInput: type: object required: - - taskName - - scores - - compositeScore - - tokens - - durationSeconds - - passed + - type + - name properties: - taskName: - type: string - description: Task name (from the dataset). - query: - type: string - description: The user query / input for the task. - scores: - type: object - additionalProperties: - type: number - format: double - description: Per-evaluator scores keyed by evaluator name. - compositeScore: - type: number - format: double - description: Composite score combining all evaluator scores. - tokens: - type: integer - format: int32 - description: Total tokens consumed during the agent run for this task. - durationSeconds: - type: number - format: double - description: Wall-clock seconds for this task's agent execution. - passed: - type: boolean - description: Whether the task met the pass threshold. - errorMessage: + type: type: string - description: Error message if the task failed during execution. - rationales: - type: object - additionalProperties: - type: string - description: Per-evaluator reasoning keyed by evaluator name. - response: + enum: + - reference + description: Dataset input type discriminator. + name: type: string - description: Raw agent response text. - runId: + description: Registered dataset name. + version: type: string - description: Identifier of the agent run that produced this result. - description: Per-task evaluation result for a single candidate. + description: Dataset version. If not specified, the latest version is used. + allOf: + - $ref: '#/components/schemas/OptimizationDatasetInput' + description: Reference to a registered Foundry dataset. OtlpTelemetryEndpoint: type: object required: @@ -32260,12 +35532,14 @@ components: endpoint: type: string description: The OTLP collector endpoint URL. - example: https://my-collector.example.com/otlp + examples: + - https://my-collector.example.com/otlp protocol: allOf: - $ref: '#/components/schemas/TelemetryTransportProtocol' description: The transport protocol for the OTLP endpoint. - example: Http + examples: + - Http allOf: - $ref: '#/components/schemas/TelemetryEndpoint' description: An OTLP (OpenTelemetry Protocol) telemetry export endpoint. @@ -32527,60 +35801,21 @@ components: x-ms-foundry-meta: required_previews: - MemoryStores=V1Preview - PromoteCandidateRequest: - type: object - required: - - agentName - - agentVersion - properties: - agentName: - type: string - description: Name of the Foundry agent to promote to. - agentVersion: - type: string - description: Version of the Foundry agent to promote to. - description: Request body for promoting a candidate to a Foundry agent version. - PromoteCandidateResponse: - type: object - required: - - candidateId - - status - - promotedAt - - agentName - - agentVersion - properties: - candidateId: - type: string - description: The promoted candidate id. - status: - type: string - description: Status after promotion. - promotedAt: - allOf: - - $ref: '#/components/schemas/FoundryTimestamp' - description: Timestamp when promotion occurred, represented in Unix time. - agentName: - type: string - description: Name of the Foundry agent promoted to. - agentVersion: - type: string - description: Version of the Foundry agent promoted to. - description: Response after successfully promoting a candidate. PromotionInfo: type: object required: - - promotedAt - - agentName - - agentVersion + - promoted_at + - agent_name + - agent_version properties: - promotedAt: + promoted_at: allOf: - $ref: '#/components/schemas/FoundryTimestamp' description: Timestamp when promotion occurred, represented in Unix time. - agentName: + agent_name: type: string description: Name of the Foundry agent this candidate was promoted to. - agentVersion: + agent_version: type: string description: Version of the Foundry agent this candidate was promoted to. description: Promotion metadata recorded when a candidate is deployed to a Foundry agent. @@ -32598,13 +35833,15 @@ components: type: string description: The model deployment to use for this agent. instructions: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' description: A system (or developer) message inserted into the model's context. temperature: - type: number - format: float - nullable: true + anyOf: + - type: number + format: float + - type: 'null' minimum: 0 maximum: 2 description: |- @@ -32612,9 +35849,10 @@ components: We generally recommend altering this or `top_p` but not both. Defaults to `1`. default: 1 top_p: - type: number - format: float - nullable: true + anyOf: + - type: number + format: float + - type: 'null' minimum: 0 maximum: 1 description: |- @@ -32625,10 +35863,9 @@ components: Defaults to `1`. default: 1 reasoning: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Reasoning' - nullable: true + - type: 'null' tools: type: array items: @@ -32649,7 +35886,7 @@ components: description: Configuration options for a text response from the model. Can be plain text or structured JSON data. structured_inputs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/StructuredInputDefinition' description: Set of structured inputs that can participate in prompt template substitution or tool argument bindings. allOf: @@ -32824,7 +36061,7 @@ components: description: List of attack strategies or nested lists of attack strategies. simulationOnly: type: boolean - description: Simulation-only or Simulation + Evaluation. Default false, if true the scan outputs conversation not evaluation result. + description: Simulation-only or Simulation + Evaluation. If `true` the scan outputs conversation not evaluation result. The service defaults to `false` if a value is not specified by the caller. default: false riskCategories: type: array @@ -32836,12 +36073,12 @@ components: description: Application scenario for the red team operation, to generate scenario specific attacks. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Red team's tags. Unlike properties, tags are fully mutable. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. status: @@ -32993,7 +36230,7 @@ components: description: The maximum number of turns of chat history to evaluate. data_mapping: type: object - additionalProperties: + unevaluatedProperties: type: string description: Mapping from source fields to response_id field, required for retrieving chat history. source: @@ -33023,10 +36260,7 @@ components: Routine: type: object required: - - name - enabled - - triggers - - action properties: name: type: string @@ -33041,7 +36275,7 @@ components: description: Whether the routine is enabled. triggers: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/RoutineTrigger' description: The triggers configured for the routine. action: @@ -33105,9 +36339,6 @@ components: - Routines=V1Preview RoutineCreateOrUpdateRequest: type: object - required: - - triggers - - action properties: description: type: string @@ -33118,7 +36349,7 @@ components: description: Whether the routine is enabled. triggers: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/RoutineTrigger' description: The triggers configured for the routine. In v1, exactly one trigger entry is supported. action: @@ -33162,16 +36393,15 @@ components: type: object required: - id - - status - - trigger_type - - started_at properties: id: type: string - description: The MLflow run identifier for the routine attempt. + description: The unique run identifier for the routine attempt. + readOnly: true status: - type: string - description: The underlying MLflow run status. + allOf: + - $ref: '#/components/schemas/RoutineRunStatus' + description: The run status. phase: allOf: - $ref: '#/components/schemas/RoutineRunPhase' @@ -33180,6 +36410,9 @@ components: allOf: - $ref: '#/components/schemas/RoutineTriggerType' description: The trigger type that produced the routine attempt. + trigger_name: + type: string + description: The configured trigger name that produced the routine attempt. attempt_source: allOf: - $ref: '#/components/schemas/RoutineAttemptSource' @@ -33188,10 +36421,26 @@ components: allOf: - $ref: '#/components/schemas/RoutineActionType' description: The action type dispatched for the routine attempt. + agent_id: + type: string + description: The project-scoped agent identifier recorded for the routine attempt. + agent_endpoint_id: + type: string + description: The legacy endpoint-scoped agent identifier recorded for the routine attempt. + conversation_id: + type: string + description: The conversation identifier used by a responses API dispatch. + session_id: + type: string + description: The hosted-agent session identifier used by an invocations API dispatch. triggered_at: allOf: - $ref: '#/components/schemas/FoundryTimestamp' description: The logical trigger time recorded for the routine attempt. + scheduled_fire_at: + allOf: + - $ref: '#/components/schemas/FoundryTimestamp' + description: The scheduled fire time recorded for timer and schedule deliveries. started_at: allOf: - $ref: '#/components/schemas/FoundryTimestamp' @@ -33212,47 +36461,20 @@ components: task_id: type: string description: The workspace task identifier linked to the routine attempt, when available. + error_status_code: + type: integer + format: int32 + description: The downstream error status code captured for a failed attempt, when available. error_type: type: string description: The fully qualified error type captured for a failed attempt, when available. error_message: type: string description: The truncated failure message captured for a failed attempt, when available. - diagnostics: - allOf: - - $ref: '#/components/schemas/RoutineRunDiagnostics' - description: Diagnostic data captured for the routine attempt. description: A single routine run returned from the run history API. x-ms-foundry-meta: conditional_previews: - Routines=V1Preview - RoutineRunDiagnostics: - type: object - required: - - parameters - - tags - - metrics - properties: - parameters: - type: object - additionalProperties: - type: string - description: MLflow parameters recorded on the run, keyed by parameter name. - tags: - type: object - additionalProperties: - type: string - description: MLflow tags recorded on the run, keyed by tag name. - metrics: - type: object - additionalProperties: - type: number - format: double - description: Latest MLflow metric values recorded on the run, keyed by metric name. - description: Generic diagnostics captured on a routine run. - x-ms-foundry-meta: - conditional_previews: - - Routines=V1Preview RoutineRunPhase: anyOf: - type: string @@ -33266,6 +36488,12 @@ components: x-ms-foundry-meta: conditional_previews: - Routines=V1Preview + RoutineRunStatus: + type: string + description: The status of a routine run. + x-ms-foundry-meta: + conditional_previews: + - Routines=V1Preview RoutineTrigger: type: object required: @@ -33280,7 +36508,8 @@ components: mapping: schedule: '#/components/schemas/ScheduleRoutineTrigger' timer: '#/components/schemas/TimerRoutineTrigger' - github_issue_opened: '#/components/schemas/GitHubIssueOpenedRoutineTrigger' + github_issue: '#/components/schemas/GitHubIssueRoutineTrigger' + custom: '#/components/schemas/CustomRoutineTrigger' description: Base model for a routine trigger. x-ms-foundry-meta: conditional_previews: @@ -33290,7 +36519,8 @@ components: - type: string - type: string enum: - - github_issue_opened + - custom + - github_issue - schedule - timer description: The discriminator values supported for routine triggers. @@ -33401,17 +36631,17 @@ components: description: Task for the schedule. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Schedule's tags. Unlike properties, tags are fully mutable. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Schedule's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. systemData: type: object - additionalProperties: + unevaluatedProperties: type: string description: System metadata for the resource. readOnly: true @@ -33479,7 +36709,7 @@ components: readOnly: true properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Properties of the schedule run. readOnly: true @@ -33495,7 +36725,7 @@ components: description: Type of the task. configuration: type: object - additionalProperties: + unevaluatedProperties: type: string description: Configuration for the task. discriminator: @@ -33539,9 +36769,19 @@ components: SessionDirectoryListResponse: type: object required: + - has_more - path - entries properties: + first_id: + type: string + description: The first ID represented in this list. + last_id: + type: string + description: The last ID represented in this list. + has_more: + type: boolean + description: A value indicating whether there are additional values available not captured in this list. path: type: string description: The path that was listed, relative to the session home directory. @@ -33550,7 +36790,6 @@ components: items: $ref: '#/components/schemas/SessionDirectoryEntry' description: The directory entries. - description: Response from listing a directory in a session sandbox. SessionFileWriteResponse: type: object required: @@ -33575,11 +36814,13 @@ components: allOf: - $ref: '#/components/schemas/SessionLogEventType' description: The SSE event type. Currently `log`, but additional event types may be added in the future. Clients should ignore unrecognized event types. - example: log + examples: + - log data: type: string description: The event payload as plain text. Currently JSON-formatted but the schema is not contractual and may change. - example: '{"timestamp":"2026-03-10T09:33:17.121467567+00:00","stream":"stdout","message":"Starting server on port 18080"}' + examples: + - '{"timestamp":"2026-03-10T09:33:17.121467567+00:00","stream":"stdout","message":"Starting server on port 18080"}' description: |- A single Server-Sent Event frame emitted by the hosted agent session log stream. @@ -33781,7 +37022,7 @@ components: description: Environment requirements or compatibility notes for the skill. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Arbitrary key-value metadata for additional properties. allowed_tools: @@ -33863,11 +37104,11 @@ components: description: The default value for the input if no run-time value is provided. schema: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The JSON schema for the structured input (optional). required: type: boolean - description: Whether the input property is required when the agent is invoked. Defaults to `false`. + description: Whether the input property is required when the agent is invoked. The service defaults to `false` if a value is not specified by the caller. default: false description: An structured input that can participate in prompt template substitutions and tool argument binding. StructuredOutputDefinition: @@ -33886,11 +37127,12 @@ components: description: A description of the output to emit. Used by the model to determine when to emit the output. schema: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The JSON schema for the structured output. strict: - type: boolean - nullable: true + anyOf: + - type: boolean + - type: 'null' description: Whether to enforce strict validation. Default `true`. description: A structured output that can be produced by the agent. StructuredOutputsOutputItem: @@ -34078,7 +37320,7 @@ components: description: List of taxonomy sub categories. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Additional properties for the taxonomy category. description: Taxonomy category definition. @@ -34103,7 +37345,7 @@ components: description: List of taxonomy items under this sub-category. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Additional properties for the taxonomy sub-category. description: Taxonomy sub-category definition. @@ -34150,10 +37392,10 @@ components: items: $ref: '#/components/schemas/TelemetryDataKind' description: Data types to export to this endpoint. Use an empty array to export no data. - example: - - ContainerStdoutStderr - - ContainerOtel - - Metrics + examples: + - - ContainerStdoutStderr + - ContainerOtel + - Metrics auth: allOf: - $ref: '#/components/schemas/TelemetryEndpointAuth' @@ -34237,10 +37479,11 @@ components: description: The version of the evaluator. Latest version if not specified. initialization_parameters: type: object + unevaluatedProperties: {} description: The initialization parameters for the evaluation. Must support structured outputs. data_mapping: type: object - additionalProperties: + unevaluatedProperties: type: string description: The model to use for the evaluation. Must support structured outputs. description: An Azure AI Evaluator grader used as testing criterion in evaluations. @@ -34249,7 +37492,6 @@ components: type: object required: - type - - at properties: type: type: string @@ -34257,11 +37499,9 @@ components: - timer description: The trigger type. at: - type: string - description: A future timer expression. Supported values include an ISO-8601 timestamp with an explicit offset, a local timestamp paired with time_zone, or a positive duration from now. - time_zone: - type: string - description: An optional IANA or Windows time zone identifier when the timer uses a local timestamp. + allOf: + - $ref: '#/components/schemas/FoundryTimestamp' + description: The UTC date and time at which the timer fires. allOf: - $ref: '#/components/schemas/RoutineTrigger' description: A one-shot timer routine trigger. @@ -34271,7 +37511,7 @@ components: ToolCallOutputContent: anyOf: - type: object - additionalProperties: {} + unevaluatedProperties: {} - type: string - type: array items: {} @@ -34421,7 +37661,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -34466,10 +37706,11 @@ components: - tools properties: metadata: - type: object - additionalProperties: - type: string - nullable: true + anyOf: + - type: object + unevaluatedProperties: + type: string + - type: 'null' description: |- Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured @@ -34730,7 +37971,7 @@ components: properties: metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -34749,7 +37990,7 @@ components: description: The manifest ID to import the agent version from. parameter_values: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The inputs to the manifest that will result in a fully materialized Agent. UpdateAgentRequest: type: object @@ -34758,7 +37999,7 @@ components: properties: metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -34795,13 +38036,12 @@ components: name: type: string metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -34814,7 +38054,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Request body for updating a model version. Only description and tags can be modified. @@ -34960,18 +38200,14 @@ components: type: string enum: - web_search - description: The type of the web search tool. One of `web_search` or `web_search_2025_08_26`. - default: web_search filters: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.WebSearchToolFilters' - nullable: true + - type: 'null' user_location: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.WebSearchApproximateLocation' - nullable: true + - type: 'null' search_context_size: type: string enum: @@ -35041,7 +38277,6 @@ components: type: string enum: - work_iq_preview - description: The object type, which is always 'work_iq_preview'. project_connection_id: type: string description: The ID of the WorkIQ project connection. diff --git a/specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.json b/specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.json index 53112b0ea97c..48707aec53d4 100644 --- a/specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.json +++ b/specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.json @@ -1,93 +1,223 @@ { - "openapi": "3.0.0", + "openapi": "3.2.0", "info": { "title": "Microsoft Foundry", "version": "virtual-public-preview" }, "tags": [ { - "name": "Agents" + "name": "EvaluationSuiteGenerationJobs" }, { - "name": "Agent Containers" + "name": "Fine-Tuning" }, { - "name": "Agent Session Files" + "name": "Responses Root", + "description": "Responses" }, { - "name": "Agent Invocations" + "name": "Responses", + "parent": "Responses Root", + "description": "Responses (OpenAI)" }, { - "name": "Agent Invocations WebSocket" + "name": "Conversations", + "parent": "Responses Root", + "description": "Conversations (OpenAI)" }, { - "name": "Connections" + "name": "Agents Root", + "description": "Agents" }, { - "name": "Datasets" + "name": "Agents", + "parent": "Agents Root", + "description": "Agent Management" }, { - "name": "Deployments" + "name": "Agent Invocations", + "parent": "Agents Root" }, { - "name": "Evaluation Taxonomies" + "name": "Agent Invocations WebSocket", + "parent": "Agents Root", + "description": "Agent Invocations (WebSocket)" }, { - "name": "Evaluation Rules" + "name": "Agent Sessions", + "parent": "Agents Root" }, { - "name": "EvaluationSuiteGenerationJobs" + "name": "Agent Session Files", + "parent": "Agents Root" }, { - "name": "Evaluators" + "name": "Agent Versions", + "parent": "Agents Root" }, { - "name": "EvaluatorGenerationJobs" + "name": "Agent Containers", + "parent": "Agents Root" }, { - "name": "Indexes" + "name": "Platform APIs" }, { - "name": "Insights" + "name": "Datasets", + "parent": "Platform APIs" }, { - "name": "Models" + "name": "Indexes", + "parent": "Platform APIs" }, { - "name": "Memory Stores" + "name": "Connections", + "parent": "Platform APIs" }, { - "name": "Conversations" + "name": "Scheduler", + "parent": "Platform APIs" }, { - "name": "Evals" + "name": "Fine-tuning", + "parent": "Platform APIs", + "summary": "Fine-Tuning" }, { - "name": "Fine-Tuning" + "name": "Models", + "parent": "Platform APIs" + }, + { + "name": "Memory Stores", + "parent": "Platform APIs" + }, + { + "name": "Chat", + "parent": "Platform APIs" + }, + { + "name": "Assistants", + "parent": "Platform APIs" + }, + { + "name": "Audio", + "parent": "Platform APIs" + }, + { + "name": "Batch", + "parent": "Platform APIs" + }, + { + "name": "Completions", + "parent": "Platform APIs" + }, + { + "name": "Containers", + "parent": "Platform APIs" }, { - "name": "Responses" + "name": "Embeddings", + "parent": "Platform APIs" }, { - "name": "Redteams" + "name": "Files", + "parent": "Platform APIs" }, { - "name": "Routines" + "name": "Images", + "parent": "Platform APIs" }, { - "name": "Schedules" + "name": "Moderations", + "parent": "Platform APIs" }, { - "name": "Skills" + "name": "Realtime", + "parent": "Platform APIs" }, { - "name": "Toolboxes" + "name": "Threads", + "parent": "Platform APIs" }, { - "name": "DataGenerationJobs" + "name": "Uploads", + "parent": "Platform APIs" }, { - "name": "AgentOptimizationJobs" + "name": "Vector stores", + "parent": "Platform APIs", + "summary": "Vector Stores" + }, + { + "name": "Videos", + "parent": "Platform APIs" + }, + { + "name": "Routines", + "parent": "Platform APIs" + }, + { + "name": "Schedules", + "parent": "Platform APIs" + }, + { + "name": "Skills", + "parent": "Platform APIs" + }, + { + "name": "Toolboxes", + "parent": "Platform APIs" + }, + { + "name": "Deployments", + "parent": "Platform APIs" + }, + { + "name": "DataGenerationJobs", + "parent": "Platform APIs", + "summary": "Data generation jobs" + }, + { + "name": "AgentOptimizationJobs", + "parent": "Platform APIs", + "summary": "Agent optimization jobs" + }, + { + "name": "EvaluatorGenerationJobs", + "parent": "Platform APIs", + "summary": "Evaluator generation jobs" + }, + { + "name": "Evaluations" + }, + { + "name": "Evals", + "parent": "Evaluations" + }, + { + "name": "Evaluation Rules", + "parent": "Evaluations" + }, + { + "name": "Evaluators", + "parent": "Evaluations" + }, + { + "name": "Evaluation Taxonomies", + "parent": "Evaluations" + }, + { + "name": "Redteams", + "parent": "Evaluations", + "summary": "Red Teaming" + }, + { + "name": "Evalsuite", + "parent": "Evaluations" + }, + { + "name": "Insights", + "parent": "Evaluations" } ], "paths": { @@ -105,7 +235,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } }, @@ -156,8 +286,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -175,22 +315,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OptimizationJobInputs" + "$ref": "#/components/schemas/OptimizationJob" } } }, - "description": "The optimization job inputs." + "description": "The job to create." }, "x-ms-foundry-meta": { "conditional_previews": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } }, "get": { "operationId": "AgentOptimizationJobs_list", "summary": "Returns a list of agent optimization jobs.", - "description": "List optimization jobs. Supports cursor pagination and optional status / agentName filters.", + "description": "List optimization jobs. Supports cursor pagination and optional status / agent_name filters.", "parameters": [ { "name": "Foundry-Features", @@ -200,7 +340,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } }, @@ -257,7 +397,7 @@ "explode": false }, { - "name": "agentName", + "name": "agent_name", "in": "query", "required": false, "description": "Filter to jobs targeting this agent name.", @@ -292,7 +432,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OptimizationJob" + "$ref": "#/components/schemas/OptimizationJobListItem" }, "description": "The requested list of items." }, @@ -314,8 +454,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -330,7 +480,7 @@ ], "x-ms-foundry-meta": { "conditional_previews": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } } @@ -339,7 +489,7 @@ "get": { "operationId": "AgentOptimizationJobs_get", "summary": "Get info about an agent optimization job.", - "description": "Get an optimization job by id. Returns 202 while in progress, 200 when terminal.", + "description": "Get an optimization job by id.", "parameters": [ { "name": "Foundry-Features", @@ -349,7 +499,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } }, @@ -379,6 +529,7 @@ "headers": { "Retry-After": { "required": false, + "description": "Recommended number of seconds to wait before polling again.", "schema": { "type": "integer", "format": "int32" @@ -393,27 +544,18 @@ } } }, - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Retry-After": { - "required": false, - "schema": { - "type": "integer", - "format": "int32" - } - } - }, + "4XX": { + "description": "Client error", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OptimizationJob" + "$ref": "#/components/schemas/ApiErrorResponse" } } } }, - "default": { - "description": "An unexpected error response.", + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -428,7 +570,7 @@ ], "x-ms-foundry-meta": { "conditional_previews": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } }, @@ -445,7 +587,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } }, @@ -458,16 +600,6 @@ "type": "string" } }, - { - "name": "force", - "in": "query", - "required": false, - "description": "When true, force-delete even if the job is in a non-terminal state.", - "schema": { - "type": "boolean" - }, - "explode": false - }, { "name": "api-version", "in": "query", @@ -483,8 +615,18 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful." }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -499,16 +641,16 @@ ], "x-ms-foundry-meta": { "conditional_previews": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } } }, - "/agent_optimization_jobs/{jobId}/candidates": { - "get": { - "operationId": "AgentOptimizationJobs_listCandidates", - "summary": "Returns a list of candidates for an optimization job.", - "description": "List candidates produced by a job.", + "/agent_optimization_jobs/{jobId}:cancel": { + "post": { + "operationId": "AgentOptimizationJobs_cancel", + "summary": "Cancels an agent optimization job.", + "description": "Request cancellation of a running or queued job. Returns an error if the job is already in a terminal state.", "parameters": [ { "name": "Foundry-Features", @@ -518,7 +660,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V1Preview" + "AgentsOptimization=V2Preview" ] } }, @@ -526,11 +668,187 @@ "name": "jobId", "in": "path", "required": true, - "description": "The optimization job id.", + "description": "The ID of the job to cancel.", "schema": { "type": "string" } }, + { + "name": "api-version", + "in": "query", + "required": true, + "description": "The API version to use for this operation.", + "schema": { + "type": "string" + }, + "explode": false + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OptimizationJob" + } + } + } + }, + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "tags": [ + "AgentOptimizationJobs" + ], + "x-ms-foundry-meta": { + "conditional_previews": [ + "AgentsOptimization=V2Preview" + ] + } + } + }, + "/agents": { + "post": { + "operationId": "Agents_createAgent_Agents_createAgentFromCode", + "parameters": [ + { + "name": "Foundry-Features", + "in": "header", + "required": false, + "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", + "schema": { + "$ref": "#/components/schemas/AgentDefinitionOptInKeys" + } + }, + { + "name": "api-version", + "in": "query", + "required": true, + "description": "The API version to use for this operation.", + "schema": { + "type": "string" + }, + "explode": false + }, + { + "name": "x-ms-agent-name", + "in": "header", + "required": false, + "description": "The unique name that identifies the agent. Max 63 chars, must start and end with alphanumeric, hyphens allowed in the middle.", + "schema": { + "type": "string", + "maxLength": 63 + } + }, + { + "name": "x-ms-code-zip-sha256", + "in": "header", + "required": false, + "description": "SHA-256 hex digest of the uploaded code zip. Used for change detection (dedup) and integrity verification.", + "schema": { + "type": "string" + } + } + ], + "description": "Creates a new agent or a new version of an existing agent. Creates a new code-based agent. Uploads the code zip and creates the agent in a single call.\nThe agent name is provided in the `x-ms-agent-name` header since POST /agents has no name in the URL path.\nThe SHA-256 hex digest of the zip is provided in the `x-ms-code-zip-sha256` header for integrity and dedup.\nThe request body is multipart/form-data with a JSON metadata part and a binary code part (part order is irrelevant).\nMaximum upload size is 250 MB.", + "summary": "Create an agent Create a new code-based agent", + "responses": { + "200": { + "description": "The request has succeeded.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AgentObject" + } + } + } + }, + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "x-ms-description-override": "Creates a new agent or a new version of an existing agent.", + "x-ms-summary-override": "Create an agent", + "x-ms-foundry-meta": { + "required_previews": [ + "CodeAgents=V1Preview" + ] + }, + "tags": [ + "Agents" + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateAgentRequest" + } + }, + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/CreateAgentFromCodeContent" + }, + "encoding": { + "metadata": { + "contentType": "application/json" + } + } + } + } + } + }, + "get": { + "operationId": "Agents_listAgents", + "summary": "List agents", + "description": "Returns a paged collection of agent resources.", + "parameters": [ + { + "name": "kind", + "in": "query", + "required": false, + "description": "Filter agents by kind. If not provided, all agents are returned.", + "schema": { + "$ref": "#/components/schemas/AgentKind" + }, + "explode": false + }, { "name": "limit", "in": "query", @@ -599,7 +917,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OptimizationCandidate" + "$ref": "#/components/schemas/AgentObject" }, "description": "The requested list of items." }, @@ -621,87 +939,8 @@ } } }, - "default": { - "description": "An unexpected error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - } - }, - "tags": [ - "AgentOptimizationJobs" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "AgentsOptimization=V1Preview" - ] - } - } - }, - "/agent_optimization_jobs/{jobId}/candidates/{candidateId}": { - "get": { - "operationId": "AgentOptimizationJobs_getCandidate", - "summary": "Get a candidate by id.", - "description": "Get a single candidate's metadata, manifest, and promotion info.", - "parameters": [ - { - "name": "Foundry-Features", - "in": "header", - "required": false, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", - "schema": { - "type": "string", - "enum": [ - "AgentsOptimization=V1Preview" - ] - } - }, - { - "name": "jobId", - "in": "path", - "required": true, - "description": "The optimization job id.", - "schema": { - "type": "string" - } - }, - { - "name": "candidateId", - "in": "path", - "required": true, - "description": "The candidate id.", - "schema": { - "type": "string" - } - }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", - "schema": { - "type": "string" - }, - "explode": false - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CandidateMetadata" - } - } - } - }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", "content": { "application/json": { "schema": { @@ -709,627 +948,9 @@ } } } - } - }, - "tags": [ - "AgentOptimizationJobs" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "AgentsOptimization=V1Preview" - ] - } - } - }, - "/agent_optimization_jobs/{jobId}/candidates/{candidateId}/config": { - "get": { - "operationId": "AgentOptimizationJobs_getCandidateConfig", - "summary": "Get candidate deploy config.", - "description": "Get the candidate's deploy config JSON. Used to compose `agents.create_version(...)` from a candidate.", - "parameters": [ - { - "name": "Foundry-Features", - "in": "header", - "required": false, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", - "schema": { - "type": "string", - "enum": [ - "AgentsOptimization=V1Preview" - ] - } - }, - { - "name": "jobId", - "in": "path", - "required": true, - "description": "The optimization job id.", - "schema": { - "type": "string" - } - }, - { - "name": "candidateId", - "in": "path", - "required": true, - "description": "The candidate id.", - "schema": { - "type": "string" - } - }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", - "schema": { - "type": "string" - }, - "explode": false - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CandidateDeployConfig" - } - } - } }, - "default": { - "description": "An unexpected error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - } - }, - "tags": [ - "AgentOptimizationJobs" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "AgentsOptimization=V1Preview" - ] - } - } - }, - "/agent_optimization_jobs/{jobId}/candidates/{candidateId}/files": { - "get": { - "operationId": "AgentOptimizationJobs_getCandidateFile", - "summary": "Get a candidate file.", - "description": "Stream a specific file from the candidate's blob directory.", - "parameters": [ - { - "name": "Foundry-Features", - "in": "header", - "required": false, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", - "schema": { - "type": "string", - "enum": [ - "AgentsOptimization=V1Preview" - ] - } - }, - { - "name": "jobId", - "in": "path", - "required": true, - "description": "The optimization job id.", - "schema": { - "type": "string" - } - }, - { - "name": "candidateId", - "in": "path", - "required": true, - "description": "The candidate id.", - "schema": { - "type": "string" - } - }, - { - "name": "path", - "in": "query", - "required": true, - "description": "Relative path of the file to download (e.g. 'files/examples.jsonl').", - "schema": { - "type": "string" - }, - "explode": false - }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", - "schema": { - "type": "string" - }, - "explode": false - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - } - } - }, - "default": { - "description": "An unexpected error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - } - }, - "tags": [ - "AgentOptimizationJobs" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "AgentsOptimization=V1Preview" - ] - } - } - }, - "/agent_optimization_jobs/{jobId}/candidates/{candidateId}/results": { - "get": { - "operationId": "AgentOptimizationJobs_getCandidateResults", - "summary": "Get candidate evaluation results.", - "description": "Get full per-task evaluation results for a candidate.", - "parameters": [ - { - "name": "Foundry-Features", - "in": "header", - "required": false, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", - "schema": { - "type": "string", - "enum": [ - "AgentsOptimization=V1Preview" - ] - } - }, - { - "name": "jobId", - "in": "path", - "required": true, - "description": "The optimization job id.", - "schema": { - "type": "string" - } - }, - { - "name": "candidateId", - "in": "path", - "required": true, - "description": "The candidate id.", - "schema": { - "type": "string" - } - }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", - "schema": { - "type": "string" - }, - "explode": false - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CandidateResults" - } - } - } - }, - "default": { - "description": "An unexpected error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - } - }, - "tags": [ - "AgentOptimizationJobs" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "AgentsOptimization=V1Preview" - ] - } - } - }, - "/agent_optimization_jobs/{jobId}/candidates/{candidateId}:promote": { - "post": { - "operationId": "AgentOptimizationJobs_promoteCandidate", - "summary": "Promote a candidate.", - "description": "Promotes a candidate, recording the deployment timestamp and target agent version.", - "parameters": [ - { - "name": "Foundry-Features", - "in": "header", - "required": false, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", - "schema": { - "type": "string", - "enum": [ - "AgentsOptimization=V1Preview" - ] - } - }, - { - "name": "jobId", - "in": "path", - "required": true, - "description": "The optimization job id.", - "schema": { - "type": "string" - } - }, - { - "name": "candidateId", - "in": "path", - "required": true, - "description": "The candidate id to promote.", - "schema": { - "type": "string" - } - }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", - "schema": { - "type": "string" - }, - "explode": false - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromoteCandidateResponse" - } - } - } - }, - "default": { - "description": "An unexpected error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - } - }, - "tags": [ - "AgentOptimizationJobs" - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromoteCandidateRequest" - } - } - }, - "description": "Promotion details." - }, - "x-ms-foundry-meta": { - "conditional_previews": [ - "AgentsOptimization=V1Preview" - ] - } - } - }, - "/agent_optimization_jobs/{jobId}:cancel": { - "post": { - "operationId": "AgentOptimizationJobs_cancel", - "summary": "Cancels an agent optimization job.", - "description": "Request cancellation. Idempotent on terminal states.", - "parameters": [ - { - "name": "Foundry-Features", - "in": "header", - "required": false, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", - "schema": { - "type": "string", - "enum": [ - "AgentsOptimization=V1Preview" - ] - } - }, - { - "name": "jobId", - "in": "path", - "required": true, - "description": "The ID of the job to cancel.", - "schema": { - "type": "string" - } - }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", - "schema": { - "type": "string" - }, - "explode": false - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OptimizationJob" - } - } - } - }, - "default": { - "description": "An unexpected error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - } - }, - "tags": [ - "AgentOptimizationJobs" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "AgentsOptimization=V1Preview" - ] - } - } - }, - "/agents": { - "post": { - "operationId": "Agents_createAgent_Agents_createAgentFromCode", - "parameters": [ - { - "name": "Foundry-Features", - "in": "header", - "required": false, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", - "schema": { - "$ref": "#/components/schemas/AgentDefinitionOptInKeys" - } - }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", - "schema": { - "type": "string" - }, - "explode": false - }, - { - "name": "x-ms-agent-name", - "in": "header", - "required": false, - "description": "The unique name that identifies the agent. Max 63 chars, must start and end with alphanumeric, hyphens allowed in the middle.", - "schema": { - "type": "string", - "maxLength": 63 - } - }, - { - "name": "x-ms-code-zip-sha256", - "in": "header", - "required": false, - "description": "SHA-256 hex digest of the uploaded code zip. Used for change detection (dedup) and integrity verification.", - "schema": { - "type": "string" - } - } - ], - "description": "Creates the agent. Creates a new code-based agent. Uploads the code zip and creates the agent in a single call.\nThe agent name is provided in the `x-ms-agent-name` header since POST /agents has no name in the URL path.\nThe SHA-256 hex digest of the zip is provided in the `x-ms-code-zip-sha256` header for integrity and dedup.\nThe request body is multipart/form-data with a JSON metadata part and a binary code part (part order is irrelevant).\nMaximum upload size is 250 MB.", - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AgentObject" - } - } - } - }, - "default": { - "description": "An unexpected error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - } - }, - "x-ms-foundry-meta": { - "required_previews": [ - "CodeAgents=V1Preview" - ] - }, - "tags": [ - "Agents" - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateAgentRequest" - } - }, - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/CreateAgentFromCodeContent" - }, - "encoding": { - "metadata": { - "contentType": "application/json" - } - } - } - } - } - }, - "get": { - "operationId": "Agents_listAgents", - "description": "Returns the list of all agents.", - "parameters": [ - { - "name": "kind", - "in": "query", - "required": false, - "description": "Filter agents by kind. If not provided, all agents are returned.", - "schema": { - "$ref": "#/components/schemas/AgentKind" - }, - "explode": false - }, - { - "name": "limit", - "in": "query", - "required": false, - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", - "schema": { - "type": "integer", - "format": "int32", - "default": 20 - }, - "explode": false - }, - { - "name": "order", - "in": "query", - "required": false, - "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", - "schema": { - "$ref": "#/components/schemas/PageOrder" - }, - "explode": false - }, - { - "name": "after", - "in": "query", - "required": false, - "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", - "schema": { - "type": "string" - }, - "explode": false - }, - { - "name": "before", - "in": "query", - "required": false, - "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "schema": { - "type": "string" - }, - "explode": false - }, - { - "name": "api-version", - "in": "query", - "required": true, - "description": "The API version to use for this operation.", - "schema": { - "type": "string" - }, - "explode": false - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "data", - "has_more" - ], - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AgentObject" - }, - "description": "The requested list of items." - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list." - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list." - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list." - } - }, - "description": "The response data for a requested list of items." - } - } - } - }, - "default": { - "description": "An unexpected error response.", + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -1347,6 +968,7 @@ "/agents/endpoint/protocols/invocations_ws": { "get": { "operationId": "AgentWebsocket_connectEndpointWebsocket", + "summary": "Establish a WebSocket connection to a hosted agent", "description": "Establishes a WebSocket connection to a hosted agent. The target project and\nagent are passed as query parameters. The service resolves (or creates) a\nsession, resolves the agent version, then relays text and binary frames\nbidirectionally between the client and the agent (1 MB maximum frame size).\n\nThe client must send an HTTP GET with `Upgrade: websocket` headers.", "parameters": [ { @@ -1445,8 +1067,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -1469,7 +1101,8 @@ "/agents/{agent_name}": { "get": { "operationId": "Agents_getAgent", - "description": "Retrieves the agent.", + "summary": "Get an agent", + "description": "Retrieves an agent definition by its unique name.", "parameters": [ { "name": "agent_name", @@ -1502,8 +1135,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -1559,6 +1202,7 @@ } ], "description": "Updates the agent by adding a new version if there are any changes to the agent definition.\nIf no changes, returns the existing agent version. Updates a code-based agent by uploading new code and creating a new version.\nIf the code and definition are unchanged (matched by x-ms-code-zip-sha256 header), returns the existing version.\nThe request body is multipart/form-data with a JSON metadata part and a binary code part (part order is irrelevant).\nMaximum upload size is 250 MB.", + "summary": "Update an agent Update a code-based agent", "responses": { "200": { "description": "The request has succeeded.", @@ -1570,8 +1214,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -1581,6 +1235,8 @@ } } }, + "x-ms-description-override": "Updates the agent by adding a new version if there are any changes to the agent definition. If no changes, returns the existing agent version.", + "x-ms-summary-override": "Update an agent", "x-ms-foundry-meta": { "required_previews": [ "CodeAgents=V1Preview" @@ -1612,6 +1268,7 @@ }, "delete": { "operationId": "Agents_deleteAgent", + "summary": "Delete an agent", "description": "Deletes an agent. For hosted agents, if any version has active sessions, the request\nis rejected with HTTP 409 unless `force` is set to true. When force is true, all\nassociated sessions are cascade-deleted along with the agent and its versions.", "parameters": [ { @@ -1627,7 +1284,7 @@ "name": "force", "in": "query", "required": false, - "description": "For Hosted Agents, if true, force-deletes the agent even if its versions have active sessions, cascading deletion to all associated sessions. Defaults to `false`. This value is not relevant for other Agent types.", + "description": "For Hosted Agents, if `true`, force-deletes the agent even if its versions have active sessions, cascading deletion to all associated sessions. The service defaults to `false` if a value is not specified by the caller. This value is not relevant for other Agent types.", "schema": { "type": "boolean", "default": false @@ -1656,8 +1313,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -1673,7 +1340,8 @@ }, "patch": { "operationId": "Agents_patchAgentObject", - "description": "Updates an agent endpoint.", + "summary": "Update an agent endpoint", + "description": "Applies a merge-patch update to the specified agent endpoint configuration.", "parameters": [ { "name": "Foundry-Features", @@ -1693,7 +1361,8 @@ "required": true, "description": "The name of the agent to retrieve.", "schema": { - "type": "string" + "type": "string", + "title": "The name of the agent to retrieve" } }, { @@ -1718,8 +1387,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -1752,7 +1431,8 @@ "/agents/{agent_name}/code:download": { "get": { "operationId": "Agents_downloadAgentCode", - "description": "Download the code zip for a code-based hosted agent.\nReturns the previously-uploaded zip (`application/zip`).\n\nIf `agent_version` is supplied, returns that version's code zip; otherwise\nreturns the latest version's code zip.\n\nThe SHA-256 digest of the returned bytes matches the `content_hash` on the\nresolved version's `code_configuration`.", + "summary": "Download agent code", + "description": "Downloads the code zip for a code-based hosted agent.\nReturns the previously-uploaded zip (`application/zip`).\n\nIf `agent_version` is supplied, returns that version's code zip; otherwise\nreturns the latest version's code zip.\n\nThe SHA-256 digest of the returned bytes matches the `content_hash` on the\nresolved version's `code_configuration`.", "parameters": [ { "name": "Foundry-Features", @@ -1811,14 +1491,23 @@ "content": { "application/zip": { "schema": { - "type": "string", - "format": "binary" + "contentMediaType": "application/zip" } } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -1841,6 +1530,7 @@ "/agents/{agent_name}/endpoint/protocols/invocations": { "post": { "operationId": "AgentInvocations_createAgentInvocation", + "summary": "Create an agent invocation", "description": "Creates an invocation for the specified agent version.", "parameters": [ { @@ -1919,8 +1609,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -1952,6 +1652,7 @@ "/agents/{agent_name}/endpoint/protocols/invocations/docs/openapi.json": { "get": { "operationId": "AgentInvocations_getAgentInvocationOpenApiSpec", + "summary": "Get an agent invocation OpenAPI spec", "description": "Retrieves the OpenAPI specification for an agent version's invocation contract.\nReturns 404 if the agent does not expose an OpenAPI specification.", "parameters": [ { @@ -1993,13 +1694,23 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} } } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -2022,6 +1733,7 @@ "/agents/{agent_name}/endpoint/protocols/invocations/{invocation_id}": { "get": { "operationId": "AgentInvocations_getAgentInvocation", + "summary": "Get an agent invocation", "description": "Retrieves the invocation with the given ID.\nReturns 404 if the agent does not support this operation or if the invocation ID is not found.", "parameters": [ { @@ -2092,8 +1804,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -2116,6 +1838,7 @@ "/agents/{agent_name}/endpoint/protocols/invocations/{invocation_id}/cancel": { "post": { "operationId": "AgentInvocations_cancelAgentInvocation", + "summary": "Cancel an agent invocation", "description": "Cancels an invocation.\nReturns 404 if the agent does not support this operation or if the invocation ID is not found.", "parameters": [ { @@ -2186,8 +1909,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -2219,6 +1952,7 @@ "/agents/{agent_name}/endpoint/sessions": { "post": { "operationId": "Agents_createSession", + "summary": "Create a session", "description": "Creates a new session for an agent endpoint.\nThe endpoint resolves the backing agent version from `version_indicator` and\nenforces session ownership using the provided isolation key for session-mutating operations.", "parameters": [ { @@ -2273,8 +2007,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -2285,7 +2029,7 @@ } }, "tags": [ - "Agents" + "Agent Sessions" ], "requestBody": { "required": true, @@ -2305,7 +2049,8 @@ }, "get": { "operationId": "Agents_listSessions", - "description": "Returns a list of sessions for the specified agent.", + "summary": "List sessions for an agent", + "description": "Returns a paged collection of sessions associated with the specified agent endpoint.", "parameters": [ { "name": "Foundry-Features", @@ -2427,8 +2172,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -2439,7 +2194,7 @@ } }, "tags": [ - "Agents" + "Agent Sessions" ], "x-ms-foundry-meta": { "required_previews": [ @@ -2451,7 +2206,8 @@ "/agents/{agent_name}/endpoint/sessions/{agent_session_id}/files": { "get": { "operationId": "AgentSessionFiles_listSessionFiles", - "description": "List files and directories at a given path in the session sandbox.\nReturns only the immediate children of the specified directory (non-recursive).", + "summary": "List session files", + "description": "Returns files and directories at the specified path in the session sandbox.\nThe response includes only the immediate children of the target directory and defaults to the session home directory when no path is supplied.", "parameters": [ { "name": "Foundry-Features", @@ -2486,8 +2242,8 @@ { "name": "path", "in": "query", - "required": true, - "description": "The directory path to list, relative to the session home directory.", + "required": false, + "description": "The directory path to list, relative to the session home directory. Defaults to the home directory if not provided.", "schema": { "type": "string" }, @@ -2502,6 +2258,48 @@ "type": "string" } }, + { + "name": "limit", + "in": "query", + "required": false, + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", + "schema": { + "type": "integer", + "format": "int32", + "default": 20 + }, + "explode": false + }, + { + "name": "order", + "in": "query", + "required": false, + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", + "schema": { + "$ref": "#/components/schemas/PageOrder" + }, + "explode": false + }, + { + "name": "after", + "in": "query", + "required": false, + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", + "schema": { + "type": "string" + }, + "explode": false + }, + { + "name": "before", + "in": "query", + "required": false, + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", + "schema": { + "type": "string" + }, + "explode": false + }, { "name": "api-version", "in": "query", @@ -2524,8 +2322,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -2546,7 +2354,8 @@ }, "delete": { "operationId": "AgentSessionFiles_deleteSessionFile", - "description": "Delete a file or directory from the session sandbox.\nIf `recursive` is false (default) and the target is a non-empty directory, the API returns 409 Conflict.", + "summary": "Delete a session file", + "description": "Deletes the specified file or directory from the session sandbox.\nWhen `recursive` is false, deleting a non-empty directory returns 409 Conflict.", "parameters": [ { "name": "Foundry-Features", @@ -2592,7 +2401,7 @@ "name": "recursive", "in": "query", "required": false, - "description": "Whether to recursively delete directory contents. Defaults to false.", + "description": "Whether to recursively delete directory contents. The service defaults to `false` if a value is not specified by the caller.", "schema": { "type": "boolean", "default": false @@ -2623,8 +2432,18 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful. " }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -2647,7 +2466,8 @@ "/agents/{agent_name}/endpoint/sessions/{agent_session_id}/files/content": { "put": { "operationId": "AgentSessionFiles_uploadSessionFile", - "description": "Upload a file to the session sandbox via binary stream.\nMaximum file size is 50 MB. Uploads exceeding this limit return 413 Payload Too Large.", + "summary": "Upload a session file", + "description": "Uploads binary file content to the specified path in the session sandbox.\nThe service stores the file relative to the session home directory and rejects payloads larger than 50 MB.", "parameters": [ { "name": "Foundry-Features", @@ -2720,8 +2540,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -2739,8 +2569,7 @@ "content": { "application/octet-stream": { "schema": { - "type": "string", - "format": "binary" + "contentMediaType": "application/octet-stream" } } } @@ -2753,7 +2582,8 @@ }, "get": { "operationId": "AgentSessionFiles_downloadSessionFile", - "description": "Download a file from the session sandbox as a binary stream.", + "summary": "Download a session file", + "description": "Downloads the file at the specified sandbox path as a binary stream.\nThe path is resolved relative to the session home directory.", "parameters": [ { "name": "Foundry-Features", @@ -2821,14 +2651,23 @@ "content": { "application/octet-stream": { "schema": { - "type": "string", - "format": "binary" + "contentMediaType": "application/octet-stream" } } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -2851,7 +2690,8 @@ "/agents/{agent_name}/endpoint/sessions/{session_id}": { "get": { "operationId": "Agents_getSession", - "description": "Retrieves a session by ID.", + "summary": "Get a session", + "description": "Retrieves the details of a hosted agent session by agent name and session identifier.", "parameters": [ { "name": "Foundry-Features", @@ -2914,8 +2754,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -2926,7 +2776,7 @@ } }, "tags": [ - "Agents" + "Agent Sessions" ], "x-ms-foundry-meta": { "required_previews": [ @@ -2936,6 +2786,7 @@ }, "delete": { "operationId": "Agents_deleteSession", + "summary": "Delete a session", "description": "Deletes a session synchronously.\nReturns 204 No Content when the session is deleted or does not exist.", "parameters": [ { @@ -2992,8 +2843,18 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful." }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -3004,7 +2865,7 @@ } }, "tags": [ - "Agents" + "Agent Sessions" ], "x-ms-foundry-meta": { "required_previews": [ @@ -3016,7 +2877,8 @@ "/agents/{agent_name}/endpoint/sessions/{session_id}:stop": { "post": { "operationId": "Agents_stopSession", - "description": "Stops a session.\nReturns 204 No Content when the stop succeeds.", + "summary": "Stop a session", + "description": "Terminates the specified hosted agent session and returns 204 No Content when the request succeeds.", "parameters": [ { "name": "Foundry-Features", @@ -3063,8 +2925,18 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful." }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -3075,7 +2947,7 @@ } }, "tags": [ - "Agents" + "Agent Sessions" ], "x-ms-foundry-meta": { "required_previews": [ @@ -3087,6 +2959,7 @@ "/agents/{agent_name}/import": { "post": { "operationId": "Agents_updateAgentFromManifest", + "summary": "Update an agent from a manifest", "description": "Updates the agent from a manifest by adding a new version if there are any changes to the agent definition.\nIf no changes, returns the existing agent version.", "parameters": [ { @@ -3120,8 +2993,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -3149,7 +3032,8 @@ "/agents/{agent_name}/operations": { "get": { "operationId": "AgentContainers_listAgentContainerOperations", - "description": "List container operations for an agent.", + "summary": "List agent container operations", + "description": "Returns container operations recorded for the specified agent across its container lifecycle.", "parameters": [ { "name": "Foundry-Features", @@ -3262,8 +3146,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -3286,7 +3180,8 @@ "/agents/{agent_name}/operations/{operation_id}": { "get": { "operationId": "AgentContainers_getAgentContainerOperation", - "description": "Get the status of a container operation for an agent.", + "summary": "Get an agent container operation", + "description": "Retrieves the status and details of the specified container operation for an agent.", "parameters": [ { "name": "Foundry-Features", @@ -3340,8 +3235,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -3404,7 +3309,8 @@ } } ], - "description": "Create a new agent version.", + "description": "Creates a new version for the specified agent and returns the created version resource. Creates a new agent version from code. Uploads the code zip and creates a new version\nfor an existing agent. The SHA-256 hex digest of the zip is provided in the\n`x-ms-code-zip-sha256` header for integrity and dedup.\nThe request body is multipart/form-data with a JSON metadata part and a binary code part (part order is irrelevant).\nMaximum upload size is 250 MB.", + "summary": "Create an agent version Create an agent version from code", "responses": { "200": { "description": "The request has succeeded.", @@ -3416,8 +3322,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -3427,13 +3343,15 @@ } } }, + "x-ms-description-override": "Creates a new version for the specified agent and returns the created version resource.", + "x-ms-summary-override": "Create an agent version", "x-ms-foundry-meta": { "required_previews": [ "CodeAgents=V1Preview" ] }, "tags": [ - "Agents" + "Agent Versions" ], "requestBody": { "required": true, @@ -3458,7 +3376,8 @@ }, "get": { "operationId": "Agents_listAgentVersions", - "description": "Returns the list of versions of an agent.", + "summary": "List agent versions", + "description": "Returns a paged collection of versions for the specified agent.", "parameters": [ { "name": "agent_name", @@ -3559,8 +3478,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -3571,14 +3500,15 @@ } }, "tags": [ - "Agents" + "Agent Versions" ] } }, "/agents/{agent_name}/versions/{agent_version}": { "get": { "operationId": "Agents_getAgentVersion", - "description": "Retrieves a specific version of an agent.", + "summary": "Get an agent version", + "description": "Retrieves the specified version of an agent by its agent name and version identifier.", "parameters": [ { "name": "agent_name", @@ -3620,8 +3550,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -3632,11 +3572,12 @@ } }, "tags": [ - "Agents" + "Agent Versions" ] }, "delete": { "operationId": "Agents_deleteAgentVersion", + "summary": "Delete an agent version", "description": "Deletes a specific version of an agent. For hosted agents, if the version has active\nsessions, the request is rejected with HTTP 409 unless `force` is set to true. When\nforce is true, all sessions associated with this version are cascade-deleted.", "parameters": [ { @@ -3661,7 +3602,7 @@ "name": "force", "in": "query", "required": false, - "description": "For Hosted Agents, if true, force-deletes the version even if it has active sessions, cascading deletion to all associated sessions. Defaults to `false`. This value is not relevant for other Agent types.", + "description": "For Hosted Agents, if `true`, force-deletes the version even if it has active sessions, cascading deletion to all associated sessions. The service defaults to `false` if a value is not specified by the caller. This value is not relevant for other Agent types.", "schema": { "type": "boolean", "default": false @@ -3690,8 +3631,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -3702,14 +3653,15 @@ } }, "tags": [ - "Agents" + "Agent Versions" ] } }, "/agents/{agent_name}/versions/{agent_version}/containers/default": { "get": { "operationId": "AgentContainers_getAgentContainer", - "description": "Get a container for a specific version of an agent.", + "summary": "Get an agent container", + "description": "Retrieves the default container resource for the specified agent version.\nThe response includes the current container state and configuration.", "parameters": [ { "name": "Foundry-Features", @@ -3763,8 +3715,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -3787,7 +3749,8 @@ "/agents/{agent_name}/versions/{agent_version}/containers/default/operations": { "get": { "operationId": "AgentContainers_listAgentVersionContainerOperations", - "description": "List container operations for a specific version of an agent.", + "summary": "List agent version container operations", + "description": "Returns container operations for the default container of the specified agent version.", "parameters": [ { "name": "Foundry-Features", @@ -3909,8 +3872,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -3933,7 +3906,8 @@ "/agents/{agent_name}/versions/{agent_version}/containers/default:delete": { "post": { "operationId": "AgentContainers_deleteAgentContainer", - "description": "Delete a container for a specific version of an agent. If the container doesn't exist, the operation will be no-op.\nThe operation is a long-running operation. Following the design guidelines for long-running operations in Azure REST APIs.\nhttps://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations", + "summary": "Delete an agent container", + "description": "Deletes the default container for the specified agent version.\nThe long-running operation returns an operation resource that can be polled to completion.", "parameters": [ { "name": "Foundry-Features", @@ -3996,8 +3970,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -4020,7 +4004,8 @@ "/agents/{agent_name}/versions/{agent_version}/containers/default:logstream": { "post": { "operationId": "AgentContainers_streamAgentContainerLogs", - "description": "Container log entry streamed from the container as text chunks.\nEach chunk is a UTF-8 string that may be either a plain text log line\nor a JSON-formatted log entry, depending on the type of container log being streamed.\nClients should treat each chunk as opaque text and, if needed, attempt\nto parse it as JSON based on their logging requirements.\n\nFor system logs, the format is JSON with the following structure:\n{\"TimeStamp\":\"2025-12-15T16:51:33Z\",\"Type\":\"Normal\",\"ContainerAppName\":null,\"RevisionName\":null,\"ReplicaName\":null,\"Msg\":\"Connecting to the events collector...\",\"Reason\":\"StartingGettingEvents\",\"EventSource\":\"ContainerAppController\",\"Count\":1}\n{\"TimeStamp\":\"2025-12-15T16:51:34Z\",\"Type\":\"Normal\",\"ContainerAppName\":null,\"RevisionName\":null,\"ReplicaName\":null,\"Msg\":\"Successfully connected to events server\",\"Reason\":\"ConnectedToEventsServer\",\"EventSource\":\"ContainerAppController\",\"Count\":1}\n\nFor console logs, the format is plain text as emitted by the container's stdout/stderr.\n2025-12-15T08:43:48.72656 Connecting to the container 'agent-container'...\n2025-12-15T08:43:48.75451 Successfully Connected to container: 'agent-container' [Revision: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b', Replica: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b-6898b9c89f-mpkjc']\n2025-12-15T08:33:59.0671054Z stdout F INFO: 127.0.0.1:42588 - \"GET /readiness HTTP/1.1\" 200 OK\n2025-12-15T08:34:29.0649033Z stdout F INFO: 127.0.0.1:60246 - \"GET /readiness HTTP/1.1\" 200 OK\n2025-12-15T08:34:59.0644467Z stdout F INFO: 127.0.0.1:43994 - \"GET /readiness HTTP/1.1\" 200 OK", + "summary": "Stream agent container logs", + "description": "Streams console or system logs from the default container for the specified agent version.\nClients can target a specific replica and request trailing log lines before the chunked text stream begins.", "parameters": [ { "name": "Foundry-Features", @@ -4098,8 +4083,18 @@ "200": { "description": "The request has succeeded." }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -4122,7 +4117,8 @@ "/agents/{agent_name}/versions/{agent_version}/containers/default:start": { "post": { "operationId": "AgentContainers_startAgentContainer", - "description": "Start a container for a specific version of an agent. If the container is already running, the operation will be no-op.\nThe operation is a long-running operation. Following the design guidelines for long-running operations in Azure REST APIs.\nhttps://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations", + "summary": "Start an agent container", + "description": "Starts the default container for the specified agent version.\nThe long-running operation provisions replicas when a container is not already running.", "parameters": [ { "name": "Foundry-Features", @@ -4185,8 +4181,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -4233,7 +4239,8 @@ "/agents/{agent_name}/versions/{agent_version}/containers/default:stop": { "post": { "operationId": "AgentContainers_stopAgentContainer", - "description": "Stop a container for a specific version of an agent. If the container is not running, or already stopped, the operation will be no-op.\nThe operation is a long-running operation. Following the design guidelines for long-running operations in Azure REST APIs.\nhttps://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations", + "summary": "Stop an agent container", + "description": "Stops the default container for the specified agent version.\nThe long-running operation completes even when the container is already stopped.", "parameters": [ { "name": "Foundry-Features", @@ -4296,8 +4303,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -4320,7 +4337,8 @@ "/agents/{agent_name}/versions/{agent_version}/containers/default:update": { "post": { "operationId": "AgentContainers_updateAgentContainer", - "description": "Update a container for a specific version of an agent. If the container is not running, the operation will be no-op.\nThe operation is a long-running operation. Following the design guidelines for long-running operations in Azure REST APIs.\nhttps://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations", + "summary": "Update an agent container", + "description": "Updates the replica settings for the default container of the specified agent version.\nThe long-running operation applies changes only when a container is already running.", "parameters": [ { "name": "Foundry-Features", @@ -4383,8 +4401,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -4429,6 +4457,7 @@ "/agents/{agent_name}/versions/{agent_version}/sessions/{session_id}:logstream": { "get": { "operationId": "Agents_getSessionLogStream", + "summary": "Stream console logs for a hosted agent session", "description": "Streams console logs (stdout / stderr) for a specific hosted agent session\nas a Server-Sent Events (SSE) stream.\n\nEach SSE frame contains:\n- `event`: always `\"log\"`\n- `data`: a plain-text log line (currently JSON-formatted, but the schema\nis not contractual and may include additional keys or change format\nover time — clients should treat it as an opaque string)\n\nExample SSE frames:\n```\nevent: log\ndata: {\"timestamp\":\"2026-03-10T09:33:17.121Z\",\"stream\":\"stdout\",\"message\":\"Starting FoundryCBAgent server on port 8088\"}\n\nevent: log\ndata: {\"timestamp\":\"2026-03-10T09:33:17.130Z\",\"stream\":\"stderr\",\"message\":\"INFO: Application startup complete.\"}\n\nevent: log\ndata: {\"timestamp\":\"2026-03-10T09:34:52.714Z\",\"stream\":\"status\",\"message\":\"Successfully connected to container\"}\n\nevent: log\ndata: {\"timestamp\":\"2026-03-10T09:35:52.714Z\",\"stream\":\"status\",\"message\":\"No logs since last 60 seconds\"}\n```\n\nThe stream remains open until the client disconnects or the server\nterminates the connection. Clients should handle reconnection as needed.", "parameters": [ { @@ -4492,8 +4521,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -4504,7 +4543,7 @@ } }, "tags": [ - "Agents" + "Agent Sessions" ], "x-ms-foundry-meta": { "required_previews": [ @@ -4516,7 +4555,8 @@ "/agents/{agent_name}/versions:import": { "post": { "operationId": "Agents_createAgentVersionFromManifest", - "description": "Create a new agent version from a manifest.", + "summary": "Create an agent version from manifest", + "description": "Imports the provided manifest to create a new version for the specified agent.", "parameters": [ { "name": "agent_name", @@ -4550,8 +4590,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -4562,7 +4612,7 @@ } }, "tags": [ - "Agents" + "Agent Versions" ], "requestBody": { "required": true, @@ -4579,7 +4629,8 @@ "/agents:import": { "post": { "operationId": "Agents_createAgentFromManifest", - "description": "Creates an agent from a manifest.", + "summary": "Create an agent from a manifest", + "description": "Imports the provided manifest to create an agent and returns the created resource.", "parameters": [ { "name": "api-version", @@ -4603,8 +4654,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -4632,7 +4693,8 @@ "/connections": { "get": { "operationId": "Connections_list", - "description": "List all connections in the project, without populating connection credentials", + "summary": "List connections", + "description": "Returns the connections available in the current project, optionally filtered by type or default status.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -4641,7 +4703,7 @@ "name": "connectionType", "in": "query", "required": false, - "description": "List connections of this specific type", + "description": "Lists connections of this specific type", "schema": { "$ref": "#/components/schemas/ConnectionType" }, @@ -4651,7 +4713,7 @@ "name": "defaultConnection", "in": "query", "required": false, - "description": "List connections that are default connections", + "description": "Lists connections that are default connections", "schema": { "type": "boolean" }, @@ -4681,8 +4743,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -4709,7 +4790,8 @@ "/connections/{name}": { "get": { "operationId": "Connections_get", - "description": "Get a connection by name, without populating connection credentials", + "summary": "Get a connection", + "description": "Retrieves the specified connection and its configuration details without including credential values.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -4747,8 +4829,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -4775,7 +4876,8 @@ "/connections/{name}/getConnectionWithCredentials": { "post": { "operationId": "Connections_getWithCredentials", - "description": "Get a connection by name, with its connection credentials", + "summary": "Get a connection with credentials", + "description": "Retrieves the specified connection together with its credential values.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -4813,8 +4915,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -4841,7 +4962,7 @@ "/data_generation_jobs": { "get": { "operationId": "DataGenerationJobs_list", - "summary": "Returns a list of data generation jobs", + "summary": "List data generation jobs", "description": "Returns a list of data generation jobs.", "parameters": [ { @@ -4946,8 +5067,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -4968,8 +5099,8 @@ }, "post": { "operationId": "DataGenerationJobs_create", - "summary": "Creates a data generation job.", - "description": "Creates a data generation job.", + "summary": "Create a data generation job", + "description": "Submits a new data generation job for asynchronous execution.", "parameters": [ { "name": "Foundry-Features", @@ -5030,8 +5161,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -5065,8 +5206,8 @@ "/data_generation_jobs/{jobId}": { "get": { "operationId": "DataGenerationJobs_get", - "summary": "Get info about a data generation job.", - "description": "Gets the details of a data generation job by its ID.", + "summary": "Get a data generation job", + "description": "Retrieves the specified data generation job and its current status.", "parameters": [ { "name": "Foundry-Features", @@ -5121,8 +5262,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -5143,8 +5294,8 @@ }, "delete": { "operationId": "DataGenerationJobs_delete", - "summary": "Deletes a data generation job.", - "description": "Deletes a data generation job by its ID.", + "summary": "Delete a data generation job", + "description": "Removes the specified data generation job and its associated output.", "parameters": [ { "name": "Foundry-Features", @@ -5182,8 +5333,18 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful." }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -5206,8 +5367,8 @@ "/data_generation_jobs/{jobId}:cancel": { "post": { "operationId": "DataGenerationJobs_cancel", - "summary": "Cancels a data generation job.", - "description": "Cancels a data generation job by its ID.", + "summary": "Cancel a data generation job", + "description": "Cancels the specified data generation job if it is still in progress.", "parameters": [ { "name": "Foundry-Features", @@ -5252,8 +5413,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -5276,6 +5447,7 @@ "/datasets": { "get": { "operationId": "Datasets_listLatest", + "summary": "List latest versions", "description": "List the latest version of each DatasetVersion", "parameters": [ { @@ -5293,8 +5465,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -5321,6 +5512,7 @@ "/datasets/{name}/versions": { "get": { "operationId": "Datasets_listVersions", + "summary": "List versions", "description": "List all versions of the given DatasetVersion", "parameters": [ { @@ -5347,8 +5539,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -5375,6 +5586,7 @@ "/datasets/{name}/versions/{version}": { "get": { "operationId": "Datasets_getVersion", + "summary": "Get a version", "description": "Get the specific version of the DatasetVersion. The service returns 404 Not Found error if the DatasetVersion does not exist.", "parameters": [ { @@ -5410,8 +5622,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -5436,6 +5667,7 @@ }, "delete": { "operationId": "Datasets_deleteVersion", + "summary": "Delete a version", "description": "Delete the specific version of the DatasetVersion. The service returns 204 No Content if the DatasetVersion was deleted successfully or if the DatasetVersion does not exist.", "parameters": [ { @@ -5464,8 +5696,27 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful." }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -5490,6 +5741,7 @@ }, "patch": { "operationId": "Datasets_createOrUpdateVersion", + "summary": "Create or update a version", "description": "Create a new or update an existing DatasetVersion with the given version id", "parameters": [ { @@ -5535,8 +5787,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -5574,7 +5845,8 @@ "/datasets/{name}/versions/{version}/credentials": { "post": { "operationId": "Datasets_getCredentials", - "description": "Get the SAS credential to access the storage account associated with a Dataset version.", + "summary": "Get dataset credentials", + "description": "Gets the SAS credential to access the storage account associated with a Dataset version.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -5609,8 +5881,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -5637,7 +5928,8 @@ "/datasets/{name}/versions/{version}/startPendingUpload": { "post": { "operationId": "Datasets_startPendingUploadVersion", - "description": "Start a new or get an existing pending upload of a dataset for a specific version.", + "summary": "Start a pending upload", + "description": "Initiates a new pending upload or retrieves an existing one for the specified dataset version.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -5672,8 +5964,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -5711,7 +6022,8 @@ "/deployments": { "get": { "operationId": "Deployments_list", - "description": "List all deployed models in the project", + "summary": "List deployments", + "description": "Returns the deployed models available in the current project, optionally filtered by publisher, model name, or deployment type.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -5770,8 +6082,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -5798,7 +6129,8 @@ "/deployments/{name}": { "get": { "operationId": "Deployments_get", - "description": "Get a deployed model.", + "summary": "Get a deployment", + "description": "Gets a deployed model.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -5836,8 +6168,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -5864,7 +6215,7 @@ "/evaluation_suite_generation_jobs": { "post": { "operationId": "EvaluationSuiteGenerationJobs_create", - "summary": "Creates an evaluation suite generation job.", + "summary": "Create an evaluation suite generation job", "description": "Create a new job (preview). Includes optional Foundry-Features header and Operation-Id for idempotent retries.", "parameters": [ { @@ -5926,8 +6277,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -5959,7 +6320,7 @@ }, "get": { "operationId": "EvaluationSuiteGenerationJobs_list", - "summary": "Returns a list of evaluation suite generation jobs.", + "summary": "List evaluation suite generation jobs", "description": "List jobs with cursor-based pagination (preview). Includes optional Foundry-Features header.", "parameters": [ { @@ -6064,8 +6425,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -6088,7 +6459,7 @@ "/evaluation_suite_generation_jobs/{jobId}": { "get": { "operationId": "EvaluationSuiteGenerationJobs_get", - "summary": "Get info about an evaluation suite generation job.", + "summary": "Get an evaluation suite generation job", "description": "Get a job by ID (preview). Includes optional Foundry-Features header.", "parameters": [ { @@ -6144,8 +6515,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -6166,7 +6547,7 @@ }, "delete": { "operationId": "EvaluationSuiteGenerationJobs_delete", - "summary": "Deletes an evaluation suite generation job.", + "summary": "Delete an evaluation suite generation job", "description": "Delete a job (preview). Returns 204 No Content.", "parameters": [ { @@ -6205,8 +6586,18 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful." }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -6229,7 +6620,7 @@ "/evaluation_suite_generation_jobs/{jobId}:cancel": { "post": { "operationId": "EvaluationSuiteGenerationJobs_cancel", - "summary": "Cancels an evaluation suite generation job.", + "summary": "Cancel an evaluation suite generation job", "description": "Cancel a running job (preview). Returns 200 with the updated job.", "parameters": [ { @@ -6275,8 +6666,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -6299,6 +6700,7 @@ "/evaluation_suites": { "get": { "operationId": "EvaluationSuites_listLatest", + "summary": "List latest versions", "description": "List the latest version of each EvaluationSuiteVersion", "parameters": [ { @@ -6326,8 +6728,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -6351,6 +6772,7 @@ "/evaluation_suites/{name}/versions": { "get": { "operationId": "EvaluationSuites_listVersions", + "summary": "List versions", "description": "List all versions of the given EvaluationSuiteVersion", "parameters": [ { @@ -6377,8 +6799,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -6400,6 +6841,7 @@ }, "post": { "operationId": "EvaluationSuites_createEvaluationSuiteVersion", + "summary": "Create an evaluation suite version", "description": "Create a new EvaluationSuiteVersion with auto incremented version id", "parameters": [ { @@ -6445,8 +6887,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -6477,6 +6929,7 @@ "/evaluation_suites/{name}/versions/{version}": { "get": { "operationId": "EvaluationSuites_getVersion", + "summary": "Get a version", "description": "Get the specific version of the EvaluationSuiteVersion. The service returns 404 Not Found error if the EvaluationSuiteVersion does not exist.", "parameters": [ { @@ -6512,8 +6965,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -6535,6 +7007,7 @@ }, "delete": { "operationId": "EvaluationSuites_deleteVersion", + "summary": "Delete a version", "description": "Delete the specific version of the EvaluationSuiteVersion. The service returns 204 No Content if the EvaluationSuiteVersion was deleted successfully or if the EvaluationSuiteVersion does not exist.", "parameters": [ { @@ -6563,8 +7036,27 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful." }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -6586,6 +7078,7 @@ }, "patch": { "operationId": "EvaluationSuites_createOrUpdateVersion", + "summary": "Create or update a version", "description": "Create a new or update an existing EvaluationSuiteVersion with the given version id", "parameters": [ { @@ -6631,8 +7124,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -6667,7 +7179,8 @@ "/evaluation_suites/{name}:run": { "post": { "operationId": "EvaluationSuites_run", - "description": "Run an evaluation using the suite's testing criteria and dataset.", + "summary": "Run an evaluation suite", + "description": "Runs an evaluation using the suite's testing criteria and dataset.", "parameters": [ { "name": "Foundry-Features", @@ -6712,8 +7225,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -6744,7 +7267,8 @@ "/evaluationrules": { "get": { "operationId": "EvaluationRules_list", - "description": "List all evaluation rules.", + "summary": "List evaluation rules", + "description": "Returns the evaluation rules configured for the project, optionally filtered by action type, agent name, or enabled state.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -6791,8 +7315,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -6819,7 +7362,8 @@ "/evaluationrules/{id}": { "get": { "operationId": "EvaluationRules_get", - "description": "Get an evaluation rule.", + "summary": "Get an evaluation rule", + "description": "Retrieves the specified evaluation rule and its configuration.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -6845,8 +7389,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -6871,7 +7434,8 @@ }, "delete": { "operationId": "EvaluationRules_delete", - "description": "Delete an evaluation rule.", + "summary": "Delete an evaluation rule", + "description": "Removes the specified evaluation rule from the project.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -6890,8 +7454,27 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful." }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -6916,7 +7499,8 @@ }, "put": { "operationId": "EvaluationRules_createOrUpdate", - "description": "Create or update an evaluation rule.", + "summary": "Create or update an evaluation rule", + "description": "Creates a new evaluation rule, or replaces the existing rule when the identifier matches.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -6964,8 +7548,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -7003,7 +7606,8 @@ "/evaluations/runs": { "get": { "operationId": "Evaluations_list", - "description": "List evaluation runs", + "summary": "List evaluation runs", + "description": "Returns the evaluation runs available in the current project.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -7032,8 +7636,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -7057,7 +7680,8 @@ "/evaluations/runs/{name}": { "get": { "operationId": "Evaluations_get", - "description": "Get an evaluation run by name.", + "summary": "Get an evaluation run", + "description": "Retrieves the specified evaluation run and its current status.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -7095,8 +7719,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -7118,7 +7761,8 @@ }, "delete": { "operationId": "Evaluations_delete", - "description": "Delete an evaluation run by name", + "summary": "Delete an evaluation run", + "description": "Removes the specified evaluation run from the project.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -7149,8 +7793,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -7174,7 +7837,8 @@ "/evaluations/runs/{name}:cancel": { "post": { "operationId": "Evaluations_cancel", - "description": "Cancel an evaluation run by name", + "summary": "Cancel an evaluation run", + "description": "Cancels the specified evaluation run before it completes.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -7205,8 +7869,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -7230,7 +7913,8 @@ "/evaluations/runs:run": { "post": { "operationId": "Evaluations_create", - "description": "Creates an evaluation run.", + "summary": "Create an evaluation run", + "description": "Submits a new evaluation run with the provided configuration.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -7247,8 +7931,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -7283,7 +7986,8 @@ "/evaluations/runs:runAgent": { "post": { "operationId": "Evaluations_createAgentEvaluation", - "description": "Creates an agent evaluation run.", + "summary": "Create an agent evaluation run", + "description": "Submits a new agent evaluation run with the provided request.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -7300,8 +8004,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -7336,7 +8059,8 @@ "/evaluationtaxonomies": { "get": { "operationId": "EvaluationTaxonomies_list", - "description": "List evaluation taxonomies", + "summary": "List evaluation taxonomies", + "description": "Returns the evaluation taxonomies available in the project, optionally filtered by input name or input type.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -7385,8 +8109,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -7413,7 +8156,8 @@ "/evaluationtaxonomies/{name}": { "get": { "operationId": "EvaluationTaxonomies_get", - "description": "Get an evaluation run by name.", + "summary": "Get an evaluation taxonomy", + "description": "Retrieves the specified evaluation taxonomy.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -7451,8 +8195,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -7477,7 +8240,8 @@ }, "delete": { "operationId": "EvaluationTaxonomies_delete", - "description": "Delete an evaluation taxonomy by name.", + "summary": "Delete an evaluation taxonomy", + "description": "Removes the specified evaluation taxonomy from the project.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -7508,8 +8272,27 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful." }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -7534,7 +8317,113 @@ }, "put": { "operationId": "EvaluationTaxonomies_create", - "description": "Create an evaluation taxonomy.", + "summary": "Create an evaluation taxonomy", + "description": "Creates or replaces the specified evaluation taxonomy with the provided definition.", + "parameters": [ + { + "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "Foundry-Features", + "in": "header", + "required": true, + "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", + "schema": { + "type": "string", + "enum": [ + "Evaluations=V1Preview" + ] + } + }, + { + "name": "name", + "in": "path", + "required": true, + "description": "The name of the evaluation taxonomy.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EvaluationTaxonomy" + } + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EvaluationTaxonomy" + } + } + } + }, + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + } + }, + "tags": [ + "Evaluation Taxonomies" + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EvaluationTaxonomyCreateOrUpdate" + } + } + }, + "description": "The evaluation taxonomy." + } + }, + "patch": { + "operationId": "EvaluationTaxonomies_update", + "summary": "Update an evaluation taxonomy", + "description": "Update an evaluation taxonomy.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -7572,18 +8461,8 @@ } } }, - "201": { - "description": "The request has succeeded and a new resource has been created as a result.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EvaluationTaxonomy" - } - } - } - }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", "headers": { "x-ms-error-code": { "required": false, @@ -7600,65 +8479,9 @@ } } } - } - }, - "tags": [ - "Evaluation Taxonomies" - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EvaluationTaxonomyCreateOrUpdate" - } - } - }, - "description": "The evaluation taxonomy." - } - }, - "patch": { - "operationId": "EvaluationTaxonomies_update", - "description": "Update an evaluation taxonomy.", - "parameters": [ - { - "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "Foundry-Features", - "in": "header", - "required": true, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", - "schema": { - "type": "string", - "enum": [ - "Evaluations=V1Preview" - ] - } - }, - { - "name": "name", - "in": "path", - "required": true, - "description": "The name of the evaluation taxonomy.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EvaluationTaxonomy" - } - } - } }, - "default": { - "description": "An unexpected error response.", + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -7696,7 +8519,7 @@ "/evaluator_generation_jobs": { "post": { "operationId": "EvaluatorGenerationJobs_create", - "summary": "Creates an evaluator generation job.", + "summary": "Create an evaluator generation job", "description": "Creates an evaluator generation job. The service generates rubric-based evaluator\ndefinitions from the provided source materials asynchronously.", "parameters": [ { @@ -7758,8 +8581,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -7791,8 +8624,8 @@ }, "get": { "operationId": "EvaluatorGenerationJobs_list", - "summary": "Returns a list of evaluator generation jobs.", - "description": "Returns a list of evaluator generation jobs.", + "summary": "List evaluator generation jobs", + "description": "Returns a list of evaluator generation jobs. The List API has up to a few\nseconds of propagation delay, so a recently created job may not appear\nimmediately; use the Get evaluator generation job API with the job ID to\nretrieve a specific job without delay.", "parameters": [ { "name": "Foundry-Features", @@ -7896,8 +8729,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -7920,7 +8763,7 @@ "/evaluator_generation_jobs/{jobId}": { "get": { "operationId": "EvaluatorGenerationJobs_get", - "summary": "Get info about an evaluator generation job.", + "summary": "Get an evaluator generation job", "description": "Gets the details of an evaluator generation job by its ID.", "parameters": [ { @@ -7976,8 +8819,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -7998,6 +8851,7 @@ }, "delete": { "operationId": "EvaluatorGenerationJobs_delete", + "summary": "Delete an evaluator generation job", "description": "Deletes an evaluator generation job by its ID. Deletes the job record only;\nthe generated evaluator (if any) is preserved.", "parameters": [ { @@ -8036,8 +8890,18 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful." }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -8060,7 +8924,7 @@ "/evaluator_generation_jobs/{jobId}:cancel": { "post": { "operationId": "EvaluatorGenerationJobs_cancel", - "summary": "Cancels an evaluator generation job.", + "summary": "Cancel an evaluator generation job", "description": "Cancels an evaluator generation job by its ID.", "parameters": [ { @@ -8106,8 +8970,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -8130,7 +9004,8 @@ "/evaluators": { "get": { "operationId": "Evaluators_listLatestVersions", - "description": "List the latest version of each evaluator", + "summary": "List latest evaluator versions", + "description": "Lists the latest version of each evaluator", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -8191,8 +9066,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -8219,7 +9113,8 @@ "/evaluators/{name}/versions": { "get": { "operationId": "Evaluators_listVersions", - "description": "List all versions of the given evaluator", + "summary": "List evaluator versions", + "description": "Returns the available versions for the specified evaluator.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -8289,8 +9184,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -8315,7 +9229,8 @@ }, "post": { "operationId": "Evaluators_createVersion", - "description": "Create a new EvaluatorVersion with auto incremented version id", + "summary": "Create an evaluator version", + "description": "Creates a new evaluator version with an auto-incremented version identifier.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -8353,8 +9268,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -8391,7 +9325,8 @@ "/evaluators/{name}/versions/{version}": { "get": { "operationId": "Evaluators_getVersion", - "description": "Get the specific version of the EvaluatorVersion. The service returns 404 Not Found error if the EvaluatorVersion does not exist.", + "summary": "Get an evaluator version", + "description": "Retrieves the specified evaluator version, returning 404 if it does not exist.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -8438,8 +9373,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -8464,7 +9418,94 @@ }, "delete": { "operationId": "Evaluators_deleteVersion", - "description": "Delete the specific version of the EvaluatorVersion. The service returns 204 No Content if the EvaluatorVersion was deleted successfully or if the EvaluatorVersion does not exist.", + "summary": "Delete an evaluator version", + "description": "Removes the specified evaluator version. Returns 204 whether the version existed or not.", + "parameters": [ + { + "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "required": true, + "description": "The name of the resource", + "schema": { + "type": "string" + } + }, + { + "name": "Foundry-Features", + "in": "header", + "required": true, + "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", + "schema": { + "type": "string", + "enum": [ + "Evaluations=V1Preview" + ] + } + }, + { + "name": "version", + "in": "path", + "required": true, + "description": "The version of the EvaluatorVersion to delete.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful." + }, + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + } + }, + "tags": [ + "Evaluators" + ] + }, + "patch": { + "operationId": "Evaluators_updateVersion", + "summary": "Update an evaluator version", + "description": "Updates the specified evaluator version in place.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -8494,18 +9535,25 @@ "name": "version", "in": "path", "required": true, - "description": "The version of the EvaluatorVersion to delete.", + "description": "The version of the EvaluatorVersion to update.", "schema": { "type": "string" } } ], "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful." + "200": { + "description": "The request has succeeded.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EvaluatorVersion" + } + } + } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", "headers": { "x-ms-error-code": { "required": false, @@ -8522,63 +9570,9 @@ } } } - } - }, - "tags": [ - "Evaluators" - ] - }, - "patch": { - "operationId": "Evaluators_updateVersion", - "description": "Update an existing EvaluatorVersion with the given version id", - "parameters": [ - { - "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" }, - { - "name": "name", - "in": "path", - "required": true, - "description": "The name of the resource", - "schema": { - "type": "string" - } - }, - { - "name": "Foundry-Features", - "in": "header", - "required": true, - "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", - "schema": { - "type": "string", - "enum": [ - "Evaluations=V1Preview" - ] - } - }, - { - "name": "version", - "in": "path", - "required": true, - "description": "The version of the EvaluatorVersion to update.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EvaluatorVersion" - } - } - } - }, - "default": { - "description": "An unexpected error response.", + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -8616,7 +9610,8 @@ "/evaluators/{name}/versions/{version}/credentials": { "post": { "operationId": "Evaluators_getCredentials", - "description": "Get the SAS credential to access the storage account associated with an Evaluator version.", + "summary": "Get evaluator credentials", + "description": "Retrieves SAS credentials for accessing the storage account associated with the specified evaluator version.", "parameters": [ { "name": "Foundry-Features", @@ -8669,8 +9664,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -8704,7 +9709,8 @@ "/evaluators/{name}/versions/{version}/startPendingUpload": { "post": { "operationId": "Evaluators_startPendingUpload", - "description": "Start a new or get an existing pending upload of an evaluator for a specific version.", + "summary": "Start a pending upload", + "description": "Initiates a new pending upload or retrieves an existing one for the specified evaluator version.", "parameters": [ { "name": "Foundry-Features", @@ -8757,8 +9763,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -8792,6 +9808,7 @@ "/indexes": { "get": { "operationId": "Indexes_listLatest", + "summary": "List latest versions", "description": "List the latest version of each Index", "parameters": [ { @@ -8809,8 +9826,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -8837,6 +9873,7 @@ "/indexes/{name}/versions": { "get": { "operationId": "Indexes_listVersions", + "summary": "List versions", "description": "List all versions of the given Index", "parameters": [ { @@ -8863,8 +9900,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -8891,6 +9947,7 @@ "/indexes/{name}/versions/{version}": { "get": { "operationId": "Indexes_getVersion", + "summary": "Get a version", "description": "Get the specific version of the Index. The service returns 404 Not Found error if the Index does not exist.", "parameters": [ { @@ -8926,8 +9983,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -8952,6 +10028,7 @@ }, "delete": { "operationId": "Indexes_deleteVersion", + "summary": "Delete a version", "description": "Delete the specific version of the Index. The service returns 204 No Content if the Index was deleted successfully or if the Index does not exist.", "parameters": [ { @@ -8980,8 +10057,27 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful." }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -9006,6 +10102,7 @@ }, "patch": { "operationId": "Indexes_createOrUpdateVersion", + "summary": "Create or update a version", "description": "Create a new or update an existing Index with the given version id", "parameters": [ { @@ -9051,8 +10148,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -9090,7 +10206,8 @@ "/insights": { "post": { "operationId": "Insights_generate", - "description": "Generate Insights", + "summary": "Generate insights", + "description": "Generates an insights report from the provided evaluation configuration.", "parameters": [ { "name": "Foundry-Features", @@ -9145,8 +10262,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -9173,7 +10300,8 @@ }, "get": { "operationId": "Insights_list", - "description": "List all insights in reverse chronological order (newest first).", + "summary": "List insights", + "description": "Returns insights in reverse chronological order, with the most recent entries first.", "parameters": [ { "name": "Foundry-Features", @@ -9259,8 +10387,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -9278,7 +10416,8 @@ "/insights/{id}": { "get": { "operationId": "Insights_get", - "description": "Get a specific insight by Id.", + "summary": "Get an insight", + "description": "Retrieves the specified insight report and its results.", "parameters": [ { "name": "Foundry-Features", @@ -9333,8 +10472,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -9352,6 +10501,8 @@ "/managedAgentIdentityBlueprints": { "get": { "operationId": "ManagedAgentIdentityBlueprints_listManagedAgentIdentityBlueprints", + "summary": "List blueprints", + "description": "Lists all managed agent identity blueprints.", "parameters": [ { "name": "Foundry-Features", @@ -9409,8 +10560,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -9430,6 +10591,8 @@ "/managedAgentIdentityBlueprints/{blueprint_name}": { "put": { "operationId": "ManagedAgentIdentityBlueprints_createOrUpdateManagedAgentIdentityBlueprint", + "summary": "Create or update a blueprint", + "description": "Creates or updates a managed agent identity blueprint.", "parameters": [ { "name": "Foundry-Features", @@ -9474,8 +10637,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -9503,6 +10676,7 @@ }, "get": { "operationId": "ManagedAgentIdentityBlueprints_getManagedAgentIdentityBlueprint", + "summary": "Get a blueprint", "description": "Retrieves a managed agent identity blueprint by name.", "parameters": [ { @@ -9548,8 +10722,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -9567,6 +10751,7 @@ }, "delete": { "operationId": "ManagedAgentIdentityBlueprints_deleteManagedAgentIdentityBlueprint", + "summary": "Delete a blueprint", "description": "Deletes a managed agent identity blueprint by name.", "parameters": [ { @@ -9605,8 +10790,18 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful." }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -9626,7 +10821,8 @@ "/memory_stores": { "post": { "operationId": "createMemoryStore", - "description": "Create a memory store.", + "summary": "Create a memory store", + "description": "Creates a memory store resource with the provided configuration.", "parameters": [ { "name": "Foundry-Features", @@ -9662,8 +10858,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -9695,7 +10901,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Arbitrary key-value metadata to associate with the memory store." @@ -9725,7 +10931,8 @@ }, "get": { "operationId": "listMemoryStores", - "description": "List all memory stores.", + "summary": "List memory stores", + "description": "Returns the memory stores available to the caller.", "parameters": [ { "name": "Foundry-Features", @@ -9829,8 +11036,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -9853,7 +11070,8 @@ "/memory_stores/{name}": { "post": { "operationId": "updateMemoryStore", - "description": "Update a memory store.", + "summary": "Update a memory store", + "description": "Updates the specified memory store with the supplied configuration changes.", "parameters": [ { "name": "Foundry-Features", @@ -9898,8 +11116,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -9926,7 +11154,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Arbitrary key-value metadata to associate with the memory store." @@ -9944,7 +11172,8 @@ }, "get": { "operationId": "getMemoryStore", - "description": "Retrieve a memory store.", + "summary": "Get a memory store", + "description": "Retrieves the specified memory store and its current configuration.", "parameters": [ { "name": "Foundry-Features", @@ -9989,8 +11218,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -10011,7 +11250,8 @@ }, "delete": { "operationId": "deleteMemoryStore", - "description": "Delete a memory store.", + "summary": "Delete a memory store", + "description": "Deletes the specified memory store.", "parameters": [ { "name": "Foundry-Features", @@ -10056,8 +11296,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -10080,7 +11330,8 @@ "/memory_stores/{name}/items": { "post": { "operationId": "createMemory", - "description": "Create a memory item in a memory store.", + "summary": "Create a memory item", + "description": "Creates a memory item in the specified memory store.", "parameters": [ { "name": "Foundry-Features", @@ -10125,8 +11376,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -10182,7 +11443,8 @@ "/memory_stores/{name}/items/{memory_id}": { "post": { "operationId": "updateMemory", - "description": "Update a memory item in a memory store.", + "summary": "Update a memory item", + "description": "Updates the specified memory item in the memory store.", "parameters": [ { "name": "Foundry-Features", @@ -10236,8 +11498,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -10277,7 +11549,8 @@ }, "get": { "operationId": "getMemory", - "description": "Retrieve a memory item from a memory store.", + "summary": "Get a memory item", + "description": "Retrieves the specified memory item from the memory store.", "parameters": [ { "name": "Foundry-Features", @@ -10331,8 +11604,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -10353,7 +11636,8 @@ }, "delete": { "operationId": "deleteMemory", - "description": "Delete a memory item from a memory store.", + "summary": "Delete a memory item", + "description": "Deletes the specified memory item from the memory store.", "parameters": [ { "name": "Foundry-Features", @@ -10407,8 +11691,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -10431,7 +11725,8 @@ "/memory_stores/{name}/items:list": { "post": { "operationId": "listMemories", - "description": "List all memory items in a memory store.", + "summary": "List memory items", + "description": "Returns memory items from the specified memory store.", "parameters": [ { "name": "Foundry-Features", @@ -10554,8 +11849,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -10597,7 +11902,8 @@ "/memory_stores/{name}/updates/{update_id}": { "get": { "operationId": "getUpdateResult", - "description": "Get memory store update result.", + "summary": "Get an update result", + "description": "Retrieves the status and result of a memory store update operation.", "parameters": [ { "name": "Foundry-Features", @@ -10651,8 +11957,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -10675,7 +11991,8 @@ "/memory_stores/{name}:delete_scope": { "post": { "operationId": "deleteScopeMemories", - "description": "Delete all memories associated with a specific scope from a memory store.", + "summary": "Delete memories by scope", + "description": "Deletes all memories in the specified memory store that are associated with the provided scope.", "parameters": [ { "name": "Foundry-Features", @@ -10720,8 +12037,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -10763,7 +12090,8 @@ "/memory_stores/{name}:search_memories": { "post": { "operationId": "searchMemories", - "description": "Search for relevant memories from a memory store based on conversation context.", + "summary": "Search memories", + "description": "Searches the specified memory store for memories relevant to the provided conversation context.", "parameters": [ { "name": "Foundry-Features", @@ -10808,8 +12136,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -10870,7 +12208,8 @@ "/memory_stores/{name}:update_memories": { "post": { "operationId": "updateMemories", - "description": "Update memory store with conversation memories.", + "summary": "Update memories", + "description": "Starts an update that writes conversation memories into the specified memory store.\nThe operation returns a long-running status location for polling the update result.", "parameters": [ { "name": "Foundry-Features", @@ -10925,8 +12264,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -10985,6 +12334,7 @@ "/models": { "get": { "operationId": "Models_listLatest", + "summary": "List latest versions", "description": "List the latest version of each ModelVersion", "parameters": [ { @@ -11014,8 +12364,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -11042,6 +12411,7 @@ "/models/{name}/versions": { "get": { "operationId": "Models_listVersions", + "summary": "List versions", "description": "List all versions of the given ModelVersion", "parameters": [ { @@ -11080,8 +12450,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -11108,7 +12497,8 @@ "/models/{name}/versions/{version}": { "get": { "operationId": "Models_getVersion", - "description": "Get the specific version of the ModelVersion. The service returns 404 Not Found error if the ModelVersion does not exist.", + "summary": "Get a model version", + "description": "Retrieves the specified model version, returning 404 if it does not exist.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -11155,8 +12545,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -11186,6 +12595,7 @@ }, "delete": { "operationId": "Models_deleteVersion", + "summary": "Delete a model version", "description": "Delete the specific version of the ModelVersion. The service returns 200 OK if the ModelVersion was deleted successfully or if the ModelVersion does not exist.", "parameters": [ { @@ -11226,8 +12636,27 @@ "200": { "description": "The request has succeeded." }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -11257,6 +12686,7 @@ }, "patch": { "operationId": "Models_updateVersion", + "summary": "Update a model version", "description": "Update an existing ModelVersion with the given version id", "parameters": [ { @@ -11314,8 +12744,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -11358,7 +12807,8 @@ "/models/{name}/versions/{version}/createAsync": { "post": { "operationId": "Models_createAsync", - "description": "Creates a model version asynchronously with blob content validation. Returns 202 Accepted with a Location header for polling.", + "summary": "Create a model version async", + "description": "Creates a model version asynchronously with blob content validation. Returns 202 Accepted with a location header for polling the operation status.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -11418,9 +12868,15 @@ "description": "URL to poll for operation status." }, "operationResult": { - "type": "string", - "format": "uri", - "nullable": true, + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ], "description": "URL to the operation result, or null if the operation is still in progress." } } @@ -11428,8 +12884,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -11472,7 +12947,8 @@ "/models/{name}/versions/{version}/credentials": { "post": { "operationId": "Models_getCredentials", - "description": "Get credentials for a model version asset.", + "summary": "Get model asset credentials", + "description": "Retrieves temporary credentials for accessing the storage backing the specified model version.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -11519,8 +12995,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -11562,7 +13057,8 @@ "/models/{name}/versions/{version}/startPendingUpload": { "post": { "operationId": "Models_startPendingUpload", - "description": "Start or retrieve a pending upload for a model version.", + "summary": "Start a pending upload", + "description": "Initiates a new pending upload or retrieves an existing one for the specified model version.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -11609,8 +13105,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -11652,7 +13167,8 @@ "/openai/v1/conversations": { "post": { "operationId": "createConversation", - "description": "Create a conversation.", + "summary": "Create a conversation", + "description": "Creates a new conversation resource.", "parameters": [ { "name": "x-ms-user-isolation-key", @@ -11675,8 +13191,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -11702,7 +13228,8 @@ }, "get": { "operationId": "listConversations", - "description": "Returns the list of all conversations.", + "summary": "List conversations", + "description": "Returns the conversations available in the current project.", "parameters": [ { "name": "limit", @@ -11813,8 +13340,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -11832,7 +13369,8 @@ "/openai/v1/conversations/{conversation_id}": { "post": { "operationId": "updateConversation", - "description": "Update a conversation.", + "summary": "Update a conversation", + "description": "Modifies the specified conversation's properties.", "parameters": [ { "name": "conversation_id", @@ -11864,8 +13402,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -11891,7 +13439,8 @@ }, "get": { "operationId": "getConversation", - "description": "Retrieves a conversation.", + "summary": "Retrieve a conversation", + "description": "Retrieves the specified conversation and its metadata.", "parameters": [ { "name": "conversation_id", @@ -11923,8 +13472,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -11940,7 +13499,8 @@ }, "delete": { "operationId": "deleteConversation", - "description": "Deletes a conversation.", + "summary": "Delete a conversation", + "description": "Removes the specified conversation resource from the current project.", "parameters": [ { "name": "conversation_id", @@ -11972,8 +13532,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -11991,7 +13561,8 @@ "/openai/v1/conversations/{conversation_id}/items": { "post": { "operationId": "createConversationItems", - "description": "Create items in a conversation with the given ID.", + "summary": "Create conversation items", + "description": "Adds one or more items to the specified conversation.", "parameters": [ { "name": "conversation_id", @@ -12036,8 +13607,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -12076,7 +13657,8 @@ }, "get": { "operationId": "listConversationItems", - "description": "List all items for a conversation with the given ID.", + "summary": "List conversation items", + "description": "Returns the items belonging to the specified conversation.", "parameters": [ { "name": "conversation_id", @@ -12186,8 +13768,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -12205,7 +13797,8 @@ "/openai/v1/conversations/{conversation_id}/items/{item_id}": { "get": { "operationId": "getConversationItem", - "description": "Get a single item from a conversation with the given IDs.", + "summary": "Get a conversation item", + "description": "Retrieves a specific item from the specified conversation.", "parameters": [ { "name": "conversation_id", @@ -12246,8 +13839,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -12263,7 +13866,8 @@ }, "delete": { "operationId": "deleteConversationItem", - "description": "Delete an item from a conversation with the given IDs.", + "summary": "Delete a conversation item", + "description": "Removes the specified item from a conversation.", "parameters": [ { "name": "conversation_id", @@ -12304,8 +13908,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -12323,8 +13937,8 @@ "/openai/v1/evals": { "get": { "operationId": "Evals_listEvals", - "summary": "List all evaluations", - "description": "List evaluations for a project.", + "summary": "List evaluations", + "description": "Returns the evaluations configured in the current project.", "parameters": [ { "name": "after", @@ -12342,11 +13956,7 @@ "required": false, "description": "Number of runs to retrieve.", "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/integer" - } - ], + "$ref": "#/components/schemas/integer", "default": 20 }, "explode": false @@ -12418,8 +14028,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -12435,8 +14055,8 @@ }, "post": { "operationId": "Evals_createEval", - "summary": "Create evaluation", - "description": "Create the structure of an evaluation that can be used to test a model's performance.\nAn evaluation is a set of testing criteria and the config for a data source, which dictates the schema of the data used in the evaluation. After creating an evaluation, you can run it on different models and model parameters. We support several types of graders and datasources.\nFor more information, see the [Evals guide](https://platform.openai.com/docs/guides/evals).", + "summary": "Create an evaluation", + "description": "Creates the structure of an evaluation that can be used to test a model's performance.\nAn evaluation is a set of testing criteria and the config for a data source, which dictates the schema of the data used in the evaluation. After creating an evaluation, you can run it on different models and model parameters. We support several types of graders and datasources.\nFor more information, see the [Evals guide](https://platform.openai.com/docs/guides/evals).", "parameters": [], "responses": { "200": { @@ -12449,8 +14069,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -12479,7 +14109,7 @@ "delete": { "operationId": "Evals_deleteEval", "summary": "Delete an evaluation", - "description": "Delete an evaluation.", + "description": "Removes the specified evaluation and its associated data.", "parameters": [ { "name": "eval_id", @@ -12502,8 +14132,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -12520,7 +14160,7 @@ "get": { "operationId": "Evals_getEval", "summary": "Get an evaluation", - "description": "Get an evaluation by ID.", + "description": "Retrieves the specified evaluation and its configuration.", "parameters": [ { "name": "eval_id", @@ -12543,8 +14183,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -12561,7 +14211,7 @@ "post": { "operationId": "Evals_updateEval", "summary": "Update an evaluation", - "description": "Update certain properties of an evaluation.", + "description": "Updates certain properties of an evaluation.", "parameters": [ { "name": "eval_id", @@ -12584,8 +14234,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -12613,8 +14273,8 @@ "/openai/v1/evals/{eval_id}/runs": { "get": { "operationId": "Evals_listRuns", - "summary": "Get a list of runs for an evaluation", - "description": "Get a list of runs for an evaluation.", + "summary": "List evaluation runs", + "description": "Returns the runs associated with the specified evaluation.", "parameters": [ { "name": "eval_id", @@ -12641,11 +14301,7 @@ "required": false, "description": "Number of runs to retrieve.", "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/integer" - } - ], + "$ref": "#/components/schemas/integer", "default": 20 }, "explode": false @@ -12720,8 +14376,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -12737,7 +14403,8 @@ }, "post": { "operationId": "Evals_createEvalRun", - "summary": "Create evaluation run", + "summary": "Create an evaluation run", + "description": "Creates an evaluation run for the specified evaluation.", "parameters": [ { "name": "eval_id", @@ -12760,8 +14427,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -12789,8 +14466,8 @@ "/openai/v1/evals/{eval_id}/runs/{run_id}": { "delete": { "operationId": "Evals_deleteEvalRun", - "summary": "Delete evaluation run", - "description": "Delete an eval run.", + "summary": "Delete an evaluation run", + "description": "Removes the specified evaluation run.", "parameters": [ { "name": "eval_id", @@ -12822,8 +14499,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -12840,7 +14527,7 @@ "get": { "operationId": "Evals_getEvalRun", "summary": "Get an evaluation run", - "description": "Get an evaluation run by ID.", + "description": "Retrieves the specified evaluation run and its current status.", "parameters": [ { "name": "eval_id", @@ -12872,8 +14559,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -12889,8 +14586,8 @@ }, "post": { "operationId": "Evals_cancelEvalRun", - "summary": "Cancel evaluation run", - "description": "Cancel an ongoing evaluation run.", + "summary": "Cancel an evaluation run", + "description": "Cancels an ongoing evaluation run.", "parameters": [ { "name": "eval_id", @@ -12922,8 +14619,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -12941,8 +14648,8 @@ "/openai/v1/evals/{eval_id}/runs/{run_id}/output_items": { "get": { "operationId": "Evals_getEvalRunOutputItems", - "summary": "Get evaluation run output items", - "description": "Get a list of output items for an evaluation run.", + "summary": "List evaluation run output items", + "description": "Returns the output items produced by the specified evaluation run.", "parameters": [ { "name": "eval_id", @@ -12977,11 +14684,7 @@ "required": false, "description": "Number of runs to retrieve.", "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/integer" - } - ], + "$ref": "#/components/schemas/integer", "default": 20 }, "explode": false @@ -13052,8 +14755,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -13072,7 +14785,7 @@ "get": { "operationId": "Evals_getEvalRunOutputItem", "summary": "Get an output item of an evaluation run", - "description": "Get an evaluation run output item by ID.", + "description": "Retrieves a single output item from the specified evaluation run.", "parameters": [ { "name": "eval_id", @@ -13113,8 +14826,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -13132,6 +14855,7 @@ "/openai/v1/fine_tuning/jobs": { "post": { "operationId": "createFineTuningJob", + "summary": "Create a fine-tuning job", "description": "Creates a fine-tuning job which begins the process of creating a new model from a given dataset.\n\nResponse includes details of the enqueued job including job status and the name of the fine-tuned models once complete.\n\n[Learn more about fine-tuning](https://platform.openai.com/docs/guides/fine-tuning)", "parameters": [ { @@ -13156,8 +14880,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -13183,7 +14917,8 @@ }, "get": { "operationId": "listPaginatedFineTuningJobs", - "description": "List your organization's fine-tuning jobs", + "summary": "List fine-tuning jobs", + "description": "Returns the fine-tuning jobs for the current organization.", "parameters": [ { "name": "after", @@ -13229,8 +14964,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -13248,7 +14993,8 @@ "/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}": { "get": { "operationId": "retrieveFineTuningJob", - "description": "Get info about a fine-tuning job.\n\n[Learn more about fine-tuning](https://platform.openai.com/docs/guides/fine-tuning)", + "summary": "Get a fine-tuning job", + "description": "Gets info about a fine-tuning job.\n\n[Learn more about fine-tuning](https://platform.openai.com/docs/guides/fine-tuning)", "parameters": [ { "name": "fine_tuning_job_id", @@ -13281,8 +15027,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -13300,7 +15056,8 @@ "/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel": { "post": { "operationId": "cancelFineTuningJob", - "description": "Immediately cancel a fine-tune job.", + "summary": "Cancel a fine-tuning job", + "description": "Immediately cancels the specified fine-tuning job.", "parameters": [ { "name": "fine_tuning_job_id", @@ -13333,8 +15090,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -13352,7 +15119,8 @@ "/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints": { "get": { "operationId": "listFineTuningJobCheckpoints", - "description": "List checkpoints for a fine-tuning job.", + "summary": "List fine-tuning job checkpoints", + "description": "Returns the checkpoints saved during the specified fine-tuning job.", "parameters": [ { "name": "fine_tuning_job_id", @@ -13407,8 +15175,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -13426,7 +15204,8 @@ "/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events": { "get": { "operationId": "listFineTuningJobEvents", - "description": "Get fine-grained status updates for a fine-tuning job.", + "summary": "List fine-tuning job events", + "description": "Returns the status events emitted during the specified fine-tuning job.", "parameters": [ { "name": "fine_tuning_job_id", @@ -13481,8 +15260,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -13500,7 +15289,8 @@ "/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause": { "post": { "operationId": "pauseFineTuningJob", - "description": "Pause a running fine-tune job.", + "summary": "Pause a fine-tuning job", + "description": "Pauses the specified fine-tuning job while it is running.", "parameters": [ { "name": "fine_tuning_job_id", @@ -13533,8 +15323,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -13552,7 +15352,8 @@ "/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume": { "post": { "operationId": "resumeFineTuningJob", - "description": "Resume a paused fine-tune job.", + "summary": "Resume a fine-tuning job", + "description": "Resumes the specified fine-tuning job after it has been paused.", "parameters": [ { "name": "fine_tuning_job_id", @@ -13585,8 +15386,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -13603,7 +15414,9 @@ }, "/openai/v1/responses": { "post": { - "operationId": "createResponse_createResponseStream", + "operationId": "createResponse", + "summary": "Create a model response", + "description": "Creates a model response. Provide text or image inputs to generate text or JSON outputs. Have the model call your own custom code or use built-in tools like web search or file search to use your own data as input for the model’s response.", "parameters": [ { "name": "x-ms-user-isolation-key", @@ -13615,7 +15428,6 @@ } } ], - "description": "Creates a model response. Creates a model response (streaming response).", "responses": { "200": { "description": "The request has succeeded.", @@ -13631,7 +15443,334 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OpenAI.Response" + "type": "object", + "properties": { + "metadata": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" + } + ] + }, + "top_logprobs": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" + } + ] + }, + "temperature": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.numeric" + }, + { + "type": "null" + } + ], + "default": 1 + }, + "top_p": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.numeric" + }, + { + "type": "null" + } + ], + "default": 1 + }, + "user": { + "type": "string", + "description": "This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations.\n A stable identifier for your end-users.\n Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).", + "deprecated": true + }, + "safety_identifier": { + "type": "string", + "maxLength": 64, + "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." + }, + "prompt_cache_key": { + "type": "string", + "description": "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching)." + }, + "service_tier": { + "$ref": "#/components/schemas/OpenAI.ServiceTier" + }, + "prompt_cache_retention": { + "anyOf": [ + { + "type": "string", + "enum": [ + "in_memory", + "24h" + ] + }, + { + "type": "null" + } + ] + }, + "previous_response_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "model": { + "type": "string", + "description": "The model deployment to use for the creation of this response." + }, + "reasoning": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.Reasoning" + }, + { + "type": "null" + } + ] + }, + "background": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, + "max_tool_calls": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" + } + ] + }, + "text": { + "$ref": "#/components/schemas/OpenAI.ResponseTextParam" + }, + "tools": { + "$ref": "#/components/schemas/OpenAI.ToolsArray" + }, + "tool_choice": { + "oneOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolChoiceOptions" + }, + { + "$ref": "#/components/schemas/OpenAI.ToolChoiceParam" + } + ] + }, + "prompt": { + "$ref": "#/components/schemas/OpenAI.Prompt" + }, + "truncation": { + "anyOf": [ + { + "type": "string", + "enum": [ + "auto", + "disabled" + ] + }, + { + "type": "null" + } + ], + "default": "disabled" + }, + "id": { + "type": "string", + "description": "Unique identifier for this Response." + }, + "object": { + "type": "string", + "enum": [ + "response" + ], + "description": "The object type of this resource - always set to `response`.", + "x-stainless-const": true + }, + "status": { + "type": "string", + "enum": [ + "completed", + "failed", + "in_progress", + "cancelled", + "queued", + "incomplete" + ], + "description": "The status of the response generation. One of `completed`, `failed`,\n `in_progress`, `cancelled`, `queued`, or `incomplete`." + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "Unix timestamp (in seconds) of when this Response was created." + }, + "completed_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "type": "integer", + "format": "unixTimestamp" + }, + "error": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseError" + }, + { + "type": "null" + } + ] + }, + "incomplete_details": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseIncompleteDetails" + }, + { + "type": "null" + } + ] + }, + "output": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.OutputItem" + }, + "description": "An array of content items generated by the model.\n - The length and order of items in the `output` array is dependent\n on the model's response.\n - Rather than accessing the first item in the `output` array and\n assuming it's an `assistant` message with the content generated by\n the model, you might consider using the `output_text` property where\n supported in SDKs." + }, + "instructions": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.InputItem" + } + }, + { + "type": "null" + } + ] + }, + "output_text": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "usage": { + "$ref": "#/components/schemas/OpenAI.ResponseUsage" + }, + "moderation": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.Moderation" + }, + { + "type": "null" + } + ] + }, + "parallel_tool_calls": { + "type": "boolean", + "description": "Whether to allow the model to run tool calls in parallel.", + "default": true + }, + "conversation": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationReference" + }, + { + "type": "null" + } + ] + }, + "max_output_tokens": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" + } + ] + }, + "agent": { + "allOf": [ + { + "$ref": "#/components/schemas/AgentId" + } + ], + "description": "(Deprecated) Use agent_reference instead.\nThe agent used for this response" + }, + "agent_session_id": { + "type": "string", + "description": "The session identifier for this response. Currently only relevant for hosted agents.\nAlways returned for hosted agents — either the caller-provided value, the auto-derived value,\nor an auto-generated UUID. Use for session-scoped operations and to maintain sandbox\naffinity in follow-up calls." + }, + "agent_reference": { + "anyOf": [ + { + "$ref": "#/components/schemas/AgentReference" + }, + { + "type": "null" + } + ], + "description": "The agent used for this response" + }, + "content_filters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ContentFilterResult" + }, + "description": "The content filter evaluation results." + } + }, + "required": [ + "id", + "object", + "created_at", + "error", + "incomplete_details", + "output", + "instructions", + "parallel_tool_calls", + "agent_reference" + ] } }, "text/event-stream": { @@ -13641,8 +15780,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -13660,432 +15809,297 @@ "content": { "application/json": { "schema": { - "anyOf": [ - { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Metadata" - } - ], - "nullable": true - }, - "top_logprobs": { - "type": "integer", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - } - ], - "nullable": true - }, - "temperature": { - "type": "number", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.numeric" - } - ], - "nullable": true, - "default": 1 - }, - "top_p": { - "type": "number", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.numeric" - } - ], - "nullable": true, - "default": 1 - }, - "user": { - "type": "string", - "description": "This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations.\n A stable identifier for your end-users.\n Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).", - "deprecated": true + "type": "object", + "properties": { + "metadata": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.Metadata" }, - "safety_identifier": { - "type": "string", - "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." + { + "type": "null" + } + ] + }, + "top_logprobs": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" }, - "prompt_cache_key": { - "type": "string", - "description": "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching)." + { + "type": "null" + } + ] + }, + "temperature": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.numeric" }, - "service_tier": { - "$ref": "#/components/schemas/OpenAI.ServiceTier" + { + "type": "null" + } + ], + "default": 1 + }, + "top_p": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.numeric" }, - "prompt_cache_retention": { + { + "type": "null" + } + ], + "default": 1 + }, + "user": { + "type": "string", + "description": "This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations.\n A stable identifier for your end-users.\n Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).", + "deprecated": true + }, + "safety_identifier": { + "type": "string", + "maxLength": 64, + "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." + }, + "prompt_cache_key": { + "type": "string", + "description": "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching)." + }, + "service_tier": { + "$ref": "#/components/schemas/OpenAI.ServiceTier" + }, + "prompt_cache_retention": { + "anyOf": [ + { "type": "string", "enum": [ - "in-memory", + "in_memory", "24h" - ], - "nullable": true - }, - "previous_response_id": { - "type": "string", - "nullable": true - }, - "model": { - "type": "string", - "description": "The model deployment to use for the creation of this response." - }, - "reasoning": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Reasoning" - } - ], - "nullable": true - }, - "background": { - "type": "boolean", - "nullable": true - }, - "max_output_tokens": { - "type": "integer", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - } - ], - "nullable": true - }, - "max_tool_calls": { - "type": "integer", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - } - ], - "nullable": true - }, - "text": { - "$ref": "#/components/schemas/OpenAI.ResponseTextParam" - }, - "tools": { - "$ref": "#/components/schemas/OpenAI.ToolsArray" - }, - "tool_choice": { - "oneOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolChoiceOptions" - }, - { - "$ref": "#/components/schemas/OpenAI.ToolChoiceParam" - } ] }, - "prompt": { - "$ref": "#/components/schemas/OpenAI.Prompt" - }, - "truncation": { - "type": "string", - "enum": [ - "auto", - "disabled" - ], - "nullable": true, - "default": "disabled" - }, - "input": { - "$ref": "#/components/schemas/OpenAI.InputParam" - }, - "include": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.IncludeEnum" - }, - "nullable": true - }, - "parallel_tool_calls": { - "type": "boolean", - "nullable": true, - "default": true - }, - "store": { - "type": "boolean", - "nullable": true, - "default": true - }, - "instructions": { - "type": "string", - "nullable": true - }, - "stream": { - "type": "boolean", - "nullable": true - }, - "stream_options": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamOptions" - } - ], - "nullable": true - }, - "conversation": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ConversationParam" - } - ], - "nullable": true - }, - "context_management": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.ContextManagementParam" - }, - "nullable": true, - "description": "Context management configuration for this request." - }, - "agent": { - "allOf": [ - { - "$ref": "#/components/schemas/AgentReference" - } - ], - "description": "(Deprecated) Use agent_reference instead.\nThe agent to use for generating the response." - }, - "agent_session_id": { - "type": "string", - "description": "Optional session identifier for sandbox affinity. Currently only relevant for hosted agents.\nWhen provided, the request is routed to the same sandbox. When omitted, auto-derived from\nconversation_id/prev_response_id or a new UUID is generated." - }, - "agent_reference": { - "allOf": [ - { - "$ref": "#/components/schemas/AgentReference" - } - ], - "description": "The agent to use for generating the response." - }, - "structured_inputs": { - "type": "object", - "additionalProperties": {}, - "description": "The structured inputs to the response that can participate in prompt template substitution or tool argument bindings." + { + "type": "null" } - } + ] }, - { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Metadata" - } - ], - "nullable": true - }, - "top_logprobs": { - "type": "integer", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - } - ], - "nullable": true - }, - "temperature": { - "type": "number", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.numeric" - } - ], - "nullable": true, - "default": 1 - }, - "top_p": { - "type": "number", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.numeric" - } - ], - "nullable": true, - "default": 1 - }, - "user": { - "type": "string", - "description": "This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations.\n A stable identifier for your end-users.\n Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).", - "deprecated": true - }, - "safety_identifier": { - "type": "string", - "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." - }, - "prompt_cache_key": { - "type": "string", - "description": "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching)." - }, - "service_tier": { - "$ref": "#/components/schemas/OpenAI.ServiceTier" - }, - "prompt_cache_retention": { - "type": "string", - "enum": [ - "in-memory", - "24h" - ], - "nullable": true - }, - "previous_response_id": { - "type": "string", - "nullable": true - }, - "model": { - "type": "string", - "description": "The model deployment to use for the creation of this response." - }, - "reasoning": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Reasoning" - } - ], - "nullable": true - }, - "background": { - "type": "boolean", - "nullable": true - }, - "max_output_tokens": { - "type": "integer", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - } - ], - "nullable": true - }, - "max_tool_calls": { - "type": "integer", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - } - ], - "nullable": true + "previous_response_id": { + "anyOf": [ + { + "type": "string" }, - "text": { - "$ref": "#/components/schemas/OpenAI.ResponseTextParam" + { + "type": "null" + } + ] + }, + "model": { + "type": "string", + "description": "The model deployment to use for the creation of this response." + }, + "reasoning": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.Reasoning" }, - "tools": { - "$ref": "#/components/schemas/OpenAI.ToolsArray" + { + "type": "null" + } + ] + }, + "background": { + "anyOf": [ + { + "type": "boolean" }, - "tool_choice": { - "oneOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolChoiceOptions" - }, - { - "$ref": "#/components/schemas/OpenAI.ToolChoiceParam" - } - ] + { + "type": "null" + } + ] + }, + "max_tool_calls": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" }, - "prompt": { - "$ref": "#/components/schemas/OpenAI.Prompt" + { + "type": "null" + } + ] + }, + "text": { + "$ref": "#/components/schemas/OpenAI.ResponseTextParam" + }, + "tools": { + "$ref": "#/components/schemas/OpenAI.ToolsArray" + }, + "tool_choice": { + "oneOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolChoiceOptions" }, - "truncation": { + { + "$ref": "#/components/schemas/OpenAI.ToolChoiceParam" + } + ] + }, + "prompt": { + "$ref": "#/components/schemas/OpenAI.Prompt" + }, + "truncation": { + "anyOf": [ + { "type": "string", "enum": [ "auto", "disabled" - ], - "nullable": true, - "default": "disabled" - }, - "input": { - "$ref": "#/components/schemas/OpenAI.InputParam" + ] }, - "include": { + { + "type": "null" + } + ], + "default": "disabled" + }, + "input": { + "$ref": "#/components/schemas/OpenAI.InputParam" + }, + "include": { + "anyOf": [ + { "type": "array", "items": { "$ref": "#/components/schemas/OpenAI.IncludeEnum" - }, - "nullable": true + } }, - "parallel_tool_calls": { - "type": "boolean", - "nullable": true, - "default": true + { + "type": "null" + } + ] + }, + "parallel_tool_calls": { + "anyOf": [ + { + "type": "boolean" }, - "store": { - "type": "boolean", - "nullable": true, - "default": true + { + "type": "null" + } + ], + "default": true + }, + "store": { + "anyOf": [ + { + "type": "boolean" }, - "instructions": { - "type": "string", - "nullable": true + { + "type": "null" + } + ], + "default": true + }, + "instructions": { + "anyOf": [ + { + "type": "string" }, - "stream": { - "type": "boolean", - "nullable": true + { + "type": "null" + } + ] + }, + "moderation": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.ModerationParam" }, - "stream_options": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamOptions" - } - ], - "nullable": true + { + "type": "null" + } + ] + }, + "stream": { + "anyOf": [ + { + "type": "boolean" }, - "conversation": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ConversationParam" - } - ], - "nullable": true + { + "type": "null" + } + ] + }, + "stream_options": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamOptions" }, - "context_management": { + { + "type": "null" + } + ] + }, + "conversation": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationParam" + }, + { + "type": "null" + } + ] + }, + "context_management": { + "anyOf": [ + { "type": "array", "items": { "$ref": "#/components/schemas/OpenAI.ContextManagementParam" - }, - "nullable": true, - "description": "Context management configuration for this request." - }, - "agent": { - "allOf": [ - { - "$ref": "#/components/schemas/AgentReference" - } - ], - "description": "(Deprecated) Use agent_reference instead.\nThe agent to use for generating the response." - }, - "agent_session_id": { - "type": "string", - "description": "Optional session identifier for sandbox affinity. Currently only relevant for hosted agents.\nWhen provided, the request is routed to the same sandbox. When omitted, auto-derived from\nconversation_id/prev_response_id or a new UUID is generated." + } }, - "agent_reference": { - "allOf": [ - { - "$ref": "#/components/schemas/AgentReference" - } - ], - "description": "The agent to use for generating the response." + { + "type": "null" + } + ], + "description": "Context management configuration for this request." + }, + "max_output_tokens": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" }, - "structured_inputs": { - "type": "object", - "additionalProperties": {}, - "description": "The structured inputs to the response that can participate in prompt template substitution or tool argument bindings." + { + "type": "null" } - } + ] + }, + "agent": { + "allOf": [ + { + "$ref": "#/components/schemas/AgentReference" + } + ], + "description": "(Deprecated) Use agent_reference instead.\nThe agent to use for generating the response." + }, + "agent_session_id": { + "type": "string", + "description": "Optional session identifier for sandbox affinity. Currently only relevant for hosted agents.\nWhen provided, the request is routed to the same sandbox. When omitted, auto-derived from\nconversation_id/prev_response_id or a new UUID is generated." + }, + "agent_reference": { + "allOf": [ + { + "$ref": "#/components/schemas/AgentReference" + } + ], + "description": "The agent to use for generating the response." + }, + "structured_inputs": { + "type": "object", + "unevaluatedProperties": {}, + "description": "The structured inputs to the response that can participate in prompt template substitution or tool argument bindings." } - ] + } } } } @@ -14093,7 +16107,8 @@ }, "get": { "operationId": "listResponses", - "description": "Returns the list of all responses.", + "summary": "List responses", + "description": "Returns a collection of all stored responses matching specified filter criteria.", "parameters": [ { "name": "limit", @@ -14214,8 +16229,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -14233,7 +16258,8 @@ "/openai/v1/responses/compact": { "post": { "operationId": "compactResponseConversation", - "description": "Produces a compaction of a responses conversation.", + "summary": "Compact a conversation", + "description": "Compacts a conversation into a response object suitable for long-running and zero-data-retention scenarios.", "parameters": [], "responses": { "200": { @@ -14246,8 +16272,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -14274,7 +16310,9 @@ }, "/openai/v1/responses/{response_id}": { "get": { - "operationId": "getResponse_getResponseStream", + "operationId": "getResponse", + "summary": "Retrieve a model response", + "description": "Retrieves a model response with the given ID.", "parameters": [ { "name": "response_id", @@ -14324,20 +16362,8 @@ "schema": { "type": "string" } - }, - { - "name": "accept", - "in": "header", - "required": false, - "schema": { - "type": "string", - "enum": [ - "text/event-stream" - ] - } } ], - "description": "Retrieves a model response with the given ID. Retrieves a model response with the given ID (streaming response).", "responses": { "200": { "description": "The request has succeeded.", @@ -14363,8 +16389,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -14380,6 +16416,7 @@ }, "delete": { "operationId": "deleteResponse", + "summary": "Delete a model response", "description": "Deletes a model response.", "parameters": [ { @@ -14421,8 +16458,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -14440,7 +16487,8 @@ "/openai/v1/responses/{response_id}/cancel": { "post": { "operationId": "cancelResponse", - "description": "Cancels a model response.", + "summary": "Cancel a model response", + "description": "Cancels a model response with the given ID. Only responses created with the background parameter set to true can be cancelled.", "parameters": [ { "name": "response_id", @@ -14481,8 +16529,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -14500,7 +16558,8 @@ "/openai/v1/responses/{response_id}/input_items": { "get": { "operationId": "listInputItems", - "description": "Returns a list of input items for a given response.", + "summary": "List input items for a response", + "description": "Retrieves the input items associated with the specified response.", "parameters": [ { "name": "response_id", @@ -14608,8 +16667,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -14627,7 +16696,8 @@ "/redTeams/runs": { "get": { "operationId": "RedTeams_list", - "description": "List a redteam by name.", + "summary": "List redteams", + "description": "Returns the redteams available in the current project.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -14656,8 +16726,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -14684,7 +16773,8 @@ "/redTeams/runs/{name}": { "get": { "operationId": "RedTeams_get", - "description": "Get a redteam by name.", + "summary": "Get a redteam", + "description": "Retrieves the specified redteam and its configuration.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -14722,8 +16812,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -14750,7 +16859,8 @@ "/redTeams/runs:run": { "post": { "operationId": "RedTeams_create", - "description": "Creates a redteam run.", + "summary": "Create a redteam run", + "description": "Submits a new redteam run for execution with the provided configuration.", "parameters": [ { "name": "Foundry-Features", @@ -14786,8 +16896,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -14816,7 +16936,8 @@ "/routines": { "get": { "operationId": "listRoutines", - "description": "List routines.", + "summary": "List routines", + "description": "Returns the routines available in the current project.", "parameters": [ { "name": "Foundry-Features", @@ -14831,46 +16952,16 @@ } }, { - "name": "limit", - "in": "query", - "required": false, - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", - "schema": { - "type": "integer", - "format": "int32", - "default": 20 - }, - "explode": false + "$ref": "#/components/parameters/ListRoutinesParameters.limit" }, { - "name": "order", - "in": "query", - "required": false, - "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", - "schema": { - "$ref": "#/components/schemas/PageOrder" - }, - "explode": false + "$ref": "#/components/parameters/ListRoutinesParameters.after" }, { - "name": "after", - "in": "query", - "required": false, - "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", - "schema": { - "type": "string" - }, - "explode": false + "$ref": "#/components/parameters/ListRoutinesParameters.before" }, { - "name": "before", - "in": "query", - "required": false, - "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "schema": { - "type": "string" - }, - "explode": false + "$ref": "#/components/parameters/ListRoutinesParameters.order" }, { "name": "api-version", @@ -14920,8 +17011,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -14944,7 +17045,8 @@ "/routines/{routine_name}": { "put": { "operationId": "createOrUpdateRoutine", - "description": "Create or update a routine.", + "summary": "Create or update a routine", + "description": "Creates a new routine or replaces an existing routine with the supplied definition.", "parameters": [ { "name": "Foundry-Features", @@ -14983,8 +17085,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -15015,7 +17127,8 @@ }, "get": { "operationId": "getRoutine", - "description": "Retrieve a routine.", + "summary": "Get a routine", + "description": "Retrieves the specified routine and its current configuration.", "parameters": [ { "name": "Foundry-Features", @@ -15054,8 +17167,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -15076,7 +17199,8 @@ }, "delete": { "operationId": "deleteRoutine", - "description": "Delete a routine.", + "summary": "Delete a routine", + "description": "Deletes the specified routine.", "parameters": [ { "name": "Foundry-Features", @@ -15108,8 +17232,18 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful." }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -15132,7 +17266,8 @@ "/routines/{routine_name}/runs": { "get": { "operationId": "listRoutineRuns", - "description": "List prior runs for a routine.", + "summary": "List prior runs for a routine", + "description": "Returns prior runs recorded for the specified routine.", "parameters": [ { "name": "Foundry-Features", @@ -15153,46 +17288,16 @@ "$ref": "#/components/parameters/ListRoutineRunsParameters.filter" }, { - "name": "limit", - "in": "query", - "required": false, - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", - "schema": { - "type": "integer", - "format": "int32", - "default": 20 - }, - "explode": false + "$ref": "#/components/parameters/ListRoutineRunsParameters.limit" }, { - "name": "order", - "in": "query", - "required": false, - "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", - "schema": { - "$ref": "#/components/schemas/PageOrder" - }, - "explode": false + "$ref": "#/components/parameters/ListRoutineRunsParameters.after" }, { - "name": "after", - "in": "query", - "required": false, - "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", - "schema": { - "type": "string" - }, - "explode": false + "$ref": "#/components/parameters/ListRoutineRunsParameters.before" }, { - "name": "before", - "in": "query", - "required": false, - "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "schema": { - "type": "string" - }, - "explode": false + "$ref": "#/components/parameters/ListRoutineRunsParameters.order" }, { "name": "api-version", @@ -15242,8 +17347,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -15266,7 +17381,8 @@ "/routines/{routine_name}:disable": { "post": { "operationId": "disableRoutine", - "description": "Disable a routine.", + "summary": "Disable a routine", + "description": "Disables the specified routine so it no longer runs.", "parameters": [ { "name": "Foundry-Features", @@ -15305,8 +17421,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -15329,7 +17455,8 @@ "/routines/{routine_name}:dispatch_async": { "post": { "operationId": "dispatchRoutineAsync", - "description": "Queue an asynchronous routine dispatch.", + "summary": "Queue an asynchronous routine dispatch", + "description": "Queues an asynchronous dispatch for the specified routine.", "parameters": [ { "name": "Foundry-Features", @@ -15368,8 +17495,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -15402,7 +17539,8 @@ "/routines/{routine_name}:enable": { "post": { "operationId": "enableRoutine", - "description": "Enable a routine.", + "summary": "Enable a routine", + "description": "Enables the specified routine so it can be dispatched.", "parameters": [ { "name": "Foundry-Features", @@ -15441,8 +17579,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -15465,7 +17613,8 @@ "/schedules": { "get": { "operationId": "Schedules_list", - "description": "List all schedules.", + "summary": "List schedules", + "description": "Returns schedules that match the supplied type and enabled filters.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -15514,8 +17663,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -15542,7 +17710,8 @@ "/schedules/{id}": { "delete": { "operationId": "Schedules_delete", - "description": "Delete a schedule.", + "summary": "Delete a schedule", + "description": "Deletes the specified schedule resource.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -15573,8 +17742,27 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful." }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -15599,7 +17787,8 @@ }, "get": { "operationId": "Schedules_get", - "description": "Get a schedule by id.", + "summary": "Get a schedule", + "description": "Retrieves the specified schedule resource.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -15637,8 +17826,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -15663,7 +17871,8 @@ }, "put": { "operationId": "Schedules_createOrUpdate", - "description": "Create or update operation template.", + "summary": "Create or update a schedule", + "description": "Creates a new schedule or updates an existing schedule with the supplied definition.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -15711,8 +17920,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -15750,7 +17978,8 @@ "/schedules/{id}/runs": { "get": { "operationId": "Schedules_listRuns", - "description": "List all schedule runs.", + "summary": "List schedule runs", + "description": "Returns schedule runs that match the supplied filters.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -15808,8 +18037,27 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "headers": { + "x-ms-error-code": { + "required": false, + "description": "String error code indicating what went wrong.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Azure.Core.Foundations.ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "headers": { "x-ms-error-code": { "required": false, @@ -15836,7 +18084,8 @@ "/schedules/{schedule_id}/runs/{run_id}": { "get": { "operationId": "Schedules_getRun", - "description": "Get a schedule run by id.", + "summary": "Get a schedule run", + "description": "Retrieves the specified run for a schedule.", "parameters": [ { "name": "schedule_id", @@ -15890,8 +18139,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -15909,7 +18168,8 @@ "/skills": { "get": { "operationId": "Skills_listSkills", - "description": "Returns the list of all skills.", + "summary": "List skills", + "description": "Returns the skills available in the current project.", "parameters": [ { "name": "limit", @@ -16013,8 +18273,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -16037,7 +18307,8 @@ "/skills/{name}": { "get": { "operationId": "Skills_getSkill", - "description": "Retrieves a skill.", + "summary": "Retrieve a skill", + "description": "Retrieves the specified skill and its current configuration.", "parameters": [ { "name": "name", @@ -16082,8 +18353,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -16104,7 +18385,8 @@ }, "post": { "operationId": "updateSkill", - "description": "Update a skill.", + "summary": "Update a skill", + "description": "Modifies the specified skill's configuration.", "parameters": [ { "name": "name", @@ -16149,8 +18431,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -16190,7 +18482,8 @@ }, "delete": { "operationId": "Skills_deleteSkill", - "description": "Deletes a skill.", + "summary": "Delete a skill", + "description": "Removes the specified skill and its associated versions.", "parameters": [ { "name": "name", @@ -16235,8 +18528,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -16259,7 +18562,8 @@ "/skills/{name}/content": { "get": { "operationId": "getSkillContent", - "description": "Download the zip content for the default version of a skill.", + "summary": "Download the zip content for the default version of a skill", + "description": "Downloads the zip content for the default version of a skill.", "parameters": [ { "name": "name", @@ -16299,14 +18603,23 @@ "content": { "application/zip": { "schema": { - "type": "string", - "format": "binary" + "contentMediaType": "application/zip" } } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -16363,6 +18676,7 @@ } ], "description": "Creates a new version of a skill. If the skill does not exist, it will be created. Creates a new version of a skill from uploaded files via multipart form data.", + "summary": "Create a new version of a skill Create a skill version from uploaded files", "responses": { "200": { "description": "The request has succeeded.", @@ -16374,8 +18688,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -16385,6 +18709,8 @@ } } }, + "x-ms-description-override": "Creates a new version of a skill. If the skill does not exist, it will be created.", + "x-ms-summary-override": "Create a new version of a skill", "x-ms-foundry-meta": { "required_previews": [ "Skills=V1Preview" @@ -16433,7 +18759,8 @@ }, "get": { "operationId": "listSkillVersions", - "description": "List all versions of a skill.", + "summary": "List skill versions", + "description": "Returns the available versions for the specified skill.", "parameters": [ { "name": "name", @@ -16546,8 +18873,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -16570,7 +18907,8 @@ "/skills/{name}/versions/{version}": { "get": { "operationId": "getSkillVersion", - "description": "Retrieve a specific version of a skill.", + "summary": "Retrieve a specific version of a skill", + "description": "Retrieves the specified version of a skill by name and version identifier.", "parameters": [ { "name": "name", @@ -16624,8 +18962,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -16646,7 +18994,8 @@ }, "delete": { "operationId": "deleteSkillVersion", - "description": "Delete a specific version of a skill.", + "summary": "Delete a specific version of a skill", + "description": "Removes the specified version of a skill.", "parameters": [ { "name": "name", @@ -16700,8 +19049,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -16724,7 +19083,8 @@ "/skills/{name}/versions/{version}/content": { "get": { "operationId": "getSkillVersionContent", - "description": "Download the zip content for a specific version of a skill.", + "summary": "Download the zip content for a specific version of a skill", + "description": "Downloads the zip content for a specific version of a skill.", "parameters": [ { "name": "name", @@ -16773,14 +19133,23 @@ "content": { "application/zip": { "schema": { - "type": "string", - "format": "binary" + "contentMediaType": "application/zip" } } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -16803,7 +19172,8 @@ "/toolboxes": { "get": { "operationId": "listToolboxes", - "description": "List all toolboxes.", + "summary": "List toolboxes", + "description": "Returns the toolboxes available in the current project.", "parameters": [ { "name": "limit", @@ -16847,6 +19217,18 @@ }, "explode": false }, + { + "name": "Foundry-Features", + "in": "header", + "required": true, + "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", + "schema": { + "type": "string", + "enum": [ + "Toolboxes=V1Preview" + ] + } + }, { "name": "api-version", "in": "query", @@ -16895,8 +19277,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -16908,13 +19300,19 @@ }, "tags": [ "Toolboxes" - ] + ], + "x-ms-foundry-meta": { + "conditional_previews": [ + "Toolboxes=V1Preview" + ] + } } }, "/toolboxes/{name}": { "get": { "operationId": "getToolbox", - "description": "Retrieve a toolbox.", + "summary": "Retrieve a toolbox", + "description": "Retrieves the specified toolbox and its current configuration.", "parameters": [ { "name": "name", @@ -16925,6 +19323,18 @@ "type": "string" } }, + { + "name": "Foundry-Features", + "in": "header", + "required": true, + "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", + "schema": { + "type": "string", + "enum": [ + "Toolboxes=V1Preview" + ] + } + }, { "name": "api-version", "in": "query", @@ -16947,8 +19357,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -16960,15 +19380,33 @@ }, "tags": [ "Toolboxes" - ] + ], + "x-ms-foundry-meta": { + "conditional_previews": [ + "Toolboxes=V1Preview" + ] + } }, "patch": { "operationId": "updateToolbox", - "description": "Update a toolbox to point to a specific version.", + "summary": "Update a toolbox to point to a specific version", + "description": "Updates the toolbox's default version pointer to the specified version.", "parameters": [ { "$ref": "#/components/parameters/UpdateToolboxRequest.name" }, + { + "name": "Foundry-Features", + "in": "header", + "required": true, + "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", + "schema": { + "type": "string", + "enum": [ + "Toolboxes=V1Preview" + ] + } + }, { "name": "api-version", "in": "query", @@ -16991,8 +19429,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -17014,11 +19462,17 @@ } } } + }, + "x-ms-foundry-meta": { + "conditional_previews": [ + "Toolboxes=V1Preview" + ] } }, "delete": { "operationId": "deleteToolbox", - "description": "Delete a toolbox and all its versions.", + "summary": "Delete a toolbox", + "description": "Removes the specified toolbox along with all of its versions.", "parameters": [ { "name": "name", @@ -17029,6 +19483,18 @@ "type": "string" } }, + { + "name": "Foundry-Features", + "in": "header", + "required": true, + "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", + "schema": { + "type": "string", + "enum": [ + "Toolboxes=V1Preview" + ] + } + }, { "name": "api-version", "in": "query", @@ -17044,8 +19510,18 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful. " }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -17057,13 +19533,19 @@ }, "tags": [ "Toolboxes" - ] + ], + "x-ms-foundry-meta": { + "conditional_previews": [ + "Toolboxes=V1Preview" + ] + } } }, "/toolboxes/{name}/versions": { "post": { "operationId": "createToolboxVersion", - "description": "Create a new version of a toolbox. If the toolbox does not exist, it will be created.", + "summary": "Create a new version of a toolbox", + "description": "Creates a new toolbox version, provisioning the toolbox itself if it does not already exist.", "parameters": [ { "name": "name", @@ -17075,6 +19557,18 @@ "maxLength": 256 } }, + { + "name": "Foundry-Features", + "in": "header", + "required": true, + "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", + "schema": { + "type": "string", + "enum": [ + "Toolboxes=V1Preview" + ] + } + }, { "name": "api-version", "in": "query", @@ -17097,8 +19591,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -17125,7 +19629,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Arbitrary key-value metadata to associate with the toolbox." @@ -17159,11 +19663,17 @@ } } } + }, + "x-ms-foundry-meta": { + "conditional_previews": [ + "Toolboxes=V1Preview" + ] } }, "get": { "operationId": "listToolboxVersions", - "description": "List all versions of a toolbox.", + "summary": "List toolbox versions", + "description": "Returns the available versions for the specified toolbox.", "parameters": [ { "name": "name", @@ -17216,6 +19726,18 @@ }, "explode": false }, + { + "name": "Foundry-Features", + "in": "header", + "required": true, + "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", + "schema": { + "type": "string", + "enum": [ + "Toolboxes=V1Preview" + ] + } + }, { "name": "api-version", "in": "query", @@ -17264,8 +19786,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -17277,13 +19809,19 @@ }, "tags": [ "Toolboxes" - ] + ], + "x-ms-foundry-meta": { + "conditional_previews": [ + "Toolboxes=V1Preview" + ] + } } }, "/toolboxes/{name}/versions/{version}": { "get": { "operationId": "getToolboxVersion", - "description": "Retrieve a specific version of a toolbox.", + "summary": "Retrieve a specific version of a toolbox", + "description": "Retrieves the specified version of a toolbox by name and version identifier.", "parameters": [ { "name": "name", @@ -17303,6 +19841,18 @@ "type": "string" } }, + { + "name": "Foundry-Features", + "in": "header", + "required": true, + "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", + "schema": { + "type": "string", + "enum": [ + "Toolboxes=V1Preview" + ] + } + }, { "name": "api-version", "in": "query", @@ -17325,8 +19875,18 @@ } } }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -17338,11 +19898,17 @@ }, "tags": [ "Toolboxes" - ] + ], + "x-ms-foundry-meta": { + "conditional_previews": [ + "Toolboxes=V1Preview" + ] + } }, "delete": { "operationId": "deleteToolboxVersion", - "description": "Delete a specific version of a toolbox.", + "summary": "Delete a specific version of a toolbox", + "description": "Removes the specified version of a toolbox.", "parameters": [ { "name": "name", @@ -17362,6 +19928,18 @@ "type": "string" } }, + { + "name": "Foundry-Features", + "in": "header", + "required": true, + "description": "A feature flag opt-in required when using preview operations or modifying persisted preview resources.", + "schema": { + "type": "string", + "enum": [ + "Toolboxes=V1Preview" + ] + } + }, { "name": "api-version", "in": "query", @@ -17377,8 +19955,18 @@ "204": { "description": "There is no content to send for this request, but the headers may be useful. " }, - "default": { - "description": "An unexpected error response.", + "4XX": { + "description": "Client error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "5XX": { + "description": "Server error", "content": { "application/json": { "schema": { @@ -17390,7 +19978,12 @@ }, "tags": [ "Toolboxes" - ] + ], + "x-ms-foundry-meta": { + "conditional_previews": [ + "Toolboxes=V1Preview" + ] + } } } }, @@ -17483,6 +20076,26 @@ "maxLength": 128 } }, + "ListRoutineRunsParameters.after": { + "name": "after", + "in": "query", + "required": false, + "description": "An opaque cursor returned as last_id by the previous list-runs response.", + "schema": { + "type": "string" + }, + "explode": false + }, + "ListRoutineRunsParameters.before": { + "name": "before", + "in": "query", + "required": false, + "description": "Unsupported. Reserved for future backward pagination support.", + "schema": { + "type": "string" + }, + "explode": false + }, "ListRoutineRunsParameters.filter": { "name": "filter", "in": "query", @@ -17493,6 +20106,27 @@ }, "explode": false }, + "ListRoutineRunsParameters.limit": { + "name": "limit", + "in": "query", + "required": false, + "description": "The maximum number of runs to return.", + "schema": { + "type": "integer", + "format": "int32" + }, + "explode": false + }, + "ListRoutineRunsParameters.order": { + "name": "order", + "in": "query", + "required": false, + "description": "The ordering direction. Supported values are asc and desc.", + "schema": { + "type": "string" + }, + "explode": false + }, "ListRoutineRunsParameters.routine_name": { "name": "routine_name", "in": "path", @@ -17503,6 +20137,47 @@ "maxLength": 128 } }, + "ListRoutinesParameters.after": { + "name": "after", + "in": "query", + "required": false, + "description": "An opaque cursor returned as last_id by the previous list response.", + "schema": { + "type": "string" + }, + "explode": false + }, + "ListRoutinesParameters.before": { + "name": "before", + "in": "query", + "required": false, + "description": "Unsupported. Reserved for future backward pagination support.", + "schema": { + "type": "string" + }, + "explode": false + }, + "ListRoutinesParameters.limit": { + "name": "limit", + "in": "query", + "required": false, + "description": "The maximum number of routines to return.", + "schema": { + "type": "integer", + "format": "int32" + }, + "explode": false + }, + "ListRoutinesParameters.order": { + "name": "order", + "in": "query", + "required": false, + "description": "The ordering direction. Supported values are asc and desc.", + "schema": { + "type": "string" + }, + "explode": false + }, "UpdateToolboxRequest.name": { "name": "name", "in": "path", @@ -17566,8 +20241,7 @@ "type": "string", "enum": [ "a2a_preview" - ], - "description": "The type of the tool. Always `\"a2a_preview`." + ] }, "base_url": { "type": "string", @@ -17980,13 +20654,17 @@ "type": "integer", "format": "int32", "description": "The maximum number of replicas for the container. Default is 1.", - "example": 10 + "examples": [ + 10 + ] }, "min_replicas": { "type": "integer", "format": "int32", "description": "The minimum number of replicas for the container. Default is 1.", - "example": 1 + "examples": [ + 1 + ] }, "error_message": { "type": "string", @@ -18410,7 +21088,7 @@ }, "evaluators": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/EvaluatorConfiguration" }, "description": "Evaluators to be used for the evaluation." @@ -18487,7 +21165,7 @@ }, "additionalDetails": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Additional properties relevant to the evaluator. These will differ between evaluators." @@ -18675,23 +21353,6 @@ } } }, - "AgentIdentifier": { - "type": "object", - "required": [ - "agentName" - ], - "properties": { - "agentName": { - "type": "string", - "description": "Registered Foundry agent name (required)." - }, - "agentVersion": { - "type": "string", - "description": "Pinned agent version. Defaults to latest if omitted." - } - }, - "description": "Identifies the registered Foundry agent to optimize (request-only). Skills, tools, and systemPrompt are specified in options.optimizationConfig." - }, "AgentIdentity": { "type": "object", "required": [ @@ -18847,6 +21508,7 @@ "enum": [ "activity_protocol", "responses", + "a2a", "mcp", "invocations", "invocations_ws" @@ -18948,7 +21610,6 @@ "idle", "updating", "failed", - "stopping", "deleting", "deleted", "expired" @@ -19046,11 +21707,17 @@ ], "properties": { "metadata": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "nullable": true, + "anyOf": [ + { + "type": "object", + "unevaluatedProperties": { + "type": "string" + } + }, + { + "type": "null" + } + ], "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "x-oaiTypeLabel": "map" }, @@ -19946,8 +22613,7 @@ "type": "string", "enum": [ "azure_ai_search" - ], - "description": "The object type, which is always 'azure_ai_search'." + ] }, "azure_ai_search": { "allOf": [ @@ -20429,7 +23095,7 @@ }, "parameters": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The parameters the functions accepts, described as a JSON Schema object." } }, @@ -20944,204 +23610,9 @@ "$ref": "#/components/schemas/OpenAI.OutputItem" } ], - "description": "A Bing grounding tool call." - }, - "BingGroundingToolCallOutput": { - "type": "object", - "required": [ - "type", - "call_id", - "status" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "bing_grounding_call_output" - ] - }, - "call_id": { - "type": "string", - "description": "The unique ID of the tool call generated by the model." - }, - "output": { - "allOf": [ - { - "$ref": "#/components/schemas/ToolCallOutputContent" - } - ], - "description": "The output from the Bing grounding tool call." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/ToolCallStatus" - } - ], - "description": "The status of the tool call." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.OutputItem" - } - ], - "description": "The output of a Bing grounding tool call." - }, - "BlobReference": { - "type": "object", - "required": [ - "blobUri", - "storageAccountArmId", - "credential" - ], - "properties": { - "blobUri": { - "type": "string", - "format": "uri", - "description": "Blob URI path for client to upload data. Example: `https://blob.windows.core.net/Container/Path`" - }, - "storageAccountArmId": { - "type": "string", - "description": "ARM ID of the storage account to use." - }, - "credential": { - "allOf": [ - { - "$ref": "#/components/schemas/SasCredential" - } - ], - "description": "Credential info to access the storage account." - } - }, - "description": "Blob reference details." - }, - "BotServiceAuthorizationScheme": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "BotService" - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/AgentEndpointAuthorizationScheme" - } - ], - "x-ms-foundry-meta": { - "required_previews": [ - "AgentEndpoints=V1Preview" - ] - } - }, - "BotServiceRbacAuthorizationScheme": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "BotServiceRbac" - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/AgentEndpointAuthorizationScheme" - } - ], - "x-ms-foundry-meta": { - "required_previews": [ - "AgentEndpoints=V1Preview" - ] - } - }, - "BrowserAutomationPreviewTool": { - "type": "object", - "required": [ - "type", - "browser_automation_preview" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "browser_automation_preview" - ], - "description": "The object type, which is always 'browser_automation_preview'." - }, - "name": { - "type": "string", - "description": "Optional user-defined name for this tool or configuration." - }, - "description": { - "type": "string", - "description": "Optional user-defined description for this tool or configuration." - }, - "browser_automation_preview": { - "allOf": [ - { - "$ref": "#/components/schemas/BrowserAutomationToolParameters" - } - ], - "description": "The Browser Automation Tool parameters." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Tool" - } - ], - "description": "The input definition information for a Browser Automation Tool, as used to configure an Agent." - }, - "BrowserAutomationToolCall": { - "type": "object", - "required": [ - "type", - "call_id", - "arguments", - "status" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "browser_automation_preview_call" - ] - }, - "call_id": { - "type": "string", - "description": "The unique ID of the tool call generated by the model." - }, - "arguments": { - "type": "string", - "description": "A JSON string of the arguments to pass to the tool." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/ToolCallStatus" - } - ], - "description": "The status of the tool call." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.OutputItem" - } - ], - "description": "A browser automation tool call." + "description": "A Bing grounding tool call." }, - "BrowserAutomationToolCallOutput": { + "BingGroundingToolCallOutput": { "type": "object", "required": [ "type", @@ -21152,7 +23623,7 @@ "type": { "type": "string", "enum": [ - "browser_automation_preview_call_output" + "bing_grounding_call_output" ] }, "call_id": { @@ -21165,7 +23636,7 @@ "$ref": "#/components/schemas/ToolCallOutputContent" } ], - "description": "The output from the browser automation tool call." + "description": "The output from the Bing grounding tool call." }, "status": { "allOf": [ @@ -21181,191 +23652,232 @@ "$ref": "#/components/schemas/OpenAI.OutputItem" } ], - "description": "The output of a browser automation tool call." + "description": "The output of a Bing grounding tool call." }, - "BrowserAutomationToolConnectionParameters": { + "BlobReference": { "type": "object", "required": [ - "project_connection_id" + "blobUri", + "storageAccountArmId", + "credential" ], "properties": { - "project_connection_id": { + "blobUri": { "type": "string", - "description": "The ID of the project connection to your Azure Playwright resource." + "format": "uri", + "description": "Blob URI path for client to upload data. Example: `https://blob.windows.core.net/Container/Path`" + }, + "storageAccountArmId": { + "type": "string", + "description": "ARM ID of the storage account to use." + }, + "credential": { + "allOf": [ + { + "$ref": "#/components/schemas/SasCredential" + } + ], + "description": "Credential info to access the storage account." } }, - "description": "Definition of input parameters for the connection used by the Browser Automation Tool." + "description": "Blob reference details." }, - "BrowserAutomationToolParameters": { + "BotServiceAuthorizationScheme": { "type": "object", "required": [ - "connection" + "type" ], "properties": { - "connection": { - "allOf": [ - { - "$ref": "#/components/schemas/BrowserAutomationToolConnectionParameters" - } - ], - "description": "The project connection parameters associated with the Browser Automation Tool." + "type": { + "type": "string", + "enum": [ + "BotService" + ] } }, - "description": "Definition of input parameters for the Browser Automation Tool." + "allOf": [ + { + "$ref": "#/components/schemas/AgentEndpointAuthorizationScheme" + } + ], + "x-ms-foundry-meta": { + "required_previews": [ + "AgentEndpoints=V1Preview" + ] + } }, - "CandidateDeployConfig": { + "BotServiceRbacAuthorizationScheme": { "type": "object", + "required": [ + "type" + ], "properties": { - "instructions": { - "type": "string", - "description": "System prompt / instructions." - }, - "model": { + "type": { "type": "string", - "description": "Foundry deployment name." - }, - "temperature": { - "type": "number", - "format": "float", - "minimum": 0, - "maximum": 2, - "description": "Optional sampling temperature." - }, - "skills": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": {} - }, - "description": "Optional skill overrides." - }, - "tools": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": {} - }, - "description": "Optional tool overrides." + "enum": [ + "BotServiceRbac" + ] } }, - "description": "Deploy-config blob for a candidate. Suitable for setting OPTIMIZATION_CONFIG on a hosted-agent version." + "allOf": [ + { + "$ref": "#/components/schemas/AgentEndpointAuthorizationScheme" + } + ], + "x-ms-foundry-meta": { + "required_previews": [ + "AgentEndpoints=V1Preview" + ] + } }, - "CandidateFileInfo": { + "BrowserAutomationPreviewTool": { "type": "object", "required": [ - "path", "type", - "sizeBytes" + "browser_automation_preview" ], "properties": { - "path": { + "type": { "type": "string", - "description": "Relative path of the file." + "enum": [ + "browser_automation_preview" + ], + "description": "The object type, which is always 'browser_automation_preview'." }, - "type": { + "name": { "type": "string", - "description": "File type category (e.g. 'config', 'results')." + "description": "Optional user-defined name for this tool or configuration." }, - "sizeBytes": { - "type": "integer", - "format": "int64", - "description": "File size in bytes." + "description": { + "type": "string", + "description": "Optional user-defined description for this tool or configuration." + }, + "browser_automation_preview": { + "allOf": [ + { + "$ref": "#/components/schemas/BrowserAutomationToolParameters" + } + ], + "description": "The Browser Automation Tool parameters." } }, - "description": "File entry in a candidate's blob directory." + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Tool" + } + ], + "description": "The input definition information for a Browser Automation Tool, as used to configure an Agent." }, - "CandidateMetadata": { + "BrowserAutomationToolCall": { "type": "object", "required": [ - "candidateId", - "jobId", - "candidateName", - "status", - "hasResults", - "createdAt", - "updatedAt", - "files" + "type", + "call_id", + "arguments", + "status" ], "properties": { - "candidateId": { + "type": { "type": "string", - "description": "Server-assigned candidate identifier." + "enum": [ + "browser_automation_preview_call" + ] }, - "jobId": { + "call_id": { "type": "string", - "description": "Owning optimization job id." + "description": "The unique ID of the tool call generated by the model." }, - "candidateName": { + "arguments": { "type": "string", - "description": "Display name of the candidate." + "description": "A JSON string of the arguments to pass to the tool." }, "status": { - "type": "string", - "description": "Candidate lifecycle status." - }, - "score": { - "type": "number", - "format": "double", - "description": "Candidate's aggregate score." - }, - "hasResults": { - "type": "boolean", - "description": "Whether detailed results are available for this candidate." - }, - "createdAt": { "allOf": [ { - "$ref": "#/components/schemas/FoundryTimestamp" + "$ref": "#/components/schemas/ToolCallStatus" } ], - "description": "Timestamp when the candidate was created, represented in Unix time." + "description": "The status of the tool call." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "description": "A browser automation tool call." + }, + "BrowserAutomationToolCallOutput": { + "type": "object", + "required": [ + "type", + "call_id", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "browser_automation_preview_call_output" + ] + }, + "call_id": { + "type": "string", + "description": "The unique ID of the tool call generated by the model." }, - "updatedAt": { + "output": { "allOf": [ { - "$ref": "#/components/schemas/FoundryTimestamp" + "$ref": "#/components/schemas/ToolCallOutputContent" } ], - "description": "Timestamp when the candidate was last updated, represented in Unix time." + "description": "The output from the browser automation tool call." }, - "promotion": { + "status": { "allOf": [ { - "$ref": "#/components/schemas/PromotionInfo" + "$ref": "#/components/schemas/ToolCallStatus" } ], - "description": "Promotion metadata. Null if not promoted." - }, - "files": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CandidateFileInfo" - }, - "description": "Files in the candidate's blob directory." + "description": "The status of the tool call." } }, - "description": "Candidate metadata returned by GET /candidates/{id}." + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "description": "The output of a browser automation tool call." }, - "CandidateResults": { + "BrowserAutomationToolConnectionParameters": { "type": "object", "required": [ - "candidateId", - "results" + "project_connection_id" ], "properties": { - "candidateId": { + "project_connection_id": { "type": "string", - "description": "Owning candidate id." - }, - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OptimizationTaskResult" - }, - "description": "Per-task evaluation rows." + "description": "The ID of the project connection to your Azure Playwright resource." + } + }, + "description": "Definition of input parameters for the connection used by the Browser Automation Tool." + }, + "BrowserAutomationToolParameters": { + "type": "object", + "required": [ + "connection" + ], + "properties": { + "connection": { + "allOf": [ + { + "$ref": "#/components/schemas/BrowserAutomationToolConnectionParameters" + } + ], + "description": "The project connection parameters associated with the Browser Automation Tool." } }, - "description": "Full per-task evaluation results for a candidate, returned by GET /candidates/{id}/results." + "description": "Definition of input parameters for the Browser Automation Tool." }, "CaptureStructuredOutputsTool": { "type": "object", @@ -21481,7 +23993,7 @@ }, "coordinates": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/ChartCoordinate" }, "description": " Optional mapping of IDs to 2D coordinates used by the UX for visualization.\n\n The map keys are string identifiers (for example, a cluster id or a sample id)\n and the values are the coordinates and visual size for rendering on a 2D chart.\n\n This property is omitted unless the client requests coordinates (for example,\n by passing `includeCoordinates=true` as a query parameter).\n\n Example:\n ```\n {\n \"cluster-1\": { \"x\": 12, \"y\": 34, \"size\": 8 },\n \"sample-123\": { \"x\": 18, \"y\": 22, \"size\": 4 }\n }\n ```\n\n Coordinates are intended only for client-side visualization and do not\n modify the canonical insights results." @@ -21633,9 +24145,7 @@ "type": "string", "enum": [ "code_interpreter" - ], - "description": "The type of the code interpreter tool. Always `code_interpreter`.", - "x-stainless-const": true + ] }, "container": { "anyOf": [ @@ -21737,7 +24247,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Metadata of the connection", @@ -21790,15 +24300,17 @@ "$ref": "#/components/schemas/ProtocolVersionRecord" }, "description": "The protocols that the agent supports for ingress communication of the containers.", - "example": [ - { - "protocol": "responses", - "version": "v0.1.1" - }, - { - "protocol": "a2a", - "version": "v0.3.0" - } + "examples": [ + [ + { + "protocol": "responses", + "version": "v0.1.1" + }, + { + "protocol": "a2a", + "version": "v0.3.0" + } + ] ] }, "container_app_resource_id": { @@ -21808,7 +24320,11 @@ "ingress_subdomain_suffix": { "type": "string", "description": "The suffix to apply to the app subdomain when sending ingress to the agent. This can be a label (e.g., '---current'), a specific revision (e.g., '--0000001'), or empty to use the default endpoint for the container app.", - "example": "--0000001" + "examples": [ + "--0000001", + "---current", + "" + ] } }, "allOf": [ @@ -21832,7 +24348,9 @@ "image": { "type": "string", "description": "The container image for the hosted agent.", - "example": "my-registry.azurecr.io/my-hosted-agent:latest" + "examples": [ + "my-registry.azurecr.io/my-hosted-agent:latest" + ] } }, "description": "Container-based deployment configuration for a hosted agent.", @@ -21981,6 +24499,14 @@ "type": "integer", "format": "int32", "description": "Maximum number of evaluation runs allowed per hour." + }, + "samplingRate": { + "type": "number", + "format": "double", + "maximum": 100, + "description": "Percentage (0-100] chance that a matching event triggers an evaluation. When omitted, the service-default is to evaluate every event, which is equivalent to setting a sampling rate of 100.", + "exclusiveMinimum": 0, + "default": 100 } }, "allOf": [ @@ -22022,7 +24548,7 @@ }, "data_mapping": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Mapping from source fields to response_id field, which is required for retrieving chat history." @@ -22126,8 +24652,6 @@ "description": "JSON metadata including description and hosted definition." }, "code": { - "type": "string", - "format": "binary", "description": "The code zip file (max 250 MB)." } }, @@ -22151,7 +24675,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -22168,7 +24692,7 @@ }, "parameter_values": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The inputs to the manifest that will result in a fully materialized Agent." } } @@ -22187,7 +24711,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -22301,8 +24825,6 @@ "description": "JSON metadata including description and hosted definition." }, "code": { - "type": "string", - "format": "binary", "description": "The code zip file (max 250 MB)." } }, @@ -22324,7 +24846,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -22355,7 +24877,7 @@ "properties": { "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -22372,7 +24894,7 @@ }, "parameter_values": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The inputs to the manifest that will result in a fully materialized Agent." } } @@ -22385,7 +24907,7 @@ "properties": { "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -22447,13 +24969,14 @@ "description": "The name of the evaluation." }, "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "data_source_config": { "oneOf": [ @@ -22503,7 +25026,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of immutable 16 key-value pairs that can be attached to an object for storing additional information.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters." @@ -22522,13 +25045,14 @@ "description": "The name of the run." }, "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "data_source": { "oneOf": [ @@ -22549,7 +25073,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of immutable 16 key-value pairs that can be attached to an object for storing additional information.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters." @@ -22589,10 +25113,7 @@ "properties": { "files": { "type": "array", - "items": { - "type": "string", - "format": "binary" - }, + "items": {}, "description": "Skill files to upload. Upload a single zip file or multiple individual files with relative paths." }, "default": { @@ -22693,7 +25214,7 @@ "readOnly": true } }, - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "allOf": [ @@ -22703,6 +25224,49 @@ ], "description": "Custom credential definition" }, + "CustomRoutineTrigger": { + "type": "object", + "required": [ + "type", + "provider", + "parameters" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "custom" + ], + "description": "The trigger type." + }, + "provider": { + "type": "string", + "maxLength": 128, + "description": "The external provider that emits the custom event." + }, + "event_name": { + "type": "string", + "maxLength": 256, + "description": "The provider-specific event name that fires the routine." + }, + "parameters": { + "type": "object", + "unevaluatedProperties": {}, + "description": "Provider-specific trigger parameters." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/RoutineTrigger" + } + ], + "description": "A custom event routine trigger.", + "x-ms-foundry-meta": { + "conditional_previews": [ + "Routines=V1Preview" + ] + } + }, "DailyRecurrenceSchedule": { "type": "object", "required": [ @@ -22932,7 +25496,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tags to assign to the output. Applies only to dataset outputs (evaluation scenario); ignored for Azure OpenAI file outputs." @@ -23118,13 +25682,15 @@ }, "schema": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The overall object JSON schema for the run data source items." } }, "discriminator": { "propertyName": "type", - "mapping": {} + "mapping": { + "azure_ai_source": "#/components/schemas/AzureAIDataSourceConfig" + } }, "description": "Base class for run data sources with discriminator support." }, @@ -23163,7 +25729,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary of the output dataset.", @@ -23245,50 +25811,6 @@ ], "description": "Dataset source for evaluator generation jobs — reference to a dataset." }, - "DatasetInfo": { - "type": "object", - "required": [ - "taskCount", - "isInline" - ], - "properties": { - "name": { - "type": "string", - "description": "Dataset name when using a registered dataset reference. Null for inline datasets." - }, - "version": { - "type": "string", - "description": "Dataset version when using a registered dataset reference. Null for inline datasets." - }, - "taskCount": { - "type": "integer", - "format": "int32", - "description": "Number of tasks/rows in the dataset." - }, - "isInline": { - "type": "boolean", - "description": "True when the dataset was provided inline in the request body." - } - }, - "description": "Metadata about the dataset used for optimization, surfaced in the response." - }, - "DatasetRef": { - "type": "object", - "required": [ - "name" - ], - "properties": { - "name": { - "type": "string", - "description": "Dataset name." - }, - "version": { - "type": "string", - "description": "Dataset version. If not specified, the latest version is used." - } - }, - "description": "Reference to a registered dataset in the Foundry Dataset Service." - }, "DatasetReference": { "type": "object", "required": [ @@ -23399,7 +25921,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -23780,7 +26302,7 @@ }, "always_applicable": { "type": "boolean", - "description": "When true, the LLM judge always scores this dimension regardless of relevance (skips applicability assessment). The service-generated general quality/policy dimension has this set to true and is non-editable. Users may set this on their own custom dimensions. Defaults to `false`.", + "description": "When true, the LLM judge always scores this dimension regardless of relevance (skips applicability assessment). The service-generated general quality/policy dimension has this set to true and is non-editable. Users may set this on their own custom dimensions. The service defaults to `false` if a value is not specified by the caller.", "default": false } }, @@ -23987,13 +26509,14 @@ "description": "The Unix timestamp (in seconds) for when the eval was created." }, "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "modified_at": { "allOf": [ @@ -24009,7 +26532,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of immutable 16 key-value pairs that can be attached to an object for storing additional information.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters." @@ -24201,13 +26724,14 @@ "description": "Information about the run's data source." }, "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "error": { "$ref": "#/components/schemas/OpenAI.EvalApiError" @@ -24226,7 +26750,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of immutable 16 key-value pairs that can be attached to an object for storing additional information.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters." @@ -24330,7 +26854,7 @@ }, "datasource_item": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "Details of the input data source item." }, "results": { @@ -24386,9 +26910,15 @@ "description": "Whether the grader considered the output a pass." }, "sample": { - "type": "object", - "additionalProperties": {}, - "nullable": true, + "anyOf": [ + { + "type": "object", + "unevaluatedProperties": {} + }, + { + "type": "null" + } + ], "description": "Optional sample or intermediate data produced by the grader." }, "status": { @@ -24418,13 +26948,13 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Additional details about the test criteria metric." } }, - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "A single grader result for an evaluation run output item.", "title": "EvalRunOutputItemResult" }, @@ -24640,21 +27170,21 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Evaluation's tags. Unlike properties, tags are fully mutable." }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Evaluation's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed." }, "evaluators": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/EvaluatorConfiguration" }, "description": "Evaluators to be used for the evaluation." @@ -24884,7 +27414,7 @@ }, "systemData": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "System metadata for the evaluation rule.", @@ -25049,6 +27579,7 @@ }, "evalRun": { "type": "object", + "unevaluatedProperties": {}, "description": "The evaluation run payload." } }, @@ -25221,7 +27752,7 @@ }, "initialization_parameters": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "Optional initialization parameters applied to all generated evaluators.\nFor example, deployment_name for LLM judge model, default threshold." }, "data_generation_options": { @@ -25610,7 +28141,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -25704,7 +28235,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -25789,7 +28320,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Additional properties for the evaluation taxonomy." @@ -25809,7 +28340,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -25831,7 +28362,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Additional properties for the evaluation taxonomy." @@ -25909,7 +28440,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -25931,7 +28462,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Additional properties for the evaluation taxonomy." @@ -25967,12 +28498,12 @@ }, "initParams": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "Initialization parameters of the evaluator." }, "dataMapping": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Data parameters of the evaluator." @@ -26015,17 +28546,17 @@ }, "init_parameters": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The JSON schema (Draft 2020-12) for the evaluator's input parameters. This includes parameters like type, properties, required." }, "data_schema": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The JSON schema (Draft 2020-12) for the evaluator's input data. This includes parameters like type, properties, required." }, "metrics": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/EvaluatorMetric" }, "description": "List of output metrics produced by this evaluator" @@ -26390,7 +28921,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Metadata about the evaluator" @@ -26410,6 +28941,16 @@ }, "description": "The categories of the evaluator" }, + "supported_evaluation_levels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EvaluationLevel" + }, + "description": "Evaluation levels this evaluator supports (e.g., `turn`, `conversation`). When omitted on create, the service defaults to `[\"turn\"]`. On update, omitting this field leaves it unchanged; an empty list is rejected. Custom code-based evaluators support only `turn`; custom prompt-based evaluators support exactly one level (`turn` or `conversation`).", + "default": [ + "turn" + ] + }, "definition": { "allOf": [ { @@ -26474,7 +29015,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Metadata about the evaluator" @@ -26494,6 +29035,16 @@ }, "description": "The categories of the evaluator" }, + "supported_evaluation_levels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EvaluationLevel" + }, + "description": "Evaluation levels this evaluator supports (e.g., `turn`, `conversation`). When omitted on create, the service defaults to `[\"turn\"]`. On update, omitting this field leaves it unchanged; an empty list is rejected. Custom code-based evaluators support only `turn`; custom prompt-based evaluators support exactly one level (`turn` or `conversation`).", + "default": [ + "turn" + ] + }, "definition": { "allOf": [ { @@ -26508,7 +29059,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -26525,7 +29076,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Metadata about the evaluator" @@ -26537,13 +29088,23 @@ }, "description": "The categories of the evaluator" }, + "supported_evaluation_levels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EvaluationLevel" + }, + "description": "Evaluation levels this evaluator supports (e.g., `turn`, `conversation`). When omitted on create, the service defaults to `[\"turn\"]`. On update, omitting this field leaves it unchanged; an empty list is rejected. Custom code-based evaluators support only `turn`; custom prompt-based evaluators support exactly one level (`turn` or `conversation`).", + "default": [ + "turn" + ] + }, "description": { "type": "string", "description": "The asset description text." }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -26705,17 +29266,13 @@ "require_approval": { "anyOf": [ { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" - } - ], - "nullable": true + "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" }, { - "type": "string", - "nullable": true + "type": "string" + }, + { + "type": "null" } ], "description": "(Optional) Whether the agent requires approval before executing actions. Default is always.", @@ -26748,8 +29305,7 @@ "type": "string", "enum": [ "fabric_iq_preview" - ], - "description": "The object type, which is always 'fabric_iq_preview'." + ] }, "project_connection_id": { "type": "string", @@ -26767,17 +29323,13 @@ "require_approval": { "anyOf": [ { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" - } - ], - "nullable": true + "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" }, { - "type": "string", - "nullable": true + "type": "string" + }, + { + "type": "null" } ], "description": "(Optional) Whether the agent requires approval before executing actions. Default is always.", @@ -26902,10 +29454,7 @@ "type": "string", "enum": [ "file_search" - ], - "description": "The type of the file search tool. Always `file_search`.", - "x-stainless-const": true, - "default": "file_search" + ] }, "max_num_results": { "allOf": [ @@ -26924,12 +29473,14 @@ "description": "Ranking options for search." }, "filters": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Filters" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "vector_store_ids": { "type": "array", @@ -27155,19 +29706,40 @@ }, "description": "Details of a function tool call." }, - "GitHubIssueOpenedRoutineTrigger": { + "GitHubIssueEvent": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "opened", + "closed" + ] + } + ], + "description": "Known GitHub issue events that can fire a routine.", + "x-ms-foundry-meta": { + "conditional_previews": [ + "Routines=V1Preview" + ] + } + }, + "GitHubIssueRoutineTrigger": { "type": "object", "required": [ "type", "connection_id", - "assignee", - "repository" + "owner", + "repository", + "issue_event" ], "properties": { "type": { "type": "string", "enum": [ - "github_issue_opened" + "github_issue" ], "description": "The trigger type." }, @@ -27176,15 +29748,23 @@ "maxLength": 256, "description": "The workspace connection identifier that resolves the GitHub configuration for the trigger." }, - "assignee": { + "owner": { "type": "string", "maxLength": 128, - "description": "The GitHub assignee or organization filter that scopes which issues can fire the trigger." + "description": "The GitHub owner or organization that scopes which issues can fire the trigger." }, "repository": { "type": "string", "maxLength": 128, "description": "The GitHub repository filter that scopes which issues can fire the trigger." + }, + "issue_event": { + "allOf": [ + { + "$ref": "#/components/schemas/GitHubIssueEvent" + } + ], + "description": "The GitHub issue event that fires the routine." } }, "allOf": [ @@ -27192,7 +29772,7 @@ "$ref": "#/components/schemas/RoutineTrigger" } ], - "description": "A GitHub issue-opened routine trigger.", + "description": "A GitHub issue routine trigger.", "x-ms-foundry-meta": { "conditional_previews": [ "Routines=V1Preview" @@ -27242,17 +29822,23 @@ "header_name": { "type": "string", "description": "The name of the HTTP header to inject the secret value into.", - "example": "X-Otlp-Api-Key" + "examples": [ + "X-Otlp-Api-Key" + ] }, "secret_id": { "type": "string", "description": "The identifier of the secret store or connection.", - "example": "my-secret-store" + "examples": [ + "my-secret-store" + ] }, "secret_key": { "type": "string", "description": "The key within the secret to retrieve the authentication value.", - "example": "OTLP_KEY" + "examples": [ + "OTLP_KEY" + ] } }, "allOf": [ @@ -27291,23 +29877,29 @@ "cpu": { "type": "string", "description": "The CPU configuration for the hosted agent.", - "example": "0.25" + "examples": [ + "0.25" + ] }, "memory": { "type": "string", "description": "The memory configuration for the hosted agent.", - "example": "0.5Gi" + "examples": [ + "0.5Gi" + ] }, "environment_variables": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Environment variables to set in the hosted agent container.", - "example": { - "name": "LOG_LEVEL", - "value": "debug" - } + "examples": [ + { + "name": "LOG_LEVEL", + "value": "debug" + } + ] }, "container_configuration": { "allOf": [ @@ -27328,15 +29920,17 @@ "$ref": "#/components/schemas/ProtocolVersionRecord" }, "description": "The protocols that the agent supports for ingress communication.", - "example": [ - { - "protocol": "responses", - "version": "v0.1.1" - }, - { - "protocol": "a2a", - "version": "v0.3.0" - } + "examples": [ + [ + { + "protocol": "responses", + "version": "v0.1.1" + }, + { + "protocol": "a2a", + "version": "v0.3.0" + } + ] ], "x-ms-foundry-meta": { "required_previews": [ @@ -27533,7 +30127,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -27789,12 +30383,12 @@ }, "features": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "Features to help with additional filtering of data in UX." }, "correlationInfo": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "Info about the correlation for the analysis sample." } }, @@ -27913,7 +30507,8 @@ "InvokeAgentInvocationsApiDispatchPayload": { "type": "object", "required": [ - "type" + "type", + "input" ], "properties": { "type": { @@ -27924,9 +30519,7 @@ "description": "The manual dispatch payload type." }, "input": { - "type": "string", - "maxLength": 32768, - "description": "The raw input sent to the downstream invocations target." + "description": "The JSON value sent as the complete downstream invocations input. The value is passed through as-is and can be an object, string, number, boolean, array, or null." } }, "allOf": [ @@ -27944,8 +30537,7 @@ "InvokeAgentInvocationsApiRoutineAction": { "type": "object", "required": [ - "type", - "agent_endpoint_id" + "type" ], "properties": { "type": { @@ -27955,10 +30547,18 @@ ], "description": "The action type." }, + "agent_name": { + "type": "string", + "maxLength": 256, + "description": "The project-scoped agent name for routine dispatch." + }, "agent_endpoint_id": { "type": "string", "maxLength": 256, - "description": "The endpoint-scoped agent identifier for invocations API dispatch." + "description": "Legacy endpoint-scoped agent identifier for routine dispatch." + }, + "input": { + "description": "Static JSON value sent as the complete downstream input when the routine fires. The value is passed through as-is; no templating is applied." }, "session_id": { "type": "string", @@ -27971,7 +30571,7 @@ "$ref": "#/components/schemas/RoutineAction" } ], - "description": "Dispatches a routine through the raw invocations API.", + "description": "Dispatches a routine through the raw invocations API. Exactly one of agent_name or agent_endpoint_id must be provided.", "x-ms-foundry-meta": { "conditional_previews": [ "Routines=V1Preview" @@ -27981,7 +30581,8 @@ "InvokeAgentResponsesApiDispatchPayload": { "type": "object", "required": [ - "type" + "type", + "input" ], "properties": { "type": { @@ -27992,9 +30593,7 @@ "description": "The manual dispatch payload type." }, "input": { - "type": "string", - "maxLength": 32768, - "description": "The user input sent to the downstream responses target." + "description": "The JSON value sent as the complete downstream responses input. The value is passed through as-is and can be an object, string, number, boolean, array, or null." } }, "allOf": [ @@ -28025,14 +30624,17 @@ "agent_name": { "type": "string", "maxLength": 256, - "description": "The project-scoped agent name for responses API dispatch." + "description": "The project-scoped agent name for routine dispatch." }, "agent_endpoint_id": { "type": "string", "maxLength": 256, - "description": "The endpoint-scoped agent identifier for responses API dispatch." + "description": "Legacy endpoint-scoped agent identifier for routine dispatch." }, - "conversation_id": { + "input": { + "description": "Static JSON value sent as the complete downstream input when the routine fires. The value is passed through as-is; no templating is applied." + }, + "conversation": { "type": "string", "maxLength": 256, "description": "An optional existing conversation identifier to continue during the downstream dispatch." @@ -28114,7 +30716,8 @@ "red_team_seed_prompts": "#/components/schemas/RedTeamSeedPromptsItemGenerationParams", "red_team_taxonomy": "#/components/schemas/RedTeamTaxonomyItemGenerationParams", "response_retrieval": "#/components/schemas/ResponseRetrievalItemGenerationParams", - "conversation_gen_preview": "#/components/schemas/ConversationGenPreviewItemGenerationParams" + "conversation_gen_preview": "#/components/schemas/ConversationGenPreviewItemGenerationParams", + "synthetic_data_gen_preview": "#/components/schemas/SyntheticDataGenerationPreviewItemGenerationParams" } }, "description": "Represents the set of parameters used to control item generation operations." @@ -28195,9 +30798,7 @@ "type": "string", "enum": [ "mcp" - ], - "description": "The type of the MCP tool. Always `mcp`.", - "x-stainless-const": true + ] }, "server_label": { "type": "string", @@ -28231,11 +30832,17 @@ "description": "Optional description of the MCP server, used to provide more context." }, "headers": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "nullable": true + "anyOf": [ + { + "type": "object", + "unevaluatedProperties": { + "type": "string" + } + }, + { + "type": "null" + } + ] }, "allowed_tools": { "anyOf": [ @@ -28243,42 +30850,38 @@ "type": "array", "items": { "type": "string" - }, - "nullable": true + } }, { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.MCPToolFilter" - } - ], - "nullable": true + "$ref": "#/components/schemas/OpenAI.MCPToolFilter" + }, + { + "type": "null" } ] }, "require_approval": { "anyOf": [ { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" - } - ], - "nullable": true + "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" }, { "type": "string", "enum": [ "always", "never" - ], - "nullable": true + ] + }, + { + "type": "null" } ], "default": "always" }, + "defer_loading": { + "type": "boolean", + "description": "Whether this MCP tool is deferred and discovered via tool search." + }, "project_connection_id": { "type": "string", "description": "The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server." @@ -28740,11 +31343,17 @@ "description": "The status of the tool call." }, "memories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MemoryItem" - }, - "nullable": true, + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/MemoryItem" + } + }, + { + "type": "null" + } + ], "description": "The results returned from the memory search." } }, @@ -28822,7 +31431,7 @@ }, "procedural_memory_enabled": { "type": "boolean", - "description": "Whether to enable procedural memory extraction and storage. Defaults to `true`.", + "description": "Whether to enable procedural memory extraction and storage. The service defaults to `true` if a value is not specified by the caller.", "default": true }, "default_ttl_seconds": { @@ -28972,7 +31581,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Arbitrary key-value metadata to associate with the memory store." @@ -29314,7 +31923,7 @@ }, "capabilities": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Capabilities of deployed model", @@ -29535,7 +32144,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -29742,8 +32351,7 @@ "create_file" ], "description": "Create a new file with the provided diff.", - "x-stainless-const": true, - "default": "create_file" + "x-stainless-const": true }, "path": { "type": "string", @@ -29776,8 +32384,7 @@ "create_file" ], "description": "The operation type. Always `create_file`.", - "x-stainless-const": true, - "default": "create_file" + "x-stainless-const": true }, "path": { "type": "string", @@ -29811,8 +32418,7 @@ "delete_file" ], "description": "Delete the specified file.", - "x-stainless-const": true, - "default": "delete_file" + "x-stainless-const": true }, "path": { "type": "string", @@ -29840,8 +32446,7 @@ "delete_file" ], "description": "The operation type. Always `delete_file`.", - "x-stainless-const": true, - "default": "delete_file" + "x-stainless-const": true }, "path": { "type": "string", @@ -29941,8 +32546,7 @@ "apply_patch" ], "description": "The type of the tool. Always `apply_patch`.", - "x-stainless-const": true, - "default": "apply_patch" + "x-stainless-const": true } }, "allOf": [ @@ -29967,8 +32571,7 @@ "update_file" ], "description": "Update an existing file with the provided diff.", - "x-stainless-const": true, - "default": "update_file" + "x-stainless-const": true }, "path": { "type": "string", @@ -30001,8 +32604,7 @@ "update_file" ], "description": "The operation type. Always `update_file`.", - "x-stainless-const": true, - "default": "update_file" + "x-stainless-const": true }, "path": { "type": "string", @@ -30039,20 +32641,44 @@ "default": "approximate" }, "country": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "region": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "city": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "timezone": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } } }, @@ -30080,12 +32706,14 @@ "description": "An optional list of uploaded files to make available to your code." }, "memory_limit": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.ContainerMemoryLimit" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "network_policy": { "$ref": "#/components/schemas/OpenAI.ContainerNetworkPolicyParam" @@ -30119,6 +32747,12 @@ "OpenAI.ChatModel": { "type": "string", "enum": [ + "gpt-5.4", + "gpt-5.4-mini", + "gpt-5.4-nano", + "gpt-5.4-mini-2026-03-17", + "gpt-5.4-nano-2026-03-17", + "gpt-5.3-chat-latest", "gpt-5.2", "gpt-5.2-2025-12-11", "gpt-5.2-chat-latest", @@ -30218,8 +32852,7 @@ "click" ], "description": "Specifies the event type. For a click action, this property is always `click`.", - "x-stainless-const": true, - "default": "click" + "x-stainless-const": true }, "button": { "allOf": [ @@ -30244,6 +32877,19 @@ } ], "description": "The y-coordinate where the click occurred." + }, + "keys": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -30410,17 +33056,61 @@ "items": { "$ref": "#/components/schemas/OpenAI.InputItem" } + }, + { + "type": "null" } - ], - "nullable": true + ] }, "previous_response_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "instructions": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "prompt_cache_key": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "prompt_cache_retention": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.PromptCacheRetentionEnum" + }, + { + "type": "null" + } + ] + }, + "service_tier": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.ServiceTierEnum" + }, + { + "type": "null" + } + ] } } }, @@ -30440,7 +33130,9 @@ "gt", "gte", "lt", - "lte" + "lte", + "in", + "nin" ], "description": "Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.\n - `eq`: equals\n - `ne`: not equal\n - `gt`: greater than\n - `gte`: greater than or equal\n - `lt`: less than\n - `lte`: less than or equal\n - `in`: in\n - `nin`: not in", "default": "eq" @@ -30542,6 +33234,14 @@ } } }, + "OpenAI.ComputerActionList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ComputerAction" + }, + "description": "Flattened batched actions for `computer_use`. Each action includes an\n`type` discriminator and action-specific fields.", + "title": "Computer Action List" + }, "OpenAI.ComputerActionType": { "anyOf": [ { @@ -30574,12 +33274,24 @@ "description": "The ID of the pending safety check." }, "code": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "message": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "description": "A pending safety check for the computer call." @@ -30599,7 +33311,8 @@ "required": [ "type", "image_url", - "file_id" + "file_id", + "detail" ], "properties": { "type": { @@ -30608,17 +33321,36 @@ "computer_screenshot" ], "description": "Specifies the event type. For a computer screenshot, this property is always set to `computer_screenshot`.", - "x-stainless-const": true, - "default": "computer_screenshot" + "x-stainless-const": true }, "image_url": { - "type": "string", - "format": "uri", - "nullable": true + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ] }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ImageDetail" + } + ], + "description": "The detail level of the screenshot image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "allOf": [ @@ -30656,6 +33388,29 @@ }, "description": "A computer screenshot image used with the computer use tool." }, + "OpenAI.ComputerTool": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "computer" + ], + "description": "The type of the computer tool. Always `computer`.", + "x-stainless-const": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Tool" + } + ], + "description": "A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).", + "title": "Computer" + }, "OpenAI.ComputerUsePreviewTool": { "type": "object", "required": [ @@ -30671,8 +33426,7 @@ "computer_use_preview" ], "description": "The type of the computer use tool. Always `computer_use_preview`.", - "x-stainless-const": true, - "default": "computer_use_preview" + "x-stainless-const": true }, "environment": { "allOf": [ @@ -30719,8 +33473,7 @@ "container_auto" ], "description": "Automatically creates a container for this request", - "x-stainless-const": true, - "default": "container_auto" + "x-stainless-const": true }, "file_ids": { "type": "array", @@ -30731,12 +33484,14 @@ "description": "An optional list of uploaded files to make available to your code." }, "memory_limit": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.ContainerMemoryLimit" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "skills": { "type": "array", @@ -30773,8 +33528,7 @@ "container_file_citation" ], "description": "The type of the container file citation. Always `container_file_citation`.", - "x-stainless-const": true, - "default": "container_file_citation" + "x-stainless-const": true }, "container_id": { "type": "string", @@ -30835,8 +33589,7 @@ "allowlist" ], "description": "Allow outbound network access only to specified domains. Always `allowlist`.", - "x-stainless-const": true, - "default": "allowlist" + "x-stainless-const": true }, "allowed_domains": { "type": "array", @@ -30845,14 +33598,6 @@ }, "minItems": 1, "description": "A list of allowed domains when type is `allowlist`." - }, - "domain_secrets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.ContainerNetworkPolicyDomainSecretParam" - }, - "minItems": 1, - "description": "Optional domain-scoped secrets for allowlisted domains." } }, "allOf": [ @@ -30873,8 +33618,7 @@ "disabled" ], "description": "Disable outbound network access. Always `disabled`.", - "x-stainless-const": true, - "default": "disabled" + "x-stainless-const": true } }, "allOf": [ @@ -30883,32 +33627,6 @@ } ] }, - "OpenAI.ContainerNetworkPolicyDomainSecretParam": { - "type": "object", - "required": [ - "domain", - "name", - "value" - ], - "properties": { - "domain": { - "type": "string", - "minLength": 1, - "description": "The domain associated with the secret." - }, - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the secret to inject for the domain." - }, - "value": { - "type": "string", - "minLength": 1, - "maxLength": 10485760, - "description": "The secret value to inject for the domain." - } - } - }, "OpenAI.ContainerNetworkPolicyParam": { "type": "object", "required": [ @@ -30955,8 +33673,7 @@ "container_reference" ], "description": "The environment type. Always `container_reference`.", - "x-stainless-const": true, - "default": "container_reference" + "x-stainless-const": true }, "container_id": { "type": "string" @@ -31013,13 +33730,14 @@ "description": "The context management entry type. Currently only 'compaction' is supported." }, "compact_threshold": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] } } }, @@ -31037,14 +33755,18 @@ "propertyName": "type", "mapping": { "message": "#/components/schemas/OpenAI.ConversationItemMessage", - "function_call": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallResource", - "function_call_output": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutputResource", + "function_call": "#/components/schemas/OpenAI.ConversationItemFunctionToolCall", + "function_call_output": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutput", "file_search_call": "#/components/schemas/OpenAI.ConversationItemFileSearchToolCall", "web_search_call": "#/components/schemas/OpenAI.ConversationItemWebSearchToolCall", "image_generation_call": "#/components/schemas/OpenAI.ConversationItemImageGenToolCall", "computer_call": "#/components/schemas/OpenAI.ConversationItemComputerToolCall", - "computer_call_output": "#/components/schemas/OpenAI.ConversationItemComputerToolCallOutputResource", + "computer_call_output": "#/components/schemas/OpenAI.ConversationItemComputerToolCallOutput", + "tool_search_call": "#/components/schemas/OpenAI.ConversationItemToolSearchCall", + "tool_search_output": "#/components/schemas/OpenAI.ConversationItemToolSearchOutput", + "additional_tools": "#/components/schemas/OpenAI.ConversationItemAdditionalTools", "reasoning": "#/components/schemas/OpenAI.ConversationItemReasoningItem", + "compaction": "#/components/schemas/OpenAI.ConversationItemCompactionBody", "code_interpreter_call": "#/components/schemas/OpenAI.ConversationItemCodeInterpreterToolCall", "local_shell_call": "#/components/schemas/OpenAI.ConversationItemLocalShellToolCall", "local_shell_call_output": "#/components/schemas/OpenAI.ConversationItemLocalShellToolCallOutput", @@ -31056,13 +33778,57 @@ "mcp_approval_request": "#/components/schemas/OpenAI.ConversationItemMcpApprovalRequest", "mcp_approval_response": "#/components/schemas/OpenAI.ConversationItemMcpApprovalResponseResource", "mcp_call": "#/components/schemas/OpenAI.ConversationItemMcpToolCall", - "custom_tool_call": "#/components/schemas/OpenAI.ConversationItemCustomToolCall", - "custom_tool_call_output": "#/components/schemas/OpenAI.ConversationItemCustomToolCallOutput" + "custom_tool_call": "#/components/schemas/OpenAI.ConversationItemCustomToolCallResource", + "custom_tool_call_output": "#/components/schemas/OpenAI.ConversationItemCustomToolCallOutputResource" } }, "description": "A single item within a conversation. The set of possible types are the same as the `output` type of a [Response object](/docs/api-reference/responses/object#responses/object-output).", "title": "Conversation item" }, + "OpenAI.ConversationItemAdditionalTools": { + "type": "object", + "required": [ + "type", + "id", + "role", + "tools" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "additional_tools" + ], + "description": "The type of the item. Always `additional_tools`.", + "x-stainless-const": true, + "default": "additional_tools" + }, + "id": { + "type": "string", + "description": "The unique ID of the additional tools item." + }, + "role": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessageRole" + } + ], + "description": "The role that provided the additional tools." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The additional tool definitions made available at this item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationItem" + } + ] + }, "OpenAI.ConversationItemApplyPatchToolCall": { "type": "object", "required": [ @@ -31155,8 +33921,14 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "created_by": { "type": "string", @@ -31211,22 +33983,34 @@ "description": "The ID of the container used to run the code." }, "code": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "outputs": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + "anyOf": [ + { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + } + ] } - ] - }, - "nullable": true + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -31237,13 +34021,50 @@ "description": "A tool call to run code.", "title": "Code interpreter tool call" }, + "OpenAI.ConversationItemCompactionBody": { + "type": "object", + "required": [ + "type", + "id", + "encrypted_content" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "compaction" + ], + "description": "The type of the item. Always `compaction`.", + "x-stainless-const": true, + "default": "compaction" + }, + "id": { + "type": "string", + "description": "The unique ID of the compaction item." + }, + "encrypted_content": { + "type": "string", + "description": "The encrypted content that was produced by compaction." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationItem" + } + ], + "description": "A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact).", + "title": "Compaction item" + }, "OpenAI.ConversationItemComputerToolCall": { "type": "object", "required": [ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -31267,6 +34088,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -31292,10 +34116,11 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.ConversationItemComputerToolCallOutputResource": { + "OpenAI.ConversationItemComputerToolCallOutput": { "type": "object", "required": [ "type", + "id", "call_id", "output" ], @@ -31311,7 +34136,8 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output." + "description": "The ID of the computer tool call output.", + "readOnly": true }, "call_id": { "type": "string", @@ -31341,40 +34167,60 @@ { "$ref": "#/components/schemas/OpenAI.ConversationItem" } - ] + ], + "description": "The output of a computer tool call.", + "title": "Computer tool call output" }, - "OpenAI.ConversationItemCustomToolCall": { + "OpenAI.ConversationItemCustomToolCallOutputResource": { "type": "object", "required": [ "type", "call_id", - "name", - "input" + "output", + "status" ], "properties": { "type": { "type": "string", "enum": [ - "custom_tool_call" + "custom_tool_call_output" ], - "description": "The type of the custom tool call. Always `custom_tool_call`.", + "description": "The type of the custom tool call output. Always `custom_tool_call_output`.", "x-stainless-const": true }, "id": { "type": "string", - "description": "The unique ID of the custom tool call in the OpenAI platform." + "description": "The unique ID of the custom tool call output in the OpenAI platform." }, "call_id": { "type": "string", - "description": "An identifier used to map this custom tool call to a tool call output." + "description": "The call ID, used to map this custom tool call output to a custom tool call." }, - "name": { - "type": "string", - "description": "The name of the custom tool being called." + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." }, - "input": { + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { "type": "string", - "description": "The input for the custom tool call generated by the model." + "description": "The identifier of the actor that created the item." } }, "allOf": [ @@ -31382,46 +34228,57 @@ "$ref": "#/components/schemas/OpenAI.ConversationItem" } ], - "description": "A call to a custom tool created by the model.", - "title": "Custom tool call" + "title": "ResponseCustomToolCallOutputItem" }, - "OpenAI.ConversationItemCustomToolCallOutput": { + "OpenAI.ConversationItemCustomToolCallResource": { "type": "object", "required": [ "type", "call_id", - "output" + "name", + "input", + "status" ], "properties": { "type": { "type": "string", "enum": [ - "custom_tool_call_output" + "custom_tool_call" ], - "description": "The type of the custom tool call output. Always `custom_tool_call_output`.", + "description": "The type of the custom tool call. Always `custom_tool_call`.", "x-stainless-const": true }, "id": { "type": "string", - "description": "The unique ID of the custom tool call output in the OpenAI platform." + "description": "The unique ID of the custom tool call in the OpenAI platform." }, "call_id": { "type": "string", - "description": "The call ID, used to map this custom tool call output to a custom tool call." + "description": "An identifier used to map this custom tool call to a tool call output." }, - "output": { - "oneOf": [ - { - "type": "string" - }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, + "name": { + "type": "string", + "description": "The name of the custom tool being called." + }, + "input": { + "type": "string", + "description": "The input for the custom tool call generated by the model." + }, + "status": { + "allOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" } ], - "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." } }, "allOf": [ @@ -31429,8 +34286,7 @@ "$ref": "#/components/schemas/OpenAI.ConversationItem" } ], - "description": "The output of a custom tool call from your code, being sent back to the model.", - "title": "Custom tool call output" + "title": "ResponseCustomToolCallItem" }, "OpenAI.ConversationItemFileSearchToolCall": { "type": "object", @@ -31472,11 +34328,17 @@ "description": "The queries used to search for files." }, "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -31526,19 +34388,20 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." }, "environment": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallEnvironment" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "created_by": { "type": "string", @@ -31584,7 +34447,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -31597,13 +34460,14 @@ "description": "An array of shell call output contents" }, "max_output_length": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "created_by": { "type": "string", @@ -31618,43 +34482,44 @@ "description": "The output of a shell tool call that was emitted.", "title": "Shell call output" }, - "OpenAI.ConversationItemFunctionToolCallOutputResource": { + "OpenAI.ConversationItemFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", - "output" + "name", + "arguments" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", "enum": [ - "function_call_output" + "function_call" ], - "description": "The type of the function tool call output. Always `function_call_output`.", + "description": "The type of the function tool call. Always `function_call`.", "x-stainless-const": true }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "output": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } - } - ], - "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, + "name": { + "type": "string", + "description": "The name of the function to run." + }, + "arguments": { + "type": "string", + "description": "A JSON string of the arguments to pass to the function." }, "status": { "type": "string", @@ -31670,40 +34535,49 @@ { "$ref": "#/components/schemas/OpenAI.ConversationItem" } - ] + ], + "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", + "title": "Function tool call" }, - "OpenAI.ConversationItemFunctionToolCallResource": { + "OpenAI.ConversationItemFunctionToolCallOutput": { "type": "object", "required": [ + "id", "type", "call_id", - "name", - "arguments" + "output" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", + "readOnly": true }, "type": { "type": "string", "enum": [ - "function_call" + "function_call_output" ], - "description": "The type of the function tool call. Always `function_call`.", + "description": "The type of the function tool call output. Always `function_call_output`.", "x-stainless-const": true }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "name": { - "type": "string", - "description": "The name of the function to run." - }, - "arguments": { - "type": "string", - "description": "A JSON string of the arguments to pass to the function." + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." }, "status": { "type": "string", @@ -31719,7 +34593,9 @@ { "$ref": "#/components/schemas/OpenAI.ConversationItem" } - ] + ], + "description": "The output of a function tool call.", + "title": "Function tool call output" }, "OpenAI.ConversationItemImageGenToolCall": { "type": "object", @@ -31753,8 +34629,14 @@ "description": "The status of the image generation call." }, "result": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -31884,13 +34766,19 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "nullable": true + "anyOf": [ + { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -31974,8 +34862,14 @@ "description": "Whether the request was approved." }, "reason": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -32019,8 +34913,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -32066,12 +34959,18 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "error": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, "status": { "allOf": [ @@ -32082,8 +34981,14 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -32139,6 +35044,16 @@ "$ref": "#/components/schemas/OpenAI.MessageContent" }, "description": "The content of the message" + }, + "phase": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -32170,8 +35085,14 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "summary": { "type": "array", @@ -32205,6 +35126,138 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, + "OpenAI.ConversationItemToolSearchCall": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "arguments", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The type of the item. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search call item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "description": "Arguments used for the tool search call." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the tool search call item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationItem" + } + ] + }, + "OpenAI.ConversationItemToolSearchOutput": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "tools", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The type of the item. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search output item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by tool search." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the tool search output item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationItem" + } + ] + }, "OpenAI.ConversationItemType": { "anyOf": [ { @@ -32221,7 +35274,11 @@ "image_generation_call", "computer_call", "computer_call_output", + "tool_search_call", + "tool_search_output", + "additional_tools", "reasoning", + "compaction", "code_interpreter_call", "local_shell_call", "local_shell_call_output", @@ -32410,7 +35467,8 @@ "propertyName": "type", "mapping": { "text": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText", - "json_object": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject" + "json_object": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject", + "json_schema": "#/components/schemas/OpenAI.ResponseFormatJsonSchema" } }, "description": "An object specifying the format that the model must output.\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables\nStructured Outputs which ensures the model will match your supplied JSON\nschema. Learn more in the [Structured Outputs\nguide](/docs/guides/structured-outputs).\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it." @@ -32480,20 +35538,27 @@ "type": "object", "properties": { "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.InputItem" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.InputItem" + } + }, + { + "type": "null" + } + ] } } }, @@ -32671,7 +35736,7 @@ }, "item_schema": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The json schema for each row in the data source." }, "include_sample_schema": { @@ -32740,7 +35805,7 @@ }, "metadata": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "Metadata filters for the logs data source." } }, @@ -32935,7 +36000,7 @@ }, "metadata": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "Metadata filters for the stored completions data source." } }, @@ -32987,33 +36052,52 @@ "deprecated": true }, "suffix": { - "type": "string", - "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "minLength": 1, "maxLength": 64, "description": "A string of up to 64 characters that will be added to your fine-tuned model name.\n For example, a `suffix` of \"custom-model-name\" would produce a model name like `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`." }, "validation_file": { - "type": "string", - "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "description": "The ID of an uploaded file that contains validation data.\n If you provide this file, the data is used to generate validation\n metrics periodically during fine-tuning. These metrics can be viewed in\n the fine-tuning results file.\n The same data should not be present in both train and validation files.\n Your dataset must be formatted as a JSONL file. You must upload your file with the purpose `fine-tune`.\n See the [fine-tuning guide](/docs/guides/model-optimization) for more details." }, "integrations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.CreateFineTuningJobRequestIntegrations" - }, - "nullable": true, + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.CreateFineTuningJobRequestIntegrations" + } + }, + { + "type": "null" + } + ], "description": "A list of integrations to enable for your fine-tuning job." }, "seed": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } ], - "nullable": true, "minimum": 0, "maximum": 2147483647, "description": "The seed controls the reproducibility of the job. Passing in the same seed and job parameters should produce the same results, but may differ in rare cases.\n If a seed is not specified, one will be generated for you." @@ -33022,13 +36106,14 @@ "$ref": "#/components/schemas/OpenAI.FineTuneMethod" }, "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] } } }, @@ -33108,12 +36193,24 @@ "type": "string" }, "name": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "entity": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "tags": { "type": "array", @@ -33300,8 +36397,7 @@ "grammar" ], "description": "Grammar format. Always `grammar`.", - "x-stainless-const": true, - "default": "grammar" + "x-stainless-const": true }, "syntax": { "allOf": [ @@ -33336,8 +36432,7 @@ "text" ], "description": "Unconstrained text format. Always `text`.", - "x-stainless-const": true, - "default": "text" + "x-stainless-const": true } }, "allOf": [ @@ -33361,8 +36456,7 @@ "custom" ], "description": "The type of the custom tool. Always `custom`.", - "x-stainless-const": true, - "default": "custom" + "x-stainless-const": true }, "name": { "type": "string", @@ -33379,6 +36473,10 @@ } ], "description": "The input format for the custom tool. Default is unconstrained text." + }, + "defer_loading": { + "type": "boolean", + "description": "Whether this tool should be deferred and discovered via tool search." } }, "allOf": [ @@ -33451,7 +36549,8 @@ "enum": [ "low", "high", - "auto" + "auto", + "original" ] }, "OpenAI.DoubleClickAction": { @@ -33459,7 +36558,8 @@ "required": [ "type", "x", - "y" + "y", + "keys" ], "properties": { "type": { @@ -33468,8 +36568,7 @@ "double_click" ], "description": "Specifies the event type. For a double click action, this property is always set to `double_click`.", - "x-stainless-const": true, - "default": "double_click" + "x-stainless-const": true }, "x": { "allOf": [ @@ -33486,6 +36585,19 @@ } ], "description": "The y-coordinate where the double click occurred." + }, + "keys": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -33509,8 +36621,7 @@ "drag" ], "description": "Specifies the event type. For a drag action, this property is always set to `drag`.", - "x-stainless-const": true, - "default": "drag" + "x-stainless-const": true }, "path": { "type": "array", @@ -33518,6 +36629,19 @@ "$ref": "#/components/schemas/OpenAI.CoordParam" }, "description": "An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg\n ```\n [\n { x: 100, y: 200 },\n { x: 200, y: 300 }\n ]\n ```" + }, + "keys": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -33557,6 +36681,16 @@ ], "description": "Text, image, or audio input to the model, used to generate a response.\n Can also contain previous assistant responses." }, + "phase": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + }, + { + "type": "null" + } + ] + }, "type": { "type": "string", "enum": [ @@ -33583,6 +36717,9 @@ "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role. Messages with the\n`assistant` role are presumed to have been generated by the model in previous\ninteractions.", "title": "Input message" }, + "OpenAI.EmptyModelParam": { + "type": "object" + }, "OpenAI.Error": { "type": "object", "required": [ @@ -33591,15 +36728,27 @@ ], "properties": { "code": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "message": { "type": "string" }, "param": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "type": { "type": "string" @@ -33612,11 +36761,11 @@ }, "additionalInfo": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, "debugInfo": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} } } }, @@ -33795,41 +36944,45 @@ "type": "object", "properties": { "seed": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "top_p": { - "type": "number", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" + }, + { + "type": "null" } ], - "nullable": true, "default": 1 }, "temperature": { - "type": "number", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "max_completions_tokens": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "reasoning_effort": { "$ref": "#/components/schemas/OpenAI.ReasoningEffort" @@ -34170,11 +37323,11 @@ "properties": { "item": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, "sample": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} } } }, @@ -34215,75 +37368,111 @@ "description": "The type of run data source. Always `responses`." }, "metadata": { - "type": "object", - "additionalProperties": {}, - "nullable": true + "anyOf": [ + { + "type": "object", + "unevaluatedProperties": {} + }, + { + "type": "null" + } + ] }, "model": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "instructions_search": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "created_after": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "created_before": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "reasoning_effort": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.ReasoningEffort" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "temperature": { - "type": "number", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "top_p": { - "type": "number", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "users": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] }, "tools": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] } }, "description": "A EvalResponsesSource object describing a run data source configuration.", @@ -34483,44 +37672,54 @@ "default": "stored_completions" }, "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "model": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "created_after": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "created_before": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "limit": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "description": "A StoredCompletionsRunDataSource configuration describing a set of filters", @@ -34546,8 +37745,7 @@ "file_citation" ], "description": "The type of the file citation. Always `file_citation`.", - "x-stainless-const": true, - "default": "file_citation" + "x-stainless-const": true }, "file_id": { "type": "string", @@ -34574,6 +37772,13 @@ "description": "A citation to a file.", "title": "File citation" }, + "OpenAI.FileInputDetail": { + "type": "string", + "enum": [ + "low", + "high" + ] + }, "OpenAI.FilePath": { "type": "object", "required": [ @@ -34624,8 +37829,7 @@ "file_search" ], "description": "The type of the file search tool. Always `file_search`.", - "x-stainless-const": true, - "default": "file_search" + "x-stainless-const": true }, "vector_store_ids": { "type": "array", @@ -34651,12 +37855,14 @@ "description": "Ranking options for search." }, "filters": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Filters" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "name": { "type": "string", @@ -34688,13 +37894,14 @@ "type": "string" }, "attributes": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.VectorStoreFileAttributes" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "score": { "type": "number", @@ -35049,12 +38256,24 @@ "type": "string" }, "name": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "entity": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "tags": { "type": "array", @@ -35094,22 +38313,37 @@ "description": "The Unix timestamp (in seconds) for when the fine-tuning job was created." }, "error": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FineTuningJobError" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "fine_tuned_model": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "finished_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "type": "integer", - "format": "unixtime", - "nullable": true + "format": "unixTimestamp" }, "hyperparameters": { "allOf": [ @@ -35155,28 +38389,41 @@ "description": "The current status of the fine-tuning job, which can be either `validating_files`, `queued`, `running`, `succeeded`, `failed`, or `cancelled`." }, "trained_tokens": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "training_file": { "type": "string", "description": "The file ID used for training. You can retrieve the training data with the [Files API](/docs/api-reference/files/retrieve-contents)." }, "validation_file": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "integrations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FineTuningIntegration" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FineTuningIntegration" + } + }, + { + "type": "null" + } + ] }, "seed": { "allOf": [ @@ -35187,21 +38434,30 @@ "description": "The seed used for the fine-tuning job." }, "estimated_finish": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "type": "integer", - "format": "unixtime", - "nullable": true + "format": "unixTimestamp" }, "method": { "$ref": "#/components/schemas/OpenAI.FineTuneMethod" }, "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "description": "The `fine_tuning.job` object represents a fine-tuning job that has been created through the API.", @@ -35313,8 +38569,14 @@ "type": "string" }, "param": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } } }, @@ -35393,17 +38655,13 @@ "type": "string", "enum": [ "auto" - ], - "nullable": true + ] }, { - "type": "integer", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - } - ], - "nullable": true + "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } ], "default": "auto" @@ -35473,21 +38731,35 @@ "default": "input_file" }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "filename": { "type": "string", "description": "The name of the file to be sent to the model." }, + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." + }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "allOf": [ @@ -35515,13 +38787,25 @@ "default": "input_image" }, "image_url": { - "type": "string", - "format": "uri", - "nullable": true + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ] }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "detail": { "allOf": [ @@ -35529,7 +38813,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "allOf": [ @@ -35592,6 +38876,22 @@ "incomplete" ] }, + "OpenAI.FunctionCallOutputStatusEnum": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + "OpenAI.FunctionCallStatus": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, "OpenAI.FunctionObject": { "type": "object", "required": [ @@ -35610,14 +38910,20 @@ "$ref": "#/components/schemas/OpenAI.FunctionParameters" }, "strict": { - "type": "boolean", - "nullable": true + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] } } }, "OpenAI.FunctionParameters": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.\nOmitting `parameters` defines a function with an empty parameter list." }, "OpenAI.FunctionShellAction": { @@ -35635,22 +38941,24 @@ } }, "timeout_ms": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "max_output_length": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "description": "Execute a shell command.", @@ -35670,22 +38978,24 @@ "description": "Ordered shell commands for the execution environment to run." }, "timeout_ms": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "max_output_length": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "description": "Commands and limits describing how to run the shell tool call.", @@ -35899,8 +39209,7 @@ "exit" ], "description": "The outcome type. Always `exit`.", - "x-stainless-const": true, - "default": "exit" + "x-stainless-const": true }, "exit_code": { "allOf": [ @@ -35932,8 +39241,7 @@ "exit" ], "description": "The outcome type. Always `exit`.", - "x-stainless-const": true, - "default": "exit" + "x-stainless-const": true }, "exit_code": { "allOf": [ @@ -36020,6 +39328,14 @@ } ] }, + "OpenAI.FunctionShellCallOutputStatusEnum": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, "OpenAI.FunctionShellCallOutputTimeoutOutcome": { "type": "object", "required": [ @@ -36032,8 +39348,7 @@ "timeout" ], "description": "The outcome type. Always `timeout`.", - "x-stainless-const": true, - "default": "timeout" + "x-stainless-const": true } }, "allOf": [ @@ -36056,8 +39371,7 @@ "timeout" ], "description": "The outcome type. Always `timeout`.", - "x-stainless-const": true, - "default": "timeout" + "x-stainless-const": true } }, "allOf": [ @@ -36068,6 +39382,14 @@ "description": "Indicates that the shell call exceeded its configured time limit.", "title": "Shell call timeout outcome" }, + "OpenAI.FunctionShellCallStatus": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, "OpenAI.FunctionShellToolParam": { "type": "object", "required": [ @@ -36080,17 +39402,17 @@ "shell" ], "description": "The type of the shell tool. Always `shell`.", - "x-stainless-const": true, - "default": "shell" + "x-stainless-const": true }, "environment": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellToolParamEnvironment" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "name": { "type": "string", @@ -36215,25 +39537,46 @@ "function" ], "description": "The type of the function tool. Always `function`.", - "x-stainless-const": true, - "default": "function" + "x-stainless-const": true }, "name": { "type": "string", "description": "The name of the function to call." }, "description": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "parameters": { - "type": "object", - "additionalProperties": {}, - "nullable": true + "anyOf": [ + { + "type": "object", + "unevaluatedProperties": {} + }, + { + "type": "null" + } + ] }, "strict": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, + "defer_loading": { "type": "boolean", - "nullable": true + "description": "Whether this function is deferred and loaded via tool search." } }, "allOf": [ @@ -36244,61 +39587,62 @@ "description": "Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).", "title": "Function" }, - "OpenAI.FunctionToolCallOutput": { + "OpenAI.FunctionToolParam": { "type": "object", "required": [ - "type", - "call_id", - "output" + "name", + "type" ], "properties": { - "id": { + "name": { "type": "string", - "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." + "minLength": 1, + "maxLength": 128, + "pattern": "^[a-zA-Z0-9_-]+$" }, - "type": { - "type": "string", - "enum": [ - "function_call_output" - ], - "description": "The type of the function tool call output. Always `function_call_output`.", - "x-stainless-const": true + "description": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, - "call_id": { - "type": "string", - "description": "The unique ID of the function tool call generated by the model." + "parameters": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.EmptyModelParam" + }, + { + "type": "null" + } + ] }, - "output": { - "oneOf": [ + "strict": { + "anyOf": [ { - "type": "string" + "type": "boolean" }, { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } + "type": "null" } - ], - "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + ] }, - "status": { + "type": { "type": "string", "enum": [ - "in_progress", - "completed", - "incomplete" + "function" ], - "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemField" + "x-stainless-const": true, + "default": "function" + }, + "defer_loading": { + "type": "boolean", + "description": "Whether this function should be deferred and discovered via tool search." } - ], - "description": "The output of a function tool call.", - "title": "Function tool call output" + } }, "OpenAI.GraderLabelModel": { "type": "object", @@ -36646,7 +39990,8 @@ "enum": [ "low", "high", - "auto" + "auto", + "original" ] }, "OpenAI.ImageGenActionEnum": { @@ -36669,8 +40014,7 @@ "image_generation" ], "description": "The type of the image generation tool. Always `image_generation`.", - "x-stainless-const": true, - "default": "image_generation" + "x-stainless-const": true }, "model": { "anyOf": [ @@ -36700,14 +40044,21 @@ "default": "auto" }, "size": { - "type": "string", - "enum": [ - "1024x1024", - "1024x1536", - "1536x1024", - "auto" + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "1024x1024", + "1024x1536", + "1536x1024", + "auto" + ] + } ], - "description": "The size of the generated image. One of `1024x1024`, `1024x1536`,\n `1536x1024`, or `auto`. Default: `auto`.", + "description": "The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.", "default": "auto" }, "output_format": { @@ -36751,12 +40102,14 @@ "default": "auto" }, "input_fidelity": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.InputFidelity" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "input_image_mask": { "allOf": [ @@ -36833,7 +40186,7 @@ ] } ], - "description": "Specify additional output data to include in the model response. Currently supported values are:\n- `web_search_call.action.sources`: Include the sources of the web search tool call.\n- `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n- `file_search_call.results`: Include the search results of the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `message.output_text.logprobs`: Include logprobs with assistant messages.\n- `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program)." + "description": "Specify additional output data to include in the model response. Currently supported values are:\n- `web_search_call.results`: Include the search results of the web search tool call.\n- `web_search_call.action.sources`: Include the sources of the web search tool call.\n- `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n- `file_search_call.results`: Include the search results of the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `message.output_text.logprobs`: Include logprobs with assistant messages.\n- `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program)." }, "OpenAI.InlineSkillParam": { "type": "object", @@ -36850,8 +40203,7 @@ "inline" ], "description": "Defines an inline skill for this request.", - "x-stainless-const": true, - "default": "inline" + "x-stainless-const": true }, "name": { "type": "string", @@ -36992,21 +40344,35 @@ "default": "input_file" }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "filename": { "type": "string", "description": "The name of the file to be sent to the model." }, + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." + }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "allOf": [ @@ -37034,13 +40400,25 @@ "default": "input_image" }, "image_url": { - "type": "string", - "format": "uri", - "nullable": true + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ] }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "detail": { "allOf": [ @@ -37048,7 +40426,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "allOf": [ @@ -37127,21 +40505,35 @@ "default": "input_file" }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "filename": { "type": "string", "description": "The name of the file to be sent to the model." }, + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." + }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "description": "A file input to the model.", @@ -37163,21 +40555,53 @@ "default": "input_file" }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "filename": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "file_data": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "file_url": { - "type": "string", - "format": "uri", - "nullable": true + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ] + }, + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "description": "A file input to the model.", @@ -37200,13 +40624,25 @@ "default": "input_image" }, "image_url": { - "type": "string", - "format": "uri", - "nullable": true + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ] }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "detail": { "allOf": [ @@ -37214,7 +40650,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "description": "An image input to the model. Learn about [image inputs](/docs/guides/vision).", @@ -37236,21 +40672,35 @@ "default": "input_image" }, "image_url": { - "type": "string", - "format": "uri", - "nullable": true + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ] }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "detail": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.DetailEnum" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "description": "An image input to the model. Learn about [image inputs](/docs/guides/vision)", @@ -37278,6 +40728,9 @@ "web_search_call": "#/components/schemas/OpenAI.InputItemWebSearchToolCall", "function_call": "#/components/schemas/OpenAI.InputItemFunctionToolCall", "function_call_output": "#/components/schemas/OpenAI.InputItemFunctionCallOutputItemParam", + "tool_search_call": "#/components/schemas/OpenAI.InputItemToolSearchCallItemParam", + "tool_search_output": "#/components/schemas/OpenAI.InputItemToolSearchOutputItemParam", + "additional_tools": "#/components/schemas/OpenAI.InputItemAdditionalToolsItemParam", "reasoning": "#/components/schemas/OpenAI.InputItemReasoningItem", "compaction": "#/components/schemas/OpenAI.InputItemCompactionSummaryItemParam", "image_generation_call": "#/components/schemas/OpenAI.InputItemImageGenToolCall", @@ -37298,6 +40751,56 @@ }, "description": "An item representing part of the context for the response to be\ngenerated by the model. Can contain text, images, and audio inputs,\nas well as previous assistant responses and tool call outputs." }, + "OpenAI.InputItemAdditionalToolsItemParam": { + "type": "object", + "required": [ + "type", + "role", + "tools" + ], + "properties": { + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "additional_tools" + ], + "description": "The item type. Always `additional_tools`.", + "x-stainless-const": true, + "default": "additional_tools" + }, + "role": { + "type": "string", + "enum": [ + "developer" + ], + "description": "The role that provided the additional tools. Only `developer` is supported.", + "x-stainless-const": true, + "default": "developer" + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "A list of additional tools made available at this item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.InputItem" + } + ] + }, "OpenAI.InputItemApplyPatchToolCallItemParam": { "type": "object", "required": [ @@ -37317,8 +40820,14 @@ "default": "apply_patch_call" }, "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -37369,8 +40878,14 @@ "default": "apply_patch_call_output" }, "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -37387,8 +40902,14 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -37439,22 +40960,34 @@ "description": "The ID of the container used to run the code." }, "code": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "outputs": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + "anyOf": [ + { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + } + ] } - ] - }, - "nullable": true + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -37473,8 +41006,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "type": { "type": "string", @@ -37508,8 +41047,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -37530,19 +41075,27 @@ "$ref": "#/components/schemas/OpenAI.ComputerScreenshotImage" }, "acknowledged_safety_checks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" + } + }, + { + "type": "null" + } + ] }, "status": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "allOf": [ @@ -37559,7 +41112,6 @@ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -37583,6 +41135,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -37633,6 +41188,10 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -37737,11 +41296,17 @@ "description": "The queries used to search for files." }, "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -37761,8 +41326,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -37804,12 +41375,14 @@ "description": "Text, image, or file output of the function tool call." }, "status": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "allOf": [ @@ -37829,8 +41402,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -37856,21 +41435,24 @@ "description": "The shell commands and limits that describe how to run the tool call." }, "status": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemStatus" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "environment": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemParamEnvironment" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "allOf": [ @@ -37890,8 +41472,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -37916,21 +41504,24 @@ "description": "Captured chunks of stdout and stderr output, along with their associated outcomes." }, "status": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemStatus" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "max_output_length": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "allOf": [ @@ -37944,6 +41535,7 @@ "OpenAI.InputItemFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", "name", @@ -37952,7 +41544,8 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", @@ -37966,6 +41559,10 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, "name": { "type": "string", "description": "The name of the function to run." @@ -38024,8 +41621,14 @@ "description": "The status of the image generation call." }, "result": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -38108,13 +41711,19 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "nullable": true + "anyOf": [ + { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -38185,8 +41794,14 @@ "x-stainless-const": true }, "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "approval_request_id": { "type": "string", @@ -38197,8 +41812,14 @@ "description": "Whether the request was approved." }, "reason": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -38242,8 +41863,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -38289,12 +41909,18 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "error": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, "status": { "allOf": [ @@ -38305,8 +41931,14 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -38354,6 +41986,16 @@ }, "description": "The content of the output message." }, + "phase": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + }, + { + "type": "null" + } + ] + }, "status": { "type": "string", "enum": [ @@ -38393,8 +42035,14 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "summary": { "type": "array", @@ -38428,6 +42076,143 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, + "OpenAI.InputItemToolSearchCallItemParam": { + "type": "object", + "required": [ + "type", + "arguments" + ], + "properties": { + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The item type. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.EmptyModelParam" + } + ], + "description": "The arguments supplied to the tool search call." + }, + "status": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + }, + { + "type": "null" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.InputItem" + } + ] + }, + "OpenAI.InputItemToolSearchOutputItemParam": { + "type": "object", + "required": [ + "type", + "tools" + ], + "properties": { + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The item type. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by the tool search output." + }, + "status": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + }, + { + "type": "null" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.InputItem" + } + ] + }, "OpenAI.InputItemType": { "anyOf": [ { @@ -38444,6 +42229,9 @@ "web_search_call", "function_call", "function_call_output", + "tool_search_call", + "tool_search_output", + "additional_tools", "reasoning", "compaction", "image_generation_call", @@ -38519,52 +42307,6 @@ "description": "The results of a web search tool call. See the\n[web search guide](/docs/guides/tools-web-search) for more information.", "title": "Web search tool call" }, - "OpenAI.InputMessage": { - "type": "object", - "required": [ - "type", - "role", - "content" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "message" - ], - "description": "The type of the message input. Always set to `message`.", - "x-stainless-const": true - }, - "role": { - "type": "string", - "enum": [ - "user", - "system", - "developer" - ], - "description": "The role of the message input. One of `user`, `system`, or `developer`." - }, - "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - }, - "content": { - "$ref": "#/components/schemas/OpenAI.InputMessageContentList" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Item" - } - ], - "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role.", - "title": "Input message" - }, "OpenAI.InputMessageContentList": { "type": "array", "items": { @@ -38573,55 +42315,6 @@ "description": "A list of one or many input items to the model, containing different content\ntypes.", "title": "Input item content list" }, - "OpenAI.InputMessageResource": { - "type": "object", - "required": [ - "type", - "role", - "content", - "id" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "message" - ], - "description": "The type of the message input. Always set to `message`.", - "x-stainless-const": true - }, - "role": { - "type": "string", - "enum": [ - "user", - "system", - "developer" - ], - "description": "The role of the message input. One of `user`, `system`, or `developer`." - }, - "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - }, - "content": { - "$ref": "#/components/schemas/OpenAI.InputMessageContentList" - }, - "id": { - "type": "string", - "description": "The unique ID of the message input." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemResource" - } - ] - }, "OpenAI.InputParam": { "oneOf": [ { @@ -38698,7 +42391,7 @@ "discriminator": { "propertyName": "type", "mapping": { - "message": "#/components/schemas/OpenAI.InputMessage", + "message": "#/components/schemas/OpenAI.ItemInputMessage", "output_message": "#/components/schemas/OpenAI.ItemOutputMessage", "file_search_call": "#/components/schemas/OpenAI.ItemFileSearchToolCall", "computer_call": "#/components/schemas/OpenAI.ItemComputerToolCall", @@ -38706,6 +42399,9 @@ "web_search_call": "#/components/schemas/OpenAI.ItemWebSearchToolCall", "function_call": "#/components/schemas/OpenAI.ItemFunctionToolCall", "function_call_output": "#/components/schemas/OpenAI.ItemFunctionCallOutputItemParam", + "tool_search_call": "#/components/schemas/OpenAI.ItemToolSearchCallItemParam", + "tool_search_output": "#/components/schemas/OpenAI.ItemToolSearchOutputItemParam", + "additional_tools": "#/components/schemas/OpenAI.ItemAdditionalToolsItemParam", "reasoning": "#/components/schemas/OpenAI.ItemReasoningItem", "compaction": "#/components/schemas/OpenAI.ItemCompactionSummaryItemParam", "image_generation_call": "#/components/schemas/OpenAI.ItemImageGenToolCall", @@ -38726,6 +42422,56 @@ }, "description": "Content item used to generate a response." }, + "OpenAI.ItemAdditionalToolsItemParam": { + "type": "object", + "required": [ + "type", + "role", + "tools" + ], + "properties": { + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "additional_tools" + ], + "description": "The item type. Always `additional_tools`.", + "x-stainless-const": true, + "default": "additional_tools" + }, + "role": { + "type": "string", + "enum": [ + "developer" + ], + "description": "The role that provided the additional tools. Only `developer` is supported.", + "x-stainless-const": true, + "default": "developer" + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "A list of additional tools made available at this item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Item" + } + ] + }, "OpenAI.ItemApplyPatchToolCallItemParam": { "type": "object", "required": [ @@ -38745,8 +42491,14 @@ "default": "apply_patch_call" }, "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -38797,8 +42549,14 @@ "default": "apply_patch_call_output" }, "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -38815,8 +42573,14 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -38867,22 +42631,34 @@ "description": "The ID of the container used to run the code." }, "code": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "outputs": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + "anyOf": [ + { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + } + ] } - ] - }, - "nullable": true + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -38901,8 +42677,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "type": { "type": "string", @@ -38936,8 +42718,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -38958,19 +42746,27 @@ "$ref": "#/components/schemas/OpenAI.ComputerScreenshotImage" }, "acknowledged_safety_checks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" + } + }, + { + "type": "null" + } + ] }, "status": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "allOf": [ @@ -38987,7 +42783,6 @@ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -39011,6 +42806,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -39061,6 +42859,10 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -39138,14 +42940,17 @@ "discriminator": { "propertyName": "type", "mapping": { - "function_call_output": "#/components/schemas/OpenAI.FunctionToolCallOutput", "message": "#/components/schemas/OpenAI.ItemFieldMessage", "function_call": "#/components/schemas/OpenAI.ItemFieldFunctionToolCall", + "tool_search_call": "#/components/schemas/OpenAI.ItemFieldToolSearchCall", + "tool_search_output": "#/components/schemas/OpenAI.ItemFieldToolSearchOutput", + "additional_tools": "#/components/schemas/OpenAI.ItemFieldAdditionalTools", + "function_call_output": "#/components/schemas/OpenAI.ItemFieldFunctionToolCallOutput", "file_search_call": "#/components/schemas/OpenAI.ItemFieldFileSearchToolCall", "web_search_call": "#/components/schemas/OpenAI.ItemFieldWebSearchToolCall", "image_generation_call": "#/components/schemas/OpenAI.ItemFieldImageGenToolCall", "computer_call": "#/components/schemas/OpenAI.ItemFieldComputerToolCall", - "computer_call_output": "#/components/schemas/OpenAI.ItemFieldComputerToolCallOutputResource", + "computer_call_output": "#/components/schemas/OpenAI.ItemFieldComputerToolCallOutput", "reasoning": "#/components/schemas/OpenAI.ItemFieldReasoningItem", "compaction": "#/components/schemas/OpenAI.ItemFieldCompactionBody", "code_interpreter_call": "#/components/schemas/OpenAI.ItemFieldCodeInterpreterToolCall", @@ -39165,6 +42970,50 @@ }, "description": "An item representing a message, tool call, tool output, reasoning, or other response element." }, + "OpenAI.ItemFieldAdditionalTools": { + "type": "object", + "required": [ + "type", + "id", + "role", + "tools" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "additional_tools" + ], + "description": "The type of the item. Always `additional_tools`.", + "x-stainless-const": true, + "default": "additional_tools" + }, + "id": { + "type": "string", + "description": "The unique ID of the additional tools item." + }, + "role": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessageRole" + } + ], + "description": "The role that provided the additional tools." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The additional tool definitions made available at this item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemField" + } + ] + }, "OpenAI.ItemFieldApplyPatchToolCall": { "type": "object", "required": [ @@ -39257,8 +43106,14 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "created_by": { "type": "string", @@ -39313,22 +43168,34 @@ "description": "The ID of the container used to run the code." }, "code": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "outputs": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + "anyOf": [ + { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + } + ] } - ] - }, - "nullable": true + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -39383,7 +43250,6 @@ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -39407,6 +43273,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -39432,10 +43301,11 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.ItemFieldComputerToolCallOutputResource": { + "OpenAI.ItemFieldComputerToolCallOutput": { "type": "object", "required": [ "type", + "id", "call_id", "output" ], @@ -39451,7 +43321,8 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output." + "description": "The ID of the computer tool call output.", + "readOnly": true }, "call_id": { "type": "string", @@ -39481,7 +43352,9 @@ { "$ref": "#/components/schemas/OpenAI.ItemField" } - ] + ], + "description": "The output of a computer tool call.", + "title": "Computer tool call output" }, "OpenAI.ItemFieldCustomToolCall": { "type": "object", @@ -39508,6 +43381,10 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -39612,11 +43489,17 @@ "description": "The queries used to search for files." }, "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -39666,19 +43549,20 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." }, "environment": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallEnvironment" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "created_by": { "type": "string", @@ -39724,7 +43608,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -39737,13 +43621,14 @@ "description": "An array of shell call output contents" }, "max_output_length": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "created_by": { "type": "string", @@ -39761,6 +43646,7 @@ "OpenAI.ItemFieldFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", "name", @@ -39769,7 +43655,8 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", @@ -39783,6 +43670,10 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, "name": { "type": "string", "description": "The name of the function to run." @@ -39809,6 +43700,64 @@ "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", "title": "Function tool call" }, + "OpenAI.ItemFieldFunctionToolCallOutput": { + "type": "object", + "required": [ + "id", + "type", + "call_id", + "output" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", + "readOnly": true + }, + "type": { + "type": "string", + "enum": [ + "function_call_output" + ], + "description": "The type of the function tool call output. Always `function_call_output`.", + "x-stainless-const": true + }, + "call_id": { + "type": "string", + "description": "The unique ID of the function tool call generated by the model." + }, + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemField" + } + ], + "description": "The output of a function tool call.", + "title": "Function tool call output" + }, "OpenAI.ItemFieldImageGenToolCall": { "type": "object", "required": [ @@ -39841,8 +43790,14 @@ "description": "The status of the image generation call." }, "result": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -39925,13 +43880,19 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "nullable": true + "anyOf": [ + { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -40015,8 +43976,14 @@ "description": "Whether the request was approved." }, "reason": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -40060,8 +44027,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -40107,12 +44073,18 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "error": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, "status": { "allOf": [ @@ -40123,8 +44095,14 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -40180,6 +44158,16 @@ "$ref": "#/components/schemas/OpenAI.MessageContent" }, "description": "The content of the message" + }, + "phase": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -40211,8 +44199,14 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "summary": { "type": "array", @@ -40246,6 +44240,138 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, + "OpenAI.ItemFieldToolSearchCall": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "arguments", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The type of the item. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search call item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "description": "Arguments used for the tool search call." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the tool search call item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemField" + } + ] + }, + "OpenAI.ItemFieldToolSearchOutput": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "tools", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The type of the item. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search output item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by tool search." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the tool search output item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemField" + } + ] + }, "OpenAI.ItemFieldType": { "anyOf": [ { @@ -40256,6 +44382,9 @@ "enum": [ "message", "function_call", + "tool_search_call", + "tool_search_output", + "additional_tools", "function_call_output", "file_search_call", "web_search_call", @@ -40375,11 +44504,17 @@ "description": "The queries used to search for files." }, "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -40399,8 +44534,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -40442,12 +44583,14 @@ "description": "Text, image, or file output of the function tool call." }, "status": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "allOf": [ @@ -40467,8 +44610,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -40494,21 +44643,24 @@ "description": "The shell commands and limits that describe how to run the tool call." }, "status": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemStatus" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "environment": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemParamEnvironment" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "allOf": [ @@ -40528,8 +44680,14 @@ ], "properties": { "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "call_id": { "type": "string", @@ -40554,21 +44712,24 @@ "description": "Captured chunks of stdout and stderr output, along with their associated outcomes." }, "status": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemStatus" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "max_output_length": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "allOf": [ @@ -40582,6 +44743,7 @@ "OpenAI.ItemFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", "name", @@ -40590,7 +44752,8 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", @@ -40604,6 +44767,10 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, "name": { "type": "string", "description": "The name of the function to run." @@ -40662,8 +44829,14 @@ "description": "The status of the image generation call." }, "result": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -40674,6 +44847,59 @@ "description": "An image generation request made by the model.", "title": "Image generation call" }, + "OpenAI.ItemInputMessage": { + "type": "object", + "required": [ + "type", + "role", + "content", + "id" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "message" + ], + "description": "The type of the message input. Always set to `message`.", + "x-stainless-const": true, + "default": "message" + }, + "role": { + "type": "string", + "enum": [ + "user", + "system", + "developer" + ], + "description": "The role of the message input. One of `user`, `system`, or `developer`." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "content": { + "$ref": "#/components/schemas/OpenAI.InputMessageContentList" + }, + "id": { + "type": "string", + "description": "The unique ID of the message input.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Item" + } + ], + "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role.", + "title": "Input message" + }, "OpenAI.ItemLocalShellToolCall": { "type": "object", "required": [ @@ -40746,13 +44972,19 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "nullable": true + "anyOf": [ + { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -40823,8 +45055,14 @@ "x-stainless-const": true }, "id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "approval_request_id": { "type": "string", @@ -40835,8 +45073,14 @@ "description": "Whether the request was approved." }, "reason": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -40880,8 +45124,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -40927,12 +45170,18 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "error": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, "status": { "allOf": [ @@ -40943,8 +45192,14 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -40992,6 +45247,16 @@ }, "description": "The content of the output message." }, + "phase": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + }, + { + "type": "null" + } + ] + }, "status": { "type": "string", "enum": [ @@ -41031,8 +45296,14 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "summary": { "type": "array", @@ -41079,8 +45350,7 @@ "item_reference" ], "description": "The type of item to reference. Always `item_reference`.", - "x-stainless-const": true, - "default": "item_reference" + "x-stainless-const": true }, "id": { "type": "string", @@ -41108,14 +45378,19 @@ "discriminator": { "propertyName": "type", "mapping": { - "message": "#/components/schemas/OpenAI.InputMessageResource", + "message": "#/components/schemas/OpenAI.ItemResourceInputMessage", "output_message": "#/components/schemas/OpenAI.ItemResourceOutputMessage", "file_search_call": "#/components/schemas/OpenAI.ItemResourceFileSearchToolCall", "computer_call": "#/components/schemas/OpenAI.ItemResourceComputerToolCall", - "computer_call_output": "#/components/schemas/OpenAI.ItemResourceComputerToolCallOutputResource", + "computer_call_output": "#/components/schemas/OpenAI.ItemResourceComputerToolCallOutput", "web_search_call": "#/components/schemas/OpenAI.ItemResourceWebSearchToolCall", - "function_call": "#/components/schemas/OpenAI.ItemResourceFunctionToolCallResource", - "function_call_output": "#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutputResource", + "function_call": "#/components/schemas/OpenAI.ItemResourceFunctionToolCall", + "function_call_output": "#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutput", + "tool_search_call": "#/components/schemas/OpenAI.ItemResourceToolSearchCall", + "tool_search_output": "#/components/schemas/OpenAI.ItemResourceToolSearchOutput", + "additional_tools": "#/components/schemas/OpenAI.ItemResourceAdditionalTools", + "reasoning": "#/components/schemas/OpenAI.ItemResourceReasoningItem", + "compaction": "#/components/schemas/OpenAI.ItemResourceCompactionBody", "image_generation_call": "#/components/schemas/OpenAI.ItemResourceImageGenToolCall", "code_interpreter_call": "#/components/schemas/OpenAI.ItemResourceCodeInterpreterToolCall", "local_shell_call": "#/components/schemas/OpenAI.ItemResourceLocalShellToolCall", @@ -41127,11 +45402,57 @@ "mcp_list_tools": "#/components/schemas/OpenAI.ItemResourceMcpListTools", "mcp_approval_request": "#/components/schemas/OpenAI.ItemResourceMcpApprovalRequest", "mcp_approval_response": "#/components/schemas/OpenAI.ItemResourceMcpApprovalResponseResource", - "mcp_call": "#/components/schemas/OpenAI.ItemResourceMcpToolCall" + "mcp_call": "#/components/schemas/OpenAI.ItemResourceMcpToolCall", + "custom_tool_call": "#/components/schemas/OpenAI.ItemResourceCustomToolCallResource", + "custom_tool_call_output": "#/components/schemas/OpenAI.ItemResourceCustomToolCallOutputResource" } }, "description": "Content item used to generate a response." }, + "OpenAI.ItemResourceAdditionalTools": { + "type": "object", + "required": [ + "type", + "id", + "role", + "tools" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "additional_tools" + ], + "description": "The type of the item. Always `additional_tools`.", + "x-stainless-const": true, + "default": "additional_tools" + }, + "id": { + "type": "string", + "description": "The unique ID of the additional tools item." + }, + "role": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessageRole" + } + ], + "description": "The role that provided the additional tools." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The additional tool definitions made available at this item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ] + }, "OpenAI.ItemResourceApplyPatchToolCall": { "type": "object", "required": [ @@ -41224,8 +45545,14 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "created_by": { "type": "string", @@ -41280,22 +45607,34 @@ "description": "The ID of the container used to run the code." }, "code": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "outputs": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + "anyOf": [ + { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + } + ] } - ] - }, - "nullable": true + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -41306,13 +45645,50 @@ "description": "A tool call to run code.", "title": "Code interpreter tool call" }, + "OpenAI.ItemResourceCompactionBody": { + "type": "object", + "required": [ + "type", + "id", + "encrypted_content" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "compaction" + ], + "description": "The type of the item. Always `compaction`.", + "x-stainless-const": true, + "default": "compaction" + }, + "id": { + "type": "string", + "description": "The unique ID of the compaction item." + }, + "encrypted_content": { + "type": "string", + "description": "The encrypted content that was produced by compaction." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "description": "A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact).", + "title": "Compaction item" + }, "OpenAI.ItemResourceComputerToolCall": { "type": "object", "required": [ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -41336,6 +45712,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -41361,10 +45740,11 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.ItemResourceComputerToolCallOutputResource": { + "OpenAI.ItemResourceComputerToolCallOutput": { "type": "object", "required": [ "type", + "id", "call_id", "output" ], @@ -41380,7 +45760,8 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output." + "description": "The ID of the computer tool call output.", + "readOnly": true }, "call_id": { "type": "string", @@ -41410,7 +45791,126 @@ { "$ref": "#/components/schemas/OpenAI.ItemResource" } - ] + ], + "description": "The output of a computer tool call.", + "title": "Computer tool call output" + }, + "OpenAI.ItemResourceCustomToolCallOutputResource": { + "type": "object", + "required": [ + "type", + "call_id", + "output", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "custom_tool_call_output" + ], + "description": "The type of the custom tool call output. Always `custom_tool_call_output`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the custom tool call output in the OpenAI platform." + }, + "call_id": { + "type": "string", + "description": "The call ID, used to map this custom tool call output to a custom tool call." + }, + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "title": "ResponseCustomToolCallOutputItem" + }, + "OpenAI.ItemResourceCustomToolCallResource": { + "type": "object", + "required": [ + "type", + "call_id", + "name", + "input", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "custom_tool_call" + ], + "description": "The type of the custom tool call. Always `custom_tool_call`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the custom tool call in the OpenAI platform." + }, + "call_id": { + "type": "string", + "description": "An identifier used to map this custom tool call to a tool call output." + }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, + "name": { + "type": "string", + "description": "The name of the custom tool being called." + }, + "input": { + "type": "string", + "description": "The input for the custom tool call generated by the model." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "title": "ResponseCustomToolCallItem" }, "OpenAI.ItemResourceFileSearchToolCall": { "type": "object", @@ -41452,11 +45952,17 @@ "description": "The queries used to search for files." }, "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -41506,19 +46012,20 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." }, "environment": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallEnvironment" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "created_by": { "type": "string", @@ -41564,30 +46071,88 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." }, - "output": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputContent" - }, - "description": "An array of shell call output contents" + "output": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputContent" + }, + "description": "An array of shell call output contents" + }, + "max_output_length": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" + } + ] + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "description": "The output of a shell tool call that was emitted.", + "title": "Shell call output" + }, + "OpenAI.ItemResourceFunctionToolCall": { + "type": "object", + "required": [ + "id", + "type", + "call_id", + "name", + "arguments" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique ID of the function tool call.", + "readOnly": true + }, + "type": { + "type": "string", + "enum": [ + "function_call" + ], + "description": "The type of the function tool call. Always `function_call`.", + "x-stainless-const": true + }, + "call_id": { + "type": "string", + "description": "The unique ID of the function tool call generated by the model." + }, + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, + "name": { + "type": "string", + "description": "The name of the function to run." }, - "max_output_length": { - "type": "integer", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - } - ], - "nullable": true + "arguments": { + "type": "string", + "description": "A JSON string of the arguments to pass to the function." }, - "created_by": { + "status": { "type": "string", - "description": "The identifier of the actor that created the item." + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." } }, "allOf": [ @@ -41595,12 +46160,13 @@ "$ref": "#/components/schemas/OpenAI.ItemResource" } ], - "description": "The output of a shell tool call that was emitted.", - "title": "Shell call output" + "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", + "title": "Function tool call" }, - "OpenAI.ItemResourceFunctionToolCallOutputResource": { + "OpenAI.ItemResourceFunctionToolCallOutput": { "type": "object", "required": [ + "id", "type", "call_id", "output" @@ -41608,7 +46174,8 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", + "readOnly": true }, "type": { "type": "string", @@ -41650,91 +46217,103 @@ { "$ref": "#/components/schemas/OpenAI.ItemResource" } - ] + ], + "description": "The output of a function tool call.", + "title": "Function tool call output" }, - "OpenAI.ItemResourceFunctionToolCallResource": { + "OpenAI.ItemResourceImageGenToolCall": { "type": "object", "required": [ "type", - "call_id", - "name", - "arguments" + "id", + "status", + "result" ], "properties": { - "id": { - "type": "string", - "description": "The unique ID of the function tool call." - }, "type": { "type": "string", "enum": [ - "function_call" + "image_generation_call" ], - "description": "The type of the function tool call. Always `function_call`.", + "description": "The type of the image generation call. Always `image_generation_call`.", "x-stainless-const": true }, - "call_id": { - "type": "string", - "description": "The unique ID of the function tool call generated by the model." - }, - "name": { - "type": "string", - "description": "The name of the function to run." - }, - "arguments": { + "id": { "type": "string", - "description": "A JSON string of the arguments to pass to the function." + "description": "The unique ID of the image generation call." }, "status": { "type": "string", "enum": [ "in_progress", "completed", - "incomplete" + "generating", + "failed" ], - "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + "description": "The status of the image generation call." + }, + "result": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ { "$ref": "#/components/schemas/OpenAI.ItemResource" } - ] + ], + "description": "An image generation request made by the model.", + "title": "Image generation call" }, - "OpenAI.ItemResourceImageGenToolCall": { + "OpenAI.ItemResourceInputMessage": { "type": "object", "required": [ "type", - "id", - "status", - "result" + "role", + "content", + "id" ], "properties": { "type": { "type": "string", "enum": [ - "image_generation_call" + "message" ], - "description": "The type of the image generation call. Always `image_generation_call`.", - "x-stainless-const": true + "description": "The type of the message input. Always set to `message`.", + "x-stainless-const": true, + "default": "message" }, - "id": { + "role": { "type": "string", - "description": "The unique ID of the image generation call." + "enum": [ + "user", + "system", + "developer" + ], + "description": "The role of the message input. One of `user`, `system`, or `developer`." }, "status": { "type": "string", "enum": [ "in_progress", "completed", - "generating", - "failed" + "incomplete" ], - "description": "The status of the image generation call." + "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." }, - "result": { + "content": { + "$ref": "#/components/schemas/OpenAI.InputMessageContentList" + }, + "id": { "type": "string", - "nullable": true + "description": "The unique ID of the message input.", + "readOnly": true } }, "allOf": [ @@ -41742,8 +46321,8 @@ "$ref": "#/components/schemas/OpenAI.ItemResource" } ], - "description": "An image generation request made by the model.", - "title": "Image generation call" + "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role.", + "title": "Input message" }, "OpenAI.ItemResourceLocalShellToolCall": { "type": "object", @@ -41817,13 +46396,19 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "nullable": true + "anyOf": [ + { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -41907,8 +46492,14 @@ "description": "Whether the request was approved." }, "reason": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -41952,8 +46543,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -41999,12 +46589,18 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "error": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, "status": { "allOf": [ @@ -42015,8 +46611,14 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -42064,6 +46666,16 @@ }, "description": "The content of the output message." }, + "phase": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + }, + { + "type": "null" + } + ] + }, "status": { "type": "string", "enum": [ @@ -42082,6 +46694,200 @@ "description": "An output message from the model.", "title": "Output message" }, + "OpenAI.ItemResourceReasoningItem": { + "type": "object", + "required": [ + "type", + "id", + "summary" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "reasoning" + ], + "description": "The type of the object. Always `reasoning`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique identifier of the reasoning content." + }, + "encrypted_content": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "summary": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.SummaryTextContent" + }, + "description": "Reasoning summary content." + }, + "content": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ReasoningTextContent" + }, + "description": "Reasoning text content." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", + "title": "Reasoning" + }, + "OpenAI.ItemResourceToolSearchCall": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "arguments", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The type of the item. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search call item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "description": "Arguments used for the tool search call." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the tool search call item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ] + }, + "OpenAI.ItemResourceToolSearchOutput": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "tools", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The type of the item. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search output item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by tool search." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the tool search output item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ] + }, "OpenAI.ItemResourceType": { "anyOf": [ { @@ -42098,6 +46904,11 @@ "web_search_call", "function_call", "function_call_output", + "tool_search_call", + "tool_search_output", + "additional_tools", + "reasoning", + "compaction", "image_generation_call", "code_interpreter_call", "local_shell_call", @@ -42110,6 +46921,8 @@ "mcp_approval_request", "mcp_approval_response", "mcp_call", + "custom_tool_call", + "custom_tool_call_output", "structured_outputs", "oauth_consent_request", "memory_search_call", @@ -42192,6 +47005,143 @@ "description": "The results of a web search tool call. See the\n[web search guide](/docs/guides/tools-web-search) for more information.", "title": "Web search tool call" }, + "OpenAI.ItemToolSearchCallItemParam": { + "type": "object", + "required": [ + "type", + "arguments" + ], + "properties": { + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The item type. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.EmptyModelParam" + } + ], + "description": "The arguments supplied to the tool search call." + }, + "status": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + }, + { + "type": "null" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Item" + } + ] + }, + "OpenAI.ItemToolSearchOutputItemParam": { + "type": "object", + "required": [ + "type", + "tools" + ], + "properties": { + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The item type. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by the tool search output." + }, + "status": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + }, + { + "type": "null" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Item" + } + ] + }, "OpenAI.ItemType": { "anyOf": [ { @@ -42208,6 +47158,9 @@ "web_search_call", "function_call", "function_call_output", + "tool_search_call", + "tool_search_output", + "additional_tools", "reasoning", "compaction", "image_generation_call", @@ -42319,8 +47272,7 @@ "keypress" ], "description": "Specifies the event type. For a keypress action, this property is always set to `keypress`.", - "x-stainless-const": true, - "default": "keypress" + "x-stainless-const": true }, "keys": { "type": "array", @@ -42361,12 +47313,24 @@ "x-stainless-const": true }, "first_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "last_id": { - "type": "string", - "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "x-ms-list-continuation-token": true }, "has_more": { @@ -42440,8 +47404,7 @@ "local" ], "description": "The environment type. Always `local`.", - "x-stainless-const": true, - "default": "local" + "x-stainless-const": true } }, "allOf": [ @@ -42452,22 +47415,6 @@ "description": "Represents the use of a local environment to perform shell actions.", "title": "Local Environment" }, - "OpenAI.LocalShellCallOutputStatusEnum": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, - "OpenAI.LocalShellCallStatus": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, "OpenAI.LocalShellExecAction": { "type": "object", "required": [ @@ -42493,29 +47440,42 @@ "description": "The command to run." }, "timeout_ms": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "working_directory": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "env": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Environment variables to set for the command.", "x-oaiTypeLabel": "map" }, "user": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "description": "Execute a shell command on the server.", @@ -42533,8 +47493,7 @@ "local_shell" ], "description": "The type of the local shell tool. Always `local_shell`.", - "x-stainless-const": true, - "default": "local_shell" + "x-stainless-const": true }, "name": { "type": "string", @@ -42618,8 +47577,14 @@ "description": "The name of the tool." }, "description": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "input_schema": { "allOf": [ @@ -42630,13 +47595,14 @@ "description": "The JSON schema describing the tool's input." }, "annotations": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.MCPListToolsToolAnnotations" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "description": "A tool available on an MCP server.", @@ -42695,11 +47661,17 @@ "description": "Optional description of the MCP server, used to provide more context." }, "headers": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "nullable": true + "anyOf": [ + { + "type": "object", + "unevaluatedProperties": { + "type": "string" + } + }, + { + "type": "null" + } + ] }, "allowed_tools": { "anyOf": [ @@ -42707,42 +47679,38 @@ "type": "array", "items": { "type": "string" - }, - "nullable": true + } }, { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.MCPToolFilter" - } - ], - "nullable": true + "$ref": "#/components/schemas/OpenAI.MCPToolFilter" + }, + { + "type": "null" } ] }, "require_approval": { "anyOf": [ { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" - } - ], - "nullable": true + "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" }, { "type": "string", "enum": [ "always", "never" - ], - "nullable": true + ] + }, + { + "type": "null" } ], "default": "always" }, + "defer_loading": { + "type": "boolean", + "description": "Whether this MCP tool is deferred and discovered via tool search." + }, "project_connection_id": { "type": "string", "description": "The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server." @@ -42816,7 +47784,8 @@ "reasoning_text": "#/components/schemas/OpenAI.MessageContentReasoningTextContent", "refusal": "#/components/schemas/OpenAI.MessageContentRefusalContent", "input_image": "#/components/schemas/OpenAI.MessageContentInputImageContent", - "input_file": "#/components/schemas/OpenAI.MessageContentInputFileContent" + "input_file": "#/components/schemas/OpenAI.MessageContentInputFileContent", + "summary_text": "#/components/schemas/OpenAI.SummaryTextContent" } }, "description": "A content part that makes up an input or output item." @@ -42837,21 +47806,35 @@ "default": "input_file" }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "filename": { "type": "string", "description": "The name of the file to be sent to the model." }, + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." + }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "allOf": [ @@ -42879,13 +47862,25 @@ "default": "input_image" }, "image_url": { - "type": "string", - "format": "uri", - "nullable": true + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ] }, "file_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "detail": { "allOf": [ @@ -42893,7 +47888,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "allOf": [ @@ -43056,6 +48051,14 @@ } ] }, + "OpenAI.MessagePhase": { + "type": "string", + "enum": [ + "commentary", + "final_answer" + ], + "description": "Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`).\nFor models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend\nphase on all assistant messages — dropping it can degrade performance. Not used for user messages." + }, "OpenAI.MessageRole": { "type": "string", "enum": [ @@ -43079,7 +48082,7 @@ }, "OpenAI.Metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -43088,18 +48091,13 @@ "OpenAI.ModelIdsCompaction": { "anyOf": [ { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ModelIdsResponses" - } - ], - "description": "Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models.", - "nullable": true + "$ref": "#/components/schemas/OpenAI.ModelIdsResponses" }, { - "type": "string", - "description": "Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models.", - "nullable": true + "type": "string" + }, + { + "type": "null" } ], "description": "Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models." @@ -43140,6 +48138,182 @@ } ] }, + "OpenAI.Moderation": { + "type": "object", + "required": [ + "input", + "output" + ], + "properties": { + "input": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ModerationEntry" + } + ], + "description": "Moderation for the response input." + }, + "output": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ModerationEntry" + } + ], + "description": "Moderation for the response output." + } + }, + "description": "Moderation results or errors for the response input and output.", + "title": "Moderation" + }, + "OpenAI.ModerationEntry": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/OpenAI.ModerationEntryType" + } + }, + "discriminator": { + "propertyName": "type", + "mapping": { + "moderation_result": "#/components/schemas/OpenAI.ModerationResultBody", + "error": "#/components/schemas/OpenAI.ModerationErrorBody" + } + }, + "description": "Moderation results or an error for a response moderation check." + }, + "OpenAI.ModerationEntryType": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "moderation_result", + "error" + ] + } + ] + }, + "OpenAI.ModerationErrorBody": { + "type": "object", + "required": [ + "type", + "code", + "message" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "error" + ], + "description": "The object type, which was always `error` for moderation failures.", + "x-stainless-const": true + }, + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ModerationEntry" + } + ], + "description": "An error produced while attempting moderation for the response input or output.", + "title": "Moderation error" + }, + "OpenAI.ModerationInputType": { + "type": "string", + "enum": [ + "text", + "image" + ] + }, + "OpenAI.ModerationParam": { + "type": "object", + "required": [ + "model" + ], + "properties": { + "model": { + "type": "string", + "description": "The moderation model to use for moderated completions, e.g. 'omni-moderation-latest'." + } + }, + "description": "Configuration for running moderation on the input and output of this response." + }, + "OpenAI.ModerationResultBody": { + "type": "object", + "required": [ + "type", + "model", + "flagged", + "categories", + "category_scores", + "category_applied_input_types" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "moderation_result" + ], + "description": "The object type, which was always `moderation_result` for successful moderation results.", + "x-stainless-const": true + }, + "model": { + "type": "string", + "description": "The moderation model that produced this result." + }, + "flagged": { + "type": "boolean", + "description": "A boolean indicating whether the content was flagged by any category." + }, + "categories": { + "type": "object", + "unevaluatedProperties": { + "type": "boolean" + }, + "description": "A dictionary of moderation categories to booleans, True if the input is flagged under this category.", + "x-oaiTypeLabel": "map" + }, + "category_scores": { + "type": "object", + "unevaluatedProperties": { + "$ref": "#/components/schemas/OpenAI.numeric" + }, + "description": "A dictionary of moderation categories to scores.", + "x-oaiTypeLabel": "map" + }, + "category_applied_input_types": { + "type": "object", + "unevaluatedProperties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ModerationInputType" + } + }, + "description": "Which modalities of input are reflected by the score for each category.", + "x-oaiTypeLabel": "map" + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ModerationEntry" + } + ], + "description": "A moderation result produced for the response input or output.", + "title": "Moderation result" + }, "OpenAI.MoveParam": { "type": "object", "required": [ @@ -43154,8 +48328,7 @@ "move" ], "description": "Specifies the event type. For a move action, this property is always set to `move`.", - "x-stainless-const": true, - "default": "move" + "x-stainless-const": true }, "x": { "allOf": [ @@ -43172,6 +48345,19 @@ } ], "description": "The y-coordinate to move to." + }, + "keys": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -43182,6 +48368,57 @@ "description": "A mouse move action.", "title": "Move" }, + "OpenAI.NamespaceToolParam": { + "type": "object", + "required": [ + "type", + "name", + "description", + "tools" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "namespace" + ], + "description": "The type of the tool. Always `namespace`.", + "x-stainless-const": true + }, + "name": { + "type": "string", + "minLength": 1, + "description": "The namespace name used in tool calls (for example, `crm`)." + }, + "description": { + "type": "string", + "minLength": 1, + "description": "A description of the namespace shown to the model." + }, + "tools": { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionToolParam" + }, + { + "$ref": "#/components/schemas/OpenAI.CustomToolParam" + } + ] + }, + "minItems": 1, + "description": "The function/custom tools available inside this namespace." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Tool" + } + ], + "description": "Groups function/custom tools under a shared namespace.", + "title": "Namespace" + }, "OpenAI.OutputContent": { "type": "object", "required": [ @@ -43381,13 +48618,19 @@ "output_message": "#/components/schemas/OpenAI.OutputItemOutputMessage", "file_search_call": "#/components/schemas/OpenAI.OutputItemFileSearchToolCall", "function_call": "#/components/schemas/OpenAI.OutputItemFunctionToolCall", + "function_call_output": "#/components/schemas/OpenAI.OutputItemFunctionToolCallOutput", "web_search_call": "#/components/schemas/OpenAI.OutputItemWebSearchToolCall", "computer_call": "#/components/schemas/OpenAI.OutputItemComputerToolCall", + "computer_call_output": "#/components/schemas/OpenAI.OutputItemComputerToolCallOutput", "reasoning": "#/components/schemas/OpenAI.OutputItemReasoningItem", + "tool_search_call": "#/components/schemas/OpenAI.OutputItemToolSearchCall", + "tool_search_output": "#/components/schemas/OpenAI.OutputItemToolSearchOutput", + "additional_tools": "#/components/schemas/OpenAI.OutputItemAdditionalTools", "compaction": "#/components/schemas/OpenAI.OutputItemCompactionBody", "image_generation_call": "#/components/schemas/OpenAI.OutputItemImageGenToolCall", "code_interpreter_call": "#/components/schemas/OpenAI.OutputItemCodeInterpreterToolCall", "local_shell_call": "#/components/schemas/OpenAI.OutputItemLocalShellToolCall", + "local_shell_call_output": "#/components/schemas/OpenAI.OutputItemLocalShellToolCallOutput", "shell_call": "#/components/schemas/OpenAI.OutputItemFunctionShellCall", "shell_call_output": "#/components/schemas/OpenAI.OutputItemFunctionShellCallOutput", "apply_patch_call": "#/components/schemas/OpenAI.OutputItemApplyPatchToolCall", @@ -43395,10 +48638,56 @@ "mcp_call": "#/components/schemas/OpenAI.OutputItemMcpToolCall", "mcp_list_tools": "#/components/schemas/OpenAI.OutputItemMcpListTools", "mcp_approval_request": "#/components/schemas/OpenAI.OutputItemMcpApprovalRequest", - "custom_tool_call": "#/components/schemas/OpenAI.OutputItemCustomToolCall" + "mcp_approval_response": "#/components/schemas/OpenAI.OutputItemMcpApprovalResponseResource", + "custom_tool_call": "#/components/schemas/OpenAI.OutputItemCustomToolCallResource", + "custom_tool_call_output": "#/components/schemas/OpenAI.OutputItemCustomToolCallOutputResource" } } }, + "OpenAI.OutputItemAdditionalTools": { + "type": "object", + "required": [ + "type", + "id", + "role", + "tools" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "additional_tools" + ], + "description": "The type of the item. Always `additional_tools`.", + "x-stainless-const": true, + "default": "additional_tools" + }, + "id": { + "type": "string", + "description": "The unique ID of the additional tools item." + }, + "role": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessageRole" + } + ], + "description": "The role that provided the additional tools." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The additional tool definitions made available at this item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ] + }, "OpenAI.OutputItemApplyPatchToolCall": { "type": "object", "required": [ @@ -43491,8 +48780,14 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "created_by": { "type": "string", @@ -43547,22 +48842,34 @@ "description": "The ID of the container used to run the code." }, "code": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "outputs": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + "anyOf": [ + { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" + } + ] } - ] - }, - "nullable": true + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -43617,7 +48924,6 @@ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -43641,6 +48947,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -43666,13 +48975,128 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.OutputItemCustomToolCall": { + "OpenAI.OutputItemComputerToolCallOutput": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "output" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "computer_call_output" + ], + "description": "The type of the computer tool call output. Always `computer_call_output`.", + "x-stainless-const": true, + "default": "computer_call_output" + }, + "id": { + "type": "string", + "description": "The ID of the computer tool call output.", + "readOnly": true + }, + "call_id": { + "type": "string", + "description": "The ID of the computer tool call that produced the output." + }, + "acknowledged_safety_checks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" + }, + "description": "The safety checks reported by the API that have been acknowledged by the\n developer." + }, + "output": { + "$ref": "#/components/schemas/OpenAI.ComputerScreenshotImage" + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of the message input. One of `in_progress`, `completed`, or\n `incomplete`. Populated when input items are returned via API." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "description": "The output of a computer tool call.", + "title": "Computer tool call output" + }, + "OpenAI.OutputItemCustomToolCallOutputResource": { + "type": "object", + "required": [ + "type", + "call_id", + "output", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "custom_tool_call_output" + ], + "description": "The type of the custom tool call output. Always `custom_tool_call_output`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the custom tool call output in the OpenAI platform." + }, + "call_id": { + "type": "string", + "description": "The call ID, used to map this custom tool call output to a custom tool call." + }, + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "title": "ResponseCustomToolCallOutputItem" + }, + "OpenAI.OutputItemCustomToolCallResource": { "type": "object", "required": [ "type", "call_id", "name", - "input" + "input", + "status" ], "properties": { "type": { @@ -43691,6 +49115,10 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -43698,6 +49126,18 @@ "input": { "type": "string", "description": "The input for the custom tool call generated by the model." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." } }, "allOf": [ @@ -43705,8 +49145,7 @@ "$ref": "#/components/schemas/OpenAI.OutputItem" } ], - "description": "A call to a custom tool created by the model.", - "title": "Custom tool call" + "title": "ResponseCustomToolCallItem" }, "OpenAI.OutputItemFileSearchToolCall": { "type": "object", @@ -43748,11 +49187,17 @@ "description": "The queries used to search for files." }, "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -43802,19 +49247,20 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." }, "environment": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallEnvironment" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "created_by": { "type": "string", @@ -43860,7 +49306,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -43873,13 +49319,14 @@ "description": "An array of shell call output contents" }, "max_output_length": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "created_by": { "type": "string", @@ -43897,35 +49344,99 @@ "OpenAI.OutputItemFunctionToolCall": { "type": "object", "required": [ + "id", + "type", + "call_id", + "name", + "arguments" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique ID of the function tool call.", + "readOnly": true + }, + "type": { + "type": "string", + "enum": [ + "function_call" + ], + "description": "The type of the function tool call. Always `function_call`.", + "x-stainless-const": true + }, + "call_id": { + "type": "string", + "description": "The unique ID of the function tool call generated by the model." + }, + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, + "name": { + "type": "string", + "description": "The name of the function to run." + }, + "arguments": { + "type": "string", + "description": "A JSON string of the arguments to pass to the function." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", + "title": "Function tool call" + }, + "OpenAI.OutputItemFunctionToolCallOutput": { + "type": "object", + "required": [ + "id", "type", "call_id", - "name", - "arguments" + "output" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", + "readOnly": true }, "type": { "type": "string", "enum": [ - "function_call" + "function_call_output" ], - "description": "The type of the function tool call. Always `function_call`.", + "description": "The type of the function tool call output. Always `function_call_output`.", "x-stainless-const": true }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "name": { - "type": "string", - "description": "The name of the function to run." - }, - "arguments": { - "type": "string", - "description": "A JSON string of the arguments to pass to the function." + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." }, "status": { "type": "string", @@ -43942,8 +49453,8 @@ "$ref": "#/components/schemas/OpenAI.OutputItem" } ], - "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", - "title": "Function tool call" + "description": "The output of a function tool call.", + "title": "Function tool call output" }, "OpenAI.OutputItemImageGenToolCall": { "type": "object", @@ -43977,8 +49488,14 @@ "description": "The status of the image generation call." }, "result": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -44036,6 +49553,54 @@ "description": "A tool call to run a command on the local shell.", "title": "Local shell call" }, + "OpenAI.OutputItemLocalShellToolCallOutput": { + "type": "object", + "required": [ + "type", + "id", + "output" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "local_shell_call_output" + ], + "description": "The type of the local shell tool call output. Always `local_shell_call_output`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the local shell tool call generated by the model." + }, + "output": { + "type": "string", + "description": "A JSON string of the output of the local shell tool call." + }, + "status": { + "anyOf": [ + { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + { + "type": "null" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "description": "The output of a local shell tool call.", + "title": "Local shell call output" + }, "OpenAI.OutputItemMcpApprovalRequest": { "type": "object", "required": [ @@ -44079,6 +49644,54 @@ "description": "A request for human approval of a tool invocation.", "title": "MCP approval request" }, + "OpenAI.OutputItemMcpApprovalResponseResource": { + "type": "object", + "required": [ + "type", + "id", + "approval_request_id", + "approve" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "mcp_approval_response" + ], + "description": "The type of the item. Always `mcp_approval_response`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the approval response" + }, + "approval_request_id": { + "type": "string", + "description": "The ID of the approval request being answered." + }, + "approve": { + "type": "boolean", + "description": "Whether the request was approved." + }, + "reason": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "description": "A response to an MCP approval request.", + "title": "MCP approval response" + }, "OpenAI.OutputItemMcpListTools": { "type": "object", "required": [ @@ -44112,8 +49725,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -44159,12 +49771,18 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "error": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, "status": { "allOf": [ @@ -44175,8 +49793,14 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -44224,6 +49848,16 @@ }, "description": "The content of the output message." }, + "phase": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + }, + { + "type": "null" + } + ] + }, "status": { "type": "string", "enum": [ @@ -44263,8 +49897,14 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "summary": { "type": "array", @@ -44298,6 +49938,138 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, + "OpenAI.OutputItemToolSearchCall": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "arguments", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The type of the item. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search call item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "description": "Arguments used for the tool search call." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the tool search call item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ] + }, + "OpenAI.OutputItemToolSearchOutput": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "tools", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The type of the item. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search output item." + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by tool search." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the tool search output item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ] + }, "OpenAI.OutputItemType": { "anyOf": [ { @@ -44309,13 +50081,19 @@ "output_message", "file_search_call", "function_call", + "function_call_output", "web_search_call", "computer_call", + "computer_call_output", "reasoning", + "tool_search_call", + "tool_search_output", + "additional_tools", "compaction", "image_generation_call", "code_interpreter_call", "local_shell_call", + "local_shell_call_output", "shell_call", "shell_call_output", "apply_patch_call", @@ -44323,7 +50101,9 @@ "mcp_call", "mcp_list_tools", "mcp_approval_request", + "mcp_approval_response", "custom_tool_call", + "custom_tool_call_output", "structured_outputs", "oauth_consent_request", "memory_search_call", @@ -44522,21 +50302,35 @@ "description": "The unique identifier of the prompt template to use." }, "version": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "variables": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.ResponsePromptVariables" + }, + { + "type": "null" } - ], - "nullable": true + ] } }, "description": "Reference to a prompt template and its variables.\n[Learn more](/docs/guides/text?api-mode=responses#reusable-prompts)." }, + "OpenAI.PromptCacheRetentionEnum": { + "type": "string", + "enum": [ + "in_memory", + "24h" + ] + }, "OpenAI.RankerVersionType": { "type": "string", "enum": [ @@ -44573,46 +50367,181 @@ } } }, - "OpenAI.Reasoning": { + "OpenAI.RealtimeMCPError": { "type": "object", + "required": [ + "type" + ], "properties": { - "effort": { - "$ref": "#/components/schemas/OpenAI.ReasoningEffort" + "type": { + "$ref": "#/components/schemas/OpenAI.RealtimeMcpErrorType" + } + }, + "discriminator": { + "propertyName": "type", + "mapping": { + "protocol_error": "#/components/schemas/OpenAI.RealtimeMCPProtocolError", + "tool_execution_error": "#/components/schemas/OpenAI.RealtimeMCPToolExecutionError", + "http_error": "#/components/schemas/OpenAI.RealtimeMCPHTTPError" + } + } + }, + "OpenAI.RealtimeMCPHTTPError": { + "type": "object", + "required": [ + "type", + "code", + "message" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "http_error" + ], + "x-stainless-const": true }, - "summary": { + "code": { + "$ref": "#/components/schemas/OpenAI.integer" + }, + "message": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + } + ], + "title": "Realtime MCP HTTP error" + }, + "OpenAI.RealtimeMCPProtocolError": { + "type": "object", + "required": [ + "type", + "code", + "message" + ], + "properties": { + "type": { "type": "string", "enum": [ - "auto", - "concise", - "detailed" + "protocol_error" ], - "nullable": true + "x-stainless-const": true }, - "generate_summary": { + "code": { + "$ref": "#/components/schemas/OpenAI.integer" + }, + "message": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + } + ], + "title": "Realtime MCP protocol error" + }, + "OpenAI.RealtimeMCPToolExecutionError": { + "type": "object", + "required": [ + "type", + "message" + ], + "properties": { + "type": { "type": "string", "enum": [ - "auto", - "concise", - "detailed" + "tool_execution_error" ], - "nullable": true + "x-stainless-const": true + }, + "message": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + } + ], + "title": "Realtime MCP tool execution error" + }, + "OpenAI.RealtimeMcpErrorType": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "protocol_error", + "tool_execution_error", + "http_error" + ] + } + ] + }, + "OpenAI.Reasoning": { + "type": "object", + "properties": { + "effort": { + "$ref": "#/components/schemas/OpenAI.ReasoningEffort" + }, + "summary": { + "anyOf": [ + { + "type": "string", + "enum": [ + "auto", + "concise", + "detailed" + ] + }, + { + "type": "null" + } + ] + }, + "generate_summary": { + "anyOf": [ + { + "type": "string", + "enum": [ + "auto", + "concise", + "detailed" + ] + }, + { + "type": "null" + } + ] } }, "description": "**gpt-5 and o-series models only**\nConfiguration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).", "title": "Reasoning" }, "OpenAI.ReasoningEffort": { - "type": "string", - "enum": [ - "none", - "minimal", - "low", - "medium", - "high", - "xhigh" + "anyOf": [ + { + "type": "string", + "enum": [ + "none", + "minimal", + "low", + "medium", + "high", + "xhigh" + ] + }, + { + "type": "null" + } ], - "description": "Constrains effort on reasoning for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\nCurrently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing\nreasoning effort can result in faster responses and fewer tokens used\non reasoning in a response.\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is supported for all models after `gpt-5.1-codex-max`.", - "nullable": true + "description": "Constrains effort on reasoning for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\nCurrently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing\nreasoning effort can result in faster responses and fewer tokens used\non reasoning in a response.\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is supported for all models after `gpt-5.1-codex-max`." }, "OpenAI.ReasoningTextContent": { "type": "object", @@ -44653,41 +50582,45 @@ ], "properties": { "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "top_logprobs": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "temperature": { - "type": "number", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" + }, + { + "type": "null" } ], - "nullable": true, "default": 1 }, "top_p": { - "type": "number", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" + }, + { + "type": "null" } ], - "nullable": true, "default": 1 }, "user": { @@ -44697,7 +50630,8 @@ }, "safety_identifier": { "type": "string", - "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." + "maxLength": 64, + "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." }, "prompt_cache_key": { "type": "string", @@ -44707,51 +50641,62 @@ "$ref": "#/components/schemas/OpenAI.ServiceTier" }, "prompt_cache_retention": { - "type": "string", - "enum": [ - "in-memory", - "24h" - ], - "nullable": true + "anyOf": [ + { + "type": "string", + "enum": [ + "in_memory", + "24h" + ] + }, + { + "type": "null" + } + ] }, "previous_response_id": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "model": { "type": "string", "description": "The model deployment to use for the creation of this response." }, "reasoning": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Reasoning" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "background": { - "type": "boolean", - "nullable": true - }, - "max_output_tokens": { - "type": "integer", - "allOf": [ + "anyOf": [ { - "$ref": "#/components/schemas/OpenAI.integer" + "type": "boolean" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "max_tool_calls": { - "type": "integer", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "text": { "$ref": "#/components/schemas/OpenAI.ResponseTextParam" @@ -44773,12 +50718,18 @@ "$ref": "#/components/schemas/OpenAI.Prompt" }, "truncation": { - "type": "string", - "enum": [ - "auto", - "disabled" + "anyOf": [ + { + "type": "string", + "enum": [ + "auto", + "disabled" + ] + }, + { + "type": "null" + } ], - "nullable": true, "default": "disabled" }, "id": { @@ -44811,27 +50762,37 @@ "description": "Unix timestamp (in seconds) of when this Response was created." }, "completed_at": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "type": "integer", - "format": "unixtime", - "nullable": true + "format": "unixTimestamp" }, "error": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.ResponseError" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "incomplete_details": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.ResponseIncompleteDetails" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "output": { "type": "array", @@ -44850,30 +50811,59 @@ "items": { "$ref": "#/components/schemas/OpenAI.InputItem" } + }, + { + "type": "null" } - ], - "nullable": true + ] }, "output_text": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "usage": { "$ref": "#/components/schemas/OpenAI.ResponseUsage" }, + "moderation": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.Moderation" + }, + { + "type": "null" + } + ] + }, "parallel_tool_calls": { "type": "boolean", "description": "Whether to allow the model to run tool calls in parallel.", "default": true }, "conversation": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.ConversationReference" + }, + { + "type": "null" } - ], - "nullable": true + ] + }, + "max_output_tokens": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + }, + { + "type": "null" + } + ] }, "agent": { "allOf": [ @@ -44888,13 +50878,14 @@ "description": "The session identifier for this response. Currently only relevant for hosted agents.\nAlways returned for hosted agents — either the caller-provided value, the auto-derived value,\nor an auto-generated UUID. Use for session-scoped operations and to maintain sandbox\naffinity in follow-up calls." }, "agent_reference": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/AgentReference" + }, + { + "type": "null" } ], - "nullable": true, "description": "The agent used for this response" }, "content_filters": { @@ -44933,10 +50924,15 @@ }, "delta": { "type": "string", - "format": "base64", + "contentEncoding": "base64", "description": "A chunk of Base64 encoded response audio bytes." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a partial audio response.", "x-oaiMeta": { "name": "response.audio.delta", @@ -44968,6 +50964,11 @@ "description": "The sequence number of the delta." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the audio response is complete.", "x-oaiMeta": { "name": "response.audio.done", @@ -45004,6 +51005,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a partial transcript of audio.", "x-oaiMeta": { "name": "response.audio.transcript.delta", @@ -45035,6 +51041,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the full audio transcript is completed.", "x-oaiMeta": { "name": "response.audio.transcript.done", @@ -45085,6 +51096,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a partial code snippet is streamed by the code interpreter.", "x-oaiMeta": { "name": "response.code_interpreter_call_code.delta", @@ -45135,6 +51151,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the code snippet is finalized by the code interpreter.", "x-oaiMeta": { "name": "response.code_interpreter_call_code.done", @@ -45180,6 +51201,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the code interpreter call is completed.", "x-oaiMeta": { "name": "response.code_interpreter_call.completed", @@ -45225,6 +51251,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a code interpreter call is in progress.", "x-oaiMeta": { "name": "response.code_interpreter_call.in_progress", @@ -45270,6 +51301,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the code interpreter is actively interpreting the code snippet.", "x-oaiMeta": { "name": "response.code_interpreter_call.interpreting", @@ -45310,6 +51346,11 @@ "description": "The sequence number for this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the model response is complete.", "x-oaiMeta": { "name": "response.completed", @@ -45373,6 +51414,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a new content part is added.", "x-oaiMeta": { "name": "response.content_part.added", @@ -45436,6 +51482,11 @@ "description": "The content part that is done." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a content part is done.", "x-oaiMeta": { "name": "response.content_part.done", @@ -45476,6 +51527,11 @@ "description": "The sequence number for this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "An event that is emitted when a response is created.", "x-oaiMeta": { "name": "response.created", @@ -45526,6 +51582,11 @@ "description": "The incremental input data (delta) for the custom tool call." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Event representing a delta (partial update) to the input of a custom tool call.", "title": "ResponseCustomToolCallInputDelta", "x-oaiMeta": { @@ -45577,6 +51638,11 @@ "description": "The complete input data for the custom tool call." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Event indicating that input for a custom tool call is complete.", "title": "ResponseCustomToolCallInputDone", "x-oaiMeta": { @@ -45645,16 +51711,28 @@ "x-stainless-const": true }, "code": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "message": { "type": "string", "description": "The error message." }, "param": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "sequence_number": { "allOf": [ @@ -45665,6 +51743,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an error occurs.", "x-oaiMeta": { "name": "error", @@ -45705,6 +51788,11 @@ "description": "The response that failed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "An event that is emitted when a response fails.", "x-oaiMeta": { "name": "response.failed", @@ -45750,6 +51838,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a file search call is completed (results found).", "x-oaiMeta": { "name": "response.file_search_call.completed", @@ -45795,6 +51888,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a file search call is initiated.", "x-oaiMeta": { "name": "response.file_search_call.in_progress", @@ -45840,6 +51938,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a file search is currently searching.", "x-oaiMeta": { "name": "response.file_search_call.searching", @@ -45914,14 +52017,20 @@ "$ref": "#/components/schemas/OpenAI.ResponseFormatJsonSchemaSchema" }, "strict": { - "type": "boolean", - "nullable": true + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] } } }, "OpenAI.ResponseFormatJsonSchemaSchema": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/).", "title": "JSON schema" }, @@ -45986,6 +52095,11 @@ "description": "The function-call arguments delta that is added." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a partial function-call arguments delta.", "x-oaiMeta": { "name": "response.function_call_arguments.delta", @@ -46040,6 +52154,11 @@ "description": "The function-call arguments." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when function-call arguments are finalized.", "x-oaiMeta": { "name": "response.function_call_arguments.done", @@ -46085,6 +52204,11 @@ "description": "The unique identifier of the image generation item being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an image generation tool call has completed and the final image is available.", "title": "ResponseImageGenCallCompletedEvent", "x-oaiMeta": { @@ -46131,6 +52255,11 @@ "description": "The sequence number of the image generation item being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an image generation tool call is actively generating an image (intermediate state).", "title": "ResponseImageGenCallGeneratingEvent", "x-oaiMeta": { @@ -46177,6 +52306,11 @@ "description": "The sequence number of the image generation item being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an image generation tool call is in progress.", "title": "ResponseImageGenCallInProgressEvent", "x-oaiMeta": { @@ -46237,6 +52371,11 @@ "description": "Base64-encoded partial image data, suitable for rendering as an image." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a partial image is available during image generation streaming.", "title": "ResponseImageGenCallPartialImageEvent", "x-oaiMeta": { @@ -46278,6 +52417,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the response is in progress.", "x-oaiMeta": { "name": "response.in_progress", @@ -46330,6 +52474,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "An event that is emitted when a response finishes as incomplete.", "x-oaiMeta": { "name": "response.incomplete", @@ -46361,7 +52510,7 @@ "items": { "$ref": "#/components/schemas/OpenAI.ResponseLogProbTopLogprobs" }, - "description": "The log probability of the top 20 most likely tokens." + "description": "The log probabilities of up to 20 of the most likely tokens." } }, "description": "A logprob is the logarithmic probability that the model assigns to producing\na particular token at a given position in the sequence. Less-negative (higher)\nlogprob values indicate greater model confidence in that token choice." @@ -46420,6 +52569,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a delta (partial update) to the arguments of an MCP tool call.", "title": "ResponseMCPCallArgumentsDeltaEvent", "x-oaiMeta": { @@ -46471,6 +52625,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the arguments for an MCP tool call are finalized.", "title": "ResponseMCPCallArgumentsDoneEvent", "x-oaiMeta": { @@ -46517,6 +52676,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an MCP tool call has completed successfully.", "title": "ResponseMCPCallCompletedEvent", "x-oaiMeta": { @@ -46563,6 +52727,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an MCP tool call has failed.", "title": "ResponseMCPCallFailedEvent", "x-oaiMeta": { @@ -46609,6 +52778,11 @@ "description": "The unique identifier of the MCP tool call item being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an MCP tool call is in progress.", "title": "ResponseMCPCallInProgressEvent", "x-oaiMeta": { @@ -46655,6 +52829,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the list of available MCP tools has been successfully retrieved.", "title": "ResponseMCPListToolsCompletedEvent", "x-oaiMeta": { @@ -46701,6 +52880,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the attempt to list available MCP tools has failed.", "title": "ResponseMCPListToolsFailedEvent", "x-oaiMeta": { @@ -46747,6 +52931,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the system is in the process of retrieving the list of available MCP tools.", "title": "ResponseMCPListToolsInProgressEvent", "x-oaiMeta": { @@ -46797,6 +52986,11 @@ "description": "The output item that was added." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a new output item is added.", "x-oaiMeta": { "name": "response.output_item.added", @@ -46846,6 +53040,11 @@ "description": "The output item that was marked done." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an output item is marked done.", "x-oaiMeta": { "name": "response.output_item.done", @@ -46918,6 +53117,11 @@ "description": "The annotation object being added. (See annotation schema for details.)" } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an annotation is added to output text content.", "title": "ResponseOutputTextAnnotationAddedEvent", "x-oaiMeta": { @@ -46928,7 +53132,7 @@ }, "OpenAI.ResponsePromptVariables": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "anyOf": [ { "type": "string" @@ -46982,6 +53186,11 @@ "description": "The sequence number for this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a response is queued and waiting to be processed.", "title": "ResponseQueuedEvent", "x-oaiMeta": { @@ -47046,6 +53255,11 @@ "description": "The summary part that was added." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a new reasoning summary part is added.", "x-oaiMeta": { "name": "response.reasoning_summary_part.added", @@ -47128,6 +53342,11 @@ "description": "The completed summary part." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a reasoning summary part is completed.", "x-oaiMeta": { "name": "response.reasoning_summary_part.done", @@ -47206,6 +53425,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a delta is added to a reasoning summary text.", "x-oaiMeta": { "name": "response.reasoning_summary_text.delta", @@ -47265,6 +53489,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a reasoning summary text is completed.", "x-oaiMeta": { "name": "response.reasoning_summary_text.done", @@ -47324,6 +53553,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a delta is added to a reasoning text.", "x-oaiMeta": { "name": "response.reasoning_text.delta", @@ -47383,6 +53617,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a reasoning text is completed.", "x-oaiMeta": { "name": "response.reasoning_text.done", @@ -47442,6 +53681,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a partial refusal text.", "x-oaiMeta": { "name": "response.refusal.delta", @@ -47501,6 +53745,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when refusal text is finalized.", "x-oaiMeta": { "name": "response.refusal.done", @@ -47508,6 +53757,140 @@ "example": "{\n \"type\": \"response.refusal.done\",\n \"item_id\": \"item-abc\",\n \"output_index\": 1,\n \"content_index\": 2,\n \"refusal\": \"final refusal text\",\n \"sequence_number\": 1\n}\n" } }, + "OpenAI.ResponseStreamEvent": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEventType" + } + }, + "discriminator": { + "propertyName": "type", + "mapping": { + "response.audio.transcript.delta": "#/components/schemas/OpenAI.ResponseAudioTranscriptDeltaEvent", + "response.code_interpreter_call_code.delta": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent", + "response.code_interpreter_call.in_progress": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallInProgressEvent", + "response.code_interpreter_call.interpreting": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallInterpretingEvent", + "response.content_part.added": "#/components/schemas/OpenAI.ResponseContentPartAddedEvent", + "response.created": "#/components/schemas/OpenAI.ResponseCreatedEvent", + "error": "#/components/schemas/OpenAI.ResponseErrorEvent", + "response.file_search_call.in_progress": "#/components/schemas/OpenAI.ResponseFileSearchCallInProgressEvent", + "response.file_search_call.searching": "#/components/schemas/OpenAI.ResponseFileSearchCallSearchingEvent", + "response.function_call_arguments.delta": "#/components/schemas/OpenAI.ResponseFunctionCallArgumentsDeltaEvent", + "response.in_progress": "#/components/schemas/OpenAI.ResponseInProgressEvent", + "response.failed": "#/components/schemas/OpenAI.ResponseFailedEvent", + "response.incomplete": "#/components/schemas/OpenAI.ResponseIncompleteEvent", + "response.output_item.added": "#/components/schemas/OpenAI.ResponseOutputItemAddedEvent", + "response.reasoning_summary_part.added": "#/components/schemas/OpenAI.ResponseReasoningSummaryPartAddedEvent", + "response.reasoning_summary_text.delta": "#/components/schemas/OpenAI.ResponseReasoningSummaryTextDeltaEvent", + "response.reasoning_text.delta": "#/components/schemas/OpenAI.ResponseReasoningTextDeltaEvent", + "response.refusal.delta": "#/components/schemas/OpenAI.ResponseRefusalDeltaEvent", + "response.output_text.delta": "#/components/schemas/OpenAI.ResponseTextDeltaEvent", + "response.web_search_call.in_progress": "#/components/schemas/OpenAI.ResponseWebSearchCallInProgressEvent", + "response.web_search_call.searching": "#/components/schemas/OpenAI.ResponseWebSearchCallSearchingEvent", + "response.image_generation_call.generating": "#/components/schemas/OpenAI.ResponseImageGenCallGeneratingEvent", + "response.image_generation_call.in_progress": "#/components/schemas/OpenAI.ResponseImageGenCallInProgressEvent", + "response.image_generation_call.partial_image": "#/components/schemas/OpenAI.ResponseImageGenCallPartialImageEvent", + "response.mcp_call_arguments.delta": "#/components/schemas/OpenAI.ResponseMCPCallArgumentsDeltaEvent", + "response.mcp_call.failed": "#/components/schemas/OpenAI.ResponseMCPCallFailedEvent", + "response.mcp_call.in_progress": "#/components/schemas/OpenAI.ResponseMCPCallInProgressEvent", + "response.mcp_list_tools.failed": "#/components/schemas/OpenAI.ResponseMCPListToolsFailedEvent", + "response.mcp_list_tools.in_progress": "#/components/schemas/OpenAI.ResponseMCPListToolsInProgressEvent", + "response.output_text.annotation.added": "#/components/schemas/OpenAI.ResponseOutputTextAnnotationAddedEvent", + "response.queued": "#/components/schemas/OpenAI.ResponseQueuedEvent", + "response.custom_tool_call_input.delta": "#/components/schemas/OpenAI.ResponseCustomToolCallInputDeltaEvent", + "response.audio.done": "#/components/schemas/OpenAI.ResponseAudioDoneEvent", + "response.audio.transcript.done": "#/components/schemas/OpenAI.ResponseAudioTranscriptDoneEvent", + "response.code_interpreter_call_code.done": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallCodeDoneEvent", + "response.code_interpreter_call.completed": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallCompletedEvent", + "response.completed": "#/components/schemas/OpenAI.ResponseCompletedEvent", + "response.content_part.done": "#/components/schemas/OpenAI.ResponseContentPartDoneEvent", + "response.file_search_call.completed": "#/components/schemas/OpenAI.ResponseFileSearchCallCompletedEvent", + "response.function_call_arguments.done": "#/components/schemas/OpenAI.ResponseFunctionCallArgumentsDoneEvent", + "response.output_item.done": "#/components/schemas/OpenAI.ResponseOutputItemDoneEvent", + "response.reasoning_summary_part.done": "#/components/schemas/OpenAI.ResponseReasoningSummaryPartDoneEvent", + "response.reasoning_summary_text.done": "#/components/schemas/OpenAI.ResponseReasoningSummaryTextDoneEvent", + "response.reasoning_text.done": "#/components/schemas/OpenAI.ResponseReasoningTextDoneEvent", + "response.refusal.done": "#/components/schemas/OpenAI.ResponseRefusalDoneEvent", + "response.output_text.done": "#/components/schemas/OpenAI.ResponseTextDoneEvent", + "response.web_search_call.completed": "#/components/schemas/OpenAI.ResponseWebSearchCallCompletedEvent", + "response.image_generation_call.completed": "#/components/schemas/OpenAI.ResponseImageGenCallCompletedEvent", + "response.mcp_call_arguments.done": "#/components/schemas/OpenAI.ResponseMCPCallArgumentsDoneEvent", + "response.mcp_call.completed": "#/components/schemas/OpenAI.ResponseMCPCallCompletedEvent", + "response.mcp_list_tools.completed": "#/components/schemas/OpenAI.ResponseMCPListToolsCompletedEvent", + "response.custom_tool_call_input.done": "#/components/schemas/OpenAI.ResponseCustomToolCallInputDoneEvent", + "response.audio.delta": "#/components/schemas/OpenAI.ResponseAudioDeltaEvent" + } + } + }, + "OpenAI.ResponseStreamEventType": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "response.audio.delta", + "response.audio.done", + "response.audio.transcript.delta", + "response.audio.transcript.done", + "response.code_interpreter_call_code.delta", + "response.code_interpreter_call_code.done", + "response.code_interpreter_call.completed", + "response.code_interpreter_call.in_progress", + "response.code_interpreter_call.interpreting", + "response.completed", + "response.content_part.added", + "response.content_part.done", + "response.created", + "error", + "response.file_search_call.completed", + "response.file_search_call.in_progress", + "response.file_search_call.searching", + "response.function_call_arguments.delta", + "response.function_call_arguments.done", + "response.in_progress", + "response.failed", + "response.incomplete", + "response.output_item.added", + "response.output_item.done", + "response.reasoning_summary_part.added", + "response.reasoning_summary_part.done", + "response.reasoning_summary_text.delta", + "response.reasoning_summary_text.done", + "response.reasoning_text.delta", + "response.reasoning_text.done", + "response.refusal.delta", + "response.refusal.done", + "response.output_text.delta", + "response.output_text.done", + "response.web_search_call.completed", + "response.web_search_call.in_progress", + "response.web_search_call.searching", + "response.image_generation_call.completed", + "response.image_generation_call.generating", + "response.image_generation_call.in_progress", + "response.image_generation_call.partial_image", + "response.mcp_call_arguments.delta", + "response.mcp_call_arguments.done", + "response.mcp_call.completed", + "response.mcp_call.failed", + "response.mcp_call.in_progress", + "response.mcp_list_tools.completed", + "response.mcp_list_tools.failed", + "response.mcp_list_tools.in_progress", + "response.output_text.annotation.added", + "response.queued", + "response.custom_tool_call_input.delta", + "response.custom_tool_call_input.done" + ] + } + ] + }, "OpenAI.ResponseStreamOptions": { "type": "object", "properties": { @@ -47578,6 +53961,11 @@ "description": "The log probabilities of the tokens in the delta." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is an additional text delta.", "x-oaiMeta": { "name": "response.output_text.delta", @@ -47645,6 +54033,11 @@ "description": "The log probabilities of the tokens in the delta." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when text content is finalized.", "x-oaiMeta": { "name": "response.output_text.done", @@ -47777,6 +54170,11 @@ "description": "The sequence number of the web search call being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a web search call is completed.", "x-oaiMeta": { "name": "response.web_search_call.completed", @@ -47822,6 +54220,11 @@ "description": "The sequence number of the web search call being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a web search call is initiated.", "x-oaiMeta": { "name": "response.web_search_call.in_progress", @@ -47867,6 +54270,11 @@ "description": "The sequence number of the web search call being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a web search call is executing.", "x-oaiMeta": { "name": "response.web_search_call.searching", @@ -47886,8 +54294,7 @@ "screenshot" ], "description": "Specifies the event type. For a screenshot action, this property is always set to `screenshot`.", - "x-stainless-const": true, - "default": "screenshot" + "x-stainless-const": true } }, "allOf": [ @@ -47914,8 +54321,7 @@ "scroll" ], "description": "Specifies the event type. For a scroll action, this property is always set to `scroll`.", - "x-stainless-const": true, - "default": "scroll" + "x-stainless-const": true }, "x": { "allOf": [ @@ -47948,6 +54354,19 @@ } ], "description": "The vertical scroll distance." + }, + "keys": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -47958,6 +54377,13 @@ "description": "A scroll action.", "title": "Scroll" }, + "OpenAI.SearchContentType": { + "type": "string", + "enum": [ + "text", + "image" + ] + }, "OpenAI.SearchContextSize": { "type": "string", "enum": [ @@ -47967,16 +54393,31 @@ ] }, "OpenAI.ServiceTier": { + "anyOf": [ + { + "type": "string", + "enum": [ + "auto", + "default", + "flex", + "scale", + "priority" + ] + }, + { + "type": "null" + } + ], + "description": "Specifies the processing type used for serving the request.\n- If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.\n- If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.\n- If set to '[flex](/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier.\n- When not set, the default behavior is 'auto'.\nWhen the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter." + }, + "OpenAI.ServiceTierEnum": { "type": "string", "enum": [ "auto", "default", "flex", - "scale", "priority" - ], - "description": "Specifies the processing type used for serving the request.\n- If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.\n- If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.\n- If set to '[flex](/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier.\n- When not set, the default behavior is 'auto'.\nWhen the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.", - "nullable": true + ] }, "OpenAI.SkillReferenceParam": { "type": "object", @@ -47991,8 +54432,7 @@ "skill_reference" ], "description": "References a skill created with the /v1/skills endpoint.", - "x-stainless-const": true, - "default": "skill_reference" + "x-stainless-const": true }, "skill_id": { "type": "string", @@ -48023,8 +54463,7 @@ "apply_patch" ], "description": "The tool to call. Always `apply_patch`.", - "x-stainless-const": true, - "default": "apply_patch" + "x-stainless-const": true } }, "allOf": [ @@ -48047,8 +54486,7 @@ "shell" ], "description": "The tool to call. Always `shell`.", - "x-stainless-const": true, - "default": "shell" + "x-stainless-const": true } }, "allOf": [ @@ -48072,8 +54510,7 @@ "summary_text" ], "description": "The type of the object. Always `summary_text`.", - "x-stainless-const": true, - "default": "summary_text" + "x-stainless-const": true }, "text": { "type": "string", @@ -48100,8 +54537,7 @@ "enum": [ "text" ], - "x-stainless-const": true, - "default": "text" + "x-stainless-const": true }, "text": { "type": "string" @@ -48224,8 +54660,14 @@ "$ref": "#/components/schemas/OpenAI.ResponseFormatJsonSchemaSchema" }, "strict": { - "type": "boolean", - "nullable": true + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -48274,7 +54716,10 @@ "shell": "#/components/schemas/OpenAI.FunctionShellToolParam", "custom": "#/components/schemas/OpenAI.CustomToolParam", "web_search_preview": "#/components/schemas/OpenAI.WebSearchPreviewTool", - "apply_patch": "#/components/schemas/OpenAI.ApplyPatchToolParam" + "apply_patch": "#/components/schemas/OpenAI.ApplyPatchToolParam", + "computer": "#/components/schemas/OpenAI.ComputerTool", + "namespace": "#/components/schemas/OpenAI.NamespaceToolParam", + "tool_search": "#/components/schemas/OpenAI.ToolSearchToolParam" } }, "description": "A tool that can be used to generate a response." @@ -48307,7 +54752,7 @@ "type": "array", "items": { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, "description": "A list of tool definitions that the model should be allowed to call.\n For the Responses API, the list of tool definitions might look like:\n ```json\n [\n { \"type\": \"function\", \"name\": \"get_weather\" },\n { \"type\": \"mcp\", \"server_label\": \"deepwiki\" },\n { \"type\": \"image_generation\" }\n ]\n ```" } @@ -48340,6 +54785,46 @@ ], "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." }, + "OpenAI.ToolChoiceComputer": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "computer" + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolChoiceParam" + } + ], + "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." + }, + "OpenAI.ToolChoiceComputerUse": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "computer_use" + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolChoiceParam" + } + ], + "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." + }, "OpenAI.ToolChoiceComputerUsePreview": { "type": "object", "required": [ @@ -48476,8 +54961,14 @@ "description": "The label of the MCP server to use." }, "name": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "allOf": [ @@ -48522,7 +55013,9 @@ "computer_use_preview": "#/components/schemas/OpenAI.ToolChoiceComputerUsePreview", "web_search_preview_2025_03_11": "#/components/schemas/OpenAI.ToolChoiceWebSearchPreview20250311", "image_generation": "#/components/schemas/OpenAI.ToolChoiceImageGeneration", - "code_interpreter": "#/components/schemas/OpenAI.ToolChoiceCodeInterpreter" + "code_interpreter": "#/components/schemas/OpenAI.ToolChoiceCodeInterpreter", + "computer": "#/components/schemas/OpenAI.ToolChoiceComputer", + "computer_use": "#/components/schemas/OpenAI.ToolChoiceComputerUse" } }, "description": "How the model should select which tool (or tools) to use when generating\na response. See the `tools` parameter to see how to specify which tools\nthe model can call." @@ -48546,7 +55039,9 @@ "computer_use_preview", "web_search_preview_2025_03_11", "image_generation", - "code_interpreter" + "code_interpreter", + "computer", + "computer_use" ] } ] @@ -48591,6 +55086,64 @@ ], "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." }, + "OpenAI.ToolSearchExecutionType": { + "type": "string", + "enum": [ + "server", + "client" + ] + }, + "OpenAI.ToolSearchToolParam": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search" + ], + "description": "The type of the tool. Always `tool_search`.", + "x-stainless-const": true + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search is executed by the server or by the client." + }, + "description": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "parameters": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.EmptyModelParam" + }, + { + "type": "null" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Tool" + } + ], + "description": "Hosted or BYOT tool search configuration for deferred tools.", + "title": "Tool search tool" + }, "OpenAI.ToolType": { "anyOf": [ { @@ -48601,6 +55154,7 @@ "enum": [ "function", "file_search", + "computer", "computer_use_preview", "web_search", "mcp", @@ -48609,6 +55163,8 @@ "local_shell", "shell", "custom", + "namespace", + "tool_search", "web_search_preview", "apply_patch", "a2a_preview", @@ -48673,8 +55229,7 @@ "type" ], "description": "Specifies the event type. For a type action, this property is always set to `type`.", - "x-stainless-const": true, - "default": "type" + "x-stainless-const": true }, "text": { "type": "string", @@ -48696,13 +55251,14 @@ ], "properties": { "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } ], - "nullable": true, "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.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters." } } @@ -48723,8 +55279,7 @@ "url_citation" ], "description": "The type of the URL citation. Always `url_citation`.", - "x-stainless-const": true, - "default": "url_citation" + "x-stainless-const": true }, "url": { "type": "string", @@ -48762,7 +55317,7 @@ }, "OpenAI.VectorStoreFileAttributes": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "anyOf": [ { "type": "string" @@ -48779,14 +55334,20 @@ "x-oaiTypeLabel": "map" }, "OpenAI.Verbosity": { - "type": "string", - "enum": [ - "low", - "medium", - "high" + "anyOf": [ + { + "type": "string", + "enum": [ + "low", + "medium", + "high" + ] + }, + { + "type": "null" + } ], - "description": "Constrains the verbosity of the model's response. Lower values will result in\nmore concise responses, while higher values will result in more verbose responses.\nCurrently supported values are `low`, `medium`, and `high`.", - "nullable": true + "description": "Constrains the verbosity of the model's response. Lower values will result in\nmore concise responses, while higher values will result in more verbose responses.\nCurrently supported values are `low`, `medium`, and `high`." }, "OpenAI.WaitParam": { "type": "object", @@ -48800,8 +55361,7 @@ "wait" ], "description": "Specifies the event type. For a wait action, this property is always set to `wait`.", - "x-stainless-const": true, - "default": "wait" + "x-stainless-const": true } }, "allOf": [ @@ -48856,9 +55416,15 @@ "x-stainless-const": true }, "url": { - "type": "string", - "format": "uri", - "nullable": true, + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ], "description": "The URL opened by the model." } }, @@ -48868,8 +55434,7 @@ "OpenAI.WebSearchActionSearch": { "type": "object", "required": [ - "type", - "query" + "type" ], "properties": { "type": { @@ -48882,7 +55447,7 @@ }, "query": { "type": "string", - "description": "[DEPRECATED] The search query.", + "description": "The search query.", "deprecated": true }, "queries": { @@ -48920,7 +55485,8 @@ "x-stainless-const": true }, "url": { - "type": "string" + "type": "string", + "format": "uri" } } }, @@ -48940,20 +55506,44 @@ "default": "approximate" }, "country": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "region": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "city": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, "timezone": { - "type": "string", - "nullable": true + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] } }, "description": "The approximate location of the user.", @@ -48971,17 +55561,17 @@ "web_search_preview" ], "description": "The type of the web search tool. One of `web_search_preview` or `web_search_preview_2025_03_11`.", - "x-stainless-const": true, - "default": "web_search_preview" + "x-stainless-const": true }, "user_location": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.ApproximateLocation" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "search_context_size": { "allOf": [ @@ -48990,6 +55580,12 @@ } ], "description": "High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default." + }, + "search_content_types": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.SearchContentType" + } } }, "allOf": [ @@ -49011,26 +55607,27 @@ "enum": [ "web_search" ], - "description": "The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.", - "default": "web_search" + "description": "The type of the web search tool. One of `web_search` or `web_search_2025_08_26`." }, "filters": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.WebSearchToolFilters" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "user_location": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.WebSearchApproximateLocation" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "search_context_size": { "type": "string", @@ -49071,11 +55668,17 @@ "type": "object", "properties": { "allowed_domains": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] } } }, @@ -49167,7 +55770,7 @@ }, "spec": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The openapi function shape, described as a JSON Schema object." }, "auth": { @@ -49200,7 +55803,7 @@ }, "parameters": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The parameters the functions accepts, described as a JSON Schema object." } }, @@ -49433,8 +56036,7 @@ "type": "string", "enum": [ "openapi" - ], - "description": "The object type, which is always 'openapi'." + ] }, "openapi": { "allOf": [ @@ -49452,58 +56054,32 @@ ], "description": "An OpenAPI tool stored in a toolbox." }, - "OptimizationAgentDefinition": { + "OptimizationAgentIdentifier": { "type": "object", + "required": [ + "agent_name" + ], "properties": { - "agentName": { - "type": "string", - "description": "Agent name." - }, - "agentVersion": { - "type": "string", - "description": "Agent version." - }, - "model": { + "agent_name": { "type": "string", - "description": "Model deployment name." + "description": "Registered Foundry agent name (required)." }, - "systemPrompt": { + "agent_version": { "type": "string", - "description": "System prompt / instructions." - }, - "skills": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": {} - }, - "description": "Agent skills." - }, - "tools": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": {} - }, - "description": "Agent tools." + "description": "Pinned agent version. Defaults to latest if omitted." } }, - "description": "Agent definition returned in response payloads (includes resolved config)." + "description": "Identifies the registered Foundry agent to optimize (request-only). Skills, tools, and system_prompt are specified in options.optimization_config." }, "OptimizationCandidate": { "type": "object", "required": [ "name", - "config", - "mutations", - "avgScore", - "avgTokens", - "passRate", - "taskScores", - "isParetoOptimal" + "avg_score", + "avg_tokens" ], "properties": { - "candidateId": { + "candidate_id": { "type": "string", "description": "Server-assigned candidate identifier. Use with GET /candidates/{id} sub-endpoints." }, @@ -49511,50 +56087,26 @@ "type": "string", "description": "Display name of the candidate (e.g., 'baseline', 'instruction-v2')." }, - "config": { - "allOf": [ - { - "$ref": "#/components/schemas/OptimizationAgentDefinition" - } - ], - "description": "The agent configuration that produced this candidate." - }, "mutations": { "type": "object", - "additionalProperties": {}, - "description": "What was mutated from the baseline (e.g., {systemPrompt: 'new prompt'})." + "unevaluatedProperties": {}, + "description": "What was mutated from the baseline (e.g., {system_prompt: 'new prompt'})." }, - "avgScore": { + "avg_score": { "type": "number", "format": "double", "description": "Average composite score across all tasks." }, - "avgTokens": { + "avg_tokens": { "type": "number", "format": "double", "description": "Average token usage across all tasks." }, - "passRate": { - "type": "number", - "format": "double", - "description": "Fraction of tasks that met the pass threshold." - }, - "taskScores": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OptimizationTaskResult" - }, - "description": "Individual task-level scores." - }, - "isParetoOptimal": { - "type": "boolean", - "description": "Whether this candidate is on the Pareto frontier (score vs cost)." - }, - "evalId": { + "eval_id": { "type": "string", "description": "Foundry evaluation identifier used to score this candidate." }, - "evalRunId": { + "eval_run_id": { "type": "string", "description": "Foundry evaluation run identifier for this candidate's scoring run." }, @@ -49569,12 +56121,144 @@ }, "description": "Aggregated evaluation result for a single candidate agent configuration across all tasks." }, + "OptimizationDatasetCriterion": { + "type": "object", + "required": [ + "name", + "instruction" + ], + "properties": { + "name": { + "type": "string", + "description": "Criterion name." + }, + "instruction": { + "type": "string", + "description": "Criterion instruction / description." + } + }, + "description": "Evaluation criterion: a name + instruction pair used for per-item scoring." + }, + "OptimizationDatasetInput": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "allOf": [ + { + "$ref": "#/components/schemas/OptimizationDatasetInputType" + } + ], + "description": "Dataset input type discriminator." + } + }, + "discriminator": { + "propertyName": "type", + "mapping": { + "inline": "#/components/schemas/OptimizationInlineDatasetInput", + "reference": "#/components/schemas/OptimizationReferenceDatasetInput" + } + }, + "description": "Base discriminated model for dataset input. Either inline items or a registered reference." + }, + "OptimizationDatasetInputType": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "inline", + "reference" + ] + } + ], + "description": "Discriminator values for the dataset input union." + }, + "OptimizationDatasetItem": { + "type": "object", + "properties": { + "query": { + "type": "string", + "description": "The user query / prompt." + }, + "ground_truth": { + "type": "string", + "description": "Expected ground truth answer." + }, + "desired_num_turns": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 20, + "description": "Desired number of conversation turns for simulation mode (1-20)." + }, + "criteria": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OptimizationDatasetCriterion" + }, + "description": "Per-item evaluation criteria." + } + }, + "description": "A single item in an inline dataset." + }, + "OptimizationEvaluatorRef": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "Evaluator name." + }, + "version": { + "type": "string", + "description": "Evaluator version. If not specified, the latest version is used." + } + }, + "description": "Reference to a named evaluator, optionally pinned to a version." + }, + "OptimizationInlineDatasetInput": { + "type": "object", + "required": [ + "type", + "items" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "inline" + ], + "description": "Dataset input type discriminator." + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OptimizationDatasetItem" + }, + "description": "Dataset items." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OptimizationDatasetInput" + } + ], + "description": "Inline dataset — items supplied directly in the request body." + }, "OptimizationJob": { "type": "object", "required": [ "id", "status", - "createdAt" + "created_at", + "updated_at" ], "properties": { "id": { @@ -49582,42 +56266,42 @@ "description": "Server-assigned unique identifier.", "readOnly": true }, - "status": { + "inputs": { "allOf": [ { - "$ref": "#/components/schemas/JobStatus" + "$ref": "#/components/schemas/OptimizationJobInputs" } ], - "description": "Current lifecycle status.", - "readOnly": true + "description": "Caller-supplied inputs." }, - "error": { + "result": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.Error" + "$ref": "#/components/schemas/OptimizationJobResult" } ], - "description": "Error details — populated only on failure.", + "description": "Result produced on success.", "readOnly": true }, - "result": { + "status": { "allOf": [ { - "$ref": "#/components/schemas/OptimizationJobResult" + "$ref": "#/components/schemas/JobStatus" } ], - "description": "Result produced on success.", + "description": "Current lifecycle status.", "readOnly": true }, - "inputs": { + "error": { "allOf": [ { - "$ref": "#/components/schemas/OptimizationJobInputs" + "$ref": "#/components/schemas/OpenAI.Error" } ], - "description": "Caller-supplied inputs." + "description": "Error details — populated only on failure.", + "readOnly": true }, - "createdAt": { + "created_at": { "allOf": [ { "$ref": "#/components/schemas/FoundryTimestamp" @@ -49626,7 +56310,7 @@ "description": "The timestamp when the job was created, represented in Unix time.", "readOnly": true }, - "updatedAt": { + "updated_at": { "allOf": [ { "$ref": "#/components/schemas/FoundryTimestamp" @@ -49641,16 +56325,15 @@ "$ref": "#/components/schemas/OptimizationJobProgress" } ], - "description": "Progress while in flight. Absent in terminal states.", + "description": "Progress snapshot. May be present in terminal states reflecting last-known progress.", "readOnly": true }, - "dataset": { - "allOf": [ - { - "$ref": "#/components/schemas/DatasetInfo" - } - ], - "description": "Metadata about the dataset used for this optimization job.", + "warnings": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Non-fatal warnings emitted at any point during optimization.", "readOnly": true } }, @@ -49660,29 +56343,30 @@ "type": "object", "required": [ "agent", - "trainDatasetReference" + "train_dataset", + "evaluators" ], "properties": { "agent": { "allOf": [ { - "$ref": "#/components/schemas/AgentIdentifier" + "$ref": "#/components/schemas/OptimizationAgentIdentifier" } ], "description": "The agent (and pinned version) being optimized." }, - "trainDatasetReference": { + "train_dataset": { "allOf": [ { - "$ref": "#/components/schemas/DatasetRef" + "$ref": "#/components/schemas/OptimizationDatasetInput" } ], - "description": "Reference to a registered training dataset (required)." + "description": "Training dataset — either inline items or a reference to a registered dataset. Required." }, - "validationDatasetReference": { + "validation_dataset": { "allOf": [ { - "$ref": "#/components/schemas/DatasetRef" + "$ref": "#/components/schemas/OptimizationDatasetInput" } ], "description": "Optional held-out validation dataset for measuring generalization of the final candidate." @@ -49690,9 +56374,9 @@ "evaluators": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/OptimizationEvaluatorRef" }, - "description": "Job-level evaluators (referenced by name). Per-task criteria may override. Default: ['task_adherence']." + "description": "Job-level evaluators referenced by name and optional version. Required; at least one must be provided." }, "options": { "allOf": [ @@ -49705,25 +56389,96 @@ }, "description": "Caller-supplied inputs for an optimization job." }, + "OptimizationJobListItem": { + "type": "object", + "required": [ + "id", + "status", + "created_at", + "updated_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Server-assigned unique identifier.", + "readOnly": true + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/JobStatus" + } + ], + "description": "Current lifecycle status.", + "readOnly": true + }, + "error": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Error" + } + ], + "description": "Error details — populated only on failure.", + "readOnly": true + }, + "created_at": { + "allOf": [ + { + "$ref": "#/components/schemas/FoundryTimestamp" + } + ], + "description": "The timestamp when the job was created, represented in Unix time.", + "readOnly": true + }, + "updated_at": { + "allOf": [ + { + "$ref": "#/components/schemas/FoundryTimestamp" + } + ], + "description": "The timestamp when the job was last updated, represented in Unix time.", + "readOnly": true + }, + "progress": { + "allOf": [ + { + "$ref": "#/components/schemas/OptimizationJobProgress" + } + ], + "description": "Progress snapshot. May be present in terminal states reflecting last-known progress.", + "readOnly": true + }, + "agent": { + "allOf": [ + { + "$ref": "#/components/schemas/OptimizationAgentIdentifier" + } + ], + "description": "The agent targeted by this optimization job.", + "readOnly": true + } + }, + "description": "Slim job representation returned by the LIST endpoint." + }, "OptimizationJobProgress": { "type": "object", "required": [ - "currentIteration", - "bestScore", - "elapsedSeconds" + "candidates_completed", + "best_score", + "elapsed_seconds" ], "properties": { - "currentIteration": { + "candidates_completed": { "type": "integer", "format": "int32", - "description": "1-based current iteration index." + "description": "Number of candidates whose evaluation has completed so far." }, - "bestScore": { + "best_score": { "type": "number", "format": "double", "description": "Best score observed so far across all candidates." }, - "elapsedSeconds": { + "elapsed_seconds": { "type": "number", "format": "double", "description": "Wall-clock time elapsed in seconds since the job began executing." @@ -49735,20 +56490,12 @@ "type": "object", "properties": { "baseline": { - "allOf": [ - { - "$ref": "#/components/schemas/OptimizationCandidate" - } - ], - "description": "Evaluation scores for the original (un-optimized) agent configuration." + "type": "string", + "description": "Candidate ID of the original (un-optimized) baseline evaluation." }, "best": { - "allOf": [ - { - "$ref": "#/components/schemas/OptimizationCandidate" - } - ], - "description": "The highest-scoring candidate found during optimization." + "type": "string", + "description": "Candidate ID of the highest-scoring candidate found during optimization." }, "candidates": { "type": "array", @@ -49756,25 +56503,6 @@ "$ref": "#/components/schemas/OptimizationCandidate" }, "description": "All evaluated candidates including baseline." - }, - "options": { - "allOf": [ - { - "$ref": "#/components/schemas/OptimizationOptions" - } - ], - "description": "The options used for this optimization run." - }, - "warnings": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Non-fatal warnings from the optimization run (e.g., target attribute failures that were skipped)." - }, - "allTargetAttributesFailed": { - "type": "boolean", - "description": "True when all target attributes failed — only the baseline was evaluated." } }, "description": "Terminal-state result body. Populated when status is succeeded or failed." @@ -49782,26 +56510,27 @@ "OptimizationOptions": { "type": "object", "properties": { - "maxIterations": { + "max_candidates": { "type": "integer", "format": "int32", - "description": "Maximum optimization iterations per strategy. Must be >= 1. Default: 5.", + "minimum": 1, + "description": "Maximum number of optimization candidates to generate. Must be >= 1. Default: 5.", "default": 5 }, - "optimizationConfig": { + "optimization_config": { "type": "object", - "additionalProperties": {}, - "description": "Per-target-attribute configuration overrides. Contains skills, tools, systemPrompt for the agent, plus model space for model optimization." + "unevaluatedProperties": {}, + "description": "Per-target-attribute configuration overrides. Contains skills, tools, system_prompt for the agent, plus model space for model optimization." }, - "evalModel": { + "eval_model": { "type": "string", "description": "Model deployment used for evaluation. Defaults to server config (typically 'gpt-4o')." }, - "optimizationModel": { + "optimization_model": { "type": "string", "description": "Model deployment for optimization reasoning (must be gpt-5 family). Falls back to the default eval model when not set." }, - "evaluationLevel": { + "evaluation_level": { "allOf": [ { "$ref": "#/components/schemas/EvaluationLevel" @@ -49812,73 +56541,35 @@ }, "description": "Tuning knobs and run-mode for an optimization job." }, - "OptimizationTaskResult": { + "OptimizationReferenceDatasetInput": { "type": "object", "required": [ - "taskName", - "scores", - "compositeScore", - "tokens", - "durationSeconds", - "passed" + "type", + "name" ], "properties": { - "taskName": { - "type": "string", - "description": "Task name (from the dataset)." - }, - "query": { - "type": "string", - "description": "The user query / input for the task." - }, - "scores": { - "type": "object", - "additionalProperties": { - "type": "number", - "format": "double" - }, - "description": "Per-evaluator scores keyed by evaluator name." - }, - "compositeScore": { - "type": "number", - "format": "double", - "description": "Composite score combining all evaluator scores." - }, - "tokens": { - "type": "integer", - "format": "int32", - "description": "Total tokens consumed during the agent run for this task." - }, - "durationSeconds": { - "type": "number", - "format": "double", - "description": "Wall-clock seconds for this task's agent execution." - }, - "passed": { - "type": "boolean", - "description": "Whether the task met the pass threshold." - }, - "errorMessage": { + "type": { "type": "string", - "description": "Error message if the task failed during execution." - }, - "rationales": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Per-evaluator reasoning keyed by evaluator name." + "enum": [ + "reference" + ], + "description": "Dataset input type discriminator." }, - "response": { + "name": { "type": "string", - "description": "Raw agent response text." + "description": "Registered dataset name." }, - "runId": { + "version": { "type": "string", - "description": "Identifier of the agent run that produced this result." + "description": "Dataset version. If not specified, the latest version is used." } }, - "description": "Per-task evaluation result for a single candidate." + "allOf": [ + { + "$ref": "#/components/schemas/OptimizationDatasetInput" + } + ], + "description": "Reference to a registered Foundry dataset." }, "OtlpTelemetryEndpoint": { "type": "object", @@ -49898,7 +56589,9 @@ "endpoint": { "type": "string", "description": "The OTLP collector endpoint URL.", - "example": "https://my-collector.example.com/otlp" + "examples": [ + "https://my-collector.example.com/otlp" + ] }, "protocol": { "allOf": [ @@ -49907,7 +56600,9 @@ } ], "description": "The transport protocol for the OTLP endpoint.", - "example": "Http" + "examples": [ + "Http" + ] } }, "allOf": [ @@ -50354,70 +57049,15 @@ ] } }, - "PromoteCandidateRequest": { - "type": "object", - "required": [ - "agentName", - "agentVersion" - ], - "properties": { - "agentName": { - "type": "string", - "description": "Name of the Foundry agent to promote to." - }, - "agentVersion": { - "type": "string", - "description": "Version of the Foundry agent to promote to." - } - }, - "description": "Request body for promoting a candidate to a Foundry agent version." - }, - "PromoteCandidateResponse": { - "type": "object", - "required": [ - "candidateId", - "status", - "promotedAt", - "agentName", - "agentVersion" - ], - "properties": { - "candidateId": { - "type": "string", - "description": "The promoted candidate id." - }, - "status": { - "type": "string", - "description": "Status after promotion." - }, - "promotedAt": { - "allOf": [ - { - "$ref": "#/components/schemas/FoundryTimestamp" - } - ], - "description": "Timestamp when promotion occurred, represented in Unix time." - }, - "agentName": { - "type": "string", - "description": "Name of the Foundry agent promoted to." - }, - "agentVersion": { - "type": "string", - "description": "Version of the Foundry agent promoted to." - } - }, - "description": "Response after successfully promoting a candidate." - }, "PromotionInfo": { "type": "object", "required": [ - "promotedAt", - "agentName", - "agentVersion" + "promoted_at", + "agent_name", + "agent_version" ], "properties": { - "promotedAt": { + "promoted_at": { "allOf": [ { "$ref": "#/components/schemas/FoundryTimestamp" @@ -50425,11 +57065,11 @@ ], "description": "Timestamp when promotion occurred, represented in Unix time." }, - "agentName": { + "agent_name": { "type": "string", "description": "Name of the Foundry agent this candidate was promoted to." }, - "agentVersion": { + "agent_version": { "type": "string", "description": "Version of the Foundry agent this candidate was promoted to." } @@ -50454,36 +57094,55 @@ "description": "The model deployment to use for this agent." }, "instructions": { - "type": "string", - "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "description": "A system (or developer) message inserted into the model's context." }, "temperature": { - "type": "number", - "format": "float", - "nullable": true, + "anyOf": [ + { + "type": "number", + "format": "float" + }, + { + "type": "null" + } + ], "minimum": 0, "maximum": 2, "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nWe generally recommend altering this or `top_p` but not both. Defaults to `1`.", "default": 1 }, "top_p": { - "type": "number", - "format": "float", - "nullable": true, + "anyOf": [ + { + "type": "number", + "format": "float" + }, + { + "type": "null" + } + ], "minimum": 0, "maximum": 1, "description": "An alternative to sampling with temperature, called nucleus sampling,\nwhere the model considers the results of the tokens with top_p probability\nmass. So 0.1 means only the tokens comprising the top 10% probability mass\nare considered. We generally recommend altering this or `temperature` but not both.\nDefaults to `1`.", "default": 1 }, "reasoning": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Reasoning" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "tools": { "type": "array", @@ -50513,7 +57172,7 @@ }, "structured_inputs": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/StructuredInputDefinition" }, "description": "Set of structured inputs that can participate in prompt template substitution or tool argument bindings." @@ -50807,7 +57466,7 @@ }, "simulationOnly": { "type": "boolean", - "description": "Simulation-only or Simulation + Evaluation. Default false, if true the scan outputs conversation not evaluation result.", + "description": "Simulation-only or Simulation + Evaluation. If `true` the scan outputs conversation not evaluation result. The service defaults to `false` if a value is not specified by the caller.", "default": false }, "riskCategories": { @@ -50823,14 +57482,14 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Red team's tags. Unlike properties, tags are fully mutable." }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed." @@ -51058,7 +57717,7 @@ }, "data_mapping": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Mapping from source fields to response_id field, required for retrieving chat history." @@ -51108,10 +57767,7 @@ "Routine": { "type": "object", "required": [ - "name", - "enabled", - "triggers", - "action" + "enabled" ], "properties": { "name": { @@ -51130,7 +57786,7 @@ }, "triggers": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/RoutineTrigger" }, "description": "The triggers configured for the routine." @@ -51241,10 +57897,6 @@ }, "RoutineCreateOrUpdateRequest": { "type": "object", - "required": [ - "triggers", - "action" - ], "properties": { "description": { "type": "string", @@ -51257,7 +57909,7 @@ }, "triggers": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/RoutineTrigger" }, "description": "The triggers configured for the routine. In v1, exactly one trigger entry is supported." @@ -51330,19 +57982,21 @@ "RoutineRun": { "type": "object", "required": [ - "id", - "status", - "trigger_type", - "started_at" + "id" ], "properties": { "id": { "type": "string", - "description": "The MLflow run identifier for the routine attempt." + "description": "The unique run identifier for the routine attempt.", + "readOnly": true }, "status": { - "type": "string", - "description": "The underlying MLflow run status." + "allOf": [ + { + "$ref": "#/components/schemas/RoutineRunStatus" + } + ], + "description": "The run status." }, "phase": { "allOf": [ @@ -51360,6 +58014,10 @@ ], "description": "The trigger type that produced the routine attempt." }, + "trigger_name": { + "type": "string", + "description": "The configured trigger name that produced the routine attempt." + }, "attempt_source": { "allOf": [ { @@ -51376,6 +58034,22 @@ ], "description": "The action type dispatched for the routine attempt." }, + "agent_id": { + "type": "string", + "description": "The project-scoped agent identifier recorded for the routine attempt." + }, + "agent_endpoint_id": { + "type": "string", + "description": "The legacy endpoint-scoped agent identifier recorded for the routine attempt." + }, + "conversation_id": { + "type": "string", + "description": "The conversation identifier used by a responses API dispatch." + }, + "session_id": { + "type": "string", + "description": "The hosted-agent session identifier used by an invocations API dispatch." + }, "triggered_at": { "allOf": [ { @@ -51384,6 +58058,14 @@ ], "description": "The logical trigger time recorded for the routine attempt." }, + "scheduled_fire_at": { + "allOf": [ + { + "$ref": "#/components/schemas/FoundryTimestamp" + } + ], + "description": "The scheduled fire time recorded for timer and schedule deliveries." + }, "started_at": { "allOf": [ { @@ -51416,6 +58098,11 @@ "type": "string", "description": "The workspace task identifier linked to the routine attempt, when available." }, + "error_status_code": { + "type": "integer", + "format": "int32", + "description": "The downstream error status code captured for a failed attempt, when available." + }, "error_type": { "type": "string", "description": "The fully qualified error type captured for a failed attempt, when available." @@ -51423,14 +58110,6 @@ "error_message": { "type": "string", "description": "The truncated failure message captured for a failed attempt, when available." - }, - "diagnostics": { - "allOf": [ - { - "$ref": "#/components/schemas/RoutineRunDiagnostics" - } - ], - "description": "Diagnostic data captured for the routine attempt." } }, "description": "A single routine run returned from the run history API.", @@ -51440,44 +58119,6 @@ ] } }, - "RoutineRunDiagnostics": { - "type": "object", - "required": [ - "parameters", - "tags", - "metrics" - ], - "properties": { - "parameters": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "MLflow parameters recorded on the run, keyed by parameter name." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "MLflow tags recorded on the run, keyed by tag name." - }, - "metrics": { - "type": "object", - "additionalProperties": { - "type": "number", - "format": "double" - }, - "description": "Latest MLflow metric values recorded on the run, keyed by metric name." - } - }, - "description": "Generic diagnostics captured on a routine run.", - "x-ms-foundry-meta": { - "conditional_previews": [ - "Routines=V1Preview" - ] - } - }, "RoutineRunPhase": { "anyOf": [ { @@ -51500,6 +58141,15 @@ ] } }, + "RoutineRunStatus": { + "type": "string", + "description": "The status of a routine run.", + "x-ms-foundry-meta": { + "conditional_previews": [ + "Routines=V1Preview" + ] + } + }, "RoutineTrigger": { "type": "object", "required": [ @@ -51520,7 +58170,8 @@ "mapping": { "schedule": "#/components/schemas/ScheduleRoutineTrigger", "timer": "#/components/schemas/TimerRoutineTrigger", - "github_issue_opened": "#/components/schemas/GitHubIssueOpenedRoutineTrigger" + "github_issue": "#/components/schemas/GitHubIssueRoutineTrigger", + "custom": "#/components/schemas/CustomRoutineTrigger" } }, "description": "Base model for a routine trigger.", @@ -51538,7 +58189,8 @@ { "type": "string", "enum": [ - "github_issue_opened", + "custom", + "github_issue", "schedule", "timer" ] @@ -51705,21 +58357,21 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Schedule's tags. Unlike properties, tags are fully mutable." }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Schedule's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed." }, "systemData": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "System metadata for the resource.", @@ -51816,7 +58468,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Properties of the schedule run.", @@ -51841,7 +58493,7 @@ }, "configuration": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Configuration for the task." @@ -51905,10 +58557,23 @@ "SessionDirectoryListResponse": { "type": "object", "required": [ + "has_more", "path", "entries" ], "properties": { + "first_id": { + "type": "string", + "description": "The first ID represented in this list." + }, + "last_id": { + "type": "string", + "description": "The last ID represented in this list." + }, + "has_more": { + "type": "boolean", + "description": "A value indicating whether there are additional values available not captured in this list." + }, "path": { "type": "string", "description": "The path that was listed, relative to the session home directory." @@ -51920,8 +58585,7 @@ }, "description": "The directory entries." } - }, - "description": "Response from listing a directory in a session sandbox." + } }, "SessionFileWriteResponse": { "type": "object", @@ -51956,12 +58620,16 @@ } ], "description": "The SSE event type. Currently `log`, but additional event types may be added in the future. Clients should ignore unrecognized event types.", - "example": "log" + "examples": [ + "log" + ] }, "data": { "type": "string", "description": "The event payload as plain text. Currently JSON-formatted but the schema is not contractual and may change.", - "example": "{\"timestamp\":\"2026-03-10T09:33:17.121467567+00:00\",\"stream\":\"stdout\",\"message\":\"Starting server on port 18080\"}" + "examples": [ + "{\"timestamp\":\"2026-03-10T09:33:17.121467567+00:00\",\"stream\":\"stdout\",\"message\":\"Starting server on port 18080\"}" + ] } }, "description": "A single Server-Sent Event frame emitted by the hosted agent session log stream.\n\nEach frame contains an `event` field identifying the event type and a `data`\nfield carrying the payload as plain text. Although the current `data` payload\nis JSON-formatted, its schema is not contractual — additional keys may appear\nand the format may change over time. Clients should treat `data` as an\nopaque string and optionally attempt JSON parsing.\n\nNew event types may be added in the future. Clients should gracefully\nignore unrecognized event types.\n\nWire format:\n```\nevent: log\ndata: {\"timestamp\":\"2026-03-10T09:33:17.121Z\",\"stream\":\"stdout\",\"message\":\"Starting server on port 18080\"}\n\nevent: log\ndata: {\"timestamp\":\"2026-03-10T09:34:52.714Z\",\"stream\":\"status\",\"message\":\"Successfully connected to container\"}\n```", @@ -52240,7 +58908,7 @@ }, "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Arbitrary key-value metadata for additional properties." @@ -52354,12 +59022,12 @@ }, "schema": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The JSON schema for the structured input (optional)." }, "required": { "type": "boolean", - "description": "Whether the input property is required when the agent is invoked. Defaults to `false`.", + "description": "Whether the input property is required when the agent is invoked. The service defaults to `false` if a value is not specified by the caller.", "default": false } }, @@ -52384,12 +59052,18 @@ }, "schema": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The JSON schema for the structured output." }, "strict": { - "type": "boolean", - "nullable": true, + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], "description": "Whether to enforce strict validation. Default `true`." } }, @@ -52710,7 +59384,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Additional properties for the taxonomy category." @@ -52744,7 +59418,7 @@ }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Additional properties for the taxonomy sub-category." @@ -52817,10 +59491,12 @@ "$ref": "#/components/schemas/TelemetryDataKind" }, "description": "Data types to export to this endpoint. Use an empty array to export no data.", - "example": [ - "ContainerStdoutStderr", - "ContainerOtel", - "Metrics" + "examples": [ + [ + "ContainerStdoutStderr", + "ContainerOtel", + "Metrics" + ] ] }, "auth": { @@ -52960,11 +59636,12 @@ }, "initialization_parameters": { "type": "object", + "unevaluatedProperties": {}, "description": "The initialization parameters for the evaluation. Must support structured outputs." }, "data_mapping": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "The model to use for the evaluation. Must support structured outputs." @@ -52976,8 +59653,7 @@ "TimerRoutineTrigger": { "type": "object", "required": [ - "type", - "at" + "type" ], "properties": { "type": { @@ -52988,12 +59664,12 @@ "description": "The trigger type." }, "at": { - "type": "string", - "description": "A future timer expression. Supported values include an ISO-8601 timestamp with an explicit offset, a local timestamp paired with time_zone, or a positive duration from now." - }, - "time_zone": { - "type": "string", - "description": "An optional IANA or Windows time zone identifier when the timer uses a local timestamp." + "allOf": [ + { + "$ref": "#/components/schemas/FoundryTimestamp" + } + ], + "description": "The UTC date and time at which the timer fires." } }, "allOf": [ @@ -53012,7 +59688,7 @@ "anyOf": [ { "type": "object", - "additionalProperties": {} + "unevaluatedProperties": {} }, { "type": "string" @@ -53233,7 +59909,7 @@ }, "tool_configs": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "$ref": "#/components/schemas/ToolConfig" }, "description": "Per-tool configuration map. Keys are tool names or `*` (catch-all default).\nResolution order: exact tool name match takes priority over `*`.\nUnknown tool names are silently ignored at runtime." @@ -53284,11 +59960,17 @@ ], "properties": { "metadata": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "nullable": true, + "anyOf": [ + { + "type": "object", + "unevaluatedProperties": { + "type": "string" + } + }, + { + "type": "null" + } + ], "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "x-oaiTypeLabel": "map" }, @@ -53730,7 +60412,7 @@ "properties": { "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -53747,7 +60429,7 @@ }, "parameter_values": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "The inputs to the manifest that will result in a fully materialized Agent." } } @@ -53760,7 +60442,7 @@ "properties": { "metadata": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", @@ -53809,17 +60491,18 @@ "type": "string" }, "metadata": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "properties": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Set of immutable 16 key-value pairs that can be attached to an object for storing additional information.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters." @@ -53835,7 +60518,7 @@ }, "tags": { "type": "object", - "additionalProperties": { + "unevaluatedProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -54093,27 +60776,27 @@ "type": "string", "enum": [ "web_search" - ], - "description": "The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.", - "default": "web_search" + ] }, "filters": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.WebSearchToolFilters" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "user_location": { - "type": "object", - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/OpenAI.WebSearchApproximateLocation" + }, + { + "type": "null" } - ], - "nullable": true + ] }, "search_context_size": { "type": "string", @@ -54215,8 +60898,7 @@ "type": "string", "enum": [ "work_iq_preview" - ], - "description": "The object type, which is always 'work_iq_preview'." + ] }, "project_connection_id": { "type": "string", @@ -54340,7 +61022,7 @@ }, "modelParams": { "type": "object", - "additionalProperties": {}, + "unevaluatedProperties": {}, "description": "Optional parameters passed to the model for evaluation." } }, diff --git a/specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.yaml b/specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.yaml index e66cfdfe4ce4..dbb65b803891 100644 --- a/specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.yaml +++ b/specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.yaml @@ -1,36 +1,118 @@ -openapi: 3.0.0 +openapi: 3.2.0 info: title: Microsoft Foundry version: virtual-public-preview tags: + - name: EvaluationSuiteGenerationJobs + - name: Fine-Tuning + - name: Responses Root + description: Responses + - name: Responses + parent: Responses Root + description: Responses (OpenAI) + - name: Conversations + parent: Responses Root + description: Conversations (OpenAI) + - name: Agents Root + description: Agents - name: Agents - - name: Agent Containers - - name: Agent Session Files + parent: Agents Root + description: Agent Management - name: Agent Invocations + parent: Agents Root - name: Agent Invocations WebSocket - - name: Connections + parent: Agents Root + description: Agent Invocations (WebSocket) + - name: Agent Sessions + parent: Agents Root + - name: Agent Session Files + parent: Agents Root + - name: Agent Versions + parent: Agents Root + - name: Agent Containers + parent: Agents Root + - name: Platform APIs - name: Datasets - - name: Deployments - - name: Evaluation Taxonomies - - name: Evaluation Rules - - name: EvaluationSuiteGenerationJobs - - name: Evaluators - - name: EvaluatorGenerationJobs + parent: Platform APIs - name: Indexes - - name: Insights + parent: Platform APIs + - name: Connections + parent: Platform APIs + - name: Scheduler + parent: Platform APIs + - name: Fine-tuning + parent: Platform APIs + summary: Fine-Tuning - name: Models + parent: Platform APIs - name: Memory Stores - - name: Conversations - - name: Evals - - name: Fine-Tuning - - name: Responses - - name: Redteams + parent: Platform APIs + - name: Chat + parent: Platform APIs + - name: Assistants + parent: Platform APIs + - name: Audio + parent: Platform APIs + - name: Batch + parent: Platform APIs + - name: Completions + parent: Platform APIs + - name: Containers + parent: Platform APIs + - name: Embeddings + parent: Platform APIs + - name: Files + parent: Platform APIs + - name: Images + parent: Platform APIs + - name: Moderations + parent: Platform APIs + - name: Realtime + parent: Platform APIs + - name: Threads + parent: Platform APIs + - name: Uploads + parent: Platform APIs + - name: Vector stores + parent: Platform APIs + summary: Vector Stores + - name: Videos + parent: Platform APIs - name: Routines + parent: Platform APIs - name: Schedules + parent: Platform APIs - name: Skills + parent: Platform APIs - name: Toolboxes + parent: Platform APIs + - name: Deployments + parent: Platform APIs - name: DataGenerationJobs + parent: Platform APIs + summary: Data generation jobs - name: AgentOptimizationJobs + parent: Platform APIs + summary: Agent optimization jobs + - name: EvaluatorGenerationJobs + parent: Platform APIs + summary: Evaluator generation jobs + - name: Evaluations + - name: Evals + parent: Evaluations + - name: Evaluation Rules + parent: Evaluations + - name: Evaluators + parent: Evaluations + - name: Evaluation Taxonomies + parent: Evaluations + - name: Redteams + parent: Evaluations + summary: Red Teaming + - name: Evalsuite + parent: Evaluations + - name: Insights + parent: Evaluations paths: /agent_optimization_jobs: post: @@ -45,7 +127,7 @@ paths: schema: type: string enum: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview - name: Operation-Id in: header required: false @@ -77,8 +159,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OptimizationJob' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -90,15 +178,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/OptimizationJobInputs' - description: The optimization job inputs. + $ref: '#/components/schemas/OptimizationJob' + description: The job to create. x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview get: operationId: AgentOptimizationJobs_list summary: Returns a list of agent optimization jobs. - description: List optimization jobs. Supports cursor pagination and optional status / agentName filters. + description: List optimization jobs. Supports cursor pagination and optional status / agent_name filters. parameters: - name: Foundry-Features in: header @@ -107,7 +195,7 @@ paths: schema: type: string enum: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview - name: limit in: query required: false @@ -155,7 +243,7 @@ paths: schema: $ref: '#/components/schemas/JobStatus' explode: false - - name: agentName + - name: agent_name in: query required: false description: Filter to jobs targeting this agent name. @@ -183,7 +271,7 @@ paths: data: type: array items: - $ref: '#/components/schemas/OptimizationJob' + $ref: '#/components/schemas/OptimizationJobListItem' description: The requested list of items. first_id: type: string @@ -195,8 +283,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -205,12 +299,12 @@ paths: - AgentOptimizationJobs x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview /agent_optimization_jobs/{jobId}: get: operationId: AgentOptimizationJobs_get summary: Get info about an agent optimization job. - description: Get an optimization job by id. Returns 202 while in progress, 200 when terminal. + description: Get an optimization job by id. parameters: - name: Foundry-Features in: header @@ -219,7 +313,7 @@ paths: schema: type: string enum: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview - name: jobId in: path required: true @@ -239,6 +333,7 @@ paths: headers: Retry-After: required: false + description: Recommended number of seconds to wait before polling again. schema: type: integer format: int32 @@ -246,20 +341,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OptimizationJob' - '202': - description: The request has been accepted for processing, but processing has not yet completed. - headers: - Retry-After: - required: false - schema: - type: integer - format: int32 + 4XX: + description: Client error content: application/json: schema: - $ref: '#/components/schemas/OptimizationJob' - default: - description: An unexpected error response. + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -268,7 +357,7 @@ paths: - AgentOptimizationJobs x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview delete: operationId: AgentOptimizationJobs_delete summary: Deletes an agent optimization job. @@ -281,20 +370,13 @@ paths: schema: type: string enum: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview - name: jobId in: path required: true description: The ID of the job to delete. schema: type: string - - name: force - in: query - required: false - description: When true, force-delete even if the job is in a non-terminal state. - schema: - type: boolean - explode: false - name: api-version in: query required: true @@ -305,112 +387,14 @@ paths: responses: '204': description: There is no content to send for this request, but the headers may be useful. - default: - description: An unexpected error response. + 4XX: + description: Client error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' - tags: - - AgentOptimizationJobs - x-ms-foundry-meta: - conditional_previews: - - AgentsOptimization=V1Preview - /agent_optimization_jobs/{jobId}/candidates: - get: - operationId: AgentOptimizationJobs_listCandidates - summary: Returns a list of candidates for an optimization job. - description: List candidates produced by a job. - parameters: - - name: Foundry-Features - in: header - required: false - description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. - schema: - type: string - enum: - - AgentsOptimization=V1Preview - - name: jobId - in: path - required: true - description: The optimization job id. - schema: - type: string - - name: limit - in: query - required: false - description: |- - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the - default is 20. - schema: - type: integer - format: int32 - default: 20 - explode: false - - name: order - in: query - required: false - description: |- - Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc` - for descending order. - schema: - $ref: '#/components/schemas/PageOrder' - explode: false - - name: after - in: query - required: false - description: |- - A cursor for use in pagination. `after` is an object ID that defines your place in the list. - For instance, if you make a list request and receive 100 objects, ending with obj_foo, your - subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - explode: false - - name: before - in: query - required: false - description: |- - A cursor for use in pagination. `before` is an object ID that defines your place in the list. - For instance, if you make a list request and receive 100 objects, ending with obj_foo, your - subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - explode: false - - name: api-version - in: query - required: true - description: The API version to use for this operation. - schema: - type: string - explode: false - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - type: object - required: - - data - - has_more - properties: - data: - type: array - items: - $ref: '#/components/schemas/OptimizationCandidate' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - default: - description: An unexpected error response. + 5XX: + description: Server error content: application/json: schema: @@ -419,282 +403,12 @@ paths: - AgentOptimizationJobs x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V1Preview - /agent_optimization_jobs/{jobId}/candidates/{candidateId}: - get: - operationId: AgentOptimizationJobs_getCandidate - summary: Get a candidate by id. - description: Get a single candidate's metadata, manifest, and promotion info. - parameters: - - name: Foundry-Features - in: header - required: false - description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. - schema: - type: string - enum: - - AgentsOptimization=V1Preview - - name: jobId - in: path - required: true - description: The optimization job id. - schema: - type: string - - name: candidateId - in: path - required: true - description: The candidate id. - schema: - type: string - - name: api-version - in: query - required: true - description: The API version to use for this operation. - schema: - type: string - explode: false - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - $ref: '#/components/schemas/CandidateMetadata' - default: - description: An unexpected error response. - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - tags: - - AgentOptimizationJobs - x-ms-foundry-meta: - conditional_previews: - - AgentsOptimization=V1Preview - /agent_optimization_jobs/{jobId}/candidates/{candidateId}/config: - get: - operationId: AgentOptimizationJobs_getCandidateConfig - summary: Get candidate deploy config. - description: Get the candidate's deploy config JSON. Used to compose `agents.create_version(...)` from a candidate. - parameters: - - name: Foundry-Features - in: header - required: false - description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. - schema: - type: string - enum: - - AgentsOptimization=V1Preview - - name: jobId - in: path - required: true - description: The optimization job id. - schema: - type: string - - name: candidateId - in: path - required: true - description: The candidate id. - schema: - type: string - - name: api-version - in: query - required: true - description: The API version to use for this operation. - schema: - type: string - explode: false - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - $ref: '#/components/schemas/CandidateDeployConfig' - default: - description: An unexpected error response. - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - tags: - - AgentOptimizationJobs - x-ms-foundry-meta: - conditional_previews: - - AgentsOptimization=V1Preview - /agent_optimization_jobs/{jobId}/candidates/{candidateId}/files: - get: - operationId: AgentOptimizationJobs_getCandidateFile - summary: Get a candidate file. - description: Stream a specific file from the candidate's blob directory. - parameters: - - name: Foundry-Features - in: header - required: false - description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. - schema: - type: string - enum: - - AgentsOptimization=V1Preview - - name: jobId - in: path - required: true - description: The optimization job id. - schema: - type: string - - name: candidateId - in: path - required: true - description: The candidate id. - schema: - type: string - - name: path - in: query - required: true - description: Relative path of the file to download (e.g. 'files/examples.jsonl'). - schema: - type: string - explode: false - - name: api-version - in: query - required: true - description: The API version to use for this operation. - schema: - type: string - explode: false - responses: - '200': - description: The request has succeeded. - content: - application/octet-stream: - schema: - type: string - format: binary - default: - description: An unexpected error response. - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - tags: - - AgentOptimizationJobs - x-ms-foundry-meta: - conditional_previews: - - AgentsOptimization=V1Preview - /agent_optimization_jobs/{jobId}/candidates/{candidateId}/results: - get: - operationId: AgentOptimizationJobs_getCandidateResults - summary: Get candidate evaluation results. - description: Get full per-task evaluation results for a candidate. - parameters: - - name: Foundry-Features - in: header - required: false - description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. - schema: - type: string - enum: - - AgentsOptimization=V1Preview - - name: jobId - in: path - required: true - description: The optimization job id. - schema: - type: string - - name: candidateId - in: path - required: true - description: The candidate id. - schema: - type: string - - name: api-version - in: query - required: true - description: The API version to use for this operation. - schema: - type: string - explode: false - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - $ref: '#/components/schemas/CandidateResults' - default: - description: An unexpected error response. - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - tags: - - AgentOptimizationJobs - x-ms-foundry-meta: - conditional_previews: - - AgentsOptimization=V1Preview - /agent_optimization_jobs/{jobId}/candidates/{candidateId}:promote: - post: - operationId: AgentOptimizationJobs_promoteCandidate - summary: Promote a candidate. - description: Promotes a candidate, recording the deployment timestamp and target agent version. - parameters: - - name: Foundry-Features - in: header - required: false - description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. - schema: - type: string - enum: - - AgentsOptimization=V1Preview - - name: jobId - in: path - required: true - description: The optimization job id. - schema: - type: string - - name: candidateId - in: path - required: true - description: The candidate id to promote. - schema: - type: string - - name: api-version - in: query - required: true - description: The API version to use for this operation. - schema: - type: string - explode: false - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - $ref: '#/components/schemas/PromoteCandidateResponse' - default: - description: An unexpected error response. - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - tags: - - AgentOptimizationJobs - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/PromoteCandidateRequest' - description: Promotion details. - x-ms-foundry-meta: - conditional_previews: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview /agent_optimization_jobs/{jobId}:cancel: post: operationId: AgentOptimizationJobs_cancel summary: Cancels an agent optimization job. - description: Request cancellation. Idempotent on terminal states. + description: Request cancellation of a running or queued job. Returns an error if the job is already in a terminal state. parameters: - name: Foundry-Features in: header @@ -703,7 +417,7 @@ paths: schema: type: string enum: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview - name: jobId in: path required: true @@ -724,8 +438,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OptimizationJob' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -734,7 +454,7 @@ paths: - AgentOptimizationJobs x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V1Preview + - AgentsOptimization=V2Preview /agents: post: operationId: Agents_createAgent_Agents_createAgentFromCode @@ -766,11 +486,12 @@ paths: schema: type: string description: |- - Creates the agent. Creates a new code-based agent. Uploads the code zip and creates the agent in a single call. + Creates a new agent or a new version of an existing agent. Creates a new code-based agent. Uploads the code zip and creates the agent in a single call. The agent name is provided in the `x-ms-agent-name` header since POST /agents has no name in the URL path. The SHA-256 hex digest of the zip is provided in the `x-ms-code-zip-sha256` header for integrity and dedup. The request body is multipart/form-data with a JSON metadata part and a binary code part (part order is irrelevant). Maximum upload size is 250 MB. + summary: Create an agent Create a new code-based agent responses: '200': description: The request has succeeded. @@ -778,12 +499,20 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' + x-ms-description-override: Creates a new agent or a new version of an existing agent. + x-ms-summary-override: Create an agent x-ms-foundry-meta: required_previews: - CodeAgents=V1Preview @@ -803,7 +532,8 @@ paths: contentType: application/json get: operationId: Agents_listAgents - description: Returns the list of all agents. + summary: List agents + description: Returns a paged collection of agent resources. parameters: - name: kind in: query @@ -885,8 +615,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -896,6 +632,7 @@ paths: /agents/endpoint/protocols/invocations_ws: get: operationId: AgentWebsocket_connectEndpointWebsocket + summary: Establish a WebSocket connection to a hosted agent description: |- Establishes a WebSocket connection to a hosted agent. The target project and agent are passed as query parameters. The service resolves (or creates) a @@ -969,8 +706,14 @@ paths: content: application/json: schema: {} - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -983,7 +726,8 @@ paths: /agents/{agent_name}: get: operationId: Agents_getAgent - description: Retrieves the agent. + summary: Get an agent + description: Retrieves an agent definition by its unique name. parameters: - name: agent_name in: path @@ -1005,8 +749,14 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -1047,6 +797,7 @@ paths: If the code and definition are unchanged (matched by x-ms-code-zip-sha256 header), returns the existing version. The request body is multipart/form-data with a JSON metadata part and a binary code part (part order is irrelevant). Maximum upload size is 250 MB. + summary: Update an agent Update a code-based agent responses: '200': description: The request has succeeded. @@ -1054,12 +805,20 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentObject' - default: - description: An unexpected error response. + 4XX: + description: Client error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + x-ms-description-override: Updates the agent by adding a new version if there are any changes to the agent definition. If no changes, returns the existing agent version. + x-ms-summary-override: Update an agent x-ms-foundry-meta: required_previews: - CodeAgents=V1Preview @@ -1079,6 +838,7 @@ paths: contentType: application/json delete: operationId: Agents_deleteAgent + summary: Delete an agent description: |- Deletes an agent. For hosted agents, if any version has active sessions, the request is rejected with HTTP 409 unless `force` is set to true. When force is true, all @@ -1093,7 +853,7 @@ paths: - name: force in: query required: false - description: For Hosted Agents, if true, force-deletes the agent even if its versions have active sessions, cascading deletion to all associated sessions. Defaults to `false`. This value is not relevant for other Agent types. + description: For Hosted Agents, if `true`, force-deletes the agent even if its versions have active sessions, cascading deletion to all associated sessions. The service defaults to `false` if a value is not specified by the caller. This value is not relevant for other Agent types. schema: type: boolean default: false @@ -1112,8 +872,14 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteAgentResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -1122,7 +888,8 @@ paths: - Agents patch: operationId: Agents_patchAgentObject - description: Updates an agent endpoint. + summary: Update an agent endpoint + description: Applies a merge-patch update to the specified agent endpoint configuration. parameters: - name: Foundry-Features in: header @@ -1138,6 +905,7 @@ paths: description: The name of the agent to retrieve. schema: type: string + title: The name of the agent to retrieve - name: api-version in: query required: true @@ -1152,8 +920,14 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -1172,8 +946,9 @@ paths: /agents/{agent_name}/code:download: get: operationId: Agents_downloadAgentCode + summary: Download agent code description: |- - Download the code zip for a code-based hosted agent. + Downloads the code zip for a code-based hosted agent. Returns the previously-uploaded zip (`application/zip`). If `agent_version` is supplied, returns that version's code zip; otherwise @@ -1228,10 +1003,15 @@ paths: content: application/zip: schema: - type: string - format: binary - default: - description: An unexpected error response. + contentMediaType: application/zip + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -1244,6 +1024,7 @@ paths: /agents/{agent_name}/endpoint/protocols/invocations: post: operationId: AgentInvocations_createAgentInvocation + summary: Create an agent invocation description: Creates an invocation for the specified agent version. parameters: - name: agent_name @@ -1297,8 +1078,14 @@ paths: content: '*/*': schema: {} - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -1317,6 +1104,7 @@ paths: /agents/{agent_name}/endpoint/protocols/invocations/docs/openapi.json: get: operationId: AgentInvocations_getAgentInvocationOpenApiSpec + summary: Get an agent invocation OpenAPI spec description: |- Retrieves the OpenAPI specification for an agent version's invocation contract. Returns 404 if the agent does not expose an OpenAPI specification. @@ -1349,9 +1137,15 @@ paths: application/json: schema: type: object - additionalProperties: {} - default: - description: An unexpected error response. + unevaluatedProperties: {} + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -1364,6 +1158,7 @@ paths: /agents/{agent_name}/endpoint/protocols/invocations/{invocation_id}: get: operationId: AgentInvocations_getAgentInvocation + summary: Get an agent invocation description: |- Retrieves the invocation with the given ID. Returns 404 if the agent does not support this operation or if the invocation ID is not found. @@ -1413,8 +1208,14 @@ paths: content: '*/*': schema: {} - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -1427,6 +1228,7 @@ paths: /agents/{agent_name}/endpoint/protocols/invocations/{invocation_id}/cancel: post: operationId: AgentInvocations_cancelAgentInvocation + summary: Cancel an agent invocation description: |- Cancels an invocation. Returns 404 if the agent does not support this operation or if the invocation ID is not found. @@ -1476,8 +1278,14 @@ paths: content: '*/*': schema: {} - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -1496,6 +1304,7 @@ paths: /agents/{agent_name}/endpoint/sessions: post: operationId: Agents_createSession + summary: Create a session description: |- Creates a new session for an agent endpoint. The endpoint resolves the backing agent version from `version_indicator` and @@ -1535,14 +1344,20 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentSessionResource' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Sessions requestBody: required: true content: @@ -1554,7 +1369,8 @@ paths: - AgentEndpoints=V1Preview get: operationId: Agents_listSessions - description: Returns a list of sessions for the specified agent. + summary: List sessions for an agent + description: Returns a paged collection of sessions associated with the specified agent endpoint. parameters: - name: Foundry-Features in: header @@ -1649,23 +1465,30 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Sessions x-ms-foundry-meta: required_previews: - AgentEndpoints=V1Preview /agents/{agent_name}/endpoint/sessions/{agent_session_id}/files: get: operationId: AgentSessionFiles_listSessionFiles + summary: List session files description: |- - List files and directories at a given path in the session sandbox. - Returns only the immediate children of the specified directory (non-recursive). + Returns files and directories at the specified path in the session sandbox. + The response includes only the immediate children of the target directory and defaults to the session home directory when no path is supplied. parameters: - name: Foundry-Features in: header @@ -1689,8 +1512,8 @@ paths: type: string - name: path in: query - required: true - description: The directory path to list, relative to the session home directory. + required: false + description: The directory path to list, relative to the session home directory. Defaults to the home directory if not provided. schema: type: string explode: false @@ -1700,6 +1523,46 @@ paths: description: Opaque per-user isolation key used to scope endpoint-scoped data (responses, conversations, sessions) to a specific end user. schema: type: string + - name: limit + in: query + required: false + description: |- + A limit on the number of objects to be returned. Limit can range between 1 and 100, and the + default is 20. + schema: + type: integer + format: int32 + default: 20 + explode: false + - name: order + in: query + required: false + description: |- + Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc` + for descending order. + schema: + $ref: '#/components/schemas/PageOrder' + explode: false + - name: after + in: query + required: false + description: |- + A cursor for use in pagination. `after` is an object ID that defines your place in the list. + For instance, if you make a list request and receive 100 objects, ending with obj_foo, your + subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + explode: false + - name: before + in: query + required: false + description: |- + A cursor for use in pagination. `before` is an object ID that defines your place in the list. + For instance, if you make a list request and receive 100 objects, ending with obj_foo, your + subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + explode: false - name: api-version in: query required: true @@ -1714,8 +1577,14 @@ paths: application/json: schema: $ref: '#/components/schemas/SessionDirectoryListResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -1727,9 +1596,10 @@ paths: - HostedAgents=V1Preview delete: operationId: AgentSessionFiles_deleteSessionFile + summary: Delete a session file description: |- - Delete a file or directory from the session sandbox. - If `recursive` is false (default) and the target is a non-empty directory, the API returns 409 Conflict. + Deletes the specified file or directory from the session sandbox. + When `recursive` is false, deleting a non-empty directory returns 409 Conflict. parameters: - name: Foundry-Features in: header @@ -1761,7 +1631,7 @@ paths: - name: recursive in: query required: false - description: Whether to recursively delete directory contents. Defaults to false. + description: Whether to recursively delete directory contents. The service defaults to `false` if a value is not specified by the caller. schema: type: boolean default: false @@ -1782,8 +1652,14 @@ paths: responses: '204': description: 'There is no content to send for this request, but the headers may be useful. ' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -1796,9 +1672,10 @@ paths: /agents/{agent_name}/endpoint/sessions/{agent_session_id}/files/content: put: operationId: AgentSessionFiles_uploadSessionFile + summary: Upload a session file description: |- - Upload a file to the session sandbox via binary stream. - Maximum file size is 50 MB. Uploads exceeding this limit return 413 Payload Too Large. + Uploads binary file content to the specified path in the session sandbox. + The service stores the file relative to the session home directory and rejects payloads larger than 50 MB. parameters: - name: Foundry-Features in: header @@ -1847,8 +1724,14 @@ paths: application/json: schema: $ref: '#/components/schemas/SessionFileWriteResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -1860,14 +1743,16 @@ paths: content: application/octet-stream: schema: - type: string - format: binary + contentMediaType: application/octet-stream x-ms-foundry-meta: required_previews: - HostedAgents=V1Preview get: operationId: AgentSessionFiles_downloadSessionFile - description: Download a file from the session sandbox as a binary stream. + summary: Download a session file + description: |- + Downloads the file at the specified sandbox path as a binary stream. + The path is resolved relative to the session home directory. parameters: - name: Foundry-Features in: header @@ -1915,10 +1800,15 @@ paths: content: application/octet-stream: schema: - type: string - format: binary - default: - description: An unexpected error response. + contentMediaType: application/octet-stream + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -1931,7 +1821,8 @@ paths: /agents/{agent_name}/endpoint/sessions/{session_id}: get: operationId: Agents_getSession - description: Retrieves a session by ID. + summary: Get a session + description: Retrieves the details of a hosted agent session by agent name and session identifier. parameters: - name: Foundry-Features in: header @@ -1973,19 +1864,26 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentSessionResource' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Sessions x-ms-foundry-meta: required_previews: - AgentEndpoints=V1Preview delete: operationId: Agents_deleteSession + summary: Delete a session description: |- Deletes a session synchronously. Returns 204 No Content when the session is deleted or does not exist. @@ -2026,23 +1924,28 @@ paths: responses: '204': description: There is no content to send for this request, but the headers may be useful. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Sessions x-ms-foundry-meta: required_previews: - AgentEndpoints=V1Preview /agents/{agent_name}/endpoint/sessions/{session_id}:stop: post: operationId: Agents_stopSession - description: |- - Stops a session. - Returns 204 No Content when the stop succeeds. + summary: Stop a session + description: Terminates the specified hosted agent session and returns 204 No Content when the request succeeds. parameters: - name: Foundry-Features in: header @@ -2074,20 +1977,27 @@ paths: responses: '204': description: There is no content to send for this request, but the headers may be useful. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Sessions x-ms-foundry-meta: required_previews: - AgentEndpoints=V1Preview /agents/{agent_name}/import: post: operationId: Agents_updateAgentFromManifest + summary: Update an agent from a manifest description: |- Updates the agent from a manifest by adding a new version if there are any changes to the agent definition. If no changes, returns the existing agent version. @@ -2112,8 +2022,14 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -2129,7 +2045,8 @@ paths: /agents/{agent_name}/operations: get: operationId: AgentContainers_listAgentContainerOperations - description: List container operations for an agent. + summary: List agent container operations + description: Returns container operations recorded for the specified agent across its container lifecycle. parameters: - name: Foundry-Features in: header @@ -2218,8 +2135,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -2232,7 +2155,8 @@ paths: /agents/{agent_name}/operations/{operation_id}: get: operationId: AgentContainers_getAgentContainerOperation - description: Get the status of a container operation for an agent. + summary: Get an agent container operation + description: Retrieves the status and details of the specified container operation for an agent. parameters: - name: Foundry-Features in: header @@ -2268,8 +2192,14 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentContainerOperationObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -2313,7 +2243,13 @@ paths: description: SHA-256 hex digest of the uploaded code zip. Used for change detection (dedup) and integrity verification. schema: type: string - description: Create a new agent version. + description: |- + Creates a new version for the specified agent and returns the created version resource. Creates a new agent version from code. Uploads the code zip and creates a new version + for an existing agent. The SHA-256 hex digest of the zip is provided in the + `x-ms-code-zip-sha256` header for integrity and dedup. + The request body is multipart/form-data with a JSON metadata part and a binary code part (part order is irrelevant). + Maximum upload size is 250 MB. + summary: Create an agent version Create an agent version from code responses: '200': description: The request has succeeded. @@ -2321,17 +2257,25 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentVersionObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' + x-ms-description-override: Creates a new version for the specified agent and returns the created version resource. + x-ms-summary-override: Create an agent version x-ms-foundry-meta: required_previews: - CodeAgents=V1Preview tags: - - Agents + - Agent Versions requestBody: required: true content: @@ -2346,7 +2290,8 @@ paths: contentType: application/json get: operationId: Agents_listAgentVersions - description: Returns the list of versions of an agent. + summary: List agent versions + description: Returns a paged collection of versions for the specified agent. parameters: - name: agent_name in: path @@ -2427,18 +2372,25 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Versions /agents/{agent_name}/versions/{agent_version}: get: operationId: Agents_getAgentVersion - description: Retrieves a specific version of an agent. + summary: Get an agent version + description: Retrieves the specified version of an agent by its agent name and version identifier. parameters: - name: agent_name in: path @@ -2466,16 +2418,23 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentVersionObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Versions delete: operationId: Agents_deleteAgentVersion + summary: Delete an agent version description: |- Deletes a specific version of an agent. For hosted agents, if the version has active sessions, the request is rejected with HTTP 409 unless `force` is set to true. When @@ -2496,7 +2455,7 @@ paths: - name: force in: query required: false - description: For Hosted Agents, if true, force-deletes the version even if it has active sessions, cascading deletion to all associated sessions. Defaults to `false`. This value is not relevant for other Agent types. + description: For Hosted Agents, if `true`, force-deletes the version even if it has active sessions, cascading deletion to all associated sessions. The service defaults to `false` if a value is not specified by the caller. This value is not relevant for other Agent types. schema: type: boolean default: false @@ -2515,18 +2474,27 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteAgentVersionResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Versions /agents/{agent_name}/versions/{agent_version}/containers/default: get: operationId: AgentContainers_getAgentContainer - description: Get a container for a specific version of an agent. + summary: Get an agent container + description: |- + Retrieves the default container resource for the specified agent version. + The response includes the current container state and configuration. parameters: - name: Foundry-Features in: header @@ -2562,8 +2530,14 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentContainerObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -2576,7 +2550,8 @@ paths: /agents/{agent_name}/versions/{agent_version}/containers/default/operations: get: operationId: AgentContainers_listAgentVersionContainerOperations - description: List container operations for a specific version of an agent. + summary: List agent version container operations + description: Returns container operations for the default container of the specified agent version. parameters: - name: Foundry-Features in: header @@ -2671,8 +2646,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -2685,10 +2666,10 @@ paths: /agents/{agent_name}/versions/{agent_version}/containers/default:delete: post: operationId: AgentContainers_deleteAgentContainer + summary: Delete an agent container description: |- - Delete a container for a specific version of an agent. If the container doesn't exist, the operation will be no-op. - The operation is a long-running operation. Following the design guidelines for long-running operations in Azure REST APIs. - https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations + Deletes the default container for the specified agent version. + The long-running operation returns an operation resource that can be polled to completion. parameters: - name: Foundry-Features in: header @@ -2730,8 +2711,14 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentContainerOperationObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -2744,23 +2731,10 @@ paths: /agents/{agent_name}/versions/{agent_version}/containers/default:logstream: post: operationId: AgentContainers_streamAgentContainerLogs + summary: Stream agent container logs description: |- - Container log entry streamed from the container as text chunks. - Each chunk is a UTF-8 string that may be either a plain text log line - or a JSON-formatted log entry, depending on the type of container log being streamed. - Clients should treat each chunk as opaque text and, if needed, attempt - to parse it as JSON based on their logging requirements. - - For system logs, the format is JSON with the following structure: - {"TimeStamp":"2025-12-15T16:51:33Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Connecting to the events collector...","Reason":"StartingGettingEvents","EventSource":"ContainerAppController","Count":1} - {"TimeStamp":"2025-12-15T16:51:34Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Successfully connected to events server","Reason":"ConnectedToEventsServer","EventSource":"ContainerAppController","Count":1} - - For console logs, the format is plain text as emitted by the container's stdout/stderr. - 2025-12-15T08:43:48.72656 Connecting to the container 'agent-container'... - 2025-12-15T08:43:48.75451 Successfully Connected to container: 'agent-container' [Revision: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b', Replica: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b-6898b9c89f-mpkjc'] - 2025-12-15T08:33:59.0671054Z stdout F INFO: 127.0.0.1:42588 - "GET /readiness HTTP/1.1" 200 OK - 2025-12-15T08:34:29.0649033Z stdout F INFO: 127.0.0.1:60246 - "GET /readiness HTTP/1.1" 200 OK - 2025-12-15T08:34:59.0644467Z stdout F INFO: 127.0.0.1:43994 - "GET /readiness HTTP/1.1" 200 OK + Streams console or system logs from the default container for the specified agent version. + Clients can target a specific replica and request trailing log lines before the chunked text stream begins. parameters: - name: Foundry-Features in: header @@ -2814,8 +2788,14 @@ paths: responses: '200': description: The request has succeeded. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -2828,10 +2808,10 @@ paths: /agents/{agent_name}/versions/{agent_version}/containers/default:start: post: operationId: AgentContainers_startAgentContainer + summary: Start an agent container description: |- - Start a container for a specific version of an agent. If the container is already running, the operation will be no-op. - The operation is a long-running operation. Following the design guidelines for long-running operations in Azure REST APIs. - https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations + Starts the default container for the specified agent version. + The long-running operation provisions replicas when a container is not already running. parameters: - name: Foundry-Features in: header @@ -2873,8 +2853,14 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentContainerOperationObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -2904,10 +2890,10 @@ paths: /agents/{agent_name}/versions/{agent_version}/containers/default:stop: post: operationId: AgentContainers_stopAgentContainer + summary: Stop an agent container description: |- - Stop a container for a specific version of an agent. If the container is not running, or already stopped, the operation will be no-op. - The operation is a long-running operation. Following the design guidelines for long-running operations in Azure REST APIs. - https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations + Stops the default container for the specified agent version. + The long-running operation completes even when the container is already stopped. parameters: - name: Foundry-Features in: header @@ -2949,8 +2935,14 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentContainerOperationObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -2963,10 +2955,10 @@ paths: /agents/{agent_name}/versions/{agent_version}/containers/default:update: post: operationId: AgentContainers_updateAgentContainer + summary: Update an agent container description: |- - Update a container for a specific version of an agent. If the container is not running, the operation will be no-op. - The operation is a long-running operation. Following the design guidelines for long-running operations in Azure REST APIs. - https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations + Updates the replica settings for the default container of the specified agent version. + The long-running operation applies changes only when a container is already running. parameters: - name: Foundry-Features in: header @@ -3008,8 +3000,14 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentContainerOperationObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -3037,6 +3035,7 @@ paths: /agents/{agent_name}/versions/{agent_version}/sessions/{session_id}:logstream: get: operationId: Agents_getSessionLogStream + summary: Stream console logs for a hosted agent session description: |- Streams console logs (stdout / stderr) for a specific hosted agent session as a Server-Sent Events (SSE) stream. @@ -3105,21 +3104,28 @@ paths: text/event-stream: schema: $ref: '#/components/schemas/SessionLogEvent' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Sessions x-ms-foundry-meta: required_previews: - HostedAgents=V1Preview /agents/{agent_name}/versions:import: post: operationId: Agents_createAgentVersionFromManifest - description: Create a new agent version from a manifest. + summary: Create an agent version from manifest + description: Imports the provided manifest to create a new version for the specified agent. parameters: - name: agent_name in: path @@ -3146,14 +3152,20 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentVersionObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agents + - Agent Versions requestBody: required: true content: @@ -3163,7 +3175,8 @@ paths: /agents:import: post: operationId: Agents_createAgentFromManifest - description: Creates an agent from a manifest. + summary: Create an agent from a manifest + description: Imports the provided manifest to create an agent and returns the created resource. parameters: - name: api-version in: query @@ -3179,8 +3192,14 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -3196,20 +3215,21 @@ paths: /connections: get: operationId: Connections_list - description: List all connections in the project, without populating connection credentials + summary: List connections + description: Returns the connections available in the current project, optionally filtered by type or default status. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: connectionType in: query required: false - description: List connections of this specific type + description: Lists connections of this specific type schema: $ref: '#/components/schemas/ConnectionType' explode: false - name: defaultConnection in: query required: false - description: List connections that are default connections + description: Lists connections that are default connections schema: type: boolean explode: false @@ -3227,8 +3247,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedConnection' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -3244,7 +3276,8 @@ paths: /connections/{name}: get: operationId: Connections_get - description: Get a connection by name, without populating connection credentials + summary: Get a connection + description: Retrieves the specified connection and its configuration details without including credential values. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -3267,8 +3300,20 @@ paths: application/json: schema: $ref: '#/components/schemas/Connection' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -3284,7 +3329,8 @@ paths: /connections/{name}/getConnectionWithCredentials: post: operationId: Connections_getWithCredentials - description: Get a connection by name, with its connection credentials + summary: Get a connection with credentials + description: Retrieves the specified connection together with its credential values. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -3307,8 +3353,20 @@ paths: application/json: schema: $ref: '#/components/schemas/Connection' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -3324,7 +3382,7 @@ paths: /data_generation_jobs: get: operationId: DataGenerationJobs_list - summary: Returns a list of data generation jobs + summary: List data generation jobs description: Returns a list of data generation jobs. parameters: - name: Foundry-Features @@ -3408,8 +3466,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -3421,8 +3485,8 @@ paths: - DataGenerationJobs=V1Preview post: operationId: DataGenerationJobs_create - summary: Creates a data generation job. - description: Creates a data generation job. + summary: Create a data generation job + description: Submits a new data generation job for asynchronous execution. parameters: - name: Foundry-Features in: header @@ -3463,8 +3527,14 @@ paths: application/json: schema: $ref: '#/components/schemas/DataGenerationJob' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -3484,8 +3554,8 @@ paths: /data_generation_jobs/{jobId}: get: operationId: DataGenerationJobs_get - summary: Get info about a data generation job. - description: Gets the details of a data generation job by its ID. + summary: Get a data generation job + description: Retrieves the specified data generation job and its current status. parameters: - name: Foundry-Features in: header @@ -3522,8 +3592,14 @@ paths: application/json: schema: $ref: '#/components/schemas/DataGenerationJob' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -3535,8 +3611,8 @@ paths: - DataGenerationJobs=V1Preview delete: operationId: DataGenerationJobs_delete - summary: Deletes a data generation job. - description: Deletes a data generation job by its ID. + summary: Delete a data generation job + description: Removes the specified data generation job and its associated output. parameters: - name: Foundry-Features in: header @@ -3562,8 +3638,14 @@ paths: responses: '204': description: There is no content to send for this request, but the headers may be useful. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -3576,8 +3658,8 @@ paths: /data_generation_jobs/{jobId}:cancel: post: operationId: DataGenerationJobs_cancel - summary: Cancels a data generation job. - description: Cancels a data generation job by its ID. + summary: Cancel a data generation job + description: Cancels the specified data generation job if it is still in progress. parameters: - name: Foundry-Features in: header @@ -3607,8 +3689,14 @@ paths: application/json: schema: $ref: '#/components/schemas/DataGenerationJob' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -3621,6 +3709,7 @@ paths: /datasets: get: operationId: Datasets_listLatest + summary: List latest versions description: List the latest version of each DatasetVersion parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -3631,8 +3720,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedDatasetVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -3648,6 +3749,7 @@ paths: /datasets/{name}/versions: get: operationId: Datasets_listVersions + summary: List versions description: List all versions of the given DatasetVersion parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -3664,8 +3766,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedDatasetVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -3681,6 +3795,7 @@ paths: /datasets/{name}/versions/{version}: get: operationId: Datasets_getVersion + summary: Get a version description: Get the specific version of the DatasetVersion. The service returns 404 Not Found error if the DatasetVersion does not exist. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -3703,8 +3818,20 @@ paths: application/json: schema: $ref: '#/components/schemas/DatasetVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -3719,6 +3846,7 @@ paths: - Datasets delete: operationId: Datasets_deleteVersion + summary: Delete a version description: Delete the specific version of the DatasetVersion. The service returns 204 No Content if the DatasetVersion was deleted successfully or if the DatasetVersion does not exist. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -3737,8 +3865,20 @@ paths: responses: '204': description: There is no content to send for this request, but the headers may be useful. - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -3753,6 +3893,7 @@ paths: - Datasets patch: operationId: Datasets_createOrUpdateVersion + summary: Create or update a version description: Create a new or update an existing DatasetVersion with the given version id parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -3781,8 +3922,20 @@ paths: application/json: schema: $ref: '#/components/schemas/DatasetVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -3805,7 +3958,8 @@ paths: /datasets/{name}/versions/{version}/credentials: post: operationId: Datasets_getCredentials - description: Get the SAS credential to access the storage account associated with a Dataset version. + summary: Get dataset credentials + description: Gets the SAS credential to access the storage account associated with a Dataset version. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -3827,8 +3981,20 @@ paths: application/json: schema: $ref: '#/components/schemas/AssetCredentialResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -3844,7 +4010,8 @@ paths: /datasets/{name}/versions/{version}/startPendingUpload: post: operationId: Datasets_startPendingUploadVersion - description: Start a new or get an existing pending upload of a dataset for a specific version. + summary: Start a pending upload + description: Initiates a new pending upload or retrieves an existing one for the specified dataset version. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -3866,8 +4033,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PendingUploadResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -3890,7 +4069,8 @@ paths: /deployments: get: operationId: Deployments_list - description: List all deployed models in the project + summary: List deployments + description: Returns the deployed models available in the current project, optionally filtered by publisher, model name, or deployment type. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: modelPublisher @@ -3928,8 +4108,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedDeployment' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -3945,7 +4137,8 @@ paths: /deployments/{name}: get: operationId: Deployments_get - description: Get a deployed model. + summary: Get a deployment + description: Gets a deployed model. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -3968,8 +4161,20 @@ paths: application/json: schema: $ref: '#/components/schemas/Deployment' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -3985,7 +4190,7 @@ paths: /evaluation_suite_generation_jobs: post: operationId: EvaluationSuiteGenerationJobs_create - summary: Creates an evaluation suite generation job. + summary: Create an evaluation suite generation job description: Create a new job (preview). Includes optional Foundry-Features header and Operation-Id for idempotent retries. parameters: - name: Foundry-Features @@ -4027,8 +4232,14 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluationSuiteGenerationJob' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -4047,7 +4258,7 @@ paths: - Evaluations=V1Preview get: operationId: EvaluationSuiteGenerationJobs_list - summary: Returns a list of evaluation suite generation jobs. + summary: List evaluation suite generation jobs description: List jobs with cursor-based pagination (preview). Includes optional Foundry-Features header. parameters: - name: Foundry-Features @@ -4131,8 +4342,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -4145,7 +4362,7 @@ paths: /evaluation_suite_generation_jobs/{jobId}: get: operationId: EvaluationSuiteGenerationJobs_get - summary: Get info about an evaluation suite generation job. + summary: Get an evaluation suite generation job description: Get a job by ID (preview). Includes optional Foundry-Features header. parameters: - name: Foundry-Features @@ -4183,8 +4400,14 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluationSuiteGenerationJob' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -4196,7 +4419,7 @@ paths: - Evaluations=V1Preview delete: operationId: EvaluationSuiteGenerationJobs_delete - summary: Deletes an evaluation suite generation job. + summary: Delete an evaluation suite generation job description: Delete a job (preview). Returns 204 No Content. parameters: - name: Foundry-Features @@ -4223,8 +4446,14 @@ paths: responses: '204': description: There is no content to send for this request, but the headers may be useful. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -4237,7 +4466,7 @@ paths: /evaluation_suite_generation_jobs/{jobId}:cancel: post: operationId: EvaluationSuiteGenerationJobs_cancel - summary: Cancels an evaluation suite generation job. + summary: Cancel an evaluation suite generation job description: Cancel a running job (preview). Returns 200 with the updated job. parameters: - name: Foundry-Features @@ -4268,8 +4497,14 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluationSuiteGenerationJob' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -4282,6 +4517,7 @@ paths: /evaluation_suites: get: operationId: EvaluationSuites_listLatest + summary: List latest versions description: List the latest version of each EvaluationSuiteVersion parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -4299,8 +4535,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedEvaluationSuiteVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -4314,6 +4562,7 @@ paths: /evaluation_suites/{name}/versions: get: operationId: EvaluationSuites_listVersions + summary: List versions description: List all versions of the given EvaluationSuiteVersion parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -4330,8 +4579,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedEvaluationSuiteVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -4344,6 +4605,7 @@ paths: $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' post: operationId: EvaluationSuites_createEvaluationSuiteVersion + summary: Create an evaluation suite version description: Create a new EvaluationSuiteVersion with auto incremented version id parameters: - name: Foundry-Features @@ -4374,8 +4636,14 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluationSuiteVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -4393,6 +4661,7 @@ paths: /evaluation_suites/{name}/versions/{version}: get: operationId: EvaluationSuites_getVersion + summary: Get a version description: Get the specific version of the EvaluationSuiteVersion. The service returns 404 Not Found error if the EvaluationSuiteVersion does not exist. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -4415,8 +4684,20 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluationSuiteVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -4429,6 +4710,7 @@ paths: $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' delete: operationId: EvaluationSuites_deleteVersion + summary: Delete a version description: Delete the specific version of the EvaluationSuiteVersion. The service returns 204 No Content if the EvaluationSuiteVersion was deleted successfully or if the EvaluationSuiteVersion does not exist. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -4447,8 +4729,20 @@ paths: responses: '204': description: There is no content to send for this request, but the headers may be useful. - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -4461,6 +4755,7 @@ paths: $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' patch: operationId: EvaluationSuites_createOrUpdateVersion + summary: Create or update a version description: Create a new or update an existing EvaluationSuiteVersion with the given version id parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -4489,8 +4784,20 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluationSuiteVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -4511,7 +4818,8 @@ paths: /evaluation_suites/{name}:run: post: operationId: EvaluationSuites_run - description: Run an evaluation using the suite's testing criteria and dataset. + summary: Run an evaluation suite + description: Runs an evaluation using the suite's testing criteria and dataset. parameters: - name: Foundry-Features in: header @@ -4541,8 +4849,14 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluationSuiteRunResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -4560,7 +4874,8 @@ paths: /evaluationrules: get: operationId: EvaluationRules_list - description: List all evaluation rules. + summary: List evaluation rules + description: Returns the evaluation rules configured for the project, optionally filtered by action type, agent name, or enabled state. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: actionType @@ -4591,8 +4906,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedEvaluationRule' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -4608,7 +4935,8 @@ paths: /evaluationrules/{id}: get: operationId: EvaluationRules_get - description: Get an evaluation rule. + summary: Get an evaluation rule + description: Retrieves the specified evaluation rule and its configuration. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: id @@ -4624,8 +4952,20 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluationRule' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -4640,7 +4980,8 @@ paths: - Evaluation Rules delete: operationId: EvaluationRules_delete - description: Delete an evaluation rule. + summary: Delete an evaluation rule + description: Removes the specified evaluation rule from the project. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: id @@ -4652,8 +4993,20 @@ paths: responses: '204': description: There is no content to send for this request, but the headers may be useful. - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -4668,7 +5021,8 @@ paths: - Evaluation Rules put: operationId: EvaluationRules_createOrUpdate - description: Create or update an evaluation rule. + summary: Create or update an evaluation rule + description: Creates a new evaluation rule, or replaces the existing rule when the identifier matches. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: id @@ -4698,8 +5052,20 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluationRule' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -4722,7 +5088,8 @@ paths: /evaluations/runs: get: operationId: Evaluations_list - description: List evaluation runs + summary: List evaluation runs + description: Returns the evaluation runs available in the current project. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - $ref: '#/components/parameters/Azure.Core.ClientRequestIdHeader' @@ -4739,8 +5106,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedEvaluation' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -4754,7 +5133,8 @@ paths: /evaluations/runs/{name}: get: operationId: Evaluations_get - description: Get an evaluation run by name. + summary: Get an evaluation run + description: Retrieves the specified evaluation run and its current status. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -4777,8 +5157,20 @@ paths: application/json: schema: $ref: '#/components/schemas/Evaluation' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -4791,7 +5183,8 @@ paths: $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' delete: operationId: Evaluations_delete - description: Delete an evaluation run by name + summary: Delete an evaluation run + description: Removes the specified evaluation run from the project. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -4810,8 +5203,20 @@ paths: description: An opaque, globally-unique, client-generated string identifier for the request. schema: $ref: '#/components/schemas/Azure.Core.uuid' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -4825,7 +5230,8 @@ paths: /evaluations/runs/{name}:cancel: post: operationId: Evaluations_cancel - description: Cancel an evaluation run by name + summary: Cancel an evaluation run + description: Cancels the specified evaluation run before it completes. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -4844,8 +5250,20 @@ paths: description: An opaque, globally-unique, client-generated string identifier for the request. schema: $ref: '#/components/schemas/Azure.Core.uuid' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -4859,7 +5277,8 @@ paths: /evaluations/runs:run: post: operationId: Evaluations_create - description: Creates an evaluation run. + summary: Create an evaluation run + description: Submits a new evaluation run with the provided configuration. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' responses: @@ -4869,8 +5288,20 @@ paths: application/json: schema: $ref: '#/components/schemas/Evaluation' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -4891,7 +5322,8 @@ paths: /evaluations/runs:runAgent: post: operationId: Evaluations_createAgentEvaluation - description: Creates an agent evaluation run. + summary: Create an agent evaluation run + description: Submits a new agent evaluation run with the provided request. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' responses: @@ -4901,8 +5333,20 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentEvaluation' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -4923,7 +5367,8 @@ paths: /evaluationtaxonomies: get: operationId: EvaluationTaxonomies_list - description: List evaluation taxonomies + summary: List evaluation taxonomies + description: Returns the evaluation taxonomies available in the project, optionally filtered by input name or input type. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: inputName @@ -4955,8 +5400,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedEvaluationTaxonomy' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -4972,7 +5429,8 @@ paths: /evaluationtaxonomies/{name}: get: operationId: EvaluationTaxonomies_get - description: Get an evaluation run by name. + summary: Get an evaluation taxonomy + description: Retrieves the specified evaluation taxonomy. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -4996,8 +5454,20 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluationTaxonomy' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -5012,7 +5482,8 @@ paths: - Evaluation Taxonomies delete: operationId: EvaluationTaxonomies_delete - description: Delete an evaluation taxonomy by name. + summary: Delete an evaluation taxonomy + description: Removes the specified evaluation taxonomy from the project. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -5032,8 +5503,20 @@ paths: responses: '204': description: There is no content to send for this request, but the headers may be useful. - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -5048,7 +5531,8 @@ paths: - Evaluation Taxonomies put: operationId: EvaluationTaxonomies_create - description: Create an evaluation taxonomy. + summary: Create an evaluation taxonomy + description: Creates or replaces the specified evaluation taxonomy with the provided definition. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: Foundry-Features @@ -5078,8 +5562,20 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluationTaxonomy' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -5101,6 +5597,7 @@ paths: description: The evaluation taxonomy. patch: operationId: EvaluationTaxonomies_update + summary: Update an evaluation taxonomy description: Update an evaluation taxonomy. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -5125,8 +5622,20 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluationTaxonomy' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -5149,7 +5658,7 @@ paths: /evaluator_generation_jobs: post: operationId: EvaluatorGenerationJobs_create - summary: Creates an evaluator generation job. + summary: Create an evaluator generation job description: |- Creates an evaluator generation job. The service generates rubric-based evaluator definitions from the provided source materials asynchronously. @@ -5193,8 +5702,14 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluatorGenerationJob' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -5213,8 +5728,12 @@ paths: - Evaluations=V1Preview get: operationId: EvaluatorGenerationJobs_list - summary: Returns a list of evaluator generation jobs. - description: Returns a list of evaluator generation jobs. + summary: List evaluator generation jobs + description: |- + Returns a list of evaluator generation jobs. The List API has up to a few + seconds of propagation delay, so a recently created job may not appear + immediately; use the Get evaluator generation job API with the job ID to + retrieve a specific job without delay. parameters: - name: Foundry-Features in: header @@ -5297,8 +5816,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -5311,7 +5836,7 @@ paths: /evaluator_generation_jobs/{jobId}: get: operationId: EvaluatorGenerationJobs_get - summary: Get info about an evaluator generation job. + summary: Get an evaluator generation job description: Gets the details of an evaluator generation job by its ID. parameters: - name: Foundry-Features @@ -5349,8 +5874,14 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluatorGenerationJob' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -5362,6 +5893,7 @@ paths: - Evaluations=V1Preview delete: operationId: EvaluatorGenerationJobs_delete + summary: Delete an evaluator generation job description: |- Deletes an evaluator generation job by its ID. Deletes the job record only; the generated evaluator (if any) is preserved. @@ -5390,8 +5922,14 @@ paths: responses: '204': description: There is no content to send for this request, but the headers may be useful. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -5404,7 +5942,7 @@ paths: /evaluator_generation_jobs/{jobId}:cancel: post: operationId: EvaluatorGenerationJobs_cancel - summary: Cancels an evaluator generation job. + summary: Cancel an evaluator generation job description: Cancels an evaluator generation job by its ID. parameters: - name: Foundry-Features @@ -5435,8 +5973,14 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluatorGenerationJob' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -5449,7 +5993,8 @@ paths: /evaluators: get: operationId: Evaluators_listLatestVersions - description: List the latest version of each evaluator + summary: List latest evaluator versions + description: Lists the latest version of each evaluator parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: type @@ -5487,8 +6032,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedEvaluatorVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -5504,7 +6061,8 @@ paths: /evaluators/{name}/versions: get: operationId: Evaluators_listVersions - description: List all versions of the given evaluator + summary: List evaluator versions + description: Returns the available versions for the specified evaluator. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -5548,8 +6106,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedEvaluatorVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -5564,7 +6134,8 @@ paths: - Evaluators post: operationId: Evaluators_createVersion - description: Create a new EvaluatorVersion with auto incremented version id + summary: Create an evaluator version + description: Creates a new evaluator version with an auto-incremented version identifier. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -5588,8 +6159,20 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluatorVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -5611,7 +6194,8 @@ paths: /evaluators/{name}/versions/{version}: get: operationId: Evaluators_getVersion - description: Get the specific version of the EvaluatorVersion. The service returns 404 Not Found error if the EvaluatorVersion does not exist. + summary: Get an evaluator version + description: Retrieves the specified evaluator version, returning 404 if it does not exist. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -5641,8 +6225,20 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluatorVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -5657,7 +6253,8 @@ paths: - Evaluators delete: operationId: Evaluators_deleteVersion - description: Delete the specific version of the EvaluatorVersion. The service returns 204 No Content if the EvaluatorVersion was deleted successfully or if the EvaluatorVersion does not exist. + summary: Delete an evaluator version + description: Removes the specified evaluator version. Returns 204 whether the version existed or not. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -5683,8 +6280,20 @@ paths: responses: '204': description: There is no content to send for this request, but the headers may be useful. - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -5699,7 +6308,8 @@ paths: - Evaluators patch: operationId: Evaluators_updateVersion - description: Update an existing EvaluatorVersion with the given version id + summary: Update an evaluator version + description: Updates the specified evaluator version in place. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -5729,8 +6339,20 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluatorVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -5753,7 +6375,71 @@ paths: /evaluators/{name}/versions/{version}/credentials: post: operationId: Evaluators_getCredentials - description: Get the SAS credential to access the storage account associated with an Evaluator version. + summary: Get evaluator credentials + description: Retrieves SAS credentials for accessing the storage account associated with the specified evaluator version. + parameters: + - name: Foundry-Features + in: header + required: false + description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. + schema: + type: string + enum: + - Evaluations=V1Preview + - name: name + in: path + required: true + schema: + type: string + - name: version + in: path + required: true + description: The specific version id of the EvaluatorVersion to operate on. + schema: + type: string + - name: api-version + in: query + required: true + description: The API version to use for this operation. + schema: + type: string + explode: false + responses: + '200': + description: The request has succeeded. + content: + application/json: + schema: + $ref: '#/components/schemas/AssetCredentialResponse' + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + tags: + - Evaluators + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EvaluatorCredentialRequest' + description: The credential request parameters + x-ms-foundry-meta: + required_previews: + - Evaluations=V1Preview + /evaluators/{name}/versions/{version}/startPendingUpload: + post: + operationId: Evaluators_startPendingUpload + summary: Start a pending upload + description: Initiates a new pending upload or retrieves an existing one for the specified evaluator version. parameters: - name: Foundry-Features in: header @@ -5787,65 +6473,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AssetCredentialResponse' - default: - description: An unexpected error response. + $ref: '#/components/schemas/PendingUploadResponse' + 4XX: + description: Client error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' - tags: - - Evaluators - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/EvaluatorCredentialRequest' - description: The credential request parameters - x-ms-foundry-meta: - required_previews: - - Evaluations=V1Preview - /evaluators/{name}/versions/{version}/startPendingUpload: - post: - operationId: Evaluators_startPendingUpload - description: Start a new or get an existing pending upload of an evaluator for a specific version. - parameters: - - name: Foundry-Features - in: header - required: false - description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. - schema: - type: string - enum: - - Evaluations=V1Preview - - name: name - in: path - required: true - schema: - type: string - - name: version - in: path - required: true - description: The specific version id of the EvaluatorVersion to operate on. - schema: - type: string - - name: api-version - in: query - required: true - description: The API version to use for this operation. - schema: - type: string - explode: false - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - $ref: '#/components/schemas/PendingUploadResponse' - default: - description: An unexpected error response. + 5XX: + description: Server error content: application/json: schema: @@ -5865,6 +6501,7 @@ paths: /indexes: get: operationId: Indexes_listLatest + summary: List latest versions description: List the latest version of each Index parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -5875,8 +6512,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedIndex' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -5892,6 +6541,7 @@ paths: /indexes/{name}/versions: get: operationId: Indexes_listVersions + summary: List versions description: List all versions of the given Index parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -5908,8 +6558,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedIndex' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -5925,6 +6587,7 @@ paths: /indexes/{name}/versions/{version}: get: operationId: Indexes_getVersion + summary: Get a version description: Get the specific version of the Index. The service returns 404 Not Found error if the Index does not exist. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -5947,8 +6610,20 @@ paths: application/json: schema: $ref: '#/components/schemas/Index' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -5963,6 +6638,7 @@ paths: - Indexes delete: operationId: Indexes_deleteVersion + summary: Delete a version description: Delete the specific version of the Index. The service returns 204 No Content if the Index was deleted successfully or if the Index does not exist. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -5981,8 +6657,20 @@ paths: responses: '204': description: There is no content to send for this request, but the headers may be useful. - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -5997,6 +6685,7 @@ paths: - Indexes patch: operationId: Indexes_createOrUpdateVersion + summary: Create or update a version description: Create a new or update an existing Index with the given version id parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -6025,8 +6714,20 @@ paths: application/json: schema: $ref: '#/components/schemas/Index' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -6049,7 +6750,8 @@ paths: /insights: post: operationId: Insights_generate - description: Generate Insights + summary: Generate insights + description: Generates an insights report from the provided evaluation configuration. parameters: - name: Foundry-Features in: header @@ -6086,8 +6788,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Insight' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6103,7 +6811,8 @@ paths: description: Complete evaluation configuration including data source, evaluators, and result settings get: operationId: Insights_list - description: List all insights in reverse chronological order (newest first). + summary: List insights + description: Returns insights in reverse chronological order, with the most recent entries first. parameters: - name: Foundry-Features in: header @@ -6162,8 +6871,14 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedInsight' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6173,7 +6888,8 @@ paths: /insights/{id}: get: operationId: Insights_get - description: Get a specific insight by Id. + summary: Get an insight + description: Retrieves the specified insight report and its results. parameters: - name: Foundry-Features in: header @@ -6210,8 +6926,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Insight' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6221,6 +6943,8 @@ paths: /managedAgentIdentityBlueprints: get: operationId: ManagedAgentIdentityBlueprints_listManagedAgentIdentityBlueprints + summary: List blueprints + description: Lists all managed agent identity blueprints. parameters: - name: Foundry-Features in: header @@ -6264,8 +6988,14 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedManagedAgentIdentityBlueprint' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6276,6 +7006,8 @@ paths: /managedAgentIdentityBlueprints/{blueprint_name}: put: operationId: ManagedAgentIdentityBlueprints_createOrUpdateManagedAgentIdentityBlueprint + summary: Create or update a blueprint + description: Creates or updates a managed agent identity blueprint. parameters: - name: Foundry-Features in: header @@ -6305,8 +7037,14 @@ paths: application/json: schema: $ref: '#/components/schemas/ManagedAgentIdentityBlueprint' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6322,6 +7060,7 @@ paths: - AgentEndpoints=V1Preview get: operationId: ManagedAgentIdentityBlueprints_getManagedAgentIdentityBlueprint + summary: Get a blueprint description: Retrieves a managed agent identity blueprint by name. parameters: - name: Foundry-Features @@ -6352,8 +7091,14 @@ paths: application/json: schema: $ref: '#/components/schemas/ManagedAgentIdentityBlueprint' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6363,6 +7108,7 @@ paths: - AgentEndpoints=V1Preview delete: operationId: ManagedAgentIdentityBlueprints_deleteManagedAgentIdentityBlueprint + summary: Delete a blueprint description: Deletes a managed agent identity blueprint by name. parameters: - name: Foundry-Features @@ -6389,8 +7135,14 @@ paths: responses: '204': description: There is no content to send for this request, but the headers may be useful. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6401,7 +7153,8 @@ paths: /memory_stores: post: operationId: createMemoryStore - description: Create a memory store. + summary: Create a memory store + description: Creates a memory store resource with the provided configuration. parameters: - name: Foundry-Features in: header @@ -6425,8 +7178,14 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryStoreObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6450,7 +7209,7 @@ paths: description: A human-readable description of the memory store. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Arbitrary key-value metadata to associate with the memory store. definition: @@ -6465,7 +7224,8 @@ paths: - MemoryStores=V1Preview get: operationId: listMemoryStores - description: List all memory stores. + summary: List memory stores + description: Returns the memory stores available to the caller. parameters: - name: Foundry-Features in: header @@ -6548,8 +7308,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6562,7 +7328,8 @@ paths: /memory_stores/{name}: post: operationId: updateMemoryStore - description: Update a memory store. + summary: Update a memory store + description: Updates the specified memory store with the supplied configuration changes. parameters: - name: Foundry-Features in: header @@ -6592,8 +7359,14 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryStoreObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6613,7 +7386,7 @@ paths: description: A human-readable description of the memory store. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Arbitrary key-value metadata to associate with the memory store. x-ms-foundry-meta: @@ -6621,7 +7394,8 @@ paths: - MemoryStores=V1Preview get: operationId: getMemoryStore - description: Retrieve a memory store. + summary: Get a memory store + description: Retrieves the specified memory store and its current configuration. parameters: - name: Foundry-Features in: header @@ -6651,8 +7425,14 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryStoreObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6664,7 +7444,8 @@ paths: - MemoryStores=V1Preview delete: operationId: deleteMemoryStore - description: Delete a memory store. + summary: Delete a memory store + description: Deletes the specified memory store. parameters: - name: Foundry-Features in: header @@ -6694,8 +7475,14 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteMemoryStoreResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6708,7 +7495,8 @@ paths: /memory_stores/{name}/items: post: operationId: createMemory - description: Create a memory item in a memory store. + summary: Create a memory item + description: Creates a memory item in the specified memory store. parameters: - name: Foundry-Features in: header @@ -6738,8 +7526,14 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryItem' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6773,7 +7567,8 @@ paths: /memory_stores/{name}/items/{memory_id}: post: operationId: updateMemory - description: Update a memory item in a memory store. + summary: Update a memory item + description: Updates the specified memory item in the memory store. parameters: - name: Foundry-Features in: header @@ -6809,8 +7604,14 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryItem' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6834,7 +7635,8 @@ paths: - MemoryStores=V1Preview get: operationId: getMemory - description: Retrieve a memory item from a memory store. + summary: Get a memory item + description: Retrieves the specified memory item from the memory store. parameters: - name: Foundry-Features in: header @@ -6870,8 +7672,14 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryItem' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6883,7 +7691,8 @@ paths: - MemoryStores=V1Preview delete: operationId: deleteMemory - description: Delete a memory item from a memory store. + summary: Delete a memory item + description: Deletes the specified memory item from the memory store. parameters: - name: Foundry-Features in: header @@ -6919,8 +7728,14 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteMemoryResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -6933,7 +7748,8 @@ paths: /memory_stores/{name}/items:list: post: operationId: listMemories - description: List all memory items in a memory store. + summary: List memory items + description: Returns memory items from the specified memory store. parameters: - name: Foundry-Features in: header @@ -7029,8 +7845,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -7055,7 +7877,8 @@ paths: /memory_stores/{name}/updates/{update_id}: get: operationId: getUpdateResult - description: Get memory store update result. + summary: Get an update result + description: Retrieves the status and result of a memory store update operation. parameters: - name: Foundry-Features in: header @@ -7091,8 +7914,14 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryStoreUpdateResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -7105,7 +7934,8 @@ paths: /memory_stores/{name}:delete_scope: post: operationId: deleteScopeMemories - description: Delete all memories associated with a specific scope from a memory store. + summary: Delete memories by scope + description: Deletes all memories in the specified memory store that are associated with the provided scope. parameters: - name: Foundry-Features in: header @@ -7135,8 +7965,14 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryStoreDeleteScopeResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -7161,7 +7997,8 @@ paths: /memory_stores/{name}:search_memories: post: operationId: searchMemories - description: Search for relevant memories from a memory store based on conversation context. + summary: Search memories + description: Searches the specified memory store for memories relevant to the provided conversation context. parameters: - name: Foundry-Features in: header @@ -7191,8 +8028,14 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryStoreSearchResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -7229,7 +8072,10 @@ paths: /memory_stores/{name}:update_memories: post: operationId: updateMemories - description: Update memory store with conversation memories. + summary: Update memories + description: |- + Starts an update that writes conversation memories into the specified memory store. + The operation returns a long-running status location for polling the update result. parameters: - name: Foundry-Features in: header @@ -7266,8 +8112,14 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryStoreUpdateResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -7309,6 +8161,7 @@ paths: /models: get: operationId: Models_listLatest + summary: List latest versions description: List the latest version of each ModelVersion parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -7327,8 +8180,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedModelVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -7344,6 +8209,7 @@ paths: /models/{name}/versions: get: operationId: Models_listVersions + summary: List versions description: List all versions of the given ModelVersion parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -7368,8 +8234,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedModelVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -7385,7 +8263,8 @@ paths: /models/{name}/versions/{version}: get: operationId: Models_getVersion - description: Get the specific version of the ModelVersion. The service returns 404 Not Found error if the ModelVersion does not exist. + summary: Get a model version + description: Retrieves the specified model version, returning 404 if it does not exist. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -7415,8 +8294,20 @@ paths: application/json: schema: $ref: '#/components/schemas/ModelVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -7434,6 +8325,7 @@ paths: - Models=V1Preview delete: operationId: Models_deleteVersion + summary: Delete a model version description: Delete the specific version of the ModelVersion. The service returns 200 OK if the ModelVersion was deleted successfully or if the ModelVersion does not exist. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -7460,8 +8352,20 @@ paths: responses: '200': description: The request has succeeded. - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -7479,6 +8383,7 @@ paths: - Models=V1Preview patch: operationId: Models_updateVersion + summary: Update a model version description: Update an existing ModelVersion with the given version id parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' @@ -7515,8 +8420,20 @@ paths: application/json: schema: $ref: '#/components/schemas/ModelVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -7542,7 +8459,8 @@ paths: /models/{name}/versions/{version}/createAsync: post: operationId: Models_createAsync - description: Creates a model version asynchronously with blob content validation. Returns 202 Accepted with a Location header for polling. + summary: Create a model version async + description: Creates a model version asynchronously with blob content validation. Returns 202 Accepted with a location header for polling the operation status. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: Foundry-Features @@ -7585,12 +8503,25 @@ paths: format: uri description: URL to poll for operation status. operationResult: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' description: URL to the operation result, or null if the operation is still in progress. - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -7616,7 +8547,8 @@ paths: /models/{name}/versions/{version}/credentials: post: operationId: Models_getCredentials - description: Get credentials for a model version asset. + summary: Get model asset credentials + description: Retrieves temporary credentials for accessing the storage backing the specified model version. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: Foundry-Features @@ -7646,8 +8578,20 @@ paths: application/json: schema: $ref: '#/components/schemas/AssetCredentialResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -7672,7 +8616,8 @@ paths: /models/{name}/versions/{version}/startPendingUpload: post: operationId: Models_startPendingUpload - description: Start or retrieve a pending upload for a model version. + summary: Start a pending upload + description: Initiates a new pending upload or retrieves an existing one for the specified model version. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: Foundry-Features @@ -7702,8 +8647,20 @@ paths: application/json: schema: $ref: '#/components/schemas/ModelPendingUploadResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -7728,7 +8685,8 @@ paths: /openai/v1/conversations: post: operationId: createConversation - description: Create a conversation. + summary: Create a conversation + description: Creates a new conversation resource. parameters: - name: x-ms-user-isolation-key in: header @@ -7743,8 +8701,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ConversationResource' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -7759,7 +8723,8 @@ paths: $ref: '#/components/schemas/OpenAI.CreateConversationBody' get: operationId: listConversations - description: Returns the list of all conversations. + summary: List conversations + description: Returns the conversations available in the current project. parameters: - name: limit in: query @@ -7847,8 +8812,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -7858,7 +8829,8 @@ paths: /openai/v1/conversations/{conversation_id}: post: operationId: updateConversation - description: Update a conversation. + summary: Update a conversation + description: Modifies the specified conversation's properties. parameters: - name: conversation_id in: path @@ -7879,8 +8851,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ConversationResource' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -7895,7 +8873,8 @@ paths: $ref: '#/components/schemas/OpenAI.UpdateConversationBody' get: operationId: getConversation - description: Retrieves a conversation. + summary: Retrieve a conversation + description: Retrieves the specified conversation and its metadata. parameters: - name: conversation_id in: path @@ -7916,8 +8895,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ConversationResource' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -7926,7 +8911,8 @@ paths: - Conversations delete: operationId: deleteConversation - description: Deletes a conversation. + summary: Delete a conversation + description: Removes the specified conversation resource from the current project. parameters: - name: conversation_id in: path @@ -7947,8 +8933,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.DeletedConversationResource' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -7958,7 +8950,8 @@ paths: /openai/v1/conversations/{conversation_id}/items: post: operationId: createConversationItems - description: Create items in a conversation with the given ID. + summary: Create conversation items + description: Adds one or more items to the specified conversation. parameters: - name: conversation_id in: path @@ -7990,8 +8983,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ConversationItemList' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8015,7 +9014,8 @@ paths: - items get: operationId: listConversationItems - description: List all items for a conversation with the given ID. + summary: List conversation items + description: Returns the items belonging to the specified conversation. parameters: - name: conversation_id in: path @@ -8102,8 +9102,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8113,7 +9119,8 @@ paths: /openai/v1/conversations/{conversation_id}/items/{item_id}: get: operationId: getConversationItem - description: Get a single item from a conversation with the given IDs. + summary: Get a conversation item + description: Retrieves a specific item from the specified conversation. parameters: - name: conversation_id in: path @@ -8140,8 +9147,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.OutputItem' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8150,7 +9163,8 @@ paths: - Conversations delete: operationId: deleteConversationItem - description: Delete an item from a conversation with the given IDs. + summary: Delete a conversation item + description: Removes the specified item from a conversation. parameters: - name: conversation_id in: path @@ -8177,8 +9191,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ConversationResource' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8188,8 +9208,8 @@ paths: /openai/v1/evals: get: operationId: Evals_listEvals - summary: List all evaluations - description: List evaluations for a project. + summary: List evaluations + description: Returns the evaluations configured in the current project. parameters: - name: after in: query @@ -8203,8 +9223,7 @@ paths: required: false description: Number of runs to retrieve. schema: - allOf: - - $ref: '#/components/schemas/integer' + $ref: '#/components/schemas/integer' default: 20 explode: false - name: order @@ -8256,8 +9275,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8266,9 +9291,9 @@ paths: - Evals post: operationId: Evals_createEval - summary: Create evaluation + summary: Create an evaluation description: |- - Create the structure of an evaluation that can be used to test a model's performance. + Creates the structure of an evaluation that can be used to test a model's performance. An evaluation is a set of testing criteria and the config for a data source, which dictates the schema of the data used in the evaluation. After creating an evaluation, you can run it on different models and model parameters. We support several types of graders and datasources. For more information, see the [Evals guide](https://platform.openai.com/docs/guides/evals). parameters: [] @@ -8279,8 +9304,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Eval' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8297,7 +9328,7 @@ paths: delete: operationId: Evals_deleteEval summary: Delete an evaluation - description: Delete an evaluation. + description: Removes the specified evaluation and its associated data. parameters: - name: eval_id in: path @@ -8312,8 +9343,14 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteEvalResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8323,7 +9360,7 @@ paths: get: operationId: Evals_getEval summary: Get an evaluation - description: Get an evaluation by ID. + description: Retrieves the specified evaluation and its configuration. parameters: - name: eval_id in: path @@ -8338,8 +9375,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Eval' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8349,7 +9392,7 @@ paths: post: operationId: Evals_updateEval summary: Update an evaluation - description: Update certain properties of an evaluation. + description: Updates certain properties of an evaluation. parameters: - name: eval_id in: path @@ -8364,8 +9407,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Eval' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8381,8 +9430,8 @@ paths: /openai/v1/evals/{eval_id}/runs: get: operationId: Evals_listRuns - summary: Get a list of runs for an evaluation - description: Get a list of runs for an evaluation. + summary: List evaluation runs + description: Returns the runs associated with the specified evaluation. parameters: - name: eval_id in: path @@ -8402,8 +9451,7 @@ paths: required: false description: Number of runs to retrieve. schema: - allOf: - - $ref: '#/components/schemas/integer' + $ref: '#/components/schemas/integer' default: 20 explode: false - name: order @@ -8456,8 +9504,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8466,7 +9520,8 @@ paths: - Evals post: operationId: Evals_createEvalRun - summary: Create evaluation run + summary: Create an evaluation run + description: Creates an evaluation run for the specified evaluation. parameters: - name: eval_id in: path @@ -8481,8 +9536,14 @@ paths: application/json: schema: $ref: '#/components/schemas/EvalRun' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8498,8 +9559,8 @@ paths: /openai/v1/evals/{eval_id}/runs/{run_id}: delete: operationId: Evals_deleteEvalRun - summary: Delete evaluation run - description: Delete an eval run. + summary: Delete an evaluation run + description: Removes the specified evaluation run. parameters: - name: eval_id in: path @@ -8520,8 +9581,14 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteEvalRunResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8531,7 +9598,7 @@ paths: get: operationId: Evals_getEvalRun summary: Get an evaluation run - description: Get an evaluation run by ID. + description: Retrieves the specified evaluation run and its current status. parameters: - name: eval_id in: path @@ -8552,8 +9619,14 @@ paths: application/json: schema: $ref: '#/components/schemas/EvalRun' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8562,8 +9635,8 @@ paths: - Evals post: operationId: Evals_cancelEvalRun - summary: Cancel evaluation run - description: Cancel an ongoing evaluation run. + summary: Cancel an evaluation run + description: Cancels an ongoing evaluation run. parameters: - name: eval_id in: path @@ -8584,8 +9657,14 @@ paths: application/json: schema: $ref: '#/components/schemas/EvalRun' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8595,8 +9674,8 @@ paths: /openai/v1/evals/{eval_id}/runs/{run_id}/output_items: get: operationId: Evals_getEvalRunOutputItems - summary: Get evaluation run output items - description: Get a list of output items for an evaluation run. + summary: List evaluation run output items + description: Returns the output items produced by the specified evaluation run. parameters: - name: eval_id in: path @@ -8621,8 +9700,7 @@ paths: required: false description: Number of runs to retrieve. schema: - allOf: - - $ref: '#/components/schemas/integer' + $ref: '#/components/schemas/integer' default: 20 explode: false - name: order @@ -8673,8 +9751,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8685,7 +9769,7 @@ paths: get: operationId: Evals_getEvalRunOutputItem summary: Get an output item of an evaluation run - description: Get an evaluation run output item by ID. + description: Retrieves a single output item from the specified evaluation run. parameters: - name: eval_id in: path @@ -8712,8 +9796,14 @@ paths: application/json: schema: $ref: '#/components/schemas/EvalRunOutputItem' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8723,6 +9813,7 @@ paths: /openai/v1/fine_tuning/jobs: post: operationId: createFineTuningJob + summary: Create a fine-tuning job description: |- Creates a fine-tuning job which begins the process of creating a new model from a given dataset. @@ -8744,8 +9835,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.FineTuningJob' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8760,7 +9857,8 @@ paths: $ref: '#/components/schemas/OpenAI.CreateFineTuningJobRequest' get: operationId: listPaginatedFineTuningJobs - description: List your organization's fine-tuning jobs + summary: List fine-tuning jobs + description: Returns the fine-tuning jobs for the current organization. parameters: - name: after in: query @@ -8792,8 +9890,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ListPaginatedFineTuningJobsResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8803,8 +9907,9 @@ paths: /openai/v1/fine_tuning/jobs/{fine_tuning_job_id}: get: operationId: retrieveFineTuningJob + summary: Get a fine-tuning job description: |- - Get info about a fine-tuning job. + Gets info about a fine-tuning job. [Learn more about fine-tuning](https://platform.openai.com/docs/guides/fine-tuning) parameters: @@ -8828,8 +9933,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.FineTuningJob' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8839,7 +9950,8 @@ paths: /openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel: post: operationId: cancelFineTuningJob - description: Immediately cancel a fine-tune job. + summary: Cancel a fine-tuning job + description: Immediately cancels the specified fine-tuning job. parameters: - name: fine_tuning_job_id in: path @@ -8861,8 +9973,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.FineTuningJob' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8872,7 +9990,8 @@ paths: /openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints: get: operationId: listFineTuningJobCheckpoints - description: List checkpoints for a fine-tuning job. + summary: List fine-tuning job checkpoints + description: Returns the checkpoints saved during the specified fine-tuning job. parameters: - name: fine_tuning_job_id in: path @@ -8910,8 +10029,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ListFineTuningJobCheckpointsResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8921,7 +10046,8 @@ paths: /openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events: get: operationId: listFineTuningJobEvents - description: Get fine-grained status updates for a fine-tuning job. + summary: List fine-tuning job events + description: Returns the status events emitted during the specified fine-tuning job. parameters: - name: fine_tuning_job_id in: path @@ -8959,8 +10085,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ListFineTuningJobEventsResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -8970,7 +10102,8 @@ paths: /openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause: post: operationId: pauseFineTuningJob - description: Pause a running fine-tune job. + summary: Pause a fine-tuning job + description: Pauses the specified fine-tuning job while it is running. parameters: - name: fine_tuning_job_id in: path @@ -8992,8 +10125,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.FineTuningJob' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -9003,7 +10142,8 @@ paths: /openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume: post: operationId: resumeFineTuningJob - description: Resume a paused fine-tune job. + summary: Resume a fine-tuning job + description: Resumes the specified fine-tuning job after it has been paused. parameters: - name: fine_tuning_job_id in: path @@ -9025,8 +10165,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.FineTuningJob' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -9035,7 +10181,9 @@ paths: - Fine-Tuning /openai/v1/responses: post: - operationId: createResponse_createResponseStream + operationId: createResponse + summary: Create a model response + description: Creates a model response. Provide text or image inputs to generate text or JSON outputs. Have the model call your own custom code or use built-in tools like web search or file search to use your own data as input for the model’s response. parameters: - name: x-ms-user-isolation-key in: header @@ -9043,7 +10191,6 @@ paths: description: Opaque per-user isolation key used to scope endpoint-scoped data (responses, conversations, sessions) to a specific end user. schema: type: string - description: Creates a model response. Creates a model response (streaming response). responses: '200': description: The request has succeeded. @@ -9056,12 +10203,213 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/OpenAI.Response' + type: object + properties: + metadata: + anyOf: + - $ref: '#/components/schemas/OpenAI.Metadata' + - type: 'null' + top_logprobs: + anyOf: + - $ref: '#/components/schemas/OpenAI.integer' + - type: 'null' + temperature: + anyOf: + - $ref: '#/components/schemas/OpenAI.numeric' + - type: 'null' + default: 1 + top_p: + anyOf: + - $ref: '#/components/schemas/OpenAI.numeric' + - type: 'null' + default: 1 + user: + type: string + description: |- + This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. + A stable identifier for your end-users. + Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). + deprecated: true + safety_identifier: + type: string + maxLength: 64 + description: |- + A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. + The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). + prompt_cache_key: + type: string + description: Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching). + service_tier: + $ref: '#/components/schemas/OpenAI.ServiceTier' + prompt_cache_retention: + anyOf: + - type: string + enum: + - in_memory + - 24h + - type: 'null' + previous_response_id: + anyOf: + - type: string + - type: 'null' + model: + type: string + description: The model deployment to use for the creation of this response. + reasoning: + anyOf: + - $ref: '#/components/schemas/OpenAI.Reasoning' + - type: 'null' + background: + anyOf: + - type: boolean + - type: 'null' + max_tool_calls: + anyOf: + - $ref: '#/components/schemas/OpenAI.integer' + - type: 'null' + text: + $ref: '#/components/schemas/OpenAI.ResponseTextParam' + tools: + $ref: '#/components/schemas/OpenAI.ToolsArray' + tool_choice: + oneOf: + - $ref: '#/components/schemas/OpenAI.ToolChoiceOptions' + - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' + prompt: + $ref: '#/components/schemas/OpenAI.Prompt' + truncation: + anyOf: + - type: string + enum: + - auto + - disabled + - type: 'null' + default: disabled + id: + type: string + description: Unique identifier for this Response. + object: + type: string + enum: + - response + description: The object type of this resource - always set to `response`. + x-stainless-const: true + status: + type: string + enum: + - completed + - failed + - in_progress + - cancelled + - queued + - incomplete + description: |- + The status of the response generation. One of `completed`, `failed`, + `in_progress`, `cancelled`, `queued`, or `incomplete`. + created_at: + type: integer + format: unixtime + description: Unix timestamp (in seconds) of when this Response was created. + completed_at: + anyOf: + - type: string + format: date-time + - type: 'null' + type: integer + format: unixTimestamp + error: + anyOf: + - $ref: '#/components/schemas/OpenAI.ResponseError' + - type: 'null' + incomplete_details: + anyOf: + - $ref: '#/components/schemas/OpenAI.ResponseIncompleteDetails' + - type: 'null' + output: + type: array + items: + $ref: '#/components/schemas/OpenAI.OutputItem' + description: |- + An array of content items generated by the model. + - The length and order of items in the `output` array is dependent + on the model's response. + - Rather than accessing the first item in the `output` array and + assuming it's an `assistant` message with the content generated by + the model, you might consider using the `output_text` property where + supported in SDKs. + instructions: + anyOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.InputItem' + - type: 'null' + output_text: + anyOf: + - type: string + - type: 'null' + usage: + $ref: '#/components/schemas/OpenAI.ResponseUsage' + moderation: + anyOf: + - $ref: '#/components/schemas/OpenAI.Moderation' + - type: 'null' + parallel_tool_calls: + type: boolean + description: Whether to allow the model to run tool calls in parallel. + default: true + conversation: + anyOf: + - $ref: '#/components/schemas/OpenAI.ConversationReference' + - type: 'null' + max_output_tokens: + anyOf: + - $ref: '#/components/schemas/OpenAI.integer' + - type: 'null' + agent: + allOf: + - $ref: '#/components/schemas/AgentId' + description: |- + (Deprecated) Use agent_reference instead. + The agent used for this response + agent_session_id: + type: string + description: |- + The session identifier for this response. Currently only relevant for hosted agents. + Always returned for hosted agents — either the caller-provided value, the auto-derived value, + or an auto-generated UUID. Use for session-scoped operations and to maintain sandbox + affinity in follow-up calls. + agent_reference: + anyOf: + - $ref: '#/components/schemas/AgentReference' + - type: 'null' + description: The agent used for this response + content_filters: + type: array + items: + $ref: '#/components/schemas/ContentFilterResult' + description: The content filter evaluation results. + required: + - id + - object + - created_at + - error + - incomplete_details + - output + - instructions + - parallel_tool_calls + - agent_reference text/event-stream: schema: $ref: '#/components/schemas/OpenAI.CreateResponseStreamingResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -9073,298 +10421,161 @@ paths: content: application/json: schema: - anyOf: - - type: object - properties: - metadata: - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true - top_logprobs: - type: integer - allOf: - - $ref: '#/components/schemas/OpenAI.integer' - nullable: true - temperature: - type: number - allOf: - - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true - default: 1 - top_p: - type: number - allOf: - - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true - default: 1 - user: - type: string - description: |- - This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. - A stable identifier for your end-users. - Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). - deprecated: true - safety_identifier: - type: string - description: |- - A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. - The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). - prompt_cache_key: - type: string - description: Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching). - service_tier: - $ref: '#/components/schemas/OpenAI.ServiceTier' - prompt_cache_retention: - type: string - enum: - - in-memory - - 24h - nullable: true - previous_response_id: - type: string - nullable: true - model: - type: string - description: The model deployment to use for the creation of this response. - reasoning: - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.Reasoning' - nullable: true - background: - type: boolean - nullable: true - max_output_tokens: - type: integer - allOf: - - $ref: '#/components/schemas/OpenAI.integer' - nullable: true - max_tool_calls: - type: integer - allOf: - - $ref: '#/components/schemas/OpenAI.integer' - nullable: true - text: - $ref: '#/components/schemas/OpenAI.ResponseTextParam' - tools: - $ref: '#/components/schemas/OpenAI.ToolsArray' - tool_choice: - oneOf: - - $ref: '#/components/schemas/OpenAI.ToolChoiceOptions' - - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' - prompt: - $ref: '#/components/schemas/OpenAI.Prompt' - truncation: - type: string - enum: - - auto - - disabled - nullable: true - default: disabled - input: - $ref: '#/components/schemas/OpenAI.InputParam' - include: - type: array - items: - $ref: '#/components/schemas/OpenAI.IncludeEnum' - nullable: true - parallel_tool_calls: - type: boolean - nullable: true - default: true - store: - type: boolean - nullable: true - default: true - instructions: - type: string - nullable: true - stream: - type: boolean - nullable: true - stream_options: - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamOptions' - nullable: true - conversation: - allOf: - - $ref: '#/components/schemas/OpenAI.ConversationParam' - nullable: true - context_management: - type: array - items: - $ref: '#/components/schemas/OpenAI.ContextManagementParam' - nullable: true - description: Context management configuration for this request. - agent: - allOf: - - $ref: '#/components/schemas/AgentReference' - description: |- - (Deprecated) Use agent_reference instead. - The agent to use for generating the response. - agent_session_id: - type: string - description: |- - Optional session identifier for sandbox affinity. Currently only relevant for hosted agents. - When provided, the request is routed to the same sandbox. When omitted, auto-derived from - conversation_id/prev_response_id or a new UUID is generated. - agent_reference: - allOf: - - $ref: '#/components/schemas/AgentReference' - description: The agent to use for generating the response. - structured_inputs: - type: object - additionalProperties: {} - description: The structured inputs to the response that can participate in prompt template substitution or tool argument bindings. - - type: object - properties: - metadata: - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true - top_logprobs: - type: integer - allOf: - - $ref: '#/components/schemas/OpenAI.integer' - nullable: true - temperature: - type: number - allOf: - - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true - default: 1 - top_p: - type: number - allOf: - - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true - default: 1 - user: - type: string - description: |- - This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. - A stable identifier for your end-users. - Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). - deprecated: true - safety_identifier: - type: string - description: |- - A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. - The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). - prompt_cache_key: - type: string - description: Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching). - service_tier: - $ref: '#/components/schemas/OpenAI.ServiceTier' - prompt_cache_retention: - type: string + type: object + properties: + metadata: + anyOf: + - $ref: '#/components/schemas/OpenAI.Metadata' + - type: 'null' + top_logprobs: + anyOf: + - $ref: '#/components/schemas/OpenAI.integer' + - type: 'null' + temperature: + anyOf: + - $ref: '#/components/schemas/OpenAI.numeric' + - type: 'null' + default: 1 + top_p: + anyOf: + - $ref: '#/components/schemas/OpenAI.numeric' + - type: 'null' + default: 1 + user: + type: string + description: |- + This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. + A stable identifier for your end-users. + Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). + deprecated: true + safety_identifier: + type: string + maxLength: 64 + description: |- + A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. + The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). + prompt_cache_key: + type: string + description: Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching). + service_tier: + $ref: '#/components/schemas/OpenAI.ServiceTier' + prompt_cache_retention: + anyOf: + - type: string enum: - - in-memory + - in_memory - 24h - nullable: true - previous_response_id: - type: string - nullable: true - model: - type: string - description: The model deployment to use for the creation of this response. - reasoning: - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.Reasoning' - nullable: true - background: - type: boolean - nullable: true - max_output_tokens: - type: integer - allOf: - - $ref: '#/components/schemas/OpenAI.integer' - nullable: true - max_tool_calls: - type: integer - allOf: - - $ref: '#/components/schemas/OpenAI.integer' - nullable: true - text: - $ref: '#/components/schemas/OpenAI.ResponseTextParam' - tools: - $ref: '#/components/schemas/OpenAI.ToolsArray' - tool_choice: - oneOf: - - $ref: '#/components/schemas/OpenAI.ToolChoiceOptions' - - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' - prompt: - $ref: '#/components/schemas/OpenAI.Prompt' - truncation: - type: string + - type: 'null' + previous_response_id: + anyOf: + - type: string + - type: 'null' + model: + type: string + description: The model deployment to use for the creation of this response. + reasoning: + anyOf: + - $ref: '#/components/schemas/OpenAI.Reasoning' + - type: 'null' + background: + anyOf: + - type: boolean + - type: 'null' + max_tool_calls: + anyOf: + - $ref: '#/components/schemas/OpenAI.integer' + - type: 'null' + text: + $ref: '#/components/schemas/OpenAI.ResponseTextParam' + tools: + $ref: '#/components/schemas/OpenAI.ToolsArray' + tool_choice: + oneOf: + - $ref: '#/components/schemas/OpenAI.ToolChoiceOptions' + - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' + prompt: + $ref: '#/components/schemas/OpenAI.Prompt' + truncation: + anyOf: + - type: string enum: - auto - disabled - nullable: true - default: disabled - input: - $ref: '#/components/schemas/OpenAI.InputParam' - include: - type: array + - type: 'null' + default: disabled + input: + $ref: '#/components/schemas/OpenAI.InputParam' + include: + anyOf: + - type: array items: $ref: '#/components/schemas/OpenAI.IncludeEnum' - nullable: true - parallel_tool_calls: - type: boolean - nullable: true - default: true - store: - type: boolean - nullable: true - default: true - instructions: - type: string - nullable: true - stream: - type: boolean - nullable: true - stream_options: - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.ResponseStreamOptions' - nullable: true - conversation: - allOf: - - $ref: '#/components/schemas/OpenAI.ConversationParam' - nullable: true - context_management: - type: array + - type: 'null' + parallel_tool_calls: + anyOf: + - type: boolean + - type: 'null' + default: true + store: + anyOf: + - type: boolean + - type: 'null' + default: true + instructions: + anyOf: + - type: string + - type: 'null' + moderation: + anyOf: + - $ref: '#/components/schemas/OpenAI.ModerationParam' + - type: 'null' + stream: + anyOf: + - type: boolean + - type: 'null' + stream_options: + anyOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamOptions' + - type: 'null' + conversation: + anyOf: + - $ref: '#/components/schemas/OpenAI.ConversationParam' + - type: 'null' + context_management: + anyOf: + - type: array items: $ref: '#/components/schemas/OpenAI.ContextManagementParam' - nullable: true - description: Context management configuration for this request. - agent: - allOf: - - $ref: '#/components/schemas/AgentReference' - description: |- - (Deprecated) Use agent_reference instead. - The agent to use for generating the response. - agent_session_id: - type: string - description: |- - Optional session identifier for sandbox affinity. Currently only relevant for hosted agents. - When provided, the request is routed to the same sandbox. When omitted, auto-derived from - conversation_id/prev_response_id or a new UUID is generated. - agent_reference: - allOf: - - $ref: '#/components/schemas/AgentReference' - description: The agent to use for generating the response. - structured_inputs: - type: object - additionalProperties: {} - description: The structured inputs to the response that can participate in prompt template substitution or tool argument bindings. + - type: 'null' + description: Context management configuration for this request. + max_output_tokens: + anyOf: + - $ref: '#/components/schemas/OpenAI.integer' + - type: 'null' + agent: + allOf: + - $ref: '#/components/schemas/AgentReference' + description: |- + (Deprecated) Use agent_reference instead. + The agent to use for generating the response. + agent_session_id: + type: string + description: |- + Optional session identifier for sandbox affinity. Currently only relevant for hosted agents. + When provided, the request is routed to the same sandbox. When omitted, auto-derived from + conversation_id/prev_response_id or a new UUID is generated. + agent_reference: + allOf: + - $ref: '#/components/schemas/AgentReference' + description: The agent to use for generating the response. + structured_inputs: + type: object + unevaluatedProperties: {} + description: The structured inputs to the response that can participate in prompt template substitution or tool argument bindings. get: operationId: listResponses - description: Returns the list of all responses. + summary: List responses + description: Returns a collection of all stored responses matching specified filter criteria. parameters: - name: limit in: query @@ -9459,8 +10670,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -9470,7 +10687,8 @@ paths: /openai/v1/responses/compact: post: operationId: compactResponseConversation - description: Produces a compaction of a responses conversation. + summary: Compact a conversation + description: Compacts a conversation into a response object suitable for long-running and zero-data-retention scenarios. parameters: [] responses: '200': @@ -9479,8 +10697,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.CompactResource' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -9495,7 +10719,9 @@ paths: $ref: '#/components/schemas/OpenAI.CompactResponseMethodPublicBody' /openai/v1/responses/{response_id}: get: - operationId: getResponse_getResponseStream + operationId: getResponse + summary: Retrieve a model response + description: Retrieves a model response with the given ID. parameters: - name: response_id in: path @@ -9530,14 +10756,6 @@ paths: description: Opaque per-user isolation key used to scope endpoint-scoped data (responses, conversations, sessions) to a specific end user. schema: type: string - - name: accept - in: header - required: false - schema: - type: string - enum: - - text/event-stream - description: Retrieves a model response with the given ID. Retrieves a model response with the given ID (streaming response). responses: '200': description: The request has succeeded. @@ -9554,8 +10772,14 @@ paths: text/event-stream: schema: $ref: '#/components/schemas/OpenAI.CreateResponseStreamingResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -9564,6 +10788,7 @@ paths: - Responses delete: operationId: deleteResponse + summary: Delete a model response description: Deletes a model response. parameters: - name: response_id @@ -9591,8 +10816,14 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteResponseResult' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -9602,7 +10833,8 @@ paths: /openai/v1/responses/{response_id}/cancel: post: operationId: cancelResponse - description: Cancels a model response. + summary: Cancel a model response + description: Cancels a model response with the given ID. Only responses created with the background parameter set to true can be cancelled. parameters: - name: response_id in: path @@ -9629,8 +10861,14 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.Response' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -9640,7 +10878,8 @@ paths: /openai/v1/responses/{response_id}/input_items: get: operationId: listInputItems - description: Returns a list of input items for a given response. + summary: List input items for a response + description: Retrieves the input items associated with the specified response. parameters: - name: response_id in: path @@ -9725,8 +10964,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -9736,7 +10981,8 @@ paths: /redTeams/runs: get: operationId: RedTeams_list - description: List a redteam by name. + summary: List redteams + description: Returns the redteams available in the current project. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: Foundry-Features @@ -9754,8 +11000,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedRedTeam' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -9771,7 +11029,8 @@ paths: /redTeams/runs/{name}: get: operationId: RedTeams_get - description: Get a redteam by name. + summary: Get a redteam + description: Retrieves the specified redteam and its configuration. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -9795,8 +11054,20 @@ paths: application/json: schema: $ref: '#/components/schemas/RedTeam' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -9812,7 +11083,8 @@ paths: /redTeams/runs:run: post: operationId: RedTeams_create - description: Creates a redteam run. + summary: Create a redteam run + description: Submits a new redteam run for execution with the provided configuration. parameters: - name: Foundry-Features in: header @@ -9836,8 +11108,14 @@ paths: application/json: schema: $ref: '#/components/schemas/RedTeam' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -9854,7 +11132,8 @@ paths: /routines: get: operationId: listRoutines - description: List routines. + summary: List routines + description: Returns the routines available in the current project. parameters: - name: Foundry-Features in: header @@ -9864,46 +11143,10 @@ paths: type: string enum: - Routines=V1Preview - - name: limit - in: query - required: false - description: |- - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the - default is 20. - schema: - type: integer - format: int32 - default: 20 - explode: false - - name: order - in: query - required: false - description: |- - Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc` - for descending order. - schema: - $ref: '#/components/schemas/PageOrder' - explode: false - - name: after - in: query - required: false - description: |- - A cursor for use in pagination. `after` is an object ID that defines your place in the list. - For instance, if you make a list request and receive 100 objects, ending with obj_foo, your - subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - explode: false - - name: before - in: query - required: false - description: |- - A cursor for use in pagination. `before` is an object ID that defines your place in the list. - For instance, if you make a list request and receive 100 objects, ending with obj_foo, your - subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - explode: false + - $ref: '#/components/parameters/ListRoutinesParameters.limit' + - $ref: '#/components/parameters/ListRoutinesParameters.after' + - $ref: '#/components/parameters/ListRoutinesParameters.before' + - $ref: '#/components/parameters/ListRoutinesParameters.order' - name: api-version in: query required: true @@ -9937,8 +11180,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -9951,7 +11200,8 @@ paths: /routines/{routine_name}: put: operationId: createOrUpdateRoutine - description: Create or update a routine. + summary: Create or update a routine + description: Creates a new routine or replaces an existing routine with the supplied definition. parameters: - name: Foundry-Features in: header @@ -9976,8 +11226,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Routine' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -9995,7 +11251,8 @@ paths: - Routines=V1Preview get: operationId: getRoutine - description: Retrieve a routine. + summary: Get a routine + description: Retrieves the specified routine and its current configuration. parameters: - name: Foundry-Features in: header @@ -10020,8 +11277,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Routine' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -10033,7 +11296,8 @@ paths: - Routines=V1Preview delete: operationId: deleteRoutine - description: Delete a routine. + summary: Delete a routine + description: Deletes the specified routine. parameters: - name: Foundry-Features in: header @@ -10054,8 +11318,14 @@ paths: responses: '204': description: There is no content to send for this request, but the headers may be useful. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -10068,7 +11338,8 @@ paths: /routines/{routine_name}/runs: get: operationId: listRoutineRuns - description: List prior runs for a routine. + summary: List prior runs for a routine + description: Returns prior runs recorded for the specified routine. parameters: - name: Foundry-Features in: header @@ -10080,46 +11351,10 @@ paths: - Routines=V1Preview - $ref: '#/components/parameters/ListRoutineRunsParameters.routine_name' - $ref: '#/components/parameters/ListRoutineRunsParameters.filter' - - name: limit - in: query - required: false - description: |- - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the - default is 20. - schema: - type: integer - format: int32 - default: 20 - explode: false - - name: order - in: query - required: false - description: |- - Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc` - for descending order. - schema: - $ref: '#/components/schemas/PageOrder' - explode: false - - name: after - in: query - required: false - description: |- - A cursor for use in pagination. `after` is an object ID that defines your place in the list. - For instance, if you make a list request and receive 100 objects, ending with obj_foo, your - subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - explode: false - - name: before - in: query - required: false - description: |- - A cursor for use in pagination. `before` is an object ID that defines your place in the list. - For instance, if you make a list request and receive 100 objects, ending with obj_foo, your - subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - explode: false + - $ref: '#/components/parameters/ListRoutineRunsParameters.limit' + - $ref: '#/components/parameters/ListRoutineRunsParameters.after' + - $ref: '#/components/parameters/ListRoutineRunsParameters.before' + - $ref: '#/components/parameters/ListRoutineRunsParameters.order' - name: api-version in: query required: true @@ -10153,8 +11388,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -10167,7 +11408,8 @@ paths: /routines/{routine_name}:disable: post: operationId: disableRoutine - description: Disable a routine. + summary: Disable a routine + description: Disables the specified routine so it no longer runs. parameters: - name: Foundry-Features in: header @@ -10192,8 +11434,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Routine' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -10206,7 +11454,8 @@ paths: /routines/{routine_name}:dispatch_async: post: operationId: dispatchRoutineAsync - description: Queue an asynchronous routine dispatch. + summary: Queue an asynchronous routine dispatch + description: Queues an asynchronous dispatch for the specified routine. parameters: - name: Foundry-Features in: header @@ -10231,8 +11480,14 @@ paths: application/json: schema: $ref: '#/components/schemas/DispatchRoutineResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -10251,7 +11506,8 @@ paths: /routines/{routine_name}:enable: post: operationId: enableRoutine - description: Enable a routine. + summary: Enable a routine + description: Enables the specified routine so it can be dispatched. parameters: - name: Foundry-Features in: header @@ -10276,8 +11532,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Routine' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -10290,7 +11552,8 @@ paths: /schedules: get: operationId: Schedules_list - description: List all schedules. + summary: List schedules + description: Returns schedules that match the supplied type and enabled filters. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: type @@ -10322,8 +11585,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedSchedule' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -10339,7 +11614,8 @@ paths: /schedules/{id}: delete: operationId: Schedules_delete - description: Delete a schedule. + summary: Delete a schedule + description: Deletes the specified schedule resource. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: id @@ -10359,8 +11635,20 @@ paths: responses: '204': description: There is no content to send for this request, but the headers may be useful. - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -10375,7 +11663,8 @@ paths: - Schedules get: operationId: Schedules_get - description: Get a schedule by id. + summary: Get a schedule + description: Retrieves the specified schedule resource. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: id @@ -10399,8 +11688,20 @@ paths: application/json: schema: $ref: '#/components/schemas/Schedule' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -10415,7 +11716,8 @@ paths: - Schedules put: operationId: Schedules_createOrUpdate - description: Create or update operation template. + summary: Create or update a schedule + description: Creates a new schedule or updates an existing schedule with the supplied definition. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: id @@ -10445,8 +11747,20 @@ paths: application/json: schema: $ref: '#/components/schemas/Schedule' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -10469,7 +11783,8 @@ paths: /schedules/{id}/runs: get: operationId: Schedules_listRuns - description: List all schedule runs. + summary: List schedule runs + description: Returns schedule runs that match the supplied filters. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: id @@ -10507,8 +11822,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedScheduleRun' - default: - description: An unexpected error response. + 4XX: + description: Client error + headers: + x-ms-error-code: + required: false + description: String error code indicating what went wrong. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' + 5XX: + description: Server error headers: x-ms-error-code: required: false @@ -10524,7 +11851,8 @@ paths: /schedules/{schedule_id}/runs/{run_id}: get: operationId: Schedules_getRun - description: Get a schedule run by id. + summary: Get a schedule run + description: Retrieves the specified run for a schedule. parameters: - name: schedule_id in: path @@ -10560,8 +11888,14 @@ paths: application/json: schema: $ref: '#/components/schemas/ScheduleRun' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -10571,7 +11905,8 @@ paths: /skills: get: operationId: Skills_listSkills - description: Returns the list of all skills. + summary: List skills + description: Returns the skills available in the current project. parameters: - name: limit in: query @@ -10654,8 +11989,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -10668,7 +12009,8 @@ paths: /skills/{name}: get: operationId: Skills_getSkill - description: Retrieves a skill. + summary: Retrieve a skill + description: Retrieves the specified skill and its current configuration. parameters: - name: name in: path @@ -10698,8 +12040,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Skill' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -10711,7 +12059,8 @@ paths: - Skills=V1Preview post: operationId: updateSkill - description: Update a skill. + summary: Update a skill + description: Modifies the specified skill's configuration. parameters: - name: name in: path @@ -10741,8 +12090,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Skill' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -10766,7 +12121,8 @@ paths: - Skills=V1Preview delete: operationId: Skills_deleteSkill - description: Deletes a skill. + summary: Delete a skill + description: Removes the specified skill and its associated versions. parameters: - name: name in: path @@ -10796,8 +12152,14 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteSkillResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -10810,7 +12172,8 @@ paths: /skills/{name}/content: get: operationId: getSkillContent - description: Download the zip content for the default version of a skill. + summary: Download the zip content for the default version of a skill + description: Downloads the zip content for the default version of a skill. parameters: - name: name in: path @@ -10839,10 +12202,15 @@ paths: content: application/zip: schema: - type: string - format: binary - default: - description: An unexpected error response. + contentMediaType: application/zip + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -10878,6 +12246,7 @@ paths: type: string explode: false description: Creates a new version of a skill. If the skill does not exist, it will be created. Creates a new version of a skill from uploaded files via multipart form data. + summary: Create a new version of a skill Create a skill version from uploaded files responses: '200': description: The request has succeeded. @@ -10885,12 +12254,20 @@ paths: application/json: schema: $ref: '#/components/schemas/SkillVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' + x-ms-description-override: Creates a new version of a skill. If the skill does not exist, it will be created. + x-ms-summary-override: Create a new version of a skill x-ms-foundry-meta: required_previews: - Skills=V1Preview @@ -10920,7 +12297,8 @@ paths: contentType: text/plain get: operationId: listSkillVersions - description: List all versions of a skill. + summary: List skill versions + description: Returns the available versions for the specified skill. parameters: - name: name in: path @@ -11009,8 +12387,14 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -11023,7 +12407,8 @@ paths: /skills/{name}/versions/{version}: get: operationId: getSkillVersion - description: Retrieve a specific version of a skill. + summary: Retrieve a specific version of a skill + description: Retrieves the specified version of a skill by name and version identifier. parameters: - name: name in: path @@ -11059,8 +12444,14 @@ paths: application/json: schema: $ref: '#/components/schemas/SkillVersion' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -11072,7 +12463,8 @@ paths: - Skills=V1Preview delete: operationId: deleteSkillVersion - description: Delete a specific version of a skill. + summary: Delete a specific version of a skill + description: Removes the specified version of a skill. parameters: - name: name in: path @@ -11108,8 +12500,14 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteSkillVersionResponse' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -11122,7 +12520,8 @@ paths: /skills/{name}/versions/{version}/content: get: operationId: getSkillVersionContent - description: Download the zip content for a specific version of a skill. + summary: Download the zip content for a specific version of a skill + description: Downloads the zip content for a specific version of a skill. parameters: - name: name in: path @@ -11157,10 +12556,15 @@ paths: content: application/zip: schema: - type: string - format: binary - default: - description: An unexpected error response. + contentMediaType: application/zip + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -11173,7 +12577,8 @@ paths: /toolboxes: get: operationId: listToolboxes - description: List all toolboxes. + summary: List toolboxes + description: Returns the toolboxes available in the current project. parameters: - name: limit in: query @@ -11215,6 +12620,14 @@ paths: schema: type: string explode: false + - name: Foundry-Features + in: header + required: true + description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. + schema: + type: string + enum: + - Toolboxes=V1Preview - name: api-version in: query required: true @@ -11248,18 +12661,28 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - Toolboxes + x-ms-foundry-meta: + conditional_previews: + - Toolboxes=V1Preview /toolboxes/{name}: get: operationId: getToolbox - description: Retrieve a toolbox. + summary: Retrieve a toolbox + description: Retrieves the specified toolbox and its current configuration. parameters: - name: name in: path @@ -11267,6 +12690,14 @@ paths: description: The name of the toolbox to retrieve. schema: type: string + - name: Foundry-Features + in: header + required: true + description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. + schema: + type: string + enum: + - Toolboxes=V1Preview - name: api-version in: query required: true @@ -11281,19 +12712,37 @@ paths: application/json: schema: $ref: '#/components/schemas/ToolboxObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - Toolboxes + x-ms-foundry-meta: + conditional_previews: + - Toolboxes=V1Preview patch: operationId: updateToolbox - description: Update a toolbox to point to a specific version. + summary: Update a toolbox to point to a specific version + description: Updates the toolbox's default version pointer to the specified version. parameters: - $ref: '#/components/parameters/UpdateToolboxRequest.name' + - name: Foundry-Features + in: header + required: true + description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. + schema: + type: string + enum: + - Toolboxes=V1Preview - name: api-version in: query required: true @@ -11308,8 +12757,14 @@ paths: application/json: schema: $ref: '#/components/schemas/ToolboxObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -11322,9 +12777,13 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateToolboxRequest' + x-ms-foundry-meta: + conditional_previews: + - Toolboxes=V1Preview delete: operationId: deleteToolbox - description: Delete a toolbox and all its versions. + summary: Delete a toolbox + description: Removes the specified toolbox along with all of its versions. parameters: - name: name in: path @@ -11332,6 +12791,14 @@ paths: description: The name of the toolbox to delete. schema: type: string + - name: Foundry-Features + in: header + required: true + description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. + schema: + type: string + enum: + - Toolboxes=V1Preview - name: api-version in: query required: true @@ -11342,18 +12809,28 @@ paths: responses: '204': description: 'There is no content to send for this request, but the headers may be useful. ' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - Toolboxes + x-ms-foundry-meta: + conditional_previews: + - Toolboxes=V1Preview /toolboxes/{name}/versions: post: operationId: createToolboxVersion - description: Create a new version of a toolbox. If the toolbox does not exist, it will be created. + summary: Create a new version of a toolbox + description: Creates a new toolbox version, provisioning the toolbox itself if it does not already exist. parameters: - name: name in: path @@ -11362,6 +12839,14 @@ paths: schema: type: string maxLength: 256 + - name: Foundry-Features + in: header + required: true + description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. + schema: + type: string + enum: + - Toolboxes=V1Preview - name: api-version in: query required: true @@ -11376,8 +12861,14 @@ paths: application/json: schema: $ref: '#/components/schemas/ToolboxVersionObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: @@ -11397,7 +12888,7 @@ paths: description: A human-readable description of the toolbox. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Arbitrary key-value metadata to associate with the toolbox. tools: @@ -11416,9 +12907,13 @@ paths: description: Policy configuration for this toolbox version. required: - tools + x-ms-foundry-meta: + conditional_previews: + - Toolboxes=V1Preview get: operationId: listToolboxVersions - description: List all versions of a toolbox. + summary: List toolbox versions + description: Returns the available versions for the specified toolbox. parameters: - name: name in: path @@ -11466,6 +12961,14 @@ paths: schema: type: string explode: false + - name: Foundry-Features + in: header + required: true + description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. + schema: + type: string + enum: + - Toolboxes=V1Preview - name: api-version in: query required: true @@ -11499,18 +13002,28 @@ paths: type: boolean description: A value indicating whether there are additional values available not captured in this list. description: The response data for a requested list of items. - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - Toolboxes + x-ms-foundry-meta: + conditional_previews: + - Toolboxes=V1Preview /toolboxes/{name}/versions/{version}: get: operationId: getToolboxVersion - description: Retrieve a specific version of a toolbox. + summary: Retrieve a specific version of a toolbox + description: Retrieves the specified version of a toolbox by name and version identifier. parameters: - name: name in: path @@ -11524,6 +13037,14 @@ paths: description: The version identifier to retrieve. schema: type: string + - name: Foundry-Features + in: header + required: true + description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. + schema: + type: string + enum: + - Toolboxes=V1Preview - name: api-version in: query required: true @@ -11538,17 +13059,27 @@ paths: application/json: schema: $ref: '#/components/schemas/ToolboxVersionObject' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - Toolboxes + x-ms-foundry-meta: + conditional_previews: + - Toolboxes=V1Preview delete: operationId: deleteToolboxVersion - description: Delete a specific version of a toolbox. + summary: Delete a specific version of a toolbox + description: Removes the specified version of a toolbox. parameters: - name: name in: path @@ -11562,6 +13093,14 @@ paths: description: The version identifier to delete. schema: type: string + - name: Foundry-Features + in: header + required: true + description: A feature flag opt-in required when using preview operations or modifying persisted preview resources. + schema: + type: string + enum: + - Toolboxes=V1Preview - name: api-version in: query required: true @@ -11572,14 +13111,23 @@ paths: responses: '204': description: 'There is no content to send for this request, but the headers may be useful. ' - default: - description: An unexpected error response. + 4XX: + description: Client error + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorResponse' + 5XX: + description: Server error content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - Toolboxes + x-ms-foundry-meta: + conditional_previews: + - Toolboxes=V1Preview security: - OAuth2Auth: - https://ai.azure.com/.default @@ -11649,6 +13197,22 @@ components: schema: type: string maxLength: 128 + ListRoutineRunsParameters.after: + name: after + in: query + required: false + description: An opaque cursor returned as last_id by the previous list-runs response. + schema: + type: string + explode: false + ListRoutineRunsParameters.before: + name: before + in: query + required: false + description: Unsupported. Reserved for future backward pagination support. + schema: + type: string + explode: false ListRoutineRunsParameters.filter: name: filter in: query @@ -11657,6 +13221,23 @@ components: schema: type: string explode: false + ListRoutineRunsParameters.limit: + name: limit + in: query + required: false + description: The maximum number of runs to return. + schema: + type: integer + format: int32 + explode: false + ListRoutineRunsParameters.order: + name: order + in: query + required: false + description: The ordering direction. Supported values are asc and desc. + schema: + type: string + explode: false ListRoutineRunsParameters.routine_name: name: routine_name in: path @@ -11665,6 +13246,39 @@ components: schema: type: string maxLength: 128 + ListRoutinesParameters.after: + name: after + in: query + required: false + description: An opaque cursor returned as last_id by the previous list response. + schema: + type: string + explode: false + ListRoutinesParameters.before: + name: before + in: query + required: false + description: Unsupported. Reserved for future backward pagination support. + schema: + type: string + explode: false + ListRoutinesParameters.limit: + name: limit + in: query + required: false + description: The maximum number of routines to return. + schema: + type: integer + format: int32 + explode: false + ListRoutinesParameters.order: + name: order + in: query + required: false + description: The ordering direction. Supported values are asc and desc. + schema: + type: string + explode: false UpdateToolboxRequest.name: name: name in: path @@ -11715,7 +13329,6 @@ components: type: string enum: - a2a_preview - description: The type of the tool. Always `"a2a_preview`. base_url: type: string format: uri @@ -11997,12 +13610,14 @@ components: type: integer format: int32 description: The maximum number of replicas for the container. Default is 1. - example: 10 + examples: + - 10 min_replicas: type: integer format: int32 description: The minimum number of replicas for the container. Default is 1. - example: 1 + examples: + - 1 error_message: type: string description: The error message if the container failed to operate, if any. @@ -12286,7 +13901,7 @@ components: description: Identifier of the agent thread. This field is mandatory currently, but it will be optional in the future. evaluators: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/EvaluatorConfiguration' description: Evaluators to be used for the evaluation. samplingConfiguration: @@ -12340,7 +13955,7 @@ components: description: A string explaining why there was an error, if applicable. additionalDetails: type: object - additionalProperties: + unevaluatedProperties: type: string description: Additional properties relevant to the evaluator. These will differ between evaluators. description: Result for the agent evaluation evaluator run. @@ -12465,18 +14080,6 @@ components: version: type: string description: The version identifier of the agent. - AgentIdentifier: - type: object - required: - - agentName - properties: - agentName: - type: string - description: Registered Foundry agent name (required). - agentVersion: - type: string - description: Pinned agent version. Defaults to latest if omitted. - description: Identifies the registered Foundry agent to optimize (request-only). Skills, tools, and systemPrompt are specified in options.optimizationConfig. AgentIdentity: type: object required: @@ -12574,6 +14177,7 @@ components: enum: - activity_protocol - responses + - a2a - mcp - invocations - invocations_ws @@ -12644,7 +14248,6 @@ components: - idle - updating - failed - - stopping - deleting - deleted - expired @@ -12708,10 +14311,11 @@ components: - definition properties: metadata: - type: object - additionalProperties: - type: string - nullable: true + anyOf: + - type: object + unevaluatedProperties: + type: string + - type: 'null' description: |- Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured @@ -13304,7 +14908,6 @@ components: type: string enum: - azure_ai_search - description: The object type, which is always 'azure_ai_search'. azure_ai_search: allOf: - $ref: '#/components/schemas/AzureAISearchToolResource' @@ -13614,7 +15217,7 @@ components: description: A description of what the function does, used by the model to choose when and how to call the function. parameters: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The parameters the functions accepts, described as a JSON Schema object. required: - name @@ -14118,116 +15721,6 @@ components: - $ref: '#/components/schemas/BrowserAutomationToolConnectionParameters' description: The project connection parameters associated with the Browser Automation Tool. description: Definition of input parameters for the Browser Automation Tool. - CandidateDeployConfig: - type: object - properties: - instructions: - type: string - description: System prompt / instructions. - model: - type: string - description: Foundry deployment name. - temperature: - type: number - format: float - minimum: 0 - maximum: 2 - description: Optional sampling temperature. - skills: - type: array - items: - type: object - additionalProperties: {} - description: Optional skill overrides. - tools: - type: array - items: - type: object - additionalProperties: {} - description: Optional tool overrides. - description: Deploy-config blob for a candidate. Suitable for setting OPTIMIZATION_CONFIG on a hosted-agent version. - CandidateFileInfo: - type: object - required: - - path - - type - - sizeBytes - properties: - path: - type: string - description: Relative path of the file. - type: - type: string - description: File type category (e.g. 'config', 'results'). - sizeBytes: - type: integer - format: int64 - description: File size in bytes. - description: File entry in a candidate's blob directory. - CandidateMetadata: - type: object - required: - - candidateId - - jobId - - candidateName - - status - - hasResults - - createdAt - - updatedAt - - files - properties: - candidateId: - type: string - description: Server-assigned candidate identifier. - jobId: - type: string - description: Owning optimization job id. - candidateName: - type: string - description: Display name of the candidate. - status: - type: string - description: Candidate lifecycle status. - score: - type: number - format: double - description: Candidate's aggregate score. - hasResults: - type: boolean - description: Whether detailed results are available for this candidate. - createdAt: - allOf: - - $ref: '#/components/schemas/FoundryTimestamp' - description: Timestamp when the candidate was created, represented in Unix time. - updatedAt: - allOf: - - $ref: '#/components/schemas/FoundryTimestamp' - description: Timestamp when the candidate was last updated, represented in Unix time. - promotion: - allOf: - - $ref: '#/components/schemas/PromotionInfo' - description: Promotion metadata. Null if not promoted. - files: - type: array - items: - $ref: '#/components/schemas/CandidateFileInfo' - description: Files in the candidate's blob directory. - description: Candidate metadata returned by GET /candidates/{id}. - CandidateResults: - type: object - required: - - candidateId - - results - properties: - candidateId: - type: string - description: Owning candidate id. - results: - type: array - items: - $ref: '#/components/schemas/OptimizationTaskResult' - description: Per-task evaluation rows. - description: Full per-task evaluation results for a candidate, returned by GET /candidates/{id}/results. CaptureStructuredOutputsTool: type: object required: @@ -14305,7 +15798,7 @@ components: description: List of clusters identified in the insights. coordinates: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ChartCoordinate' description: |2- Optional mapping of IDs to 2D coordinates used by the UX for visualization. @@ -14430,8 +15923,6 @@ components: type: string enum: - code_interpreter - description: The type of the code interpreter tool. Always `code_interpreter`. - x-stainless-const: true container: anyOf: - type: string @@ -14502,7 +15993,7 @@ components: readOnly: true metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Metadata of the connection readOnly: true @@ -14540,18 +16031,21 @@ components: items: $ref: '#/components/schemas/ProtocolVersionRecord' description: The protocols that the agent supports for ingress communication of the containers. - example: - - protocol: responses - version: v0.1.1 - - protocol: a2a - version: v0.3.0 + examples: + - - protocol: responses + version: v0.1.1 + - protocol: a2a + version: v0.3.0 container_app_resource_id: type: string description: The resource ID of the Azure Container App that hosts this agent. Not mutable across versions. ingress_subdomain_suffix: type: string description: The suffix to apply to the app subdomain when sending ingress to the agent. This can be a label (e.g., '---current'), a specific revision (e.g., '--0000001'), or empty to use the default endpoint for the container app. - example: --0000001 + examples: + - --0000001 + - ---current + - '' allOf: - $ref: '#/components/schemas/AgentDefinition' description: The container app agent definition. @@ -14566,7 +16060,8 @@ components: image: type: string description: The container image for the hosted agent. - example: my-registry.azurecr.io/my-hosted-agent:latest + examples: + - my-registry.azurecr.io/my-hosted-agent:latest description: Container-based deployment configuration for a hosted agent. x-ms-foundry-meta: required_previews: @@ -14672,6 +16167,13 @@ components: type: integer format: int32 description: Maximum number of evaluation runs allowed per hour. + samplingRate: + type: number + format: double + maximum: 100 + description: Percentage (0-100] chance that a matching event triggers an evaluation. When omitted, the service-default is to evaluate every event, which is equivalent to setting a sampling rate of 100. + exclusiveMinimum: 0 + default: 100 allOf: - $ref: '#/components/schemas/EvaluationRuleAction' description: Evaluation rule action for continuous evaluation. @@ -14701,7 +16203,7 @@ components: default: 5 data_mapping: type: object - additionalProperties: + unevaluatedProperties: type: string description: Mapping from source fields to response_id field, which is required for retrieving chat history. sampling_params: @@ -14764,8 +16266,6 @@ components: - $ref: '#/components/schemas/CreateAgentVersionFromCodeMetadata' description: JSON metadata including description and hosted definition. code: - type: string - format: binary description: The code zip file (max 250 MB). required: - metadata @@ -14787,7 +16287,7 @@ components: - Must not exceed 63 characters. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -14806,7 +16306,7 @@ components: description: The manifest ID to import the agent version from. parameter_values: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The inputs to the manifest that will result in a fully materialized Agent. CreateAgentRequest: type: object @@ -14824,7 +16324,7 @@ components: - Must not exceed 63 characters. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -14899,8 +16399,6 @@ components: - $ref: '#/components/schemas/CreateAgentVersionFromCodeMetadata' description: JSON metadata including description and hosted definition. code: - type: string - format: binary description: The code zip file (max 250 MB). required: - metadata @@ -14916,7 +16414,7 @@ components: description: A human-readable description of the agent. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -14946,7 +16444,7 @@ components: properties: metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -14965,7 +16463,7 @@ components: description: The manifest ID to import the agent version from. parameter_values: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The inputs to the manifest that will result in a fully materialized Agent. CreateAgentVersionRequest: type: object @@ -14974,7 +16472,7 @@ components: properties: metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -15021,10 +16519,9 @@ components: type: string description: The name of the evaluation. metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' data_source_config: oneOf: - $ref: '#/components/schemas/OpenAI.CreateEvalCustomDataSourceConfig' @@ -15046,7 +16543,7 @@ components: description: A list of graders for all eval runs in this group. Graders can reference variables in the data source using double curly braces notation, like `{{item.variable_name}}`. To reference the model's output, use the `sample` namespace (ie, `{{sample.output_text}}`). properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -15061,10 +16558,9 @@ components: type: string description: The name of the run. metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' data_source: oneOf: - $ref: '#/components/schemas/OpenAI.CreateEvalJsonlRunDataSource' @@ -15074,7 +16570,7 @@ components: description: Details about the run's data source. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -15107,9 +16603,7 @@ components: properties: files: type: array - items: - type: string - format: binary + items: {} description: Skill files to upload. Upload a single zip file or multiple individual files with relative paths. default: type: boolean @@ -15175,11 +16669,41 @@ components: - CustomKeys description: The credential type readOnly: true - additionalProperties: + unevaluatedProperties: type: string allOf: - $ref: '#/components/schemas/BaseCredentials' description: Custom credential definition + CustomRoutineTrigger: + type: object + required: + - type + - provider + - parameters + properties: + type: + type: string + enum: + - custom + description: The trigger type. + provider: + type: string + maxLength: 128 + description: The external provider that emits the custom event. + event_name: + type: string + maxLength: 256 + description: The provider-specific event name that fires the routine. + parameters: + type: object + unevaluatedProperties: {} + description: Provider-specific trigger parameters. + allOf: + - $ref: '#/components/schemas/RoutineTrigger' + description: A custom event routine trigger. + x-ms-foundry-meta: + conditional_previews: + - Routines=V1Preview DailyRecurrenceSchedule: type: object required: @@ -15327,7 +16851,7 @@ components: description: Description to assign to the output. Applies only to dataset outputs (evaluation scenario); ignored for Azure OpenAI file outputs. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tags to assign to the output. Applies only to dataset outputs (evaluation scenario); ignored for Azure OpenAI file outputs. description: Output options for data generation job. @@ -15449,11 +16973,12 @@ components: description: The data source type discriminator. schema: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The overall object JSON schema for the run data source items. discriminator: propertyName: type - mapping: {} + mapping: + azure_ai_source: '#/components/schemas/AzureAIDataSourceConfig' description: Base class for run data sources with discriminator support. DatasetDataGenerationJobOutput: type: object @@ -15483,7 +17008,7 @@ components: readOnly: true tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary of the output dataset. readOnly: true @@ -15536,38 +17061,6 @@ components: allOf: - $ref: '#/components/schemas/EvaluatorGenerationJobSource' description: Dataset source for evaluator generation jobs — reference to a dataset. - DatasetInfo: - type: object - required: - - taskCount - - isInline - properties: - name: - type: string - description: Dataset name when using a registered dataset reference. Null for inline datasets. - version: - type: string - description: Dataset version when using a registered dataset reference. Null for inline datasets. - taskCount: - type: integer - format: int32 - description: Number of tasks/rows in the dataset. - isInline: - type: boolean - description: True when the dataset was provided inline in the request body. - description: Metadata about the dataset used for optimization, surfaced in the response. - DatasetRef: - type: object - required: - - name - properties: - name: - type: string - description: Dataset name. - version: - type: string - description: Dataset version. If not specified, the latest version is used. - description: Reference to a registered dataset in the Foundry Dataset Service. DatasetReference: type: object required: @@ -15645,7 +17138,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. discriminator: @@ -15910,7 +17403,7 @@ components: description: Relative weight of this dimension (1-10). The generation pipeline assigns exactly one dimension weight 8-10; all others use 1-6. User edits are not constrained by this heuristic. always_applicable: type: boolean - description: When true, the LLM judge always scores this dimension regardless of relevance (skips applicability assessment). The service-generated general quality/policy dimension has this set to true and is non-editable. Users may set this on their own custom dimensions. Defaults to `false`. + description: When true, the LLM judge always scores this dimension regardless of relevance (skips applicability assessment). The service-generated general quality/policy dimension has this set to true and is non-editable. Users may set this on their own custom dimensions. The service defaults to `false` if a value is not specified by the caller. default: false description: A single dimension — one independent, measurable quality dimension within a rubric evaluator's scoring blueprint. DispatchRoutineRequest: @@ -16034,10 +17527,9 @@ components: format: unixtime description: The Unix timestamp (in seconds) for when the eval was created. metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' modified_at: allOf: - $ref: '#/components/schemas/integer' @@ -16047,7 +17539,7 @@ components: description: the name of the person who created the run. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -16218,10 +17710,9 @@ components: - $ref: '#/components/schemas/EvalRunDataSource' description: Information about the run's data source. metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' error: $ref: '#/components/schemas/OpenAI.EvalApiError' modified_at: @@ -16233,7 +17724,7 @@ components: description: the name of the person who created the run. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -16492,7 +17983,7 @@ components: description: The identifier for the data source item. datasource_item: type: object - additionalProperties: {} + unevaluatedProperties: {} description: Details of the input data source item. results: type: array @@ -16582,9 +18073,10 @@ components: type: boolean description: Whether the grader considered the output a pass. sample: - type: object - additionalProperties: {} - nullable: true + anyOf: + - type: object + unevaluatedProperties: {} + - type: 'null' description: Optional sample or intermediate data produced by the grader. status: allOf: @@ -16605,10 +18097,10 @@ components: description: The reason for the test criteria metric. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Additional details about the test criteria metric. - additionalProperties: {} + unevaluatedProperties: {} description: A single grader result for an evaluation run output item. title: EvalRunOutputItemResult EvalRunOutputItemResultStatus: @@ -16760,17 +18252,17 @@ components: readOnly: true tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Evaluation's tags. Unlike properties, tags are fully mutable. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Evaluation's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. evaluators: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/EvaluatorConfiguration' description: Evaluators to be used for the evaluation. target: @@ -16921,7 +18413,7 @@ components: description: Indicates whether the evaluation rule is enabled. Default is true. systemData: type: object - additionalProperties: + unevaluatedProperties: type: string description: System metadata for the evaluation rule. readOnly: true @@ -17027,6 +18519,7 @@ components: description: Identifier of the evaluation group. evalRun: type: object + unevaluatedProperties: {} description: The evaluation run payload. allOf: - $ref: '#/components/schemas/ScheduleTask' @@ -17132,7 +18625,7 @@ components: default: quality initialization_parameters: type: object - additionalProperties: {} + unevaluatedProperties: {} description: |- Optional initialization parameters applied to all generated evaluators. For example, deployment_name for LLM judge model, default threshold. @@ -17407,7 +18900,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: |- @@ -17476,7 +18969,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: |- @@ -17534,7 +19027,7 @@ components: description: List of taxonomy categories. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Additional properties for the evaluation taxonomy. description: Evaluation Taxonomy Definition @@ -17548,7 +19041,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. taxonomyInput: @@ -17562,7 +19055,7 @@ components: description: List of taxonomy categories. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Additional properties for the evaluation taxonomy. description: Evaluation Taxonomy Definition @@ -17610,7 +19103,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. taxonomyInput: @@ -17624,7 +19117,7 @@ components: description: List of taxonomy categories. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Additional properties for the evaluation taxonomy. description: Evaluation Taxonomy Definition @@ -17647,11 +19140,11 @@ components: description: Identifier of the evaluator. initParams: type: object - additionalProperties: {} + unevaluatedProperties: {} description: Initialization parameters of the evaluator. dataMapping: type: object - additionalProperties: + unevaluatedProperties: type: string description: Data parameters of the evaluator. description: Evaluator Configuration @@ -17679,15 +19172,15 @@ components: description: The type of evaluator definition init_parameters: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The JSON schema (Draft 2020-12) for the evaluator's input parameters. This includes parameters like type, properties, required. data_schema: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The JSON schema (Draft 2020-12) for the evaluator's input data. This includes parameters like type, properties, required. metrics: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/EvaluatorMetric' description: List of output metrics produced by this evaluator discriminator: @@ -17924,7 +19417,7 @@ components: description: Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Metadata about the evaluator evaluator_type: @@ -17936,6 +19429,13 @@ components: items: $ref: '#/components/schemas/EvaluatorCategory' description: The categories of the evaluator + supported_evaluation_levels: + type: array + items: + $ref: '#/components/schemas/EvaluationLevel' + description: Evaluation levels this evaluator supports (e.g., `turn`, `conversation`). When omitted on create, the service defaults to `["turn"]`. On update, omitting this field leaves it unchanged; an empty list is rejected. Custom code-based evaluators support only `turn`; custom prompt-based evaluators support exactly one level (`turn` or `conversation`). + default: + - turn definition: allOf: - $ref: '#/components/schemas/EvaluatorDefinition' @@ -17982,7 +19482,7 @@ components: description: Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Metadata about the evaluator evaluator_type: @@ -17994,6 +19494,13 @@ components: items: $ref: '#/components/schemas/EvaluatorCategory' description: The categories of the evaluator + supported_evaluation_levels: + type: array + items: + $ref: '#/components/schemas/EvaluationLevel' + description: Evaluation levels this evaluator supports (e.g., `turn`, `conversation`). When omitted on create, the service defaults to `["turn"]`. On update, omitting this field leaves it unchanged; an empty list is rejected. Custom code-based evaluators support only `turn`; custom prompt-based evaluators support exactly one level (`turn` or `conversation`). + default: + - turn definition: allOf: - $ref: '#/components/schemas/EvaluatorDefinition' @@ -18003,7 +19510,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Evaluator Definition @@ -18015,7 +19522,7 @@ components: description: Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Metadata about the evaluator categories: @@ -18023,12 +19530,19 @@ components: items: $ref: '#/components/schemas/EvaluatorCategory' description: The categories of the evaluator + supported_evaluation_levels: + type: array + items: + $ref: '#/components/schemas/EvaluationLevel' + description: Evaluation levels this evaluator supports (e.g., `turn`, `conversation`). When omitted on create, the service defaults to `["turn"]`. On update, omitting this field leaves it unchanged; an empty list is rejected. Custom code-based evaluators support only `turn`; custom prompt-based evaluators support exactly one level (`turn` or `conversation`). + default: + - turn description: type: string description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Evaluator Definition @@ -18143,12 +19657,9 @@ components: description: (Optional) The URL of the FabricIQ MCP server. If not provided, the URL from the project connection will be used. require_approval: anyOf: - - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' - nullable: true + - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' - type: string - nullable: true + - type: 'null' description: (Optional) Whether the agent requires approval before executing actions. Default is always. default: always name: @@ -18170,7 +19681,6 @@ components: type: string enum: - fabric_iq_preview - description: The object type, which is always 'fabric_iq_preview'. project_connection_id: type: string description: The ID of the FabricIQ project connection. @@ -18183,12 +19693,9 @@ components: description: (Optional) The URL of the FabricIQ MCP server. If not provided, the URL from the project connection will be used. require_approval: anyOf: - - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' - nullable: true + - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' - type: string - nullable: true + - type: 'null' description: (Optional) Whether the agent requires approval before executing actions. Default is always. default: always allOf: @@ -18269,9 +19776,6 @@ components: type: string enum: - file_search - description: The type of the file search tool. Always `file_search`. - x-stainless-const: true - default: file_search max_num_results: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -18281,9 +19785,9 @@ components: - $ref: '#/components/schemas/OpenAI.RankingOptions' description: Ranking options for search. filters: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Filters' - nullable: true + - type: 'null' vector_store_ids: type: array items: @@ -18419,34 +19923,50 @@ components: type: string description: The arguments to call the function with, as generated by the model in JSON format. description: Details of a function tool call. - GitHubIssueOpenedRoutineTrigger: + GitHubIssueEvent: + anyOf: + - type: string + - type: string + enum: + - opened + - closed + description: Known GitHub issue events that can fire a routine. + x-ms-foundry-meta: + conditional_previews: + - Routines=V1Preview + GitHubIssueRoutineTrigger: type: object required: - type - connection_id - - assignee + - owner - repository + - issue_event properties: type: type: string enum: - - github_issue_opened + - github_issue description: The trigger type. connection_id: type: string maxLength: 256 description: The workspace connection identifier that resolves the GitHub configuration for the trigger. - assignee: + owner: type: string maxLength: 128 - description: The GitHub assignee or organization filter that scopes which issues can fire the trigger. + description: The GitHub owner or organization that scopes which issues can fire the trigger. repository: type: string maxLength: 128 description: The GitHub repository filter that scopes which issues can fire the trigger. + issue_event: + allOf: + - $ref: '#/components/schemas/GitHubIssueEvent' + description: The GitHub issue event that fires the routine. allOf: - $ref: '#/components/schemas/RoutineTrigger' - description: A GitHub issue-opened routine trigger. + description: A GitHub issue routine trigger. x-ms-foundry-meta: conditional_previews: - Routines=V1Preview @@ -18480,15 +20000,18 @@ components: header_name: type: string description: The name of the HTTP header to inject the secret value into. - example: X-Otlp-Api-Key + examples: + - X-Otlp-Api-Key secret_id: type: string description: The identifier of the secret store or connection. - example: my-secret-store + examples: + - my-secret-store secret_key: type: string description: The key within the secret to retrieve the authentication value. - example: OTLP_KEY + examples: + - OTLP_KEY allOf: - $ref: '#/components/schemas/TelemetryEndpointAuth' description: Header-based secret authentication for a telemetry endpoint. The resolved secret value is injected as an HTTP header. @@ -18516,19 +20039,21 @@ components: cpu: type: string description: The CPU configuration for the hosted agent. - example: '0.25' + examples: + - '0.25' memory: type: string description: The memory configuration for the hosted agent. - example: 0.5Gi + examples: + - 0.5Gi environment_variables: type: object - additionalProperties: + unevaluatedProperties: type: string description: Environment variables to set in the hosted agent container. - example: - name: LOG_LEVEL - value: debug + examples: + - name: LOG_LEVEL + value: debug container_configuration: allOf: - $ref: '#/components/schemas/ContainerConfiguration' @@ -18541,11 +20066,11 @@ components: items: $ref: '#/components/schemas/ProtocolVersionRecord' description: The protocols that the agent supports for ingress communication. - example: - - protocol: responses - version: v0.1.1 - - protocol: a2a - version: v0.3.0 + examples: + - - protocol: responses + version: v0.1.1 + - protocol: a2a + version: v0.3.0 x-ms-foundry-meta: required_previews: - CodeAgents=V1Preview @@ -18664,7 +20189,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. discriminator: @@ -18837,11 +20362,11 @@ components: description: Sample type features: type: object - additionalProperties: {} + unevaluatedProperties: {} description: Features to help with additional filtering of data in UX. correlationInfo: type: object - additionalProperties: {} + unevaluatedProperties: {} description: Info about the correlation for the analysis sample. discriminator: propertyName: type @@ -18921,6 +20446,7 @@ components: type: object required: - type + - input properties: type: type: string @@ -18928,9 +20454,7 @@ components: - invoke_agent_invocations_api description: The manual dispatch payload type. input: - type: string - maxLength: 32768 - description: The raw input sent to the downstream invocations target. + description: The JSON value sent as the complete downstream invocations input. The value is passed through as-is and can be an object, string, number, boolean, array, or null. allOf: - $ref: '#/components/schemas/RoutineDispatchPayload' description: A manual payload used to test an invocations API routine dispatch. @@ -18941,24 +20465,29 @@ components: type: object required: - type - - agent_endpoint_id properties: type: type: string enum: - invoke_agent_invocations_api description: The action type. + agent_name: + type: string + maxLength: 256 + description: The project-scoped agent name for routine dispatch. agent_endpoint_id: type: string maxLength: 256 - description: The endpoint-scoped agent identifier for invocations API dispatch. + description: Legacy endpoint-scoped agent identifier for routine dispatch. + input: + description: Static JSON value sent as the complete downstream input when the routine fires. The value is passed through as-is; no templating is applied. session_id: type: string maxLength: 256 description: An optional existing hosted-agent session identifier to continue during the downstream dispatch. allOf: - $ref: '#/components/schemas/RoutineAction' - description: Dispatches a routine through the raw invocations API. + description: Dispatches a routine through the raw invocations API. Exactly one of agent_name or agent_endpoint_id must be provided. x-ms-foundry-meta: conditional_previews: - Routines=V1Preview @@ -18966,6 +20495,7 @@ components: type: object required: - type + - input properties: type: type: string @@ -18973,9 +20503,7 @@ components: - invoke_agent_responses_api description: The manual dispatch payload type. input: - type: string - maxLength: 32768 - description: The user input sent to the downstream responses target. + description: The JSON value sent as the complete downstream responses input. The value is passed through as-is and can be an object, string, number, boolean, array, or null. allOf: - $ref: '#/components/schemas/RoutineDispatchPayload' description: A manual payload used to test a responses API routine dispatch. @@ -18995,12 +20523,14 @@ components: agent_name: type: string maxLength: 256 - description: The project-scoped agent name for responses API dispatch. + description: The project-scoped agent name for routine dispatch. agent_endpoint_id: type: string maxLength: 256 - description: The endpoint-scoped agent identifier for responses API dispatch. - conversation_id: + description: Legacy endpoint-scoped agent identifier for routine dispatch. + input: + description: Static JSON value sent as the complete downstream input when the routine fires. The value is passed through as-is; no templating is applied. + conversation: type: string maxLength: 256 description: An optional existing conversation identifier to continue during the downstream dispatch. @@ -19052,6 +20582,7 @@ components: red_team_taxonomy: '#/components/schemas/RedTeamTaxonomyItemGenerationParams' response_retrieval: '#/components/schemas/ResponseRetrievalItemGenerationParams' conversation_gen_preview: '#/components/schemas/ConversationGenPreviewItemGenerationParams' + synthetic_data_gen_preview: '#/components/schemas/SyntheticDataGenerationPreviewItemGenerationParams' description: Represents the set of parameters used to control item generation operations. ItemGenerationParamsType: anyOf: @@ -19107,8 +20638,6 @@ components: type: string enum: - mcp - description: The type of the MCP tool. Always `mcp`. - x-stainless-const: true server_label: type: string description: A label for this MCP server, used to identify it in tool calls. @@ -19152,32 +20681,30 @@ components: type: string description: Optional description of the MCP server, used to provide more context. headers: - type: object - additionalProperties: - type: string - nullable: true + anyOf: + - type: object + unevaluatedProperties: + type: string + - type: 'null' allowed_tools: anyOf: - type: array items: type: string - nullable: true - - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.MCPToolFilter' - nullable: true + - $ref: '#/components/schemas/OpenAI.MCPToolFilter' + - type: 'null' require_approval: anyOf: - - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' - nullable: true + - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' - type: string enum: - always - never - nullable: true + - type: 'null' default: always + defer_loading: + type: boolean + description: Whether this MCP tool is deferred and discovered via tool search. project_connection_id: type: string description: The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server. @@ -19477,10 +21004,11 @@ components: - $ref: '#/components/schemas/ToolCallStatus' description: The status of the tool call. memories: - type: array - items: - $ref: '#/components/schemas/MemoryItem' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/MemoryItem' + - type: 'null' description: The results returned from the memory search. allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' @@ -19532,7 +21060,7 @@ components: default: true procedural_memory_enabled: type: boolean - description: Whether to enable procedural memory extraction and storage. Defaults to `true`. + description: Whether to enable procedural memory extraction and storage. The service defaults to `true` if a value is not specified by the caller. default: true default_ttl_seconds: type: integer @@ -19632,7 +21160,7 @@ components: description: A human-readable description of the memory store. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Arbitrary key-value metadata to associate with the memory store. definition: @@ -19851,7 +21379,7 @@ components: readOnly: true capabilities: type: object - additionalProperties: + unevaluatedProperties: type: string description: Capabilities of deployed model readOnly: true @@ -20000,7 +21528,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Model Version Definition @@ -20142,7 +21670,6 @@ components: - create_file description: Create a new file with the provided diff. x-stainless-const: true - default: create_file path: type: string description: Path of the file to create. @@ -20166,7 +21693,6 @@ components: - create_file description: The operation type. Always `create_file`. x-stainless-const: true - default: create_file path: type: string minLength: 1 @@ -20191,7 +21717,6 @@ components: - delete_file description: Delete the specified file. x-stainless-const: true - default: delete_file path: type: string description: Path of the file to delete. @@ -20211,7 +21736,6 @@ components: - delete_file description: The operation type. Always `delete_file`. x-stainless-const: true - default: delete_file path: type: string minLength: 1 @@ -20277,7 +21801,6 @@ components: - apply_patch description: The type of the tool. Always `apply_patch`. x-stainless-const: true - default: apply_patch allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: Allows the assistant to create, delete, or update files using unified diffs. @@ -20295,7 +21818,6 @@ components: - update_file description: Update an existing file with the provided diff. x-stainless-const: true - default: update_file path: type: string description: Path of the file to update. @@ -20319,7 +21841,6 @@ components: - update_file description: The operation type. Always `update_file`. x-stainless-const: true - default: update_file path: type: string minLength: 1 @@ -20345,17 +21866,21 @@ components: x-stainless-const: true default: approximate country: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' region: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' city: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' timezone: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' OpenAI.AutoCodeInterpreterToolParam: type: object required: @@ -20375,9 +21900,9 @@ components: maxItems: 50 description: An optional list of uploaded files to make available to your code. memory_limit: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ContainerMemoryLimit' - nullable: true + - type: 'null' network_policy: $ref: '#/components/schemas/OpenAI.ContainerNetworkPolicyParam' description: Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. @@ -20401,6 +21926,12 @@ components: OpenAI.ChatModel: type: string enum: + - gpt-5.4 + - gpt-5.4-mini + - gpt-5.4-nano + - gpt-5.4-mini-2026-03-17 + - gpt-5.4-nano-2026-03-17 + - gpt-5.3-chat-latest - gpt-5.2 - gpt-5.2-2025-12-11 - gpt-5.2-chat-latest @@ -20495,7 +22026,6 @@ components: - click description: Specifies the event type. For a click action, this property is always `click`. x-stainless-const: true - default: click button: allOf: - $ref: '#/components/schemas/OpenAI.ClickButtonType' @@ -20508,6 +22038,12 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The y-coordinate where the click occurred. + keys: + anyOf: + - type: array + items: + type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A click action. @@ -20625,13 +22161,27 @@ components: - type: array items: $ref: '#/components/schemas/OpenAI.InputItem' - nullable: true + - type: 'null' previous_response_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' instructions: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' + prompt_cache_key: + anyOf: + - type: string + - type: 'null' + prompt_cache_retention: + anyOf: + - $ref: '#/components/schemas/OpenAI.PromptCacheRetentionEnum' + - type: 'null' + service_tier: + anyOf: + - $ref: '#/components/schemas/OpenAI.ServiceTierEnum' + - type: 'null' OpenAI.ComparisonFilter: type: object required: @@ -20648,6 +22198,8 @@ components: - gte - lt - lte + - in + - nin description: |- Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`. - `eq`: equals @@ -20719,6 +22271,14 @@ components: scroll: '#/components/schemas/OpenAI.ScrollParam' type: '#/components/schemas/OpenAI.TypeParam' wait: '#/components/schemas/OpenAI.WaitParam' + OpenAI.ComputerActionList: + type: array + items: + $ref: '#/components/schemas/OpenAI.ComputerAction' + description: |- + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + title: Computer Action List OpenAI.ComputerActionType: anyOf: - type: string @@ -20742,11 +22302,13 @@ components: type: string description: The ID of the pending safety check. code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' message: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' description: A pending safety check for the computer call. OpenAI.ComputerEnvironment: type: string @@ -20762,6 +22324,7 @@ components: - type - image_url - file_id + - detail properties: type: type: string @@ -20769,14 +22332,19 @@ components: - computer_screenshot description: Specifies the event type. For a computer screenshot, this property is always set to `computer_screenshot`. x-stainless-const: true - default: computer_screenshot image_url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' + detail: + allOf: + - $ref: '#/components/schemas/OpenAI.ImageDetail' + description: The detail level of the screenshot image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. allOf: - $ref: '#/components/schemas/OpenAI.MessageContent' description: A screenshot of a computer. @@ -20803,6 +22371,21 @@ components: type: string description: The identifier of an uploaded file that contains the screenshot. description: A computer screenshot image used with the computer use tool. + OpenAI.ComputerTool: + type: object + required: + - type + properties: + type: + type: string + enum: + - computer + description: The type of the computer tool. Always `computer`. + x-stainless-const: true + allOf: + - $ref: '#/components/schemas/OpenAI.Tool' + description: A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + title: Computer OpenAI.ComputerUsePreviewTool: type: object required: @@ -20817,7 +22400,6 @@ components: - computer_use_preview description: The type of the computer use tool. Always `computer_use_preview`. x-stainless-const: true - default: computer_use_preview environment: allOf: - $ref: '#/components/schemas/OpenAI.ComputerEnvironment' @@ -20845,7 +22427,6 @@ components: - container_auto description: Automatically creates a container for this request x-stainless-const: true - default: container_auto file_ids: type: array items: @@ -20853,9 +22434,9 @@ components: maxItems: 50 description: An optional list of uploaded files to make available to your code. memory_limit: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ContainerMemoryLimit' - nullable: true + - type: 'null' skills: type: array items: @@ -20882,7 +22463,6 @@ components: - container_file_citation description: The type of the container file citation. Always `container_file_citation`. x-stainless-const: true - default: container_file_citation container_id: type: string description: The ID of the container file. @@ -20923,19 +22503,12 @@ components: - allowlist description: Allow outbound network access only to specified domains. Always `allowlist`. x-stainless-const: true - default: allowlist allowed_domains: type: array items: type: string minItems: 1 description: A list of allowed domains when type is `allowlist`. - domain_secrets: - type: array - items: - $ref: '#/components/schemas/OpenAI.ContainerNetworkPolicyDomainSecretParam' - minItems: 1 - description: Optional domain-scoped secrets for allowlisted domains. allOf: - $ref: '#/components/schemas/OpenAI.ContainerNetworkPolicyParam' OpenAI.ContainerNetworkPolicyDisabledParam: @@ -20949,29 +22522,8 @@ components: - disabled description: Disable outbound network access. Always `disabled`. x-stainless-const: true - default: disabled allOf: - $ref: '#/components/schemas/OpenAI.ContainerNetworkPolicyParam' - OpenAI.ContainerNetworkPolicyDomainSecretParam: - type: object - required: - - domain - - name - - value - properties: - domain: - type: string - minLength: 1 - description: The domain associated with the secret. - name: - type: string - minLength: 1 - description: The name of the secret to inject for the domain. - value: - type: string - minLength: 1 - maxLength: 10485760 - description: The secret value to inject for the domain. OpenAI.ContainerNetworkPolicyParam: type: object required: @@ -21004,7 +22556,6 @@ components: - container_reference description: The environment type. Always `container_reference`. x-stainless-const: true - default: container_reference container_id: type: string allOf: @@ -21039,10 +22590,9 @@ components: type: string description: The context management entry type. Currently only 'compaction' is supported. compact_threshold: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' OpenAI.ConversationItem: type: object required: @@ -21054,14 +22604,18 @@ components: propertyName: type mapping: message: '#/components/schemas/OpenAI.ConversationItemMessage' - function_call: '#/components/schemas/OpenAI.ConversationItemFunctionToolCallResource' - function_call_output: '#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutputResource' + function_call: '#/components/schemas/OpenAI.ConversationItemFunctionToolCall' + function_call_output: '#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutput' file_search_call: '#/components/schemas/OpenAI.ConversationItemFileSearchToolCall' web_search_call: '#/components/schemas/OpenAI.ConversationItemWebSearchToolCall' image_generation_call: '#/components/schemas/OpenAI.ConversationItemImageGenToolCall' computer_call: '#/components/schemas/OpenAI.ConversationItemComputerToolCall' - computer_call_output: '#/components/schemas/OpenAI.ConversationItemComputerToolCallOutputResource' + computer_call_output: '#/components/schemas/OpenAI.ConversationItemComputerToolCallOutput' + tool_search_call: '#/components/schemas/OpenAI.ConversationItemToolSearchCall' + tool_search_output: '#/components/schemas/OpenAI.ConversationItemToolSearchOutput' + additional_tools: '#/components/schemas/OpenAI.ConversationItemAdditionalTools' reasoning: '#/components/schemas/OpenAI.ConversationItemReasoningItem' + compaction: '#/components/schemas/OpenAI.ConversationItemCompactionBody' code_interpreter_call: '#/components/schemas/OpenAI.ConversationItemCodeInterpreterToolCall' local_shell_call: '#/components/schemas/OpenAI.ConversationItemLocalShellToolCall' local_shell_call_output: '#/components/schemas/OpenAI.ConversationItemLocalShellToolCallOutput' @@ -21073,10 +22627,39 @@ components: mcp_approval_request: '#/components/schemas/OpenAI.ConversationItemMcpApprovalRequest' mcp_approval_response: '#/components/schemas/OpenAI.ConversationItemMcpApprovalResponseResource' mcp_call: '#/components/schemas/OpenAI.ConversationItemMcpToolCall' - custom_tool_call: '#/components/schemas/OpenAI.ConversationItemCustomToolCall' - custom_tool_call_output: '#/components/schemas/OpenAI.ConversationItemCustomToolCallOutput' + custom_tool_call: '#/components/schemas/OpenAI.ConversationItemCustomToolCallResource' + custom_tool_call_output: '#/components/schemas/OpenAI.ConversationItemCustomToolCallOutputResource' description: A single item within a conversation. The set of possible types are the same as the `output` type of a [Response object](/docs/api-reference/responses/object#responses/object-output). title: Conversation item + OpenAI.ConversationItemAdditionalTools: + type: object + required: + - type + - id + - role + - tools + properties: + type: + type: string + enum: + - additional_tools + description: The type of the item. Always `additional_tools`. + x-stainless-const: true + default: additional_tools + id: + type: string + description: The unique ID of the additional tools item. + role: + allOf: + - $ref: '#/components/schemas/OpenAI.MessageRole' + description: The role that provided the additional tools. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The additional tool definitions made available at this item. + allOf: + - $ref: '#/components/schemas/OpenAI.ConversationItem' OpenAI.ConversationItemApplyPatchToolCall: type: object required: @@ -21141,8 +22724,9 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call output. @@ -21183,26 +22767,54 @@ components: type: string description: The ID of the container used to run the code. code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' outputs: - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - nullable: true + anyOf: + - type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: A tool call to run code. title: Code interpreter tool call + OpenAI.ConversationItemCompactionBody: + type: object + required: + - type + - id + - encrypted_content + properties: + type: + type: string + enum: + - compaction + description: The type of the item. Always `compaction`. + x-stainless-const: true + default: compaction + id: + type: string + description: The unique ID of the compaction item. + encrypted_content: + type: string + description: The encrypted content that was produced by compaction. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ConversationItem' + description: A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact). + title: Compaction item OpenAI.ConversationItemComputerToolCall: type: object required: - type - id - call_id - - action - pending_safety_checks - status properties: @@ -21220,6 +22832,8 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' + actions: + $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -21240,10 +22854,11 @@ components: A tool call to a computer use tool. See the [computer use guide](/docs/guides/tools-computer-use) for more information. title: Computer tool call - OpenAI.ConversationItemComputerToolCallOutputResource: + OpenAI.ConversationItemComputerToolCallOutput: type: object required: - type + - id - call_id - output properties: @@ -21257,6 +22872,7 @@ components: id: type: string description: The ID of the computer tool call output. + readOnly: true call_id: type: string description: The ID of the computer tool call that produced the output. @@ -21280,68 +22896,91 @@ components: `incomplete`. Populated when input items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - OpenAI.ConversationItemCustomToolCall: + description: The output of a computer tool call. + title: Computer tool call output + OpenAI.ConversationItemCustomToolCallOutputResource: type: object required: - type - call_id - - name - - input + - output + - status properties: type: type: string enum: - - custom_tool_call - description: The type of the custom tool call. Always `custom_tool_call`. + - custom_tool_call_output + description: The type of the custom tool call output. Always `custom_tool_call_output`. x-stainless-const: true id: type: string - description: The unique ID of the custom tool call in the OpenAI platform. + description: The unique ID of the custom tool call output in the OpenAI platform. call_id: type: string - description: An identifier used to map this custom tool call to a tool call output. - name: - type: string - description: The name of the custom tool being called. - input: + description: The call ID, used to map this custom tool call output to a custom tool call. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + created_by: type: string - description: The input for the custom tool call generated by the model. + description: The identifier of the actor that created the item. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - description: A call to a custom tool created by the model. - title: Custom tool call - OpenAI.ConversationItemCustomToolCallOutput: + title: ResponseCustomToolCallOutputItem + OpenAI.ConversationItemCustomToolCallResource: type: object required: - type - call_id - - output + - name + - input + - status properties: type: type: string enum: - - custom_tool_call_output - description: The type of the custom tool call output. Always `custom_tool_call_output`. + - custom_tool_call + description: The type of the custom tool call. Always `custom_tool_call`. x-stainless-const: true id: type: string - description: The unique ID of the custom tool call output in the OpenAI platform. + description: The unique ID of the custom tool call in the OpenAI platform. call_id: type: string - description: The call ID, used to map this custom tool call output to a custom tool call. - output: - oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: An identifier used to map this custom tool call to a tool call output. + namespace: + type: string + description: The namespace of the custom tool being called. + name: + type: string + description: The name of the custom tool being called. + input: + type: string + description: The input for the custom tool call generated by the model. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' description: |- - The output from the custom tool call generated by your code. - Can be a string or an list of output content. + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + created_by: + type: string + description: The identifier of the actor that created the item. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - description: The output of a custom tool call from your code, being sent back to the model. - title: Custom tool call output + title: ResponseCustomToolCallItem OpenAI.ConversationItemFileSearchToolCall: type: object required: @@ -21376,10 +23015,11 @@ components: type: string description: The queries used to search for files. results: - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: |- @@ -21415,13 +23055,12 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - nullable: true + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call. @@ -21454,7 +23093,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -21462,10 +23101,9 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' created_by: type: string description: The identifier of the actor that created the item. @@ -21473,36 +23111,37 @@ components: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: The output of a shell tool call that was emitted. title: Shell call output - OpenAI.ConversationItemFunctionToolCallOutputResource: + OpenAI.ConversationItemFunctionToolCall: type: object required: + - id - type - call_id - - output + - name + - arguments properties: id: type: string - description: |- - The unique ID of the function tool call output. Populated when this item - is returned via API. + description: The unique ID of the function tool call. + readOnly: true type: type: string enum: - - function_call_output - description: The type of the function tool call output. Always `function_call_output`. + - function_call + description: The type of the function tool call. Always `function_call`. x-stainless-const: true call_id: type: string description: The unique ID of the function tool call generated by the model. - output: - oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' - description: |- - The output from the function call generated by your code. - Can be a string or an list of output content. + namespace: + type: string + description: The namespace of the function to run. + name: + type: string + description: The name of the function to run. + arguments: + type: string + description: A JSON string of the arguments to pass to the function. status: type: string enum: @@ -21514,32 +23153,42 @@ components: `incomplete`. Populated when items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - OpenAI.ConversationItemFunctionToolCallResource: + description: |- + A tool call to run a function. See the + [function calling guide](/docs/guides/function-calling) for more information. + title: Function tool call + OpenAI.ConversationItemFunctionToolCallOutput: type: object required: + - id - type - call_id - - name - - arguments + - output properties: id: type: string - description: The unique ID of the function tool call. + description: |- + The unique ID of the function tool call output. Populated when this item + is returned via API. + readOnly: true type: type: string enum: - - function_call - description: The type of the function tool call. Always `function_call`. + - function_call_output + description: The type of the function tool call output. Always `function_call_output`. x-stainless-const: true call_id: type: string description: The unique ID of the function tool call generated by the model. - name: - type: string - description: The name of the function to run. - arguments: - type: string - description: A JSON string of the arguments to pass to the function. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the function call generated by your code. + Can be a string or an list of output content. status: type: string enum: @@ -21551,6 +23200,8 @@ components: `incomplete`. Populated when items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' + description: The output of a function tool call. + title: Function tool call output OpenAI.ConversationItemImageGenToolCall: type: object required: @@ -21577,8 +23228,9 @@ components: - failed description: The status of the image generation call. result: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: An image generation request made by the model. @@ -21673,12 +23325,13 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - type: string - enum: - - in_progress - - completed - - incomplete - nullable: true + anyOf: + - type: string + enum: + - in_progress + - completed + - incomplete + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: The output of a local shell tool call. @@ -21738,8 +23391,9 @@ components: type: boolean description: Whether the request was approved. reason: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: A response to an MCP approval request. @@ -21770,8 +23424,7 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - type: string - nullable: true + $ref: '#/components/schemas/OpenAI.RealtimeMCPError' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: A list of tools available on an MCP server. @@ -21804,18 +23457,20 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' error: type: object - additionalProperties: {} + unevaluatedProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: An invocation of a tool on an MCP server. @@ -21852,6 +23507,10 @@ components: items: $ref: '#/components/schemas/OpenAI.MessageContent' description: The content of the message + phase: + anyOf: + - $ref: '#/components/schemas/OpenAI.MessagePhase' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: A message to or from the model. @@ -21873,8 +23532,9 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' summary: type: array items: @@ -21902,6 +23562,87 @@ components: for subsequent turns of a conversation if you are manually [managing context](/docs/guides/conversation-state). title: Reasoning + OpenAI.ConversationItemToolSearchCall: + type: object + required: + - type + - id + - call_id + - execution + - arguments + - status + properties: + type: + type: string + enum: + - tool_search_call + description: The type of the item. Always `tool_search_call`. + x-stainless-const: true + default: tool_search_call + id: + type: string + description: The unique ID of the tool search call item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + arguments: + description: Arguments used for the tool search call. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' + description: The status of the tool search call item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ConversationItem' + OpenAI.ConversationItemToolSearchOutput: + type: object + required: + - type + - id + - call_id + - execution + - tools + - status + properties: + type: + type: string + enum: + - tool_search_output + description: The type of the item. Always `tool_search_output`. + x-stainless-const: true + default: tool_search_output + id: + type: string + description: The unique ID of the tool search output item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The loaded tool definitions returned by tool search. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' + description: The status of the tool search output item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ConversationItem' OpenAI.ConversationItemType: anyOf: - type: string @@ -21915,7 +23656,11 @@ components: - image_generation_call - computer_call - computer_call_output + - tool_search_call + - tool_search_output + - additional_tools - reasoning + - compaction - code_interpreter_call - local_shell_call - local_shell_call_output @@ -22051,6 +23796,7 @@ components: mapping: text: '#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText' json_object: '#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject' + json_schema: '#/components/schemas/OpenAI.ResponseFormatJsonSchema' description: |- An object specifying the format that the model must output. Setting to `{ "type": "json_schema", "json_schema": {...} }` enables @@ -22106,15 +23852,15 @@ components: type: object properties: metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' items: - type: array - items: - $ref: '#/components/schemas/OpenAI.InputItem' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.InputItem' + - type: 'null' OpenAI.CreateEvalCompletionsRunDataSource: type: object required: @@ -22235,7 +23981,7 @@ components: default: custom item_schema: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The json schema for each row in the data source. include_sample_schema: type: boolean @@ -22307,7 +24053,7 @@ components: default: logs metadata: type: object - additionalProperties: {} + unevaluatedProperties: {} description: Metadata filters for the logs data source. description: |- A data source config which specifies the metadata property of your logs query. @@ -22452,7 +24198,7 @@ components: default: stored_completions metadata: type: object - additionalProperties: {} + unevaluatedProperties: {} description: Metadata filters for the stored completions data source. description: Deprecated in favor of LogsDataSourceConfig. title: StoredCompletionsDataSourceConfig @@ -22502,16 +24248,18 @@ components: This value is now deprecated in favor of `method`, and should be passed in under the `method` parameter. deprecated: true suffix: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' minLength: 1 maxLength: 64 description: |- A string of up to 64 characters that will be added to your fine-tuned model name. For example, a `suffix` of "custom-model-name" would produce a model name like `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`. validation_file: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' description: |- The ID of an uploaded file that contains validation data. If you provide this file, the data is used to generate validation @@ -22521,16 +24269,16 @@ components: Your dataset must be formatted as a JSONL file. You must upload your file with the purpose `fine-tune`. See the [fine-tuning guide](/docs/guides/model-optimization) for more details. integrations: - type: array - items: - $ref: '#/components/schemas/OpenAI.CreateFineTuningJobRequestIntegrations' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.CreateFineTuningJobRequestIntegrations' + - type: 'null' description: A list of integrations to enable for your fine-tuning job. seed: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' minimum: 0 maximum: 2147483647 description: |- @@ -22539,10 +24287,9 @@ components: method: $ref: '#/components/schemas/OpenAI.FineTuneMethod' metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' OpenAI.CreateFineTuningJobRequestHyperparameters: type: object properties: @@ -22588,11 +24335,13 @@ components: project: type: string name: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' entity: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' tags: type: array items: @@ -22665,7 +24414,6 @@ components: - grammar description: Grammar format. Always `grammar`. x-stainless-const: true - default: grammar syntax: allOf: - $ref: '#/components/schemas/OpenAI.GrammarSyntax1' @@ -22688,7 +24436,6 @@ components: - text description: Unconstrained text format. Always `text`. x-stainless-const: true - default: text allOf: - $ref: '#/components/schemas/OpenAI.CustomToolParamFormat' description: Unconstrained free-form text. @@ -22705,7 +24452,6 @@ components: - custom description: The type of the custom tool. Always `custom`. x-stainless-const: true - default: custom name: type: string description: The name of the custom tool, used to identify it in tool calls. @@ -22716,6 +24462,9 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.CustomToolParamFormat' description: The input format for the custom tool. Default is unconstrained text. + defer_loading: + type: boolean + description: Whether this tool should be deferred and discovered via tool search. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools) @@ -22763,12 +24512,14 @@ components: - low - high - auto + - original OpenAI.DoubleClickAction: type: object required: - type - x - 'y' + - keys properties: type: type: string @@ -22776,7 +24527,6 @@ components: - double_click description: Specifies the event type. For a double click action, this property is always set to `double_click`. x-stainless-const: true - default: double_click x: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -22785,6 +24535,12 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The y-coordinate where the double click occurred. + keys: + anyOf: + - type: array + items: + type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A double click action. @@ -22801,7 +24557,6 @@ components: - drag description: Specifies the event type. For a drag action, this property is always set to `drag`. x-stainless-const: true - default: drag path: type: array items: @@ -22814,6 +24569,12 @@ components: { x: 200, y: 300 } ] ``` + keys: + anyOf: + - type: array + items: + type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A drag action. @@ -22842,6 +24603,10 @@ components: description: |- Text, image, or audio input to the model, used to generate a response. Can also contain previous assistant responses. + phase: + anyOf: + - $ref: '#/components/schemas/OpenAI.MessagePhase' + - type: 'null' type: type: string enum: @@ -22866,6 +24631,8 @@ components: `assistant` role are presumed to have been generated by the model in previous interactions. title: Input message + OpenAI.EmptyModelParam: + type: object OpenAI.Error: type: object required: @@ -22873,13 +24640,15 @@ components: - message properties: code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' message: type: string param: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' type: type: string details: @@ -22888,10 +24657,10 @@ components: $ref: '#/components/schemas/OpenAI.Error' additionalInfo: type: object - additionalProperties: {} + unevaluatedProperties: {} debugInfo: type: object - additionalProperties: {} + unevaluatedProperties: {} OpenAI.EvalApiError: type: object required: @@ -23021,26 +24790,22 @@ components: type: object properties: seed: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' top_p: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' default: 1 temperature: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' max_completions_tokens: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' reasoning_effort: $ref: '#/components/schemas/OpenAI.ReasoningEffort' OpenAI.EvalGraderStringCheck: @@ -23293,10 +25058,10 @@ components: properties: item: type: object - additionalProperties: {} + unevaluatedProperties: {} sample: type: object - additionalProperties: {} + unevaluatedProperties: {} OpenAI.EvalJsonlFileIdSource: type: object required: @@ -23325,49 +25090,50 @@ components: - responses description: The type of run data source. Always `responses`. metadata: - type: object - additionalProperties: {} - nullable: true + anyOf: + - type: object + unevaluatedProperties: {} + - type: 'null' model: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' instructions_search: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' created_after: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' created_before: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' reasoning_effort: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ReasoningEffort' - nullable: true + - type: 'null' temperature: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' top_p: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' users: - type: array - items: - type: string - nullable: true + anyOf: + - type: array + items: + type: string + - type: 'null' tools: - type: array - items: - type: string - nullable: true + anyOf: + - type: array + items: + type: string + - type: 'null' description: A EvalResponsesSource object describing a run data source configuration. title: EvalResponsesSource x-oaiMeta: @@ -23513,28 +25279,25 @@ components: x-stainless-const: true default: stored_completions metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' model: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' created_after: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' created_before: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' limit: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' description: A StoredCompletionsRunDataSource configuration describing a set of filters title: StoredCompletionsRunDataSource x-oaiMeta: @@ -23563,7 +25326,6 @@ components: - file_citation description: The type of the file citation. Always `file_citation`. x-stainless-const: true - default: file_citation file_id: type: string description: The ID of the file. @@ -23578,6 +25340,11 @@ components: - $ref: '#/components/schemas/OpenAI.Annotation' description: A citation to a file. title: File citation + OpenAI.FileInputDetail: + type: string + enum: + - low + - high OpenAI.FilePath: type: object required: @@ -23614,7 +25381,6 @@ components: - file_search description: The type of the file search tool. Always `file_search`. x-stainless-const: true - default: file_search vector_store_ids: type: array items: @@ -23629,9 +25395,9 @@ components: - $ref: '#/components/schemas/OpenAI.RankingOptions' description: Ranking options for search. filters: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Filters' - nullable: true + - type: 'null' name: type: string description: Optional user-defined name for this tool or configuration. @@ -23652,10 +25418,9 @@ components: filename: type: string attributes: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.VectorStoreFileAttributes' - nullable: true + - type: 'null' score: type: number format: float @@ -23863,11 +25628,13 @@ components: project: type: string name: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' entity: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' tags: type: array items: @@ -23899,17 +25666,20 @@ components: format: unixtime description: The Unix timestamp (in seconds) for when the fine-tuning job was created. error: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FineTuningJobError' - nullable: true + - type: 'null' fine_tuned_model: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' finished_at: + anyOf: + - type: string + format: date-time + - type: 'null' type: integer - format: unixtime - nullable: true + format: unixTimestamp hyperparameters: allOf: - $ref: '#/components/schemas/OpenAI.FineTuningJobHyperparameters' @@ -23942,36 +25712,39 @@ components: - cancelled description: The current status of the fine-tuning job, which can be either `validating_files`, `queued`, `running`, `succeeded`, `failed`, or `cancelled`. trained_tokens: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' training_file: type: string description: The file ID used for training. You can retrieve the training data with the [Files API](/docs/api-reference/files/retrieve-contents). validation_file: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' integrations: - type: array - items: - $ref: '#/components/schemas/OpenAI.FineTuningIntegration' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.FineTuningIntegration' + - type: 'null' seed: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The seed used for the fine-tuning job. estimated_finish: + anyOf: + - type: string + format: date-time + - type: 'null' type: integer - format: unixtime - nullable: true + format: unixTimestamp method: $ref: '#/components/schemas/OpenAI.FineTuneMethod' metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' description: The `fine_tuning.job` object represents a fine-tuning job that has been created through the API. title: FineTuningJob x-oaiMeta: @@ -24103,8 +25876,9 @@ components: message: type: string param: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' OpenAI.FineTuningJobEvent: type: object required: @@ -24170,11 +25944,8 @@ components: - type: string enum: - auto - nullable: true - - type: integer - allOf: - - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - $ref: '#/components/schemas/OpenAI.integer' + - type: 'null' default: auto learning_rate_multiplier: oneOf: @@ -24216,18 +25987,23 @@ components: x-stainless-const: true default: input_file file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' filename: type: string description: The name of the file to be sent to the model. + file_data: + type: string + description: The content of the file to be sent to the model. file_url: type: string format: uri description: The URL of the file to be sent to the model. - file_data: - type: string - description: The content of the file to be sent to the model. + detail: + allOf: + - $ref: '#/components/schemas/OpenAI.FileInputDetail' + description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. allOf: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' description: A file input to the model. @@ -24246,16 +26022,18 @@ components: x-stainless-const: true default: input_image image_url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. allOf: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' description: An image input to the model. Learn about [image inputs](/docs/guides/vision). @@ -24294,6 +26072,18 @@ components: - in_progress - completed - incomplete + OpenAI.FunctionCallOutputStatusEnum: + type: string + enum: + - in_progress + - completed + - incomplete + OpenAI.FunctionCallStatus: + type: string + enum: + - in_progress + - completed + - incomplete OpenAI.FunctionObject: type: object required: @@ -24308,11 +26098,12 @@ components: parameters: $ref: '#/components/schemas/OpenAI.FunctionParameters' strict: - type: boolean - nullable: true + anyOf: + - type: boolean + - type: 'null' OpenAI.FunctionParameters: type: object - additionalProperties: {} + unevaluatedProperties: {} description: |- The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list. @@ -24328,15 +26119,13 @@ components: items: type: string timeout_ms: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' description: Execute a shell command. title: Shell exec action OpenAI.FunctionShellActionParam: @@ -24350,15 +26139,13 @@ components: type: string description: Ordered shell commands for the execution environment to run. timeout_ms: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' description: Commands and limits describing how to run the shell tool call. title: Shell action OpenAI.FunctionShellCallEnvironment: @@ -24502,7 +26289,6 @@ components: - exit description: The outcome type. Always `exit`. x-stainless-const: true - default: exit exit_code: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -24523,7 +26309,6 @@ components: - exit description: The outcome type. Always `exit`. x-stainless-const: true - default: exit exit_code: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -24574,6 +26359,12 @@ components: enum: - timeout - exit + OpenAI.FunctionShellCallOutputStatusEnum: + type: string + enum: + - in_progress + - completed + - incomplete OpenAI.FunctionShellCallOutputTimeoutOutcome: type: object required: @@ -24585,7 +26376,6 @@ components: - timeout description: The outcome type. Always `timeout`. x-stainless-const: true - default: timeout allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputOutcome' description: Indicates that the shell call exceeded its configured time limit. @@ -24601,11 +26391,16 @@ components: - timeout description: The outcome type. Always `timeout`. x-stainless-const: true - default: timeout allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputOutcomeParam' description: Indicates that the shell call exceeded its configured time limit. title: Shell call timeout outcome + OpenAI.FunctionShellCallStatus: + type: string + enum: + - in_progress + - completed + - incomplete OpenAI.FunctionShellToolParam: type: object required: @@ -24617,12 +26412,10 @@ components: - shell description: The type of the shell tool. Always `shell`. x-stainless-const: true - default: shell environment: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellToolParamEnvironment' - nullable: true + - type: 'null' name: type: string description: Optional user-defined name for this tool or configuration. @@ -24706,67 +26499,61 @@ components: - function description: The type of the function tool. Always `function`. x-stainless-const: true - default: function name: type: string description: The name of the function to call. description: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' parameters: - type: object - additionalProperties: {} - nullable: true + anyOf: + - type: object + unevaluatedProperties: {} + - type: 'null' strict: + anyOf: + - type: boolean + - type: 'null' + defer_loading: type: boolean - nullable: true + description: Whether this function is deferred and loaded via tool search. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling). title: Function - OpenAI.FunctionToolCallOutput: + OpenAI.FunctionToolParam: type: object required: + - name - type - - call_id - - output properties: - id: + name: type: string - description: |- - The unique ID of the function tool call output. Populated when this item - is returned via API. + minLength: 1 + maxLength: 128 + pattern: ^[a-zA-Z0-9_-]+$ + description: + anyOf: + - type: string + - type: 'null' + parameters: + anyOf: + - $ref: '#/components/schemas/OpenAI.EmptyModelParam' + - type: 'null' + strict: + anyOf: + - type: boolean + - type: 'null' type: type: string enum: - - function_call_output - description: The type of the function tool call output. Always `function_call_output`. + - function x-stainless-const: true - call_id: - type: string - description: The unique ID of the function tool call generated by the model. - output: - oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' - description: |- - The output from the function call generated by your code. - Can be a string or an list of output content. - status: - type: string - enum: - - in_progress - - completed - - incomplete - description: |- - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemField' - description: The output of a function tool call. - title: Function tool call output + default: function + defer_loading: + type: boolean + description: Whether this function should be deferred and discovered via tool search. OpenAI.GraderLabelModel: type: object required: @@ -25143,6 +26930,7 @@ components: - low - high - auto + - original OpenAI.ImageGenActionEnum: type: string enum: @@ -25160,7 +26948,6 @@ components: - image_generation description: The type of the image generation tool. Always `image_generation`. x-stainless-const: true - default: image_generation model: anyOf: - type: string @@ -25182,15 +26969,15 @@ components: or `auto`. Default: `auto`. default: auto size: - type: string - enum: - - 1024x1024 - - 1024x1536 - - 1536x1024 - - auto - description: |- - The size of the generated image. One of `1024x1024`, `1024x1536`, - `1536x1024`, or `auto`. Default: `auto`. + anyOf: + - type: string + - type: string + enum: + - 1024x1024 + - 1024x1536 + - 1536x1024 + - auto + description: The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`. default: auto output_format: type: string @@ -25227,9 +27014,9 @@ components: `opaque`, or `auto`. Default: `auto`. default: auto input_fidelity: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.InputFidelity' - nullable: true + - type: 'null' input_image_mask: allOf: - $ref: '#/components/schemas/OpenAI.ImageGenToolInputImageMask' @@ -25280,6 +27067,7 @@ components: - memory_search_call.results description: |- Specify additional output data to include in the model response. Currently supported values are: + - `web_search_call.results`: Include the search results of the web search tool call. - `web_search_call.action.sources`: Include the sources of the web search tool call. - `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items. - `computer_call_output.output.image_url`: Include image urls from the computer call output. @@ -25301,7 +27089,6 @@ components: - inline description: Defines an inline skill for this request. x-stainless-const: true - default: inline name: type: string description: The name of the skill. @@ -25398,18 +27185,23 @@ components: x-stainless-const: true default: input_file file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' filename: type: string description: The name of the file to be sent to the model. + file_data: + type: string + description: The content of the file to be sent to the model. file_url: type: string format: uri description: The URL of the file to be sent to the model. - file_data: - type: string - description: The content of the file to be sent to the model. + detail: + allOf: + - $ref: '#/components/schemas/OpenAI.FileInputDetail' + description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. allOf: - $ref: '#/components/schemas/OpenAI.InputContent' description: A file input to the model. @@ -25428,16 +27220,18 @@ components: x-stainless-const: true default: input_image image_url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. allOf: - $ref: '#/components/schemas/OpenAI.InputContent' description: An image input to the model. Learn about [image inputs](/docs/guides/vision). @@ -25489,18 +27283,23 @@ components: x-stainless-const: true default: input_file file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' filename: type: string description: The name of the file to be sent to the model. + file_data: + type: string + description: The content of the file to be sent to the model. file_url: type: string format: uri description: The URL of the file to be sent to the model. - file_data: - type: string - description: The content of the file to be sent to the model. + detail: + allOf: + - $ref: '#/components/schemas/OpenAI.FileInputDetail' + description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. description: A file input to the model. title: Input file OpenAI.InputFileContentParam: @@ -25516,18 +27315,26 @@ components: x-stainless-const: true default: input_file file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' filename: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' file_data: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' file_url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' + detail: + allOf: + - $ref: '#/components/schemas/OpenAI.FileInputDetail' + description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. description: A file input to the model. title: Input file OpenAI.InputImageContent: @@ -25544,16 +27351,18 @@ components: x-stainless-const: true default: input_image image_url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. description: An image input to the model. Learn about [image inputs](/docs/guides/vision). title: Input image OpenAI.InputImageContentParamAutoParam: @@ -25569,16 +27378,18 @@ components: x-stainless-const: true default: input_image image_url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' detail: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.DetailEnum' - nullable: true + - type: 'null' description: An image input to the model. Learn about [image inputs](/docs/guides/vision) title: Input image OpenAI.InputItem: @@ -25600,6 +27411,9 @@ components: web_search_call: '#/components/schemas/OpenAI.InputItemWebSearchToolCall' function_call: '#/components/schemas/OpenAI.InputItemFunctionToolCall' function_call_output: '#/components/schemas/OpenAI.InputItemFunctionCallOutputItemParam' + tool_search_call: '#/components/schemas/OpenAI.InputItemToolSearchCallItemParam' + tool_search_output: '#/components/schemas/OpenAI.InputItemToolSearchOutputItemParam' + additional_tools: '#/components/schemas/OpenAI.InputItemAdditionalToolsItemParam' reasoning: '#/components/schemas/OpenAI.InputItemReasoningItem' compaction: '#/components/schemas/OpenAI.InputItemCompactionSummaryItemParam' image_generation_call: '#/components/schemas/OpenAI.InputItemImageGenToolCall' @@ -25620,6 +27434,38 @@ components: An item representing part of the context for the response to be generated by the model. Can contain text, images, and audio inputs, as well as previous assistant responses and tool call outputs. + OpenAI.InputItemAdditionalToolsItemParam: + type: object + required: + - type + - role + - tools + properties: + id: + anyOf: + - type: string + - type: 'null' + type: + type: string + enum: + - additional_tools + description: The item type. Always `additional_tools`. + x-stainless-const: true + default: additional_tools + role: + type: string + enum: + - developer + description: The role that provided the additional tools. Only `developer` is supported. + x-stainless-const: true + default: developer + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: A list of additional tools made available at this item. + allOf: + - $ref: '#/components/schemas/OpenAI.InputItem' OpenAI.InputItemApplyPatchToolCallItemParam: type: object required: @@ -25636,8 +27482,9 @@ components: x-stainless-const: true default: apply_patch_call id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -25670,8 +27517,9 @@ components: x-stainless-const: true default: apply_patch_call_output id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -25682,8 +27530,9 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatusParam' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The streamed output emitted by an apply patch tool call. @@ -25721,15 +27570,17 @@ components: type: string description: The ID of the container used to run the code. code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' outputs: - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - nullable: true + anyOf: + - type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A tool call to run code. @@ -25741,8 +27592,9 @@ components: - encrypted_content properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' type: type: string enum: @@ -25766,8 +27618,9 @@ components: - output properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -25783,14 +27636,15 @@ components: output: $ref: '#/components/schemas/OpenAI.ComputerScreenshotImage' acknowledged_safety_checks: - type: array - items: - $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' + - type: 'null' status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The output of a computer tool call. @@ -25801,7 +27655,6 @@ components: - type - id - call_id - - action - pending_safety_checks - status properties: @@ -25819,6 +27672,8 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' + actions: + $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -25859,6 +27714,9 @@ components: call_id: type: string description: An identifier used to map this custom tool call to a tool call output. + namespace: + type: string + description: The namespace of the custom tool being called. name: type: string description: The name of the custom tool being called. @@ -25935,10 +27793,11 @@ components: type: string description: The queries used to search for files. results: - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: |- @@ -25953,8 +27812,9 @@ components: - output properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -25978,9 +27838,9 @@ components: - $ref: '#/components/schemas/OpenAI.InputFileContentParam' description: Text, image, or file output of the function tool call. status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The output of a function tool call. @@ -25993,8 +27853,9 @@ components: - action properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -26012,14 +27873,13 @@ components: - $ref: '#/components/schemas/OpenAI.FunctionShellActionParam' description: The shell commands and limits that describe how to run the tool call. status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - nullable: true + - type: 'null' environment: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemParamEnvironment' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A tool representing a request to execute one or more shell commands. @@ -26032,8 +27892,9 @@ components: - output properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -26052,14 +27913,13 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContentParam' description: Captured chunks of stdout and stderr output, along with their associated outcomes. status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - nullable: true + - type: 'null' max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The streamed output items emitted by a shell tool call. @@ -26067,6 +27927,7 @@ components: OpenAI.InputItemFunctionToolCall: type: object required: + - id - type - call_id - name @@ -26075,6 +27936,7 @@ components: id: type: string description: The unique ID of the function tool call. + readOnly: true type: type: string enum: @@ -26084,6 +27946,9 @@ components: call_id: type: string description: The unique ID of the function tool call generated by the model. + namespace: + type: string + description: The namespace of the function to run. name: type: string description: The name of the function to run. @@ -26131,8 +27996,9 @@ components: - failed description: The status of the image generation call. result: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: An image generation request made by the model. @@ -26191,12 +28057,13 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - type: string - enum: - - in_progress - - completed - - incomplete - nullable: true + anyOf: + - type: string + enum: + - in_progress + - completed + - incomplete + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The output of a local shell tool call. @@ -26246,8 +28113,9 @@ components: description: The type of the item. Always `mcp_approval_response`. x-stainless-const: true id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' approval_request_id: type: string description: The ID of the approval request being answered. @@ -26255,8 +28123,9 @@ components: type: boolean description: Whether the request was approved. reason: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A response to an MCP approval request. @@ -26287,8 +28156,7 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - type: string - nullable: true + $ref: '#/components/schemas/OpenAI.RealtimeMCPError' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A list of tools available on an MCP server. @@ -26321,18 +28189,20 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' error: type: object - additionalProperties: {} + unevaluatedProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: An invocation of a tool on an MCP server. @@ -26366,6 +28236,10 @@ components: items: $ref: '#/components/schemas/OpenAI.OutputMessageContent' description: The content of the output message. + phase: + anyOf: + - $ref: '#/components/schemas/OpenAI.MessagePhase' + - type: 'null' status: type: string enum: @@ -26396,8 +28270,9 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' summary: type: array items: @@ -26425,6 +28300,77 @@ components: for subsequent turns of a conversation if you are manually [managing context](/docs/guides/conversation-state). title: Reasoning + OpenAI.InputItemToolSearchCallItemParam: + type: object + required: + - type + - arguments + properties: + id: + anyOf: + - type: string + - type: 'null' + call_id: + anyOf: + - type: string + - type: 'null' + type: + type: string + enum: + - tool_search_call + description: The item type. Always `tool_search_call`. + x-stainless-const: true + default: tool_search_call + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + arguments: + allOf: + - $ref: '#/components/schemas/OpenAI.EmptyModelParam' + description: The arguments supplied to the tool search call. + status: + anyOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' + - type: 'null' + allOf: + - $ref: '#/components/schemas/OpenAI.InputItem' + OpenAI.InputItemToolSearchOutputItemParam: + type: object + required: + - type + - tools + properties: + id: + anyOf: + - type: string + - type: 'null' + call_id: + anyOf: + - type: string + - type: 'null' + type: + type: string + enum: + - tool_search_output + description: The item type. Always `tool_search_output`. + x-stainless-const: true + default: tool_search_output + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The loaded tool definitions returned by the tool search output. + status: + anyOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' + - type: 'null' + allOf: + - $ref: '#/components/schemas/OpenAI.InputItem' OpenAI.InputItemType: anyOf: - type: string @@ -26438,6 +28384,9 @@ components: - web_search_call - function_call - function_call_output + - tool_search_call + - tool_search_output + - additional_tools - reasoning - compaction - image_generation_call @@ -26494,44 +28443,6 @@ components: The results of a web search tool call. See the [web search guide](/docs/guides/tools-web-search) for more information. title: Web search tool call - OpenAI.InputMessage: - type: object - required: - - type - - role - - content - properties: - type: - type: string - enum: - - message - description: The type of the message input. Always set to `message`. - x-stainless-const: true - role: - type: string - enum: - - user - - system - - developer - description: The role of the message input. One of `user`, `system`, or `developer`. - status: - type: string - enum: - - in_progress - - completed - - incomplete - description: |- - The status of item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - content: - $ref: '#/components/schemas/OpenAI.InputMessageContentList' - allOf: - - $ref: '#/components/schemas/OpenAI.Item' - description: |- - A message input to the model with a role indicating instruction following - hierarchy. Instructions given with the `developer` or `system` role take - precedence over instructions given with the `user` role. - title: Input message OpenAI.InputMessageContentList: type: array items: @@ -26540,43 +28451,6 @@ components: A list of one or many input items to the model, containing different content types. title: Input item content list - OpenAI.InputMessageResource: - type: object - required: - - type - - role - - content - - id - properties: - type: - type: string - enum: - - message - description: The type of the message input. Always set to `message`. - x-stainless-const: true - role: - type: string - enum: - - user - - system - - developer - description: The role of the message input. One of `user`, `system`, or `developer`. - status: - type: string - enum: - - in_progress - - completed - - incomplete - description: |- - The status of item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - content: - $ref: '#/components/schemas/OpenAI.InputMessageContentList' - id: - type: string - description: The unique ID of the message input. - allOf: - - $ref: '#/components/schemas/OpenAI.ItemResource' OpenAI.InputParam: oneOf: - type: string @@ -26638,7 +28512,7 @@ components: discriminator: propertyName: type mapping: - message: '#/components/schemas/OpenAI.InputMessage' + message: '#/components/schemas/OpenAI.ItemInputMessage' output_message: '#/components/schemas/OpenAI.ItemOutputMessage' file_search_call: '#/components/schemas/OpenAI.ItemFileSearchToolCall' computer_call: '#/components/schemas/OpenAI.ItemComputerToolCall' @@ -26646,6 +28520,9 @@ components: web_search_call: '#/components/schemas/OpenAI.ItemWebSearchToolCall' function_call: '#/components/schemas/OpenAI.ItemFunctionToolCall' function_call_output: '#/components/schemas/OpenAI.ItemFunctionCallOutputItemParam' + tool_search_call: '#/components/schemas/OpenAI.ItemToolSearchCallItemParam' + tool_search_output: '#/components/schemas/OpenAI.ItemToolSearchOutputItemParam' + additional_tools: '#/components/schemas/OpenAI.ItemAdditionalToolsItemParam' reasoning: '#/components/schemas/OpenAI.ItemReasoningItem' compaction: '#/components/schemas/OpenAI.ItemCompactionSummaryItemParam' image_generation_call: '#/components/schemas/OpenAI.ItemImageGenToolCall' @@ -26663,6 +28540,38 @@ components: custom_tool_call_output: '#/components/schemas/OpenAI.ItemCustomToolCallOutput' custom_tool_call: '#/components/schemas/OpenAI.ItemCustomToolCall' description: Content item used to generate a response. + OpenAI.ItemAdditionalToolsItemParam: + type: object + required: + - type + - role + - tools + properties: + id: + anyOf: + - type: string + - type: 'null' + type: + type: string + enum: + - additional_tools + description: The item type. Always `additional_tools`. + x-stainless-const: true + default: additional_tools + role: + type: string + enum: + - developer + description: The role that provided the additional tools. Only `developer` is supported. + x-stainless-const: true + default: developer + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: A list of additional tools made available at this item. + allOf: + - $ref: '#/components/schemas/OpenAI.Item' OpenAI.ItemApplyPatchToolCallItemParam: type: object required: @@ -26679,8 +28588,9 @@ components: x-stainless-const: true default: apply_patch_call id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -26713,8 +28623,9 @@ components: x-stainless-const: true default: apply_patch_call_output id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -26725,8 +28636,9 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatusParam' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The streamed output emitted by an apply patch tool call. @@ -26764,15 +28676,17 @@ components: type: string description: The ID of the container used to run the code. code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' outputs: - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - nullable: true + anyOf: + - type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A tool call to run code. @@ -26784,8 +28698,9 @@ components: - encrypted_content properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' type: type: string enum: @@ -26809,8 +28724,9 @@ components: - output properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -26826,14 +28742,15 @@ components: output: $ref: '#/components/schemas/OpenAI.ComputerScreenshotImage' acknowledged_safety_checks: - type: array - items: - $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' + - type: 'null' status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The output of a computer tool call. @@ -26844,7 +28761,6 @@ components: - type - id - call_id - - action - pending_safety_checks - status properties: @@ -26862,6 +28778,8 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' + actions: + $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -26902,6 +28820,9 @@ components: call_id: type: string description: An identifier used to map this custom tool call to a tool call output. + namespace: + type: string + description: The namespace of the custom tool being called. name: type: string description: The name of the custom tool being called. @@ -26954,14 +28875,17 @@ components: discriminator: propertyName: type mapping: - function_call_output: '#/components/schemas/OpenAI.FunctionToolCallOutput' message: '#/components/schemas/OpenAI.ItemFieldMessage' function_call: '#/components/schemas/OpenAI.ItemFieldFunctionToolCall' + tool_search_call: '#/components/schemas/OpenAI.ItemFieldToolSearchCall' + tool_search_output: '#/components/schemas/OpenAI.ItemFieldToolSearchOutput' + additional_tools: '#/components/schemas/OpenAI.ItemFieldAdditionalTools' + function_call_output: '#/components/schemas/OpenAI.ItemFieldFunctionToolCallOutput' file_search_call: '#/components/schemas/OpenAI.ItemFieldFileSearchToolCall' web_search_call: '#/components/schemas/OpenAI.ItemFieldWebSearchToolCall' image_generation_call: '#/components/schemas/OpenAI.ItemFieldImageGenToolCall' computer_call: '#/components/schemas/OpenAI.ItemFieldComputerToolCall' - computer_call_output: '#/components/schemas/OpenAI.ItemFieldComputerToolCallOutputResource' + computer_call_output: '#/components/schemas/OpenAI.ItemFieldComputerToolCallOutput' reasoning: '#/components/schemas/OpenAI.ItemFieldReasoningItem' compaction: '#/components/schemas/OpenAI.ItemFieldCompactionBody' code_interpreter_call: '#/components/schemas/OpenAI.ItemFieldCodeInterpreterToolCall' @@ -26978,6 +28902,35 @@ components: custom_tool_call: '#/components/schemas/OpenAI.ItemFieldCustomToolCall' custom_tool_call_output: '#/components/schemas/OpenAI.ItemFieldCustomToolCallOutput' description: An item representing a message, tool call, tool output, reasoning, or other response element. + OpenAI.ItemFieldAdditionalTools: + type: object + required: + - type + - id + - role + - tools + properties: + type: + type: string + enum: + - additional_tools + description: The type of the item. Always `additional_tools`. + x-stainless-const: true + default: additional_tools + id: + type: string + description: The unique ID of the additional tools item. + role: + allOf: + - $ref: '#/components/schemas/OpenAI.MessageRole' + description: The role that provided the additional tools. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The additional tool definitions made available at this item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemField' OpenAI.ItemFieldApplyPatchToolCall: type: object required: @@ -27042,8 +28995,9 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call output. @@ -27084,15 +29038,17 @@ components: type: string description: The ID of the container used to run the code. code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' outputs: - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - nullable: true + anyOf: + - type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A tool call to run code. @@ -27130,7 +29086,6 @@ components: - type - id - call_id - - action - pending_safety_checks - status properties: @@ -27148,6 +29103,8 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' + actions: + $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -27168,10 +29125,11 @@ components: A tool call to a computer use tool. See the [computer use guide](/docs/guides/tools-computer-use) for more information. title: Computer tool call - OpenAI.ItemFieldComputerToolCallOutputResource: + OpenAI.ItemFieldComputerToolCallOutput: type: object required: - type + - id - call_id - output properties: @@ -27185,6 +29143,7 @@ components: id: type: string description: The ID of the computer tool call output. + readOnly: true call_id: type: string description: The ID of the computer tool call that produced the output. @@ -27208,6 +29167,8 @@ components: `incomplete`. Populated when input items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ItemField' + description: The output of a computer tool call. + title: Computer tool call output OpenAI.ItemFieldCustomToolCall: type: object required: @@ -27228,6 +29189,9 @@ components: call_id: type: string description: An identifier used to map this custom tool call to a tool call output. + namespace: + type: string + description: The namespace of the custom tool being called. name: type: string description: The name of the custom tool being called. @@ -27304,10 +29268,11 @@ components: type: string description: The queries used to search for files. results: - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: |- @@ -27343,13 +29308,12 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - nullable: true + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call. @@ -27382,7 +29346,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -27390,10 +29354,9 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' created_by: type: string description: The identifier of the actor that created the item. @@ -27404,6 +29367,7 @@ components: OpenAI.ItemFieldFunctionToolCall: type: object required: + - id - type - call_id - name @@ -27412,6 +29376,7 @@ components: id: type: string description: The unique ID of the function tool call. + readOnly: true type: type: string enum: @@ -27421,6 +29386,9 @@ components: call_id: type: string description: The unique ID of the function tool call generated by the model. + namespace: + type: string + description: The namespace of the function to run. name: type: string description: The name of the function to run. @@ -27442,6 +29410,51 @@ components: A tool call to run a function. See the [function calling guide](/docs/guides/function-calling) for more information. title: Function tool call + OpenAI.ItemFieldFunctionToolCallOutput: + type: object + required: + - id + - type + - call_id + - output + properties: + id: + type: string + description: |- + The unique ID of the function tool call output. Populated when this item + is returned via API. + readOnly: true + type: + type: string + enum: + - function_call_output + description: The type of the function tool call output. Always `function_call_output`. + x-stainless-const: true + call_id: + type: string + description: The unique ID of the function tool call generated by the model. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the function call generated by your code. + Can be a string or an list of output content. + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemField' + description: The output of a function tool call. + title: Function tool call output OpenAI.ItemFieldImageGenToolCall: type: object required: @@ -27468,8 +29481,9 @@ components: - failed description: The status of the image generation call. result: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: An image generation request made by the model. @@ -27528,12 +29542,13 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - type: string - enum: - - in_progress - - completed - - incomplete - nullable: true + anyOf: + - type: string + enum: + - in_progress + - completed + - incomplete + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: The output of a local shell tool call. @@ -27593,8 +29608,9 @@ components: type: boolean description: Whether the request was approved. reason: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A response to an MCP approval request. @@ -27625,8 +29641,7 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - type: string - nullable: true + $ref: '#/components/schemas/OpenAI.RealtimeMCPError' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A list of tools available on an MCP server. @@ -27659,18 +29674,20 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' error: type: object - additionalProperties: {} + unevaluatedProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: An invocation of a tool on an MCP server. @@ -27707,6 +29724,10 @@ components: items: $ref: '#/components/schemas/OpenAI.MessageContent' description: The content of the message + phase: + anyOf: + - $ref: '#/components/schemas/OpenAI.MessagePhase' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A message to or from the model. @@ -27728,8 +29749,9 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' summary: type: array items: @@ -27757,6 +29779,87 @@ components: for subsequent turns of a conversation if you are manually [managing context](/docs/guides/conversation-state). title: Reasoning + OpenAI.ItemFieldToolSearchCall: + type: object + required: + - type + - id + - call_id + - execution + - arguments + - status + properties: + type: + type: string + enum: + - tool_search_call + description: The type of the item. Always `tool_search_call`. + x-stainless-const: true + default: tool_search_call + id: + type: string + description: The unique ID of the tool search call item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + arguments: + description: Arguments used for the tool search call. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' + description: The status of the tool search call item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemField' + OpenAI.ItemFieldToolSearchOutput: + type: object + required: + - type + - id + - call_id + - execution + - tools + - status + properties: + type: + type: string + enum: + - tool_search_output + description: The type of the item. Always `tool_search_output`. + x-stainless-const: true + default: tool_search_output + id: + type: string + description: The unique ID of the tool search output item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The loaded tool definitions returned by tool search. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' + description: The status of the tool search output item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemField' OpenAI.ItemFieldType: anyOf: - type: string @@ -27764,6 +29867,9 @@ components: enum: - message - function_call + - tool_search_call + - tool_search_output + - additional_tools - function_call_output - file_search_call - web_search_call @@ -27858,10 +29964,11 @@ components: type: string description: The queries used to search for files. results: - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: |- @@ -27876,8 +29983,9 @@ components: - output properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -27901,9 +30009,9 @@ components: - $ref: '#/components/schemas/OpenAI.InputFileContentParam' description: Text, image, or file output of the function tool call. status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The output of a function tool call. @@ -27916,8 +30024,9 @@ components: - action properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -27935,14 +30044,13 @@ components: - $ref: '#/components/schemas/OpenAI.FunctionShellActionParam' description: The shell commands and limits that describe how to run the tool call. status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - nullable: true + - type: 'null' environment: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemParamEnvironment' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A tool representing a request to execute one or more shell commands. @@ -27955,8 +30063,9 @@ components: - output properties: id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' call_id: type: string minLength: 1 @@ -27975,14 +30084,13 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContentParam' description: Captured chunks of stdout and stderr output, along with their associated outcomes. status: - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - nullable: true + - type: 'null' max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The streamed output items emitted by a shell tool call. @@ -27990,6 +30098,7 @@ components: OpenAI.ItemFunctionToolCall: type: object required: + - id - type - call_id - name @@ -27998,6 +30107,7 @@ components: id: type: string description: The unique ID of the function tool call. + readOnly: true type: type: string enum: @@ -28007,6 +30117,9 @@ components: call_id: type: string description: The unique ID of the function tool call generated by the model. + namespace: + type: string + description: The namespace of the function to run. name: type: string description: The name of the function to run. @@ -28054,12 +30167,57 @@ components: - failed description: The status of the image generation call. result: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: An image generation request made by the model. title: Image generation call + OpenAI.ItemInputMessage: + type: object + required: + - type + - role + - content + - id + properties: + type: + type: string + enum: + - message + description: The type of the message input. Always set to `message`. + x-stainless-const: true + default: message + role: + type: string + enum: + - user + - system + - developer + description: The role of the message input. One of `user`, `system`, or `developer`. + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + content: + $ref: '#/components/schemas/OpenAI.InputMessageContentList' + id: + type: string + description: The unique ID of the message input. + readOnly: true + allOf: + - $ref: '#/components/schemas/OpenAI.Item' + description: |- + A message input to the model with a role indicating instruction following + hierarchy. Instructions given with the `developer` or `system` role take + precedence over instructions given with the `user` role. + title: Input message OpenAI.ItemLocalShellToolCall: type: object required: @@ -28114,12 +30272,13 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - type: string - enum: - - in_progress - - completed - - incomplete - nullable: true + anyOf: + - type: string + enum: + - in_progress + - completed + - incomplete + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The output of a local shell tool call. @@ -28169,8 +30328,9 @@ components: description: The type of the item. Always `mcp_approval_response`. x-stainless-const: true id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' approval_request_id: type: string description: The ID of the approval request being answered. @@ -28178,8 +30338,9 @@ components: type: boolean description: Whether the request was approved. reason: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A response to an MCP approval request. @@ -28210,8 +30371,7 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - type: string - nullable: true + $ref: '#/components/schemas/OpenAI.RealtimeMCPError' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A list of tools available on an MCP server. @@ -28244,18 +30404,20 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' error: type: object - additionalProperties: {} + unevaluatedProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.Item' description: An invocation of a tool on an MCP server. @@ -28289,6 +30451,10 @@ components: items: $ref: '#/components/schemas/OpenAI.OutputMessageContent' description: The content of the output message. + phase: + anyOf: + - $ref: '#/components/schemas/OpenAI.MessagePhase' + - type: 'null' status: type: string enum: @@ -28319,8 +30485,9 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' summary: type: array items: @@ -28360,7 +30527,6 @@ components: - item_reference description: The type of item to reference. Always `item_reference`. x-stainless-const: true - default: item_reference id: type: string description: The ID of the item to reference. @@ -28378,14 +30544,19 @@ components: discriminator: propertyName: type mapping: - message: '#/components/schemas/OpenAI.InputMessageResource' + message: '#/components/schemas/OpenAI.ItemResourceInputMessage' output_message: '#/components/schemas/OpenAI.ItemResourceOutputMessage' file_search_call: '#/components/schemas/OpenAI.ItemResourceFileSearchToolCall' computer_call: '#/components/schemas/OpenAI.ItemResourceComputerToolCall' - computer_call_output: '#/components/schemas/OpenAI.ItemResourceComputerToolCallOutputResource' + computer_call_output: '#/components/schemas/OpenAI.ItemResourceComputerToolCallOutput' web_search_call: '#/components/schemas/OpenAI.ItemResourceWebSearchToolCall' - function_call: '#/components/schemas/OpenAI.ItemResourceFunctionToolCallResource' - function_call_output: '#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutputResource' + function_call: '#/components/schemas/OpenAI.ItemResourceFunctionToolCall' + function_call_output: '#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutput' + tool_search_call: '#/components/schemas/OpenAI.ItemResourceToolSearchCall' + tool_search_output: '#/components/schemas/OpenAI.ItemResourceToolSearchOutput' + additional_tools: '#/components/schemas/OpenAI.ItemResourceAdditionalTools' + reasoning: '#/components/schemas/OpenAI.ItemResourceReasoningItem' + compaction: '#/components/schemas/OpenAI.ItemResourceCompactionBody' image_generation_call: '#/components/schemas/OpenAI.ItemResourceImageGenToolCall' code_interpreter_call: '#/components/schemas/OpenAI.ItemResourceCodeInterpreterToolCall' local_shell_call: '#/components/schemas/OpenAI.ItemResourceLocalShellToolCall' @@ -28398,7 +30569,38 @@ components: mcp_approval_request: '#/components/schemas/OpenAI.ItemResourceMcpApprovalRequest' mcp_approval_response: '#/components/schemas/OpenAI.ItemResourceMcpApprovalResponseResource' mcp_call: '#/components/schemas/OpenAI.ItemResourceMcpToolCall' + custom_tool_call: '#/components/schemas/OpenAI.ItemResourceCustomToolCallResource' + custom_tool_call_output: '#/components/schemas/OpenAI.ItemResourceCustomToolCallOutputResource' description: Content item used to generate a response. + OpenAI.ItemResourceAdditionalTools: + type: object + required: + - type + - id + - role + - tools + properties: + type: + type: string + enum: + - additional_tools + description: The type of the item. Always `additional_tools`. + x-stainless-const: true + default: additional_tools + id: + type: string + description: The unique ID of the additional tools item. + role: + allOf: + - $ref: '#/components/schemas/OpenAI.MessageRole' + description: The role that provided the additional tools. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The additional tool definitions made available at this item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' OpenAI.ItemResourceApplyPatchToolCall: type: object required: @@ -28463,8 +30665,9 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call output. @@ -28505,26 +30708,54 @@ components: type: string description: The ID of the container used to run the code. code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' outputs: - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - nullable: true + anyOf: + - type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: A tool call to run code. title: Code interpreter tool call + OpenAI.ItemResourceCompactionBody: + type: object + required: + - type + - id + - encrypted_content + properties: + type: + type: string + enum: + - compaction + description: The type of the item. Always `compaction`. + x-stainless-const: true + default: compaction + id: + type: string + description: The unique ID of the compaction item. + encrypted_content: + type: string + description: The encrypted content that was produced by compaction. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' + description: A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact). + title: Compaction item OpenAI.ItemResourceComputerToolCall: type: object required: - type - id - call_id - - action - pending_safety_checks - status properties: @@ -28542,6 +30773,8 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' + actions: + $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -28562,10 +30795,11 @@ components: A tool call to a computer use tool. See the [computer use guide](/docs/guides/tools-computer-use) for more information. title: Computer tool call - OpenAI.ItemResourceComputerToolCallOutputResource: + OpenAI.ItemResourceComputerToolCallOutput: type: object required: - type + - id - call_id - output properties: @@ -28579,6 +30813,7 @@ components: id: type: string description: The ID of the computer tool call output. + readOnly: true call_id: type: string description: The ID of the computer tool call that produced the output. @@ -28602,6 +30837,91 @@ components: `incomplete`. Populated when input items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' + description: The output of a computer tool call. + title: Computer tool call output + OpenAI.ItemResourceCustomToolCallOutputResource: + type: object + required: + - type + - call_id + - output + - status + properties: + type: + type: string + enum: + - custom_tool_call_output + description: The type of the custom tool call output. Always `custom_tool_call_output`. + x-stainless-const: true + id: + type: string + description: The unique ID of the custom tool call output in the OpenAI platform. + call_id: + type: string + description: The call ID, used to map this custom tool call output to a custom tool call. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' + title: ResponseCustomToolCallOutputItem + OpenAI.ItemResourceCustomToolCallResource: + type: object + required: + - type + - call_id + - name + - input + - status + properties: + type: + type: string + enum: + - custom_tool_call + description: The type of the custom tool call. Always `custom_tool_call`. + x-stainless-const: true + id: + type: string + description: The unique ID of the custom tool call in the OpenAI platform. + call_id: + type: string + description: An identifier used to map this custom tool call to a tool call output. + namespace: + type: string + description: The namespace of the custom tool being called. + name: + type: string + description: The name of the custom tool being called. + input: + type: string + description: The input for the custom tool call generated by the model. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' + title: ResponseCustomToolCallItem OpenAI.ItemResourceFileSearchToolCall: type: object required: @@ -28636,10 +30956,11 @@ components: type: string description: The queries used to search for files. results: - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: |- @@ -28675,13 +30996,12 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - nullable: true + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call. @@ -28714,7 +31034,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -28722,10 +31042,9 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' created_by: type: string description: The identifier of the actor that created the item. @@ -28733,36 +31052,37 @@ components: - $ref: '#/components/schemas/OpenAI.ItemResource' description: The output of a shell tool call that was emitted. title: Shell call output - OpenAI.ItemResourceFunctionToolCallOutputResource: + OpenAI.ItemResourceFunctionToolCall: type: object required: + - id - type - call_id - - output + - name + - arguments properties: id: type: string - description: |- - The unique ID of the function tool call output. Populated when this item - is returned via API. + description: The unique ID of the function tool call. + readOnly: true type: type: string enum: - - function_call_output - description: The type of the function tool call output. Always `function_call_output`. + - function_call + description: The type of the function tool call. Always `function_call`. x-stainless-const: true call_id: type: string description: The unique ID of the function tool call generated by the model. - output: - oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' - description: |- - The output from the function call generated by your code. - Can be a string or an list of output content. + namespace: + type: string + description: The namespace of the function to run. + name: + type: string + description: The name of the function to run. + arguments: + type: string + description: A JSON string of the arguments to pass to the function. status: type: string enum: @@ -28774,32 +31094,42 @@ components: `incomplete`. Populated when items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' - OpenAI.ItemResourceFunctionToolCallResource: + description: |- + A tool call to run a function. See the + [function calling guide](/docs/guides/function-calling) for more information. + title: Function tool call + OpenAI.ItemResourceFunctionToolCallOutput: type: object required: + - id - type - call_id - - name - - arguments + - output properties: id: type: string - description: The unique ID of the function tool call. + description: |- + The unique ID of the function tool call output. Populated when this item + is returned via API. + readOnly: true type: type: string enum: - - function_call - description: The type of the function tool call. Always `function_call`. + - function_call_output + description: The type of the function tool call output. Always `function_call_output`. x-stainless-const: true call_id: type: string description: The unique ID of the function tool call generated by the model. - name: - type: string - description: The name of the function to run. - arguments: - type: string - description: A JSON string of the arguments to pass to the function. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the function call generated by your code. + Can be a string or an list of output content. status: type: string enum: @@ -28811,6 +31141,8 @@ components: `incomplete`. Populated when items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' + description: The output of a function tool call. + title: Function tool call output OpenAI.ItemResourceImageGenToolCall: type: object required: @@ -28837,12 +31169,57 @@ components: - failed description: The status of the image generation call. result: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: An image generation request made by the model. title: Image generation call + OpenAI.ItemResourceInputMessage: + type: object + required: + - type + - role + - content + - id + properties: + type: + type: string + enum: + - message + description: The type of the message input. Always set to `message`. + x-stainless-const: true + default: message + role: + type: string + enum: + - user + - system + - developer + description: The role of the message input. One of `user`, `system`, or `developer`. + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + content: + $ref: '#/components/schemas/OpenAI.InputMessageContentList' + id: + type: string + description: The unique ID of the message input. + readOnly: true + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' + description: |- + A message input to the model with a role indicating instruction following + hierarchy. Instructions given with the `developer` or `system` role take + precedence over instructions given with the `user` role. + title: Input message OpenAI.ItemResourceLocalShellToolCall: type: object required: @@ -28897,12 +31274,13 @@ components: type: string description: A JSON string of the output of the local shell tool call. status: - type: string - enum: - - in_progress - - completed - - incomplete - nullable: true + anyOf: + - type: string + enum: + - in_progress + - completed + - incomplete + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: The output of a local shell tool call. @@ -28962,8 +31340,9 @@ components: type: boolean description: Whether the request was approved. reason: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: A response to an MCP approval request. @@ -28994,8 +31373,7 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - type: string - nullable: true + $ref: '#/components/schemas/OpenAI.RealtimeMCPError' allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: A list of tools available on an MCP server. @@ -29028,18 +31406,20 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' error: type: object - additionalProperties: {} + unevaluatedProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: An invocation of a tool on an MCP server. @@ -29073,6 +31453,10 @@ components: items: $ref: '#/components/schemas/OpenAI.OutputMessageContent' description: The content of the output message. + phase: + anyOf: + - $ref: '#/components/schemas/OpenAI.MessagePhase' + - type: 'null' status: type: string enum: @@ -29086,6 +31470,134 @@ components: - $ref: '#/components/schemas/OpenAI.ItemResource' description: An output message from the model. title: Output message + OpenAI.ItemResourceReasoningItem: + type: object + required: + - type + - id + - summary + properties: + type: + type: string + enum: + - reasoning + description: The type of the object. Always `reasoning`. + x-stainless-const: true + id: + type: string + description: The unique identifier of the reasoning content. + encrypted_content: + anyOf: + - type: string + - type: 'null' + summary: + type: array + items: + $ref: '#/components/schemas/OpenAI.SummaryTextContent' + description: Reasoning summary content. + content: + type: array + items: + $ref: '#/components/schemas/OpenAI.ReasoningTextContent' + description: Reasoning text content. + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' + description: |- + A description of the chain of thought used by a reasoning model while generating + a response. Be sure to include these items in your `input` to the Responses API + for subsequent turns of a conversation if you are manually + [managing context](/docs/guides/conversation-state). + title: Reasoning + OpenAI.ItemResourceToolSearchCall: + type: object + required: + - type + - id + - call_id + - execution + - arguments + - status + properties: + type: + type: string + enum: + - tool_search_call + description: The type of the item. Always `tool_search_call`. + x-stainless-const: true + default: tool_search_call + id: + type: string + description: The unique ID of the tool search call item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + arguments: + description: Arguments used for the tool search call. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' + description: The status of the tool search call item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' + OpenAI.ItemResourceToolSearchOutput: + type: object + required: + - type + - id + - call_id + - execution + - tools + - status + properties: + type: + type: string + enum: + - tool_search_output + description: The type of the item. Always `tool_search_output`. + x-stainless-const: true + default: tool_search_output + id: + type: string + description: The unique ID of the tool search output item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The loaded tool definitions returned by tool search. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' + description: The status of the tool search output item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.ItemResource' OpenAI.ItemResourceType: anyOf: - type: string @@ -29099,6 +31611,11 @@ components: - web_search_call - function_call - function_call_output + - tool_search_call + - tool_search_output + - additional_tools + - reasoning + - compaction - image_generation_call - code_interpreter_call - local_shell_call @@ -29111,6 +31628,8 @@ components: - mcp_approval_request - mcp_approval_response - mcp_call + - custom_tool_call + - custom_tool_call_output - structured_outputs - oauth_consent_request - memory_search_call @@ -29174,6 +31693,77 @@ components: The results of a web search tool call. See the [web search guide](/docs/guides/tools-web-search) for more information. title: Web search tool call + OpenAI.ItemToolSearchCallItemParam: + type: object + required: + - type + - arguments + properties: + id: + anyOf: + - type: string + - type: 'null' + call_id: + anyOf: + - type: string + - type: 'null' + type: + type: string + enum: + - tool_search_call + description: The item type. Always `tool_search_call`. + x-stainless-const: true + default: tool_search_call + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + arguments: + allOf: + - $ref: '#/components/schemas/OpenAI.EmptyModelParam' + description: The arguments supplied to the tool search call. + status: + anyOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' + - type: 'null' + allOf: + - $ref: '#/components/schemas/OpenAI.Item' + OpenAI.ItemToolSearchOutputItemParam: + type: object + required: + - type + - tools + properties: + id: + anyOf: + - type: string + - type: 'null' + call_id: + anyOf: + - type: string + - type: 'null' + type: + type: string + enum: + - tool_search_output + description: The item type. Always `tool_search_output`. + x-stainless-const: true + default: tool_search_output + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The loaded tool definitions returned by the tool search output. + status: + anyOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' + - type: 'null' + allOf: + - $ref: '#/components/schemas/OpenAI.Item' OpenAI.ItemType: anyOf: - type: string @@ -29187,6 +31777,9 @@ components: - web_search_call - function_call - function_call_output + - tool_search_call + - tool_search_output + - additional_tools - reasoning - compaction - image_generation_call @@ -29278,7 +31871,6 @@ components: - keypress description: Specifies the event type. For a keypress action, this property is always set to `keypress`. x-stainless-const: true - default: keypress keys: type: array items: @@ -29306,11 +31898,13 @@ components: - list x-stainless-const: true first_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' last_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' x-ms-list-continuation-token: true has_more: type: boolean @@ -29363,23 +31957,10 @@ components: - local description: The environment type. Always `local`. x-stainless-const: true - default: local allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' description: Represents the use of a local environment to perform shell actions. title: Local Environment - OpenAI.LocalShellCallOutputStatusEnum: - type: string - enum: - - in_progress - - completed - - incomplete - OpenAI.LocalShellCallStatus: - type: string - enum: - - in_progress - - completed - - incomplete OpenAI.LocalShellExecAction: type: object required: @@ -29400,22 +31981,23 @@ components: type: string description: The command to run. timeout_ms: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' working_directory: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' env: type: object - additionalProperties: + unevaluatedProperties: type: string description: Environment variables to set for the command. x-oaiTypeLabel: map user: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' description: Execute a shell command on the server. title: Local shell exec action OpenAI.LocalShellToolParam: @@ -29429,7 +32011,6 @@ components: - local_shell description: The type of the local shell tool. Always `local_shell`. x-stainless-const: true - default: local_shell name: type: string description: Optional user-defined name for this tool or configuration. @@ -29488,17 +32069,17 @@ components: type: string description: The name of the tool. description: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' input_schema: allOf: - $ref: '#/components/schemas/OpenAI.MCPListToolsToolInputSchema' description: The JSON schema describing the tool's input. annotations: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.MCPListToolsToolAnnotations' - nullable: true + - type: 'null' description: A tool available on an MCP server. title: MCP list tools tool OpenAI.MCPListToolsToolAnnotations: @@ -29560,32 +32141,30 @@ components: type: string description: Optional description of the MCP server, used to provide more context. headers: - type: object - additionalProperties: - type: string - nullable: true + anyOf: + - type: object + unevaluatedProperties: + type: string + - type: 'null' allowed_tools: anyOf: - type: array items: type: string - nullable: true - - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.MCPToolFilter' - nullable: true + - $ref: '#/components/schemas/OpenAI.MCPToolFilter' + - type: 'null' require_approval: anyOf: - - type: object - allOf: - - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' - nullable: true + - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' - type: string enum: - always - never - nullable: true + - type: 'null' default: always + defer_loading: + type: boolean + description: Whether this MCP tool is deferred and discovered via tool search. project_connection_id: type: string description: The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server. @@ -29645,6 +32224,7 @@ components: refusal: '#/components/schemas/OpenAI.MessageContentRefusalContent' input_image: '#/components/schemas/OpenAI.MessageContentInputImageContent' input_file: '#/components/schemas/OpenAI.MessageContentInputFileContent' + summary_text: '#/components/schemas/OpenAI.SummaryTextContent' description: A content part that makes up an input or output item. OpenAI.MessageContentInputFileContent: type: object @@ -29659,18 +32239,23 @@ components: x-stainless-const: true default: input_file file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' filename: type: string description: The name of the file to be sent to the model. + file_data: + type: string + description: The content of the file to be sent to the model. file_url: type: string format: uri description: The URL of the file to be sent to the model. - file_data: - type: string - description: The content of the file to be sent to the model. + detail: + allOf: + - $ref: '#/components/schemas/OpenAI.FileInputDetail' + description: The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. allOf: - $ref: '#/components/schemas/OpenAI.MessageContent' description: A file input to the model. @@ -29689,16 +32274,18 @@ components: x-stainless-const: true default: input_image image_url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' file_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. allOf: - $ref: '#/components/schemas/OpenAI.MessageContent' description: An image input to the model. Learn about [image inputs](/docs/guides/vision). @@ -29808,6 +32395,15 @@ components: - input_image - computer_screenshot - input_file + OpenAI.MessagePhase: + type: string + enum: + - commentary + - final_answer + description: |- + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. OpenAI.MessageRole: type: string enum: @@ -29827,7 +32423,7 @@ components: - incomplete OpenAI.Metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -29838,13 +32434,9 @@ components: x-oaiTypeLabel: map OpenAI.ModelIdsCompaction: anyOf: - - allOf: - - $ref: '#/components/schemas/OpenAI.ModelIdsResponses' - description: Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models. - nullable: true + - $ref: '#/components/schemas/OpenAI.ModelIdsResponses' - type: string - description: Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models. - nullable: true + - type: 'null' description: Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models. OpenAI.ModelIdsResponses: anyOf: @@ -29869,6 +32461,125 @@ components: anyOf: - type: string - $ref: '#/components/schemas/OpenAI.ChatModel' + OpenAI.Moderation: + type: object + required: + - input + - output + properties: + input: + allOf: + - $ref: '#/components/schemas/OpenAI.ModerationEntry' + description: Moderation for the response input. + output: + allOf: + - $ref: '#/components/schemas/OpenAI.ModerationEntry' + description: Moderation for the response output. + description: Moderation results or errors for the response input and output. + title: Moderation + OpenAI.ModerationEntry: + type: object + required: + - type + properties: + type: + $ref: '#/components/schemas/OpenAI.ModerationEntryType' + discriminator: + propertyName: type + mapping: + moderation_result: '#/components/schemas/OpenAI.ModerationResultBody' + error: '#/components/schemas/OpenAI.ModerationErrorBody' + description: Moderation results or an error for a response moderation check. + OpenAI.ModerationEntryType: + anyOf: + - type: string + - type: string + enum: + - moderation_result + - error + OpenAI.ModerationErrorBody: + type: object + required: + - type + - code + - message + properties: + type: + type: string + enum: + - error + description: The object type, which was always `error` for moderation failures. + x-stainless-const: true + code: + type: string + description: The error code. + message: + type: string + description: The error message. + allOf: + - $ref: '#/components/schemas/OpenAI.ModerationEntry' + description: An error produced while attempting moderation for the response input or output. + title: Moderation error + OpenAI.ModerationInputType: + type: string + enum: + - text + - image + OpenAI.ModerationParam: + type: object + required: + - model + properties: + model: + type: string + description: The moderation model to use for moderated completions, e.g. 'omni-moderation-latest'. + description: Configuration for running moderation on the input and output of this response. + OpenAI.ModerationResultBody: + type: object + required: + - type + - model + - flagged + - categories + - category_scores + - category_applied_input_types + properties: + type: + type: string + enum: + - moderation_result + description: The object type, which was always `moderation_result` for successful moderation results. + x-stainless-const: true + model: + type: string + description: The moderation model that produced this result. + flagged: + type: boolean + description: A boolean indicating whether the content was flagged by any category. + categories: + type: object + unevaluatedProperties: + type: boolean + description: A dictionary of moderation categories to booleans, True if the input is flagged under this category. + x-oaiTypeLabel: map + category_scores: + type: object + unevaluatedProperties: + $ref: '#/components/schemas/OpenAI.numeric' + description: A dictionary of moderation categories to scores. + x-oaiTypeLabel: map + category_applied_input_types: + type: object + unevaluatedProperties: + type: array + items: + $ref: '#/components/schemas/OpenAI.ModerationInputType' + description: Which modalities of input are reflected by the score for each category. + x-oaiTypeLabel: map + allOf: + - $ref: '#/components/schemas/OpenAI.ModerationEntry' + description: A moderation result produced for the response input or output. + title: Moderation result OpenAI.MoveParam: type: object required: @@ -29882,7 +32593,6 @@ components: - move description: Specifies the event type. For a move action, this property is always set to `move`. x-stainless-const: true - default: move x: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -29891,10 +32601,50 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The y-coordinate to move to. + keys: + anyOf: + - type: array + items: + type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A mouse move action. title: Move + OpenAI.NamespaceToolParam: + type: object + required: + - type + - name + - description + - tools + properties: + type: + type: string + enum: + - namespace + description: The type of the tool. Always `namespace`. + x-stainless-const: true + name: + type: string + minLength: 1 + description: The namespace name used in tool calls (for example, `crm`). + description: + type: string + minLength: 1 + description: A description of the namespace shown to the model. + tools: + type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.FunctionToolParam' + - $ref: '#/components/schemas/OpenAI.CustomToolParam' + minItems: 1 + description: The function/custom tools available inside this namespace. + allOf: + - $ref: '#/components/schemas/OpenAI.Tool' + description: Groups function/custom tools under a shared namespace. + title: Namespace OpenAI.OutputContent: type: object required: @@ -30036,13 +32786,19 @@ components: output_message: '#/components/schemas/OpenAI.OutputItemOutputMessage' file_search_call: '#/components/schemas/OpenAI.OutputItemFileSearchToolCall' function_call: '#/components/schemas/OpenAI.OutputItemFunctionToolCall' + function_call_output: '#/components/schemas/OpenAI.OutputItemFunctionToolCallOutput' web_search_call: '#/components/schemas/OpenAI.OutputItemWebSearchToolCall' computer_call: '#/components/schemas/OpenAI.OutputItemComputerToolCall' + computer_call_output: '#/components/schemas/OpenAI.OutputItemComputerToolCallOutput' reasoning: '#/components/schemas/OpenAI.OutputItemReasoningItem' + tool_search_call: '#/components/schemas/OpenAI.OutputItemToolSearchCall' + tool_search_output: '#/components/schemas/OpenAI.OutputItemToolSearchOutput' + additional_tools: '#/components/schemas/OpenAI.OutputItemAdditionalTools' compaction: '#/components/schemas/OpenAI.OutputItemCompactionBody' image_generation_call: '#/components/schemas/OpenAI.OutputItemImageGenToolCall' code_interpreter_call: '#/components/schemas/OpenAI.OutputItemCodeInterpreterToolCall' local_shell_call: '#/components/schemas/OpenAI.OutputItemLocalShellToolCall' + local_shell_call_output: '#/components/schemas/OpenAI.OutputItemLocalShellToolCallOutput' shell_call: '#/components/schemas/OpenAI.OutputItemFunctionShellCall' shell_call_output: '#/components/schemas/OpenAI.OutputItemFunctionShellCallOutput' apply_patch_call: '#/components/schemas/OpenAI.OutputItemApplyPatchToolCall' @@ -30050,7 +32806,38 @@ components: mcp_call: '#/components/schemas/OpenAI.OutputItemMcpToolCall' mcp_list_tools: '#/components/schemas/OpenAI.OutputItemMcpListTools' mcp_approval_request: '#/components/schemas/OpenAI.OutputItemMcpApprovalRequest' - custom_tool_call: '#/components/schemas/OpenAI.OutputItemCustomToolCall' + mcp_approval_response: '#/components/schemas/OpenAI.OutputItemMcpApprovalResponseResource' + custom_tool_call: '#/components/schemas/OpenAI.OutputItemCustomToolCallResource' + custom_tool_call_output: '#/components/schemas/OpenAI.OutputItemCustomToolCallOutputResource' + OpenAI.OutputItemAdditionalTools: + type: object + required: + - type + - id + - role + - tools + properties: + type: + type: string + enum: + - additional_tools + description: The type of the item. Always `additional_tools`. + x-stainless-const: true + default: additional_tools + id: + type: string + description: The unique ID of the additional tools item. + role: + allOf: + - $ref: '#/components/schemas/OpenAI.MessageRole' + description: The role that provided the additional tools. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The additional tool definitions made available at this item. + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' OpenAI.OutputItemApplyPatchToolCall: type: object required: @@ -30115,8 +32902,9 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call output. @@ -30157,15 +32945,17 @@ components: type: string description: The ID of the container used to run the code. code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' outputs: - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - nullable: true + anyOf: + - type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: A tool call to run code. @@ -30203,7 +32993,6 @@ components: - type - id - call_id - - action - pending_safety_checks - status properties: @@ -30221,6 +33010,8 @@ components: description: An identifier used when responding to the tool call with output. action: $ref: '#/components/schemas/OpenAI.ComputerAction' + actions: + $ref: '#/components/schemas/OpenAI.ComputerActionList' pending_safety_checks: type: array items: @@ -30241,13 +33032,99 @@ components: A tool call to a computer use tool. See the [computer use guide](/docs/guides/tools-computer-use) for more information. title: Computer tool call - OpenAI.OutputItemCustomToolCall: + OpenAI.OutputItemComputerToolCallOutput: + type: object + required: + - type + - id + - call_id + - output + properties: + type: + type: string + enum: + - computer_call_output + description: The type of the computer tool call output. Always `computer_call_output`. + x-stainless-const: true + default: computer_call_output + id: + type: string + description: The ID of the computer tool call output. + readOnly: true + call_id: + type: string + description: The ID of the computer tool call that produced the output. + acknowledged_safety_checks: + type: array + items: + $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' + description: |- + The safety checks reported by the API that have been acknowledged by the + developer. + output: + $ref: '#/components/schemas/OpenAI.ComputerScreenshotImage' + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' + description: The output of a computer tool call. + title: Computer tool call output + OpenAI.OutputItemCustomToolCallOutputResource: + type: object + required: + - type + - call_id + - output + - status + properties: + type: + type: string + enum: + - custom_tool_call_output + description: The type of the custom tool call output. Always `custom_tool_call_output`. + x-stainless-const: true + id: + type: string + description: The unique ID of the custom tool call output in the OpenAI platform. + call_id: + type: string + description: The call ID, used to map this custom tool call output to a custom tool call. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' + title: ResponseCustomToolCallOutputItem + OpenAI.OutputItemCustomToolCallResource: type: object required: - type - call_id - name - input + - status properties: type: type: string @@ -30261,16 +33138,27 @@ components: call_id: type: string description: An identifier used to map this custom tool call to a tool call output. + namespace: + type: string + description: The namespace of the custom tool being called. name: type: string description: The name of the custom tool being called. input: type: string description: The input for the custom tool call generated by the model. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + created_by: + type: string + description: The identifier of the actor that created the item. allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' - description: A call to a custom tool created by the model. - title: Custom tool call + title: ResponseCustomToolCallItem OpenAI.OutputItemFileSearchToolCall: type: object required: @@ -30305,10 +33193,11 @@ components: type: string description: The queries used to search for files. results: - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - nullable: true + anyOf: + - type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: |- @@ -30344,13 +33233,12 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - nullable: true + - type: 'null' created_by: type: string description: The ID of the entity that created this tool call. @@ -30383,7 +33271,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -30391,10 +33279,9 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' created_by: type: string description: The identifier of the actor that created the item. @@ -30405,6 +33292,7 @@ components: OpenAI.OutputItemFunctionToolCall: type: object required: + - id - type - call_id - name @@ -30413,6 +33301,7 @@ components: id: type: string description: The unique ID of the function tool call. + readOnly: true type: type: string enum: @@ -30422,6 +33311,9 @@ components: call_id: type: string description: The unique ID of the function tool call generated by the model. + namespace: + type: string + description: The namespace of the function to run. name: type: string description: The name of the function to run. @@ -30443,6 +33335,51 @@ components: A tool call to run a function. See the [function calling guide](/docs/guides/function-calling) for more information. title: Function tool call + OpenAI.OutputItemFunctionToolCallOutput: + type: object + required: + - id + - type + - call_id + - output + properties: + id: + type: string + description: |- + The unique ID of the function tool call output. Populated when this item + is returned via API. + readOnly: true + type: + type: string + enum: + - function_call_output + description: The type of the function tool call output. Always `function_call_output`. + x-stainless-const: true + call_id: + type: string + description: The unique ID of the function tool call generated by the model. + output: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' + description: |- + The output from the function call generated by your code. + Can be a string or an list of output content. + status: + type: string + enum: + - in_progress + - completed + - incomplete + description: |- + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' + description: The output of a function tool call. + title: Function tool call output OpenAI.OutputItemImageGenToolCall: type: object required: @@ -30469,8 +33406,9 @@ components: - failed description: The status of the image generation call. result: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: An image generation request made by the model. @@ -30509,6 +33447,37 @@ components: - $ref: '#/components/schemas/OpenAI.OutputItem' description: A tool call to run a command on the local shell. title: Local shell call + OpenAI.OutputItemLocalShellToolCallOutput: + type: object + required: + - type + - id + - output + properties: + type: + type: string + enum: + - local_shell_call_output + description: The type of the local shell tool call output. Always `local_shell_call_output`. + x-stainless-const: true + id: + type: string + description: The unique ID of the local shell tool call generated by the model. + output: + type: string + description: A JSON string of the output of the local shell tool call. + status: + anyOf: + - type: string + enum: + - in_progress + - completed + - incomplete + - type: 'null' + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' + description: The output of a local shell tool call. + title: Local shell call output OpenAI.OutputItemMcpApprovalRequest: type: object required: @@ -30540,6 +33509,37 @@ components: - $ref: '#/components/schemas/OpenAI.OutputItem' description: A request for human approval of a tool invocation. title: MCP approval request + OpenAI.OutputItemMcpApprovalResponseResource: + type: object + required: + - type + - id + - approval_request_id + - approve + properties: + type: + type: string + enum: + - mcp_approval_response + description: The type of the item. Always `mcp_approval_response`. + x-stainless-const: true + id: + type: string + description: The unique ID of the approval response + approval_request_id: + type: string + description: The ID of the approval request being answered. + approve: + type: boolean + description: Whether the request was approved. + reason: + anyOf: + - type: string + - type: 'null' + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' + description: A response to an MCP approval request. + title: MCP approval response OpenAI.OutputItemMcpListTools: type: object required: @@ -30566,8 +33566,7 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - type: string - nullable: true + $ref: '#/components/schemas/OpenAI.RealtimeMCPError' allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: A list of tools available on an MCP server. @@ -30600,18 +33599,20 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' error: type: object - additionalProperties: {} + unevaluatedProperties: {} status: allOf: - $ref: '#/components/schemas/OpenAI.MCPToolCallStatus' description: The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. approval_request_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: An invocation of a tool on an MCP server. @@ -30645,6 +33646,10 @@ components: items: $ref: '#/components/schemas/OpenAI.OutputMessageContent' description: The content of the output message. + phase: + anyOf: + - $ref: '#/components/schemas/OpenAI.MessagePhase' + - type: 'null' status: type: string enum: @@ -30675,8 +33680,9 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' summary: type: array items: @@ -30704,6 +33710,87 @@ components: for subsequent turns of a conversation if you are manually [managing context](/docs/guides/conversation-state). title: Reasoning + OpenAI.OutputItemToolSearchCall: + type: object + required: + - type + - id + - call_id + - execution + - arguments + - status + properties: + type: + type: string + enum: + - tool_search_call + description: The type of the item. Always `tool_search_call`. + x-stainless-const: true + default: tool_search_call + id: + type: string + description: The unique ID of the tool search call item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + arguments: + description: Arguments used for the tool search call. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallStatus' + description: The status of the tool search call item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' + OpenAI.OutputItemToolSearchOutput: + type: object + required: + - type + - id + - call_id + - execution + - tools + - status + properties: + type: + type: string + enum: + - tool_search_output + description: The type of the item. Always `tool_search_output`. + x-stainless-const: true + default: tool_search_output + id: + type: string + description: The unique ID of the tool search output item. + call_id: + anyOf: + - type: string + - type: 'null' + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search was executed by the server or by the client. + tools: + type: array + items: + $ref: '#/components/schemas/OpenAI.Tool' + description: The loaded tool definitions returned by tool search. + status: + allOf: + - $ref: '#/components/schemas/OpenAI.FunctionCallOutputStatusEnum' + description: The status of the tool search output item that was recorded. + created_by: + type: string + description: The identifier of the actor that created the item. + allOf: + - $ref: '#/components/schemas/OpenAI.OutputItem' OpenAI.OutputItemType: anyOf: - type: string @@ -30712,13 +33799,19 @@ components: - output_message - file_search_call - function_call + - function_call_output - web_search_call - computer_call + - computer_call_output - reasoning + - tool_search_call + - tool_search_output + - additional_tools - compaction - image_generation_call - code_interpreter_call - local_shell_call + - local_shell_call_output - shell_call - shell_call_output - apply_patch_call @@ -30726,7 +33819,9 @@ components: - mcp_call - mcp_list_tools - mcp_approval_request + - mcp_approval_response - custom_tool_call + - custom_tool_call_output - structured_outputs - oauth_consent_request - memory_search_call @@ -30869,16 +33964,21 @@ components: type: string description: The unique identifier of the prompt template to use. version: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' variables: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ResponsePromptVariables' - nullable: true + - type: 'null' description: |- Reference to a prompt template and its variables. [Learn more](/docs/guides/text?api-mode=responses#reusable-prompts). + OpenAI.PromptCacheRetentionEnum: + type: string + enum: + - in_memory + - 24h OpenAI.RankerVersionType: type: string enum: @@ -30899,39 +33999,118 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.HybridSearchOptions' description: Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + OpenAI.RealtimeMCPError: + type: object + required: + - type + properties: + type: + $ref: '#/components/schemas/OpenAI.RealtimeMcpErrorType' + discriminator: + propertyName: type + mapping: + protocol_error: '#/components/schemas/OpenAI.RealtimeMCPProtocolError' + tool_execution_error: '#/components/schemas/OpenAI.RealtimeMCPToolExecutionError' + http_error: '#/components/schemas/OpenAI.RealtimeMCPHTTPError' + OpenAI.RealtimeMCPHTTPError: + type: object + required: + - type + - code + - message + properties: + type: + type: string + enum: + - http_error + x-stainless-const: true + code: + $ref: '#/components/schemas/OpenAI.integer' + message: + type: string + allOf: + - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + title: Realtime MCP HTTP error + OpenAI.RealtimeMCPProtocolError: + type: object + required: + - type + - code + - message + properties: + type: + type: string + enum: + - protocol_error + x-stainless-const: true + code: + $ref: '#/components/schemas/OpenAI.integer' + message: + type: string + allOf: + - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + title: Realtime MCP protocol error + OpenAI.RealtimeMCPToolExecutionError: + type: object + required: + - type + - message + properties: + type: + type: string + enum: + - tool_execution_error + x-stainless-const: true + message: + type: string + allOf: + - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + title: Realtime MCP tool execution error + OpenAI.RealtimeMcpErrorType: + anyOf: + - type: string + - type: string + enum: + - protocol_error + - tool_execution_error + - http_error OpenAI.Reasoning: type: object properties: effort: $ref: '#/components/schemas/OpenAI.ReasoningEffort' summary: - type: string - enum: - - auto - - concise - - detailed - nullable: true + anyOf: + - type: string + enum: + - auto + - concise + - detailed + - type: 'null' generate_summary: - type: string - enum: - - auto - - concise - - detailed - nullable: true + anyOf: + - type: string + enum: + - auto + - concise + - detailed + - type: 'null' description: |- **gpt-5 and o-series models only** Configuration options for [reasoning models](https://platform.openai.com/docs/guides/reasoning). title: Reasoning OpenAI.ReasoningEffort: - type: string - enum: - - none - - minimal - - low - - medium - - high - - xhigh + anyOf: + - type: string + enum: + - none + - minimal + - low + - medium + - high + - xhigh + - type: 'null' description: |- Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). @@ -30942,7 +34121,6 @@ components: - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`. - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. - `xhigh` is supported for all models after `gpt-5.1-codex-max`. - nullable: true OpenAI.ReasoningTextContent: type: object required: @@ -30975,26 +34153,22 @@ components: - agent_reference properties: metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' top_logprobs: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' temperature: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' default: 1 top_p: - type: number - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.numeric' - nullable: true + - type: 'null' default: 1 user: type: string @@ -31005,44 +34179,41 @@ components: deprecated: true safety_identifier: type: string + maxLength: 64 description: |- A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. - The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). + The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers). prompt_cache_key: type: string description: Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching). service_tier: $ref: '#/components/schemas/OpenAI.ServiceTier' prompt_cache_retention: - type: string - enum: - - in-memory - - 24h - nullable: true + anyOf: + - type: string + enum: + - in_memory + - 24h + - type: 'null' previous_response_id: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' model: type: string description: The model deployment to use for the creation of this response. reasoning: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Reasoning' - nullable: true + - type: 'null' background: - type: boolean - nullable: true - max_output_tokens: - type: integer - allOf: - - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + anyOf: + - type: boolean + - type: 'null' max_tool_calls: - type: integer - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.integer' - nullable: true + - type: 'null' text: $ref: '#/components/schemas/OpenAI.ResponseTextParam' tools: @@ -31054,11 +34225,12 @@ components: prompt: $ref: '#/components/schemas/OpenAI.Prompt' truncation: - type: string - enum: - - auto - - disabled - nullable: true + anyOf: + - type: string + enum: + - auto + - disabled + - type: 'null' default: disabled id: type: string @@ -31086,19 +34258,20 @@ components: format: unixtime description: Unix timestamp (in seconds) of when this Response was created. completed_at: + anyOf: + - type: string + format: date-time + - type: 'null' type: integer - format: unixtime - nullable: true + format: unixTimestamp error: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ResponseError' - nullable: true + - type: 'null' incomplete_details: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ResponseIncompleteDetails' - nullable: true + - type: 'null' output: type: array items: @@ -31117,21 +34290,29 @@ components: - type: array items: $ref: '#/components/schemas/OpenAI.InputItem' - nullable: true + - type: 'null' output_text: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' usage: $ref: '#/components/schemas/OpenAI.ResponseUsage' + moderation: + anyOf: + - $ref: '#/components/schemas/OpenAI.Moderation' + - type: 'null' parallel_tool_calls: type: boolean description: Whether to allow the model to run tool calls in parallel. default: true conversation: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ConversationReference' - nullable: true + - type: 'null' + max_output_tokens: + anyOf: + - $ref: '#/components/schemas/OpenAI.integer' + - type: 'null' agent: allOf: - $ref: '#/components/schemas/AgentId' @@ -31146,10 +34327,9 @@ components: or an auto-generated UUID. Use for session-scoped operations and to maintain sandbox affinity in follow-up calls. agent_reference: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/AgentReference' - nullable: true + - type: 'null' description: The agent used for this response content_filters: type: array @@ -31176,8 +34356,10 @@ components: description: A sequence number for this chunk of the stream response. delta: type: string - format: base64 + contentEncoding: base64 description: A chunk of Base64 encoded response audio bytes. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a partial audio response. x-oaiMeta: name: response.audio.delta @@ -31205,6 +34387,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the delta. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the audio response is complete. x-oaiMeta: name: response.audio.done @@ -31235,6 +34419,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a partial transcript of audio. x-oaiMeta: name: response.audio.transcript.delta @@ -31262,6 +34448,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the full audio transcript is completed. x-oaiMeta: name: response.audio.transcript.done @@ -31301,6 +34489,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a partial code snippet is streamed by the code interpreter. x-oaiMeta: name: response.code_interpreter_call_code.delta @@ -31342,6 +34532,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the code snippet is finalized by the code interpreter. x-oaiMeta: name: response.code_interpreter_call_code.done @@ -31379,6 +34571,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the code interpreter call is completed. x-oaiMeta: name: response.code_interpreter_call.completed @@ -31415,6 +34609,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a code interpreter call is in progress. x-oaiMeta: name: response.code_interpreter_call.in_progress @@ -31451,6 +34647,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event, used to order streaming events. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the code interpreter is actively interpreting the code snippet. x-oaiMeta: name: response.code_interpreter_call.interpreting @@ -31483,6 +34681,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number for this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the model response is complete. x-oaiMeta: name: response.completed @@ -31577,6 +34777,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a new content part is added. x-oaiMeta: name: response.content_part.added @@ -31629,6 +34831,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.OutputContent' description: The content part that is done. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a content part is done. x-oaiMeta: name: response.content_part.done @@ -31667,6 +34871,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number for this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: An event that is emitted when a response is created. x-oaiMeta: name: response.created @@ -31738,6 +34944,8 @@ components: delta: type: string description: The incremental input data (delta) for the custom tool call. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Event representing a delta (partial update) to the input of a custom tool call. title: ResponseCustomToolCallInputDelta x-oaiMeta: @@ -31779,6 +34987,8 @@ components: input: type: string description: The complete input data for the custom tool call. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Event indicating that input for a custom tool call is complete. title: ResponseCustomToolCallInputDone x-oaiMeta: @@ -31841,18 +35051,22 @@ components: description: The type of the event. Always `error`. x-stainless-const: true code: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' message: type: string description: The error message. param: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' sequence_number: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an error occurs. x-oaiMeta: name: error @@ -31886,6 +35100,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.Response' description: The response that failed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: An event that is emitted when a response fails. x-oaiMeta: name: response.failed @@ -31951,6 +35167,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a file search call is completed (results found). x-oaiMeta: name: response.file_search_call.completed @@ -31987,6 +35205,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a file search call is initiated. x-oaiMeta: name: response.file_search_call.in_progress @@ -32023,6 +35243,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a file search is currently searching. x-oaiMeta: name: response.file_search_call.searching @@ -32086,11 +35308,12 @@ components: schema: $ref: '#/components/schemas/OpenAI.ResponseFormatJsonSchemaSchema' strict: - type: boolean - nullable: true + anyOf: + - type: boolean + - type: 'null' OpenAI.ResponseFormatJsonSchemaSchema: type: object - additionalProperties: {} + unevaluatedProperties: {} description: |- The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). @@ -32137,6 +35360,8 @@ components: delta: type: string description: The function-call arguments delta that is added. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a partial function-call arguments delta. x-oaiMeta: name: response.function_call_arguments.delta @@ -32181,6 +35406,8 @@ components: arguments: type: string description: The function-call arguments. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when function-call arguments are finalized. x-oaiMeta: name: response.function_call_arguments.done @@ -32219,6 +35446,8 @@ components: item_id: type: string description: The unique identifier of the image generation item being processed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an image generation tool call has completed and the final image is available. title: ResponseImageGenCallCompletedEvent x-oaiMeta: @@ -32256,6 +35485,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the image generation item being processed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an image generation tool call is actively generating an image (intermediate state). title: ResponseImageGenCallGeneratingEvent x-oaiMeta: @@ -32293,6 +35524,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the image generation item being processed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an image generation tool call is in progress. title: ResponseImageGenCallInProgressEvent x-oaiMeta: @@ -32339,6 +35572,8 @@ components: partial_image_b64: type: string description: Base64-encoded partial image data, suitable for rendering as an image. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a partial image is available during image generation streaming. title: ResponseImageGenCallPartialImageEvent x-oaiMeta: @@ -32374,6 +35609,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the response is in progress. x-oaiMeta: name: response.in_progress @@ -32445,6 +35682,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: An event that is emitted when a response finishes as incomplete. x-oaiMeta: name: response.incomplete @@ -32502,7 +35741,7 @@ components: type: array items: $ref: '#/components/schemas/OpenAI.ResponseLogProbTopLogprobs' - description: The log probability of the top 20 most likely tokens. + description: The log probabilities of up to 20 of the most likely tokens. description: |- A logprob is the logarithmic probability that the model assigns to producing a particular token at a given position in the sequence. Less-negative (higher) @@ -32543,6 +35782,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a delta (partial update) to the arguments of an MCP tool call. title: ResponseMCPCallArgumentsDeltaEvent x-oaiMeta: @@ -32585,6 +35826,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the arguments for an MCP tool call are finalized. title: ResponseMCPCallArgumentsDoneEvent x-oaiMeta: @@ -32623,6 +35866,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an MCP tool call has completed successfully. title: ResponseMCPCallCompletedEvent x-oaiMeta: @@ -32660,6 +35905,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an MCP tool call has failed. title: ResponseMCPCallFailedEvent x-oaiMeta: @@ -32697,6 +35944,8 @@ components: item_id: type: string description: The unique identifier of the MCP tool call item being processed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an MCP tool call is in progress. title: ResponseMCPCallInProgressEvent x-oaiMeta: @@ -32734,6 +35983,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the list of available MCP tools has been successfully retrieved. title: ResponseMCPListToolsCompletedEvent x-oaiMeta: @@ -32771,6 +36022,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the attempt to list available MCP tools has failed. title: ResponseMCPListToolsFailedEvent x-oaiMeta: @@ -32808,6 +36061,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when the system is in the process of retrieving the list of available MCP tools. title: ResponseMCPListToolsInProgressEvent x-oaiMeta: @@ -32846,6 +36101,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: The output item that was added. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a new output item is added. x-oaiMeta: name: response.output_item.added @@ -32889,6 +36146,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: The output item that was marked done. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an output item is marked done. x-oaiMeta: name: response.output_item.done @@ -32952,6 +36211,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.Annotation' description: The annotation object being added. (See annotation schema for details.) + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when an annotation is added to output text content. title: ResponseOutputTextAnnotationAddedEvent x-oaiMeta: @@ -32974,7 +36235,7 @@ components: } OpenAI.ResponsePromptVariables: type: object - additionalProperties: + unevaluatedProperties: anyOf: - type: string - $ref: '#/components/schemas/OpenAI.InputTextContent' @@ -33008,6 +36269,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number for this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a response is queued and waiting to be processed. title: ResponseQueuedEvent x-oaiMeta: @@ -33059,6 +36322,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.ResponseReasoningSummaryPartAddedEventPart' description: The summary part that was added. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a new reasoning summary part is added. x-oaiMeta: name: response.reasoning_summary_part.added @@ -33123,6 +36388,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.ResponseReasoningSummaryPartDoneEventPart' description: The completed summary part. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a reasoning summary part is completed. x-oaiMeta: name: response.reasoning_summary_part.done @@ -33188,6 +36455,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a delta is added to a reasoning summary text. x-oaiMeta: name: response.reasoning_summary_text.delta @@ -33237,6 +36506,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a reasoning summary text is completed. x-oaiMeta: name: response.reasoning_summary_text.done @@ -33286,6 +36557,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a delta is added to a reasoning text. x-oaiMeta: name: response.reasoning_text.delta @@ -33333,6 +36606,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a reasoning text is completed. x-oaiMeta: name: response.reasoning_text.done @@ -33380,6 +36655,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is a partial refusal text. x-oaiMeta: name: response.refusal.delta @@ -33427,6 +36704,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of this event. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when refusal text is finalized. x-oaiMeta: name: response.refusal.done @@ -33440,6 +36719,127 @@ components: "refusal": "final refusal text", "sequence_number": 1 } + OpenAI.ResponseStreamEvent: + type: object + required: + - type + properties: + type: + $ref: '#/components/schemas/OpenAI.ResponseStreamEventType' + discriminator: + propertyName: type + mapping: + response.audio.transcript.delta: '#/components/schemas/OpenAI.ResponseAudioTranscriptDeltaEvent' + response.code_interpreter_call_code.delta: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent' + response.code_interpreter_call.in_progress: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallInProgressEvent' + response.code_interpreter_call.interpreting: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallInterpretingEvent' + response.content_part.added: '#/components/schemas/OpenAI.ResponseContentPartAddedEvent' + response.created: '#/components/schemas/OpenAI.ResponseCreatedEvent' + error: '#/components/schemas/OpenAI.ResponseErrorEvent' + response.file_search_call.in_progress: '#/components/schemas/OpenAI.ResponseFileSearchCallInProgressEvent' + response.file_search_call.searching: '#/components/schemas/OpenAI.ResponseFileSearchCallSearchingEvent' + response.function_call_arguments.delta: '#/components/schemas/OpenAI.ResponseFunctionCallArgumentsDeltaEvent' + response.in_progress: '#/components/schemas/OpenAI.ResponseInProgressEvent' + response.failed: '#/components/schemas/OpenAI.ResponseFailedEvent' + response.incomplete: '#/components/schemas/OpenAI.ResponseIncompleteEvent' + response.output_item.added: '#/components/schemas/OpenAI.ResponseOutputItemAddedEvent' + response.reasoning_summary_part.added: '#/components/schemas/OpenAI.ResponseReasoningSummaryPartAddedEvent' + response.reasoning_summary_text.delta: '#/components/schemas/OpenAI.ResponseReasoningSummaryTextDeltaEvent' + response.reasoning_text.delta: '#/components/schemas/OpenAI.ResponseReasoningTextDeltaEvent' + response.refusal.delta: '#/components/schemas/OpenAI.ResponseRefusalDeltaEvent' + response.output_text.delta: '#/components/schemas/OpenAI.ResponseTextDeltaEvent' + response.web_search_call.in_progress: '#/components/schemas/OpenAI.ResponseWebSearchCallInProgressEvent' + response.web_search_call.searching: '#/components/schemas/OpenAI.ResponseWebSearchCallSearchingEvent' + response.image_generation_call.generating: '#/components/schemas/OpenAI.ResponseImageGenCallGeneratingEvent' + response.image_generation_call.in_progress: '#/components/schemas/OpenAI.ResponseImageGenCallInProgressEvent' + response.image_generation_call.partial_image: '#/components/schemas/OpenAI.ResponseImageGenCallPartialImageEvent' + response.mcp_call_arguments.delta: '#/components/schemas/OpenAI.ResponseMCPCallArgumentsDeltaEvent' + response.mcp_call.failed: '#/components/schemas/OpenAI.ResponseMCPCallFailedEvent' + response.mcp_call.in_progress: '#/components/schemas/OpenAI.ResponseMCPCallInProgressEvent' + response.mcp_list_tools.failed: '#/components/schemas/OpenAI.ResponseMCPListToolsFailedEvent' + response.mcp_list_tools.in_progress: '#/components/schemas/OpenAI.ResponseMCPListToolsInProgressEvent' + response.output_text.annotation.added: '#/components/schemas/OpenAI.ResponseOutputTextAnnotationAddedEvent' + response.queued: '#/components/schemas/OpenAI.ResponseQueuedEvent' + response.custom_tool_call_input.delta: '#/components/schemas/OpenAI.ResponseCustomToolCallInputDeltaEvent' + response.audio.done: '#/components/schemas/OpenAI.ResponseAudioDoneEvent' + response.audio.transcript.done: '#/components/schemas/OpenAI.ResponseAudioTranscriptDoneEvent' + response.code_interpreter_call_code.done: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallCodeDoneEvent' + response.code_interpreter_call.completed: '#/components/schemas/OpenAI.ResponseCodeInterpreterCallCompletedEvent' + response.completed: '#/components/schemas/OpenAI.ResponseCompletedEvent' + response.content_part.done: '#/components/schemas/OpenAI.ResponseContentPartDoneEvent' + response.file_search_call.completed: '#/components/schemas/OpenAI.ResponseFileSearchCallCompletedEvent' + response.function_call_arguments.done: '#/components/schemas/OpenAI.ResponseFunctionCallArgumentsDoneEvent' + response.output_item.done: '#/components/schemas/OpenAI.ResponseOutputItemDoneEvent' + response.reasoning_summary_part.done: '#/components/schemas/OpenAI.ResponseReasoningSummaryPartDoneEvent' + response.reasoning_summary_text.done: '#/components/schemas/OpenAI.ResponseReasoningSummaryTextDoneEvent' + response.reasoning_text.done: '#/components/schemas/OpenAI.ResponseReasoningTextDoneEvent' + response.refusal.done: '#/components/schemas/OpenAI.ResponseRefusalDoneEvent' + response.output_text.done: '#/components/schemas/OpenAI.ResponseTextDoneEvent' + response.web_search_call.completed: '#/components/schemas/OpenAI.ResponseWebSearchCallCompletedEvent' + response.image_generation_call.completed: '#/components/schemas/OpenAI.ResponseImageGenCallCompletedEvent' + response.mcp_call_arguments.done: '#/components/schemas/OpenAI.ResponseMCPCallArgumentsDoneEvent' + response.mcp_call.completed: '#/components/schemas/OpenAI.ResponseMCPCallCompletedEvent' + response.mcp_list_tools.completed: '#/components/schemas/OpenAI.ResponseMCPListToolsCompletedEvent' + response.custom_tool_call_input.done: '#/components/schemas/OpenAI.ResponseCustomToolCallInputDoneEvent' + response.audio.delta: '#/components/schemas/OpenAI.ResponseAudioDeltaEvent' + OpenAI.ResponseStreamEventType: + anyOf: + - type: string + - type: string + enum: + - response.audio.delta + - response.audio.done + - response.audio.transcript.delta + - response.audio.transcript.done + - response.code_interpreter_call_code.delta + - response.code_interpreter_call_code.done + - response.code_interpreter_call.completed + - response.code_interpreter_call.in_progress + - response.code_interpreter_call.interpreting + - response.completed + - response.content_part.added + - response.content_part.done + - response.created + - error + - response.file_search_call.completed + - response.file_search_call.in_progress + - response.file_search_call.searching + - response.function_call_arguments.delta + - response.function_call_arguments.done + - response.in_progress + - response.failed + - response.incomplete + - response.output_item.added + - response.output_item.done + - response.reasoning_summary_part.added + - response.reasoning_summary_part.done + - response.reasoning_summary_text.delta + - response.reasoning_summary_text.done + - response.reasoning_text.delta + - response.reasoning_text.done + - response.refusal.delta + - response.refusal.done + - response.output_text.delta + - response.output_text.done + - response.web_search_call.completed + - response.web_search_call.in_progress + - response.web_search_call.searching + - response.image_generation_call.completed + - response.image_generation_call.generating + - response.image_generation_call.in_progress + - response.image_generation_call.partial_image + - response.mcp_call_arguments.delta + - response.mcp_call_arguments.done + - response.mcp_call.completed + - response.mcp_call.failed + - response.mcp_call.in_progress + - response.mcp_list_tools.completed + - response.mcp_list_tools.failed + - response.mcp_list_tools.in_progress + - response.output_text.annotation.added + - response.queued + - response.custom_tool_call_input.delta + - response.custom_tool_call_input.done OpenAI.ResponseStreamOptions: type: object properties: @@ -33494,6 +36894,8 @@ components: items: $ref: '#/components/schemas/OpenAI.ResponseLogProb' description: The log probabilities of the tokens in the delta. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when there is an additional text delta. x-oaiMeta: name: response.output_text.delta @@ -33547,6 +36949,8 @@ components: items: $ref: '#/components/schemas/OpenAI.ResponseLogProb' description: The log probabilities of the tokens in the delta. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when text content is finalized. x-oaiMeta: name: response.output_text.done @@ -33643,6 +37047,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the web search call being processed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a web search call is completed. x-oaiMeta: name: response.web_search_call.completed @@ -33679,6 +37085,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the web search call being processed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a web search call is initiated. x-oaiMeta: name: response.web_search_call.in_progress @@ -33715,6 +37123,8 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The sequence number of the web search call being processed. + allOf: + - $ref: '#/components/schemas/OpenAI.ResponseStreamEvent' description: Emitted when a web search call is executing. x-oaiMeta: name: response.web_search_call.searching @@ -33737,7 +37147,6 @@ components: - screenshot description: Specifies the event type. For a screenshot action, this property is always set to `screenshot`. x-stainless-const: true - default: screenshot allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A screenshot action. @@ -33757,7 +37166,6 @@ components: - scroll description: Specifies the event type. For a scroll action, this property is always set to `scroll`. x-stainless-const: true - default: scroll x: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -33774,10 +37182,21 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.integer' description: The vertical scroll distance. + keys: + anyOf: + - type: array + items: + type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A scroll action. title: Scroll + OpenAI.SearchContentType: + type: string + enum: + - text + - image OpenAI.SearchContextSize: type: string enum: @@ -33785,13 +37204,15 @@ components: - medium - high OpenAI.ServiceTier: - type: string - enum: - - auto - - default - - flex - - scale - - priority + anyOf: + - type: string + enum: + - auto + - default + - flex + - scale + - priority + - type: 'null' description: |- Specifies the processing type used for serving the request. - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. @@ -33799,7 +37220,13 @@ components: - If set to '[flex](/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier. - When not set, the default behavior is 'auto'. When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter. - nullable: true + OpenAI.ServiceTierEnum: + type: string + enum: + - auto + - default + - flex + - priority OpenAI.SkillReferenceParam: type: object required: @@ -33812,7 +37239,6 @@ components: - skill_reference description: References a skill created with the /v1/skills endpoint. x-stainless-const: true - default: skill_reference skill_id: type: string minLength: 1 @@ -33834,7 +37260,6 @@ components: - apply_patch description: The tool to call. Always `apply_patch`. x-stainless-const: true - default: apply_patch allOf: - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' description: Forces the model to call the apply_patch tool when executing a tool call. @@ -33850,7 +37275,6 @@ components: - shell description: The tool to call. Always `shell`. x-stainless-const: true - default: shell allOf: - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' description: Forces the model to call the shell tool when a tool call is required. @@ -33867,7 +37291,6 @@ components: - summary_text description: The type of the object. Always `summary_text`. x-stainless-const: true - default: summary_text text: type: string description: A summary of the reasoning output from the model so far. @@ -33886,7 +37309,6 @@ components: enum: - text x-stainless-const: true - default: text text: type: string allOf: @@ -33984,8 +37406,9 @@ components: schema: $ref: '#/components/schemas/OpenAI.ResponseFormatJsonSchemaSchema' strict: - type: boolean - nullable: true + anyOf: + - type: boolean + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.TextResponseFormatConfiguration' description: |- @@ -34028,6 +37451,9 @@ components: custom: '#/components/schemas/OpenAI.CustomToolParam' web_search_preview: '#/components/schemas/OpenAI.WebSearchPreviewTool' apply_patch: '#/components/schemas/OpenAI.ApplyPatchToolParam' + computer: '#/components/schemas/OpenAI.ComputerTool' + namespace: '#/components/schemas/OpenAI.NamespaceToolParam' + tool_search: '#/components/schemas/OpenAI.ToolSearchToolParam' description: A tool that can be used to generate a response. OpenAI.ToolChoiceAllowed: type: object @@ -34056,7 +37482,7 @@ components: type: array items: type: object - additionalProperties: {} + unevaluatedProperties: {} description: |- A list of tool definitions that the model should be allowed to call. For the Responses API, the list of tool definitions might look like: @@ -34085,6 +37511,34 @@ components: description: |- Indicates that the model should use a built-in tool to generate a response. [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools). + OpenAI.ToolChoiceComputer: + type: object + required: + - type + properties: + type: + type: string + enum: + - computer + allOf: + - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' + description: |- + Indicates that the model should use a built-in tool to generate a response. + [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools). + OpenAI.ToolChoiceComputerUse: + type: object + required: + - type + properties: + type: + type: string + enum: + - computer_use + allOf: + - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' + description: |- + Indicates that the model should use a built-in tool to generate a response. + [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools). OpenAI.ToolChoiceComputerUsePreview: type: object required: @@ -34181,8 +37635,9 @@ components: type: string description: The label of the MCP server to use. name: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' description: Use this option to force the model to call a specific tool on a remote MCP server. @@ -34222,6 +37677,8 @@ components: web_search_preview_2025_03_11: '#/components/schemas/OpenAI.ToolChoiceWebSearchPreview20250311' image_generation: '#/components/schemas/OpenAI.ToolChoiceImageGeneration' code_interpreter: '#/components/schemas/OpenAI.ToolChoiceCodeInterpreter' + computer: '#/components/schemas/OpenAI.ToolChoiceComputer' + computer_use: '#/components/schemas/OpenAI.ToolChoiceComputerUse' description: |- How the model should select which tool (or tools) to use when generating a response. See the `tools` parameter to see how to specify which tools @@ -34243,6 +37700,8 @@ components: - web_search_preview_2025_03_11 - image_generation - code_interpreter + - computer + - computer_use OpenAI.ToolChoiceWebSearchPreview: type: object required: @@ -34271,6 +37730,38 @@ components: description: |- Indicates that the model should use a built-in tool to generate a response. [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools). + OpenAI.ToolSearchExecutionType: + type: string + enum: + - server + - client + OpenAI.ToolSearchToolParam: + type: object + required: + - type + properties: + type: + type: string + enum: + - tool_search + description: The type of the tool. Always `tool_search`. + x-stainless-const: true + execution: + allOf: + - $ref: '#/components/schemas/OpenAI.ToolSearchExecutionType' + description: Whether tool search is executed by the server or by the client. + description: + anyOf: + - type: string + - type: 'null' + parameters: + anyOf: + - $ref: '#/components/schemas/OpenAI.EmptyModelParam' + - type: 'null' + allOf: + - $ref: '#/components/schemas/OpenAI.Tool' + description: Hosted or BYOT tool search configuration for deferred tools. + title: Tool search tool OpenAI.ToolType: anyOf: - type: string @@ -34278,6 +37769,7 @@ components: enum: - function - file_search + - computer - computer_use_preview - web_search - mcp @@ -34286,6 +37778,8 @@ components: - local_shell - shell - custom + - namespace + - tool_search - web_search_preview - apply_patch - a2a_preview @@ -34351,7 +37845,6 @@ components: - type description: Specifies the event type. For a type action, this property is always set to `type`. x-stainless-const: true - default: type text: type: string description: The text to type. @@ -34365,10 +37858,9 @@ components: - metadata properties: metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' description: |- Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. @@ -34387,7 +37879,6 @@ components: - url_citation description: The type of the URL citation. Always `url_citation`. x-stainless-const: true - default: url_citation url: type: string format: uri @@ -34409,7 +37900,7 @@ components: title: URL citation OpenAI.VectorStoreFileAttributes: type: object - additionalProperties: + unevaluatedProperties: anyOf: - type: string - $ref: '#/components/schemas/OpenAI.numeric' @@ -34422,16 +37913,17 @@ components: length of 512 characters, booleans, or numbers. x-oaiTypeLabel: map OpenAI.Verbosity: - type: string - enum: - - low - - medium - - high + anyOf: + - type: string + enum: + - low + - medium + - high + - type: 'null' description: |- Constrains the verbosity of the model's response. Lower values will result in more concise responses, while higher values will result in more verbose responses. Currently supported values are `low`, `medium`, and `high`. - nullable: true OpenAI.WaitParam: type: object required: @@ -34443,7 +37935,6 @@ components: - wait description: Specifies the event type. For a wait action, this property is always set to `wait`. x-stainless-const: true - default: wait allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A wait action. @@ -34482,9 +37973,10 @@ components: description: The action type. x-stainless-const: true url: - type: string - format: uri - nullable: true + anyOf: + - type: string + format: uri + - type: 'null' description: The URL opened by the model. description: Action type "open_page" - Opens a specific URL from search results. title: Open page action @@ -34492,7 +37984,6 @@ components: type: object required: - type - - query properties: type: type: string @@ -34502,7 +37993,7 @@ components: x-stainless-const: true query: type: string - description: '[DEPRECATED] The search query.' + description: The search query. deprecated: true queries: type: array @@ -34531,6 +38022,7 @@ components: x-stainless-const: true url: type: string + format: uri OpenAI.WebSearchApproximateLocation: type: object required: @@ -34544,17 +38036,21 @@ components: x-stainless-const: true default: approximate country: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' region: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' city: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' timezone: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' description: The approximate location of the user. title: Web search approximate location OpenAI.WebSearchPreviewTool: @@ -34568,16 +38064,18 @@ components: - web_search_preview description: The type of the web search tool. One of `web_search_preview` or `web_search_preview_2025_03_11`. x-stainless-const: true - default: web_search_preview user_location: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.ApproximateLocation' - nullable: true + - type: 'null' search_context_size: allOf: - $ref: '#/components/schemas/OpenAI.SearchContextSize' description: High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default. + search_content_types: + type: array + items: + $ref: '#/components/schemas/OpenAI.SearchContentType' allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: This tool searches the web for relevant results to use in a response. Learn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search). @@ -34592,17 +38090,14 @@ components: enum: - web_search description: The type of the web search tool. One of `web_search` or `web_search_2025_08_26`. - default: web_search filters: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.WebSearchToolFilters' - nullable: true + - type: 'null' user_location: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.WebSearchApproximateLocation' - nullable: true + - type: 'null' search_context_size: type: string enum: @@ -34633,10 +38128,11 @@ components: type: object properties: allowed_domains: - type: array - items: - type: string - nullable: true + anyOf: + - type: array + items: + type: string + - type: 'null' OpenAI.integer: type: integer format: int64 @@ -34700,7 +38196,7 @@ components: description: A description of what the function does, used by the model to choose when and how to call the function. spec: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The openapi function shape, described as a JSON Schema object. auth: allOf: @@ -34724,7 +38220,7 @@ components: description: A description of what the function does, used by the model to choose when and how to call the function. parameters: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The parameters the functions accepts, described as a JSON Schema object. required: - name @@ -34872,7 +38368,6 @@ components: type: string enum: - openapi - description: The object type, which is always 'openapi'. openapi: allOf: - $ref: '#/components/schemas/OpenApiFunctionDefinition' @@ -34880,84 +38375,47 @@ components: allOf: - $ref: '#/components/schemas/ToolboxTool' description: An OpenAPI tool stored in a toolbox. - OptimizationAgentDefinition: + OptimizationAgentIdentifier: type: object + required: + - agent_name properties: - agentName: - type: string - description: Agent name. - agentVersion: - type: string - description: Agent version. - model: + agent_name: type: string - description: Model deployment name. - systemPrompt: + description: Registered Foundry agent name (required). + agent_version: type: string - description: System prompt / instructions. - skills: - type: array - items: - type: object - additionalProperties: {} - description: Agent skills. - tools: - type: array - items: - type: object - additionalProperties: {} - description: Agent tools. - description: Agent definition returned in response payloads (includes resolved config). + description: Pinned agent version. Defaults to latest if omitted. + description: Identifies the registered Foundry agent to optimize (request-only). Skills, tools, and system_prompt are specified in options.optimization_config. OptimizationCandidate: type: object required: - name - - config - - mutations - - avgScore - - avgTokens - - passRate - - taskScores - - isParetoOptimal + - avg_score + - avg_tokens properties: - candidateId: + candidate_id: type: string description: Server-assigned candidate identifier. Use with GET /candidates/{id} sub-endpoints. name: type: string description: Display name of the candidate (e.g., 'baseline', 'instruction-v2'). - config: - allOf: - - $ref: '#/components/schemas/OptimizationAgentDefinition' - description: The agent configuration that produced this candidate. mutations: type: object - additionalProperties: {} - description: "What was mutated from the baseline (e.g., {systemPrompt: 'new prompt'})." - avgScore: + unevaluatedProperties: {} + description: "What was mutated from the baseline (e.g., {system_prompt: 'new prompt'})." + avg_score: type: number format: double description: Average composite score across all tasks. - avgTokens: + avg_tokens: type: number format: double description: Average token usage across all tasks. - passRate: - type: number - format: double - description: Fraction of tasks that met the pass threshold. - taskScores: - type: array - items: - $ref: '#/components/schemas/OptimizationTaskResult' - description: Individual task-level scores. - isParetoOptimal: - type: boolean - description: Whether this candidate is on the Pareto frontier (score vs cost). - evalId: + eval_id: type: string description: Foundry evaluation identifier used to score this candidate. - evalRunId: + eval_run_id: type: string description: Foundry evaluation run identifier for this candidate's scoring run. promotion: @@ -34965,17 +38423,115 @@ components: - $ref: '#/components/schemas/PromotionInfo' description: Promotion metadata. Null if the candidate has not been promoted. description: Aggregated evaluation result for a single candidate agent configuration across all tasks. + OptimizationDatasetCriterion: + type: object + required: + - name + - instruction + properties: + name: + type: string + description: Criterion name. + instruction: + type: string + description: Criterion instruction / description. + description: 'Evaluation criterion: a name + instruction pair used for per-item scoring.' + OptimizationDatasetInput: + type: object + required: + - type + properties: + type: + allOf: + - $ref: '#/components/schemas/OptimizationDatasetInputType' + description: Dataset input type discriminator. + discriminator: + propertyName: type + mapping: + inline: '#/components/schemas/OptimizationInlineDatasetInput' + reference: '#/components/schemas/OptimizationReferenceDatasetInput' + description: Base discriminated model for dataset input. Either inline items or a registered reference. + OptimizationDatasetInputType: + anyOf: + - type: string + - type: string + enum: + - inline + - reference + description: Discriminator values for the dataset input union. + OptimizationDatasetItem: + type: object + properties: + query: + type: string + description: The user query / prompt. + ground_truth: + type: string + description: Expected ground truth answer. + desired_num_turns: + type: integer + format: int32 + minimum: 1 + maximum: 20 + description: Desired number of conversation turns for simulation mode (1-20). + criteria: + type: array + items: + $ref: '#/components/schemas/OptimizationDatasetCriterion' + description: Per-item evaluation criteria. + description: A single item in an inline dataset. + OptimizationEvaluatorRef: + type: object + required: + - name + properties: + name: + type: string + description: Evaluator name. + version: + type: string + description: Evaluator version. If not specified, the latest version is used. + description: Reference to a named evaluator, optionally pinned to a version. + OptimizationInlineDatasetInput: + type: object + required: + - type + - items + properties: + type: + type: string + enum: + - inline + description: Dataset input type discriminator. + items: + type: array + items: + $ref: '#/components/schemas/OptimizationDatasetItem' + description: Dataset items. + allOf: + - $ref: '#/components/schemas/OptimizationDatasetInput' + description: Inline dataset — items supplied directly in the request body. OptimizationJob: type: object required: - id - status - - createdAt + - created_at + - updated_at properties: id: type: string description: Server-assigned unique identifier. readOnly: true + inputs: + allOf: + - $ref: '#/components/schemas/OptimizationJobInputs' + description: Caller-supplied inputs. + result: + allOf: + - $ref: '#/components/schemas/OptimizationJobResult' + description: Result produced on success. + readOnly: true status: allOf: - $ref: '#/components/schemas/JobStatus' @@ -34986,21 +38542,12 @@ components: - $ref: '#/components/schemas/OpenAI.Error' description: Error details — populated only on failure. readOnly: true - result: - allOf: - - $ref: '#/components/schemas/OptimizationJobResult' - description: Result produced on success. - readOnly: true - inputs: - allOf: - - $ref: '#/components/schemas/OptimizationJobInputs' - description: Caller-supplied inputs. - createdAt: + created_at: allOf: - $ref: '#/components/schemas/FoundryTimestamp' description: The timestamp when the job was created, represented in Unix time. readOnly: true - updatedAt: + updated_at: allOf: - $ref: '#/components/schemas/FoundryTimestamp' description: The timestamp when the job was last updated, represented in Unix time. @@ -35008,58 +38555,103 @@ components: progress: allOf: - $ref: '#/components/schemas/OptimizationJobProgress' - description: Progress while in flight. Absent in terminal states. + description: Progress snapshot. May be present in terminal states reflecting last-known progress. readOnly: true - dataset: - allOf: - - $ref: '#/components/schemas/DatasetInfo' - description: Metadata about the dataset used for this optimization job. + warnings: + type: array + items: + type: string + description: Non-fatal warnings emitted at any point during optimization. readOnly: true description: Agent optimization job resource — a long-running job that optimizes an agent's configuration (instructions, model, skills, tools) to maximize evaluation scores. On success, the result contains scored candidates. OptimizationJobInputs: type: object required: - agent - - trainDatasetReference + - train_dataset + - evaluators properties: agent: allOf: - - $ref: '#/components/schemas/AgentIdentifier' + - $ref: '#/components/schemas/OptimizationAgentIdentifier' description: The agent (and pinned version) being optimized. - trainDatasetReference: + train_dataset: allOf: - - $ref: '#/components/schemas/DatasetRef' - description: Reference to a registered training dataset (required). - validationDatasetReference: + - $ref: '#/components/schemas/OptimizationDatasetInput' + description: Training dataset — either inline items or a reference to a registered dataset. Required. + validation_dataset: allOf: - - $ref: '#/components/schemas/DatasetRef' + - $ref: '#/components/schemas/OptimizationDatasetInput' description: Optional held-out validation dataset for measuring generalization of the final candidate. evaluators: type: array items: - type: string - description: "Job-level evaluators (referenced by name). Per-task criteria may override. Default: ['task_adherence']." + $ref: '#/components/schemas/OptimizationEvaluatorRef' + description: Job-level evaluators referenced by name and optional version. Required; at least one must be provided. options: allOf: - $ref: '#/components/schemas/OptimizationOptions' description: Tuning knobs and run-mode. description: Caller-supplied inputs for an optimization job. + OptimizationJobListItem: + type: object + required: + - id + - status + - created_at + - updated_at + properties: + id: + type: string + description: Server-assigned unique identifier. + readOnly: true + status: + allOf: + - $ref: '#/components/schemas/JobStatus' + description: Current lifecycle status. + readOnly: true + error: + allOf: + - $ref: '#/components/schemas/OpenAI.Error' + description: Error details — populated only on failure. + readOnly: true + created_at: + allOf: + - $ref: '#/components/schemas/FoundryTimestamp' + description: The timestamp when the job was created, represented in Unix time. + readOnly: true + updated_at: + allOf: + - $ref: '#/components/schemas/FoundryTimestamp' + description: The timestamp when the job was last updated, represented in Unix time. + readOnly: true + progress: + allOf: + - $ref: '#/components/schemas/OptimizationJobProgress' + description: Progress snapshot. May be present in terminal states reflecting last-known progress. + readOnly: true + agent: + allOf: + - $ref: '#/components/schemas/OptimizationAgentIdentifier' + description: The agent targeted by this optimization job. + readOnly: true + description: Slim job representation returned by the LIST endpoint. OptimizationJobProgress: type: object required: - - currentIteration - - bestScore - - elapsedSeconds + - candidates_completed + - best_score + - elapsed_seconds properties: - currentIteration: + candidates_completed: type: integer format: int32 - description: 1-based current iteration index. - bestScore: + description: Number of candidates whose evaluation has completed so far. + best_score: type: number format: double description: Best score observed so far across all candidates. - elapsedSeconds: + elapsed_seconds: type: number format: double description: Wall-clock time elapsed in seconds since the job began executing. @@ -35068,106 +38660,61 @@ components: type: object properties: baseline: - allOf: - - $ref: '#/components/schemas/OptimizationCandidate' - description: Evaluation scores for the original (un-optimized) agent configuration. + type: string + description: Candidate ID of the original (un-optimized) baseline evaluation. best: - allOf: - - $ref: '#/components/schemas/OptimizationCandidate' - description: The highest-scoring candidate found during optimization. + type: string + description: Candidate ID of the highest-scoring candidate found during optimization. candidates: type: array items: $ref: '#/components/schemas/OptimizationCandidate' description: All evaluated candidates including baseline. - options: - allOf: - - $ref: '#/components/schemas/OptimizationOptions' - description: The options used for this optimization run. - warnings: - type: array - items: - type: string - description: Non-fatal warnings from the optimization run (e.g., target attribute failures that were skipped). - allTargetAttributesFailed: - type: boolean - description: True when all target attributes failed — only the baseline was evaluated. description: Terminal-state result body. Populated when status is succeeded or failed. OptimizationOptions: type: object properties: - maxIterations: + max_candidates: type: integer format: int32 - description: 'Maximum optimization iterations per strategy. Must be >= 1. Default: 5.' + minimum: 1 + description: 'Maximum number of optimization candidates to generate. Must be >= 1. Default: 5.' default: 5 - optimizationConfig: + optimization_config: type: object - additionalProperties: {} - description: Per-target-attribute configuration overrides. Contains skills, tools, systemPrompt for the agent, plus model space for model optimization. - evalModel: + unevaluatedProperties: {} + description: Per-target-attribute configuration overrides. Contains skills, tools, system_prompt for the agent, plus model space for model optimization. + eval_model: type: string description: Model deployment used for evaluation. Defaults to server config (typically 'gpt-4o'). - optimizationModel: + optimization_model: type: string description: Model deployment for optimization reasoning (must be gpt-5 family). Falls back to the default eval model when not set. - evaluationLevel: + evaluation_level: allOf: - $ref: '#/components/schemas/EvaluationLevel' description: Evaluation granularity. Null/omitted means per-item single-turn. Set to 'conversation' for per-conversation multi-turn simulation scoring. description: Tuning knobs and run-mode for an optimization job. - OptimizationTaskResult: + OptimizationReferenceDatasetInput: type: object required: - - taskName - - scores - - compositeScore - - tokens - - durationSeconds - - passed + - type + - name properties: - taskName: - type: string - description: Task name (from the dataset). - query: - type: string - description: The user query / input for the task. - scores: - type: object - additionalProperties: - type: number - format: double - description: Per-evaluator scores keyed by evaluator name. - compositeScore: - type: number - format: double - description: Composite score combining all evaluator scores. - tokens: - type: integer - format: int32 - description: Total tokens consumed during the agent run for this task. - durationSeconds: - type: number - format: double - description: Wall-clock seconds for this task's agent execution. - passed: - type: boolean - description: Whether the task met the pass threshold. - errorMessage: + type: type: string - description: Error message if the task failed during execution. - rationales: - type: object - additionalProperties: - type: string - description: Per-evaluator reasoning keyed by evaluator name. - response: + enum: + - reference + description: Dataset input type discriminator. + name: type: string - description: Raw agent response text. - runId: + description: Registered dataset name. + version: type: string - description: Identifier of the agent run that produced this result. - description: Per-task evaluation result for a single candidate. + description: Dataset version. If not specified, the latest version is used. + allOf: + - $ref: '#/components/schemas/OptimizationDatasetInput' + description: Reference to a registered Foundry dataset. OtlpTelemetryEndpoint: type: object required: @@ -35183,12 +38730,14 @@ components: endpoint: type: string description: The OTLP collector endpoint URL. - example: https://my-collector.example.com/otlp + examples: + - https://my-collector.example.com/otlp protocol: allOf: - $ref: '#/components/schemas/TelemetryTransportProtocol' description: The transport protocol for the OTLP endpoint. - example: Http + examples: + - Http allOf: - $ref: '#/components/schemas/TelemetryEndpoint' description: An OTLP (OpenTelemetry Protocol) telemetry export endpoint. @@ -35495,60 +39044,21 @@ components: x-ms-foundry-meta: required_previews: - MemoryStores=V1Preview - PromoteCandidateRequest: - type: object - required: - - agentName - - agentVersion - properties: - agentName: - type: string - description: Name of the Foundry agent to promote to. - agentVersion: - type: string - description: Version of the Foundry agent to promote to. - description: Request body for promoting a candidate to a Foundry agent version. - PromoteCandidateResponse: - type: object - required: - - candidateId - - status - - promotedAt - - agentName - - agentVersion - properties: - candidateId: - type: string - description: The promoted candidate id. - status: - type: string - description: Status after promotion. - promotedAt: - allOf: - - $ref: '#/components/schemas/FoundryTimestamp' - description: Timestamp when promotion occurred, represented in Unix time. - agentName: - type: string - description: Name of the Foundry agent promoted to. - agentVersion: - type: string - description: Version of the Foundry agent promoted to. - description: Response after successfully promoting a candidate. PromotionInfo: type: object required: - - promotedAt - - agentName - - agentVersion + - promoted_at + - agent_name + - agent_version properties: - promotedAt: + promoted_at: allOf: - $ref: '#/components/schemas/FoundryTimestamp' description: Timestamp when promotion occurred, represented in Unix time. - agentName: + agent_name: type: string description: Name of the Foundry agent this candidate was promoted to. - agentVersion: + agent_version: type: string description: Version of the Foundry agent this candidate was promoted to. description: Promotion metadata recorded when a candidate is deployed to a Foundry agent. @@ -35566,13 +39076,15 @@ components: type: string description: The model deployment to use for this agent. instructions: - type: string - nullable: true + anyOf: + - type: string + - type: 'null' description: A system (or developer) message inserted into the model's context. temperature: - type: number - format: float - nullable: true + anyOf: + - type: number + format: float + - type: 'null' minimum: 0 maximum: 2 description: |- @@ -35580,9 +39092,10 @@ components: We generally recommend altering this or `top_p` but not both. Defaults to `1`. default: 1 top_p: - type: number - format: float - nullable: true + anyOf: + - type: number + format: float + - type: 'null' minimum: 0 maximum: 1 description: |- @@ -35593,10 +39106,9 @@ components: Defaults to `1`. default: 1 reasoning: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Reasoning' - nullable: true + - type: 'null' tools: type: array items: @@ -35617,7 +39129,7 @@ components: description: Configuration options for a text response from the model. Can be plain text or structured JSON data. structured_inputs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/StructuredInputDefinition' description: Set of structured inputs that can participate in prompt template substitution or tool argument bindings. allOf: @@ -35812,7 +39324,7 @@ components: description: List of attack strategies or nested lists of attack strategies. simulationOnly: type: boolean - description: Simulation-only or Simulation + Evaluation. Default false, if true the scan outputs conversation not evaluation result. + description: Simulation-only or Simulation + Evaluation. If `true` the scan outputs conversation not evaluation result. The service defaults to `false` if a value is not specified by the caller. default: false riskCategories: type: array @@ -35824,12 +39336,12 @@ components: description: Application scenario for the red team operation, to generate scenario specific attacks. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Red team's tags. Unlike properties, tags are fully mutable. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. status: @@ -35981,7 +39493,7 @@ components: description: The maximum number of turns of chat history to evaluate. data_mapping: type: object - additionalProperties: + unevaluatedProperties: type: string description: Mapping from source fields to response_id field, required for retrieving chat history. source: @@ -36011,10 +39523,7 @@ components: Routine: type: object required: - - name - enabled - - triggers - - action properties: name: type: string @@ -36029,7 +39538,7 @@ components: description: Whether the routine is enabled. triggers: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/RoutineTrigger' description: The triggers configured for the routine. action: @@ -36093,9 +39602,6 @@ components: - Routines=V1Preview RoutineCreateOrUpdateRequest: type: object - required: - - triggers - - action properties: description: type: string @@ -36106,7 +39612,7 @@ components: description: Whether the routine is enabled. triggers: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/RoutineTrigger' description: The triggers configured for the routine. In v1, exactly one trigger entry is supported. action: @@ -36150,16 +39656,15 @@ components: type: object required: - id - - status - - trigger_type - - started_at properties: id: type: string - description: The MLflow run identifier for the routine attempt. + description: The unique run identifier for the routine attempt. + readOnly: true status: - type: string - description: The underlying MLflow run status. + allOf: + - $ref: '#/components/schemas/RoutineRunStatus' + description: The run status. phase: allOf: - $ref: '#/components/schemas/RoutineRunPhase' @@ -36168,6 +39673,9 @@ components: allOf: - $ref: '#/components/schemas/RoutineTriggerType' description: The trigger type that produced the routine attempt. + trigger_name: + type: string + description: The configured trigger name that produced the routine attempt. attempt_source: allOf: - $ref: '#/components/schemas/RoutineAttemptSource' @@ -36176,10 +39684,26 @@ components: allOf: - $ref: '#/components/schemas/RoutineActionType' description: The action type dispatched for the routine attempt. + agent_id: + type: string + description: The project-scoped agent identifier recorded for the routine attempt. + agent_endpoint_id: + type: string + description: The legacy endpoint-scoped agent identifier recorded for the routine attempt. + conversation_id: + type: string + description: The conversation identifier used by a responses API dispatch. + session_id: + type: string + description: The hosted-agent session identifier used by an invocations API dispatch. triggered_at: allOf: - $ref: '#/components/schemas/FoundryTimestamp' description: The logical trigger time recorded for the routine attempt. + scheduled_fire_at: + allOf: + - $ref: '#/components/schemas/FoundryTimestamp' + description: The scheduled fire time recorded for timer and schedule deliveries. started_at: allOf: - $ref: '#/components/schemas/FoundryTimestamp' @@ -36200,47 +39724,20 @@ components: task_id: type: string description: The workspace task identifier linked to the routine attempt, when available. + error_status_code: + type: integer + format: int32 + description: The downstream error status code captured for a failed attempt, when available. error_type: type: string description: The fully qualified error type captured for a failed attempt, when available. error_message: type: string description: The truncated failure message captured for a failed attempt, when available. - diagnostics: - allOf: - - $ref: '#/components/schemas/RoutineRunDiagnostics' - description: Diagnostic data captured for the routine attempt. description: A single routine run returned from the run history API. x-ms-foundry-meta: conditional_previews: - Routines=V1Preview - RoutineRunDiagnostics: - type: object - required: - - parameters - - tags - - metrics - properties: - parameters: - type: object - additionalProperties: - type: string - description: MLflow parameters recorded on the run, keyed by parameter name. - tags: - type: object - additionalProperties: - type: string - description: MLflow tags recorded on the run, keyed by tag name. - metrics: - type: object - additionalProperties: - type: number - format: double - description: Latest MLflow metric values recorded on the run, keyed by metric name. - description: Generic diagnostics captured on a routine run. - x-ms-foundry-meta: - conditional_previews: - - Routines=V1Preview RoutineRunPhase: anyOf: - type: string @@ -36254,6 +39751,12 @@ components: x-ms-foundry-meta: conditional_previews: - Routines=V1Preview + RoutineRunStatus: + type: string + description: The status of a routine run. + x-ms-foundry-meta: + conditional_previews: + - Routines=V1Preview RoutineTrigger: type: object required: @@ -36268,7 +39771,8 @@ components: mapping: schedule: '#/components/schemas/ScheduleRoutineTrigger' timer: '#/components/schemas/TimerRoutineTrigger' - github_issue_opened: '#/components/schemas/GitHubIssueOpenedRoutineTrigger' + github_issue: '#/components/schemas/GitHubIssueRoutineTrigger' + custom: '#/components/schemas/CustomRoutineTrigger' description: Base model for a routine trigger. x-ms-foundry-meta: conditional_previews: @@ -36278,7 +39782,8 @@ components: - type: string - type: string enum: - - github_issue_opened + - custom + - github_issue - schedule - timer description: The discriminator values supported for routine triggers. @@ -36389,17 +39894,17 @@ components: description: Task for the schedule. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Schedule's tags. Unlike properties, tags are fully mutable. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Schedule's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. systemData: type: object - additionalProperties: + unevaluatedProperties: type: string description: System metadata for the resource. readOnly: true @@ -36467,7 +39972,7 @@ components: readOnly: true properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Properties of the schedule run. readOnly: true @@ -36483,7 +39988,7 @@ components: description: Type of the task. configuration: type: object - additionalProperties: + unevaluatedProperties: type: string description: Configuration for the task. discriminator: @@ -36527,9 +40032,19 @@ components: SessionDirectoryListResponse: type: object required: + - has_more - path - entries properties: + first_id: + type: string + description: The first ID represented in this list. + last_id: + type: string + description: The last ID represented in this list. + has_more: + type: boolean + description: A value indicating whether there are additional values available not captured in this list. path: type: string description: The path that was listed, relative to the session home directory. @@ -36538,7 +40053,6 @@ components: items: $ref: '#/components/schemas/SessionDirectoryEntry' description: The directory entries. - description: Response from listing a directory in a session sandbox. SessionFileWriteResponse: type: object required: @@ -36563,11 +40077,13 @@ components: allOf: - $ref: '#/components/schemas/SessionLogEventType' description: The SSE event type. Currently `log`, but additional event types may be added in the future. Clients should ignore unrecognized event types. - example: log + examples: + - log data: type: string description: The event payload as plain text. Currently JSON-formatted but the schema is not contractual and may change. - example: '{"timestamp":"2026-03-10T09:33:17.121467567+00:00","stream":"stdout","message":"Starting server on port 18080"}' + examples: + - '{"timestamp":"2026-03-10T09:33:17.121467567+00:00","stream":"stdout","message":"Starting server on port 18080"}' description: |- A single Server-Sent Event frame emitted by the hosted agent session log stream. @@ -36769,7 +40285,7 @@ components: description: Environment requirements or compatibility notes for the skill. metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: Arbitrary key-value metadata for additional properties. allowed_tools: @@ -36851,11 +40367,11 @@ components: description: The default value for the input if no run-time value is provided. schema: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The JSON schema for the structured input (optional). required: type: boolean - description: Whether the input property is required when the agent is invoked. Defaults to `false`. + description: Whether the input property is required when the agent is invoked. The service defaults to `false` if a value is not specified by the caller. default: false description: An structured input that can participate in prompt template substitutions and tool argument binding. StructuredOutputDefinition: @@ -36874,11 +40390,12 @@ components: description: A description of the output to emit. Used by the model to determine when to emit the output. schema: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The JSON schema for the structured output. strict: - type: boolean - nullable: true + anyOf: + - type: boolean + - type: 'null' description: Whether to enforce strict validation. Default `true`. description: A structured output that can be produced by the agent. StructuredOutputsOutputItem: @@ -37083,7 +40600,7 @@ components: description: List of taxonomy sub categories. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Additional properties for the taxonomy category. description: Taxonomy category definition. @@ -37108,7 +40625,7 @@ components: description: List of taxonomy items under this sub-category. properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: Additional properties for the taxonomy sub-category. description: Taxonomy sub-category definition. @@ -37155,10 +40672,10 @@ components: items: $ref: '#/components/schemas/TelemetryDataKind' description: Data types to export to this endpoint. Use an empty array to export no data. - example: - - ContainerStdoutStderr - - ContainerOtel - - Metrics + examples: + - - ContainerStdoutStderr + - ContainerOtel + - Metrics auth: allOf: - $ref: '#/components/schemas/TelemetryEndpointAuth' @@ -37242,10 +40759,11 @@ components: description: The version of the evaluator. Latest version if not specified. initialization_parameters: type: object + unevaluatedProperties: {} description: The initialization parameters for the evaluation. Must support structured outputs. data_mapping: type: object - additionalProperties: + unevaluatedProperties: type: string description: The model to use for the evaluation. Must support structured outputs. description: An Azure AI Evaluator grader used as testing criterion in evaluations. @@ -37254,7 +40772,6 @@ components: type: object required: - type - - at properties: type: type: string @@ -37262,11 +40779,9 @@ components: - timer description: The trigger type. at: - type: string - description: A future timer expression. Supported values include an ISO-8601 timestamp with an explicit offset, a local timestamp paired with time_zone, or a positive duration from now. - time_zone: - type: string - description: An optional IANA or Windows time zone identifier when the timer uses a local timestamp. + allOf: + - $ref: '#/components/schemas/FoundryTimestamp' + description: The UTC date and time at which the timer fires. allOf: - $ref: '#/components/schemas/RoutineTrigger' description: A one-shot timer routine trigger. @@ -37276,7 +40791,7 @@ components: ToolCallOutputContent: anyOf: - type: object - additionalProperties: {} + unevaluatedProperties: {} - type: string - type: array items: {} @@ -37426,7 +40941,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - additionalProperties: + unevaluatedProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -37471,10 +40986,11 @@ components: - tools properties: metadata: - type: object - additionalProperties: - type: string - nullable: true + anyOf: + - type: object + unevaluatedProperties: + type: string + - type: 'null' description: |- Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured @@ -37769,7 +41285,7 @@ components: properties: metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -37788,7 +41304,7 @@ components: description: The manifest ID to import the agent version from. parameter_values: type: object - additionalProperties: {} + unevaluatedProperties: {} description: The inputs to the manifest that will result in a fully materialized Agent. UpdateAgentRequest: type: object @@ -37797,7 +41313,7 @@ components: properties: metadata: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -37834,13 +41350,12 @@ components: name: type: string metadata: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.Metadata' - nullable: true + - type: 'null' properties: type: object - additionalProperties: + unevaluatedProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -37853,7 +41368,7 @@ components: description: The asset description text. tags: type: object - additionalProperties: + unevaluatedProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Request body for updating a model version. Only description and tags can be modified. @@ -38016,18 +41531,14 @@ components: type: string enum: - web_search - description: The type of the web search tool. One of `web_search` or `web_search_2025_08_26`. - default: web_search filters: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.WebSearchToolFilters' - nullable: true + - type: 'null' user_location: - type: object - allOf: + anyOf: - $ref: '#/components/schemas/OpenAI.WebSearchApproximateLocation' - nullable: true + - type: 'null' search_context_size: type: string enum: @@ -38097,7 +41608,6 @@ components: type: string enum: - work_iq_preview - description: The object type, which is always 'work_iq_preview'. project_connection_id: type: string description: The ID of the WorkIQ project connection. @@ -38182,7 +41692,7 @@ components: description: The model deployment to be evaluated. Accepts either the deployment name alone or with the connection name as '{connectionName}/modelDeploymentName'. modelParams: type: object - additionalProperties: {} + unevaluatedProperties: {} description: Optional parameters passed to the model for evaluation. allOf: - $ref: '#/components/schemas/EvaluationTarget' diff --git a/specification/ai-foundry/data-plane/Foundry/src/toolboxes/models.tsp b/specification/ai-foundry/data-plane/Foundry/src/toolboxes/models.tsp index c38f29fded61..53e02b2ff2df 100644 --- a/specification/ai-foundry/data-plane/Foundry/src/toolboxes/models.tsp +++ b/specification/ai-foundry/data-plane/Foundry/src/toolboxes/models.tsp @@ -4,10 +4,13 @@ import "../agents/models.tsp"; import "../skills/models.tsp"; using TypeSpec.Http; -using TypeSpec.OpenAPI; namespace Azure.AI.Projects; +const ToolboxesRequiredPreviews = #{ + conditional_previews: #[FoundryFeaturesOptInKeys.toolboxes_v1_preview], +}; + /** * Per-tool configuration that controls tool visibility and search behavior. */ @@ -50,7 +53,7 @@ model WithFieldsOptional { * Spreads tool-specific fields from `Source`, excluding fields owned by `ToolboxTool`. */ alias ToolFields = { - ...OmitProperties; + ...OmitProperties; }; /** @@ -87,6 +90,8 @@ model ToolboxTool { * A code interpreter tool stored in a toolbox. */ model CodeInterpreterToolboxTool extends ToolboxTool { + type: "code_interpreter"; + ...ToolFields; } @@ -94,6 +99,8 @@ model CodeInterpreterToolboxTool extends ToolboxTool { * A file search tool stored in a toolbox. */ model FileSearchToolboxTool extends ToolboxTool { + type: "file_search"; + ...WithFieldsOptional< ToolFields, "vector_store_ids" @@ -104,6 +111,8 @@ model FileSearchToolboxTool extends ToolboxTool { * A web search tool stored in a toolbox. */ model WebSearchToolboxTool extends ToolboxTool { + type: "web_search"; + ...ToolFields; } @@ -111,6 +120,8 @@ model WebSearchToolboxTool extends ToolboxTool { * An MCP tool stored in a toolbox. */ model MCPToolboxTool extends ToolboxTool { + type: "mcp"; + ...ToolFields; } @@ -118,6 +129,8 @@ model MCPToolboxTool extends ToolboxTool { * An Azure AI Search tool stored in a toolbox. */ model AzureAISearchToolboxTool extends ToolboxTool { + type: "azure_ai_search"; + ...ToolFields; } @@ -125,6 +138,8 @@ model AzureAISearchToolboxTool extends ToolboxTool { * An OpenAPI tool stored in a toolbox. */ model OpenApiToolboxTool extends ToolboxTool { + type: "openapi"; + ...ToolFields; } @@ -132,6 +147,8 @@ model OpenApiToolboxTool extends ToolboxTool { * An A2A tool stored in a toolbox. */ model A2APreviewToolboxTool extends ToolboxTool { + type: "a2a_preview"; + ...ToolFields; } @@ -139,6 +156,8 @@ model A2APreviewToolboxTool extends ToolboxTool { * A WorkIQ tool stored in a toolbox. */ model WorkIQPreviewToolboxTool extends ToolboxTool { + type: "work_iq_preview"; + ...ToolFields; } @@ -146,6 +165,8 @@ model WorkIQPreviewToolboxTool extends ToolboxTool { * A FabricIQ tool stored in a toolbox. */ model FabricIQPreviewToolboxTool extends ToolboxTool { + type: "fabric_iq_preview"; + ...ToolFields; } diff --git a/specification/ai-foundry/data-plane/Foundry/src/tools/models.tsp b/specification/ai-foundry/data-plane/Foundry/src/tools/models.tsp index 2de8f208ae1e..23265c30cf41 100644 --- a/specification/ai-foundry/data-plane/Foundry/src/tools/models.tsp +++ b/specification/ai-foundry/data-plane/Foundry/src/tools/models.tsp @@ -44,7 +44,8 @@ namespace Azure.AI.Projects { @@copyVariants(OpenAI.IncludeEnum, Azure.AI.Projects._AgentIncludable); #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" - @@copyProperties(OpenAI.MCPTool, + @@copyProperties( + OpenAI.MCPTool, { /** * The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server. @@ -54,7 +55,8 @@ namespace Azure.AI.Projects { ); #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" - @@copyProperties(OpenAI.WebSearchTool, + @@copyProperties( + OpenAI.WebSearchTool, { ...ToolNameAndDescriptionExtension, @@ -67,35 +69,40 @@ namespace Azure.AI.Projects { ); #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" - @@copyProperties(OpenAI.CodeInterpreterTool, + @@copyProperties( + OpenAI.CodeInterpreterTool, { ...ToolNameAndDescriptionExtension, } ); #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" - @@copyProperties(OpenAI.ImageGenTool, + @@copyProperties( + OpenAI.ImageGenTool, { ...ToolNameAndDescriptionExtension, } ); #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" - @@copyProperties(OpenAI.LocalShellToolParam, + @@copyProperties( + OpenAI.LocalShellToolParam, { ...ToolNameAndDescriptionExtension, } ); #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" - @@copyProperties(OpenAI.FunctionShellToolParam, + @@copyProperties( + OpenAI.FunctionShellToolParam, { ...ToolNameAndDescriptionExtension, } ); #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" - @@copyProperties(OpenAI.FileSearchTool, + @@copyProperties( + OpenAI.FileSearchTool, { ...ToolNameAndDescriptionExtension, }