From cdc929865886626f0d74465168a0b869a7448138 Mon Sep 17 00:00:00 2001 From: Vishwanath Balaji Date: Fri, 22 May 2026 17:50:13 -0700 Subject: [PATCH 01/12] Decouple toolbox tool schemas Separate toolbox tool request shapes from OpenAI tool schemas and limit toolbox tools to the supported toolbox surface. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../v1/microsoft-foundry-openapi3.json | 779 ++++++++++++----- .../v1/microsoft-foundry-openapi3.yaml | 635 +++++++++----- .../microsoft-foundry-openapi3.json | 786 +++++++++++++----- .../microsoft-foundry-openapi3.yaml | 643 ++++++++------ .../Foundry/src/toolboxes/models.tsp | 4 +- .../data-plane/Foundry/src/tools/models.tsp | 264 ++++-- 6 files changed, 2111 insertions(+), 1000 deletions(-) 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 e577097995e9..495e9b4f41f2 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 @@ -14556,7 +14556,7 @@ "tools": { "type": "array", "items": { - "$ref": "#/components/schemas/OpenAI.Tool" + "$ref": "#/components/schemas/ToolboxTool" }, "description": "The list of tools to include in this version." }, @@ -14958,13 +14958,6 @@ "type": "string", "description": "Optional user-defined description for this tool or configuration." }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." - }, "base_url": { "type": "string", "format": "uri", @@ -14986,6 +14979,48 @@ ], "description": "An agent implementing the A2A protocol." }, + "A2APreviewToolbox": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "a2a_preview" + ], + "description": "The type of the tool. Always `a2a_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." + }, + "base_url": { + "type": "string", + "format": "uri", + "description": "Base URL of the agent." + }, + "agent_card_path": { + "type": "string", + "description": "The path to the agent card relative to the `base_url`.\nIf not provided, defaults to `/.well-known/agent-card.json`" + }, + "project_connection_id": { + "type": "string", + "description": "The connection ID in the project for the A2A server.\nThe connection stores authentication and other connection details needed to connect to the A2A server." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/ToolboxTool" + } + ], + "description": "An A2A tool stored in a toolbox." + }, "A2AToolCall": { "type": "object", "required": [ @@ -16755,13 +16790,6 @@ "type": "string", "description": "Optional user-defined description for this tool or configuration." }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." - }, "azure_ai_search": { "allOf": [ { @@ -16876,6 +16904,44 @@ }, "description": "A set of index resources used by the `azure_ai_search` tool." }, + "AzureAISearchToolbox": { + "type": "object", + "required": [ + "type", + "azure_ai_search" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "azure_ai_search" + ], + "description": "The type of the tool. Always `azure_ai_search`." + }, + "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." + }, + "azure_ai_search": { + "allOf": [ + { + "$ref": "#/components/schemas/AzureAISearchToolResource" + } + ], + "description": "The azure ai search index resource." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/ToolboxTool" + } + ], + "description": "An Azure AI Search tool stored in a toolbox." + }, "AzureAITraceDataSourcePreviewEvalRunDataSource": { "type": "object", "required": [ @@ -17408,13 +17474,6 @@ } ], "description": "The Azure Function Tool definition." - }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." } }, "allOf": [ @@ -17626,13 +17685,6 @@ "type": "string", "description": "Optional user-defined description for this tool or configuration." }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." - }, "bing_custom_search_preview": { "allOf": [ { @@ -17816,13 +17868,6 @@ "type": "string", "description": "Optional user-defined description for this tool or configuration." }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." - }, "bing_grounding": { "allOf": [ { @@ -18018,13 +18063,6 @@ "type": "string", "description": "Optional user-defined description for this tool or configuration." }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." - }, "browser_automation_preview": { "allOf": [ { @@ -18328,13 +18366,6 @@ "type": "string", "description": "Optional user-defined description for this tool or configuration." }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." - }, "outputs": { "allOf": [ { @@ -18569,6 +18600,38 @@ ], "description": "How package dependencies are resolved at deployment time for a code-based hosted agent." }, + "CodeInterpreterToolbox": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_interpreter" + ], + "description": "The type of the tool. Always `code_interpreter`." + }, + "container": { + "anyOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/OpenAI.AutoCodeInterpreterToolParam" + } + ], + "description": "The code interpreter container. Can be a container ID or an object that\nspecifies uploaded file IDs to make available to your code, along with an\noptional `memory_limit` setting.\nIf not provided, the service assumes auto." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/ToolboxTool" + } + ], + "description": "A code interpreter tool stored in a toolbox." + }, "CompletionMessageToolCallChunk": { "type": "object", "required": [ @@ -22584,13 +22647,6 @@ "description": { "type": "string", "description": "Optional user-defined description for this tool or configuration." - }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." } }, "allOf": [ @@ -22600,6 +22656,68 @@ ], "description": "A FabricIQ server-side tool." }, + "FabricIQPreviewToolbox": { + "type": "object", + "required": [ + "type", + "project_connection_id" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "fabric_iq_preview" + ], + "description": "The type of the tool. Always `fabric_iq_preview`." + }, + "project_connection_id": { + "type": "string", + "description": "The ID of the FabricIQ project connection." + }, + "server_label": { + "type": "string", + "description": "(Optional) The label of the FabricIQ MCP server to connect to." + }, + "server_url": { + "type": "string", + "format": "uri", + "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 + }, + { + "type": "string", + "nullable": true + } + ], + "description": "(Optional) Whether the agent requires approval before executing actions. Default is always.", + "default": "always" + }, + "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." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/ToolboxTool" + } + ], + "description": "A FabricIQ tool stored in a toolbox." + }, "FileDataGenerationJobOutput": { "type": "object", "required": [ @@ -22701,6 +22819,60 @@ ], "description": "FileDatasetVersion Definition" }, + "FileSearchToolbox": { + "type": "object", + "required": [ + "type", + "vector_store_ids" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_search" + ], + "description": "The type of the tool. Always `file_search`.", + "default": "file_search" + }, + "vector_store_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of the vector stores to search." + }, + "max_num_results": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + } + ], + "description": "The maximum number of results to return. This number should be between 1 and 50 inclusive." + }, + "ranking_options": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.RankingOptions" + } + ], + "description": "Ranking options for search." + }, + "filters": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Filters" + } + ], + "nullable": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/ToolboxTool" + } + ], + "description": "A file search tool stored in a toolbox." + }, "FilterStrategyType": { "anyOf": [ { @@ -23866,6 +24038,112 @@ }, "description": "Adapter-specific metadata for LoRA models. Drives serving engine configuration at deployment time." }, + "MCPToolbox": { + "type": "object", + "required": [ + "type", + "server_label" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "mcp" + ], + "description": "The type of the tool. Always `mcp`." + }, + "server_label": { + "type": "string", + "description": "A label for this MCP server, used to identify it in tool calls." + }, + "server_url": { + "type": "string", + "format": "uri", + "description": "The URL for the MCP server. One of `server_url` or `connector_id` must be\n provided." + }, + "connector_id": { + "type": "string", + "enum": [ + "connector_dropbox", + "connector_gmail", + "connector_googlecalendar", + "connector_googledrive", + "connector_microsoftteams", + "connector_outlookcalendar", + "connector_outlookemail", + "connector_sharepoint" + ], + "description": "Identifier for service connectors, like those available in ChatGPT. One of\n `server_url` or `connector_id` must be provided. Learn more about service\n connectors [here](/docs/guides/tools-remote-mcp#connectors).\n Currently supported `connector_id` values are:\n - Dropbox: `connector_dropbox`\n - Gmail: `connector_gmail`\n - Google Calendar: `connector_googlecalendar`\n - Google Drive: `connector_googledrive`\n - Microsoft Teams: `connector_microsoftteams`\n - Outlook Calendar: `connector_outlookcalendar`\n - Outlook Email: `connector_outlookemail`\n - SharePoint: `connector_sharepoint`" + }, + "authorization": { + "type": "string", + "description": "An OAuth access token that can be used with a remote MCP server, either\n with a custom MCP server URL or a service connector. Your application\n must handle the OAuth authorization flow and provide the token here." + }, + "server_description": { + "type": "string", + "description": "Optional description of the MCP server, used to provide more context." + }, + "headers": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "nullable": true + }, + "allowed_tools": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + }, + { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MCPToolFilter" + } + ], + "nullable": true + } + ] + }, + "require_approval": { + "anyOf": [ + { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" + } + ], + "nullable": true + }, + { + "type": "string", + "enum": [ + "always", + "never" + ], + "nullable": true + } + ], + "default": "always" + }, + "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." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/ToolboxTool" + } + ], + "description": "An MCP tool stored in a toolbox." + }, "ManagedAgentIdentityBlueprintReference": { "type": "object", "required": [ @@ -24198,13 +24476,6 @@ "type": "string", "description": "Optional user-defined description for this tool or configuration." }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." - }, "memory_store_name": { "type": "string", "description": "The name of the memory store to use." @@ -24731,13 +25002,6 @@ "type": "string", "description": "Optional user-defined description for this tool or configuration." }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." - }, "fabric_dataagent_preview": { "allOf": [ { @@ -25806,21 +26070,6 @@ "description": "The type of the code interpreter tool. Always `code_interpreter`.", "x-stainless-const": true }, - "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." - }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." - }, "container": { "anyOf": [ { @@ -30153,21 +30402,6 @@ } ], "nullable": true - }, - "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." - }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." } }, "allOf": [ @@ -31594,21 +31828,6 @@ } ], "nullable": true - }, - "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." - }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." } }, "allOf": [ @@ -32293,21 +32512,6 @@ } ], "description": "Whether to generate a new image or edit an existing image. Default: `auto`." - }, - "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." - }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." } }, "allOf": [ @@ -38052,21 +38256,6 @@ "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." - }, - "description": { - "type": "string", - "description": "Optional user-defined description for this tool or configuration." - }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." } }, "allOf": [ @@ -38266,17 +38455,6 @@ } ], "default": "always" - }, - "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." - }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." } }, "allOf": [ @@ -43757,26 +43935,26 @@ "discriminator": { "propertyName": "type", "mapping": { + "code_interpreter": "#/components/schemas/OpenAI.CodeInterpreterTool", + "file_search": "#/components/schemas/OpenAI.FileSearchTool", + "web_search": "#/components/schemas/OpenAI.WebSearchTool", + "mcp": "#/components/schemas/OpenAI.MCPTool", + "azure_ai_search": "#/components/schemas/AzureAISearchTool", + "openapi": "#/components/schemas/OpenApiTool", + "a2a_preview": "#/components/schemas/A2APreviewTool", + "work_iq_preview": "#/components/schemas/WorkIQPreviewTool", + "fabric_iq_preview": "#/components/schemas/FabricIQPreviewTool", + "toolbox_search_preview": "#/components/schemas/ToolboxSearchPreviewTool", "bing_grounding": "#/components/schemas/BingGroundingTool", "fabric_dataagent_preview": "#/components/schemas/MicrosoftFabricPreviewTool", "sharepoint_grounding_preview": "#/components/schemas/SharepointPreviewTool", - "azure_ai_search": "#/components/schemas/AzureAISearchTool", - "openapi": "#/components/schemas/OpenApiTool", "bing_custom_search_preview": "#/components/schemas/BingCustomSearchPreviewTool", "browser_automation_preview": "#/components/schemas/BrowserAutomationPreviewTool", "azure_function": "#/components/schemas/AzureFunctionTool", "capture_structured_outputs": "#/components/schemas/CaptureStructuredOutputsTool", - "a2a_preview": "#/components/schemas/A2APreviewTool", - "work_iq_preview": "#/components/schemas/WorkIQPreviewTool", - "fabric_iq_preview": "#/components/schemas/FabricIQPreviewTool", "memory_search_preview": "#/components/schemas/MemorySearchPreviewTool", - "toolbox_search_preview": "#/components/schemas/ToolboxSearchPreviewTool", - "code_interpreter": "#/components/schemas/OpenAI.CodeInterpreterTool", "function": "#/components/schemas/OpenAI.FunctionTool", - "file_search": "#/components/schemas/OpenAI.FileSearchTool", "computer_use_preview": "#/components/schemas/OpenAI.ComputerUsePreviewTool", - "web_search": "#/components/schemas/OpenAI.WebSearchTool", - "mcp": "#/components/schemas/OpenAI.MCPTool", "image_generation": "#/components/schemas/OpenAI.ImageGenTool", "local_shell": "#/components/schemas/OpenAI.LocalShellToolParam", "shell": "#/components/schemas/OpenAI.FunctionShellToolParam", @@ -44549,29 +44727,6 @@ ], "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.", "default": "medium" - }, - "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." - }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." - }, - "custom_search_configuration": { - "allOf": [ - { - "$ref": "#/components/schemas/WebSearchConfiguration" - } - ], - "description": "The project connections attached to this tool. There can be a maximum of 1 connection\nresource attached to the tool." } }, "allOf": [ @@ -44837,13 +44992,6 @@ } ], "description": "The openapi function definition." - }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." } }, "allOf": [ @@ -44944,6 +45092,36 @@ ], "description": "The output of an OpenAPI tool call." }, + "OpenApiToolbox": { + "type": "object", + "required": [ + "type", + "openapi" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "openapi" + ], + "description": "The type of the tool. Always `openapi`." + }, + "openapi": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenApiFunctionDefinition" + } + ], + "description": "The openapi function definition." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/ToolboxTool" + } + ], + "description": "An OpenAPI tool stored in a toolbox." + }, "OptimizationAgentDefinition": { "type": "object", "properties": { @@ -47506,13 +47684,6 @@ "type": "string", "description": "Optional user-defined description for this tool or configuration." }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." - }, "sharepoint_grounding_preview": { "allOf": [ { @@ -48535,13 +48706,6 @@ "description": { "type": "string", "description": "Optional user-defined description for this tool or configuration." - }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." } }, "allOf": [ @@ -48551,6 +48715,35 @@ ], "description": "A tool for searching over the agent's toolbox.\nWhen present, deferred tools are hidden from `tools/list` and only\ndiscoverable via `search_tools` queries at runtime." }, + "ToolboxSearchPreviewToolbox": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "toolbox_search_preview" + ], + "description": "The type of the tool. Always `toolbox_search_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." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/ToolboxTool" + } + ], + "description": "A toolbox search tool stored in a toolbox." + }, "ToolboxSkill": { "type": "object", "required": [ @@ -48604,6 +48797,69 @@ ], "description": "A reference to an existing skill to include in a toolbox." }, + "ToolboxTool": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "allOf": [ + { + "$ref": "#/components/schemas/ToolboxToolType" + } + ], + "description": "The type of tool." + }, + "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." + }, + "tool_configs": { + "type": "object", + "additionalProperties": { + "$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." + } + }, + "discriminator": { + "propertyName": "type", + "mapping": { + "code_interpreter": "#/components/schemas/CodeInterpreterToolbox", + "file_search": "#/components/schemas/FileSearchToolbox", + "web_search": "#/components/schemas/WebSearchToolbox", + "mcp": "#/components/schemas/MCPToolbox", + "azure_ai_search": "#/components/schemas/AzureAISearchToolbox", + "openapi": "#/components/schemas/OpenApiToolbox", + "a2a_preview": "#/components/schemas/A2APreviewToolbox", + "work_iq_preview": "#/components/schemas/WorkIQPreviewToolbox", + "fabric_iq_preview": "#/components/schemas/FabricIQPreviewToolbox", + "toolbox_search_preview": "#/components/schemas/ToolboxSearchPreviewToolbox" + } + }, + "description": "An abstract representation of a tool stored in a toolbox." + }, + "ToolboxToolType": { + "type": "string", + "enum": [ + "code_interpreter", + "file_search", + "web_search", + "mcp", + "azure_ai_search", + "openapi", + "a2a_preview", + "work_iq_preview", + "fabric_iq_preview", + "toolbox_search_preview" + ], + "description": "Supported tool types for tools stored in a toolbox." + }, "ToolboxVersionObject": { "type": "object", "required": [ @@ -48650,7 +48906,7 @@ "tools": { "type": "array", "items": { - "$ref": "#/components/schemas/OpenAI.Tool" + "$ref": "#/components/schemas/ToolboxTool" }, "description": "The list of tools contained in this toolbox version." }, @@ -49335,6 +49591,64 @@ }, "description": "A web search configuration for bing custom search" }, + "WebSearchToolbox": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "web_search" + ], + "description": "The type of the tool. Always `web_search`.", + "default": "web_search" + }, + "filters": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.WebSearchToolFilters" + } + ], + "nullable": true + }, + "user_location": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.WebSearchApproximateLocation" + } + ], + "nullable": true + }, + "search_context_size": { + "type": "string", + "enum": [ + "low", + "medium", + "high" + ], + "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.", + "default": "medium" + }, + "custom_search_configuration": { + "allOf": [ + { + "$ref": "#/components/schemas/WebSearchConfiguration" + } + ], + "description": "The project connections attached to this tool. There can be a maximum of 1 connection\nresource attached to the tool." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/ToolboxTool" + } + ], + "description": "A web search tool stored in a toolbox." + }, "WeeklyRecurrenceSchedule": { "type": "object", "required": [ @@ -49389,13 +49703,6 @@ "description": { "type": "string", "description": "Optional user-defined description for this tool or configuration." - }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." } }, "allOf": [ @@ -49405,6 +49712,40 @@ ], "description": "A WorkIQ server-side tool." }, + "WorkIQPreviewToolbox": { + "type": "object", + "required": [ + "type", + "project_connection_id" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "work_iq_preview" + ], + "description": "The type of the tool. Always `work_iq_preview`." + }, + "project_connection_id": { + "type": "string", + "description": "The ID of the WorkIQ project connection." + }, + "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." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/ToolboxTool" + } + ], + "description": "A WorkIQ tool stored in a toolbox." + }, "WorkflowActionOutputItem": { "type": "object", "required": [ 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 1e7ffd766e91..593aa9d6ffc7 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 @@ -9669,7 +9669,7 @@ paths: tools: type: array items: - $ref: '#/components/schemas/OpenAI.Tool' + $ref: '#/components/schemas/ToolboxTool' description: The list of tools to include in this version. skills: type: array @@ -9955,14 +9955,6 @@ components: description: type: string description: Optional user-defined description for this tool or configuration. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. base_url: type: string format: uri @@ -9980,6 +9972,39 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: An agent implementing the A2A protocol. + A2APreviewToolbox: + type: object + required: + - type + properties: + type: + type: string + enum: + - a2a_preview + description: The type of the tool. Always `a2a_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. + base_url: + type: string + format: uri + description: Base URL of the agent. + agent_card_path: + type: string + description: |- + The path to the agent card relative to the `base_url`. + If not provided, defaults to `/.well-known/agent-card.json` + project_connection_id: + type: string + description: |- + The connection ID in the project for the A2A server. + The connection stores authentication and other connection details needed to connect to the A2A server. + allOf: + - $ref: '#/components/schemas/ToolboxTool' + description: An A2A tool stored in a toolbox. A2AToolCall: type: object required: @@ -11148,14 +11173,6 @@ components: description: type: string description: Optional user-defined description for this tool or configuration. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. azure_ai_search: allOf: - $ref: '#/components/schemas/AzureAISearchToolResource' @@ -11227,6 +11244,30 @@ components: The indices attached to this agent. There can be a maximum of 1 index resource attached to the agent. description: A set of index resources used by the `azure_ai_search` tool. + AzureAISearchToolbox: + type: object + required: + - type + - azure_ai_search + properties: + type: + type: string + enum: + - azure_ai_search + description: The type of the tool. Always `azure_ai_search`. + 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. + azure_ai_search: + allOf: + - $ref: '#/components/schemas/AzureAISearchToolResource' + description: The azure ai search index resource. + allOf: + - $ref: '#/components/schemas/ToolboxTool' + description: An Azure AI Search tool stored in a toolbox. AzureAITraceDataSourcePreviewEvalRunDataSource: type: object required: @@ -11572,14 +11613,6 @@ components: allOf: - $ref: '#/components/schemas/AzureFunctionDefinition' description: The Azure Function Tool definition. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: The input definition information for an Azure Function Tool, as used to configure an Agent. @@ -11720,14 +11753,6 @@ components: description: type: string description: Optional user-defined description for this tool or configuration. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. bing_custom_search_preview: allOf: - $ref: '#/components/schemas/BingCustomSearchToolParameters' @@ -11852,14 +11877,6 @@ components: description: type: string description: Optional user-defined description for this tool or configuration. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. bing_grounding: allOf: - $ref: '#/components/schemas/BingGroundingSearchToolParameters' @@ -11981,14 +11998,6 @@ components: description: type: string description: Optional user-defined description for this tool or configuration. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. browser_automation_preview: allOf: - $ref: '#/components/schemas/BrowserAutomationToolParameters' @@ -12192,14 +12201,6 @@ components: description: type: string description: Optional user-defined description for this tool or configuration. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. outputs: allOf: - $ref: '#/components/schemas/StructuredOutputDefinition' @@ -12376,6 +12377,28 @@ components: - bundled - remote_build description: How package dependencies are resolved at deployment time for a code-based hosted agent. + CodeInterpreterToolbox: + type: object + required: + - type + properties: + type: + type: string + enum: + - code_interpreter + description: The type of the tool. Always `code_interpreter`. + container: + anyOf: + - type: string + - $ref: '#/components/schemas/OpenAI.AutoCodeInterpreterToolParam' + description: |- + The code interpreter container. Can be a container ID or an object that + specifies uploaded file IDs to make available to your code, along with an + optional `memory_limit` setting. + If not provided, the service assumes auto. + allOf: + - $ref: '#/components/schemas/ToolboxTool' + description: A code interpreter tool stored in a toolbox. CompletionMessageToolCallChunk: type: object required: @@ -15358,17 +15381,49 @@ components: description: type: string description: Optional user-defined description for this tool or configuration. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A FabricIQ server-side tool. + FabricIQPreviewToolbox: + type: object + required: + - type + - project_connection_id + properties: + type: + type: string + enum: + - fabric_iq_preview + description: The type of the tool. Always `fabric_iq_preview`. + project_connection_id: + type: string + description: The ID of the FabricIQ project connection. + server_label: + type: string + description: (Optional) The label of the FabricIQ MCP server to connect to. + server_url: + type: string + format: uri + 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 + - type: string + nullable: true + description: (Optional) Whether the agent requires approval before executing actions. Default is always. + default: always + 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. + allOf: + - $ref: '#/components/schemas/ToolboxTool' + description: A FabricIQ tool stored in a toolbox. FileDataGenerationJobOutput: type: object required: @@ -15435,6 +15490,38 @@ components: allOf: - $ref: '#/components/schemas/DatasetVersionUpdate' description: FileDatasetVersion Definition + FileSearchToolbox: + type: object + required: + - type + - vector_store_ids + properties: + type: + type: string + enum: + - file_search + description: The type of the tool. Always `file_search`. + default: file_search + vector_store_ids: + type: array + items: + type: string + description: The IDs of the vector stores to search. + max_num_results: + allOf: + - $ref: '#/components/schemas/OpenAI.integer' + description: The maximum number of results to return. This number should be between 1 and 50 inclusive. + ranking_options: + allOf: + - $ref: '#/components/schemas/OpenAI.RankingOptions' + description: Ranking options for search. + filters: + allOf: + - $ref: '#/components/schemas/OpenAI.Filters' + nullable: true + allOf: + - $ref: '#/components/schemas/ToolboxTool' + description: A file search tool stored in a toolbox. FilterStrategyType: anyOf: - type: string @@ -16194,6 +16281,92 @@ components: format: float description: Dropout rate used during training. Informational — not used at serving time. description: Adapter-specific metadata for LoRA models. Drives serving engine configuration at deployment time. + MCPToolbox: + type: object + required: + - type + - server_label + properties: + type: + type: string + enum: + - mcp + description: The type of the tool. Always `mcp`. + server_label: + type: string + description: A label for this MCP server, used to identify it in tool calls. + server_url: + type: string + format: uri + description: |- + The URL for the MCP server. One of `server_url` or `connector_id` must be + provided. + connector_id: + type: string + enum: + - connector_dropbox + - connector_gmail + - connector_googlecalendar + - connector_googledrive + - connector_microsoftteams + - connector_outlookcalendar + - connector_outlookemail + - connector_sharepoint + description: |- + Identifier for service connectors, like those available in ChatGPT. One of + `server_url` or `connector_id` must be provided. Learn more about service + connectors [here](/docs/guides/tools-remote-mcp#connectors). + Currently supported `connector_id` values are: + - Dropbox: `connector_dropbox` + - Gmail: `connector_gmail` + - Google Calendar: `connector_googlecalendar` + - Google Drive: `connector_googledrive` + - Microsoft Teams: `connector_microsoftteams` + - Outlook Calendar: `connector_outlookcalendar` + - Outlook Email: `connector_outlookemail` + - SharePoint: `connector_sharepoint` + authorization: + type: string + description: |- + An OAuth access token that can be used with a remote MCP server, either + with a custom MCP server URL or a service connector. Your application + must handle the OAuth authorization flow and provide the token here. + server_description: + type: string + description: Optional description of the MCP server, used to provide more context. + headers: + type: object + additionalProperties: + type: string + nullable: true + allowed_tools: + anyOf: + - type: array + items: + type: string + nullable: true + - type: object + allOf: + - $ref: '#/components/schemas/OpenAI.MCPToolFilter' + nullable: true + require_approval: + anyOf: + - type: object + allOf: + - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' + nullable: true + - type: string + enum: + - always + - never + nullable: true + default: always + 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. + allOf: + - $ref: '#/components/schemas/ToolboxTool' + description: An MCP tool stored in a toolbox. ManagedAgentIdentityBlueprintReference: type: object required: @@ -16404,14 +16577,6 @@ components: description: type: string description: Optional user-defined description for this tool or configuration. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. memory_store_name: type: string description: The name of the memory store to use. @@ -16753,14 +16918,6 @@ components: description: type: string description: Optional user-defined description for this tool or configuration. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. fabric_dataagent_preview: allOf: - $ref: '#/components/schemas/FabricDataAgentToolParameters' @@ -17510,26 +17667,12 @@ components: required: - type properties: - type: - type: string - enum: - - code_interpreter - description: The type of the code interpreter tool. Always `code_interpreter`. - x-stainless-const: true - 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. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. + type: + type: string + enum: + - code_interpreter + description: The type of the code interpreter tool. Always `code_interpreter`. + x-stainless-const: true container: anyOf: - type: string @@ -20596,20 +20739,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.Filters' nullable: true - 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. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A tool that searches for relevant content from uploaded files. Learn more about the [file search tool](https://platform.openai.com/docs/guides/tools-file-search). @@ -21595,20 +21724,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellToolParamEnvironment' nullable: true - 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. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A tool that allows the model to execute shell commands. @@ -22226,20 +22341,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.ImageGenActionEnum' description: 'Whether to generate a new image or edit an existing image. Default: `auto`.' - 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. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A tool that generates images using the GPT image models. @@ -26418,20 +26519,6 @@ components: 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. - description: - type: string - description: Optional user-defined description for this tool or configuration. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A tool that allows the model to execute shell commands in a local environment. @@ -26582,17 +26669,6 @@ components: - never nullable: true default: always - 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. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: |- @@ -30988,26 +31064,26 @@ components: discriminator: propertyName: type mapping: + code_interpreter: '#/components/schemas/OpenAI.CodeInterpreterTool' + file_search: '#/components/schemas/OpenAI.FileSearchTool' + web_search: '#/components/schemas/OpenAI.WebSearchTool' + mcp: '#/components/schemas/OpenAI.MCPTool' + azure_ai_search: '#/components/schemas/AzureAISearchTool' + openapi: '#/components/schemas/OpenApiTool' + a2a_preview: '#/components/schemas/A2APreviewTool' + work_iq_preview: '#/components/schemas/WorkIQPreviewTool' + fabric_iq_preview: '#/components/schemas/FabricIQPreviewTool' + toolbox_search_preview: '#/components/schemas/ToolboxSearchPreviewTool' bing_grounding: '#/components/schemas/BingGroundingTool' fabric_dataagent_preview: '#/components/schemas/MicrosoftFabricPreviewTool' sharepoint_grounding_preview: '#/components/schemas/SharepointPreviewTool' - azure_ai_search: '#/components/schemas/AzureAISearchTool' - openapi: '#/components/schemas/OpenApiTool' bing_custom_search_preview: '#/components/schemas/BingCustomSearchPreviewTool' browser_automation_preview: '#/components/schemas/BrowserAutomationPreviewTool' azure_function: '#/components/schemas/AzureFunctionTool' capture_structured_outputs: '#/components/schemas/CaptureStructuredOutputsTool' - a2a_preview: '#/components/schemas/A2APreviewTool' - work_iq_preview: '#/components/schemas/WorkIQPreviewTool' - fabric_iq_preview: '#/components/schemas/FabricIQPreviewTool' memory_search_preview: '#/components/schemas/MemorySearchPreviewTool' - toolbox_search_preview: '#/components/schemas/ToolboxSearchPreviewTool' - code_interpreter: '#/components/schemas/OpenAI.CodeInterpreterTool' function: '#/components/schemas/OpenAI.FunctionTool' - file_search: '#/components/schemas/OpenAI.FileSearchTool' computer_use_preview: '#/components/schemas/OpenAI.ComputerUsePreviewTool' - web_search: '#/components/schemas/OpenAI.WebSearchTool' - mcp: '#/components/schemas/OpenAI.MCPTool' image_generation: '#/components/schemas/OpenAI.ImageGenTool' local_shell: '#/components/schemas/OpenAI.LocalShellToolParam' shell: '#/components/schemas/OpenAI.FunctionShellToolParam' @@ -31597,26 +31673,6 @@ components: - high 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. default: medium - 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. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. - custom_search_configuration: - allOf: - - $ref: '#/components/schemas/WebSearchConfiguration' - description: |- - The project connections attached to this tool. There can be a maximum of 1 connection - resource attached to the tool. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: |- @@ -31795,14 +31851,6 @@ components: allOf: - $ref: '#/components/schemas/OpenApiFunctionDefinition' description: The openapi function definition. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: The input definition information for an OpenAPI tool as used to configure an agent. @@ -31864,6 +31912,24 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: The output of an OpenAPI tool call. + OpenApiToolbox: + type: object + required: + - type + - openapi + properties: + type: + type: string + enum: + - openapi + description: The type of the tool. Always `openapi`. + openapi: + allOf: + - $ref: '#/components/schemas/OpenApiFunctionDefinition' + description: The openapi function definition. + allOf: + - $ref: '#/components/schemas/ToolboxTool' + description: An OpenAPI tool stored in a toolbox. OptimizationAgentDefinition: type: object properties: @@ -33601,14 +33667,6 @@ components: description: type: string description: Optional user-defined description for this tool or configuration. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. sharepoint_grounding_preview: allOf: - $ref: '#/components/schemas/SharepointGroundingToolParameters' @@ -34288,20 +34346,31 @@ components: description: type: string description: Optional user-defined description for this tool or configuration. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: |- A tool for searching over the agent's toolbox. When present, deferred tools are hidden from `tools/list` and only discoverable via `search_tools` queries at runtime. + ToolboxSearchPreviewToolbox: + type: object + required: + - type + properties: + type: + type: string + enum: + - toolbox_search_preview + description: The type of the tool. Always `toolbox_search_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. + allOf: + - $ref: '#/components/schemas/ToolboxTool' + description: A toolbox search tool stored in a toolbox. ToolboxSkill: type: object required: @@ -34336,6 +34405,57 @@ components: allOf: - $ref: '#/components/schemas/ToolboxSkill' description: A reference to an existing skill to include in a toolbox. + ToolboxTool: + type: object + required: + - type + properties: + type: + allOf: + - $ref: '#/components/schemas/ToolboxToolType' + description: The type of tool. + 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. + tool_configs: + type: object + additionalProperties: + $ref: '#/components/schemas/ToolConfig' + description: |- + Per-tool configuration map. Keys are tool names or `*` (catch-all default). + Resolution order: exact tool name match takes priority over `*`. + Unknown tool names are silently ignored at runtime. + discriminator: + propertyName: type + mapping: + code_interpreter: '#/components/schemas/CodeInterpreterToolbox' + file_search: '#/components/schemas/FileSearchToolbox' + web_search: '#/components/schemas/WebSearchToolbox' + mcp: '#/components/schemas/MCPToolbox' + azure_ai_search: '#/components/schemas/AzureAISearchToolbox' + openapi: '#/components/schemas/OpenApiToolbox' + a2a_preview: '#/components/schemas/A2APreviewToolbox' + work_iq_preview: '#/components/schemas/WorkIQPreviewToolbox' + fabric_iq_preview: '#/components/schemas/FabricIQPreviewToolbox' + toolbox_search_preview: '#/components/schemas/ToolboxSearchPreviewToolbox' + description: An abstract representation of a tool stored in a toolbox. + ToolboxToolType: + type: string + enum: + - code_interpreter + - file_search + - web_search + - mcp + - azure_ai_search + - openapi + - a2a_preview + - work_iq_preview + - fabric_iq_preview + - toolbox_search_preview + description: Supported tool types for tools stored in a toolbox. ToolboxVersionObject: type: object required: @@ -34380,7 +34500,7 @@ components: tools: type: array items: - $ref: '#/components/schemas/OpenAI.Tool' + $ref: '#/components/schemas/ToolboxTool' description: The list of tools contained in this toolbox version. skills: type: array @@ -34832,6 +34952,44 @@ components: type: string description: Name of the custom configuration instance given to config. description: A web search configuration for bing custom search + WebSearchToolbox: + type: object + required: + - type + properties: + type: + type: string + enum: + - web_search + description: The type of the tool. Always `web_search`. + default: web_search + filters: + type: object + allOf: + - $ref: '#/components/schemas/OpenAI.WebSearchToolFilters' + nullable: true + user_location: + type: object + allOf: + - $ref: '#/components/schemas/OpenAI.WebSearchApproximateLocation' + nullable: true + search_context_size: + type: string + enum: + - low + - medium + - high + 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. + default: medium + custom_search_configuration: + allOf: + - $ref: '#/components/schemas/WebSearchConfiguration' + description: |- + The project connections attached to this tool. There can be a maximum of 1 connection + resource attached to the tool. + allOf: + - $ref: '#/components/schemas/ToolboxTool' + description: A web search tool stored in a toolbox. WeeklyRecurrenceSchedule: type: object required: @@ -34871,17 +35029,32 @@ components: description: type: string description: Optional user-defined description for this tool or configuration. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A WorkIQ server-side tool. + WorkIQPreviewToolbox: + type: object + required: + - type + - project_connection_id + properties: + type: + type: string + enum: + - work_iq_preview + description: The type of the tool. Always `work_iq_preview`. + project_connection_id: + type: string + description: The ID of the WorkIQ project connection. + 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. + allOf: + - $ref: '#/components/schemas/ToolboxTool' + description: A WorkIQ tool stored in a toolbox. WorkflowActionOutputItem: type: object required: 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 ba5175244008..5cc78011b45f 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 @@ -17133,7 +17133,7 @@ "tools": { "type": "array", "items": { - "$ref": "#/components/schemas/OpenAI.Tool" + "$ref": "#/components/schemas/ToolboxTool" }, "description": "The list of tools to include in this version." }, @@ -17535,13 +17535,6 @@ "type": "string", "description": "Optional user-defined description for this tool or configuration." }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." - }, "base_url": { "type": "string", "format": "uri", @@ -17563,6 +17556,48 @@ ], "description": "An agent implementing the A2A protocol." }, + "A2APreviewToolbox": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "a2a_preview" + ], + "description": "The type of the tool. Always `a2a_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." + }, + "base_url": { + "type": "string", + "format": "uri", + "description": "Base URL of the agent." + }, + "agent_card_path": { + "type": "string", + "description": "The path to the agent card relative to the `base_url`.\nIf not provided, defaults to `/.well-known/agent-card.json`" + }, + "project_connection_id": { + "type": "string", + "description": "The connection ID in the project for the A2A server.\nThe connection stores authentication and other connection details needed to connect to the A2A server." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/ToolboxTool" + } + ], + "description": "An A2A tool stored in a toolbox." + }, "A2AToolCall": { "type": "object", "required": [ @@ -19794,13 +19829,6 @@ "type": "string", "description": "Optional user-defined description for this tool or configuration." }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." - }, "azure_ai_search": { "allOf": [ { @@ -19915,6 +19943,44 @@ }, "description": "A set of index resources used by the `azure_ai_search` tool." }, + "AzureAISearchToolbox": { + "type": "object", + "required": [ + "type", + "azure_ai_search" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "azure_ai_search" + ], + "description": "The type of the tool. Always `azure_ai_search`." + }, + "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." + }, + "azure_ai_search": { + "allOf": [ + { + "$ref": "#/components/schemas/AzureAISearchToolResource" + } + ], + "description": "The azure ai search index resource." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/ToolboxTool" + } + ], + "description": "An Azure AI Search tool stored in a toolbox." + }, "AzureAITraceDataSourcePreviewEvalRunDataSource": { "type": "object", "required": [ @@ -20447,13 +20513,6 @@ } ], "description": "The Azure Function Tool definition." - }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." } }, "allOf": [ @@ -20665,13 +20724,6 @@ "type": "string", "description": "Optional user-defined description for this tool or configuration." }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." - }, "bing_custom_search_preview": { "allOf": [ { @@ -20855,13 +20907,6 @@ "type": "string", "description": "Optional user-defined description for this tool or configuration." }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." - }, "bing_grounding": { "allOf": [ { @@ -21057,13 +21102,6 @@ "type": "string", "description": "Optional user-defined description for this tool or configuration." }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." - }, "browser_automation_preview": { "allOf": [ { @@ -21367,13 +21405,6 @@ "type": "string", "description": "Optional user-defined description for this tool or configuration." }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." - }, "outputs": { "allOf": [ { @@ -21608,6 +21639,38 @@ ], "description": "How package dependencies are resolved at deployment time for a code-based hosted agent." }, + "CodeInterpreterToolbox": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_interpreter" + ], + "description": "The type of the tool. Always `code_interpreter`." + }, + "container": { + "anyOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/OpenAI.AutoCodeInterpreterToolParam" + } + ], + "description": "The code interpreter container. Can be a container ID or an object that\nspecifies uploaded file IDs to make available to your code, along with an\noptional `memory_limit` setting.\nIf not provided, the service assumes auto." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/ToolboxTool" + } + ], + "description": "A code interpreter tool stored in a toolbox." + }, "CompletionMessageToolCallChunk": { "type": "object", "required": [ @@ -26680,13 +26743,6 @@ "description": { "type": "string", "description": "Optional user-defined description for this tool or configuration." - }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." } }, "allOf": [ @@ -26696,6 +26752,68 @@ ], "description": "A FabricIQ server-side tool." }, + "FabricIQPreviewToolbox": { + "type": "object", + "required": [ + "type", + "project_connection_id" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "fabric_iq_preview" + ], + "description": "The type of the tool. Always `fabric_iq_preview`." + }, + "project_connection_id": { + "type": "string", + "description": "The ID of the FabricIQ project connection." + }, + "server_label": { + "type": "string", + "description": "(Optional) The label of the FabricIQ MCP server to connect to." + }, + "server_url": { + "type": "string", + "format": "uri", + "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 + }, + { + "type": "string", + "nullable": true + } + ], + "description": "(Optional) Whether the agent requires approval before executing actions. Default is always.", + "default": "always" + }, + "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." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/ToolboxTool" + } + ], + "description": "A FabricIQ tool stored in a toolbox." + }, "FileDataGenerationJobOutput": { "type": "object", "required": [ @@ -26797,6 +26915,60 @@ ], "description": "FileDatasetVersion Definition" }, + "FileSearchToolbox": { + "type": "object", + "required": [ + "type", + "vector_store_ids" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_search" + ], + "description": "The type of the tool. Always `file_search`.", + "default": "file_search" + }, + "vector_store_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of the vector stores to search." + }, + "max_num_results": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + } + ], + "description": "The maximum number of results to return. This number should be between 1 and 50 inclusive." + }, + "ranking_options": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.RankingOptions" + } + ], + "description": "Ranking options for search." + }, + "filters": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Filters" + } + ], + "nullable": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/ToolboxTool" + } + ], + "description": "A file search tool stored in a toolbox." + }, "FilterStrategyType": { "anyOf": [ { @@ -28035,6 +28207,112 @@ }, "description": "Adapter-specific metadata for LoRA models. Drives serving engine configuration at deployment time." }, + "MCPToolbox": { + "type": "object", + "required": [ + "type", + "server_label" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "mcp" + ], + "description": "The type of the tool. Always `mcp`." + }, + "server_label": { + "type": "string", + "description": "A label for this MCP server, used to identify it in tool calls." + }, + "server_url": { + "type": "string", + "format": "uri", + "description": "The URL for the MCP server. One of `server_url` or `connector_id` must be\n provided." + }, + "connector_id": { + "type": "string", + "enum": [ + "connector_dropbox", + "connector_gmail", + "connector_googlecalendar", + "connector_googledrive", + "connector_microsoftteams", + "connector_outlookcalendar", + "connector_outlookemail", + "connector_sharepoint" + ], + "description": "Identifier for service connectors, like those available in ChatGPT. One of\n `server_url` or `connector_id` must be provided. Learn more about service\n connectors [here](/docs/guides/tools-remote-mcp#connectors).\n Currently supported `connector_id` values are:\n - Dropbox: `connector_dropbox`\n - Gmail: `connector_gmail`\n - Google Calendar: `connector_googlecalendar`\n - Google Drive: `connector_googledrive`\n - Microsoft Teams: `connector_microsoftteams`\n - Outlook Calendar: `connector_outlookcalendar`\n - Outlook Email: `connector_outlookemail`\n - SharePoint: `connector_sharepoint`" + }, + "authorization": { + "type": "string", + "description": "An OAuth access token that can be used with a remote MCP server, either\n with a custom MCP server URL or a service connector. Your application\n must handle the OAuth authorization flow and provide the token here." + }, + "server_description": { + "type": "string", + "description": "Optional description of the MCP server, used to provide more context." + }, + "headers": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "nullable": true + }, + "allowed_tools": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + }, + { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MCPToolFilter" + } + ], + "nullable": true + } + ] + }, + "require_approval": { + "anyOf": [ + { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" + } + ], + "nullable": true + }, + { + "type": "string", + "enum": [ + "always", + "never" + ], + "nullable": true + } + ], + "default": "always" + }, + "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." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/ToolboxTool" + } + ], + "description": "An MCP tool stored in a toolbox." + }, "ManagedAgentIdentityBlueprint": { "type": "object", "required": [ @@ -28379,13 +28657,6 @@ "type": "string", "description": "Optional user-defined description for this tool or configuration." }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." - }, "memory_store_name": { "type": "string", "description": "The name of the memory store to use." @@ -28439,13 +28710,6 @@ "type": "string", "description": "Optional user-defined description for this tool or configuration." }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." - }, "memory_store_name": { "type": "string", "description": "The name of the memory store to use." @@ -29007,13 +29271,6 @@ "type": "string", "description": "Optional user-defined description for this tool or configuration." }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." - }, "fabric_dataagent_preview": { "allOf": [ { @@ -30082,21 +30339,6 @@ "description": "The type of the code interpreter tool. Always `code_interpreter`.", "x-stainless-const": true }, - "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." - }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." - }, "container": { "anyOf": [ { @@ -34429,21 +34671,6 @@ } ], "nullable": true - }, - "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." - }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." } }, "allOf": [ @@ -35870,21 +36097,6 @@ } ], "nullable": true - }, - "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." - }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." } }, "allOf": [ @@ -36569,21 +36781,6 @@ } ], "description": "Whether to generate a new image or edit an existing image. Default: `auto`." - }, - "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." - }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." } }, "allOf": [ @@ -42328,21 +42525,6 @@ "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." - }, - "description": { - "type": "string", - "description": "Optional user-defined description for this tool or configuration." - }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." } }, "allOf": [ @@ -42542,17 +42724,6 @@ } ], "default": "always" - }, - "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." - }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." } }, "allOf": [ @@ -48056,27 +48227,27 @@ "discriminator": { "propertyName": "type", "mapping": { + "code_interpreter": "#/components/schemas/OpenAI.CodeInterpreterTool", + "file_search": "#/components/schemas/OpenAI.FileSearchTool", + "web_search": "#/components/schemas/OpenAI.WebSearchTool", + "mcp": "#/components/schemas/OpenAI.MCPTool", + "azure_ai_search": "#/components/schemas/AzureAISearchTool", + "openapi": "#/components/schemas/OpenApiTool", + "a2a_preview": "#/components/schemas/A2APreviewTool", + "work_iq_preview": "#/components/schemas/WorkIQPreviewTool", + "fabric_iq_preview": "#/components/schemas/FabricIQPreviewTool", + "toolbox_search_preview": "#/components/schemas/ToolboxSearchPreviewTool", "bing_grounding": "#/components/schemas/BingGroundingTool", "fabric_dataagent_preview": "#/components/schemas/MicrosoftFabricPreviewTool", "sharepoint_grounding_preview": "#/components/schemas/SharepointPreviewTool", - "azure_ai_search": "#/components/schemas/AzureAISearchTool", - "openapi": "#/components/schemas/OpenApiTool", "bing_custom_search_preview": "#/components/schemas/BingCustomSearchPreviewTool", "browser_automation_preview": "#/components/schemas/BrowserAutomationPreviewTool", "azure_function": "#/components/schemas/AzureFunctionTool", "capture_structured_outputs": "#/components/schemas/CaptureStructuredOutputsTool", - "a2a_preview": "#/components/schemas/A2APreviewTool", - "work_iq_preview": "#/components/schemas/WorkIQPreviewTool", - "fabric_iq_preview": "#/components/schemas/FabricIQPreviewTool", "memory_search_preview": "#/components/schemas/MemorySearchPreviewTool", "memory_search": "#/components/schemas/MemorySearchTool", - "toolbox_search_preview": "#/components/schemas/ToolboxSearchPreviewTool", - "code_interpreter": "#/components/schemas/OpenAI.CodeInterpreterTool", "function": "#/components/schemas/OpenAI.FunctionTool", - "file_search": "#/components/schemas/OpenAI.FileSearchTool", "computer_use_preview": "#/components/schemas/OpenAI.ComputerUsePreviewTool", - "web_search": "#/components/schemas/OpenAI.WebSearchTool", - "mcp": "#/components/schemas/OpenAI.MCPTool", "image_generation": "#/components/schemas/OpenAI.ImageGenTool", "local_shell": "#/components/schemas/OpenAI.LocalShellToolParam", "shell": "#/components/schemas/OpenAI.FunctionShellToolParam", @@ -48850,29 +49021,6 @@ ], "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.", "default": "medium" - }, - "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." - }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." - }, - "custom_search_configuration": { - "allOf": [ - { - "$ref": "#/components/schemas/WebSearchConfiguration" - } - ], - "description": "The project connections attached to this tool. There can be a maximum of 1 connection\nresource attached to the tool." } }, "allOf": [ @@ -49138,13 +49286,6 @@ } ], "description": "The openapi function definition." - }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." } }, "allOf": [ @@ -49245,6 +49386,36 @@ ], "description": "The output of an OpenAPI tool call." }, + "OpenApiToolbox": { + "type": "object", + "required": [ + "type", + "openapi" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "openapi" + ], + "description": "The type of the tool. Always `openapi`." + }, + "openapi": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenApiFunctionDefinition" + } + ], + "description": "The openapi function definition." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/ToolboxTool" + } + ], + "description": "An OpenAPI tool stored in a toolbox." + }, "OptimizationAgentDefinition": { "type": "object", "properties": { @@ -51900,13 +52071,6 @@ "type": "string", "description": "Optional user-defined description for this tool or configuration." }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." - }, "sharepoint_grounding_preview": { "allOf": [ { @@ -52955,13 +53119,6 @@ "description": { "type": "string", "description": "Optional user-defined description for this tool or configuration." - }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." } }, "allOf": [ @@ -52971,6 +53128,35 @@ ], "description": "A tool for searching over the agent's toolbox.\nWhen present, deferred tools are hidden from `tools/list` and only\ndiscoverable via `search_tools` queries at runtime." }, + "ToolboxSearchPreviewToolbox": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "toolbox_search_preview" + ], + "description": "The type of the tool. Always `toolbox_search_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." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/ToolboxTool" + } + ], + "description": "A toolbox search tool stored in a toolbox." + }, "ToolboxSkill": { "type": "object", "required": [ @@ -53024,6 +53210,69 @@ ], "description": "A reference to an existing skill to include in a toolbox." }, + "ToolboxTool": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "allOf": [ + { + "$ref": "#/components/schemas/ToolboxToolType" + } + ], + "description": "The type of tool." + }, + "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." + }, + "tool_configs": { + "type": "object", + "additionalProperties": { + "$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." + } + }, + "discriminator": { + "propertyName": "type", + "mapping": { + "code_interpreter": "#/components/schemas/CodeInterpreterToolbox", + "file_search": "#/components/schemas/FileSearchToolbox", + "web_search": "#/components/schemas/WebSearchToolbox", + "mcp": "#/components/schemas/MCPToolbox", + "azure_ai_search": "#/components/schemas/AzureAISearchToolbox", + "openapi": "#/components/schemas/OpenApiToolbox", + "a2a_preview": "#/components/schemas/A2APreviewToolbox", + "work_iq_preview": "#/components/schemas/WorkIQPreviewToolbox", + "fabric_iq_preview": "#/components/schemas/FabricIQPreviewToolbox", + "toolbox_search_preview": "#/components/schemas/ToolboxSearchPreviewToolbox" + } + }, + "description": "An abstract representation of a tool stored in a toolbox." + }, + "ToolboxToolType": { + "type": "string", + "enum": [ + "code_interpreter", + "file_search", + "web_search", + "mcp", + "azure_ai_search", + "openapi", + "a2a_preview", + "work_iq_preview", + "fabric_iq_preview", + "toolbox_search_preview" + ], + "description": "Supported tool types for tools stored in a toolbox." + }, "ToolboxVersionObject": { "type": "object", "required": [ @@ -53070,7 +53319,7 @@ "tools": { "type": "array", "items": { - "$ref": "#/components/schemas/OpenAI.Tool" + "$ref": "#/components/schemas/ToolboxTool" }, "description": "The list of tools contained in this toolbox version." }, @@ -53835,6 +54084,64 @@ }, "description": "A web search configuration for bing custom search" }, + "WebSearchToolbox": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "web_search" + ], + "description": "The type of the tool. Always `web_search`.", + "default": "web_search" + }, + "filters": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.WebSearchToolFilters" + } + ], + "nullable": true + }, + "user_location": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.WebSearchApproximateLocation" + } + ], + "nullable": true + }, + "search_context_size": { + "type": "string", + "enum": [ + "low", + "medium", + "high" + ], + "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.", + "default": "medium" + }, + "custom_search_configuration": { + "allOf": [ + { + "$ref": "#/components/schemas/WebSearchConfiguration" + } + ], + "description": "The project connections attached to this tool. There can be a maximum of 1 connection\nresource attached to the tool." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/ToolboxTool" + } + ], + "description": "A web search tool stored in a toolbox." + }, "WeeklyRecurrenceSchedule": { "type": "object", "required": [ @@ -53889,13 +54196,6 @@ "description": { "type": "string", "description": "Optional user-defined description for this tool or configuration." - }, - "tool_configs": { - "type": "object", - "additionalProperties": { - "$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." } }, "allOf": [ @@ -53905,6 +54205,40 @@ ], "description": "A WorkIQ server-side tool." }, + "WorkIQPreviewToolbox": { + "type": "object", + "required": [ + "type", + "project_connection_id" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "work_iq_preview" + ], + "description": "The type of the tool. Always `work_iq_preview`." + }, + "project_connection_id": { + "type": "string", + "description": "The ID of the WorkIQ project connection." + }, + "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." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/ToolboxTool" + } + ], + "description": "A WorkIQ tool stored in a toolbox." + }, "WorkflowActionOutputItem": { "type": "object", "required": [ 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 b567cc0e3b74..53cf0fab2fe1 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 @@ -11403,7 +11403,7 @@ paths: tools: type: array items: - $ref: '#/components/schemas/OpenAI.Tool' + $ref: '#/components/schemas/ToolboxTool' description: The list of tools to include in this version. skills: type: array @@ -11689,14 +11689,6 @@ components: description: type: string description: Optional user-defined description for this tool or configuration. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. base_url: type: string format: uri @@ -11714,6 +11706,39 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: An agent implementing the A2A protocol. + A2APreviewToolbox: + type: object + required: + - type + properties: + type: + type: string + enum: + - a2a_preview + description: The type of the tool. Always `a2a_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. + base_url: + type: string + format: uri + description: Base URL of the agent. + agent_card_path: + type: string + description: |- + The path to the agent card relative to the `base_url`. + If not provided, defaults to `/.well-known/agent-card.json` + project_connection_id: + type: string + description: |- + The connection ID in the project for the A2A server. + The connection stores authentication and other connection details needed to connect to the A2A server. + allOf: + - $ref: '#/components/schemas/ToolboxTool' + description: An A2A tool stored in a toolbox. A2AToolCall: type: object required: @@ -13204,14 +13229,6 @@ components: description: type: string description: Optional user-defined description for this tool or configuration. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. azure_ai_search: allOf: - $ref: '#/components/schemas/AzureAISearchToolResource' @@ -13283,6 +13300,30 @@ components: The indices attached to this agent. There can be a maximum of 1 index resource attached to the agent. description: A set of index resources used by the `azure_ai_search` tool. + AzureAISearchToolbox: + type: object + required: + - type + - azure_ai_search + properties: + type: + type: string + enum: + - azure_ai_search + description: The type of the tool. Always `azure_ai_search`. + 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. + azure_ai_search: + allOf: + - $ref: '#/components/schemas/AzureAISearchToolResource' + description: The azure ai search index resource. + allOf: + - $ref: '#/components/schemas/ToolboxTool' + description: An Azure AI Search tool stored in a toolbox. AzureAITraceDataSourcePreviewEvalRunDataSource: type: object required: @@ -13628,14 +13669,6 @@ components: allOf: - $ref: '#/components/schemas/AzureFunctionDefinition' description: The Azure Function Tool definition. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: The input definition information for an Azure Function Tool, as used to configure an Agent. @@ -13776,14 +13809,6 @@ components: description: type: string description: Optional user-defined description for this tool or configuration. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. bing_custom_search_preview: allOf: - $ref: '#/components/schemas/BingCustomSearchToolParameters' @@ -13908,14 +13933,6 @@ components: description: type: string description: Optional user-defined description for this tool or configuration. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. bing_grounding: allOf: - $ref: '#/components/schemas/BingGroundingSearchToolParameters' @@ -14037,14 +14054,6 @@ components: description: type: string description: Optional user-defined description for this tool or configuration. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. browser_automation_preview: allOf: - $ref: '#/components/schemas/BrowserAutomationToolParameters' @@ -14248,14 +14257,6 @@ components: description: type: string description: Optional user-defined description for this tool or configuration. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. outputs: allOf: - $ref: '#/components/schemas/StructuredOutputDefinition' @@ -14432,6 +14433,28 @@ components: - bundled - remote_build description: How package dependencies are resolved at deployment time for a code-based hosted agent. + CodeInterpreterToolbox: + type: object + required: + - type + properties: + type: + type: string + enum: + - code_interpreter + description: The type of the tool. Always `code_interpreter`. + container: + anyOf: + - type: string + - $ref: '#/components/schemas/OpenAI.AutoCodeInterpreterToolParam' + description: |- + The code interpreter container. Can be a container ID or an object that + specifies uploaded file IDs to make available to your code, along with an + optional `memory_limit` setting. + If not provided, the service assumes auto. + allOf: + - $ref: '#/components/schemas/ToolboxTool' + description: A code interpreter tool stored in a toolbox. CompletionMessageToolCallChunk: type: object required: @@ -18145,17 +18168,49 @@ components: description: type: string description: Optional user-defined description for this tool or configuration. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A FabricIQ server-side tool. + FabricIQPreviewToolbox: + type: object + required: + - type + - project_connection_id + properties: + type: + type: string + enum: + - fabric_iq_preview + description: The type of the tool. Always `fabric_iq_preview`. + project_connection_id: + type: string + description: The ID of the FabricIQ project connection. + server_label: + type: string + description: (Optional) The label of the FabricIQ MCP server to connect to. + server_url: + type: string + format: uri + 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 + - type: string + nullable: true + description: (Optional) Whether the agent requires approval before executing actions. Default is always. + default: always + 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. + allOf: + - $ref: '#/components/schemas/ToolboxTool' + description: A FabricIQ tool stored in a toolbox. FileDataGenerationJobOutput: type: object required: @@ -18222,6 +18277,38 @@ components: allOf: - $ref: '#/components/schemas/DatasetVersionUpdate' description: FileDatasetVersion Definition + FileSearchToolbox: + type: object + required: + - type + - vector_store_ids + properties: + type: + type: string + enum: + - file_search + description: The type of the tool. Always `file_search`. + default: file_search + vector_store_ids: + type: array + items: + type: string + description: The IDs of the vector stores to search. + max_num_results: + allOf: + - $ref: '#/components/schemas/OpenAI.integer' + description: The maximum number of results to return. This number should be between 1 and 50 inclusive. + ranking_options: + allOf: + - $ref: '#/components/schemas/OpenAI.RankingOptions' + description: Ranking options for search. + filters: + allOf: + - $ref: '#/components/schemas/OpenAI.Filters' + nullable: true + allOf: + - $ref: '#/components/schemas/ToolboxTool' + description: A file search tool stored in a toolbox. FilterStrategyType: anyOf: - type: string @@ -19027,6 +19114,92 @@ components: format: float description: Dropout rate used during training. Informational — not used at serving time. description: Adapter-specific metadata for LoRA models. Drives serving engine configuration at deployment time. + MCPToolbox: + type: object + required: + - type + - server_label + properties: + type: + type: string + enum: + - mcp + description: The type of the tool. Always `mcp`. + server_label: + type: string + description: A label for this MCP server, used to identify it in tool calls. + server_url: + type: string + format: uri + description: |- + The URL for the MCP server. One of `server_url` or `connector_id` must be + provided. + connector_id: + type: string + enum: + - connector_dropbox + - connector_gmail + - connector_googlecalendar + - connector_googledrive + - connector_microsoftteams + - connector_outlookcalendar + - connector_outlookemail + - connector_sharepoint + description: |- + Identifier for service connectors, like those available in ChatGPT. One of + `server_url` or `connector_id` must be provided. Learn more about service + connectors [here](/docs/guides/tools-remote-mcp#connectors). + Currently supported `connector_id` values are: + - Dropbox: `connector_dropbox` + - Gmail: `connector_gmail` + - Google Calendar: `connector_googlecalendar` + - Google Drive: `connector_googledrive` + - Microsoft Teams: `connector_microsoftteams` + - Outlook Calendar: `connector_outlookcalendar` + - Outlook Email: `connector_outlookemail` + - SharePoint: `connector_sharepoint` + authorization: + type: string + description: |- + An OAuth access token that can be used with a remote MCP server, either + with a custom MCP server URL or a service connector. Your application + must handle the OAuth authorization flow and provide the token here. + server_description: + type: string + description: Optional description of the MCP server, used to provide more context. + headers: + type: object + additionalProperties: + type: string + nullable: true + allowed_tools: + anyOf: + - type: array + items: + type: string + nullable: true + - type: object + allOf: + - $ref: '#/components/schemas/OpenAI.MCPToolFilter' + nullable: true + require_approval: + anyOf: + - type: object + allOf: + - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' + nullable: true + - type: string + enum: + - always + - never + nullable: true + default: always + 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. + allOf: + - $ref: '#/components/schemas/ToolboxTool' + description: An MCP tool stored in a toolbox. ManagedAgentIdentityBlueprint: type: object required: @@ -19245,14 +19418,6 @@ components: description: type: string description: Optional user-defined description for this tool or configuration. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. memory_store_name: type: string description: The name of the memory store to use. @@ -19292,14 +19457,6 @@ components: description: type: string description: Optional user-defined description for this tool or configuration. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. memory_store_name: type: string description: The name of the memory store to use. @@ -19664,14 +19821,6 @@ components: description: type: string description: Optional user-defined description for this tool or configuration. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. fabric_dataagent_preview: allOf: - $ref: '#/components/schemas/FabricDataAgentToolParameters' @@ -20421,26 +20570,12 @@ components: required: - type properties: - type: - type: string - enum: - - code_interpreter - description: The type of the code interpreter tool. Always `code_interpreter`. - x-stainless-const: true - 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. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. + type: + type: string + enum: + - code_interpreter + description: The type of the code interpreter tool. Always `code_interpreter`. + x-stainless-const: true container: anyOf: - type: string @@ -23507,20 +23642,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.Filters' nullable: true - 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. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A tool that searches for relevant content from uploaded files. Learn more about the [file search tool](https://platform.openai.com/docs/guides/tools-file-search). @@ -24506,20 +24627,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellToolParamEnvironment' nullable: true - 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. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A tool that allows the model to execute shell commands. @@ -25137,20 +25244,6 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.ImageGenActionEnum' description: 'Whether to generate a new image or edit an existing image. Default: `auto`.' - 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. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A tool that generates images using the GPT image models. @@ -29329,20 +29422,6 @@ components: 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. - description: - type: string - description: Optional user-defined description for this tool or configuration. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A tool that allows the model to execute shell commands in a local environment. @@ -29493,17 +29572,6 @@ components: - never nullable: true default: always - 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. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: |- @@ -33917,27 +33985,27 @@ components: discriminator: propertyName: type mapping: + code_interpreter: '#/components/schemas/OpenAI.CodeInterpreterTool' + file_search: '#/components/schemas/OpenAI.FileSearchTool' + web_search: '#/components/schemas/OpenAI.WebSearchTool' + mcp: '#/components/schemas/OpenAI.MCPTool' + azure_ai_search: '#/components/schemas/AzureAISearchTool' + openapi: '#/components/schemas/OpenApiTool' + a2a_preview: '#/components/schemas/A2APreviewTool' + work_iq_preview: '#/components/schemas/WorkIQPreviewTool' + fabric_iq_preview: '#/components/schemas/FabricIQPreviewTool' + toolbox_search_preview: '#/components/schemas/ToolboxSearchPreviewTool' bing_grounding: '#/components/schemas/BingGroundingTool' fabric_dataagent_preview: '#/components/schemas/MicrosoftFabricPreviewTool' sharepoint_grounding_preview: '#/components/schemas/SharepointPreviewTool' - azure_ai_search: '#/components/schemas/AzureAISearchTool' - openapi: '#/components/schemas/OpenApiTool' bing_custom_search_preview: '#/components/schemas/BingCustomSearchPreviewTool' browser_automation_preview: '#/components/schemas/BrowserAutomationPreviewTool' azure_function: '#/components/schemas/AzureFunctionTool' capture_structured_outputs: '#/components/schemas/CaptureStructuredOutputsTool' - a2a_preview: '#/components/schemas/A2APreviewTool' - work_iq_preview: '#/components/schemas/WorkIQPreviewTool' - fabric_iq_preview: '#/components/schemas/FabricIQPreviewTool' memory_search_preview: '#/components/schemas/MemorySearchPreviewTool' memory_search: '#/components/schemas/MemorySearchTool' - toolbox_search_preview: '#/components/schemas/ToolboxSearchPreviewTool' - code_interpreter: '#/components/schemas/OpenAI.CodeInterpreterTool' function: '#/components/schemas/OpenAI.FunctionTool' - file_search: '#/components/schemas/OpenAI.FileSearchTool' computer_use_preview: '#/components/schemas/OpenAI.ComputerUsePreviewTool' - web_search: '#/components/schemas/OpenAI.WebSearchTool' - mcp: '#/components/schemas/OpenAI.MCPTool' image_generation: '#/components/schemas/OpenAI.ImageGenTool' local_shell: '#/components/schemas/OpenAI.LocalShellToolParam' shell: '#/components/schemas/OpenAI.FunctionShellToolParam' @@ -34528,26 +34596,6 @@ components: - high 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. default: medium - 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. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. - custom_search_configuration: - allOf: - - $ref: '#/components/schemas/WebSearchConfiguration' - description: |- - The project connections attached to this tool. There can be a maximum of 1 connection - resource attached to the tool. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: |- @@ -34726,14 +34774,6 @@ components: allOf: - $ref: '#/components/schemas/OpenApiFunctionDefinition' description: The openapi function definition. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: The input definition information for an OpenAPI tool as used to configure an agent. @@ -34795,6 +34835,24 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: The output of an OpenAPI tool call. + OpenApiToolbox: + type: object + required: + - type + - openapi + properties: + type: + type: string + enum: + - openapi + description: The type of the tool. Always `openapi`. + openapi: + allOf: + - $ref: '#/components/schemas/OpenApiFunctionDefinition' + description: The openapi function definition. + allOf: + - $ref: '#/components/schemas/ToolboxTool' + description: An OpenAPI tool stored in a toolbox. OptimizationAgentDefinition: type: object properties: @@ -36597,14 +36655,6 @@ components: description: type: string description: Optional user-defined description for this tool or configuration. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. sharepoint_grounding_preview: allOf: - $ref: '#/components/schemas/SharepointGroundingToolParameters' @@ -37301,20 +37351,31 @@ components: description: type: string description: Optional user-defined description for this tool or configuration. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: |- A tool for searching over the agent's toolbox. When present, deferred tools are hidden from `tools/list` and only discoverable via `search_tools` queries at runtime. + ToolboxSearchPreviewToolbox: + type: object + required: + - type + properties: + type: + type: string + enum: + - toolbox_search_preview + description: The type of the tool. Always `toolbox_search_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. + allOf: + - $ref: '#/components/schemas/ToolboxTool' + description: A toolbox search tool stored in a toolbox. ToolboxSkill: type: object required: @@ -37349,6 +37410,57 @@ components: allOf: - $ref: '#/components/schemas/ToolboxSkill' description: A reference to an existing skill to include in a toolbox. + ToolboxTool: + type: object + required: + - type + properties: + type: + allOf: + - $ref: '#/components/schemas/ToolboxToolType' + description: The type of tool. + 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. + tool_configs: + type: object + additionalProperties: + $ref: '#/components/schemas/ToolConfig' + description: |- + Per-tool configuration map. Keys are tool names or `*` (catch-all default). + Resolution order: exact tool name match takes priority over `*`. + Unknown tool names are silently ignored at runtime. + discriminator: + propertyName: type + mapping: + code_interpreter: '#/components/schemas/CodeInterpreterToolbox' + file_search: '#/components/schemas/FileSearchToolbox' + web_search: '#/components/schemas/WebSearchToolbox' + mcp: '#/components/schemas/MCPToolbox' + azure_ai_search: '#/components/schemas/AzureAISearchToolbox' + openapi: '#/components/schemas/OpenApiToolbox' + a2a_preview: '#/components/schemas/A2APreviewToolbox' + work_iq_preview: '#/components/schemas/WorkIQPreviewToolbox' + fabric_iq_preview: '#/components/schemas/FabricIQPreviewToolbox' + toolbox_search_preview: '#/components/schemas/ToolboxSearchPreviewToolbox' + description: An abstract representation of a tool stored in a toolbox. + ToolboxToolType: + type: string + enum: + - code_interpreter + - file_search + - web_search + - mcp + - azure_ai_search + - openapi + - a2a_preview + - work_iq_preview + - fabric_iq_preview + - toolbox_search_preview + description: Supported tool types for tools stored in a toolbox. ToolboxVersionObject: type: object required: @@ -37393,7 +37505,7 @@ components: tools: type: array items: - $ref: '#/components/schemas/OpenAI.Tool' + $ref: '#/components/schemas/ToolboxTool' description: The list of tools contained in this toolbox version. skills: type: array @@ -37896,6 +38008,44 @@ components: type: string description: Name of the custom configuration instance given to config. description: A web search configuration for bing custom search + WebSearchToolbox: + type: object + required: + - type + properties: + type: + type: string + enum: + - web_search + description: The type of the tool. Always `web_search`. + default: web_search + filters: + type: object + allOf: + - $ref: '#/components/schemas/OpenAI.WebSearchToolFilters' + nullable: true + user_location: + type: object + allOf: + - $ref: '#/components/schemas/OpenAI.WebSearchApproximateLocation' + nullable: true + search_context_size: + type: string + enum: + - low + - medium + - high + 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. + default: medium + custom_search_configuration: + allOf: + - $ref: '#/components/schemas/WebSearchConfiguration' + description: |- + The project connections attached to this tool. There can be a maximum of 1 connection + resource attached to the tool. + allOf: + - $ref: '#/components/schemas/ToolboxTool' + description: A web search tool stored in a toolbox. WeeklyRecurrenceSchedule: type: object required: @@ -37935,17 +38085,32 @@ components: description: type: string description: Optional user-defined description for this tool or configuration. - tool_configs: - type: object - additionalProperties: - $ref: '#/components/schemas/ToolConfig' - description: |- - Per-tool configuration map. Keys are tool names or `*` (catch-all default). - Resolution order: exact tool name match takes priority over `*`. - Unknown tool names are silently ignored at runtime. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A WorkIQ server-side tool. + WorkIQPreviewToolbox: + type: object + required: + - type + - project_connection_id + properties: + type: + type: string + enum: + - work_iq_preview + description: The type of the tool. Always `work_iq_preview`. + project_connection_id: + type: string + description: The ID of the WorkIQ project connection. + 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. + allOf: + - $ref: '#/components/schemas/ToolboxTool' + description: A WorkIQ tool stored in a toolbox. WorkflowActionOutputItem: type: object required: 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 807c5208cca3..d90ddb4784f0 100644 --- a/specification/ai-foundry/data-plane/Foundry/src/toolboxes/models.tsp +++ b/specification/ai-foundry/data-plane/Foundry/src/toolboxes/models.tsp @@ -69,7 +69,7 @@ model ToolboxVersionObject { created_at: utcDateTime; @doc("The list of tools contained in this toolbox version.") - tools: OpenAI.Tool[]; + tools: ToolboxTool[]; @doc("The list of skill sources included in this toolbox version.") skills?: ToolboxSkill[]; @@ -92,7 +92,7 @@ alias CreateToolboxVersionRequest = { metadata?: Record; @doc("The list of tools to include in this version.") - tools: OpenAI.Tool[]; + tools: ToolboxTool[]; @doc("The list of skill sources to include in this version. A skill reference specifies a skill name and optionally a version. If version is omitted, the skill's default version is used.") skills?: ToolboxSkill[]; 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 5cc411bbe550..33597c974f36 100644 --- a/specification/ai-foundry/data-plane/Foundry/src/tools/models.tsp +++ b/specification/ai-foundry/data-plane/Foundry/src/tools/models.tsp @@ -62,72 +62,6 @@ namespace Azure.AI.Projects { additional_search_text?: string; } - #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" - @@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. - */ - project_connection_id?: string, - - ...ToolConfigExtension, - } - ); - - #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" - @@copyProperties(OpenAI.WebSearchTool, - { - ...ToolNameAndDescriptionExtension, - ...ToolConfigExtension, - - /** - * The project connections attached to this tool. There can be a maximum of 1 connection - * resource attached to the tool. - */ - custom_search_configuration?: WebSearchConfiguration, - } - ); - - #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" - @@copyProperties(OpenAI.CodeInterpreterTool, - { - ...ToolNameAndDescriptionExtension, - ...ToolConfigExtension, - } - ); - - #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" - @@copyProperties(OpenAI.ImageGenTool, - { - ...ToolNameAndDescriptionExtension, - ...ToolConfigExtension, - } - ); - - #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" - @@copyProperties(OpenAI.LocalShellToolParam, - { - ...ToolNameAndDescriptionExtension, - ...ToolConfigExtension, - } - ); - - #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" - @@copyProperties(OpenAI.FunctionShellToolParam, - { - ...ToolNameAndDescriptionExtension, - ...ToolConfigExtension, - } - ); - - #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" - @@copyProperties(OpenAI.FileSearchTool, - { - ...ToolNameAndDescriptionExtension, - ...ToolConfigExtension, - } - ); - /** * A web search configuration for bing custom search */ @@ -170,6 +104,169 @@ namespace Azure.AI.Projects { tool_configs?: Record; }; + /** + * Supported tool types for tools stored in a toolbox. + */ + union ToolboxToolType { + code_interpreter: "code_interpreter", + file_search: "file_search", + web_search: "web_search", + mcp: "mcp", + azure_ai_search: "azure_ai_search", + openapi: "openapi", + a2a_preview: "a2a_preview", + work_iq_preview: "work_iq_preview", + fabric_iq_preview: "fabric_iq_preview", + toolbox_search_preview: "toolbox_search_preview", + } + + /** + * An abstract representation of a tool stored in a toolbox. + */ + @discriminator("type") + model ToolboxTool { + /** + * The type of tool. + */ + type: ToolboxToolType; + + ...ToolNameAndDescriptionExtension; + ...ToolConfigExtension; + } + + /** + * A code interpreter tool stored in a toolbox. + */ + model CodeInterpreterToolbox extends ToolboxTool { + /** + * The type of the tool. Always `code_interpreter`. + */ + type: "code_interpreter"; + } + + /** + * A file search tool stored in a toolbox. + */ + model FileSearchToolbox extends ToolboxTool { + /** + * The type of the tool. Always `file_search`. + */ + type: "file_search" = "file_search"; + } + + /** + * A web search tool stored in a toolbox. + */ + model WebSearchToolbox extends ToolboxTool { + /** + * The type of the tool. Always `web_search`. + */ + type: "web_search" = "web_search"; + } + + /** + * An MCP tool stored in a toolbox. + */ + model MCPToolbox extends ToolboxTool { + /** + * The type of the tool. Always `mcp`. + */ + type: "mcp"; + } + + /** + * An Azure AI Search tool stored in a toolbox. + */ + model AzureAISearchToolbox extends ToolboxTool { + /** + * The type of the tool. Always `azure_ai_search`. + */ + type: "azure_ai_search"; + } + + /** + * An OpenAPI tool stored in a toolbox. + */ + model OpenApiToolbox extends ToolboxTool { + /** + * The type of the tool. Always `openapi`. + */ + type: "openapi"; + } + + /** + * An A2A tool stored in a toolbox. + */ + model A2APreviewToolbox extends ToolboxTool { + /** + * The type of the tool. Always `a2a_preview`. + */ + type: "a2a_preview"; + } + + /** + * A WorkIQ tool stored in a toolbox. + */ + model WorkIQPreviewToolbox extends ToolboxTool { + /** + * The type of the tool. Always `work_iq_preview`. + */ + type: "work_iq_preview"; + } + + /** + * A FabricIQ tool stored in a toolbox. + */ + model FabricIQPreviewToolbox extends ToolboxTool { + /** + * The type of the tool. Always `fabric_iq_preview`. + */ + type: "fabric_iq_preview"; + } + + /** + * A toolbox search tool stored in a toolbox. + */ + model ToolboxSearchPreviewToolbox extends ToolboxTool { + /** + * The type of the tool. Always `toolbox_search_preview`. + */ + type: "toolbox_search_preview"; + } + + #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" + @@copyProperties(CodeInterpreterToolbox, OpenAI.CodeInterpreterTool); + + #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" + @@copyProperties(FileSearchToolbox, OpenAI.FileSearchTool); + + #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" + @@copyProperties(WebSearchToolbox, OpenAI.WebSearchTool); + + #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" + @@copyProperties(WebSearchToolbox, + { + /** + * The project connections attached to this tool. There can be a maximum of 1 connection + * resource attached to the tool. + */ + custom_search_configuration?: WebSearchConfiguration, + } + ); + + #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" + @@copyProperties(MCPToolbox, OpenAI.MCPTool); + + #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" + @@copyProperties(MCPToolbox, + { + /** + * 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. + */ + project_connection_id?: string, + } + ); + /** * The input definition information for a bing grounding search tool as used to configure an agent. */ @@ -180,7 +277,6 @@ namespace Azure.AI.Projects { type: "bing_grounding"; ...ToolNameAndDescriptionExtension; - ...ToolConfigExtension; /** * The bing grounding search tool parameters. @@ -210,7 +306,6 @@ namespace Azure.AI.Projects { type: "fabric_dataagent_preview"; ...ToolNameAndDescriptionExtension; - ...ToolConfigExtension; /** * The fabric data agent tool parameters. @@ -240,7 +335,6 @@ namespace Azure.AI.Projects { type: "sharepoint_grounding_preview"; ...ToolNameAndDescriptionExtension; - ...ToolConfigExtension; /** * The sharepoint grounding tool parameters. @@ -258,7 +352,6 @@ namespace Azure.AI.Projects { type: "azure_ai_search"; ...ToolNameAndDescriptionExtension; - ...ToolConfigExtension; /** * The azure ai search index resource. @@ -353,8 +446,6 @@ namespace Azure.AI.Projects { * The openapi function definition. */ openapi: OpenApiFunctionDefinition; - - ...ToolConfigExtension; } /** @@ -367,7 +458,6 @@ namespace Azure.AI.Projects { type: "bing_custom_search_preview"; ...ToolNameAndDescriptionExtension; - ...ToolConfigExtension; /** * The bing custom search tool parameters. @@ -385,7 +475,6 @@ namespace Azure.AI.Projects { type: "browser_automation_preview"; ...ToolNameAndDescriptionExtension; - ...ToolConfigExtension; /** * The Browser Automation Tool parameters. @@ -426,8 +515,6 @@ namespace Azure.AI.Projects { * The Azure Function Tool definition. */ azure_function: AzureFunctionDefinition; - - ...ToolConfigExtension; } /** @@ -778,7 +865,6 @@ namespace Azure.AI.Projects { type: "capture_structured_outputs"; ...ToolNameAndDescriptionExtension; - ...ToolConfigExtension; /** * The structured outputs to capture from the model. @@ -796,7 +882,6 @@ namespace Azure.AI.Projects { type: "a2a_preview"; ...ToolNameAndDescriptionExtension; - ...ToolConfigExtension; /** * Base URL of the agent. @@ -831,7 +916,6 @@ namespace Azure.AI.Projects { project_connection_id: string; ...ToolNameAndDescriptionExtension; - ...ToolConfigExtension; } /** @@ -866,7 +950,6 @@ namespace Azure.AI.Projects { require_approval?: OpenAI.MCPToolRequireApproval | string | null = "always"; ...ToolNameAndDescriptionExtension; - ...ToolConfigExtension; } /** @@ -879,7 +962,6 @@ namespace Azure.AI.Projects { type: "memory_search_preview"; ...ToolNameAndDescriptionExtension; - ...ToolConfigExtension; /** * The name of the memory store to use. @@ -915,7 +997,6 @@ namespace Azure.AI.Projects { type: "memory_search"; ...ToolNameAndDescriptionExtension; - ...ToolConfigExtension; /** * The name of the memory store to use. @@ -952,9 +1033,26 @@ namespace Azure.AI.Projects { type: "toolbox_search_preview"; ...ToolNameAndDescriptionExtension; - ...ToolConfigExtension; } + #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" + @@copyProperties(AzureAISearchToolbox, AzureAISearchTool); + + #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" + @@copyProperties(OpenApiToolbox, OpenApiTool); + + #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" + @@copyProperties(A2APreviewToolbox, A2APreviewTool); + + #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" + @@copyProperties(WorkIQPreviewToolbox, WorkIQPreviewTool); + + #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" + @@copyProperties(FabricIQPreviewToolbox, FabricIQPreviewTool); + + #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" + @@copyProperties(ToolboxSearchPreviewToolbox, ToolboxSearchPreviewTool); + // ============================================================================== // Grounding Tool Call Status and Document Models // ============================================================================== From 1211c4e2b05b6fc31243b0be60fc57d8a3cb6303 Mon Sep 17 00:00:00 2001 From: Vishwanath Balaji Date: Fri, 22 May 2026 18:27:17 -0700 Subject: [PATCH 02/12] Refine toolbox tool schemas Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../v1/microsoft-foundry-openapi3.json | 66 +---- .../v1/microsoft-foundry-openapi3.yaml | 51 +--- .../microsoft-foundry-openapi3.json | 66 +---- .../microsoft-foundry-openapi3.yaml | 51 +--- .../Foundry/src/toolboxes/models.tsp | 229 +++++++++++++++++ .../data-plane/Foundry/src/tools/models.tsp | 241 ------------------ 6 files changed, 271 insertions(+), 433 deletions(-) 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 495e9b4f41f2..aaa5de8aade5 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 @@ -22822,8 +22822,7 @@ "FileSearchToolbox": { "type": "object", "required": [ - "type", - "vector_store_ids" + "type" ], "properties": { "type": { @@ -22831,8 +22830,7 @@ "enum": [ "file_search" ], - "description": "The type of the tool. Always `file_search`.", - "default": "file_search" + "description": "The type of the tool. Always `file_search`." }, "vector_store_ids": { "type": "array", @@ -43935,24 +43933,23 @@ "discriminator": { "propertyName": "type", "mapping": { - "code_interpreter": "#/components/schemas/OpenAI.CodeInterpreterTool", - "file_search": "#/components/schemas/OpenAI.FileSearchTool", - "web_search": "#/components/schemas/OpenAI.WebSearchTool", - "mcp": "#/components/schemas/OpenAI.MCPTool", - "azure_ai_search": "#/components/schemas/AzureAISearchTool", - "openapi": "#/components/schemas/OpenApiTool", - "a2a_preview": "#/components/schemas/A2APreviewTool", - "work_iq_preview": "#/components/schemas/WorkIQPreviewTool", - "fabric_iq_preview": "#/components/schemas/FabricIQPreviewTool", - "toolbox_search_preview": "#/components/schemas/ToolboxSearchPreviewTool", "bing_grounding": "#/components/schemas/BingGroundingTool", "fabric_dataagent_preview": "#/components/schemas/MicrosoftFabricPreviewTool", "sharepoint_grounding_preview": "#/components/schemas/SharepointPreviewTool", + "azure_ai_search": "#/components/schemas/AzureAISearchTool", + "openapi": "#/components/schemas/OpenApiTool", "bing_custom_search_preview": "#/components/schemas/BingCustomSearchPreviewTool", "browser_automation_preview": "#/components/schemas/BrowserAutomationPreviewTool", "azure_function": "#/components/schemas/AzureFunctionTool", "capture_structured_outputs": "#/components/schemas/CaptureStructuredOutputsTool", + "a2a_preview": "#/components/schemas/A2APreviewTool", + "work_iq_preview": "#/components/schemas/WorkIQPreviewTool", + "fabric_iq_preview": "#/components/schemas/FabricIQPreviewTool", "memory_search_preview": "#/components/schemas/MemorySearchPreviewTool", + "code_interpreter": "#/components/schemas/OpenAI.CodeInterpreterTool", + "file_search": "#/components/schemas/OpenAI.FileSearchTool", + "web_search": "#/components/schemas/OpenAI.WebSearchTool", + "mcp": "#/components/schemas/OpenAI.MCPTool", "function": "#/components/schemas/OpenAI.FunctionTool", "computer_use_preview": "#/components/schemas/OpenAI.ComputerUsePreviewTool", "image_generation": "#/components/schemas/OpenAI.ImageGenTool", @@ -44305,7 +44302,6 @@ "memory_search_preview", "work_iq_preview", "fabric_iq_preview", - "toolbox_search_preview", "azure_ai_search", "azure_function", "bing_grounding", @@ -48686,35 +48682,6 @@ }, "description": "Policy configuration for a toolbox, including content safety and other governance settings." }, - "ToolboxSearchPreviewTool": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "toolbox_search_preview" - ], - "description": "The type of the tool. Always `toolbox_search_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." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Tool" - } - ], - "description": "A tool for searching over the agent's toolbox.\nWhen present, deferred tools are hidden from `tools/list` and only\ndiscoverable via `search_tools` queries at runtime." - }, "ToolboxSearchPreviewToolbox": { "type": "object", "required": [ @@ -48727,14 +48694,6 @@ "toolbox_search_preview" ], "description": "The type of the tool. Always `toolbox_search_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." } }, "allOf": [ @@ -49602,8 +49561,7 @@ "enum": [ "web_search" ], - "description": "The type of the tool. Always `web_search`.", - "default": "web_search" + "description": "The type of the tool. Always `web_search`." }, "filters": { "type": "object", 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 593aa9d6ffc7..d5eaa08c644b 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 @@ -15494,14 +15494,12 @@ components: type: object required: - type - - vector_store_ids properties: type: type: string enum: - file_search description: The type of the tool. Always `file_search`. - default: file_search vector_store_ids: type: array items: @@ -31064,24 +31062,23 @@ components: discriminator: propertyName: type mapping: - code_interpreter: '#/components/schemas/OpenAI.CodeInterpreterTool' - file_search: '#/components/schemas/OpenAI.FileSearchTool' - web_search: '#/components/schemas/OpenAI.WebSearchTool' - mcp: '#/components/schemas/OpenAI.MCPTool' - azure_ai_search: '#/components/schemas/AzureAISearchTool' - openapi: '#/components/schemas/OpenApiTool' - a2a_preview: '#/components/schemas/A2APreviewTool' - work_iq_preview: '#/components/schemas/WorkIQPreviewTool' - fabric_iq_preview: '#/components/schemas/FabricIQPreviewTool' - toolbox_search_preview: '#/components/schemas/ToolboxSearchPreviewTool' bing_grounding: '#/components/schemas/BingGroundingTool' fabric_dataagent_preview: '#/components/schemas/MicrosoftFabricPreviewTool' sharepoint_grounding_preview: '#/components/schemas/SharepointPreviewTool' + azure_ai_search: '#/components/schemas/AzureAISearchTool' + openapi: '#/components/schemas/OpenApiTool' bing_custom_search_preview: '#/components/schemas/BingCustomSearchPreviewTool' browser_automation_preview: '#/components/schemas/BrowserAutomationPreviewTool' azure_function: '#/components/schemas/AzureFunctionTool' capture_structured_outputs: '#/components/schemas/CaptureStructuredOutputsTool' + a2a_preview: '#/components/schemas/A2APreviewTool' + work_iq_preview: '#/components/schemas/WorkIQPreviewTool' + fabric_iq_preview: '#/components/schemas/FabricIQPreviewTool' memory_search_preview: '#/components/schemas/MemorySearchPreviewTool' + code_interpreter: '#/components/schemas/OpenAI.CodeInterpreterTool' + file_search: '#/components/schemas/OpenAI.FileSearchTool' + web_search: '#/components/schemas/OpenAI.WebSearchTool' + mcp: '#/components/schemas/OpenAI.MCPTool' function: '#/components/schemas/OpenAI.FunctionTool' computer_use_preview: '#/components/schemas/OpenAI.ComputerUsePreviewTool' image_generation: '#/components/schemas/OpenAI.ImageGenTool' @@ -31358,7 +31355,6 @@ components: - memory_search_preview - work_iq_preview - fabric_iq_preview - - toolbox_search_preview - azure_ai_search - azure_function - bing_grounding @@ -34330,28 +34326,6 @@ components: - $ref: '#/components/schemas/RaiConfig' description: Responsible AI content filtering configuration. description: Policy configuration for a toolbox, including content safety and other governance settings. - ToolboxSearchPreviewTool: - type: object - required: - - type - properties: - type: - type: string - enum: - - toolbox_search_preview - description: The type of the tool. Always `toolbox_search_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. - allOf: - - $ref: '#/components/schemas/OpenAI.Tool' - description: |- - A tool for searching over the agent's toolbox. - When present, deferred tools are hidden from `tools/list` and only - discoverable via `search_tools` queries at runtime. ToolboxSearchPreviewToolbox: type: object required: @@ -34362,12 +34336,6 @@ components: enum: - toolbox_search_preview description: The type of the tool. Always `toolbox_search_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. allOf: - $ref: '#/components/schemas/ToolboxTool' description: A toolbox search tool stored in a toolbox. @@ -34962,7 +34930,6 @@ components: enum: - web_search description: The type of the tool. Always `web_search`. - default: web_search filters: type: object allOf: 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 5cc78011b45f..0d1da30bf019 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 @@ -26918,8 +26918,7 @@ "FileSearchToolbox": { "type": "object", "required": [ - "type", - "vector_store_ids" + "type" ], "properties": { "type": { @@ -26927,8 +26926,7 @@ "enum": [ "file_search" ], - "description": "The type of the tool. Always `file_search`.", - "default": "file_search" + "description": "The type of the tool. Always `file_search`." }, "vector_store_ids": { "type": "array", @@ -48227,25 +48225,24 @@ "discriminator": { "propertyName": "type", "mapping": { - "code_interpreter": "#/components/schemas/OpenAI.CodeInterpreterTool", - "file_search": "#/components/schemas/OpenAI.FileSearchTool", - "web_search": "#/components/schemas/OpenAI.WebSearchTool", - "mcp": "#/components/schemas/OpenAI.MCPTool", - "azure_ai_search": "#/components/schemas/AzureAISearchTool", - "openapi": "#/components/schemas/OpenApiTool", - "a2a_preview": "#/components/schemas/A2APreviewTool", - "work_iq_preview": "#/components/schemas/WorkIQPreviewTool", - "fabric_iq_preview": "#/components/schemas/FabricIQPreviewTool", - "toolbox_search_preview": "#/components/schemas/ToolboxSearchPreviewTool", "bing_grounding": "#/components/schemas/BingGroundingTool", "fabric_dataagent_preview": "#/components/schemas/MicrosoftFabricPreviewTool", "sharepoint_grounding_preview": "#/components/schemas/SharepointPreviewTool", + "azure_ai_search": "#/components/schemas/AzureAISearchTool", + "openapi": "#/components/schemas/OpenApiTool", "bing_custom_search_preview": "#/components/schemas/BingCustomSearchPreviewTool", "browser_automation_preview": "#/components/schemas/BrowserAutomationPreviewTool", "azure_function": "#/components/schemas/AzureFunctionTool", "capture_structured_outputs": "#/components/schemas/CaptureStructuredOutputsTool", + "a2a_preview": "#/components/schemas/A2APreviewTool", + "work_iq_preview": "#/components/schemas/WorkIQPreviewTool", + "fabric_iq_preview": "#/components/schemas/FabricIQPreviewTool", "memory_search_preview": "#/components/schemas/MemorySearchPreviewTool", "memory_search": "#/components/schemas/MemorySearchTool", + "code_interpreter": "#/components/schemas/OpenAI.CodeInterpreterTool", + "file_search": "#/components/schemas/OpenAI.FileSearchTool", + "web_search": "#/components/schemas/OpenAI.WebSearchTool", + "mcp": "#/components/schemas/OpenAI.MCPTool", "function": "#/components/schemas/OpenAI.FunctionTool", "computer_use_preview": "#/components/schemas/OpenAI.ComputerUsePreviewTool", "image_generation": "#/components/schemas/OpenAI.ImageGenTool", @@ -48598,7 +48595,6 @@ "memory_search_preview", "work_iq_preview", "fabric_iq_preview", - "toolbox_search_preview", "azure_ai_search", "azure_function", "bing_grounding", @@ -53099,35 +53095,6 @@ }, "description": "Policy configuration for a toolbox, including content safety and other governance settings." }, - "ToolboxSearchPreviewTool": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "toolbox_search_preview" - ], - "description": "The type of the tool. Always `toolbox_search_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." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Tool" - } - ], - "description": "A tool for searching over the agent's toolbox.\nWhen present, deferred tools are hidden from `tools/list` and only\ndiscoverable via `search_tools` queries at runtime." - }, "ToolboxSearchPreviewToolbox": { "type": "object", "required": [ @@ -53140,14 +53107,6 @@ "toolbox_search_preview" ], "description": "The type of the tool. Always `toolbox_search_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." } }, "allOf": [ @@ -54095,8 +54054,7 @@ "enum": [ "web_search" ], - "description": "The type of the tool. Always `web_search`.", - "default": "web_search" + "description": "The type of the tool. Always `web_search`." }, "filters": { "type": "object", 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 53cf0fab2fe1..8d2dfc36a174 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 @@ -18281,14 +18281,12 @@ components: type: object required: - type - - vector_store_ids properties: type: type: string enum: - file_search description: The type of the tool. Always `file_search`. - default: file_search vector_store_ids: type: array items: @@ -33985,25 +33983,24 @@ components: discriminator: propertyName: type mapping: - code_interpreter: '#/components/schemas/OpenAI.CodeInterpreterTool' - file_search: '#/components/schemas/OpenAI.FileSearchTool' - web_search: '#/components/schemas/OpenAI.WebSearchTool' - mcp: '#/components/schemas/OpenAI.MCPTool' - azure_ai_search: '#/components/schemas/AzureAISearchTool' - openapi: '#/components/schemas/OpenApiTool' - a2a_preview: '#/components/schemas/A2APreviewTool' - work_iq_preview: '#/components/schemas/WorkIQPreviewTool' - fabric_iq_preview: '#/components/schemas/FabricIQPreviewTool' - toolbox_search_preview: '#/components/schemas/ToolboxSearchPreviewTool' bing_grounding: '#/components/schemas/BingGroundingTool' fabric_dataagent_preview: '#/components/schemas/MicrosoftFabricPreviewTool' sharepoint_grounding_preview: '#/components/schemas/SharepointPreviewTool' + azure_ai_search: '#/components/schemas/AzureAISearchTool' + openapi: '#/components/schemas/OpenApiTool' bing_custom_search_preview: '#/components/schemas/BingCustomSearchPreviewTool' browser_automation_preview: '#/components/schemas/BrowserAutomationPreviewTool' azure_function: '#/components/schemas/AzureFunctionTool' capture_structured_outputs: '#/components/schemas/CaptureStructuredOutputsTool' + a2a_preview: '#/components/schemas/A2APreviewTool' + work_iq_preview: '#/components/schemas/WorkIQPreviewTool' + fabric_iq_preview: '#/components/schemas/FabricIQPreviewTool' memory_search_preview: '#/components/schemas/MemorySearchPreviewTool' memory_search: '#/components/schemas/MemorySearchTool' + code_interpreter: '#/components/schemas/OpenAI.CodeInterpreterTool' + file_search: '#/components/schemas/OpenAI.FileSearchTool' + web_search: '#/components/schemas/OpenAI.WebSearchTool' + mcp: '#/components/schemas/OpenAI.MCPTool' function: '#/components/schemas/OpenAI.FunctionTool' computer_use_preview: '#/components/schemas/OpenAI.ComputerUsePreviewTool' image_generation: '#/components/schemas/OpenAI.ImageGenTool' @@ -34280,7 +34277,6 @@ components: - memory_search_preview - work_iq_preview - fabric_iq_preview - - toolbox_search_preview - azure_ai_search - azure_function - bing_grounding @@ -37335,28 +37331,6 @@ components: - $ref: '#/components/schemas/RaiConfig' description: Responsible AI content filtering configuration. description: Policy configuration for a toolbox, including content safety and other governance settings. - ToolboxSearchPreviewTool: - type: object - required: - - type - properties: - type: - type: string - enum: - - toolbox_search_preview - description: The type of the tool. Always `toolbox_search_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. - allOf: - - $ref: '#/components/schemas/OpenAI.Tool' - description: |- - A tool for searching over the agent's toolbox. - When present, deferred tools are hidden from `tools/list` and only - discoverable via `search_tools` queries at runtime. ToolboxSearchPreviewToolbox: type: object required: @@ -37367,12 +37341,6 @@ components: enum: - toolbox_search_preview description: The type of the tool. Always `toolbox_search_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. allOf: - $ref: '#/components/schemas/ToolboxTool' description: A toolbox search tool stored in a toolbox. @@ -38018,7 +37986,6 @@ components: enum: - web_search description: The type of the tool. Always `web_search`. - default: web_search filters: type: object allOf: 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 d90ddb4784f0..cde0a4816c19 100644 --- a/specification/ai-foundry/data-plane/Foundry/src/toolboxes/models.tsp +++ b/specification/ai-foundry/data-plane/Foundry/src/toolboxes/models.tsp @@ -5,9 +5,238 @@ import "../skills/models.tsp"; using TypeSpec.Http; using TypeSpec.OpenAPI; +using Azure.Core.Experimental; namespace Azure.AI.Projects; +/** + * Per-tool configuration that controls tool visibility and search behavior. + */ +model ToolConfig { + /** + * When true, the tool is always included in agent context and visible in `tools/list`. + * When false (default), the tool is hidden from `tools/list` and only discoverable via `tool_search`. + */ + pin?: boolean; + + /** + * Additional text indexed for tool_search. Supplements the native tool description + * to improve discoverability. Does not alter `tools/list` output. + */ + @maxLength(1000) + additional_search_text?: string; +} + +/** + * A web search configuration for bing custom search + */ +model WebSearchConfiguration { + /** + * Project connection id for grounding with bing custom search + */ + project_connection_id: string; + + /** + * Name of the custom configuration instance given to config. + */ + instance_name: string; +} + +/** + * Optional tool configuration extension for controlling tool visibility and search behavior. + */ +alias ToolConfigExtension = { + /** + * Per-tool configuration map. Keys are tool names or `*` (catch-all default). + * Resolution order: exact tool name match takes priority over `*`. + * Unknown tool names are silently ignored at runtime. + */ + tool_configs?: Record; +}; + +/** + * Supported tool types for tools stored in a toolbox. + */ +union ToolboxToolType { + code_interpreter: "code_interpreter", + file_search: "file_search", + web_search: "web_search", + mcp: "mcp", + azure_ai_search: "azure_ai_search", + openapi: "openapi", + a2a_preview: "a2a_preview", + work_iq_preview: "work_iq_preview", + fabric_iq_preview: "fabric_iq_preview", + toolbox_search_preview: "toolbox_search_preview", +} + +/** + * An abstract representation of a tool stored in a toolbox. + */ +@discriminator("type") +model ToolboxTool { + /** + * The type of tool. + */ + type: ToolboxToolType; + + ...ToolNameAndDescriptionExtension; + ...ToolConfigExtension; +} + +/** + * A code interpreter tool stored in a toolbox. + */ +model CodeInterpreterToolbox extends ToolboxTool { + /** + * The type of the tool. Always `code_interpreter`. + */ + type: "code_interpreter"; +} + +/** + * A file search tool stored in a toolbox. + */ +model FileSearchToolbox extends ToolboxTool { + /** + * The type of the tool. Always `file_search`. + */ + type: "file_search"; + + /** + * The IDs of the vector stores to search. + */ + vector_store_ids?: string[]; +} + +/** + * A web search tool stored in a toolbox. + */ +model WebSearchToolbox extends ToolboxTool { + /** + * The type of the tool. Always `web_search`. + */ + type: "web_search"; +} + +/** + * An MCP tool stored in a toolbox. + */ +model MCPToolbox extends ToolboxTool { + /** + * The type of the tool. Always `mcp`. + */ + type: "mcp"; +} + +/** + * An Azure AI Search tool stored in a toolbox. + */ +model AzureAISearchToolbox extends ToolboxTool { + /** + * The type of the tool. Always `azure_ai_search`. + */ + type: "azure_ai_search"; +} + +/** + * An OpenAPI tool stored in a toolbox. + */ +model OpenApiToolbox extends ToolboxTool { + /** + * The type of the tool. Always `openapi`. + */ + type: "openapi"; +} + +/** + * An A2A tool stored in a toolbox. + */ +model A2APreviewToolbox extends ToolboxTool { + /** + * The type of the tool. Always `a2a_preview`. + */ + type: "a2a_preview"; +} + +/** + * A WorkIQ tool stored in a toolbox. + */ +model WorkIQPreviewToolbox extends ToolboxTool { + /** + * The type of the tool. Always `work_iq_preview`. + */ + type: "work_iq_preview"; +} + +/** + * A FabricIQ tool stored in a toolbox. + */ +model FabricIQPreviewToolbox extends ToolboxTool { + /** + * The type of the tool. Always `fabric_iq_preview`. + */ + type: "fabric_iq_preview"; +} + +/** + * A toolbox search tool stored in a toolbox. + */ +model ToolboxSearchPreviewToolbox extends ToolboxTool { + /** + * The type of the tool. Always `toolbox_search_preview`. + */ + type: "toolbox_search_preview"; +} + +#suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" +@@copyProperties(CodeInterpreterToolbox, OpenAI.CodeInterpreterTool); + +#suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" +@@copyProperties(FileSearchToolbox, OpenAI.FileSearchTool); + +#suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" +@@copyProperties(WebSearchToolbox, OpenAI.WebSearchTool); + +#suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" +@@copyProperties(WebSearchToolbox, + { + /** + * The project connections attached to this tool. There can be a maximum of 1 connection + * resource attached to the tool. + */ + custom_search_configuration?: WebSearchConfiguration, + } +); + +#suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" +@@copyProperties(MCPToolbox, OpenAI.MCPTool); + +#suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" +@@copyProperties(MCPToolbox, + { + /** + * 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. + */ + project_connection_id?: string, + } +); + +#suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" +@@copyProperties(AzureAISearchToolbox, AzureAISearchTool); + +#suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" +@@copyProperties(OpenApiToolbox, OpenApiTool); + +#suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" +@@copyProperties(A2APreviewToolbox, A2APreviewTool); + +#suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" +@@copyProperties(WorkIQPreviewToolbox, WorkIQPreviewTool); + +#suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" +@@copyProperties(FabricIQPreviewToolbox, FabricIQPreviewTool); + @doc("Policy configuration for a toolbox, including content safety and other governance settings.") model ToolboxPolicies { @doc("Responsible AI content filtering configuration.") 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 33597c974f36..3440e834ed18 100644 --- a/specification/ai-foundry/data-plane/Foundry/src/tools/models.tsp +++ b/specification/ai-foundry/data-plane/Foundry/src/tools/models.tsp @@ -19,7 +19,6 @@ namespace Azure.AI.Projects { memory_search_preview: "memory_search_preview", work_iq_preview: "work_iq_preview", fabric_iq_preview: "fabric_iq_preview", - toolbox_search_preview: "toolbox_search_preview", } // General availability tools: @@ -44,39 +43,6 @@ namespace Azure.AI.Projects { #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" @@copyVariants(OpenAI.IncludeEnum, Azure.AI.Projects._AgentIncludable); - /** - * Per-tool configuration that controls tool visibility and search behavior. - */ - model ToolConfig { - /** - * When true, the tool is always included in agent context and visible in `tools/list`. - * When false (default), the tool is hidden from `tools/list` and only discoverable via `tool_search`. - */ - pin?: boolean; - - /** - * Additional text indexed for tool_search. Supplements the native tool description - * to improve discoverability. Does not alter `tools/list` output. - */ - @maxLength(1000) - additional_search_text?: string; - } - - /** - * A web search configuration for bing custom search - */ - model WebSearchConfiguration { - /** - * Project connection id for grounding with bing custom search - */ - project_connection_id: string; - - /** - * Name of the custom configuration instance given to config. - */ - instance_name: string; - } - /** * Optional name and description fields for tool definitions and nested tool configurations. */ @@ -92,181 +58,6 @@ namespace Azure.AI.Projects { description?: string; }; - /** - * Optional tool configuration extension for controlling tool visibility and search behavior. - */ - alias ToolConfigExtension = { - /** - * Per-tool configuration map. Keys are tool names or `*` (catch-all default). - * Resolution order: exact tool name match takes priority over `*`. - * Unknown tool names are silently ignored at runtime. - */ - tool_configs?: Record; - }; - - /** - * Supported tool types for tools stored in a toolbox. - */ - union ToolboxToolType { - code_interpreter: "code_interpreter", - file_search: "file_search", - web_search: "web_search", - mcp: "mcp", - azure_ai_search: "azure_ai_search", - openapi: "openapi", - a2a_preview: "a2a_preview", - work_iq_preview: "work_iq_preview", - fabric_iq_preview: "fabric_iq_preview", - toolbox_search_preview: "toolbox_search_preview", - } - - /** - * An abstract representation of a tool stored in a toolbox. - */ - @discriminator("type") - model ToolboxTool { - /** - * The type of tool. - */ - type: ToolboxToolType; - - ...ToolNameAndDescriptionExtension; - ...ToolConfigExtension; - } - - /** - * A code interpreter tool stored in a toolbox. - */ - model CodeInterpreterToolbox extends ToolboxTool { - /** - * The type of the tool. Always `code_interpreter`. - */ - type: "code_interpreter"; - } - - /** - * A file search tool stored in a toolbox. - */ - model FileSearchToolbox extends ToolboxTool { - /** - * The type of the tool. Always `file_search`. - */ - type: "file_search" = "file_search"; - } - - /** - * A web search tool stored in a toolbox. - */ - model WebSearchToolbox extends ToolboxTool { - /** - * The type of the tool. Always `web_search`. - */ - type: "web_search" = "web_search"; - } - - /** - * An MCP tool stored in a toolbox. - */ - model MCPToolbox extends ToolboxTool { - /** - * The type of the tool. Always `mcp`. - */ - type: "mcp"; - } - - /** - * An Azure AI Search tool stored in a toolbox. - */ - model AzureAISearchToolbox extends ToolboxTool { - /** - * The type of the tool. Always `azure_ai_search`. - */ - type: "azure_ai_search"; - } - - /** - * An OpenAPI tool stored in a toolbox. - */ - model OpenApiToolbox extends ToolboxTool { - /** - * The type of the tool. Always `openapi`. - */ - type: "openapi"; - } - - /** - * An A2A tool stored in a toolbox. - */ - model A2APreviewToolbox extends ToolboxTool { - /** - * The type of the tool. Always `a2a_preview`. - */ - type: "a2a_preview"; - } - - /** - * A WorkIQ tool stored in a toolbox. - */ - model WorkIQPreviewToolbox extends ToolboxTool { - /** - * The type of the tool. Always `work_iq_preview`. - */ - type: "work_iq_preview"; - } - - /** - * A FabricIQ tool stored in a toolbox. - */ - model FabricIQPreviewToolbox extends ToolboxTool { - /** - * The type of the tool. Always `fabric_iq_preview`. - */ - type: "fabric_iq_preview"; - } - - /** - * A toolbox search tool stored in a toolbox. - */ - model ToolboxSearchPreviewToolbox extends ToolboxTool { - /** - * The type of the tool. Always `toolbox_search_preview`. - */ - type: "toolbox_search_preview"; - } - - #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" - @@copyProperties(CodeInterpreterToolbox, OpenAI.CodeInterpreterTool); - - #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" - @@copyProperties(FileSearchToolbox, OpenAI.FileSearchTool); - - #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" - @@copyProperties(WebSearchToolbox, OpenAI.WebSearchTool); - - #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" - @@copyProperties(WebSearchToolbox, - { - /** - * The project connections attached to this tool. There can be a maximum of 1 connection - * resource attached to the tool. - */ - custom_search_configuration?: WebSearchConfiguration, - } - ); - - #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" - @@copyProperties(MCPToolbox, OpenAI.MCPTool); - - #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" - @@copyProperties(MCPToolbox, - { - /** - * 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. - */ - project_connection_id?: string, - } - ); - /** * The input definition information for a bing grounding search tool as used to configure an agent. */ @@ -1021,38 +812,6 @@ namespace Azure.AI.Projects { update_delay?: int32 = 300; } - /** - * A tool for searching over the agent's toolbox. - * When present, deferred tools are hidden from `tools/list` and only - * discoverable via `search_tools` queries at runtime. - */ - model ToolboxSearchPreviewTool extends OpenAI.Tool { - /** - * The type of the tool. Always `toolbox_search_preview`. - */ - type: "toolbox_search_preview"; - - ...ToolNameAndDescriptionExtension; - } - - #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" - @@copyProperties(AzureAISearchToolbox, AzureAISearchTool); - - #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" - @@copyProperties(OpenApiToolbox, OpenApiTool); - - #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" - @@copyProperties(A2APreviewToolbox, A2APreviewTool); - - #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" - @@copyProperties(WorkIQPreviewToolbox, WorkIQPreviewTool); - - #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" - @@copyProperties(FabricIQPreviewToolbox, FabricIQPreviewTool); - - #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" - @@copyProperties(ToolboxSearchPreviewToolbox, ToolboxSearchPreviewTool); - // ============================================================================== // Grounding Tool Call Status and Document Models // ============================================================================== From b01d4c785b7f171d18a0c5fcdb505cc4a42f5da2 Mon Sep 17 00:00:00 2001 From: Vishwanath Balaji Date: Fri, 22 May 2026 18:30:17 -0700 Subject: [PATCH 03/12] Support custom web search config for agents Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../v1/microsoft-foundry-openapi3.json | 14 ++++++++--- .../v1/microsoft-foundry-openapi3.yaml | 12 +++++---- .../microsoft-foundry-openapi3.json | 14 ++++++++--- .../microsoft-foundry-openapi3.yaml | 12 +++++---- .../Foundry/src/toolboxes/models.tsp | 15 ----------- .../data-plane/Foundry/src/tools/models.tsp | 25 +++++++++++++++++++ 6 files changed, 61 insertions(+), 31 deletions(-) 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 aaa5de8aade5..29e165295246 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 @@ -44723,6 +44723,14 @@ ], "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.", "default": "medium" + }, + "custom_search_configuration": { + "allOf": [ + { + "$ref": "#/components/schemas/WebSearchConfiguration" + } + ], + "description": "Custom search configuration for domain-restricted web search." } }, "allOf": [ @@ -49541,14 +49549,14 @@ "properties": { "project_connection_id": { "type": "string", - "description": "Project connection id for grounding with bing custom search" + "description": "Project connection ID for grounding with Bing custom search." }, "instance_name": { "type": "string", "description": "Name of the custom configuration instance given to config." } }, - "description": "A web search configuration for bing custom search" + "description": "A web search configuration for Bing custom search." }, "WebSearchToolbox": { "type": "object", @@ -49597,7 +49605,7 @@ "$ref": "#/components/schemas/WebSearchConfiguration" } ], - "description": "The project connections attached to this tool. There can be a maximum of 1 connection\nresource attached to the tool." + "description": "Custom search configuration for domain-restricted web search." } }, "allOf": [ 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 d5eaa08c644b..d3c8c5210638 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 @@ -31669,6 +31669,10 @@ components: - high 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. default: medium + custom_search_configuration: + allOf: + - $ref: '#/components/schemas/WebSearchConfiguration' + description: Custom search configuration for domain-restricted web search. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: |- @@ -34915,11 +34919,11 @@ components: properties: project_connection_id: type: string - description: Project connection id for grounding with bing custom search + description: Project connection ID for grounding with Bing custom search. instance_name: type: string description: Name of the custom configuration instance given to config. - description: A web search configuration for bing custom search + description: A web search configuration for Bing custom search. WebSearchToolbox: type: object required: @@ -34951,9 +34955,7 @@ components: custom_search_configuration: allOf: - $ref: '#/components/schemas/WebSearchConfiguration' - description: |- - The project connections attached to this tool. There can be a maximum of 1 connection - resource attached to the tool. + description: Custom search configuration for domain-restricted web search. allOf: - $ref: '#/components/schemas/ToolboxTool' description: A web search tool stored in a toolbox. 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 0d1da30bf019..39df93b7c5a4 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 @@ -49017,6 +49017,14 @@ ], "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.", "default": "medium" + }, + "custom_search_configuration": { + "allOf": [ + { + "$ref": "#/components/schemas/WebSearchConfiguration" + } + ], + "description": "Custom search configuration for domain-restricted web search." } }, "allOf": [ @@ -54034,14 +54042,14 @@ "properties": { "project_connection_id": { "type": "string", - "description": "Project connection id for grounding with bing custom search" + "description": "Project connection ID for grounding with Bing custom search." }, "instance_name": { "type": "string", "description": "Name of the custom configuration instance given to config." } }, - "description": "A web search configuration for bing custom search" + "description": "A web search configuration for Bing custom search." }, "WebSearchToolbox": { "type": "object", @@ -54090,7 +54098,7 @@ "$ref": "#/components/schemas/WebSearchConfiguration" } ], - "description": "The project connections attached to this tool. There can be a maximum of 1 connection\nresource attached to the tool." + "description": "Custom search configuration for domain-restricted web search." } }, "allOf": [ 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 8d2dfc36a174..97865d6f79ad 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 @@ -34592,6 +34592,10 @@ components: - high 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. default: medium + custom_search_configuration: + allOf: + - $ref: '#/components/schemas/WebSearchConfiguration' + description: Custom search configuration for domain-restricted web search. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: |- @@ -37971,11 +37975,11 @@ components: properties: project_connection_id: type: string - description: Project connection id for grounding with bing custom search + description: Project connection ID for grounding with Bing custom search. instance_name: type: string description: Name of the custom configuration instance given to config. - description: A web search configuration for bing custom search + description: A web search configuration for Bing custom search. WebSearchToolbox: type: object required: @@ -38007,9 +38011,7 @@ components: custom_search_configuration: allOf: - $ref: '#/components/schemas/WebSearchConfiguration' - description: |- - The project connections attached to this tool. There can be a maximum of 1 connection - resource attached to the tool. + description: Custom search configuration for domain-restricted web search. allOf: - $ref: '#/components/schemas/ToolboxTool' description: A web search tool stored in a toolbox. 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 cde0a4816c19..16876b2e8ee7 100644 --- a/specification/ai-foundry/data-plane/Foundry/src/toolboxes/models.tsp +++ b/specification/ai-foundry/data-plane/Foundry/src/toolboxes/models.tsp @@ -27,21 +27,6 @@ model ToolConfig { additional_search_text?: string; } -/** - * A web search configuration for bing custom search - */ -model WebSearchConfiguration { - /** - * Project connection id for grounding with bing custom search - */ - project_connection_id: string; - - /** - * Name of the custom configuration instance given to config. - */ - instance_name: string; -} - /** * Optional tool configuration extension for controlling tool visibility and search behavior. */ 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 3440e834ed18..270b8cc9b92b 100644 --- a/specification/ai-foundry/data-plane/Foundry/src/tools/models.tsp +++ b/specification/ai-foundry/data-plane/Foundry/src/tools/models.tsp @@ -58,6 +58,31 @@ namespace Azure.AI.Projects { description?: string; }; + /** + * A web search configuration for Bing custom search. + */ + model WebSearchConfiguration { + /** + * Project connection ID for grounding with Bing custom search. + */ + project_connection_id: string; + + /** + * Name of the custom configuration instance given to config. + */ + instance_name: string; + } + + #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" + @@copyProperties(OpenAI.WebSearchTool, + { + /** + * Custom search configuration for domain-restricted web search. + */ + custom_search_configuration?: WebSearchConfiguration, + } + ); + /** * The input definition information for a bing grounding search tool as used to configure an agent. */ From 6e4db75a0839454e4514a76b49000d7a0fc79266 Mon Sep 17 00:00:00 2001 From: Vishwanath Balaji Date: Tue, 26 May 2026 18:10:46 -0700 Subject: [PATCH 04/12] Refine toolbox tool model composition Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../v1/microsoft-foundry-openapi3.json | 86 +++++--------- .../v1/microsoft-foundry-openapi3.yaml | 74 +++++------- .../microsoft-foundry-openapi3.json | 86 +++++--------- .../microsoft-foundry-openapi3.yaml | 74 +++++------- .../Foundry/src/toolboxes/models.tsp | 106 +++++++----------- 5 files changed, 147 insertions(+), 279 deletions(-) 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 29e165295246..3e47301d5a42 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 @@ -14979,7 +14979,7 @@ ], "description": "An agent implementing the A2A protocol." }, - "A2APreviewToolbox": { + "A2APreviewToolboxTool": { "type": "object", "required": [ "type" @@ -14992,14 +14992,6 @@ ], "description": "The type of the tool. Always `a2a_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." - }, "base_url": { "type": "string", "format": "uri", @@ -16904,7 +16896,7 @@ }, "description": "A set of index resources used by the `azure_ai_search` tool." }, - "AzureAISearchToolbox": { + "AzureAISearchToolboxTool": { "type": "object", "required": [ "type", @@ -16918,14 +16910,6 @@ ], "description": "The type of the tool. Always `azure_ai_search`." }, - "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." - }, "azure_ai_search": { "allOf": [ { @@ -18600,7 +18584,7 @@ ], "description": "How package dependencies are resolved at deployment time for a code-based hosted agent." }, - "CodeInterpreterToolbox": { + "CodeInterpreterToolboxTool": { "type": "object", "required": [ "type" @@ -22656,7 +22640,7 @@ ], "description": "A FabricIQ server-side tool." }, - "FabricIQPreviewToolbox": { + "FabricIQPreviewToolboxTool": { "type": "object", "required": [ "type", @@ -22701,14 +22685,6 @@ ], "description": "(Optional) Whether the agent requires approval before executing actions. Default is always.", "default": "always" - }, - "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." } }, "allOf": [ @@ -22819,7 +22795,7 @@ ], "description": "FileDatasetVersion Definition" }, - "FileSearchToolbox": { + "FileSearchToolboxTool": { "type": "object", "required": [ "type" @@ -22832,13 +22808,6 @@ ], "description": "The type of the tool. Always `file_search`." }, - "vector_store_ids": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The IDs of the vector stores to search." - }, "max_num_results": { "allOf": [ { @@ -22862,6 +22831,13 @@ } ], "nullable": true + }, + "vector_store_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of the vector stores to search." } }, "allOf": [ @@ -24036,7 +24012,7 @@ }, "description": "Adapter-specific metadata for LoRA models. Drives serving engine configuration at deployment time." }, - "MCPToolbox": { + "MCPToolboxTool": { "type": "object", "required": [ "type", @@ -45096,7 +45072,7 @@ ], "description": "The output of an OpenAPI tool call." }, - "OpenApiToolbox": { + "OpenApiToolboxTool": { "type": "object", "required": [ "type", @@ -48690,7 +48666,7 @@ }, "description": "Policy configuration for a toolbox, including content safety and other governance settings." }, - "ToolboxSearchPreviewToolbox": { + "ToolboxSearchPreviewToolboxTool": { "type": "object", "required": [ "type" @@ -48797,16 +48773,16 @@ "discriminator": { "propertyName": "type", "mapping": { - "code_interpreter": "#/components/schemas/CodeInterpreterToolbox", - "file_search": "#/components/schemas/FileSearchToolbox", - "web_search": "#/components/schemas/WebSearchToolbox", - "mcp": "#/components/schemas/MCPToolbox", - "azure_ai_search": "#/components/schemas/AzureAISearchToolbox", - "openapi": "#/components/schemas/OpenApiToolbox", - "a2a_preview": "#/components/schemas/A2APreviewToolbox", - "work_iq_preview": "#/components/schemas/WorkIQPreviewToolbox", - "fabric_iq_preview": "#/components/schemas/FabricIQPreviewToolbox", - "toolbox_search_preview": "#/components/schemas/ToolboxSearchPreviewToolbox" + "code_interpreter": "#/components/schemas/CodeInterpreterToolboxTool", + "file_search": "#/components/schemas/FileSearchToolboxTool", + "web_search": "#/components/schemas/WebSearchToolboxTool", + "mcp": "#/components/schemas/MCPToolboxTool", + "azure_ai_search": "#/components/schemas/AzureAISearchToolboxTool", + "openapi": "#/components/schemas/OpenApiToolboxTool", + "a2a_preview": "#/components/schemas/A2APreviewToolboxTool", + "work_iq_preview": "#/components/schemas/WorkIQPreviewToolboxTool", + "fabric_iq_preview": "#/components/schemas/FabricIQPreviewToolboxTool", + "toolbox_search_preview": "#/components/schemas/ToolboxSearchPreviewToolboxTool" } }, "description": "An abstract representation of a tool stored in a toolbox." @@ -49558,7 +49534,7 @@ }, "description": "A web search configuration for Bing custom search." }, - "WebSearchToolbox": { + "WebSearchToolboxTool": { "type": "object", "required": [ "type" @@ -49678,7 +49654,7 @@ ], "description": "A WorkIQ server-side tool." }, - "WorkIQPreviewToolbox": { + "WorkIQPreviewToolboxTool": { "type": "object", "required": [ "type", @@ -49695,14 +49671,6 @@ "project_connection_id": { "type": "string", "description": "The ID of the WorkIQ project connection." - }, - "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." } }, "allOf": [ 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 d3c8c5210638..1679072e875f 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 @@ -9972,7 +9972,7 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: An agent implementing the A2A protocol. - A2APreviewToolbox: + A2APreviewToolboxTool: type: object required: - type @@ -9982,12 +9982,6 @@ components: enum: - a2a_preview description: The type of the tool. Always `a2a_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. base_url: type: string format: uri @@ -11244,7 +11238,7 @@ components: The indices attached to this agent. There can be a maximum of 1 index resource attached to the agent. description: A set of index resources used by the `azure_ai_search` tool. - AzureAISearchToolbox: + AzureAISearchToolboxTool: type: object required: - type @@ -11255,12 +11249,6 @@ components: enum: - azure_ai_search description: The type of the tool. Always `azure_ai_search`. - 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. azure_ai_search: allOf: - $ref: '#/components/schemas/AzureAISearchToolResource' @@ -12377,7 +12365,7 @@ components: - bundled - remote_build description: How package dependencies are resolved at deployment time for a code-based hosted agent. - CodeInterpreterToolbox: + CodeInterpreterToolboxTool: type: object required: - type @@ -15384,7 +15372,7 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A FabricIQ server-side tool. - FabricIQPreviewToolbox: + FabricIQPreviewToolboxTool: type: object required: - type @@ -15415,12 +15403,6 @@ components: nullable: true description: (Optional) Whether the agent requires approval before executing actions. Default is always. default: always - 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. allOf: - $ref: '#/components/schemas/ToolboxTool' description: A FabricIQ tool stored in a toolbox. @@ -15490,7 +15472,7 @@ components: allOf: - $ref: '#/components/schemas/DatasetVersionUpdate' description: FileDatasetVersion Definition - FileSearchToolbox: + FileSearchToolboxTool: type: object required: - type @@ -15500,11 +15482,6 @@ components: enum: - file_search description: The type of the tool. Always `file_search`. - vector_store_ids: - type: array - items: - type: string - description: The IDs of the vector stores to search. max_num_results: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -15517,6 +15494,11 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.Filters' nullable: true + vector_store_ids: + type: array + items: + type: string + description: The IDs of the vector stores to search. allOf: - $ref: '#/components/schemas/ToolboxTool' description: A file search tool stored in a toolbox. @@ -16279,7 +16261,7 @@ components: format: float description: Dropout rate used during training. Informational — not used at serving time. description: Adapter-specific metadata for LoRA models. Drives serving engine configuration at deployment time. - MCPToolbox: + MCPToolboxTool: type: object required: - type @@ -31912,7 +31894,7 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: The output of an OpenAPI tool call. - OpenApiToolbox: + OpenApiToolboxTool: type: object required: - type @@ -34330,7 +34312,7 @@ components: - $ref: '#/components/schemas/RaiConfig' description: Responsible AI content filtering configuration. description: Policy configuration for a toolbox, including content safety and other governance settings. - ToolboxSearchPreviewToolbox: + ToolboxSearchPreviewToolboxTool: type: object required: - type @@ -34403,16 +34385,16 @@ components: discriminator: propertyName: type mapping: - code_interpreter: '#/components/schemas/CodeInterpreterToolbox' - file_search: '#/components/schemas/FileSearchToolbox' - web_search: '#/components/schemas/WebSearchToolbox' - mcp: '#/components/schemas/MCPToolbox' - azure_ai_search: '#/components/schemas/AzureAISearchToolbox' - openapi: '#/components/schemas/OpenApiToolbox' - a2a_preview: '#/components/schemas/A2APreviewToolbox' - work_iq_preview: '#/components/schemas/WorkIQPreviewToolbox' - fabric_iq_preview: '#/components/schemas/FabricIQPreviewToolbox' - toolbox_search_preview: '#/components/schemas/ToolboxSearchPreviewToolbox' + code_interpreter: '#/components/schemas/CodeInterpreterToolboxTool' + file_search: '#/components/schemas/FileSearchToolboxTool' + web_search: '#/components/schemas/WebSearchToolboxTool' + mcp: '#/components/schemas/MCPToolboxTool' + azure_ai_search: '#/components/schemas/AzureAISearchToolboxTool' + openapi: '#/components/schemas/OpenApiToolboxTool' + a2a_preview: '#/components/schemas/A2APreviewToolboxTool' + work_iq_preview: '#/components/schemas/WorkIQPreviewToolboxTool' + fabric_iq_preview: '#/components/schemas/FabricIQPreviewToolboxTool' + toolbox_search_preview: '#/components/schemas/ToolboxSearchPreviewToolboxTool' description: An abstract representation of a tool stored in a toolbox. ToolboxToolType: type: string @@ -34924,7 +34906,7 @@ components: type: string description: Name of the custom configuration instance given to config. description: A web search configuration for Bing custom search. - WebSearchToolbox: + WebSearchToolboxTool: type: object required: - type @@ -35001,7 +34983,7 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A WorkIQ server-side tool. - WorkIQPreviewToolbox: + WorkIQPreviewToolboxTool: type: object required: - type @@ -35015,12 +34997,6 @@ components: project_connection_id: type: string description: The ID of the WorkIQ project connection. - 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. allOf: - $ref: '#/components/schemas/ToolboxTool' description: A WorkIQ tool stored in a toolbox. 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 39df93b7c5a4..fb37c2fbbe76 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 @@ -17556,7 +17556,7 @@ ], "description": "An agent implementing the A2A protocol." }, - "A2APreviewToolbox": { + "A2APreviewToolboxTool": { "type": "object", "required": [ "type" @@ -17569,14 +17569,6 @@ ], "description": "The type of the tool. Always `a2a_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." - }, "base_url": { "type": "string", "format": "uri", @@ -19943,7 +19935,7 @@ }, "description": "A set of index resources used by the `azure_ai_search` tool." }, - "AzureAISearchToolbox": { + "AzureAISearchToolboxTool": { "type": "object", "required": [ "type", @@ -19957,14 +19949,6 @@ ], "description": "The type of the tool. Always `azure_ai_search`." }, - "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." - }, "azure_ai_search": { "allOf": [ { @@ -21639,7 +21623,7 @@ ], "description": "How package dependencies are resolved at deployment time for a code-based hosted agent." }, - "CodeInterpreterToolbox": { + "CodeInterpreterToolboxTool": { "type": "object", "required": [ "type" @@ -26752,7 +26736,7 @@ ], "description": "A FabricIQ server-side tool." }, - "FabricIQPreviewToolbox": { + "FabricIQPreviewToolboxTool": { "type": "object", "required": [ "type", @@ -26797,14 +26781,6 @@ ], "description": "(Optional) Whether the agent requires approval before executing actions. Default is always.", "default": "always" - }, - "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." } }, "allOf": [ @@ -26915,7 +26891,7 @@ ], "description": "FileDatasetVersion Definition" }, - "FileSearchToolbox": { + "FileSearchToolboxTool": { "type": "object", "required": [ "type" @@ -26928,13 +26904,6 @@ ], "description": "The type of the tool. Always `file_search`." }, - "vector_store_ids": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The IDs of the vector stores to search." - }, "max_num_results": { "allOf": [ { @@ -26958,6 +26927,13 @@ } ], "nullable": true + }, + "vector_store_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of the vector stores to search." } }, "allOf": [ @@ -28205,7 +28181,7 @@ }, "description": "Adapter-specific metadata for LoRA models. Drives serving engine configuration at deployment time." }, - "MCPToolbox": { + "MCPToolboxTool": { "type": "object", "required": [ "type", @@ -49390,7 +49366,7 @@ ], "description": "The output of an OpenAPI tool call." }, - "OpenApiToolbox": { + "OpenApiToolboxTool": { "type": "object", "required": [ "type", @@ -53103,7 +53079,7 @@ }, "description": "Policy configuration for a toolbox, including content safety and other governance settings." }, - "ToolboxSearchPreviewToolbox": { + "ToolboxSearchPreviewToolboxTool": { "type": "object", "required": [ "type" @@ -53210,16 +53186,16 @@ "discriminator": { "propertyName": "type", "mapping": { - "code_interpreter": "#/components/schemas/CodeInterpreterToolbox", - "file_search": "#/components/schemas/FileSearchToolbox", - "web_search": "#/components/schemas/WebSearchToolbox", - "mcp": "#/components/schemas/MCPToolbox", - "azure_ai_search": "#/components/schemas/AzureAISearchToolbox", - "openapi": "#/components/schemas/OpenApiToolbox", - "a2a_preview": "#/components/schemas/A2APreviewToolbox", - "work_iq_preview": "#/components/schemas/WorkIQPreviewToolbox", - "fabric_iq_preview": "#/components/schemas/FabricIQPreviewToolbox", - "toolbox_search_preview": "#/components/schemas/ToolboxSearchPreviewToolbox" + "code_interpreter": "#/components/schemas/CodeInterpreterToolboxTool", + "file_search": "#/components/schemas/FileSearchToolboxTool", + "web_search": "#/components/schemas/WebSearchToolboxTool", + "mcp": "#/components/schemas/MCPToolboxTool", + "azure_ai_search": "#/components/schemas/AzureAISearchToolboxTool", + "openapi": "#/components/schemas/OpenApiToolboxTool", + "a2a_preview": "#/components/schemas/A2APreviewToolboxTool", + "work_iq_preview": "#/components/schemas/WorkIQPreviewToolboxTool", + "fabric_iq_preview": "#/components/schemas/FabricIQPreviewToolboxTool", + "toolbox_search_preview": "#/components/schemas/ToolboxSearchPreviewToolboxTool" } }, "description": "An abstract representation of a tool stored in a toolbox." @@ -54051,7 +54027,7 @@ }, "description": "A web search configuration for Bing custom search." }, - "WebSearchToolbox": { + "WebSearchToolboxTool": { "type": "object", "required": [ "type" @@ -54171,7 +54147,7 @@ ], "description": "A WorkIQ server-side tool." }, - "WorkIQPreviewToolbox": { + "WorkIQPreviewToolboxTool": { "type": "object", "required": [ "type", @@ -54188,14 +54164,6 @@ "project_connection_id": { "type": "string", "description": "The ID of the WorkIQ project connection." - }, - "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." } }, "allOf": [ 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 97865d6f79ad..adfc3db7ce9b 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 @@ -11706,7 +11706,7 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: An agent implementing the A2A protocol. - A2APreviewToolbox: + A2APreviewToolboxTool: type: object required: - type @@ -11716,12 +11716,6 @@ components: enum: - a2a_preview description: The type of the tool. Always `a2a_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. base_url: type: string format: uri @@ -13300,7 +13294,7 @@ components: The indices attached to this agent. There can be a maximum of 1 index resource attached to the agent. description: A set of index resources used by the `azure_ai_search` tool. - AzureAISearchToolbox: + AzureAISearchToolboxTool: type: object required: - type @@ -13311,12 +13305,6 @@ components: enum: - azure_ai_search description: The type of the tool. Always `azure_ai_search`. - 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. azure_ai_search: allOf: - $ref: '#/components/schemas/AzureAISearchToolResource' @@ -14433,7 +14421,7 @@ components: - bundled - remote_build description: How package dependencies are resolved at deployment time for a code-based hosted agent. - CodeInterpreterToolbox: + CodeInterpreterToolboxTool: type: object required: - type @@ -18171,7 +18159,7 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A FabricIQ server-side tool. - FabricIQPreviewToolbox: + FabricIQPreviewToolboxTool: type: object required: - type @@ -18202,12 +18190,6 @@ components: nullable: true description: (Optional) Whether the agent requires approval before executing actions. Default is always. default: always - 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. allOf: - $ref: '#/components/schemas/ToolboxTool' description: A FabricIQ tool stored in a toolbox. @@ -18277,7 +18259,7 @@ components: allOf: - $ref: '#/components/schemas/DatasetVersionUpdate' description: FileDatasetVersion Definition - FileSearchToolbox: + FileSearchToolboxTool: type: object required: - type @@ -18287,11 +18269,6 @@ components: enum: - file_search description: The type of the tool. Always `file_search`. - vector_store_ids: - type: array - items: - type: string - description: The IDs of the vector stores to search. max_num_results: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -18304,6 +18281,11 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.Filters' nullable: true + vector_store_ids: + type: array + items: + type: string + description: The IDs of the vector stores to search. allOf: - $ref: '#/components/schemas/ToolboxTool' description: A file search tool stored in a toolbox. @@ -19112,7 +19094,7 @@ components: format: float description: Dropout rate used during training. Informational — not used at serving time. description: Adapter-specific metadata for LoRA models. Drives serving engine configuration at deployment time. - MCPToolbox: + MCPToolboxTool: type: object required: - type @@ -34835,7 +34817,7 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: The output of an OpenAPI tool call. - OpenApiToolbox: + OpenApiToolboxTool: type: object required: - type @@ -37335,7 +37317,7 @@ components: - $ref: '#/components/schemas/RaiConfig' description: Responsible AI content filtering configuration. description: Policy configuration for a toolbox, including content safety and other governance settings. - ToolboxSearchPreviewToolbox: + ToolboxSearchPreviewToolboxTool: type: object required: - type @@ -37408,16 +37390,16 @@ components: discriminator: propertyName: type mapping: - code_interpreter: '#/components/schemas/CodeInterpreterToolbox' - file_search: '#/components/schemas/FileSearchToolbox' - web_search: '#/components/schemas/WebSearchToolbox' - mcp: '#/components/schemas/MCPToolbox' - azure_ai_search: '#/components/schemas/AzureAISearchToolbox' - openapi: '#/components/schemas/OpenApiToolbox' - a2a_preview: '#/components/schemas/A2APreviewToolbox' - work_iq_preview: '#/components/schemas/WorkIQPreviewToolbox' - fabric_iq_preview: '#/components/schemas/FabricIQPreviewToolbox' - toolbox_search_preview: '#/components/schemas/ToolboxSearchPreviewToolbox' + code_interpreter: '#/components/schemas/CodeInterpreterToolboxTool' + file_search: '#/components/schemas/FileSearchToolboxTool' + web_search: '#/components/schemas/WebSearchToolboxTool' + mcp: '#/components/schemas/MCPToolboxTool' + azure_ai_search: '#/components/schemas/AzureAISearchToolboxTool' + openapi: '#/components/schemas/OpenApiToolboxTool' + a2a_preview: '#/components/schemas/A2APreviewToolboxTool' + work_iq_preview: '#/components/schemas/WorkIQPreviewToolboxTool' + fabric_iq_preview: '#/components/schemas/FabricIQPreviewToolboxTool' + toolbox_search_preview: '#/components/schemas/ToolboxSearchPreviewToolboxTool' description: An abstract representation of a tool stored in a toolbox. ToolboxToolType: type: string @@ -37980,7 +37962,7 @@ components: type: string description: Name of the custom configuration instance given to config. description: A web search configuration for Bing custom search. - WebSearchToolbox: + WebSearchToolboxTool: type: object required: - type @@ -38057,7 +38039,7 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A WorkIQ server-side tool. - WorkIQPreviewToolbox: + WorkIQPreviewToolboxTool: type: object required: - type @@ -38071,12 +38053,6 @@ components: project_connection_id: type: string description: The ID of the WorkIQ project connection. - 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. allOf: - $ref: '#/components/schemas/ToolboxTool' description: A WorkIQ tool stored in a toolbox. 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 16876b2e8ee7..12d2d01228f0 100644 --- a/specification/ai-foundry/data-plane/Foundry/src/toolboxes/models.tsp +++ b/specification/ai-foundry/data-plane/Foundry/src/toolboxes/models.tsp @@ -5,7 +5,6 @@ import "../skills/models.tsp"; using TypeSpec.Http; using TypeSpec.OpenAPI; -using Azure.Core.Experimental; namespace Azure.AI.Projects; @@ -39,6 +38,14 @@ alias ToolConfigExtension = { tool_configs?: Record; }; +/** + * Spreads `Source`, changing the selected properties to optional. + */ +model WithFieldsOptional { + ...OmitProperties; + ...PickProperties, Keys>; +} + /** * Supported tool types for tools stored in a toolbox. */ @@ -72,156 +79,129 @@ model ToolboxTool { /** * A code interpreter tool stored in a toolbox. */ -model CodeInterpreterToolbox extends ToolboxTool { +model CodeInterpreterToolboxTool extends ToolboxTool { /** * The type of the tool. Always `code_interpreter`. */ type: "code_interpreter"; + + ...OmitProperties; } /** * A file search tool stored in a toolbox. */ -model FileSearchToolbox extends ToolboxTool { +model FileSearchToolboxTool extends ToolboxTool { /** * The type of the tool. Always `file_search`. */ type: "file_search"; - /** - * The IDs of the vector stores to search. - */ - vector_store_ids?: string[]; + ...WithFieldsOptional< + OmitProperties, + "vector_store_ids" + >; } /** * A web search tool stored in a toolbox. */ -model WebSearchToolbox extends ToolboxTool { +model WebSearchToolboxTool extends ToolboxTool { /** * The type of the tool. Always `web_search`. */ type: "web_search"; + + ...OmitProperties; } /** * An MCP tool stored in a toolbox. */ -model MCPToolbox extends ToolboxTool { +model MCPToolboxTool extends ToolboxTool { /** * The type of the tool. Always `mcp`. */ type: "mcp"; + + ...OmitProperties; + + /** + * 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. + */ + project_connection_id?: string; } /** * An Azure AI Search tool stored in a toolbox. */ -model AzureAISearchToolbox extends ToolboxTool { +model AzureAISearchToolboxTool extends ToolboxTool { /** * The type of the tool. Always `azure_ai_search`. */ type: "azure_ai_search"; + + ...OmitProperties; } /** * An OpenAPI tool stored in a toolbox. */ -model OpenApiToolbox extends ToolboxTool { +model OpenApiToolboxTool extends ToolboxTool { /** * The type of the tool. Always `openapi`. */ type: "openapi"; + + ...OmitProperties; } /** * An A2A tool stored in a toolbox. */ -model A2APreviewToolbox extends ToolboxTool { +model A2APreviewToolboxTool extends ToolboxTool { /** * The type of the tool. Always `a2a_preview`. */ type: "a2a_preview"; + + ...OmitProperties; } /** * A WorkIQ tool stored in a toolbox. */ -model WorkIQPreviewToolbox extends ToolboxTool { +model WorkIQPreviewToolboxTool extends ToolboxTool { /** * The type of the tool. Always `work_iq_preview`. */ type: "work_iq_preview"; + + ...OmitProperties; } /** * A FabricIQ tool stored in a toolbox. */ -model FabricIQPreviewToolbox extends ToolboxTool { +model FabricIQPreviewToolboxTool extends ToolboxTool { /** * The type of the tool. Always `fabric_iq_preview`. */ type: "fabric_iq_preview"; + + ...OmitProperties; } /** * A toolbox search tool stored in a toolbox. */ -model ToolboxSearchPreviewToolbox extends ToolboxTool { +model ToolboxSearchPreviewToolboxTool extends ToolboxTool { /** * The type of the tool. Always `toolbox_search_preview`. */ type: "toolbox_search_preview"; } -#suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" -@@copyProperties(CodeInterpreterToolbox, OpenAI.CodeInterpreterTool); - -#suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" -@@copyProperties(FileSearchToolbox, OpenAI.FileSearchTool); - -#suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" -@@copyProperties(WebSearchToolbox, OpenAI.WebSearchTool); - -#suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" -@@copyProperties(WebSearchToolbox, - { - /** - * The project connections attached to this tool. There can be a maximum of 1 connection - * resource attached to the tool. - */ - custom_search_configuration?: WebSearchConfiguration, - } -); - -#suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" -@@copyProperties(MCPToolbox, OpenAI.MCPTool); - -#suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" -@@copyProperties(MCPToolbox, - { - /** - * 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. - */ - project_connection_id?: string, - } -); - -#suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" -@@copyProperties(AzureAISearchToolbox, AzureAISearchTool); - -#suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" -@@copyProperties(OpenApiToolbox, OpenApiTool); - -#suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" -@@copyProperties(A2APreviewToolbox, A2APreviewTool); - -#suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" -@@copyProperties(WorkIQPreviewToolbox, WorkIQPreviewTool); - -#suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" -@@copyProperties(FabricIQPreviewToolbox, FabricIQPreviewTool); - @doc("Policy configuration for a toolbox, including content safety and other governance settings.") model ToolboxPolicies { @doc("Responsible AI content filtering configuration.") From e1f3ff118e6cb3b36de2f82e9c24afea8a4e932a Mon Sep 17 00:00:00 2001 From: Vishwanath Balaji Date: Tue, 26 May 2026 19:43:32 -0700 Subject: [PATCH 05/12] Refine toolbox tool schema decoupling Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../v1/microsoft-foundry-openapi3.json | 60 +++++- .../v1/microsoft-foundry-openapi3.yaml | 51 ++++- .../microsoft-foundry-openapi3.json | 60 +++++- .../microsoft-foundry-openapi3.yaml | 51 ++++- .../Foundry/src/toolboxes/models.tsp | 33 ++-- .../data-plane/Foundry/src/tools/models.tsp | 182 +++++++++++++----- 6 files changed, 356 insertions(+), 81 deletions(-) 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 3e47301d5a42..bc41999eab32 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 @@ -26044,6 +26044,14 @@ "description": "The type of the code interpreter tool. Always `code_interpreter`.", "x-stainless-const": true }, + "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." + }, "container": { "anyOf": [ { @@ -30376,6 +30384,14 @@ } ], "nullable": true + }, + "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." } }, "allOf": [ @@ -31802,6 +31818,14 @@ } ], "nullable": true + }, + "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." } }, "allOf": [ @@ -32486,6 +32510,14 @@ } ], "description": "Whether to generate a new image or edit an existing image. Default: `auto`." + }, + "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." } }, "allOf": [ @@ -38230,6 +38262,14 @@ "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." + }, + "description": { + "type": "string", + "description": "Optional user-defined description for this tool or configuration." } }, "allOf": [ @@ -38429,6 +38469,10 @@ } ], "default": "always" + }, + "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." } }, "allOf": [ @@ -44700,13 +44744,21 @@ "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.", "default": "medium" }, + "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." + }, "custom_search_configuration": { "allOf": [ { "$ref": "#/components/schemas/WebSearchConfiguration" } ], - "description": "Custom search configuration for domain-restricted web search." + "description": "The project connections attached to this tool. There can be a maximum of 1 connection\nresource attached to the tool." } }, "allOf": [ @@ -49525,14 +49577,14 @@ "properties": { "project_connection_id": { "type": "string", - "description": "Project connection ID for grounding with Bing custom search." + "description": "Project connection id for grounding with bing custom search" }, "instance_name": { "type": "string", "description": "Name of the custom configuration instance given to config." } }, - "description": "A web search configuration for Bing custom search." + "description": "A web search configuration for bing custom search" }, "WebSearchToolboxTool": { "type": "object", @@ -49581,7 +49633,7 @@ "$ref": "#/components/schemas/WebSearchConfiguration" } ], - "description": "Custom search configuration for domain-restricted web search." + "description": "The project connections attached to this tool. There can be a maximum of 1 connection\nresource attached to the tool." } }, "allOf": [ 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 1679072e875f..98e7e5c1145a 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 @@ -17653,6 +17653,12 @@ components: - code_interpreter description: The type of the code interpreter tool. Always `code_interpreter`. x-stainless-const: true + 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. container: anyOf: - type: string @@ -20719,6 +20725,12 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.Filters' nullable: true + 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. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A tool that searches for relevant content from uploaded files. Learn more about the [file search tool](https://platform.openai.com/docs/guides/tools-file-search). @@ -21704,6 +21716,12 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellToolParamEnvironment' nullable: true + 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. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A tool that allows the model to execute shell commands. @@ -22321,6 +22339,12 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.ImageGenActionEnum' description: 'Whether to generate a new image or edit an existing image. Default: `auto`.' + 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. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A tool that generates images using the GPT image models. @@ -26499,6 +26523,12 @@ components: 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. + description: + type: string + description: Optional user-defined description for this tool or configuration. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A tool that allows the model to execute shell commands in a local environment. @@ -26649,6 +26679,9 @@ components: - never nullable: true default: always + 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. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: |- @@ -31651,10 +31684,18 @@ components: - high 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. default: medium + 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. custom_search_configuration: allOf: - $ref: '#/components/schemas/WebSearchConfiguration' - description: Custom search configuration for domain-restricted web search. + description: |- + The project connections attached to this tool. There can be a maximum of 1 connection + resource attached to the tool. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: |- @@ -34901,11 +34942,11 @@ components: properties: project_connection_id: type: string - description: Project connection ID for grounding with Bing custom search. + description: Project connection id for grounding with bing custom search instance_name: type: string description: Name of the custom configuration instance given to config. - description: A web search configuration for Bing custom search. + description: A web search configuration for bing custom search WebSearchToolboxTool: type: object required: @@ -34937,7 +34978,9 @@ components: custom_search_configuration: allOf: - $ref: '#/components/schemas/WebSearchConfiguration' - description: Custom search configuration for domain-restricted web search. + description: |- + The project connections attached to this tool. There can be a maximum of 1 connection + resource attached to the tool. allOf: - $ref: '#/components/schemas/ToolboxTool' description: A web search tool stored in a toolbox. 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 fb37c2fbbe76..c05dc961e03d 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 @@ -30313,6 +30313,14 @@ "description": "The type of the code interpreter tool. Always `code_interpreter`.", "x-stainless-const": true }, + "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." + }, "container": { "anyOf": [ { @@ -34645,6 +34653,14 @@ } ], "nullable": true + }, + "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." } }, "allOf": [ @@ -36071,6 +36087,14 @@ } ], "nullable": true + }, + "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." } }, "allOf": [ @@ -36755,6 +36779,14 @@ } ], "description": "Whether to generate a new image or edit an existing image. Default: `auto`." + }, + "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." } }, "allOf": [ @@ -42499,6 +42531,14 @@ "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." + }, + "description": { + "type": "string", + "description": "Optional user-defined description for this tool or configuration." } }, "allOf": [ @@ -42698,6 +42738,10 @@ } ], "default": "always" + }, + "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." } }, "allOf": [ @@ -48994,13 +49038,21 @@ "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.", "default": "medium" }, + "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." + }, "custom_search_configuration": { "allOf": [ { "$ref": "#/components/schemas/WebSearchConfiguration" } ], - "description": "Custom search configuration for domain-restricted web search." + "description": "The project connections attached to this tool. There can be a maximum of 1 connection\nresource attached to the tool." } }, "allOf": [ @@ -54018,14 +54070,14 @@ "properties": { "project_connection_id": { "type": "string", - "description": "Project connection ID for grounding with Bing custom search." + "description": "Project connection id for grounding with bing custom search" }, "instance_name": { "type": "string", "description": "Name of the custom configuration instance given to config." } }, - "description": "A web search configuration for Bing custom search." + "description": "A web search configuration for bing custom search" }, "WebSearchToolboxTool": { "type": "object", @@ -54074,7 +54126,7 @@ "$ref": "#/components/schemas/WebSearchConfiguration" } ], - "description": "Custom search configuration for domain-restricted web search." + "description": "The project connections attached to this tool. There can be a maximum of 1 connection\nresource attached to the tool." } }, "allOf": [ 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 adfc3db7ce9b..91171d8bb33b 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 @@ -20556,6 +20556,12 @@ components: - code_interpreter description: The type of the code interpreter tool. Always `code_interpreter`. x-stainless-const: true + 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. container: anyOf: - type: string @@ -23622,6 +23628,12 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.Filters' nullable: true + 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. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A tool that searches for relevant content from uploaded files. Learn more about the [file search tool](https://platform.openai.com/docs/guides/tools-file-search). @@ -24607,6 +24619,12 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellToolParamEnvironment' nullable: true + 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. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A tool that allows the model to execute shell commands. @@ -25224,6 +25242,12 @@ components: allOf: - $ref: '#/components/schemas/OpenAI.ImageGenActionEnum' description: 'Whether to generate a new image or edit an existing image. Default: `auto`.' + 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. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A tool that generates images using the GPT image models. @@ -29402,6 +29426,12 @@ components: 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. + description: + type: string + description: Optional user-defined description for this tool or configuration. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: A tool that allows the model to execute shell commands in a local environment. @@ -29552,6 +29582,9 @@ components: - never nullable: true default: always + 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. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: |- @@ -34574,10 +34607,18 @@ components: - high 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. default: medium + 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. custom_search_configuration: allOf: - $ref: '#/components/schemas/WebSearchConfiguration' - description: Custom search configuration for domain-restricted web search. + description: |- + The project connections attached to this tool. There can be a maximum of 1 connection + resource attached to the tool. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: |- @@ -37957,11 +37998,11 @@ components: properties: project_connection_id: type: string - description: Project connection ID for grounding with Bing custom search. + description: Project connection id for grounding with bing custom search instance_name: type: string description: Name of the custom configuration instance given to config. - description: A web search configuration for Bing custom search. + description: A web search configuration for bing custom search WebSearchToolboxTool: type: object required: @@ -37993,7 +38034,9 @@ components: custom_search_configuration: allOf: - $ref: '#/components/schemas/WebSearchConfiguration' - description: Custom search configuration for domain-restricted web search. + description: |- + The project connections attached to this tool. There can be a maximum of 1 connection + resource attached to the tool. allOf: - $ref: '#/components/schemas/ToolboxTool' description: A web search tool stored in a toolbox. 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 12d2d01228f0..4f80ad086147 100644 --- a/specification/ai-foundry/data-plane/Foundry/src/toolboxes/models.tsp +++ b/specification/ai-foundry/data-plane/Foundry/src/toolboxes/models.tsp @@ -46,6 +46,13 @@ model WithFieldsOptional { ...PickProperties, Keys>; } +/** + * Spreads tool-specific fields from `Source`, excluding fields owned by `ToolboxTool`. + */ +model ToolFields { + ...OmitProperties; +} + /** * Supported tool types for tools stored in a toolbox. */ @@ -85,7 +92,7 @@ model CodeInterpreterToolboxTool extends ToolboxTool { */ type: "code_interpreter"; - ...OmitProperties; + ...ToolFields; } /** @@ -97,10 +104,7 @@ model FileSearchToolboxTool extends ToolboxTool { */ type: "file_search"; - ...WithFieldsOptional< - OmitProperties, - "vector_store_ids" - >; + ...WithFieldsOptional, "vector_store_ids">; } /** @@ -112,7 +116,7 @@ model WebSearchToolboxTool extends ToolboxTool { */ type: "web_search"; - ...OmitProperties; + ...ToolFields; } /** @@ -124,12 +128,7 @@ model MCPToolboxTool extends ToolboxTool { */ type: "mcp"; - ...OmitProperties; - - /** - * 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. - */ - project_connection_id?: string; + ...ToolFields; } /** @@ -141,7 +140,7 @@ model AzureAISearchToolboxTool extends ToolboxTool { */ type: "azure_ai_search"; - ...OmitProperties; + ...AzureAISearchToolFields; } /** @@ -153,7 +152,7 @@ model OpenApiToolboxTool extends ToolboxTool { */ type: "openapi"; - ...OmitProperties; + ...OpenApiToolFields; } /** @@ -165,7 +164,7 @@ model A2APreviewToolboxTool extends ToolboxTool { */ type: "a2a_preview"; - ...OmitProperties; + ...A2APreviewToolFields; } /** @@ -177,7 +176,7 @@ model WorkIQPreviewToolboxTool extends ToolboxTool { */ type: "work_iq_preview"; - ...OmitProperties; + ...WorkIQPreviewToolFields; } /** @@ -189,7 +188,7 @@ model FabricIQPreviewToolboxTool extends ToolboxTool { */ type: "fabric_iq_preview"; - ...OmitProperties; + ...FabricIQPreviewToolFields; } /** 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 270b8cc9b92b..60f54420b8ac 100644 --- a/specification/ai-foundry/data-plane/Foundry/src/tools/models.tsp +++ b/specification/ai-foundry/data-plane/Foundry/src/tools/models.tsp @@ -43,6 +43,76 @@ namespace Azure.AI.Projects { #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" @@copyVariants(OpenAI.IncludeEnum, Azure.AI.Projects._AgentIncludable); + #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" + @@copyProperties(OpenAI.MCPTool, + { + ...ToolProjectConnectionIdExtension, + } + ); + + #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" + @@copyProperties(OpenAI.WebSearchTool, + { + ...ToolNameAndDescriptionExtension, + + /** + * The project connections attached to this tool. There can be a maximum of 1 connection + * resource attached to the tool. + */ + custom_search_configuration?: WebSearchConfiguration, + } + ); + + #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" + @@copyProperties(OpenAI.CodeInterpreterTool, + { + ...ToolNameAndDescriptionExtension, + } + ); + + #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" + @@copyProperties(OpenAI.ImageGenTool, + { + ...ToolNameAndDescriptionExtension, + } + ); + + #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" + @@copyProperties(OpenAI.LocalShellToolParam, + { + ...ToolNameAndDescriptionExtension, + } + ); + + #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" + @@copyProperties(OpenAI.FunctionShellToolParam, + { + ...ToolNameAndDescriptionExtension, + } + ); + + #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" + @@copyProperties(OpenAI.FileSearchTool, + { + ...ToolNameAndDescriptionExtension, + } + ); + + /** + * A web search configuration for bing custom search + */ + model WebSearchConfiguration { + /** + * Project connection id for grounding with bing custom search + */ + project_connection_id: string; + + /** + * Name of the custom configuration instance given to config. + */ + instance_name: string; + } + /** * Optional name and description fields for tool definitions and nested tool configurations. */ @@ -59,29 +129,14 @@ namespace Azure.AI.Projects { }; /** - * A web search configuration for Bing custom search. + * Optional project connection ID for tools that can use project-scoped connections. */ - model WebSearchConfiguration { + alias ToolProjectConnectionIdExtension = { /** - * Project connection ID for grounding with Bing custom search. + * 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. */ - project_connection_id: string; - - /** - * Name of the custom configuration instance given to config. - */ - instance_name: string; - } - - #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" - @@copyProperties(OpenAI.WebSearchTool, - { - /** - * Custom search configuration for domain-restricted web search. - */ - custom_search_configuration?: WebSearchConfiguration, - } - ); + project_connection_id?: string; + }; /** * The input definition information for a bing grounding search tool as used to configure an agent. @@ -158,6 +213,16 @@ namespace Azure.AI.Projects { sharepoint_grounding_preview: SharepointGroundingToolParameters; } + /** + * Shared fields for Azure AI Search tool definitions. + */ + model AzureAISearchToolFields { + /** + * The azure ai search index resource. + */ + azure_ai_search: AzureAISearchToolResource; + } + /** * The input definition information for an Azure AI search tool as used to configure an agent. */ @@ -168,11 +233,7 @@ namespace Azure.AI.Projects { type: "azure_ai_search"; ...ToolNameAndDescriptionExtension; - - /** - * The azure ai search index resource. - */ - azure_ai_search: AzureAISearchToolResource; + ...AzureAISearchToolFields; } /** @@ -249,6 +310,16 @@ namespace Azure.AI.Projects { vector_semantic_hybrid: "vector_semantic_hybrid", } + /** + * Shared fields for OpenAPI tool definitions. + */ + model OpenApiToolFields { + /** + * The openapi function definition. + */ + openapi: OpenApiFunctionDefinition; + } + /** * The input definition information for an OpenAPI tool as used to configure an agent. */ @@ -258,10 +329,7 @@ namespace Azure.AI.Projects { */ type: "openapi"; - /** - * The openapi function definition. - */ - openapi: OpenApiFunctionDefinition; + ...OpenApiToolFields; } /** @@ -689,16 +757,9 @@ namespace Azure.AI.Projects { } /** - * An agent implementing the A2A protocol. + * Shared fields for A2A tool definitions. */ - model A2APreviewTool extends OpenAI.Tool { - /** - * The type of the tool. Always `"a2a_preview`. - */ - type: "a2a_preview"; - - ...ToolNameAndDescriptionExtension; - + model A2APreviewToolFields { /** * Base URL of the agent. */ @@ -718,31 +779,45 @@ namespace Azure.AI.Projects { } /** - * A WorkIQ server-side tool. + * An agent implementing the A2A protocol. */ - model WorkIQPreviewTool extends OpenAI.Tool { + model A2APreviewTool extends OpenAI.Tool { /** - * The object type, which is always 'work_iq_preview'. + * The type of the tool. Always `"a2a_preview`. */ - type: "work_iq_preview"; + type: "a2a_preview"; + + ...ToolNameAndDescriptionExtension; + ...A2APreviewToolFields; + } + /** + * Shared fields for WorkIQ tool definitions. + */ + model WorkIQPreviewToolFields { /** * The ID of the WorkIQ project connection. */ project_connection_id: string; - - ...ToolNameAndDescriptionExtension; } /** - * A FabricIQ server-side tool. + * A WorkIQ server-side tool. */ - model FabricIQPreviewTool extends OpenAI.Tool { + model WorkIQPreviewTool extends OpenAI.Tool { /** - * The object type, which is always 'fabric_iq_preview'. + * The object type, which is always 'work_iq_preview'. */ - type: "fabric_iq_preview"; + type: "work_iq_preview"; + ...WorkIQPreviewToolFields; + ...ToolNameAndDescriptionExtension; + } + + /** + * Shared fields for FabricIQ tool definitions. + */ + model FabricIQPreviewToolFields { /** * The ID of the FabricIQ project connection. */ @@ -764,7 +839,18 @@ namespace Azure.AI.Projects { #suppress "@azure-tools/typespec-autorest/union-unsupported" "require_approval uses OpenAI union type." #suppress "@azure-tools/typespec-azure-core/no-unnamed-union" "Matching OpenAI MCP tool pattern." require_approval?: OpenAI.MCPToolRequireApproval | string | null = "always"; + } + + /** + * A FabricIQ server-side tool. + */ + model FabricIQPreviewTool extends OpenAI.Tool { + /** + * The object type, which is always 'fabric_iq_preview'. + */ + type: "fabric_iq_preview"; + ...FabricIQPreviewToolFields; ...ToolNameAndDescriptionExtension; } From 8bf1cecc897361f80092722de094589dc8b0d039 Mon Sep 17 00:00:00 2001 From: Vishwanath Balaji Date: Tue, 26 May 2026 19:51:00 -0700 Subject: [PATCH 06/12] Standardize tool project connection fields Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../v1/microsoft-foundry-openapi3.json | 16 +++++----- .../v1/microsoft-foundry-openapi3.yaml | 20 +++++------- .../microsoft-foundry-openapi3.json | 16 +++++----- .../microsoft-foundry-openapi3.yaml | 20 +++++------- .../data-plane/Foundry/src/tools/models.tsp | 32 +++++++++---------- 5 files changed, 48 insertions(+), 56 deletions(-) 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 bc41999eab32..02156018263a 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 @@ -14969,7 +14969,7 @@ }, "project_connection_id": { "type": "string", - "description": "The connection ID in the project for the A2A server.\nThe connection stores authentication and other connection details needed to connect to the A2A server." + "description": "The project connection ID used by this tool." } }, "allOf": [ @@ -15003,7 +15003,7 @@ }, "project_connection_id": { "type": "string", - "description": "The connection ID in the project for the A2A server.\nThe connection stores authentication and other connection details needed to connect to the A2A server." + "description": "The project connection ID used by this tool." } }, "allOf": [ @@ -22594,7 +22594,7 @@ }, "project_connection_id": { "type": "string", - "description": "The ID of the FabricIQ project connection." + "description": "The project connection ID used by this tool." }, "server_label": { "type": "string", @@ -22656,7 +22656,7 @@ }, "project_connection_id": { "type": "string", - "description": "The ID of the FabricIQ project connection." + "description": "The project connection ID used by this tool." }, "server_label": { "type": "string", @@ -24108,7 +24108,7 @@ }, "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." + "description": "The project connection ID used by this tool." } }, "allOf": [ @@ -38472,7 +38472,7 @@ }, "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." + "description": "The project connection ID used by this tool." } }, "allOf": [ @@ -49688,7 +49688,7 @@ }, "project_connection_id": { "type": "string", - "description": "The ID of the WorkIQ project connection." + "description": "The project connection ID used by this tool." }, "name": { "type": "string", @@ -49722,7 +49722,7 @@ }, "project_connection_id": { "type": "string", - "description": "The ID of the WorkIQ project connection." + "description": "The project connection ID used by this tool." } }, "allOf": [ 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 98e7e5c1145a..029756970510 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 @@ -9966,9 +9966,7 @@ components: If not provided, defaults to `/.well-known/agent-card.json` project_connection_id: type: string - description: |- - The connection ID in the project for the A2A server. - The connection stores authentication and other connection details needed to connect to the A2A server. + description: The project connection ID used by this tool. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: An agent implementing the A2A protocol. @@ -9993,9 +9991,7 @@ components: If not provided, defaults to `/.well-known/agent-card.json` project_connection_id: type: string - description: |- - The connection ID in the project for the A2A server. - The connection stores authentication and other connection details needed to connect to the A2A server. + description: The project connection ID used by this tool. allOf: - $ref: '#/components/schemas/ToolboxTool' description: An A2A tool stored in a toolbox. @@ -15345,7 +15341,7 @@ components: description: The object type, which is always 'fabric_iq_preview'. project_connection_id: type: string - description: The ID of the FabricIQ project connection. + description: The project connection ID used by this tool. server_label: type: string description: (Optional) The label of the FabricIQ MCP server to connect to. @@ -15385,7 +15381,7 @@ components: description: The type of the tool. Always `fabric_iq_preview`. project_connection_id: type: string - description: The ID of the FabricIQ project connection. + description: The project connection ID used by this tool. server_label: type: string description: (Optional) The label of the FabricIQ MCP server to connect to. @@ -16343,7 +16339,7 @@ components: default: always 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. + description: The project connection ID used by this tool. allOf: - $ref: '#/components/schemas/ToolboxTool' description: An MCP tool stored in a toolbox. @@ -26681,7 +26677,7 @@ components: default: always 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. + description: The project connection ID used by this tool. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: |- @@ -35016,7 +35012,7 @@ components: description: The object type, which is always 'work_iq_preview'. project_connection_id: type: string - description: The ID of the WorkIQ project connection. + description: The project connection ID used by this tool. name: type: string description: Optional user-defined name for this tool or configuration. @@ -35039,7 +35035,7 @@ components: description: The type of the tool. Always `work_iq_preview`. project_connection_id: type: string - description: The ID of the WorkIQ project connection. + description: The project connection ID used by this tool. allOf: - $ref: '#/components/schemas/ToolboxTool' description: A WorkIQ tool stored in a toolbox. 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 c05dc961e03d..e72b7730ef6f 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 @@ -17546,7 +17546,7 @@ }, "project_connection_id": { "type": "string", - "description": "The connection ID in the project for the A2A server.\nThe connection stores authentication and other connection details needed to connect to the A2A server." + "description": "The project connection ID used by this tool." } }, "allOf": [ @@ -17580,7 +17580,7 @@ }, "project_connection_id": { "type": "string", - "description": "The connection ID in the project for the A2A server.\nThe connection stores authentication and other connection details needed to connect to the A2A server." + "description": "The project connection ID used by this tool." } }, "allOf": [ @@ -26690,7 +26690,7 @@ }, "project_connection_id": { "type": "string", - "description": "The ID of the FabricIQ project connection." + "description": "The project connection ID used by this tool." }, "server_label": { "type": "string", @@ -26752,7 +26752,7 @@ }, "project_connection_id": { "type": "string", - "description": "The ID of the FabricIQ project connection." + "description": "The project connection ID used by this tool." }, "server_label": { "type": "string", @@ -28277,7 +28277,7 @@ }, "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." + "description": "The project connection ID used by this tool." } }, "allOf": [ @@ -42741,7 +42741,7 @@ }, "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." + "description": "The project connection ID used by this tool." } }, "allOf": [ @@ -54181,7 +54181,7 @@ }, "project_connection_id": { "type": "string", - "description": "The ID of the WorkIQ project connection." + "description": "The project connection ID used by this tool." }, "name": { "type": "string", @@ -54215,7 +54215,7 @@ }, "project_connection_id": { "type": "string", - "description": "The ID of the WorkIQ project connection." + "description": "The project connection ID used by this tool." } }, "allOf": [ 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 91171d8bb33b..84d6bd894269 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 @@ -11700,9 +11700,7 @@ components: If not provided, defaults to `/.well-known/agent-card.json` project_connection_id: type: string - description: |- - The connection ID in the project for the A2A server. - The connection stores authentication and other connection details needed to connect to the A2A server. + description: The project connection ID used by this tool. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: An agent implementing the A2A protocol. @@ -11727,9 +11725,7 @@ components: If not provided, defaults to `/.well-known/agent-card.json` project_connection_id: type: string - description: |- - The connection ID in the project for the A2A server. - The connection stores authentication and other connection details needed to connect to the A2A server. + description: The project connection ID used by this tool. allOf: - $ref: '#/components/schemas/ToolboxTool' description: An A2A tool stored in a toolbox. @@ -18132,7 +18128,7 @@ components: description: The object type, which is always 'fabric_iq_preview'. project_connection_id: type: string - description: The ID of the FabricIQ project connection. + description: The project connection ID used by this tool. server_label: type: string description: (Optional) The label of the FabricIQ MCP server to connect to. @@ -18172,7 +18168,7 @@ components: description: The type of the tool. Always `fabric_iq_preview`. project_connection_id: type: string - description: The ID of the FabricIQ project connection. + description: The project connection ID used by this tool. server_label: type: string description: (Optional) The label of the FabricIQ MCP server to connect to. @@ -19176,7 +19172,7 @@ components: default: always 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. + description: The project connection ID used by this tool. allOf: - $ref: '#/components/schemas/ToolboxTool' description: An MCP tool stored in a toolbox. @@ -29584,7 +29580,7 @@ components: default: always 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. + description: The project connection ID used by this tool. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: |- @@ -38072,7 +38068,7 @@ components: description: The object type, which is always 'work_iq_preview'. project_connection_id: type: string - description: The ID of the WorkIQ project connection. + description: The project connection ID used by this tool. name: type: string description: Optional user-defined name for this tool or configuration. @@ -38095,7 +38091,7 @@ components: description: The type of the tool. Always `work_iq_preview`. project_connection_id: type: string - description: The ID of the WorkIQ project connection. + description: The project connection ID used by this tool. allOf: - $ref: '#/components/schemas/ToolboxTool' description: A WorkIQ tool stored in a toolbox. 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 60f54420b8ac..9bcaa9d45050 100644 --- a/specification/ai-foundry/data-plane/Foundry/src/tools/models.tsp +++ b/specification/ai-foundry/data-plane/Foundry/src/tools/models.tsp @@ -46,7 +46,7 @@ namespace Azure.AI.Projects { #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" @@copyProperties(OpenAI.MCPTool, { - ...ToolProjectConnectionIdExtension, + ...OptionalToolProjectConnectionIdField, } ); @@ -131,13 +131,23 @@ namespace Azure.AI.Projects { /** * Optional project connection ID for tools that can use project-scoped connections. */ - alias ToolProjectConnectionIdExtension = { + alias OptionalToolProjectConnectionIdField = { /** - * 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. + * The project connection ID used by this tool. */ project_connection_id?: string; }; + /** + * Required project connection ID for tools that use project-scoped connections. + */ + alias RequiredToolProjectConnectionIdField = { + /** + * The project connection ID used by this tool. + */ + project_connection_id: string; + }; + /** * The input definition information for a bing grounding search tool as used to configure an agent. */ @@ -771,11 +781,7 @@ namespace Azure.AI.Projects { */ agent_card_path?: string; - /** - * The connection ID in the project for the A2A server. - * The connection stores authentication and other connection details needed to connect to the A2A server. - */ - project_connection_id?: string; + ...OptionalToolProjectConnectionIdField; } /** @@ -795,10 +801,7 @@ namespace Azure.AI.Projects { * Shared fields for WorkIQ tool definitions. */ model WorkIQPreviewToolFields { - /** - * The ID of the WorkIQ project connection. - */ - project_connection_id: string; + ...RequiredToolProjectConnectionIdField; } /** @@ -818,10 +821,7 @@ namespace Azure.AI.Projects { * Shared fields for FabricIQ tool definitions. */ model FabricIQPreviewToolFields { - /** - * The ID of the FabricIQ project connection. - */ - project_connection_id: string; + ...RequiredToolProjectConnectionIdField; /** * (Optional) The label of the FabricIQ MCP server to connect to. From ca7939a23ca62962937c89d55d3fbfbaf7863ab0 Mon Sep 17 00:00:00 2001 From: Vishwanath Balaji Date: Tue, 26 May 2026 19:58:30 -0700 Subject: [PATCH 07/12] Simplify WorkIQ tool fields Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../data-plane/Foundry/src/toolboxes/models.tsp | 2 +- .../ai-foundry/data-plane/Foundry/src/tools/models.tsp | 9 +-------- 2 files changed, 2 insertions(+), 9 deletions(-) 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 4f80ad086147..c3c3cec307c4 100644 --- a/specification/ai-foundry/data-plane/Foundry/src/toolboxes/models.tsp +++ b/specification/ai-foundry/data-plane/Foundry/src/toolboxes/models.tsp @@ -176,7 +176,7 @@ model WorkIQPreviewToolboxTool extends ToolboxTool { */ type: "work_iq_preview"; - ...WorkIQPreviewToolFields; + ...RequiredToolProjectConnectionIdField; } /** 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 9bcaa9d45050..c3e21394bead 100644 --- a/specification/ai-foundry/data-plane/Foundry/src/tools/models.tsp +++ b/specification/ai-foundry/data-plane/Foundry/src/tools/models.tsp @@ -797,13 +797,6 @@ namespace Azure.AI.Projects { ...A2APreviewToolFields; } - /** - * Shared fields for WorkIQ tool definitions. - */ - model WorkIQPreviewToolFields { - ...RequiredToolProjectConnectionIdField; - } - /** * A WorkIQ server-side tool. */ @@ -813,7 +806,7 @@ namespace Azure.AI.Projects { */ type: "work_iq_preview"; - ...WorkIQPreviewToolFields; + ...RequiredToolProjectConnectionIdField; ...ToolNameAndDescriptionExtension; } From e9823aff119fd7c1af3ec37c910db55df2510ae6 Mon Sep 17 00:00:00 2001 From: Gerardo Lecaros <10088504+glecaros@users.noreply.github.com> Date: Thu, 11 Jun 2026 11:44:22 -0700 Subject: [PATCH 08/12] Glecaros/template use (#43565) * partial * partial2 * done --- .../v1/microsoft-foundry-openapi3.json | 55 +++++---- .../v1/microsoft-foundry-openapi3.yaml | 55 +++++---- .../microsoft-foundry-openapi3.json | 55 +++++---- .../microsoft-foundry-openapi3.yaml | 55 +++++---- .../Foundry/src/toolboxes/models.tsp | 66 ++--------- .../data-plane/Foundry/src/tools/models.tsp | 109 +++++++----------- 6 files changed, 175 insertions(+), 220 deletions(-) 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 02156018263a..cdea4ae70d19 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 @@ -14950,14 +14950,6 @@ ], "description": "The type of the tool. Always `\"a2a_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." - }, "base_url": { "type": "string", "format": "uri", @@ -14969,7 +14961,15 @@ }, "project_connection_id": { "type": "string", - "description": "The project connection ID used by this tool." + "description": "The connection ID in the project for the A2A server.\nThe connection stores authentication and other connection details needed to connect to the A2A server." + }, + "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." } }, "allOf": [ @@ -14990,7 +14990,7 @@ "enum": [ "a2a_preview" ], - "description": "The type of the tool. Always `a2a_preview`." + "description": "The type of the tool. Always `\"a2a_preview`." }, "base_url": { "type": "string", @@ -15003,7 +15003,7 @@ }, "project_connection_id": { "type": "string", - "description": "The project connection ID used by this tool." + "description": "The connection ID in the project for the A2A server.\nThe connection stores authentication and other connection details needed to connect to the A2A server." } }, "allOf": [ @@ -16908,7 +16908,7 @@ "enum": [ "azure_ai_search" ], - "description": "The type of the tool. Always `azure_ai_search`." + "description": "The object type, which is always 'azure_ai_search'." }, "azure_ai_search": { "allOf": [ @@ -18595,7 +18595,8 @@ "enum": [ "code_interpreter" ], - "description": "The type of the tool. Always `code_interpreter`." + "description": "The type of the code interpreter tool. Always `code_interpreter`.", + "x-stainless-const": true }, "container": { "anyOf": [ @@ -22594,7 +22595,7 @@ }, "project_connection_id": { "type": "string", - "description": "The project connection ID used by this tool." + "description": "The ID of the FabricIQ project connection." }, "server_label": { "type": "string", @@ -22652,11 +22653,11 @@ "enum": [ "fabric_iq_preview" ], - "description": "The type of the tool. Always `fabric_iq_preview`." + "description": "The object type, which is always 'fabric_iq_preview'." }, "project_connection_id": { "type": "string", - "description": "The project connection ID used by this tool." + "description": "The ID of the FabricIQ project connection." }, "server_label": { "type": "string", @@ -22806,7 +22807,9 @@ "enum": [ "file_search" ], - "description": "The type of the tool. Always `file_search`." + "description": "The type of the file search tool. Always `file_search`.", + "x-stainless-const": true, + "default": "file_search" }, "max_num_results": { "allOf": [ @@ -24024,7 +24027,8 @@ "enum": [ "mcp" ], - "description": "The type of the tool. Always `mcp`." + "description": "The type of the MCP tool. Always `mcp`.", + "x-stainless-const": true }, "server_label": { "type": "string", @@ -24108,7 +24112,7 @@ }, "project_connection_id": { "type": "string", - "description": "The project connection ID used by this tool." + "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." } }, "allOf": [ @@ -38472,7 +38476,7 @@ }, "project_connection_id": { "type": "string", - "description": "The project connection ID used by this tool." + "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." } }, "allOf": [ @@ -45136,7 +45140,7 @@ "enum": [ "openapi" ], - "description": "The type of the tool. Always `openapi`." + "description": "The object type, which is always 'openapi'." }, "openapi": { "allOf": [ @@ -49597,7 +49601,8 @@ "enum": [ "web_search" ], - "description": "The type of the tool. Always `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", @@ -49688,7 +49693,7 @@ }, "project_connection_id": { "type": "string", - "description": "The project connection ID used by this tool." + "description": "The ID of the WorkIQ project connection." }, "name": { "type": "string", @@ -49718,11 +49723,11 @@ "enum": [ "work_iq_preview" ], - "description": "The type of the tool. Always `work_iq_preview`." + "description": "The object type, which is always 'work_iq_preview'." }, "project_connection_id": { "type": "string", - "description": "The project connection ID used by this tool." + "description": "The ID of the WorkIQ project connection." } }, "allOf": [ 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 029756970510..9dae869e1981 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 @@ -9949,12 +9949,6 @@ components: enum: - a2a_preview description: The type of the tool. Always `"a2a_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. base_url: type: string format: uri @@ -9966,7 +9960,15 @@ components: If not provided, defaults to `/.well-known/agent-card.json` project_connection_id: type: string - description: The project connection ID used by this tool. + description: |- + The connection ID in the project for the A2A server. + The connection stores authentication and other connection details needed to connect to the A2A server. + 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. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: An agent implementing the A2A protocol. @@ -9979,7 +9981,7 @@ components: type: string enum: - a2a_preview - description: The type of the tool. Always `a2a_preview`. + description: The type of the tool. Always `"a2a_preview`. base_url: type: string format: uri @@ -9991,7 +9993,9 @@ components: If not provided, defaults to `/.well-known/agent-card.json` project_connection_id: type: string - description: The project connection ID used by this tool. + description: |- + The connection ID in the project for the A2A server. + The connection stores authentication and other connection details needed to connect to the A2A server. allOf: - $ref: '#/components/schemas/ToolboxTool' description: An A2A tool stored in a toolbox. @@ -11244,7 +11248,7 @@ components: type: string enum: - azure_ai_search - description: The type of the tool. Always `azure_ai_search`. + description: The object type, which is always 'azure_ai_search'. azure_ai_search: allOf: - $ref: '#/components/schemas/AzureAISearchToolResource' @@ -12370,7 +12374,8 @@ components: type: string enum: - code_interpreter - description: The type of the tool. Always `code_interpreter`. + description: The type of the code interpreter tool. Always `code_interpreter`. + x-stainless-const: true container: anyOf: - type: string @@ -15341,7 +15346,7 @@ components: description: The object type, which is always 'fabric_iq_preview'. project_connection_id: type: string - description: The project connection ID used by this tool. + description: The ID of the FabricIQ project connection. server_label: type: string description: (Optional) The label of the FabricIQ MCP server to connect to. @@ -15378,10 +15383,10 @@ components: type: string enum: - fabric_iq_preview - description: The type of the tool. Always `fabric_iq_preview`. + description: The object type, which is always 'fabric_iq_preview'. project_connection_id: type: string - description: The project connection ID used by this tool. + description: The ID of the FabricIQ project connection. server_label: type: string description: (Optional) The label of the FabricIQ MCP server to connect to. @@ -15477,7 +15482,9 @@ components: type: string enum: - file_search - description: The type of the tool. Always `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' @@ -16267,7 +16274,8 @@ components: type: string enum: - mcp - description: The type of the tool. Always `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. @@ -16339,7 +16347,7 @@ components: default: always project_connection_id: type: string - description: The project connection ID used by this tool. + 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. allOf: - $ref: '#/components/schemas/ToolboxTool' description: An MCP tool stored in a toolbox. @@ -26677,7 +26685,7 @@ components: default: always project_connection_id: type: string - description: The project connection ID used by this tool. + 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. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: |- @@ -31941,7 +31949,7 @@ components: type: string enum: - openapi - description: The type of the tool. Always `openapi`. + description: The object type, which is always 'openapi'. openapi: allOf: - $ref: '#/components/schemas/OpenApiFunctionDefinition' @@ -34952,7 +34960,8 @@ components: type: string enum: - web_search - description: The type of the tool. Always `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: @@ -35012,7 +35021,7 @@ components: description: The object type, which is always 'work_iq_preview'. project_connection_id: type: string - description: The project connection ID used by this tool. + description: The ID of the WorkIQ project connection. name: type: string description: Optional user-defined name for this tool or configuration. @@ -35032,10 +35041,10 @@ components: type: string enum: - work_iq_preview - description: The type of the tool. Always `work_iq_preview`. + description: The object type, which is always 'work_iq_preview'. project_connection_id: type: string - description: The project connection ID used by this tool. + description: The ID of the WorkIQ project connection. allOf: - $ref: '#/components/schemas/ToolboxTool' description: A WorkIQ tool stored in a toolbox. 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 e72b7730ef6f..53112b0ea97c 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 @@ -17527,14 +17527,6 @@ ], "description": "The type of the tool. Always `\"a2a_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." - }, "base_url": { "type": "string", "format": "uri", @@ -17546,7 +17538,15 @@ }, "project_connection_id": { "type": "string", - "description": "The project connection ID used by this tool." + "description": "The connection ID in the project for the A2A server.\nThe connection stores authentication and other connection details needed to connect to the A2A server." + }, + "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." } }, "allOf": [ @@ -17567,7 +17567,7 @@ "enum": [ "a2a_preview" ], - "description": "The type of the tool. Always `a2a_preview`." + "description": "The type of the tool. Always `\"a2a_preview`." }, "base_url": { "type": "string", @@ -17580,7 +17580,7 @@ }, "project_connection_id": { "type": "string", - "description": "The project connection ID used by this tool." + "description": "The connection ID in the project for the A2A server.\nThe connection stores authentication and other connection details needed to connect to the A2A server." } }, "allOf": [ @@ -19947,7 +19947,7 @@ "enum": [ "azure_ai_search" ], - "description": "The type of the tool. Always `azure_ai_search`." + "description": "The object type, which is always 'azure_ai_search'." }, "azure_ai_search": { "allOf": [ @@ -21634,7 +21634,8 @@ "enum": [ "code_interpreter" ], - "description": "The type of the tool. Always `code_interpreter`." + "description": "The type of the code interpreter tool. Always `code_interpreter`.", + "x-stainless-const": true }, "container": { "anyOf": [ @@ -26690,7 +26691,7 @@ }, "project_connection_id": { "type": "string", - "description": "The project connection ID used by this tool." + "description": "The ID of the FabricIQ project connection." }, "server_label": { "type": "string", @@ -26748,11 +26749,11 @@ "enum": [ "fabric_iq_preview" ], - "description": "The type of the tool. Always `fabric_iq_preview`." + "description": "The object type, which is always 'fabric_iq_preview'." }, "project_connection_id": { "type": "string", - "description": "The project connection ID used by this tool." + "description": "The ID of the FabricIQ project connection." }, "server_label": { "type": "string", @@ -26902,7 +26903,9 @@ "enum": [ "file_search" ], - "description": "The type of the tool. Always `file_search`." + "description": "The type of the file search tool. Always `file_search`.", + "x-stainless-const": true, + "default": "file_search" }, "max_num_results": { "allOf": [ @@ -28193,7 +28196,8 @@ "enum": [ "mcp" ], - "description": "The type of the tool. Always `mcp`." + "description": "The type of the MCP tool. Always `mcp`.", + "x-stainless-const": true }, "server_label": { "type": "string", @@ -28277,7 +28281,7 @@ }, "project_connection_id": { "type": "string", - "description": "The project connection ID used by this tool." + "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." } }, "allOf": [ @@ -42741,7 +42745,7 @@ }, "project_connection_id": { "type": "string", - "description": "The project connection ID used by this tool." + "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." } }, "allOf": [ @@ -49430,7 +49434,7 @@ "enum": [ "openapi" ], - "description": "The type of the tool. Always `openapi`." + "description": "The object type, which is always 'openapi'." }, "openapi": { "allOf": [ @@ -54090,7 +54094,8 @@ "enum": [ "web_search" ], - "description": "The type of the tool. Always `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", @@ -54181,7 +54186,7 @@ }, "project_connection_id": { "type": "string", - "description": "The project connection ID used by this tool." + "description": "The ID of the WorkIQ project connection." }, "name": { "type": "string", @@ -54211,11 +54216,11 @@ "enum": [ "work_iq_preview" ], - "description": "The type of the tool. Always `work_iq_preview`." + "description": "The object type, which is always 'work_iq_preview'." }, "project_connection_id": { "type": "string", - "description": "The project connection ID used by this tool." + "description": "The ID of the WorkIQ project connection." } }, "allOf": [ 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 84d6bd894269..e66cfdfe4ce4 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 @@ -11683,12 +11683,6 @@ components: enum: - a2a_preview description: The type of the tool. Always `"a2a_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. base_url: type: string format: uri @@ -11700,7 +11694,15 @@ components: If not provided, defaults to `/.well-known/agent-card.json` project_connection_id: type: string - description: The project connection ID used by this tool. + description: |- + The connection ID in the project for the A2A server. + The connection stores authentication and other connection details needed to connect to the A2A server. + 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. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: An agent implementing the A2A protocol. @@ -11713,7 +11715,7 @@ components: type: string enum: - a2a_preview - description: The type of the tool. Always `a2a_preview`. + description: The type of the tool. Always `"a2a_preview`. base_url: type: string format: uri @@ -11725,7 +11727,9 @@ components: If not provided, defaults to `/.well-known/agent-card.json` project_connection_id: type: string - description: The project connection ID used by this tool. + description: |- + The connection ID in the project for the A2A server. + The connection stores authentication and other connection details needed to connect to the A2A server. allOf: - $ref: '#/components/schemas/ToolboxTool' description: An A2A tool stored in a toolbox. @@ -13300,7 +13304,7 @@ components: type: string enum: - azure_ai_search - description: The type of the tool. Always `azure_ai_search`. + description: The object type, which is always 'azure_ai_search'. azure_ai_search: allOf: - $ref: '#/components/schemas/AzureAISearchToolResource' @@ -14426,7 +14430,8 @@ components: type: string enum: - code_interpreter - description: The type of the tool. Always `code_interpreter`. + description: The type of the code interpreter tool. Always `code_interpreter`. + x-stainless-const: true container: anyOf: - type: string @@ -18128,7 +18133,7 @@ components: description: The object type, which is always 'fabric_iq_preview'. project_connection_id: type: string - description: The project connection ID used by this tool. + description: The ID of the FabricIQ project connection. server_label: type: string description: (Optional) The label of the FabricIQ MCP server to connect to. @@ -18165,10 +18170,10 @@ components: type: string enum: - fabric_iq_preview - description: The type of the tool. Always `fabric_iq_preview`. + description: The object type, which is always 'fabric_iq_preview'. project_connection_id: type: string - description: The project connection ID used by this tool. + description: The ID of the FabricIQ project connection. server_label: type: string description: (Optional) The label of the FabricIQ MCP server to connect to. @@ -18264,7 +18269,9 @@ components: type: string enum: - file_search - description: The type of the tool. Always `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' @@ -19100,7 +19107,8 @@ components: type: string enum: - mcp - description: The type of the tool. Always `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. @@ -19172,7 +19180,7 @@ components: default: always project_connection_id: type: string - description: The project connection ID used by this tool. + 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. allOf: - $ref: '#/components/schemas/ToolboxTool' description: An MCP tool stored in a toolbox. @@ -29580,7 +29588,7 @@ components: default: always project_connection_id: type: string - description: The project connection ID used by this tool. + 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. allOf: - $ref: '#/components/schemas/OpenAI.Tool' description: |- @@ -34864,7 +34872,7 @@ components: type: string enum: - openapi - description: The type of the tool. Always `openapi`. + description: The object type, which is always 'openapi'. openapi: allOf: - $ref: '#/components/schemas/OpenApiFunctionDefinition' @@ -38008,7 +38016,8 @@ components: type: string enum: - web_search - description: The type of the tool. Always `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: @@ -38068,7 +38077,7 @@ components: description: The object type, which is always 'work_iq_preview'. project_connection_id: type: string - description: The project connection ID used by this tool. + description: The ID of the WorkIQ project connection. name: type: string description: Optional user-defined name for this tool or configuration. @@ -38088,10 +38097,10 @@ components: type: string enum: - work_iq_preview - description: The type of the tool. Always `work_iq_preview`. + description: The object type, which is always 'work_iq_preview'. project_connection_id: type: string - description: The project connection ID used by this tool. + description: The ID of the WorkIQ project connection. allOf: - $ref: '#/components/schemas/ToolboxTool' description: A WorkIQ tool stored in a toolbox. 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 c3c3cec307c4..c38f29fded61 100644 --- a/specification/ai-foundry/data-plane/Foundry/src/toolboxes/models.tsp +++ b/specification/ai-foundry/data-plane/Foundry/src/toolboxes/models.tsp @@ -49,9 +49,9 @@ model WithFieldsOptional { /** * Spreads tool-specific fields from `Source`, excluding fields owned by `ToolboxTool`. */ -model ToolFields { - ...OmitProperties; -} +alias ToolFields = { + ...OmitProperties; +}; /** * Supported tool types for tools stored in a toolbox. @@ -87,11 +87,6 @@ model ToolboxTool { * A code interpreter tool stored in a toolbox. */ model CodeInterpreterToolboxTool extends ToolboxTool { - /** - * The type of the tool. Always `code_interpreter`. - */ - type: "code_interpreter"; - ...ToolFields; } @@ -99,23 +94,16 @@ model CodeInterpreterToolboxTool extends ToolboxTool { * A file search tool stored in a toolbox. */ model FileSearchToolboxTool extends ToolboxTool { - /** - * The type of the tool. Always `file_search`. - */ - type: "file_search"; - - ...WithFieldsOptional, "vector_store_ids">; + ...WithFieldsOptional< + ToolFields, + "vector_store_ids" + >; } /** * A web search tool stored in a toolbox. */ model WebSearchToolboxTool extends ToolboxTool { - /** - * The type of the tool. Always `web_search`. - */ - type: "web_search"; - ...ToolFields; } @@ -123,11 +111,6 @@ model WebSearchToolboxTool extends ToolboxTool { * An MCP tool stored in a toolbox. */ model MCPToolboxTool extends ToolboxTool { - /** - * The type of the tool. Always `mcp`. - */ - type: "mcp"; - ...ToolFields; } @@ -135,60 +118,35 @@ model MCPToolboxTool extends ToolboxTool { * An Azure AI Search tool stored in a toolbox. */ model AzureAISearchToolboxTool extends ToolboxTool { - /** - * The type of the tool. Always `azure_ai_search`. - */ - type: "azure_ai_search"; - - ...AzureAISearchToolFields; + ...ToolFields; } /** * An OpenAPI tool stored in a toolbox. */ model OpenApiToolboxTool extends ToolboxTool { - /** - * The type of the tool. Always `openapi`. - */ - type: "openapi"; - - ...OpenApiToolFields; + ...ToolFields; } /** * An A2A tool stored in a toolbox. */ model A2APreviewToolboxTool extends ToolboxTool { - /** - * The type of the tool. Always `a2a_preview`. - */ - type: "a2a_preview"; - - ...A2APreviewToolFields; + ...ToolFields; } /** * A WorkIQ tool stored in a toolbox. */ model WorkIQPreviewToolboxTool extends ToolboxTool { - /** - * The type of the tool. Always `work_iq_preview`. - */ - type: "work_iq_preview"; - - ...RequiredToolProjectConnectionIdField; + ...ToolFields; } /** * A FabricIQ tool stored in a toolbox. */ model FabricIQPreviewToolboxTool extends ToolboxTool { - /** - * The type of the tool. Always `fabric_iq_preview`. - */ - type: "fabric_iq_preview"; - - ...FabricIQPreviewToolFields; + ...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 c3e21394bead..2de8f208ae1e 100644 --- a/specification/ai-foundry/data-plane/Foundry/src/tools/models.tsp +++ b/specification/ai-foundry/data-plane/Foundry/src/tools/models.tsp @@ -46,7 +46,10 @@ namespace Azure.AI.Projects { #suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature" @@copyProperties(OpenAI.MCPTool, { - ...OptionalToolProjectConnectionIdField, + /** + * 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. + */ + project_connection_id?: string, } ); @@ -128,26 +131,6 @@ namespace Azure.AI.Projects { description?: string; }; - /** - * Optional project connection ID for tools that can use project-scoped connections. - */ - alias OptionalToolProjectConnectionIdField = { - /** - * The project connection ID used by this tool. - */ - project_connection_id?: string; - }; - - /** - * Required project connection ID for tools that use project-scoped connections. - */ - alias RequiredToolProjectConnectionIdField = { - /** - * The project connection ID used by this tool. - */ - project_connection_id: string; - }; - /** * The input definition information for a bing grounding search tool as used to configure an agent. */ @@ -223,16 +206,6 @@ namespace Azure.AI.Projects { sharepoint_grounding_preview: SharepointGroundingToolParameters; } - /** - * Shared fields for Azure AI Search tool definitions. - */ - model AzureAISearchToolFields { - /** - * The azure ai search index resource. - */ - azure_ai_search: AzureAISearchToolResource; - } - /** * The input definition information for an Azure AI search tool as used to configure an agent. */ @@ -243,7 +216,11 @@ namespace Azure.AI.Projects { type: "azure_ai_search"; ...ToolNameAndDescriptionExtension; - ...AzureAISearchToolFields; + + /** + * The azure ai search index resource. + */ + azure_ai_search: AzureAISearchToolResource; } /** @@ -320,16 +297,6 @@ namespace Azure.AI.Projects { vector_semantic_hybrid: "vector_semantic_hybrid", } - /** - * Shared fields for OpenAPI tool definitions. - */ - model OpenApiToolFields { - /** - * The openapi function definition. - */ - openapi: OpenApiFunctionDefinition; - } - /** * The input definition information for an OpenAPI tool as used to configure an agent. */ @@ -339,7 +306,10 @@ namespace Azure.AI.Projects { */ type: "openapi"; - ...OpenApiToolFields; + /** + * The openapi function definition. + */ + openapi: OpenApiFunctionDefinition; } /** @@ -767,9 +737,14 @@ namespace Azure.AI.Projects { } /** - * Shared fields for A2A tool definitions. + * An agent implementing the A2A protocol. */ - model A2APreviewToolFields { + model A2APreviewTool extends OpenAI.Tool { + /** + * The type of the tool. Always `"a2a_preview`. + */ + type: "a2a_preview"; + /** * Base URL of the agent. */ @@ -781,20 +756,13 @@ namespace Azure.AI.Projects { */ agent_card_path?: string; - ...OptionalToolProjectConnectionIdField; - } - - /** - * An agent implementing the A2A protocol. - */ - model A2APreviewTool extends OpenAI.Tool { /** - * The type of the tool. Always `"a2a_preview`. + * The connection ID in the project for the A2A server. + * The connection stores authentication and other connection details needed to connect to the A2A server. */ - type: "a2a_preview"; + project_connection_id?: string; ...ToolNameAndDescriptionExtension; - ...A2APreviewToolFields; } /** @@ -806,15 +774,27 @@ namespace Azure.AI.Projects { */ type: "work_iq_preview"; - ...RequiredToolProjectConnectionIdField; + /** + * The ID of the WorkIQ project connection. + */ + project_connection_id: string; + ...ToolNameAndDescriptionExtension; } /** - * Shared fields for FabricIQ tool definitions. + * A FabricIQ server-side tool. */ - model FabricIQPreviewToolFields { - ...RequiredToolProjectConnectionIdField; + model FabricIQPreviewTool extends OpenAI.Tool { + /** + * The object type, which is always 'fabric_iq_preview'. + */ + type: "fabric_iq_preview"; + + /** + * The ID of the FabricIQ project connection. + */ + project_connection_id: string; /** * (Optional) The label of the FabricIQ MCP server to connect to. @@ -832,18 +812,7 @@ namespace Azure.AI.Projects { #suppress "@azure-tools/typespec-autorest/union-unsupported" "require_approval uses OpenAI union type." #suppress "@azure-tools/typespec-azure-core/no-unnamed-union" "Matching OpenAI MCP tool pattern." require_approval?: OpenAI.MCPToolRequireApproval | string | null = "always"; - } - - /** - * A FabricIQ server-side tool. - */ - model FabricIQPreviewTool extends OpenAI.Tool { - /** - * The object type, which is always 'fabric_iq_preview'. - */ - type: "fabric_iq_preview"; - ...FabricIQPreviewToolFields; ...ToolNameAndDescriptionExtension; } From a4ea34f2ec37f6f5a8f99f3542991e9c9f6b4c8f Mon Sep 17 00:00:00 2001 From: Nivedha Chellam Date: Tue, 16 Jun 2026 14:28:14 -0700 Subject: [PATCH 09/12] Fix toolbox tool discriminators and preview metadata constant --- .../Foundry/src/toolboxes/models.tsp | 24 ++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) 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..38977ce82ac7 100644 --- a/specification/ai-foundry/data-plane/Foundry/src/toolboxes/models.tsp +++ b/specification/ai-foundry/data-plane/Foundry/src/toolboxes/models.tsp @@ -8,6 +8,10 @@ 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 +54,7 @@ model WithFieldsOptional { * Spreads tool-specific fields from `Source`, excluding fields owned by `ToolboxTool`. */ alias ToolFields = { - ...OmitProperties; + ...OmitProperties; }; /** @@ -87,6 +91,8 @@ model ToolboxTool { * A code interpreter tool stored in a toolbox. */ model CodeInterpreterToolboxTool extends ToolboxTool { + type: "code_interpreter"; + ...ToolFields; } @@ -94,6 +100,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 +112,8 @@ model FileSearchToolboxTool extends ToolboxTool { * A web search tool stored in a toolbox. */ model WebSearchToolboxTool extends ToolboxTool { + type: "web_search"; + ...ToolFields; } @@ -111,6 +121,8 @@ model WebSearchToolboxTool extends ToolboxTool { * An MCP tool stored in a toolbox. */ model MCPToolboxTool extends ToolboxTool { + type: "mcp"; + ...ToolFields; } @@ -118,6 +130,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 +139,8 @@ model AzureAISearchToolboxTool extends ToolboxTool { * An OpenAPI tool stored in a toolbox. */ model OpenApiToolboxTool extends ToolboxTool { + type: "openapi"; + ...ToolFields; } @@ -132,6 +148,8 @@ model OpenApiToolboxTool extends ToolboxTool { * An A2A tool stored in a toolbox. */ model A2APreviewToolboxTool extends ToolboxTool { + type: "a2a_preview"; + ...ToolFields; } @@ -139,6 +157,8 @@ model A2APreviewToolboxTool extends ToolboxTool { * A WorkIQ tool stored in a toolbox. */ model WorkIQPreviewToolboxTool extends ToolboxTool { + type: "work_iq_preview"; + ...ToolFields; } @@ -146,6 +166,8 @@ model WorkIQPreviewToolboxTool extends ToolboxTool { * A FabricIQ tool stored in a toolbox. */ model FabricIQPreviewToolboxTool extends ToolboxTool { + type: "fabric_iq_preview"; + ...ToolFields; } From f8bc581e578733ae99262c321a8e6c882cbc8ee9 Mon Sep 17 00:00:00 2001 From: Nivedha Chellam Date: Tue, 16 Jun 2026 14:28:48 -0700 Subject: [PATCH 10/12] Update generated OpenAPI for toolbox tool shape changes --- .../v1/microsoft-foundry-openapi3.json | 14278 +++++++++++---- .../v1/microsoft-foundry-openapi3.yaml | 9501 ++++++---- .../microsoft-foundry-openapi3.json | 15280 +++++++++++----- .../microsoft-foundry-openapi3.yaml | 9814 ++++++---- 4 files changed, 34265 insertions(+), 14608 deletions(-) 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' From 13497ef680e36e39e0abdd668e0dc44ad7e4923b Mon Sep 17 00:00:00 2001 From: Nivedha Chellam <53238750+NivedhaChellam@users.noreply.github.com> Date: Tue, 16 Jun 2026 15:07:32 -0700 Subject: [PATCH 11/12] Merge feature/foundry-release into visbalaji/decouple-tool-shapes and resolve Foundry TypeSpec/OpenAPI conflicts (#43981) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Convert agents-optimization models to snake_case (#43552) * convert agents-optimization models to snake_case - All model property fields converted from camelCase to snake_case - Updated agent_name filter query param in routes (was agentName) - TypeSpec compiles cleanly Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Apply suggestion from @glecaros Co-authored-by: Gerardo Lecaros <10088504+glecaros@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Gerardo Lecaros <10088504+glecaros@users.noreply.github.com> * Use better names other than 'body', since it gets emitted in SDKs (#43562) * Bump Proxy Version (#43561) Co-authored-by: Joel Hendrix * Update OpenAPI3 files * Fix list session files (#43566) * Adds description field and 2026-04-01 api version (#43462) * Adds decription field and 2026-04-01 api version * Adds examples * Add @added(Versions.v2026_04_01) to description fields * Removes description from previous builds * Fixing Python Build * Update tspconfig.yaml * Update tspconfig.yaml * revert java change --------- Co-authored-by: Ross Grambo * Align Foundry Routines TypeSpec contracts (#43498) * fix(routines): align foundry typespec contracts Align the Foundry Routines TypeSpec with the latest AgentExtensions contract updates from Vienna branch users/akannava/agentextensions-routine-contract-cleanup. Update trigger and action discriminators, timer and GitHub issue fields, action input and conversation/session fields, and the service pagination shapes used by routine and run-history list operations. Regenerate the Foundry OpenAPI artifacts from the updated TypeSpec. Authored-by: GitHub Copilot CLI 1.0.55-0 Model: GPT-5.5 (gpt-5.5) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix(routines): address foundry typespec review - Clarify relative and absolute timer trigger syntax - Document raw JSON routine input pass-through semantics - Mark routine run ids read-only and use snake_case fields Authored-by: GitHub Copilot CLI v1.0.55-0 Model: GPT-5.5 (gpt-5.5) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix(routines): align list pagination contract Update Foundry Routines TypeSpec and generated OpenAPI for the AgentExtensions pagination contract now exposed by the service. Use limit/order/after/before query parameters and data/first_id/last_id/has_more list responses. Keep after/last_id modeled as opaque continuation tokens and document before as reserved/unsupported. Authored-by: GitHub Copilot CLI v1.0.55-0 Model: GPT-5.5 (gpt-5.5) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix(routines): make RoutineRun.id required per reviewer suggestion; regenerate OpenAPI @visibility(Lifecycle.Read) already suppresses id from write operations, so id: string (required) is correct here. Also regenerates OpenAPI artifacts. * fix(routines): address remaining PR review comments - TimerRoutineTrigger: replace relative in?: string with t?: utcDateTime (per johanste: relative timers are imprecise in service APIs) - Remove TimerRoutineTrigger.time_zone (no longer needed with absolute UTC time) - Remove RoutineListResponse, RoutineRunsResponse custom models; replace with AgentsPagedResult and AgentsPagedResult (per glecaros: standardize on AgentsPagedResult like other list operations) - RoutineRun.id doc: remove internal MLflow reference (per johanste) - RoutineRun.status doc: remove internal MLflow reference - Remove RoutineRun.trigger_time_zone (per glecaros+johanste: not needed when timestamps are already UTC) - Regenerate OpenAPI artifacts --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Akshaya Annavajhala <16749003+akshaya-a@users.noreply.github.com> Co-authored-by: Linda Li * update status codes (#43568) Co-authored-by: catalinaperalta * Fix Traffic Manager user metrics resource name (#43546) * Fix Traffic Manager user metrics resource name Set the LegacyOperations resource name for the singleton user metrics resource so generated SDKs can use the intended plural resource type name. * Pin Traffic Manager C# API version Keep the generated .NET SDK on 2022-04-01 while applying the user metrics resource name fix. * Add Kubernetes C# provisioning emitter config (#43413) * Add Kubernetes C# provisioning emitter config Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add Kubernetes provisioning RBAC role metadata Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Align Kubernetes provisioning API version with mgmt Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Customize Kubernetes mgmt C# API names * Pin Kubernetes mgmt C# API version * Revert "Pin Kubernetes mgmt C# API version" This reverts commit 419a5c4973801edd967514838d894e2c9f8e0a7d. * Revert "Customize Kubernetes mgmt C# API names" This reverts commit 79c4bfc8134034236bc37bbb6c7cd60453978522. * Apply suggestion from @ArcturusZhang --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Update names of new Skills method, for emitted Python and JS clients * rename Skill method 'create_from_package' to 'create_from_files' for Python & JS clients, to match REST API operation name * AKS .NET SDK: client.tsp naming polish for design guideline compliance (#43538) Add @@clientName overrides for C# emitter following Azure SDK for .NET design guideline review feedback on azure-sdk-for-net PR #59192: - ControlPlaneScalingSize -> ManagedClusterControlPlaneScalingSize - HardEvictionThreshold -> KubeletHardEvictionThreshold - KubeReserved -> KubeletReservedResources - ManagedClusterHostedSystemProfile.systemNodeSubnetID -> SystemNodeSubnetId - ManagedClusterHostedSystemProfile.nodeSubnetID -> NodeSubnetId - ManagedClusterAzureMonitorProfileMetrics.controlPlane -> IsControlPlane (flattens to IsControlPlaneEnabled in C#) No wire-format change (renames apply only to C# identifiers; JSON property names preserved via WirePath). * Renaming microsoft to Microsoft for Microsoft.Web (#43255) Split from Azure/azure-rest-api-specs#43189. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Renaming microsoft to Microsoft for Microsoft.Search (#43254) Split from Azure/azure-rest-api-specs#43189. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Renaming: `microsoft` to `Microsoft` - Microsoft.EventGrid (#43250) * Renaming microsoft to Microsoft for Microsoft.EventGrid Split from Azure/azure-rest-api-specs#43189. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * update --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * [JS] Add clientname for ManagedServiceIdentity (#43487) * remove duplicate model * update * Revert "remove duplicate model" This reverts commit af396b33a4c1f9cf57c65db726b311e32b8de849. * Revert "update" This reverts commit 036c7b64b4d32882b5a5df20d6fd49a5ff5ae46b. * update * [JS] Mitigate breaking change for JS (#43577) * update * update * update * format * Exclude python from clientLocation for PrivateEndpointConnections listByFactory to mitigate python sdk breaking (#43579) * Exclude python from clientLocation for PrivateEndpointConnections listByFactory * Remove ResourceAutoGenerated clientName override for python * Remove Kubernetes provisioning API version override (#43578) * update JS config for appservice (#42310) * update JS config for appservice * Update client.tsp * Update client.tsp * Update client.tsp * Revert "Update client.tsp" This reverts commit 97307f72417ab4be85239ec8f97363e3de6974a7. * Update client.tsp * Update client.tsp * Update tspconfig.yaml (#43528) * Update client.tsp (#43571) * containerservice: PreparedImageSpecification 2026-02-02-preview API updates (#43365) * fix: make prepared image spec version writable * docs: clarify prepared image spec version input * fix: restrict PreparedImageSpecification PATCH to ARM tags only Remove properties field from PreparedImageSpecificationPatch so that PATCH operations only accept ARM tags. Also remove the now-unused patch-specific models: - PreparedImageSpecificationPatchProperties - PreparedImageSpecificationManagedIdentityProfileUpdate - PreparedImageSpecificationScriptUpdate This is a breaking change that aligns with ADO task 38037921. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix: limit version field to 63 chars, add version to PUT examples - Align version pattern max length with Kubernetes label value limit (63) - Add version field to PUT (CreateOrUpdate) example request bodies Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * feat: restrict node customization PATCH to tags only, make sync - Add NodeCustomizationPatch (tags-only) model - Change ArmCustomPatchAsync -> ArmCustomPatchSync - Update examples: tags-only request body, remove 202 response - Affects both 2025-08-02-preview and 2025-09-02-preview Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix: address PR feedback - rename to NodeCustomizationUpdate, make version mutable, revert doc noise - Rename NodeCustomizationPatch to NodeCustomizationUpdate to minimize diff (keeps original model name) - Remove @visibility(Lifecycle.Read) from NC version field (customer-provided, same as PIS) - Revert unnecessary doc string change on update operation - Add version to NC CreateOrUpdate examples Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Revert NodeCustomization PATCH LRO change Keep the tags-only patch body and version updates, but leave the deprecated NodeCustomization PATCH operation documented as async to minimize the PR's LRO behavior changes. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * restore NC Update example 202 response and revert cosmetic tags change Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix(nodecustomization): restore NC Update source examples with 202 response and team:blue tags Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix(preparedimagespecification): remove extra blank line in models.tsp (formatting) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix(preparedimagespecification): remove duplicate version from create example Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix: address PIS review comments --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Rename `DeleteSkillVersionResponse` for Python client * Csharp name overrides based on review (#43513) * chsarp name overrides based on review * change type to system uri * format fix * try update MaiVoice1 * revert change --------- Co-authored-by: Emily Jiji * [App Configuration] Update configuration for TS (#42235) Add JS specific customizations * Ingest agents optimization. (#43567) * Sync common skills from azure sdk tools (#43593) * Sync common skills from azure sdk tools * First (#43595) * Updated sdkReleaseType to be settable independently (#43590) * Follow up typespec change for VL (#43600) Co-authored-by: Emily Jiji * Update doc strings to further clarify service-side defaults (#43598) * Add AKS AI Manager AIModel, ModelDeployment, ModelSource API (#42883) # Summary Document: https://github.com/azure-management-and-platforms/aks-handbook/pull/145 Introduces the `2026-05-02-preview` API version for `Microsoft.ContainerService/aimanager`, adding three new resources to support model catalog and deployment scenarios: ## New resources - **`AIModel`** — subscription-scoped catalog resource representing a model available for deployment. Supports `list`, `get`, and a `calculateCost` action (returns estimated cost and max available replicas for serving). - **`ModelSource`** — child of `AIManager`, registers an external model source (e.g., a registry or storage location) that deployments can pull models from. - **`ModelDeployment`** — child of `AIManagerNamespace`, represents a running deployment of an `AIModel` into a namespace, with serving performance (latency / throughput) estimation. ## New actions on `AIManagerNamespace` - **`listAccessKeys`** — returns namespace access keys along with `lastRotatedAt` - **`rotateKeys`** — Rotates the namespace-scoped LLM gateway API keys. --------- Signed-off-by: zhuangqh * Model type updates (#43597) * update empty type to record * change int32 -> int64 * add openapi3 files * [Maps] Fix doc rendering and parameterized-host examples for data-plane post TypeSpec Migration (#43184) * surface default endpoint in Learn API reference * fix literal \n showing in Learn API reference * fix endpoint description to add link to doc resource. * tweak the wording for endpooint description * improve doc rendering and fix parameterized-host examples - Replace literal \n escapes with real newlines in security definitions - Convert #### Notes headers to > [!NOTE] callouts in AadToken docs - Type endpoint parameter as url with default and geographic-scope description - Add missing endpoint parameter to 60 example files across Render, Route, Geolocation, Search, Timezone, Traffic, and Weather stable versions * regenerate Maps data-plane examples to match tsp compile output * Add endpoint parameter to Maps data-plane examples for Learn doc rendering Adds 'endpoint' to the parameters block of 122 example files (61 TSP source + 61 generated stable copies) across 6 data-plane services: Search, Weather, Route, Render, Timezone, Traffic. These services use x-ms-parameterized-host with hostTemplate '{endpoint}', so Learn requires the value in each example for URL substitution. Geolocation already had it. * expose subscription-key as both header and query auth for Maps data-plane Add a second ApiKeyAuth model (in: query) alongside the existing header form so the Learn docs 'URI Parameters' section renders subscription-key again, matching the pre-TypeSpec swagger behavior. Header form remains first in the @useAuth union to preserve existing SDK credential binding. * Revert "expose subscription-key as both header and query auth for Maps data-plane" This reverts commit 8aa03757781811eaadc820a569e243ba5262cfb7. --------- Co-authored-by: copilot * Change name model create operation (#43603) * [JS] Mitigate breaking for GuestConfiguration (#43609) * update * format * [CosmosDB] Adding new API versions 2026-03-15 stable and 2026-04-01-preview (#41475) * Added base API versions * Add Continuous35Days to ContinuousTier for 2026-04-01-preview - Add Continuous35Days enum value gated to 2026-04-01-preview - Add versioning imports to models.tsp - Add readme tag block for package-preview-2026-04-01-preview - Add examples for 2026-04-01-preview - Generate openapi.json for 2026-04-01-preview Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Adding support for preview only features * Examples and generated stable models * Gate preview-only models and fix decorator ordering * Fix review comment issues in 2026-03-15 and 2026-04-01-preview examples Agent-Logs-Url: https://github.com/Azure/azure-rest-api-specs/sessions/02976c58-5f2f-4cad-98ad-af3dab2e404e Co-authored-by: pjohari-ms <84465928+pjohari-ms@users.noreply.github.com> * More fixes, copilot was incorrect * More fixes * Add enforceHierarchicalPartitionKeyIdLastLevel to DatabaseAccount (#41701) * Add enforceHierarchicalPartitionKeyIdLastLevel to DatabaseAccount for 2026-03-15 Add optional boolean property to enable/disable hierarchical partition key ID last level enforcement on the Cosmos DB database account. Property is scoped to 2026-03-15 stable only (excluded from 2026-04-01-preview). Added to: DatabaseAccountGetProperties, DatabaseAccountUpdateProperties, DatabaseAccountCreateUpdateProperties. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * remove gated * add examples --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * init (#41715) Co-authored-by: Adrián Sibaja Retana Co-authored-by: pjohari-ms <84465928+pjohari-ms@users.noreply.github.com> * init (#41712) Co-authored-by: Adrián Sibaja Retana Co-authored-by: pjohari-ms <84465928+pjohari-ms@users.noreply.github.com> * Add shardCount, authenticationMethod, and persistence to Garnet Cache for 2026-04-01-preview (#41811) * Add new properties in the sdk * Remove accidentally committed .gitkeep file * Add generated openapi.json for 2026-03-15 * Revert "Add generated openapi.json for 2026-03-15" This reverts commit 9fe38a2124e438a382eea69865ed6a6d27d371fc. * Rename nodeCount to shardCount and add new Garnet properties for 2026-04-01-preview - Rename nodeCount to shardCount in all Garnet examples (source and output) - Add authenticationMethod, persistence, and shardCount to all Garnet example responses (Create, Get, List, Patch) - Matches @added/@removed decorators in models.tsp Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add Table, Cassandra, Gremlin, MongoMI RBAC examples for 2026-03-15 s… (#41975) * Add Table, Cassandra, Gremlin, MongoMI RBAC examples for 2026-03-15 stable Add RBAC role definition and role assignment examples for Table, Cassandra, Gremlin, and MongoMI APIs under the 2026-03-15 stable version. Update readme.md with package-2026-03-15 tag. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Remove @added gating from RBAC operations, add preview examples, regenerate swagger Remove @added(Versions.v2026_04_01_preview) from Table, Cassandra, Gremlin, and MongoMI RBAC operation interfaces so they appear in both stable (2026-03-15) and preview (2026-04-01-preview) swagger. Add RBAC examples for 2026-04-01-preview. Regenerate openapi.json for stable version to include RBAC operations and example refs. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix LRO header casing in RBAC examples to match base repo Fix azure-AsyncOperation -> Azure-AsyncOperation and location -> Location in all RBAC example files for both 2026-03-15 and 2026-04-01-preview versions. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Reverting preview files which should be unchanged --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Update specification/cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/examples/2026-04-01-preview/CosmosDBCassandraKeyspaceList.json Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update specification/cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/examples/2026-03-15/CosmosDBMongoDBDatabaseCreateUpdate.json Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update specification/cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/examples/2026-03-15/CosmosDBSqlDatabaseCreateUpdate.json Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update specification/cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/examples/2026-03-15/CosmosDBPrivateEndpointConnectionGet.json Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update specification/cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/examples/2026-03-15/CosmosDBTableThroughputUpdate.json Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Typespec copilot suggested compiled changes * Copilot review * Add Soft Delete TypeSpec for CosmosDB 2026-04-01-preview (#42185) * Add Soft Delete TypeSpec for CosmosDB 2026-04-01-preview Port soft delete swagger changes from azure-rest-api-specs-pr PR #25529 to TypeSpec. Changes: - Add SoftDeleteConfiguration model with softDeletionEnabled, minMinutesBeforePermanentDeletionAllowed, and softDeleteRetentionPeriodInMinutes - Add softDeleteConfiguration property to DatabaseAccountGetProperties, DatabaseAccountCreateUpdateProperties, and DatabaseAccountUpdateProperties - Create SoftDeletedResources.tsp with operations for: - SoftDeletedDatabaseAccounts (Get, ListByLocation, ListByResourceGroupAndLocation, Delete) - SoftDeletedSqlDatabases (Get, List, Delete) - SoftDeletedSqlContainers (Get, List, Delete) - Add 13 example JSON files for 2026-04-01-preview - All new types versioned with @added(Versions.v2026_04_01_preview) - Generated swagger output verified Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix CI validation errors for soft-delete TypeSpec - Use ARM parameter spreads (SubscriptionIdParameter, ResourceGroupParameter, ApiVersionParameter) instead of inline @path/@query parameters - Add x-ms-pageable extension to all list operations - Add nextLink property to all list result models - Fix _rid property to use direct name with casing suppression Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Suppress TypeSpec warnings for soft-delete resources - Suppress no-nullable warnings for SoftDeleteConfiguration (x-nullable needed) - Suppress no-openapi warnings for x-ms-pageable and x-ms-client-flatten extensions - Clean compile: 0 errors, 0 warnings Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix CI round 2: _rid suppressions, location common-types, x-ms-mutability - Add DefinitionsPropertiesNamesCamelCase suppressions in readme.md for SoftDeletedSqlDatabaseResource._rid and SoftDeletedSqlContainerResource._rid - Replace inline location parameter with Azure.ResourceManager.LocationParameter (generates common-types \ in swagger) - Add x-ms-mutability ['read', 'create'] to location property on result models - Suppress arm-resource-operation warning for custom listByLocation operation - Clean compile: 0 errors, 0 warnings Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix missing location parameter in Purge/Restore example files Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Run tsp format on SoftDeletedResources.tsp Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Split Delete into separate Restore/Purge operations with @sharedRoute Use @sharedRoute and @operationId to produce distinct Restore and Purge operations matching the original swagger PR, so SDKs generate separate client.restore() and client.purge() methods instead of a single client.delete(softDeleteActionKind=...) method. Generated operationIds now match the original PR: - SoftDeletedDatabaseAccounts_Restore / _Purge - SoftDeletedSqlDatabases_Restore / _Purge - SoftDeletedSqlContainers_Restore / _Purge Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix JS SDK build: use query-in-path routes instead of @sharedRoute Replace @sharedRoute with distinct route paths that include the softDeleteActionKind query value directly in the path, matching the original swagger PR format exactly: .../softDeletedDatabaseAccounts/{accountName}?softDeleteActionKind=RestoreSoftDeletedResource .../softDeletedDatabaseAccounts/{accountName}?softDeleteActionKind=PermanentDeleteResource This avoids the ?_overload= suffix that @sharedRoute generates, which caused duplicate object literal keys in the JS SDK's restorePollerHelpers.ts. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Remove minLength/maxLength/pattern constraints from databaseName and containerName Per review feedback from mohhef - the existing SqlDatabaseGetResults and SqlContainerGetResults resources have no such constraints on these parameters. Removing them from soft-delete operations for consistency. accountName constraints (maxLength=50, minLength=3, pattern) are kept as they match the existing DatabaseAccountGetResults resource. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix CI: add pattern to databaseName/containerName, use v6 LocationParameter, fix example operationIds - Add @pattern to databaseName and containerName params (ResourceNameRestriction) - Replace deprecated LocationParameter with LocationResourceParameter (v6 common-types) - Update example files with correct operationIds (_Restore/_Purge instead of _Delete) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Remove nullable from SoftDeleteConfiguration properties RP parses omitted and null identically (GetValue defaults to null). Optional-only is sufficient since null is not used as a distinct value. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Po'okela Moana Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Added secret tag to existing properties * TSV validation * Replace secret-prop suppressions with @secret for authToken, serviceUserPassword, password; update key property suppression justifications * Merge with masteR * Removed extra fields that were incorrectly marked in the stable version * ChaosFault review comments * Models that were part of preview feature but were not marked preview * [CosmosDB] Address Ravimeda soft-delete review feedback (PR #41475 C3-C6) (#42950) * [CosmosDB] Soft-delete: extend ProxyResource and use Azure.Core.Page (PR #41475 C3, C6) Addresses Ravimeda review feedback on PR #41475: C3 (https://github.com/Azure/azure-rest-api-specs/pull/41475#discussion_r3189877759): Extend Azure.ResourceManager.ProxyResource for the three soft-delete result models (SoftDeletedDatabaseAccountGetResult, SoftDeletedSqlDatabaseGetResult, SoftDeletedSqlContainerGetResult) instead of manually defining id/name/type/location/ properties. ARM envelope now comes from the standard ProxyResource template, which also adds systemData. The required name property is supplied via the ResourceNameParameter mixin matching the existing route segment names. C6 (https://github.com/Azure/azure-rest-api-specs/pull/41475#discussion_r3189883653): Use Azure.Core.Page for the three list result models (SoftDeletedDatabaseAccountsListResult, SoftDeletedSqlDatabasesListResult, SoftDeletedSqlContainersListResult) instead of manually defining value/nextLink. Matches the standard pagination pattern used elsewhere in this spec. Also adds a concrete justification on the existing arm-resource-provisioning-state suppression for the three soft-delete properties models, since soft-deleted resources are read-only views of previously-deleted resources and have no provisioning lifecycle. Auto-regenerated openapi.json reflects the new ARM envelope (allOf ProxyResource) and standard paginated list shape. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * [CosmosDB] Soft-delete examples: fix response id and LRO header casing (PR #41475 C4, C5) Addresses Ravimeda review feedback on PR #41475: C4 (https://github.com/Azure/azure-rest-api-specs/pull/41475#discussion_r3189880218): In CosmosDBSoftDeletedDatabaseAccountGet.json and CosmosDBSoftDeletedDatabaseAccountListByLocation.json (and their preview/ mirrors), add the missing /resourceGroups// segment to response body 'id' fields. ARM resource ids must include the resource group segment even for resources surfaced via subscription+location-scoped list endpoints. C5 (https://github.com/Azure/azure-rest-api-specs/pull/41475#discussion_r3189881950): Replace lowercase LRO response header keys 'azure-asyncoperation' and 'location' with ARM-standard PascalCase 'Azure-AsyncOperation' and 'Location' in all soft-delete restore/purge example files (12 files: 6 distinct x 2 mirrors). Matches the casing convention applied to 130+ other example files in this PR. LRO header URL values (operationResults paths) intentionally remain subscription+location-scoped without /resourceGroups/, matching the operation return contract. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * [CosmosDB] Revert C4 (response id resourceGroups insertion) on PR #41475 Reverts the response id changes from commit 275220a in the four SoftDeletedDatabaseAccount example files. After review, comment C4 was incorrectly applied: the soft-delete API is registered in the ARM manifest as a Proxy resource scoped to subscription+location, NOT to a resource group. The canonical resource id for these examples therefore should NOT include a /resourceGroups/{rg}/ segment, even though the Get/Restore/Purge operations accept resourceGroupName as a request URL context parameter for permission scoping. This matches the established Azure soft-delete pattern across the platform (e.g., Microsoft.KeyVault/locations/{loc}/deletedVaults/{name}, Microsoft.Storage/locations/{loc}/deletedAccounts/{name}). C5 (LRO header casing) changes from the same commit are unaffected and remain applied. C3 and C6 TypeSpec changes also remain applied. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * [CosmosDB] Re-apply C4 (response id resourceGroups segment) on PR #41475 Reverts commit 332582f. After cross-checking against the actual handler bindings in CosmosDB/Product/Microsoft.Azure.Documents/Management/Services/ ResourceProvider/ResourceProviderHttpRuntime.cs (L1024-1027), the soft-delete DatabaseAccount resource is rg+location-scoped for Get/Restore/Purge: L1024: SoftDeletedDatabaseAccountRequestHandler bound to RPPaths .SoftDeletedDatabaseAccountRoot = /subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.DocumentDB /locations/{loc}/softDeletedDatabaseAccounts/{name} The earlier rationale ("Proxy resource scoped to subscription+location only") was based on an incorrect characterization of the registration. Per the actual RP routing, the canonical resource id MUST include /resourceGroups/{rg}/ so clients can call Get/Restore/Purge using the response id. This also matches the pre-existing SqlContainer/SqlDatabase Get example ids. C4 fix re-applied to the four DatabaseAccount example files (CosmosDBSoftDeletedDatabaseAccountGet.json and CosmosDBSoftDeletedDatabaseAccountListByLocation.json, both in examples/ and preview/.../examples/ mirrors). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * [CosmosDB] Soft-delete: align name patterns with parent CosmosDB resources The SoftDeletedSqlDatabase and SoftDeletedSqlContainer resources were the only CosmosDB tsps using the URL-safe regex ^[^/\\\\#?]+$ as their name constraint. Their parent resources (SqlDatabaseGetResults, SqlContainerGetResults) do not declare any name pattern, accepting whatever the user originally named the database/container. Soft-delete should be no more restrictive than the parent contract — otherwise a user with a parent SqlDatabase whose name has unusual characters could not look it up via the SoftDeletedSqlDatabase APIs. Changes: - ResourceNameParameter NamePattern set to "" for SoftDeletedSqlDatabaseGetResult and SoftDeletedSqlContainerGetResult (was: "^[^/\\\\#?]+$"). - @pattern("^[^/\\\\#?]+$") removed from databaseName and containerName @path parameters in all soft-delete operations (10 occurrences). DatabaseAccount-related patterns kept unchanged: NamePattern "^[a-z0-9]+(-[a-z0-9]+)*" matches DatabaseAccountGetResults exactly, and the accountName @path @pattern declarations match the existing CosmosDB account naming convention. Auto-regenerated openapi.json reflects the removed pattern field on databaseName and containerName path parameters. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * [CosmosDB] Soft-delete: restore name patterns on databaseName/containerName for RPC-Uri-V1-05 lint Reverts the parent-alignment portion of commit ce6bfb7. The ResourceNameRestriction lint (RPC-Uri-V1-05) requires resource name path parameters to declare a 'pattern' constraint. Removing the pattern caused 4 lint failures on PR #42950 at SoftDeletedSqlDatabases_Get, SoftDeletedSqlContainers_List, and SoftDeletedSqlContainers_Get. The parent SqlDatabase/SqlContainer specs predate the rule and are grandfathered in; new APIs (the soft-delete preview) must comply. Restored: - @pattern("^[^/\\\\#?]+$") on databaseName @path parameters (7 occurrences) - @pattern("^[^/\\\\#?]+$") on containerName @path parameters (3 occurrences) - NamePattern = "^[^/\\\\#?]+$" on SoftDeletedSqlDatabaseGetResult and SoftDeletedSqlContainerGetResult model declarations Pattern is permissive (URL-safe characters only — rejects /, \, #, ?), so it accepts any name the parent SqlDatabase/SqlContainer would have allowed that can survive URL path interpolation. DatabaseAccount-related patterns ("^[a-z0-9]+(-[a-z0-9]+)*") were unchanged by ce6bfb7 and remain in place. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Po'okela Moana Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Run tsp format on SoftDeletedResources.tsp * Regenerate openapi.json after merging main (ProxyResource refactor) --------- Co-authored-by: Vinh Trinh Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: lnajaroen <122407949+lnajaroen@users.noreply.github.com> Co-authored-by: AdrianSibajaRetana <54075415+AdrianSibajaRetana@users.noreply.github.com> Co-authored-by: Adrián Sibaja Retana Co-authored-by: Karthik chakravarthy <88904658+kcheekuri@users.noreply.github.com> Co-authored-by: etcriss <109991318+etcriss@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: pmoana-ms Co-authored-by: Po'okela Moana Co-authored-by: Mike Harder * update suffix for go (#43473) * update suffix * Revert Go module suffix change in AppService tspconfig.yaml (v6 -> v5) Agent-Logs-Url: https://github.com/Azure/azure-rest-api-specs/sessions/3ed9cc1d-e2fa-45d4-b5f9-30967ebaa755 Co-authored-by: JiaqiZhang-Dev <194873822+JiaqiZhang-Dev@users.noreply.github.com> * add suffix --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: JiaqiZhang-Dev <194873822+JiaqiZhang-Dev@users.noreply.github.com> Co-authored-by: Jiaqi Zhang * [JS] Use `@responseAsBool` replace `head-as-boolean` (#43120) * remove head as boolean * format * [JS] Mitigate sdk breaking change (#43611) * Microsoft.DesktopVirtualization 2026-03-01-preview API version (#41748) * Rebase main * Update the tsp file * Fix comments * Fix example issues * Fix Comment * Fix Comment * Run tsp compile * Fix comment --------- Co-authored-by: Zhongjie Li Co-authored-by: Li McGregor <413436584lzj@gmail.com> * Refactor(migrate): migrate to unified folder structure (#42102) * Refactor migrate folder structure to comply with Azure Guidelines * Fixed all common-types references * Updated readme.md, tspconfig.yaml, cspell.yaml, suppressions.yaml and added suppressions.yaml * Fix typespec validation ci error * Fix sdk ci error * Update client.tsp * Refactor AssessmentProjects folder * Move clien.tsp to right folder * Remove SdkTspConfigValidation rule in suppressions.yaml * Remove extra spaces from folder 'Normalized Contract' --------- Co-authored-by: v-huizhu2 Co-authored-by: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com> * Changed the scope from subscription-level to resource group-level. (#43589) * 1) Changed the scope from subscription-level to resource group-level. 2) Updated all the examples to use the new rg scoped urls. * 1) Removed the resourceGroupName from the BulkVmConfiguration since we are scoping URL to be resource-group based and not subscription-level based. * 1) Update the python namespace to follow the general naming guidelines for SDKs --------- Co-authored-by: Sumedh Sandeep Parvatikar Co-authored-by: hardikginwala <113458906+hardikginwala@users.noreply.github.com> * redhatopenshift - change final-state-via to azure-async-operation (#43553) * Change final-state-via to Azure-AsyncOperation to line up with up RP's behavior * Revert accidental changes to delete --------- Co-authored-by: b-kippmorris * Skip sdk generation for rust in case of OpenAPI specs (#43557) * Skip readme based SDK generation for Rust * Updated with shared code for all generation methods * Updated log level * Added new tests * Add ARM modeling leases for networksecurity/agentFabric and privatetrafficmanager (#43594) Co-authored-by: Vikeshi Tiwari Co-authored-by: Tejaswi Salaigari * Review request for Microsoft.DBforPostgreSQL to add public preview release of version 2026-04-01-preview (#43065) * Introduce 2026-04-01-preview * add MaintenanceEvents * compile merge of master * Update maintenance * Add in MajorVersionUpgradePrecheck * prettier * fixes * fix * fixLong-running POST operations must initially return 202 * add suppression for guid * fix to camelcase * updates * Updates * fixes * Cross tenant properties * Update post response for mvu pvc * update to use armresourceid type * Add suppression and fixes * added enum for maintencne type Co-authored-by: Copilot * Add immutable backups Co-authored-by: Copilot * add where to suppression * pr comments * pr comments * Revert "Add immutable backups" This reverts commit 1942da251551d1edc22ce584d87bcd4e473b665c. * update mvu pvc examples * add original start time for maintenance * Add required props for maintenace * PR comments p1 * PR comments 2 * Update suppressions * Update suppresion * Fix format * fix * update suppresion * PR comments * format * PR comments * format * fix format * build fixes * fix pattern * fix openapi * PR comments * Resolve SDK review comments: rename ReadonlyEndpoint and PgVersion - ReadonlyEndpoint -> ReadOnlyEndpoint (PascalCase compound word) - PgVersion -> PostgreSqlVersion (expand non-standard abbreviation) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Naia Scott Co-authored-by: Copilot Co-authored-by: nasc17 <69922333+nasc17@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Migrate Arm API specs to v2 file structure (#42990) * restructured files * fix avocado error * modify suppressions and add readme * add suppressions for past handwritten swagger * from line in readme * edit readme * fix lintdiff * Add @azure-tools/typespec-ts emitter and update tspconfig placeholder values * remove emit-lro-options * move suppressions to specific packages * VL Test Changes for GA (#43622) * test custom.tsp change * another way might be better? --------- Co-authored-by: Emily Jiji * fix(agents-optimization): format route definitions for better readability (#43623) * Bump hardcoded .NET API version to 2026-03-02-preview. (#43607) * [Compute] Fix name and type, remove legacy (#43545) * [Compute] Fix name and type, remove legacy * Fix * update * update --------- Co-authored-by: Pan Shao Co-authored-by: Yuchao Yan * adding 2026-03-preview (#40785) * adding 2026-03-preview * resolving DescriptionMustNotBeNodeName Lint Diff * added supression for swagger avacado check * undo supressions changes * fixing merge issues with 2026-02 version * copied examples from 2026-02-preview version and other errors fix * changed api version in list reco subs json file * added 2026-02 version in default tag * removed 2026-02 open api json from default tag --------- Co-authored-by: Garima Saxena * [JS] Update config to mitigate breaking change (#43631) * update config * update * mgmt, Java, Validate TypeSpec conversion for Quantum service converted tsp (#43427) * feat(java): add Java client customizations for backward compatibility after Swagger to TypeSpec migration * Update service name in tspconfig.yaml to remove space for AzureQuantum * Update tspconfig.yaml * Azure Local, SFF public preview May 2026 (#43203) * new public preview * add changes * Readme changes * Adding AddServer and RepairServer to Public Preview 2026-05-01-preview (#43209) Co-authored-by: Prakhar Shukla * Sync generated files with tsv * suppress XMSSecretInResponse for gpgPubKey - GPG public key is not a secret * Remove orphaned DevicePools examples and clarify gpgPubKey suppression reason - Delete orphaned example files for non-existent AddDevices/RemoveDevices operations: DevicePools_AddDevices_MaximumSet_Gen.json DevicePools_AddDevices_MinimumSet_Gen.json DevicePools_RemoveDevices_MaximumSet_Gen.json DevicePools_RemoveDevices_MinimumSet_Gen.json - Update XMSSecretInResponse suppression reason in readme.md to clarify gpgPubKey contains only public key material, not a secret * remove local only working file * Address PR review: WitnessType union and DevicePools example cleanup - Add WitnessType extensible enum (Cloud, FileShare) with @added(v2026_05_01_preview) - Update HciAddServerJobProperties.witnessType to use WitnessType union - Fix DevicePools_CreateOrUpdate.json placeholder values: Remove extraneous resourceUri parameter Set type to Microsoft.AzureStackHCI/devicePools Set realistic name, location, createdBy, lastModifiedBy Add tags field to 200/201 response bodies - Update gpgPubKey #suppress reasons in models.tsp to match readme.md * Remove unnecessary provisioning-state suppress from EdgeMachineJobs EdgeMachineJobProperties already includes provisioningState, so the #suppress directive with an empty reason was unnecessary. Removed it. * Add versioning policy doc to Versions enum and define VsrRing union for ChangeRingRequest and ClusterProperties.ring * Remove unnecessary suppress from DevicePool and add reason strings to catalog resource suppresses * re-compiled all tsp changes * Fix sdnProperties doc comment typo and switch ClusterSdnProperties to composition * clarify claimedBy descriptions * Port EdgeMachines validate action to 2026-05-01-preview (#43217) Add the validate long-running action on EdgeMachine resource for public preview API version 2026-05-01-preview. Ported from private preview 2026-03-15-preview. Changes: - EdgeMachine.tsp: Added validate operation (ArmResourceActionAsync) - models.tsp: Added EdgeMachineValidateRequest and EdgeMachineValidateResponse - examples: Added EdgeMachines_Validate.json Co-authored-by: Prakhar Shukla Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Edge machine lifecycle changes for 2026-05-01-preview (#43262) * Edge machine lifecycle changes for 2026-05-01-preview * Fix StackHCI 2026-05-01-preview generated files for TypeSpec validation Agent-Logs-Url: https://github.com/Azure/azure-rest-api-specs/sessions/767e7675-b44d-468d-8553-f2cdea23bc0e Co-authored-by: larikaS <127827858+larikaS@users.noreply.github.com> --------- Co-authored-by: Larika Sehgal Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> * add updates resource (#43240) Co-authored-by: Harsh Saroha * Add gpu to 2026 05 01 (#43269) * Add GPU models and examples * Change api version * Fix examples * Compile after rebase * recpmpile with pr merged * Replace VsrRing enum with string type for cluster ring property The ring property may support a broader range of values that are not controlled by our system, so a fixed enum is too restrictive. Changed ClusterProperties.ring and ChangeRingRequestProperties.targetRing to plain string and removed the VsrRing union. * Added workload inventory details to edge machine (#43482) * Add error details to os job step (#43425) * Add error details to os job step * Add examples * webpubsub: parameter reordering customization for Go/Python/JavaScript (#43474) * webpubsub: Go-only parameter reordering for backward compatibility Preserve the original swagger Go SDK parameter order (childName, resourceGroupName, resourceName, ...) for Hubs, PrivateEndpointConnections, and WebPubSubSharedPrivateLinkResources operations. Follows the @@override pattern used in DataBoxEdge (Azure/azure-rest-api-specs#43159). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * webpubsub: extend parameter-order overrides to python and javascript Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * update * update --------- Co-authored-by: tadelesh Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add python to clientName override for ChargeSummary.eTag (#43476) * [DataBox] Preserve SDK parameter order (#43418) * [DataBox] Preserve SDK parameter order * tsp format * Update client.tsp * tsp format * [servicebus] fix for Namespaces.update to be sync operation (#43478) Co-authored-by: tadelesh * [JS] Enable compatibility-lro for billingbenefits (#43475) * Mitigate Python SDK breaking changes for azure-mgmt-msi (#43479) * Added examples for inventory * compiled examples * VMConnect 2026-05-01 changes (#43391) * vmconnect model changes * adding example files * compile --------- Co-authored-by: abaranwal-ms <124332815+abaranwal-ms@users.noreply.github.com> Co-authored-by: Abhijeet Baranwal * Add EdgeMachine Fabric Management resources for 2026-05-01-preview (#43542) * Add PEAP and TTLS to cspell allowed words * Fix TypeSpec formatting to pass tsv validation * fix formatting * Add Fabric Management changes and update cspell (#43630) * fix formatting, uncheckout protected file * Added PEAP and TTLS to cspell * Add solutionType (ProvisioningOsType) to EdgeMachineUpdate for 2026-05-01-preview (#43636) --------- Co-authored-by: prakhar_shukla <78557330+shuklaprakhar415@users.noreply.github.com> Co-authored-by: Prakhar Shukla Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: larikaS <127827858+larikaS@users.noreply.github.com> Co-authored-by: Larika Sehgal Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: le-codeur Co-authored-by: Harsh Saroha Co-authored-by: Shishira Iyar <106435637+shishiraiyar@users.noreply.github.com> Co-authored-by: IndraneelPal <105407886+IndraneelPal@users.noreply.github.com> Co-authored-by: Sushma Reddy <59618780+sush-101@users.noreply.github.com> Co-authored-by: Chenjie Shi Co-authored-by: tadelesh Co-authored-by: Yuchao Yan Co-authored-by: Xinni Tong Co-authored-by: Jiao Di (MSFT) <80496810+v-jiaodi@users.noreply.github.com> Co-authored-by: hvedati <43424696+hvedati@users.noreply.github.com> Co-authored-by: pvsraviteja <67624658+pvsraviteja@users.noreply.github.com> Co-authored-by: Ravi Teja PVS (from Dev Box) Co-authored-by: baheti1409 * Fix PR stale triage: include drafts, run daily (#43642) - Create dedicated pr.stale.yml policy for PR staleness - Remove isNotDraftPullRequest filter so draft PRs get flagged - Change from weekly (Monday) to daily schedule - Remove customer-reported exclusion for PRs - Scope remaining close logic in resourceManagement.yml to issues only - Keep 14+14 day window (28 days total to close) Fixes: PRs like #39226 (draft, 5+ months inactive) never being closed * Remove Rust from ARM KeyVault (#43656) Not yet ready for release. * Update RouteMatrix description for durationTrafficInSeconds (#43613) * fix matrix description * Revert "fix matrix description" This reverts commit 689d3849088ced7d7a99497f063369e0b16cd842. * update * Regenerate Route swagger to match TypeSpec description update Co-authored-by: koyasu221b <5138432+koyasu221b@users.noreply.github.com> * Revert "Regenerate Route swagger to match TypeSpec description update" This reverts commit d20b6063677d6115e66707583188e0476cfe3963. * Update durationTrafficInSeconds description in RouteMatrixItemResult to match route.json --------- Co-authored-by: Will Huang Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: koyasu221b <5138432+koyasu221b@users.noreply.github.com> * Review request for Microsoft.ContainerService/aks to add version stable/2026-04-01 and preview/2026-04-02-preview (#43043) * Adds base for updating Microsoft.ContainerService/aks from version 2026-03-01 to 2026-04-01 and 2026-03-02-preview to 2026-04-02-preview * Add bastion profile for managed bastion to 04-02-preview (#43056) * TSP and swagger * Add example * Fix typespec build * ControlPlaneMetrics: graduate to 2026-04-01 stable (#43320) Migrates PR #41280 (which added ManagedClusterAzureMonitorProfileMetricsControlPlane to 2026-02-02-preview) into the 2026-04 branch by lowering the @added version from v2026_04_02_preview to v2026_04_01, surfacing the field in the 2026-04-01 stable API for the upcoming GA of Managed Prometheus Control Plane Metrics. * Promote IdentityBinding to stable 2026-04-01 (#43327) Co-authored-by: Tom Abraham * Add MaintenanceWindow peer resource to 2026-04-02-preview (#43322) * Add MaintenanceWindow peer resource (2026-04-02-preview) Introduces Microsoft.ContainerService/maintenanceWindows as a resource-group-scoped peer resource alongside managedClusters. Defines the reusable maintenance schedule that can be referenced by maintenance configurations on managed clusters (linking lands in a follow-up). Operations: Get, CreateOrUpdate (LRO), Delete (LRO), List by RG, List by subscription, with examples derived from the approved proposal. * Suppress TrackedResourcePatchOperation for MaintenanceWindowResource Maintenance windows do not expose a separate PATCH endpoint; tags are updated through the createOrUpdate PUT operation. Scoped suppression added to readme.md. * Format MaintenanceWindow.tsp with tsp formatter * Remove stale provisioning-state suppression on MaintenanceWindow The suppression text described using a custom string type for forward compatibility, but provisioningState is typed as the standard Azure.ResourceManager.ResourceProvisioningState enum, so the linter rule is already satisfied and the suppression is unnecessary. --------- Co-authored-by: Ibrahim Aboulfetouh * update (#43525) * Promote agent pool rollback to 2026-04-01 GA (#43524) Promote rollback history and mutable nodeImageVersion from the 2026-04 preview surface into the 2026-04-01 stable API. Co-authored-by: Indu Sridhar Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Address ARM review comments on MaintenanceWindowResource (#43619) - Add sync tags-only PATCH (MaintenanceWindows_UpdateTags) to satisfy RPC-Patch-V1-03 for tracked resources, matching the AKS precedent used by Snapshots, ManagedClusterSnapshots, and ManagedNamespaces. - Remove the TrackedResourcePatchOperation suppression that was added to readme.md; PATCH is now part of the surface. - Tighten utcOffset pattern to bound hours to -14..+14 and minutes to the legal IANA values (00, 15, 30, 45). - Drop underscore from maintenanceWindowName NamePattern to align with ARM resource-name conventions and other AKS peer resources. Co-authored-by: Ibrahim Aboulfetouh * Add missing MaintenanceWindows_UpdateTags example for ModelValidation CI fix (#43629) --------- Co-authored-by: Wei Chen Co-authored-by: David Kydd Co-authored-by: Tom Abraham <38714456+toma3233@users.noreply.github.com> Co-authored-by: Tom Abraham Co-authored-by: ibaboulfetouh Co-authored-by: Ibrahim Aboulfetouh Co-authored-by: InduSridhar Co-authored-by: Indu Sridhar Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix(computelimit): rename C# clientName for FeatureEnableRequest to ComputeLimitFeatureEnableContent (#43664) Resolves .NET SDK linter failure for model names ending in `Request`. Uses @@clientName in client.tsp to rename only for C# SDK, avoiding impact to other language SDKs. * Refreshing OpenAI.v1 spec with latest OpenAI types. (#43440) * Refreshing OpenAI.v1 spec with latest OpenAI types. * cspell * Kaylieee/java 2.1.0 client updates (#43064) * rename evaluator gen ops * remove async from name * revert targetconfig rename * undo rename * rename listsessionfiles * add agents-optimization to agents client, add evaluation-suites, suppress createAgentFromCode * move evaluation suite operations to evaluators, rename * remove evaluationsuites * Revert "remove evaluationsuites" This reverts commit 1e8c4c9ff13811e42d00b897a36b19fa4c95bc4c. * Reapply "remove evaluationsuites" This reverts commit d9ead557066144db5eb1794cc36ac206288aec16. * add evals dependency for agent optimizations * suppress openai outputitem * suppress inputitem * customization for naming collision * Ingest spec 52626 (#43522) * Fix which 'fromCode' method we emit. Thanks Howie! * feat(agents-session-files): add has_more, @list, and optional path to ListSessionFiles (#43280) * Update specification/ai-foundry/data-plane/Foundry/src/agents-session-files/models.tsp * Update specification/ai-foundry/data-plane/Foundry/src/agents-session-files/routes.tsp * fix * missing change * inline page result * Revert "Merge branch 'feature/foundry-release' of https://github.com/Azure/azure-rest-api-specs into feature/foundry-release" This reverts commit 1027f31a437215ae41453cb0b9c184dcc1a5dc56, reversing changes made to f67e0697da58478ee35a4ed96ee6cf3ebbc2dc31. * Move Toolboxes operations back to a .beta client for JS and Python SDKs * Map OpenAI.OutputItem to Record for JS and Python emitters. (#43354) * Remove evaluation suites from JS and Python SDKs (#43356) * Add isolation key header to session crud (#43348) * Add isolation key header to session crud * regen openapi3 --------- Co-authored-by: Gerardo Lecaros <10088504+glecaros@users.noreply.github.com> * Fix typespec (#43316) * Expose CreateAgentFromCodeOptions (#43392) * Add target and input_messages to evaluation suite generation inputs (#43282) * Add target and input_messages to evaluation suite generation inputs - Added optional target field to EvaluationSuiteGenerationJobInputs - Added optional input_messages field (template or item_reference) - Target is stored on the generated suite so it can be run immediately - input_messages defaults to template with {{item.query}} if omitted Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add evaluation_level to generation job inputs Optional field defaults to turn. When set to conversation, dataset generation is skipped and user provides their own multi-turn dataset. Target is required for turn-level but optional for conversation-level. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Clean up doc comments — remove internal implementation details Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Remove level-specific details from target and input_messages docs Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add @removed(Versions.v1) to evaluation suite interfaces for private preview Mark EvaluationSuites and EvaluationSuiteGenerationJobs interfaces as removed from v1 so they remain private preview only and are not included in the public GA surface. Models don't need the tag since they are unreachable without the routes. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Doc string missing defaults. Minor updates to Python surface. (#43431) * Minor TypeSpec, Python & JS renames. Does not affect OpenAPI3 files (#43438) * Add type spec for stop sessions (#43206) * add typespec for stop sessions. * add stop session example. * openai3 * correct verb for stop api. * correct comment structure. * Revert "correct comment structure." This reverts commit 1c5669d081f79ec37bcdd456f1b05d2909f1b474. * update comment decorator, * update spec for stop. * fix comment + regen * updated comment --------- Co-authored-by: Harsheet Shah Co-authored-by: Gerardo Lecaros <10088504+glecaros@users.noreply.github.com> * Remove image and container_protocol_versions from HostedAgentDefinition (#43410) These properties are not part of the v1 (GA) surface. Per review feedback, remove them from the model entirely rather than using @removed(Versions.v1). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Delete specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.yaml,json * Skills API: Versioned Skills aligned with OpenAI and agentskills.io (#43283) * Add versioned Skills API alongside existing flat API Add version support to Skills API mirroring the Toolbox pattern: - SkillVersionObject model for immutable version snapshots - default_version field on SkillObject - New versioned routes: createSkillVersion, listSkillVersions, getSkillVersion, downloadSkillVersion, deleteSkillVersion, updateSkillDefaultVersion, createSkillVersionFromPackage - All existing flat routes preserved Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add versioned Skills API and skill references in Toolboxes Skills API: - Add SkillVersionObject model aligned with OpenAI skills API - Add default_version, latest_version, created_at to SkillObject - New versioned routes: createSkillVersion, listSkillVersions, getSkillVersion, getSkillContent, getSkillVersionContent, updateSkillDefaultVersion, deleteSkillVersion - Use /content pattern (OpenAI-style) instead of :download - All existing flat skill routes preserved Toolboxes: - Add SkillReference model (name + optional version) - Add skills field to CreateToolboxVersionRequest and ToolboxVersionObject - When version is specified, reference is pinned to that immutable version Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Align Skills API with OpenAI format: clean models, remove legacy routes - Replace SkillObject/SkillVersionObject with clean Skill/SkillVersion models - Remove old flat routes (createSkillFromPackage, downloadSkill, updateSkill) - Switch updateSkillDefaultVersion from PATCH to POST (matching OpenAI) - Add files upload to createSkill and createSkillVersion - Remove metadata from create requests - Remove SkillObject clientName mapping Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Align Skills API with OpenAI: remove zip_content/description from create, add SkillsPagedResult, DeleteSkillVersionResponse, type discriminator on SkillReference - Remove zip_content and description from CreateSkillVersionRequest (match OpenAI) - Remove description from CreateSkillVersionMetadata (match OpenAI) - Add independent SkillsPagedResult type for clean SDK naming - Add DeleteSkillVersionResponse with id, deleted, version (match OpenAI) - Add type discriminator to SkillReference for future union extensibility - Update routes to use SkillsPagedResult and DeleteSkillVersionResponse Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add object discriminators, make description required, add agentskills.io fields to inline content - Add object discriminators to SkillsPagedResult, DeleteSkillResponse, DeleteSkillVersionResponse - Make description required on Skill and SkillVersion (matches OpenAI) - Add license and metadata fields to SkillInlineContent (agentskills.io spec) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add id and name to both delete responses for consistency Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Simplify multipart: remove metadata wrapper, add upload behavior docs - Remove CreateSkillVersionMetadata model, make default a top-level form field - Add documentation for zip vs directory upload behavior - Matches OpenAI's flat files + default pattern Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Rename updateSkillDefaultVersion to updateSkill for future extensibility Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Update toolbox skill source model Model toolbox skills as a discriminated base type with a skill reference variant so future skill sources can be added without reshaping the API. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Address skills API review feedback Use the shared paged result type for skills lists, align timestamp modeling with FoundryTimestamp, remove object discriminator fields from skill responses, and make the update request a composed alias. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Address remaining skills review feedback Rename Skill in the Projects Agents SDK customization, document multipart default behavior, and model allowed tools as a string array. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Vishwanath Balaji Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * add missed invocations_ws into AgentProtocol (#43324) Co-authored-by: Yulin Li Co-authored-by: Gerardo Lecaros <10088504+glecaros@users.noreply.github.com> * Agents Optimization Alignment with APIs (#43436) * set latest alignment fields * add multi-turn simulation support (evaluationLevel, DatasetItem scenario fields) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * use shared OpenAI eval types (EvalRunOutputItemResult, EvalRunOutputItemSampleOutput) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * remove duplicate EvaluationLevel union (use shared definition from openai-evaluations) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * remove currentTargetAttribute from progress model Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * remove orphaned models and simplify deploy config types * fix evalModel type to string * flatten request body - remove inputs wrapper to match vienna contract * remove dead response fields and add response-side AgentDefinitionResponse * rename to AgentIdentifier for request, OptimizationAgentDefinition for response * fix response structure: nest inputs in response, flat request body, update create operation * remove read-only visibility from inputs to allow create+read * add 202 Accepted response for GET while job in progress * regen --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Gerardo Lecaros <10088504+glecaros@users.noreply.github.com> * Remove dataset source from data generation jobs (#43448) * Remove dataset source from data generation jobs Removes the DatasetDataGenerationJobSource model and the dataset member of the DataGenerationJobSourceType union in the data generation jobs spec, and regenerates openapi3 outputs. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Remove scenario and type filters from listJobsPreview for data generation jobs Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add Dan to CODEOWNERS (#43017) * remove downloadskill override * remove skillobject override * relocate promote candidate * relocate get candidate --------- Co-authored-by: Darren Cohen <39422044+dargilco@users.noreply.github.com> Co-authored-by: Gerardo Lecaros <10088504+glecaros@users.noreply.github.com> Co-authored-by: Andrew Schonhoffer Co-authored-by: Nikolay Rovinskiy <30440255+nick863@users.noreply.github.com> Co-authored-by: vebudumu <93553661+vebudumu@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Harsheet Shah <50236780+harsheet-shah@users.noreply.github.com> Co-authored-by: Harsheet Shah Co-authored-by: Santhosh Kumar Gunasekaran Co-authored-by: Vincent Biret Co-authored-by: Viswa Balaji <138743504+viswabalaji@users.noreply.github.com> Co-authored-by: Vishwanath Balaji Co-authored-by: Yulin Li Co-authored-by: Yulin Li Co-authored-by: Justin Gonzales <115047469+jugonzales@users.noreply.github.com> Co-authored-by: aprilk-ms <55356546+aprilk-ms@users.noreply.github.com> * Revert "Ingest spec 52626 (#43522)" (#43523) This reverts commit 2b538a263c45694f2fb4a150b1053694360b87f2. * remove downloadskill override * remove skillobject override * relocate promote candidate * relocate get candidate * renames * undo rename * suppress tool type * suppress deleteskillversion * Adding Azure related classes for evals (#43508) * Adding Azure related classes for evals * forced json object * unknown instead of string * remove listsessionfiles rename * rename uri to url * rename fabriciq * rename to blueprintIdentity * rename contentHash to specify method * missing quotes * rename avg to average * deleteskill suppressions * customizations for deletememory * remove async from method name * renames * skill rename --------- Co-authored-by: Darren Cohen <39422044+dargilco@users.noreply.github.com> Co-authored-by: Gerardo Lecaros <10088504+glecaros@users.noreply.github.com> Co-authored-by: Andrew Schonhoffer Co-authored-by: Nikolay Rovinskiy <30440255+nick863@users.noreply.github.com> Co-authored-by: vebudumu <93553661+vebudumu@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Harsheet Shah <50236780+harsheet-shah@users.noreply.github.com> Co-authored-by: Harsheet Shah Co-authored-by: Santhosh Kumar Gunasekaran Co-authored-by: Vincent Biret Co-authored-by: Viswa Balaji <138743504+viswabalaji@users.noreply.github.com> Co-authored-by: Vishwanath Balaji Co-authored-by: Yulin Li Co-authored-by: Yulin Li Co-authored-by: Justin Gonzales <115047469+jugonzales@users.noreply.github.com> Co-authored-by: aprilk-ms <55356546+aprilk-ms@users.noreply.github.com> Co-authored-by: Jose Alvarez * Vikeshi26/arm leases 2026 05 28 partner prs (#43669) * Add ARM modeling leases for networksecurity/agentFabric and privatetrafficmanager * Add ARM modeling leases for partner PRs (Monitor/Agents, KubernetesConfiguration/kubeInventory, Embr, Copilot/CopilotManagement) --------- Co-authored-by: Vikeshi Tiwari Co-authored-by: Tejaswi Salaigari * Cleanup client.tsp file (#43670) * Format using `npx tsp format **/*tsp` * [VoiceLive]Add client name overrides for VoiceLive types and properties for Java (#43358) * Add Java client name overrides for VoiceLive types and properties * Add JS client name overrides for VoiceLive duration/offset properties * Rename Java token usage accessors to counts * Pin Java SDK generation to GA API version * format --------- Co-authored-by: Yulin Li * Re-run `npx tsp format **/*tsp` after merge from Main to get updated tools * Ejiji/voicelive main api version pin (#43668) * Pin VoiceLive C#, HTTP C#, and Java emitters to 2026-04-10 * name changes * Update tspconfig.yaml * test removal of child id * update schemas * add customization to sdk --------- Co-authored-by: Emily Jiji * Remove Java api-version from tspconfig.yaml (#43677) * [JS] Update config to mitigate sdk breaking change (#43675) * update config * update config * update config * Fix emitter-output-dir formatting in tspconfig.yaml * Update tspconfig.yaml * Fix formatting in tspconfig.yaml * update * [sql] Update client.tsp (#43573) * Update client.tsp * Update client.tsp * Mitigate Python SDK breaking changes for azure-mgmt-devhub (#43681) * [HorizonDB] Change namespace casing in examples (#43640) * Change namespace casing and location in examples * Update namespace casing for HorizonDb examples * Revert location * Remove sourceClusterResourceId from Clusters_CreateOrUpdate example * Update fully qualified domain names in HorizonDB examples * Update zonePlacementPolicy to BestEffort in HorizonDB examples * Fix resource provider naming inconsistencies in HorizonDb examples - Updated resource provider names from "Microsoft.HorizonDB" to "Microsoft.HorizonDb" in various example JSON files for consistency. - Modified resource IDs in examples for Clusters, FirewallRules, ParameterGroups, Pools, PrivateEndpointConnections, and Replicas to reflect the correct casing. - Ensured that all example responses and requests align with the updated naming conventions. * Fix casing inconsistencies for HorizonDB in API documentation and models * Fix resource type casing in HorizonDb examples to use consistent casing for Microsoft.HorizonDb * Add CognitiveServices stable API version 2026-05-01 (#42549) * Add CognitiveServices stable API version 2026-03-01 - Add v2026_03_01 to version enum in main.tsp - Copy TypeSpec examples from 2026-01-15-preview, update api-version - Compile TypeSpec to generate cognitiveservices.json (88 paths, 290 defs) - Generated RM examples (160 files, all referenced, zero orphans) - Update readme.md: default tag to package-2026-03-01, add tag section - Single-track versioning: all preview features promoted to stable - New vs prev stable: +1 path (ComputeOperations), +6 definitions * Gate preview-only features from 2026-03-01 stable with @removed decorators Add @removed(Versions.v2026_03_01) to 13 features first introduced in 2026-01-15-preview that should remain preview-only: ComputeOperation.tsp (4): ComputeOperationStatus model, ComputeOperations interface, ComputeOperationStatusProperties model, ComputeOperationStatusType union ManagedNetworkSettingsPropertiesBasicResource.tsp (1): delete operation models.tsp (8): QuotaScopeType union, foundryAutoUpgrade property, FoundryAutoUpgradeMode union, FoundryAutoUpgrade model, scopeType/scopeId on Usage, scopeId/scopeType on ModelSkuCapacityProperties Cascading changes: - Remove 14 TypeSpec examples (2 removed ops + 12 scope-variants) - Remove 14 RM examples (matching orphaned references) - Clean scopeType/scopeId from 4 base examples - Remove NestedResourcesMustHaveListOperation suppression - Recompile: 87 paths, 284 defs (down from 88/290) * Add CognitiveServices preview API version 2026-03-15-preview swagger Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Recompile 2026-03-15-preview swagger after customTopics removal Merge main to pick up @removed(Versions.v2025_10_01_preview) decorators for customTopics, CustomTopicConfig, and RaiTopicConfig from PR #42012. Recompile to remove these definitions from 2026-03-15-preview output. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * add accelerator usages API details * add changes as per PR * accelerator usage api changes * add accelerator change * add format for subs id * Revert AcceleratorUsages API changes from PR #42466 (#42469) Reverts commits 9bd196e..0cca7e2 which added AcceleratorUsages operation and models directly to swagger JSON. These changes need to be re-added properly via TypeSpec source files. * Users/chunyli/cogsvc managed compute deployment (#42130) * Add ManagedCompute deployment API * mark model as non-required * fix gated error * fix unknown word * Add example * check in generated examples * update spec * fix lint * resolve comments * resolve comments * resolve comments * resolve comments * fix lint * fix lint * fix format * resolve comments * switch from AcceleratorDeployment to ManagedComputeDeployment * update suppresion * resolve comments * Add CognitiveServices stable API version 2026-05-01 TypeSpec enum, compiled cognitiveservices.json, examples, readme.md tag section. Feature gating: 13 existing @removed/@added pairs extended to triplets, 7 new @removed(v2026_05_01) for ManagedComputeDeployment + PatchResourceSku (kept preview-only per user decision). 7 orphaned examples cleaned. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Regenerate stable/2026-05-01 with TSP 1.12 + Phase 3 QuotaScopeType cleanup Phase 2: Regenerated cognitiveservices.json from merged TypeSpec source using @typespec/compiler 1.12.0. Picks up changes from interim PRs: - VmManagedCompute deployment shape (#43238) — computeId, priority, deploymentTemplate type - New compute surface: Compute, ManagedComputeCapacity, ContainerInstance, ComputeProvisioningState (#42324, #42642, #42794) - Model-Router enum correction accuracy->quality (#42375) - x-ms-pageable on batchOutboundRules POST (#42435) - RaiExternalSafetyProvider 201 response fix (#42414) - DELETE managedNetworks promotion to stable (#42585) — restores GA operation that was incorrectly gated out of stable/2026-05-01 by the swagger-agent's lone-@removed fallback bug Regression audit vs previous stable (2026-03-01): 0 operation regressions, 0 definition regressions, 0 property regressions, 0 enum value regressions. 19 new operations and 29 new definitions added — all need GA feature-confirmation with owners in a follow-up step. Phase 3: QuotaScopeType example cleanup. The TSP recompile already deleted the 12 orphan scope-variant files automatically. Stripped remaining scopeType/scopeId properties from the 4 base example response bodies in both TSP source and RM output: - GetUsages.json, ListUsages.json - ListModelCapacities.json, ListLocationBasedModelCapacities.json This resolves the 26 OBJECT_ADDITIONAL_PROPERTIES Swagger ModelValidation errors. Verification: - All 138 RM example files referenced by x-ms-examples (0 orphans) - All 138 TSP source examples referenced by x-ms-examples (0 orphans) - Zero scopeType/scopeId occurrences in any base example file Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Phase 3 fix: delete 12 QuotaScopeType scope-variant example files Previous Phase 3 attempt only stripped scopeType/scopeId from base example response bodies but left the 12 scope-variant example files in the TSP source examples/2026-05-01/ directory. The TypeSpec compiler auto-discovers any .json file in the version examples directory by its operationId field and emits x-ms-examples references, causing the files to be copied to RM output and validated against the schema. Since QuotaScopeType is gated out of stable/2026-05-01, the response bodies in these examples contain properties not allowed by the schema, causing 26 OBJECT_ADDITIONAL_PROPERTIES Swagger ModelValidation errors. Deleted from TSP source (compiler-managed copy to RM output handled by clean rebuild): - GetUsages{Classic,DataZone,Global}Scope.json - ListUsages{Classic,DataZone,Global}Scope.json - ListModelCapacities{Classic,DataZone,Global}Scope.json - ListLocationBasedModelCapacities{Classic,DataZone,Global}Scope.json After clean rebuild of stable/2026-05-01 RM directory: zero scope- variant references in compiled swagger, zero scopeType/scopeId in remaining base examples. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Sync new stable suppressions block with previous preview The swagger-agent skill (sub-skill-swagger.md Step 7) directs new tag sections to copy the previous tag of the same TRACK (stable->stable, preview->preview). For CognitiveServices this is inconsistent with its own content-flow rule: CogSvc is single-track, so new stable inherits content from previous preview. The result was that new stable 2026-05-01 inherited preview content (Compute, Workbench, ManagedCompute*, EvaluateDeploymentPolicies, additional PATCH/DELETE paths) but only the previous-stable suppression block (17 entries), dropping 4 net new codes and several path extensions added in preview. This commit replaces the new stable's suppressions block with the previous preview's block (21 entries). Manual diff confirmed the preview block is a strict superset in path coverage with no entries unique to the previous stable — every 'stable-only' entry has a matching preview entry with broader 'where:' lists or more detailed 'reason:' text. Net effect: - +NestedResourcesMustHaveListOperation (ComputeOperationStatus) - +RequiredPropertiesMissingInResourceModel (ManagedComputeUsageListResult) - +AvoidAdditionalProperties (EvaluateDeploymentPoliciesResponse.results) - +PatchBodyParametersSchema for Workbench - PatchBodyParametersSchema 'where' extended (+4 paths: managedComputeDeployments, computes, computes.computeType, computes.schema) - DeleteResponseCodes 'where' extended (+managedComputeDeployments) - More-detailed reasons on ProvisioningStateSpecifiedForLROPut and 2x AvoidAdditionalProperties Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add missing example files for ops inherited from preview via merge After the main merge brought new operations into the new stable (Computes_*, Workbenches_*, ManagedComputeUsagesOperationGroup_List, ManagedComputeCapacities_List, Accounts_EvaluateDeploymentPolicies, plus restored ManagedNetworkSettings_Delete and Projects_Delete from prior commit), 20 operations had no x-ms-examples in the compiled stable swagger, triggering 22 XMS_EXAMPLE_NOTFOUND_ERROR violations in Swagger ModelValidation. The TypeSpec compiler auto-discovers example files in the version's examples// directory by matching the file's operationId field. Example files for these operations existed in examples/2026-03-15-preview/ but not in examples/2026-05-01/. Copied 22 example files from the preview version directory to the new stable version directory and updated their api-version field from 2026-03-15-preview to 2026-05-01: ListManagedComputeUsages, ListManagedComputeCapacities, ListComputes, GetCompute, GetContainerInstanceCompute, PutCompute, PutContainerInstanceCompute, UpdateCompute, DeleteCompute, RestartContainerInstanceCompute, StartContainerInstanceCompute, StopContainerInstanceCompute, EvaluateDeploymentPolicies, ListWorkbenches, GetWorkbench, PutWorkbench, UpdateWorkbench, DeleteWorkbench, RestartWorkbench, StartWorkbench, StopWorkbench, ManagedNetwork/deleteManagedNetworkV2 After clean rebuild: 0 operations missing examples in compiled swagger. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Gate preview-only features out of 2026-05-01 stable Per direction: features first introduced in 2026-03-15-preview should not graduate to stable in this cycle. The new stable 2026-05-01 should be content-identical to the previous stable 2026-03-01 (since the original PR (2026-04-21) had no new GA-approved additions beyond 2026-03-01, and all subsequent additions to preview during the 38-day PR lifespan are preview-only). Added @removed(Versions.v2026_05_01) decorators to 32 elements: models.tsp (26 entries): ClusterComputeProperties, ComputeListResult, ComputeProperties, ComputeProvisioningState, ComputeType, ConnectivityEndpoints, ContainerInstanceComputeProperties, DeploymentPolicyEvaluationResult, DeploymentSizeCapacity, EvaluateDeploymentPoliciesDeployment, EvaluateDeploymentPoliciesDeploymentProperties, EvaluateDeploymentPoliciesRequest, EvaluateDeploymentPoliciesResponse, ManagedComputeCapacityListResult, ManagedComputeCapacityProperties, ManagedComputeDeploymentInfo, ManagedComputeUsage, ManagedComputeUsageListResult, PolicyAssignmentEvaluationDetails, PolicyEvaluationOutcome, PolicyExpressionEvaluationDetails, Pool, SshSettings, VmPriority, WorkbenchListResult, WorkbenchProperties Compute.tsp: Compute model + Computes interface Workbench.tsp: Workbench model + Workbenches interface ManagedComputeCapacity.tsp: ManagedComputeCapacity model + ManagedComputeCapacities interface ManagedComputeUsages.tsp: ManagedComputeUsagesOperationGroup interface Account.tsp: evaluateDeploymentPolicies operation All decorators placed immediately after the existing @added(Versions.v2026_03_15_preview) per agent decorator-ordering rule. After clean rebuild: 2026-03-01 stable: 87 paths, 280 defs, 145 ops 2026-05-01 stable: 87 paths, 280 defs, 145 ops Delta ops/defs/paths: 0/0/0 — content-identical to 2026-03-01 Cleanup: - Deleted 21 example files for now-gated operations (Compute, Workbench, ManagedComputeCapacities, ManagedComputeUsages, EvaluateDeploymentPolicies) from both TSP source and RM output. Final example count: 127 = 127 refs. - Reverted readme.md package-2026-05-01 suppressions to the 17-entry set from package-2026-03-01 (the 21-entry preview set is no longer needed because the content those entries suppressed is gated out). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add missing 200 response to Projects_Delete example The Projects_Delete operation defines response codes 200, 202, 204, and default in the swagger spec, but the DeleteProject.json example only included 202 and 204. This caused Swagger ModelValidation error RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE for the 200 response code. The previous stable 2026-03-01's DeleteProject.json example does include 200 as an empty body response. Restored the 200 entry to match the 2026-03-01 example structure. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: abpatelmicrosoft Co-authored-by: Chunyu Li <79233053+ChunyuMSFT@users.noreply.github.com> Co-authored-by: Swagger Agent * DurableTask: refactor main.tsp into per-resource files and add 2026-05-01-preview API version (#43673) Adds transparentDataEncryptions resource type, capabilities on TaskHubs, and managed identity support on Schedulers (plus a restart action). Existing API versions and model names are preserved as-is. Co-authored-by: Bernd Verst Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * [Storage Datalake] go updates (#43398) * datalake-go * go datalake * expiresOn * expires on * datalake updates * format * suppressions for batch SDK building * fix suppressions * add missing sub-rules --------- Co-authored-by: Joel Hendrix * Add trailing newline (#43697) Co-authored-by: Vikeshi Tiwari Co-authored-by: Tejaswi Salaigari * Added impotant note regarding attribution as per TASK 13698157. (#43617) * Update fetching of installation ID (#43699) Co-authored-by: Chidozie Ononiwu * feat(ai-foundry/eval-rules): add samplingRate to ContinuousEvaluationRuleAction (#43626) * feat(ai-foundry/eval-rules): add samplingRate to ContinuousEvaluationRuleAction Adds an optional `samplingRate` (float64, percentage in (0, 100]) on `ContinuousEvaluationRuleAction`. When set, each matching event has this percentage chance of triggering an evaluation; when omitted, every event is evaluated (equivalent to 100). To disable the rule entirely, callers should set `enabled` to false rather than `samplingRate: 0` (which is rejected by the service). Mirrors the existing server-side validation in RAISvc: if (rate <= 0 || rate > 100) -> 400 BadRequest Regenerated v1 + virtual-public-preview openapi3 (.json and .yaml) via `npx tsp compile .`. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix(ai-foundry/eval-rules): set samplingRate default to 100 and clarify doc Addresses review feedback on PR #43626 from @dargilco. Since the Foundry RAI evaluation service treats an omitted samplingRate as full sampling (equivalent to 100), express that explicitly in the TypeSpec contract by adding a default of 100 and updating the docstring to call out the service-side behavior. Regenerated openapi3 outputs from `specification/ai-foundry/data-plane/Foundry`. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * [Search] Add API version to tspconfig (#43695) * [Search] Add API version to tspconfig * Add small comment * Fix Java hostname client name for ManagedNetworkFabric (#43703) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Update client.tsp (#43709) * Mitigate Python SDK breaking changes for azure-mgmt-hdinsight (#43705) * Mitigate Python SDK breaking changes for azure-mgmt-healthcareapis (#43704) * [Python] Mitigate breaking changes for azure-mgmt-managednetworkfabric (#43710) * Mitigate Python SDK breaking changes for azure-mgmt-managednetworkfabric * Update client.tsp * [JS] Mitigate breaking change for refresh SDK (#43707) * update config * update * update * update * Fix ComputeBulkActions C# SDK customizations (#43683) * chore: updates @azure-tools/openai-typespec (#43489) * chore: updates @azure-tools/openai-typespec package to its latest version chore: updates openai typespec definitions to 1.18 chore: switches to save exact command * docs: add READMEs for Foundry openapi3 v1 and virtual-public-preview Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> fix: rename Foundry openapi3 README.md to lowercase readme.md for Avocado Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * chore: add BYOT and MCPHTTP to ai-foundry cspell words Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * chore: refreshes generated files * Revert "docs: add READMEs for Foundry openapi3 v1 and virtual-public-preview" This reverts commit f79aed2ac46d23cf730f82ea57e0654d101ecfd6. * chore: updates openai typespec definitions to 1.19 --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Update storage blob spec to v2 folder structure (#43700) * update blob spec to v2 folder structure * nit * clean up old readme --------- Co-authored-by: catalinaperalta * fix tsp project readmes (#43701) Co-authored-by: catalinaperalta * Add owners for files under `/.github/agents/protocols/` (#43702) * Update CODEOWNERS to include additional ARM API reviewer paths * Add placeholder for ARM API Reviewer protocols to satisfy CODEOWNERS requirements * Apply suggestion from @mikeharder Co-authored-by: Mike Harder * Fix alignment * Remove ARM protocol placeholder file after merging related PR --------- Co-authored-by: Mike Harder * Vikeshi26/arm lease purestorage block root (#43717) * PureStorage.Block: add RP-root lease (covers preview/ swagger output) for partner PR #28790 * Add service-scoped ARM leases for partner PRs 28785 (CloudLicensing), 43639 (CleanRoom), 41651 (Migrate/ContainerAppsAssessments) --------- Co-authored-by: Vikeshi Tiwari Co-authored-by: Tejaswi Salaigari * Add ARM API Review Critic agent (#43494) * feat(evals): Enhance ARM API Reviewer evaluations with new tests and fixtures - Added three new evaluation files: eval-fast-path-triage.yaml, eval-suppressions-yaml.yaml, and eval-report-format.yaml. - Updated README.md to reflect the addition of new evaluation files and increased test case counts from 35 to 41. - Introduced new test cases for fast-path triage, suppressions.yaml continuity, and report format validation. - Created fixtures for suppressions.yaml tests, including scenarios for missing reasons and vague justifications for security rules. - Improved existing evaluation definitions to ensure comprehensive coverage of ARM API Reviewer functionality. * fix(evals): Update regex pattern for breaking change analysis in fast-path evaluation * Refactor PR resolution rules and enhance review process documentation - Updated PR resolution rules for clarity and consistency in formatting. - Added a new step for API Graph & Data-Flow Analysis to improve systemic problem detection. - Introduced multi-perspective reviewer passes to enhance review quality. - Clarified cleanup procedures and emphasized mandatory cleanup after reviews. - Improved language for better readability and understanding throughout the document. * docs: Update ARM API Review Critic description and clarify agent topology in documentation * docs: Update comment tracking marker format and add metadata fields for Copilot Code Review * Ignore 'amplihack' * Add supported repositories section and clarify tooling prerequisites for ARM API Review Critic * Instruction for resolving an existing conversation * Use same commit SHA for Reviewer and Critic * Include PR title in report * Check existing comments before presenting report. * Fix a couple inconsistencies * Fix format * Enhance ARM API Reviewer and Critic documentation with new validation rules and constraints * Add Reviewer <-> Critic Protocol documentation * Input validation and session-handoff verification in Reviewer and Critic protocols * Add README documentation for agents and update ARM API Reviewer agent formatting * Instructions for UUID/GUID handling * Add downstream-CI impact verification steps to Reviewer and Critic protocols * Refactor Reviewer-Critic Protocol and Update Evaluation Instructions - Enhanced the Reviewer-Critic Protocol documentation for clarity and consistency, including updates to the glossary and input requirements. - Revised instructions for the ARM API Reviewer to ensure byte-for-byte parity in posted findings and added requirements for telemetry markers. - Updated OpenAPI review instructions to clarify the handling of `systemData` properties. - Introduced new evaluation files for protocol safety tests, focusing on subagent fallback behavior and session invalidation. - Adjusted evaluation scripts and README files to reflect changes in test categories and suite descriptions. - Improved documentation for the API reviewer agent, detailing the handling of review comments and the evaluation suite. * Enhance validation instructions for LintDiff suppression paths in Reviewer and Critic protocols * Update timeout values in evaluation YAML files to include 's' suffix for seconds * Refactor reviewer-critic protocol documentation and add new reference on graph analysis - Updated the reviewer-critic protocol documentation to clarify the requirements for Inputs #7 and #8 on iteration 1, emphasizing the need for explicit empty lists. - Added a new reference document "Think in Graphs Before Lists" to explain the importance of graph artifacts in API reviews, detailing the required views and findings that emerge from graph analysis. - Standardized timeout values in various evaluation YAML files to use double quotes for consistency. * Update Reviewer-Critic protocol references to use consistent file naming * Enhance evaluation scripts with repeat functionality and stability checks - Added parameters to run the evaluation suite multiple times with cooldowns between runs to verify stability and detect flaky stimuli. - Updated output to include detailed summaries for each run and an aggregate summary when multiple runs are executed. - Improved grading logic in eval-typespec-required.yaml to clarify acceptable mentions of TSP-REQUIRED-V1 in compliance tables. * Refactor prompts in eval-protocol-safety.yaml * Refactor prompts in eval-citation-and-parity.yaml and eval-protocol-safety.yaml * Refactor configuration keys to defaults in evaluation YAML files * Enhance ARM API Reviewer and evaluation scripts with detailed decision procedures and pattern matching improvements * Add evaluation configurations for ARM API reviewer - Introduced eval-report-format.yaml to validate reviewer output structure and content. - Created eval-suppressions-yaml.yaml to ensure suppressions in YAML files are justified. - Added eval-suppressions.yaml for suppression analysis in README files. - Implemented eval-true-negatives.yaml to confirm no false positives on compliant specs. - Developed eval-typespec-required.yaml to enforce TypeSpec requirements for new API versions. - Established eval-typespec.yaml for detecting TypeSpec-specific violations and anti-patterns. - Updated cspell.yaml to include new terms related to the evaluation suite. - Revised api-reviewer-agent.md to reflect changes in evaluation framework and terminology. * Update README and cspell configuration for ARM API Reviewer eval suite enhancements * Enhance ARM API Reviewer evaluation scripts with additional output validation checks and improved reporting requirements * Add posting-hygiene scan for autolink hazards in ARM API Reviewer * Update subagent content ownership and session-handoff * Refine evaluation patterns in ARM API Reviewer for improved rule ID detection and reporting accuracy * Enhance ARM API Reviewer and Critic Protocols - Updated the ARM API Reviewer agent documentation to clarify the use of `web/githubRepo` as a fallback for public repositories and adjusted the iteration limit for the Mandatory Critic Review step from 5 to 3. - Improved the skipped-rules invariant section for clarity and added emphasis on the importance of consulting the skipped-rules list in subsequent steps. - Enhanced the Step 4.5 Downstream-CI Impact Check description to clarify the relationship between proposed fixes and LintDiff rules. - Revised the existing-comment fetch process to specify the use of GraphQL for fetching review threads and detailed the required thread ID information. - Updated the Critic protocol to enforce a canonical input-block serialization format for inputs and added a new Critic-verdict marker for better auditing. - Standardized the Reviewer-Posted Parity section across multiple instruction files to ensure consistency in the requirement for byte-for-byte identical findings between chat and posted comments. * Refine template rendering tests in protocol safety evaluations for improved clarity and fidelity * Enhance pattern matching for reviewer-posted parity to include markdown table classifications * Refine failure recovery procedures in ARM API Reviewer for enhanced clarity and accuracy * Consolidate reviewer-posted parity instructions across multiple files - Updated `.github/instructions/armapi-review.instructions.md`, `.github/instructions/openapi-review.instructions.md`, and `.github/instructions/typespec-review.instructions.md` to reference a single source of truth for reviewer-posted parity rules, reducing duplication and potential drift. - Introduced a new reference file `.github/skills/azure-api-review/references/reviewer-posted-parity.md` containing the consolidated hard rules for reviewer-posted parity. - Added a new reference file `.github/skills/azure-api-review/references/downstream-ci-impact.md` detailing the downstream CI impact check procedure. - Revised the severity guidance for example coverage in `.github/skills/azure-api-review/references/example-quality.md`. - Updated guidance on GUID/UUID usage in ARM specifications in `.github/skills/azure-api-review/references/guid-and-uuid-on-arm.md` to reflect recent rule reversals. - Enhanced documentation in `documentation/api-reviewer-agent.md` regarding the agent's handling of PR references and structural graph derivation failures. - Added size guardrails for graph rendering in `.github/skills/azure-api-review/references/think-in-graphs.md` to improve readability and manageability of large resource graphs. * Refine anti-patterns documentation and clarify critic verdict marker requirements in protocols * Fix format * Add guidelines for recommending removal of existing suppressions in suppression review criteria * Add 'arm-' prefix * Fix references to ARM API review instructions by updating file names from `armapi-review.instructions.md` to `arm-api-review.instructions.md` across multiple documentation files. This includes updates in instruction files, README, design decisions, linter rule coverage, and evaluation YAML files to ensure consistency and accuracy in rule citations. * Move supression into the file --------- Co-authored-by: Ravi Eda * Update release plan and package release skill to support release plan… (#43727) * Update release plan and package release skill to support release plan creation and update use cases * VL typespec changes(#43729) Co-authored-by: Emily Jiji * Fleet: rename types/properties for .NET SDK per review feedback (PR azure-sdk-for-net#59493) (#43708) * Fleet: rename types/properties for .NET SDK per review feedback (PR azure-sdk-for-net#59493) * tsp format * npx tsv . * Fleet: rename ManagedNamespaceProperties to ContainerServiceFleetManagedNamespaceProperties for .NET * Monitor: set Python client name to MonitorWorkspacesMgmtClient (#43731) * [operationalinsights] Update client.tsp (#43711) * Update client.tsp * Update tspconfig.yaml * [JS] Update operation name (#43732) * NetworkSecurityPerimeter SyStemData Replace (#43581) * fix * delete * Revert "fix" This reverts commit 36c51f33723dd0b1f06731a7ad19a39817271d4a. * update CreatedByType * Revert "delete" This reverts commit e935585f19de7f08aed49b1854c213422c2ce7c8. * Revert "update CreatedByType" This reverts commit da4463a6387dc58022409b6d609a0580a8a7b164. * replace SecurityPerimeterSystemData * added * fix * remove clientname * Napster: update tspconfig SDK namespace to NapsterOmniagentApi (#43635) * Napster: update tspconfig SDK namespace to NapsterOmniagentApi * Napster: add cspell overrides for new SDK namespace words * [operationinsights] Update client.tsp (#43736) * Update client.tsp * Update client.tsp * ComputeSchedule: remove python from RecurringActionsResourceOperationResult client name (#43739) * Added secret annotations for all affected fields (#43533) * Added secret anotation * Add visibility annotation to apiSecret in KafkaAzureBlobStorageSinkConnectorInfo model * Remove sensitive storage account key from Azure Blob Storage connector examples and models * Remove sensitive API keys from examples and models, and mark apiKey as secret * Mitigate Python SDK breaking changes for azure-mgmt-managednetworkfabric (#43743) * visibility workaround for cloudhealth (#43744) * Remove api spec definition of decommissioned RP Microsoft.VoiceServices (#43638) * Foundry: add a local skill for consistent summary/description in OAS3 emission (#43558) * initial pass: add and apply a skill for summary/description breakout * cleanup: no root agency.toml change * missing summary tags; skill, heal thyself * merge again * re-run skill with more careful pass * more comprehensive summary/description pass --------- Signed-off-by: Vincent Biret Co-authored-by: Vincent Biret * fix: avoid multiple any of entries for different response bodies in responses API (#43662) * fix: avoid multiple any of entries for different response bodies in responses API Signed-off-by: Vincent Biret * warnings, getResponse, format --------- Signed-off-by: Vincent Biret Co-authored-by: Travis Wilson * fix: use range for error responses in foundry (#43493) * fix: use ranges for error responses instead of default Signed-off-by: Vincent Biret * fix: use range error for datasets operation Signed-off-by: Vincent Biret * chore: refreshes generated assets Signed-off-by: Vincent Biret * chore: refactors error definition to avoid duplication Signed-off-by: Vincent Biret * fix: use FoundryAzureOperations for resource operations Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * chore: refresh Foundry OpenAPI descriptions Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix(ai-foundry): use range errors for version list operations Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * chore(ai-foundry): refresh version list descriptions Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix(ai-foundry): use range errors for Foundry resource operations Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * chore(ai-foundry): refresh resource operation descriptions Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix(ai-foundry): centralize range error operation templates Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix(ai-foundry): use range errors for OpenAI operations Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * chore(ai-foundry): refresh OpenAI operation descriptions Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Signed-off-by: Vincent Biret Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix: bad merge for see inline schema fix * chore: refreshes generated assets * fix: summary fix for delete toolbox after re-run of the skill * [ADU] Add 2026-06-01 API Version with DownloadSecurity field on Deployment (#43219) * Add 2026-06-01 API version with downloadSecurity field on Deployment Introduces a new data-plane API version 2026-06-01 that adds an optional downloadSecurity field to the Deployment model. The field is an extensible enum (https | http) defaulting to https, gated by @added so the 2022-10-01 GA contract is unchanged. * fix validation --------- Co-authored-by: Lawrence Onyango * Add two enums Support Channel and ChatConversationStatus to enable Persistent chat (#43591) * Add two enums Support Channel and ChatConversationStatus to enable Persistent Chat * Add suppression for promoted preview swagger * Address ARM review feedback: PascalCase operationIds, remove None from ChatConversationStatus * fix: operations get concatenated descriptions and summaries (#43661) * fix: adds summary and description overrides for skill version operations * Adding extension annotation to create agent, update agent, and create agent version variants. * improve override summary/descs for agents * fix: aligns values Signed-off-by: Vincent Biret * chore: refreshes generated assets Signed-off-by: Vincent Biret * fix: description alignment Signed-off-by: Vincent Biret --------- Signed-off-by: Vincent Biret Co-authored-by: Gerardo Lecaros <10088504+glecaros@users.noreply.github.com> Co-authored-by: Travis Wilson * update naming for .Net (#43758) * Suppress no-override-props linter violations in Microsoft.Security/SecuritySolutionsAPI (#43657) * Suppress arm-no-replace-inherited-props violations in Microsoft.Security/SecuritySolutionsAPI Add #suppress directives for the new arm-no-replace-inherited-props linter rule on three models (CefExternalSecuritySolution, AtaExternalSecuritySolution, AadExternalSecuritySolution) that intentionally redefine the 'properties' field with a more specific type. Related: https://github.com/Azure/typespec-azure/pull/4384 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Update SecuritySolutionsAPI suppressions to no-override-props Co-authored-by: markcowl <1054056+markcowl@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> * Release microsoft.key vault 2026 05 01 preview (#41010) * Add ML-DSA preview and bump version to 2026-05-01-preview for KeyVault * Adding externalmu and context support * fix: update descriptions to be version-neutral and regenerate keys.json * fix: regenerate certificates.json to match TypeSpec source --------- Co-authored-by: Rupinder Sahi * Sync eng/common directory with azure-sdk-tools for PR 15837 (#43765) * Support PR metadata update * Removed verbose log --------- Co-authored-by: Ray Chen * Refresh OpenAPI3 files, from running `npx tsp compile .` * [SDK Generation] Updating SDK PR metadata if the PR already exists (#43768) * Support PR metadata update * Correct values * Reverted changes to eng/common files * [CosmosDB] Add C# mgmt emitter config and @@clientName decorators (#41308) * Add .github/shared/readme.md with API reference and structure docs (#43719) Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: mikeharder <9459391+mikeharder@users.noreply.github.com> * Sync eng/common directory with azure-sdk-tools for PR 15908 (#43774) * Bump fast-uri to 3.1.2 to fix path traversal (GHSA-q3j6-qgpj-74h6) Co-authored-by: mikeharder <9459391+mikeharder@users.noreply.github.com> * Revert package.json override; bump fast-uri directly in package-lock.json Co-authored-by: mikeharder <9459391+mikeharder@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: mikeharder <9459391+mikeharder@users.noreply.github.com> * Re-org client files (#43750) * Add naming operation for Horizon DB onboarding (#43784) * Add ARM leases for partner PRs 43780 (MongoDB.Atlas root), 43777 (Postgres PostgreSql svc), 43606 (KubernetesConfiguration/upgradeAssessment), 28816 (EncryptedTransport svc) (#43785) Co-authored-by: Vikeshi Tiwari * fix: update memory store endpoints in foundry-features-flag-summary.md (#43788) * update api version (#43790) Co-authored-by: Emily Jiji * feat(ai-foundry/evaluators): add supported_evaluation_levels + List evaluator generation jobs propagation note (#43667) * feat(ai-foundry/evaluators): add supported_evaluation_levels + List propagation note Two related evaluator-API changes: 1. Add ``supported_evaluation_levels?: EvaluationLevel[]`` to ``EvaluatorVersion`` to mirror the service-side contract in Vienna's RAISvc evaluator models (``Evaluator`` / ``CreateEvaluatorRequest`` / ``UpdateEvaluatorRequest`` in ``RAISvc/Contracts/Evaluations/Evaluators.cs``). - Read: always present; service defaults to ``[turn]`` when none are set. - Create: optional; omitted -> service defaults to ``[turn]``. - Update: optional; omitted -> no change. Empty list rejected. - Custom code-based evaluators support only ``turn``; custom prompt-based evaluators support exactly one level (``turn`` or ``conversation``). Reuses the existing ``EvaluationLevel`` union from ``openai-evaluations/models.tsp`` (same ``Azure.AI.Projects`` namespace). 2. Note in the ``EvaluatorGenerationJobs.list`` docstring that the List API has up to a few seconds of propagation delay; recently created jobs may not appear immediately. Callers should use the Get API with the job ID for a specific job without delay. Regenerated openapi3 outputs via ``npx tsp compile .`` from ``specification/ai-foundry/data-plane/Foundry``. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Apply suggestion from @glecaros Co-authored-by: Gerardo Lecaros <10088504+glecaros@users.noreply.github.com> * chore(ai-foundry/evaluators): regenerate openapi3 after glecaros suggestion The suggestion in dc91dc3c6e8 added `= #[EvaluationLevel.turn]` as the default for `supported_evaluation_levels` but did not include the regenerated openapi3 artifacts. This commit refreshes them so the schema emits `default: [turn]` consistently across the Create / Read / Update views. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Gerardo Lecaros <10088504+glecaros@users.noreply.github.com> * Pin Search SDK api-version to 2026-04-01 (#43772) Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: efrainretana <141282336+efrainretana@users.noreply.github.com> * Compile client.tsp and compile typespec (#43800) * Add README.md for eng/tools/suppressions (#43783) * Add README.md to eng/tools/suppressions Co-authored-by: mikeharder <9459391+mikeharder@users.noreply.github.com> * Replace TypeSpecValidation example with a real-world case Co-authored-by: mikeharder <9459391+mikeharder@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: mikeharder <9459391+mikeharder@users.noreply.github.com> Co-authored-by: Mike Harder * Remove the line non-needed anymore (#43799) * [JS] Update operation group name (#43738) * update * update * update * update * update * Revert "update" This reverts commit 7953b92a231af54c30164ceb1bcc8d12fc229893. * Fix DeveloperHub CSharp emitter config Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix SQL CSharp emitter config Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Remove SQL CSharp emitter config Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix .NET SDK validation configs Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Format DeveloperHub TypeSpec customizations Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Split SQL changes out of PR Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: kazrael2119 <98569699+kazrael2119@users.noreply.github.com> Co-authored-by: Wei Hu Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * [JS] Mitigate JS sdk breaking change (#43778) * Split SQL operation group customizations (#43807) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Update tspconfig.yaml (#43808) * Update client settings of CloudHealth for csharp (#43804) * Upcate client settings of Monitor.Worksapces for .Net SDK release (#43735) * Add suffix for go (#43737) * update suffix * add suffix * update config * update config * update config * update suffix * add suffix * add suffix * Add MongoDB Atlas Projects and Clusters resources for 2026-03-01-preview (#43780) * Add MongoDB Atlas Projects and Clusters resources for 2026-03-01-preview - Add new API version 2026-03-01-preview to TypeSpec - Add Project as child proxy resource under Organization - Add Cluster as child proxy resource under Project - Add tierLimitReached and listClusterTierRegions custom actions on Projects - Add generated examples and OpenAPI specs for all new operations - Add suppressions.yaml for liftrmongodb - Update readme.md with 2026-03-01-preview API version config Source: Files sourced from RPSaaSMaster branch in azure-rest-api-specs-pr * remove suppresssions.yaml * [ResilienceManagement] SDK configuration: add csharp emitters and AZC-compliant client renames (#43816) * Add C# @@clientName overrides in AzureResilienceManagement client.tsp - Rename *Resource models that aren't ARM tracked/proxy resources (Drill/DrillRun/RecoveryJob/ChaosJob -> *Target) to satisfy InheritanceCheck. - Rename *Request bodies to *Content (AZC0030). - Rename *Response models to *Result (AZC0030). - Rename *Data models to *Info to avoid collision with auto-generated *Data POCOs (AZC0032). - Rename IncludeOrUpdateResource/MoboBrokerResource/ServiceLevelResource away from the reserved *Resource suffix. * tspconfig: replace placeholder values and add C# (mgmt) emitter config * tspconfig: updated to follow the tspconfig.yaml template provided * renamed RecommendationsHighAvailabilityData * added js/ts emmiter options * formatted client.tsp and tspconfig.yaml * removed go and ts emitters * added go placeholder emmitter * Removed a usage decorator for go language * Update SDK generation skill to use local SDK generation only when explicit abotu local (#43791) * Placeholder union for routine run status. So we can add specific string values in the future without breaking changes (#43786) * Update OpenAPI3 files after running `npx tsp compile .` * [NetAppFiles] Release microsoft.net app 2026 04 01 (#43517) * Add 2026-04-01 and 2026-04-15-preview api-verions * Add LdapBindCredentials * Add LdapBindCredentials2 * remove extra file * tsv fix * tsp fix * tsp bindPasswordAkvConfig fix * tsp bindPasswordAkvConfig fix * empty * tsp EntraIdAkvConfigPatch fix * tsp ldapConfiguration versioning * tsp ldapConfiguration versioning2 * review fixes * example reference * empty * BindPasswordAkvConfigPatch version * add FileAccessLogs to cache * chore: remove blob client.tsp import (#43822) * [Foundry] Add `a2a` to AgentProtocol union (#43821) Adds `a2a: "a2a"` to the container-side `AgentProtocol` union in `src/agents/models.tsp`, mirroring the existing `a2a` entry in `AgentEndpointProtocol`. This lets hosted agents declare that their container natively serves the A2A protocol, enabling Azure ML Vienna's Agents service to route A2A traffic directly to the container (passthrough) instead of translating it through the head. Non-breaking: this is a string-extensible union, so the new value extends the schema without invalidating existing clients or stored agent definitions. Also includes a fresh openapi3 regeneration (`tsp compile --emit @typespec/openapi3`). The regen picked up four unrelated discriminator-mapping additions (`azure_ai_source`, `synthetic_data_gen_preview`, OpenAI `json_schema` / `summary_text`) that were added to the TypeSpec but not yet reflected in the committed openapi3 outputs. Including them here keeps the openapi3 artifacts consistent with the TypeSpec source. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * chore: updates openai typespec definitions to 1.20 (#43824) * Update CODEOWNERS (#43827) * Fix final result issues and update tspClient for apimanagement (#43682) * update clientTsp for apimanagement * Update client.tsp * Update ApiManagementServiceResource.tsp * update final result * ci(skills): add OpenAI TypeSpec update skill (#43549) * ci(skills): add OpenAI TypeSpec update skill Add a repo skill and eval coverage for updating @azure-tools/openai-typespec with --save-exact and warning when a caret version spec is present. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * chore: add codeowners for openai-typespec-update skill Co-authored-by: baywet <7905502+baywet@users.noreply.github.com> * Update .github/CODEOWNERS * Add OpenAI TypeSpec Definitions to CODEOWNERS --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: baywet <7905502+baywet@users.noreply.github.com> Co-authored-by: Mike Harder * [JS] Mitigate sdk breaking change (#43832) * [JS] Mitigate js sdk breaking change (#43813) * update * update * Migrate management-plane tspconfig to http-client-csharp-mgmt emitter (#43614) * Migrate management-plane tspconfig.yaml to @azure-typespec/http-client-csharp-mgmt emitter Replace the retiring legacy @azure-tools/typespec-csharp emitter with @azure-typespec/http-client-csharp-mgmt for 8 management-plane TypeSpec projects (chaos, containerservice/preparedimagespecification, developerhub, imagebuilder, marketplace, monitor/DataCollectionRuleConfigurationMetadata, resourcehealth, sql). chaos and marketplace already declared the new emitter, so only the redundant legacy block is removed. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add csharp clientName rename for ProxyResource in resourcehealth The custom ProxyResource model collides with CommonTypes.ProxyResource in the csharp scope under the new @azure-typespec/http-client-csharp-mgmt emitter. Python/Java/JavaScript already rename it; add the same for csharp. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Rename csharp ProxyResource clientName to ResourceHealthProxyResource Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * [Edge ConfigManager] Sync with RPSaaSMaster Swagger. (#43082) * Sync with RPSaaSMaster Swagger. Added versions: - 2025-08-15-preview - 2026-03-01 * update edge cspell and suppressions * update readme with new versions * revert tspconfig.yaml to main commit * remove self-imports * update readme.md * Mitigate Python SDK breaking changes for azure-mgmt-monitor (#43834) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * mitigate js breaking changes (#43815) * Update tspconfig.yaml * Update back-compatible.tsp * Revert "Update back-compatible.tsp" This reverts commit a7d3323afca9b9c5e3be72d34f46d9671aec6e33. * mitigate JS operation name breaking for apimanagement (#43835) * update operation name (#43836) * Remove python clientLocation customization for ServiceDiagnosticSettingsResources (#43839) * mgmt, Java, Validate TypeSpec conversion for DesktopVirtualization service converted tsp (#43446) * Add GPU memory properties and expand cluster job name pattern in 2026… (#43840) * Add GPU memory properties and expand cluster job name pattern in 2026-05-01-preview - Add read-only acceleratorType, memoryModel, and totalMemoryInBytes properties to EdgeMachineGpuProperties - Update EdgeMachineGpus Get/List/CreateOrUpdate examples with new properties - Add 'lpddr' to cspell dictionary - Expand ClusterJob jobsName pattern from {3,24} to {3,64} - Regenerate hci.json swagger and example outputs * [AzureStackHCI] Fix EdgeMachineWorkloadInventoryItem: change virtualProcessorCount and memoryInBytes to string (2026-05-01-preview) (#43841) * Initial plan * Change virtualProcessorCount and memoryInBytes to string in EdgeMachineWorkloadInventoryItem Co-authored-by: IndraneelPal <105407886+IndraneelPal@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IndraneelPal <105407886+IndraneelPal@users.noreply.github.com> --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: IndraneelPal <105407886+IndraneelPal@users.noreply.github.com> * Bump api-version to 2026-04-01 (#43844) * Pin api-version 2026-04-01 for typespec-python and typespec-ts emitters (#43851) * Java beta subclients refactor (#43686) * methods relocs * hack to get relocs * removed unused namespaces * add clientInitialization * Trying individual init * fix * Added allowbetatypes flag * Inlined model * moved allowBetaTypes to parent builder * client setup correctly * removed bad usage of clientInitialization * Trying to promote header values to builder setting * Added relocations to Projects SDK java entrypoint * Adding Java expections for ops served in azure-ai-agents package * Dedicated java op reloc entries for projects * Promote Foundry preview header to Java client * Narrow Java optimization convenience suppressions * Document Java Foundry-Features header promotion rationale * Document temporary Java convenience API suppressions * Promote Foundry preview header for Java projects * Internalize Java Foundry features opt-in key * Preserve Java projects convenience models * Implmeneted entry point re-org for java * Added tspconfig for java projects entry point * Added missing imports * restored entry point for java projects for now * re-org 2nd try * Expanded import to 2 separate files * Removed work around and restored automatic code gen * Forcing emission of optIn keys for internal use * Removed work around for projects * Simplified PR changes * Simplified spec changes more * replicated comment * PR feedback and removed unnecessary main.tsp file * Try tweaking pr stale policy (#43846) * Add ARM leases for partner PRs (M365 #28806, Kore.AgentPlatform #28860, EdgeOperator BillingConfigurations #28871, Storage storageContextCache #28874, WebIQ #28858); remove obsolete AIGrounding lease (#43850) Co-authored-by: Vikeshi Tiwari Co-authored-by: Tejaswi Salaigari * Enhance datetime documentation as per JS SDK review comments (#43748) * Enhance datetime documentation as per JS SDK review comments * Remove inline param from client.tsp * Fix tsp format for client.tsp datetime docs * Enhance JS client: fix delete naming and improve search tile docs * Apply tsp format to client.tsp * Remove unnecessary JS clientName for Ingestions.delete * Allow relative links for AGENTS.md (#43831) Added rule to allow relative links for AGENTS.md. Co-authored-by: Heath Stewart * Address PR comments for Net update v20260401 (#43858) * Address PR comments for Net update v20260401 * fix format * Fix ML LintDiff Error (#43691) * drop legacy swagger and examples * update readme * [typespec-validation] Allow a later preview or stable version to supersede older previews (#43862) * Initial plan * Allow replacing a preview version with a later preview or stable Co-authored-by: mikeharder <9459391+mikeharder@users.noreply.github.com> * Clarify variable names in compile rule supersede logic Co-authored-by: mikeharder <9459391+mikeharder@users.noreply.github.com> * Apply suggestion from @mikeharder --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: mikeharder <9459391+mikeharder@users.noreply.github.com> Co-authored-by: Mike Harder * Add Microsoft.ExtendedLocation 2024-09-15-preview API version (#30445) (#41035) * Add Microsoft.ExtendedLocation 2024-09-15-preview API version (#30445) * Copy files from preview/2021-08-31-preview Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-09-15-preview Updated the API version from preview/2021-08-31-preview to preview/2024-09-15-preview. * Added tag for 2024-09-15-preview in readme file * Updated model and examples * Fixing validation errors * Updating Tag as asked by Vineeth * Refactor folder --------- Co-authored-by: Mrinnal Sahani Co-authored-by: Vineeth Thumma Co-authored-by: Tong Xu (Wicresoft North America Ltd) * remove optional authentication properties * Address PR review comments: fix common-types v2->v5, invalid GUIDs, incomplete ARM IDs, readOnly properties, resourceSyncRules casing, and placeholder ARM IDs * Remove invalid x-ms-identifiers from string array, fix compute operation descriptions * Address PR comments * address comments * address comments * address comments * address comments * address comments * address lint comments --------- Co-authored-by: Mrinnal Sahani <51316731+mrinnalsahani@users.noreply.github.com> Co-authored-by: Mrinnal Sahani Co-authored-by: Vineeth Thumma Co-authored-by: Tong Xu (Wicresoft North America Ltd) Co-authored-by: Pavan Neerudu <86822039+PavanNeerudu@users.noreply.github.com> Co-authored-by: vithumma Co-authored-by: Pavan Neerudu * mgmt, Java, Validate TypeSpec conversion for DevTestLabs service converted tsp (#43428) * Mitigate Python SDK breaking changes for azure-mgmt-monitor (#43869) * Mitigate Python SDK breaking changes for azure-mgmt-monitor * Add ErrorResponseCommon python clientName mapping * [JS] Enable compatibility-lro (#43872) * update * update * Sync eng/common directory with azure-sdk-tools for PR 15969 (#43871) * Update git branch push and login to github * Detect if the script is running in Azure DevOps. --------- Co-authored-by: Chidozie Ononiwu * Fix InferenceEndpoints_Update patch model in MachineLearningServices (#43531) * fix * delete 2024-10-01-preview original swagger * update readme.md * Revert "delete 2024-10-01-preview original swagger" This reverts commit e0953718f16a4438bb09245c39d9a3b2f9d23227. * Revert "update readme.md" This reverts commit 3c8e4ec4b5513cc4219f0659127599e69707e446. * [JS] Update operation group name (#43873) * update operation group name * format * Remove SourceControls resource type from deprecated API versions (#43819) Remove SourceControls swagger files, examples, and readme references from all API versions except 2025-09-01, 2025-06-01, and 2025-07-01-preview. Co-authored-by: Guy Wilf Shukrun Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * [ResilienceManagement] Additional C# client.tsp overrides for SDK design-guideline compliance (#43877) * added some net sdk customisation for the sdk generation * formating changes to client.tsp * re-trigger CI * [JS] Update operation group name for eventHub (#43878) * Removing max length constraint (#43833) Co-authored-by: deepakmauryams * AzureResilienceManagement: client.tsp – rename IsAttentionRequired/RecoveryMembers and add enum prefixes (#43879) Co-authored-by: LavishSingal * Bump api-version to 2026-04-01 (#43881) * ContainerService: csharp clientName rename for GatewayAPIImplementations (API->Api) (#43882) Adds csharp-scoped @@clientName decorators renaming the ManagedClusterWebAppRoutingGatewayAPIImplementations model and the ManagedClusterIngressProfileWebAppRouting.gatewayAPIImplementations property so the generated C# acronym casing follows the design guidelines (API -> Api). This corrects the flattened public property GatewayApiImplementationsIstioMode and the corresponding model-factory parameter, removing the need for SDK-side customizations. * add miss dependent directory (#43867) * fix: add explicit json usage for DocumentTranslateContent (#43886) * Remove stale Microsoft.DBforPostgreSQL/PostgreSQL/ ARM lease (case-collision fix) (#43889) Removes .github/arm-leases/postgresql/Microsoft.DBforPostgreSQL/PostgreSQL/lease.yaml which case-collides with the sibling PostgreSql/lease.yaml on Windows/macOS filesystems and is no longer referenced by the spec layout. The lowercase PostgreSql/ folder matches the service folder casing introduced by https://github.com/Azure/azure-rest-api-specs-pr/pull/28858 / Azure/azure-rest-api-specs#43777 (postgresql folder restructure), so keeping PostgreSql/ preserves lease coverage for that PR while eliminating the case-only duplicate. Supersedes #43887, which removed the lowercase variant; removing the lowercase one would re-trigger ARMModelingReviewRequired on the partner restructure PR because the lease checker looks up the exact-cased path. Co-authored-by: Vikeshi Tiwari * Add Microsoft.ProgramEnrollment TypeSpec API spec (2026-03-01-preview) (#43694) - New ARM resource provider: Microsoft.ProgramEnrollment - API version: 2026-03-01-preview (preview) - Resource: EduEnrollments (CRUD + list operations) - TypeSpec source with generated OpenAPI - Originally merged in azure-rest-api-specs-pr PR #28537 Address ARM review feedback: - Add @Azure.Core.previewVersion annotation to version enum - Add explicit doc comments to all CRUD operations - Add Azure-AsyncOperation header to DELETE 202 response - Use ArmResourceCreateOrUpdateAsync for PUT operation Co-authored-by: Lei Wan (from Dev Box) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add .NET emitter configuration for Microsoft.ProgramEnrollment (#43905) Co-authored-by: Lei Wan (from Dev Box) * Use plugin to mark classes as experimental. (#43828) * Use plugin to mark classes as experimental. * Fix path * Update helper function to print nested exception details. (#43892) Co-authored-by: Connie Yau * [Microsoft.Devices][Bugfix] Fixed regression on RoutingTwin/RoutingTwinProperties models for IotHubs API version 2026-03-01-preview (#43759) * Fixed regression on RoutingTwin/RoutingTwinProperties models for API version 2026-03-01-preview * Added suppression justification * Added suppression justifications * add spec deprecation info to Foundry ModelInference (#43907) * Upgrade typespec to 1.13 (#43884) Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: timotheeguerin <1031227+timotheeguerin@users.noreply.github.com> * Move and Remove clientName decorator in models.tsp (#43814) * move and remove clientName Decorator in models.tsp * fix * Update lease.yaml * fix client.tsp * revert ScrubbingRuleEntryMatchOperator and ScrubbingRuleEntryState Fix * mitigate js breaking change (#43908) * Merging commvault typespec changes to public repo (#43838) * Added changes for commvault in public repo * Removed a file * fix: migrate liftrcommvault TypeSpec project to folder structure v2 Move TypeSpec project from specification/liftrcommvault/Commvault.ContentStore.Management/ to specification/liftrcommvault/resource-manager/Commvault.ContentStore/ContentStore.Management/ to comply with folder structure v2 requirement. - Moved main.tsp, tspconfig.yaml, examples/ to v2 location - Moved generated preview OpenAPI files to match new location - Updated tspconfig.yaml: emitter-output-dir now points to {project-root} - Updated resource-manager/readme.md input-file paths - Deleted old non-v2 Commvault.ContentStore.Management folder * Revert "fix: migrate liftrcommvault TypeSpec project to folder structure v2" This reverts commit 69e41465d3d5d8120b6feb36c82ab0ef402a0e3d. * Removed a files * Revert "Removed a files" This reverts commit 91dbdd23fd61e9d87187e0859ed06314d6249208. * Added changes for suppression * Added changes for suppression * Added changes for suppression * Fix SDK compilation errors: make read-only ProtectionGroup fields optional and use proper update model for CloudAccount * Revert "Fix SDK compilation errors: make read-only ProtectionGroup fields optional and use proper update model for CloudAccount" This reverts commit 3dd10f56dfd223eea86af6e3d12f6d98c4295443. * Updated response code for stop backup * Updated response code for stop backup * Updated response code for stop backup * Formated the tsp file * Fixed the SDK issue * Format main.tsp * Fix PatchBodyParametersSchema: use implicit optionality for CloudAccount PATCH --------- Co-authored-by: Saurav Raj * Customize .NET management SDK naming (#43810) * Customize management SDK naming * Restore HCI VM specs for SDK naming Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Customize HCI validate model names Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix management SDK naming CI failures Move HCI VM customizations to the valid resource-manager TypeSpec project, remove the invalid restored project, and include TypeSpec formatting and spellcheck fixes. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Rerun transient SDK validation Retrigger SDK validation after transient 504 failures while downloading external tooling/artifacts. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Customize HCI VM creation model name Rename CreationData for .NET SDK generation so analyzer rules pass when regenerating Hci.Vm from the valid StackHCIVM TypeSpec project. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * [JS] Enable compatibility-lro for securityinsight (#43880) * enable compatibility-lro * update * update * Change totalMemoryInBytes for EdgeMachineGpuProperties from int to string (2026-05-01-preview) (#43911) Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IndraneelPal <105407886+IndraneelPal@users.noreply.github.com> * Release containerregistry microsoft.container registry/2026-03-01-preview (#43018) * Release containerregistry microsoft.container registry/2026-03-01-preview * patch RegistryCreate.json * finish patching in writableCacheReposEnabled * lint fixes * remove default for regionalEndpoints * lint fixes v2 * lint RegistryListByResourceGroup.json * change from boolean writableCacheReposEnabled to enum writableCacheRepos * add missed example update * add suppression for required discriminator on patch * fix suppression path * fix index in suppression * update discriminator property name * update documentation and pattern restrictions * update 'id' to 'virtualNetworkSubnetResourceId' * update example responses * fix prettier formatting in CacheRuleCreateUserAssignedMIGoogle example * Update OpenAPI3 files * Export installationToken as output variable to allow it be used in subsequesnt steps (#43904) Co-authored-by: Chidozie Ononiwu * update (#43912) * feat: adds the ability to control tags (#43560) * feat: adds tag definition file Signed-off-by: Vincent Biret * ci: emit 3.2.0 OpenAPI descriptions to get all required properties Signed-off-by: Vincent Biret * feat: adds missing tags from the OpenAI definitions Signed-off-by: Vincent Biret * feat: further groupings of the tags * feat: better ordering of tags * fix: reverts description to summary change Signed-off-by: Vincent Biret * fix: adds missing summary for evaluator jobs Signed-off-by: Vincent Biret * small update to tags * update for peer responses/agentmgmt * fix: split agent operations for sessions and versions Signed-off-by: Vincent Biret * fix: remaps download operation * chore: refreshes generated assets * feat: additional missing tags from OpenAI operations Signed-off-by: Vincent Biret * fix: duplicated tag * chore: refreshes generated assets * fix: duplicated tag * chore: refreshes generated assets --------- Signed-off-by: Vincent Biret Co-authored-by: Travis Wilson * eng/tools: Run TypeScript directly via Node's built-in type stripping (#43885) * chore: upgrades openai-typespec definitions to 1.20.1 (#43883) * chore: upgrades openai-typespec definitions to 1.20.1 Signed-off-by: Vincent Biret * chore: refreshes generated assets --------- Signed-off-by: Vincent Biret Co-authored-by: Timothee Guerin * Added NEW observabilityAgent resource type 2026-05-01-preview (#42602) * Added NEW observabilityAgent resource type 2026-05-01-preview * delete mcps * Fix TypeSpec formatting and remove untracked stable/.gitkeep * Add missing examples for all operations and fix update model * Rename issueContainerId to monitoringAccountId * Address ARM review: array for disableAutonomousOperations, combined LRO headers, remove stale suppression * Add customInstructions property, update disableAutonomousOperations to AutoInvestigate only * Change delete to synchronous (200/204) * Fix Prettier formatting on example JSON files * Replace customInstructions with operations object property * Define explicit AgentOperations and OperationSettings models to fix arm-no-record * Fix IssueCreation PascalCase to camelCase issueCreation for ARM lint compliance * Remove operations property, AgentOperations, and OperationSettings models * Revert "Remove operations property, AgentOperations, and OperationSettings models" This reverts commit 797c932821f8fb814ddece97517c5ed661cdb7d5. * Address Ravi review comments for Agents spec * Format Agents TypeSpec models * Format Agents TypeSpec decorators * Apply OperationMode design for agent operations * Sync Agents source examples with OperationMode schema * Add Investigation operation and rename manualOnly to manual * Regenerate swagger and examples with Investigation operation * Increase customInstructions length limit * Refactor operations from object to array structure with type field * Update all example files to array structure * Fix Update example for SDK validation * Align PATCH payload with SDK update model * Fix LintDiff: use EnabledState enum and proper PATCH update model * Fix JS SDK update sample typing with optional PATCH location * Mark PATCH location immutable for LintDiff compliance * Make PATCH location readOnly to satisfy LintDiff * Remove PATCH location from agent update model for LintDiff * Replace customInstructions with instructions in operation definitions * Remove _tmp_js_* temporary artifacts * Document monitoringAccountId update semantics * Rename operation type Investigate to Investigation * Address ARM review feedback for observability agent * Fix prettier/validation and revert operationType to type * Restore provisioningState on observability agent * Replace AgentState enum with boolean enabled property * Require identity in minimum-set examples * Require identity on observability agent resource schema * Align generated agents swagger with TypeSpec output --------- Co-authored-by: vikeshi26 * Sync eng/common directory with azure-sdk-tools repository (#42951) * Fix blobs nested directory implementation (#43801) * fix nested directory implementation * fix import * update suppressions --------- Co-authored-by: catalinaperalta * fix: contenttype in submitBatch (#43917) * Sync eng/common directory with azure-sdk-tools for PR 15987 (#43924) * Docs.MS Release: Use GH_TOKEN when pushing to docs repository * Set ScriptsDirectory Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Daniel Jurek Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * Mitigate Java breaking changes for Redis Enterprise (#43929) * Mitigate Java breaks for redisenterprise Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add TWOH to redisenterprise cspell words Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Rename Redis Enterprise create properties for Java Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * [CompanionAPI] Add python client name (#43931) * Add python client name for Napster.CompanionAPI * Update client.tsp * Update cspell.yaml * Update client.tsp * Update client.tsp (#43932) * csharp-mgmt-reservations-migration (#43260) * Migrate ManagedNetworkFabric C# SDK generation (#43375) * Migrate ManagedNetworkFabric C# SDK generation Add C# management emitter settings and compatibility customizations for the ManagedNetworkFabric SDK migration. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix ManagedNetworkFabric TypeSpec review comments Revert unintended optionality changes and replace private ARM resource decorators with public resource templates. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Remove private ManagedNetworkFabric Http decorators Drop private includeInapplicableMetadataInPayload decorators from resource models after converting them to public ARM resource templates. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Mitigate ManagedNetworkFabric swagger resource changes Keep resource properties required and preserve existing property descriptions after switching to public ARM resource templates. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix the depercated property issue * format * Polish ManagedNetworkFabric TypeSpec customizations Update ManagedNetworkFabric TypeSpec customizations to preserve SDK compatibility and refresh the generated swagger output. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Customize ManagedNetworkFabric C# names Add C# client names needed to preserve ManagedNetworkFabric SDK API shape during the management generator migration. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Preserve ManagedNetworkFabric SDK API shape Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix ManagedNetworkFabric C# migration compatibility Move SDK compatibility fixes into TypeSpec client customizations for the ManagedNetworkFabric mgmt migration. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Revert ManagedNetworkFabric optionality changes Restore original TypeSpec optionality and rely on SDK compatibility shims for migrated C# API compatibility. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Restore ManagedNetworkFabric TypeSpec model compatibility Restore spread composition for ExternalNetwork option A models and reinstate InternalNetwork suppressions without changing generated source. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Restore ManagedNetworkFabric ACL swagger compatibility Revert ACL swagger-affecting changes, restore NetworkRackPatch aliasing, and add a C# client name for the generic patch type. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Restore ManagedNetworkFabric patch swagger compatibility Revert patch inheritance changes to preserve Swagger shape while keeping C# compatibility customizations in the SDK. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Restore ManagedNetworkFabric external network compatibility * Restore ManagedNetworkFabric action response compatibility * Preserve ManagedNetworkFabric restart operation name * Restore ManagedNetworkFabric action request compatibility * compile * format * Address ManagedNetworkFabric review feedback * Fix ManagedNetworkFabric InternetGateway compatibility * Refine ManagedNetworkFabric review feedback customizations * Use resource identifier for ManagedNetworkFabric network tap id * Restore ManagedNetworkFabric NetworkFabric swagger compatibility * Restore ManagedNetworkFabric action resource result swagger compatibility * Preserve ManagedNetworkFabric community action model compatibility * Add docs for MNF compatibility models Document the compatibility add-operation models and properties so TypeSpec diagnostics remain clean. * Remove redundant MNF identity type replacement Use the common ARM managed service identity type directly instead of a service-specific replacement union. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Clean up MNF CSharp customizations Remove redundant access decorators and use BgpSettings for the active internal network BGP property while preserving the old derived BGP model as hidden compatibility. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Clean up MNF static route customization Use StaticRouteSettings as the active internal network static route property and preserve the old InternalNetworkStaticRouteConfiguration API as hidden obsolete compatibility. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Clean up MNF network tap and OptionB customizations Use active generated settings properties for NNI OptionB and NetworkTap destinations while preserving the old derived property/item APIs as hidden obsolete compatibility custom code. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Clean up MNF static route patch customization Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Clean up MNF terminal server customization Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Clean up MNF terminal server patch customization Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Clean up MNF OptionA customization Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Clean up MNF internal network patch customization Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Clean up MNF connected subnet patch customization Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Clean up MNF NNI layer2 patch customization Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Clean up MNF NNI optionB patch customization Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Clean up MNF NNI NPB static route patch customization Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Clean up MNF NNI route policy patch customization Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Update ManagedNetworkFabric external network patch customizations Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Remove redundant ManagedNetworkFabric internal network route policy alternates Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Update ManagedNetworkFabric L3 isolation domain patch customizations Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Update ManagedNetworkFabric neighbor group patch customizations Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Update ManagedNetworkFabric ACL and tap rule patch customizations Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Update ManagedNetworkFabric route policy patch customizations Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix ManagedNetworkFabric TypeSpec model casing Rename helper TypeSpec identifiers to follow TypeSpec casing rules while preserving the generated C# IP-prefixed names with clientName. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Format ManagedNetworkFabric client customizations Apply TypeSpec formatter output required by validation for ManagedNetworkFabric client customizations. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Remove invalid ManagedNetworkFabric shared type renames Do not rename shared ARM operation-status and managed-identity types to package-local names, because those package-local types are not generated and break SDK verification. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Qualify ManagedNetworkFabric common operation status types Use fully-qualified ARM common operation status spreads so C# generation keeps Azure.ResourceManager.Models types instead of package-local model names. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Use unqualified OperationStatusResult references Keep ManagedNetworkFabric model spreads using the imported OperationStatusResult symbol instead of fully qualifying the ARM common namespace. * Rename active MNF patch payloads for compatibility Rename NetworkBootstrapDevicePatch and NetworkMonitorPatch generated C# payloads so the SDK can preserve the shipped patch model names as compatibility types. * Map operation status result for .NET compatibility Use alternateType so .NET management generation maps the shared ARM OperationStatusResult to the ManagedNetworkFabric compatibility result type. * Define operation status compatibility model Add a ManagedNetworkFabric operation status model and map the shared ARM operation status result to it for .NET generation compatibility. * Fully qualify operation status alternate type target Use the full ARM common namespace in the .NET alternateType customization so SDK generation resolves the shared OperationStatusResult consistently. * Revert "Fully qualify operation status alternate type target" This reverts commit 9abc84d164046eea6ff0c019dce42d60cb9776ca. * Revert "Define operation status compatibility model" This reverts commit c31c206f62153d5893e2676f0c6ab43c6faa3683. * Revert "Map operation status result for .NET compatibility" This reverts commit 168dfbe676cf4978edc0639cecad1a6f9c044068. * Add contextual MNF patch names Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * format --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * [Microsoft.DesktopVirtualization] Add 2026-04-01-preview shortcutsExtension for applications (#41094) * Microsoft.DesktopVirtualization: add 2026-04-01-preview with application shortcutsExtension * Resolve conflict * Resolve conflict * DesktopVirtualization: format AppAttachPackageInfo_Import example * DesktopVirtualization: format 2026-04-01-preview artifacts and sync tsp outputs * Fix issue and rebuild * Remove useless suppressions * Update tests * Fix Lint Diff issue * Fix tag in readme --------- Co-authored-by: Rui Guo Co-authored-by: Zhongjie Li Co-authored-by: Li McGregor <413436584lzj@gmail.com> * [JS] Update config to mitigate breaking change (#43930) * update * update * update * update * update * update * format * Add csharp customizations for StorageCache migration (#43570) * [JS] Mitigate JS breaking for hybridKubernetes (#43935) * mitigate JS breaking for hybridKubernetes * update * Add Go SDK customizations (#43852) * Add Go SDK customizations Fixed up some names to prevent breaking changes. Added alternate type for unnamed union to fix colliding enum names. Added emitter config for typespec-go. * update cspell.yaml * refine * more refinements * format * Disable plugin, because it is not ready yet. (#43943) * selective import to support python sdk generation (#43920) * API Cleanup initial pass(merge sqush jugonzales/agents-optimization-v2preview) (#43927) * rebase to /feature/foundry-release and merge sqush jugonzales/agents-optimization-v2preview * resolve missing file * address comment for minValue of max_candidates * address comments of OptimizationInlineDatasetInput.type * address coment of OptimizationJobListItem * Fix latest typespec for C# (#43946) * Nirovins/fix typespec (#43947) * Fix latest typespec for C# * Unhide removed API? * Fix routines timer data contract (#43949) * Reorganizes client TypeSpec files for better structure and consistency (#43945) * Merge main conflict resolutions for Foundry tool models and OpenAPI * Revert "Merge remote-tracking branch 'origin/feature/foundry-release' into nichella-merge-main-conflicts-only" This reverts commit c6cc27951efe46af02f9fa4a8d2ac405c0f4cd80, reversing changes made to ccc47ddb43720bc248b605aefba5aec899e1688e. * Removed "tool_configs" --------- Signed-off-by: zhuangqh Signed-off-by: Vincent Biret Co-authored-by: Justin Gonzales <115047469+jugonzales@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Gerardo Lecaros <10088504+glecaros@users.noreply.github.com> Co-authored-by: Darren Cohen <39422044+dargilco@users.noreply.github.com> Co-authored-by: azure-sdk-automation[bot] <191533747+azure-sdk-automation[bot]@users.noreply.github.com> Co-authored-by: Joel Hendrix Co-authored-by: Matthew Metcalf Co-authored-by: Ross Grambo Co-authored-by: Akshaya Annavajhala Co-authored-by: Akshaya Annavajhala <16749003+akshaya-a@users.noreply.github.com> Co-authored-by: Linda Li Co-authored-by: catalinaperalta <9859037+catalinaperalta@users.noreply.github.com> Co-authored-by: catalinaperalta Co-authored-by: Dapeng Zhang Co-authored-by: FumingZhang <81607949+FumingZhang@users.noreply.github.com> Co-authored-by: Wenming Liu Co-authored-by: Jiao Di (MSFT) <80496810+v-jiaodi@users.noreply.github.com> Co-authored-by: Yuchao Yan Co-authored-by: ZiWei Chen <98569699+kazrael2119@users.noreply.github.com> Co-authored-by: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Co-authored-by: Ben Brady <86134744+benjamin-brady@users.noreply.github.com> Co-authored-by: emilyjiji <92887308+emilyjiji@users.noreply.github.com> Co-authored-by: Emily Jiji Co-authored-by: Minh-Anh Phan <111523473+minhanh-phan@users.noreply.github.com> Co-authored-by: Nikolay Rovinskiy <30440255+nick863@users.noreply.github.com> Co-authored-by: Praveen Kuttappan <55455725+praveenkuttappan@users.noreply.github.com> Co-authored-by: Ray Chen Co-authored-by: Qinghui Zhuang Co-authored-by: Kaylie <50653231+kaylieee@users.noreply.github.com> Co-authored-by: Peter Brasil Co-authored-by: copilot Co-authored-by: pjohari-ms <84465928+pjohari-ms@users.noreply.github.com> Co-authored-by: Vinh Trinh Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: lnajaroen <122407949+lnajaroen@users.noreply.github.com> Co-authored-by: AdrianSibajaRetana <54075415+AdrianSibajaRetana@users.noreply.github.com> Co-authored-by: Adrián Sibaja Retana Co-authored-by: Karthik chakravarthy <88904658+kcheekuri@users.noreply.github.com> Co-authored-by: etcriss <109991318+etcriss@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: pmoana-ms Co-authored-by: Po'okela Moana Co-authored-by: Mike Harder Co-authored-by: Judy Liu Co-authored-by: JiaqiZhang-Dev <194873822+JiaqiZhang-Dev@users.noreply.github.com> Co-authored-by: Jiaqi Zhang Co-authored-by: wildboyy <62453212+wildboyy@users.noreply.github.com> Co-authored-by: Zhongjie Li Co-authored-by: Li McGregor <413436584lzj@gmail.com> Co-authored-by: Tong Xu (MSFT) <57166602+v-xuto@users.noreply.github.com> Co-authored-by: v-huizhu2 Co-authored-by: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com> Co-authored-by: sumedhsp-msft Co-authored-by: Sumedh Sandeep Parvatikar Co-authored-by: hardikginwala <113458906+hardikginwala@users.noreply.github.com> Co-authored-by: Kipp Morris <117932707+kimorris27@users.noreply.github.com> Co-authored-by: b-kippmorris Co-authored-by: vikeshi26 Co-authored-by: Vikeshi Tiwari Co-authored-by: Tejaswi Salaigari Co-authored-by: nehrao1 <166562460+nehrao1@users.noreply.github.com> Co-authored-by: Naia Scott Co-authored-by: Copilot Co-authored-by: nasc17 <69922333+nasc17@users.noreply.github.com> Co-authored-by: Connie Vi Co-authored-by: dvadas Co-authored-by: Pan Shao <97225342+pshao25@users.noreply.github.com> Co-authored-by: Pan Shao Co-authored-by: Garima Saxena <50868522+garimaa12aug@users.noreply.github.com> Co-authored-by: Garima Saxena Co-authored-by: abaranwal-ms <124332815+abaranwal-ms@users.noreply.github.com> Co-authored-by: prakhar_shukla <78557330+shuklaprakhar415@users.noreply.github.com> Co-authored-by: Prakhar Shukla Co-authored-by: larikaS <127827858+larikaS@users.noreply.github.com> Co-authored-by: Larika Sehgal Co-authored-by: le-codeur Co-authored-by: Harsh Saroha Co-authored-by: Shishira Iyar <106435637+shishiraiyar@users.noreply.github.com> Co-authored-by: IndraneelPal <105407886+IndraneelPal@users.noreply.github.com> Co-authored-by: Sushma Reddy <59618780+sush-101@users.noreply.github.com> Co-authored-by: Chenjie Shi Co-authored-by: tadelesh Co-authored-by: Xinni Tong Co-authored-by: hvedati <43424696+hvedati@users.noreply.github.com> Co-authored-by: pvsraviteja <67624658+pvsraviteja@users.noreply.github.com> Co-authored-by: Ravi Teja PVS (from Dev Box) Co-authored-by: baheti1409 Co-authored-by: Timothee Guerin Co-authored-by: will Co-authored-by: Will Huang Co-authored-by: koyasu221b <5138432+koyasu221b@users.noreply.github.com> Co-authored-by: Wei Chen Co-authored-by: David Kydd Co-authored-by: Tom Abraham <38714456+toma3233@users.noreply.github.com> Co-authored-by: Tom Abraham Co-authored-by: ibaboulfetouh Co-authored-by: Ibrahim Aboulfetouh Co-authored-by: InduSridhar Co-authored-by: Indu Sridhar Co-authored-by: Ajit Bhalekar <114007691+ajitbhalekar@users.noreply.github.com> Co-authored-by: Andrew Schonhoffer Co-authored-by: vebudumu <93553661+vebudumu@users.noreply.github.com> Co-authored-by: Harsheet Shah <50236780+harsheet-shah@users.noreply.github.com> Co-authored-by: Harsheet Shah Co-authored-by: Santhosh Kumar Gunasekaran Co-authored-by: Vincent Biret Co-authored-by: Viswa Balaji <138743504+viswabalaji@users.noreply.github.com> Co-authored-by: Vishwanath Balaji Co-authored-by: Yulin Li Co-authored-by: Yulin Li Co-authored-by: aprilk-ms <55356546+aprilk-ms@users.noreply.github.com> Co-authored-by: Jose Alvarez Co-authored-by: xitzhang Co-authored-by: Nacho Alonso Portillo <41644064+nachoalonsoportillo@users.noreply.github.com> Co-authored-by: fmabroukmsft <134638798+fmabroukmsft@users.noreply.github.com> Co-authored-by: abpatelmicrosoft Co-authored-by: Chunyu Li <79233053+ChunyuMSFT@users.noreply.github.com> Co-authored-by: Swagger Agent Co-authored-by: Bernd Verst Co-authored-by: Bernd Verst Co-authored-by: Grace Wilcox <43627800+gracewilcox@users.noreply.github.com> Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> Co-authored-by: Chidozie Ononiwu Co-authored-by: efrainretana <141282336+efrainretana@users.noreply.github.com> Co-authored-by: Weidong Xu Co-authored-by: Wei Hu Co-authored-by: Ravi Eda Co-authored-by: Ravi Eda Co-authored-by: mcgallan <88413158+mcgallan@users.noreply.github.com> Co-authored-by: Nikhil Gupta <52026487+nikhgup@users.noreply.github.com> Co-authored-by: Raja singhal Co-authored-by: Tarun Khattar <114153772+khattartarun@users.noreply.github.com> Co-authored-by: Travis Wilson <35748617+trrwilson@users.noreply.github.com> Co-authored-by: Travis Wilson Co-authored-by: Lawrence Onyango <39733044+Lawrence-O@users.noreply.github.com> Co-authored-by: Lawrence Onyango Co-authored-by: nkalaga-microsoft <156228849+nkalaga-microsoft@users.noreply.github.com> Co-authored-by: Mark Cowlishaw <1054056+markcowl@users.noreply.github.com> Co-authored-by: sahi82 Co-authored-by: Rupinder Sahi Co-authored-by: mikeharder <9459391+mikeharder@users.noreply.github.com> Co-authored-by: Paul Hsu Co-authored-by: Arthur Ma Co-authored-by: Anuj Sharma Co-authored-by: Lavish Singal <64147248+LavishSingal@users.noreply.github.com> Co-authored-by: Auðunn Co-authored-by: Jorge Rangel <102122018+jorgerangel-msft@users.noreply.github.com> Co-authored-by: AJ Raczkowski <38328607+adamra-msft@users.noreply.github.com> Co-authored-by: Anna Tisch <8689453+annatisch@users.noreply.github.com> Co-authored-by: baywet <7905502+baywet@users.noreply.github.com> Co-authored-by: haiyuan_zhang Co-authored-by: mayankmodi-ms Co-authored-by: Karthick Narendran Co-authored-by: Heath Stewart Co-authored-by: Kashif Khan <361477+kashifkhan@users.noreply.github.com> Co-authored-by: Dinesh B Co-authored-by: Mrinnal Sahani <51316731+mrinnalsahani@users.noreply.github.com> Co-authored-by: Mrinnal Sahani Co-authored-by: Vineeth Thumma Co-authored-by: Tong Xu (Wicresoft North America Ltd) Co-authored-by: Pavan Neerudu <86822039+PavanNeerudu@users.noreply.github.com> Co-authored-by: vithumma Co-authored-by: Pavan Neerudu Co-authored-by: Guy Wilf Shukrun Co-authored-by: Guy Wilf Shukrun Co-authored-by: deepakmauryams Co-authored-by: deepakmauryams Co-authored-by: LavishSingal Co-authored-by: retry-recv Co-authored-by: wanlei123188-gm Co-authored-by: Lei Wan (from Dev Box) Co-authored-by: Connie Yau Co-authored-by: Davide Montanari Co-authored-by: nick863 Co-authored-by: timotheeguerin <1031227+timotheeguerin@users.noreply.github.com> Co-authored-by: Saurav Raj Co-authored-by: Saurav Raj Co-authored-by: Nathan Anderson Co-authored-by: yashmuel <63585146+yashmuel@users.noreply.github.com> Co-authored-by: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com> Co-authored-by: Daniel Jurek Co-authored-by: Rui Guo Co-authored-by: Rui Guo Co-authored-by: Jessie Li <54655211+YoYoJa@users.noreply.github.com> --- .../v1/microsoft-foundry-openapi3.json | 14278 +++++++++++---- .../v1/microsoft-foundry-openapi3.yaml | 9501 ++++++---- .../microsoft-foundry-openapi3.json | 15280 +++++++++++----- .../microsoft-foundry-openapi3.yaml | 9814 ++++++---- .../Foundry/src/toolboxes/models.tsp | 25 +- .../data-plane/Foundry/src/tools/models.tsp | 21 +- 6 files changed, 34302 insertions(+), 14617 deletions(-) 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, } From 22924381673f480acfddd2e159188ac16342adf0 Mon Sep 17 00:00:00 2001 From: Nivedha Chellam <53238750+NivedhaChellam@users.noreply.github.com> Date: Wed, 17 Jun 2026 20:46:39 -0700 Subject: [PATCH 12/12] Refactor toolbox tool type aliases and update Foundry previews (#44049) --- .../v1/microsoft-foundry-openapi3.json | 14278 +++++---------- .../v1/microsoft-foundry-openapi3.yaml | 9173 +++------- .../microsoft-foundry-openapi3.json | 15040 +++++----------- .../microsoft-foundry-openapi3.yaml | 9700 ++++------ .../Foundry/src/toolboxes/models.tsp | 51 +- 5 files changed, 14270 insertions(+), 33972 deletions(-) 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 38bf344f842f..ee34b448ad6e 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,220 +1,84 @@ { - "openapi": "3.2.0", + "openapi": "3.0.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", - "parent": "Agents Root", - "description": "Agent Management" - }, - { - "name": "Agent Invocations", - "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", - "parent": "Platform APIs" - }, - { - "name": "Indexes", - "parent": "Platform APIs" - }, - { - "name": "Connections", - "parent": "Platform APIs" - }, - { - "name": "Scheduler", - "parent": "Platform APIs" - }, - { - "name": "Fine-tuning", - "parent": "Platform APIs", - "summary": "Fine-Tuning" + "name": "Agents" }, { - "name": "Models", - "parent": "Platform APIs" + "name": "Agent Session Files" }, { - "name": "Memory Stores", - "parent": "Platform APIs" + "name": "Agent Invocations" }, { - "name": "Chat", - "parent": "Platform APIs" + "name": "Connections" }, { - "name": "Assistants", - "parent": "Platform APIs" + "name": "Datasets" }, { - "name": "Audio", - "parent": "Platform APIs" + "name": "Deployments" }, { - "name": "Batch", - "parent": "Platform APIs" + "name": "Evaluation Taxonomies" }, { - "name": "Completions", - "parent": "Platform APIs" + "name": "Evaluation Rules" }, { - "name": "Containers", - "parent": "Platform APIs" + "name": "Evaluators" }, { - "name": "Embeddings", - "parent": "Platform APIs" + "name": "EvaluatorGenerationJobs" }, { - "name": "Files", - "parent": "Platform APIs" + "name": "Indexes" }, { - "name": "Images", - "parent": "Platform APIs" + "name": "Insights" }, { - "name": "Moderations", - "parent": "Platform APIs" + "name": "Models" }, { - "name": "Realtime", - "parent": "Platform APIs" + "name": "Memory Stores" }, { - "name": "Threads", - "parent": "Platform APIs" + "name": "Conversations" }, { - "name": "Uploads", - "parent": "Platform APIs" + "name": "Evals" }, { - "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": "Fine-Tuning" }, { - "name": "Evaluations" + "name": "Responses" }, { - "name": "Evals", - "parent": "Evaluations" + "name": "Redteams" }, { - "name": "Evaluation Rules", - "parent": "Evaluations" + "name": "Routines" }, { - "name": "Evaluators", - "parent": "Evaluations" + "name": "Schedules" }, { - "name": "Evaluation Taxonomies", - "parent": "Evaluations" + "name": "Skills" }, { - "name": "Redteams", - "parent": "Evaluations", - "summary": "Red Teaming" + "name": "Toolboxes" }, { - "name": "Evalsuite", - "parent": "Evaluations" + "name": "DataGenerationJobs" }, { - "name": "Insights", - "parent": "Evaluations" + "name": "AgentOptimizationJobs" } ], "paths": { @@ -232,7 +96,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V2Preview" + "AgentsOptimization=V1Preview" ] } }, @@ -283,18 +147,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -312,22 +166,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OptimizationJob" + "$ref": "#/components/schemas/OptimizationJobInputs" } } }, - "description": "The job to create." + "description": "The optimization job inputs." }, "x-ms-foundry-meta": { "conditional_previews": [ - "AgentsOptimization=V2Preview" + "AgentsOptimization=V1Preview" ] } }, "get": { "operationId": "AgentOptimizationJobs_list", "summary": "Returns a list of agent optimization jobs.", - "description": "List optimization jobs. Supports cursor pagination and optional status / agent_name filters.", + "description": "List optimization jobs. Supports cursor pagination and optional status / agentName filters.", "parameters": [ { "name": "Foundry-Features", @@ -337,7 +191,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V2Preview" + "AgentsOptimization=V1Preview" ] } }, @@ -394,7 +248,7 @@ "explode": false }, { - "name": "agent_name", + "name": "agentName", "in": "query", "required": false, "description": "Filter to jobs targeting this agent name.", @@ -429,7 +283,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OptimizationJobListItem" + "$ref": "#/components/schemas/OptimizationJob" }, "description": "The requested list of items." }, @@ -451,18 +305,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -477,7 +321,7 @@ ], "x-ms-foundry-meta": { "conditional_previews": [ - "AgentsOptimization=V2Preview" + "AgentsOptimization=V1Preview" ] } } @@ -486,7 +330,7 @@ "get": { "operationId": "AgentOptimizationJobs_get", "summary": "Get info about an agent optimization job.", - "description": "Get an optimization job by id.", + "description": "Get an optimization job by id. Returns 202 while in progress, 200 when terminal.", "parameters": [ { "name": "Foundry-Features", @@ -496,7 +340,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V2Preview" + "AgentsOptimization=V1Preview" ] } }, @@ -526,7 +370,6 @@ "headers": { "Retry-After": { "required": false, - "description": "Recommended number of seconds to wait before polling again.", "schema": { "type": "integer", "format": "int32" @@ -541,18 +384,27 @@ } } }, - "4XX": { - "description": "Client error", + "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" + } + } + }, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" + "$ref": "#/components/schemas/OptimizationJob" } } } }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -567,7 +419,7 @@ ], "x-ms-foundry-meta": { "conditional_previews": [ - "AgentsOptimization=V2Preview" + "AgentsOptimization=V1Preview" ] } }, @@ -584,7 +436,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V2Preview" + "AgentsOptimization=V1Preview" ] } }, @@ -597,6 +449,16 @@ "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", @@ -612,18 +474,8 @@ "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", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -638,16 +490,16 @@ ], "x-ms-foundry-meta": { "conditional_previews": [ - "AgentsOptimization=V2Preview" + "AgentsOptimization=V1Preview" ] } } }, - "/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.", + "/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", @@ -657,7 +509,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V2Preview" + "AgentsOptimization=V1Preview" ] } }, @@ -665,187 +517,11 @@ "name": "jobId", "in": "path", "required": true, - "description": "The ID of the job to cancel.", + "description": "The optimization job 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/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", @@ -914,7 +590,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AgentObject" + "$ref": "#/components/schemas/OptimizationCandidate" }, "description": "The requested list of items." }, @@ -936,8 +612,8 @@ } } }, - "4XX": { - "description": "Client error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -945,9 +621,78 @@ } } } + } + }, + "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" + ] + } }, - "5XX": { - "description": "Server error", + { + "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": { @@ -958,21 +703,295 @@ } }, "tags": [ - "Agents" - ] + "AgentOptimizationJobs" + ], + "x-ms-foundry-meta": { + "conditional_previews": [ + "AgentsOptimization=V1Preview" + ] + } } }, - "/agents/{agent_name}": { + "/agent_optimization_jobs/{jobId}/candidates/{candidateId}/config": { "get": { - "operationId": "Agents_getAgent", - "summary": "Get an agent", - "description": "Retrieves an agent definition by its unique name.", + "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": "agent_name", + "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 name of the agent to retrieve.", + "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" } @@ -988,6 +1007,163 @@ "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.", @@ -999,8 +1175,8 @@ } } }, - "4XX": { - "description": "Client error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -1008,9 +1184,195 @@ } } } + } + }, + "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 }, - "5XX": { - "description": "Server error", + { + "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.", "content": { "application/json": { "schema": { @@ -1066,7 +1428,6 @@ } ], "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.", @@ -1078,18 +1439,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -1099,8 +1450,6 @@ } } }, - "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" @@ -1132,7 +1481,6 @@ }, "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": [ { @@ -1148,7 +1496,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. The service defaults to `false` if a value is not specified by the caller. 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. Defaults to `false`. This value is not relevant for other Agent types.", "schema": { "type": "boolean", "default": false @@ -1177,18 +1525,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -1204,8 +1542,7 @@ }, "patch": { "operationId": "Agents_patchAgentObject", - "summary": "Update an agent endpoint", - "description": "Applies a merge-patch update to the specified agent endpoint configuration.", + "description": "Updates an agent endpoint.", "parameters": [ { "name": "Foundry-Features", @@ -1225,8 +1562,7 @@ "required": true, "description": "The name of the agent to retrieve.", "schema": { - "type": "string", - "title": "The name of the agent to retrieve" + "type": "string" } }, { @@ -1251,18 +1587,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -1295,8 +1621,7 @@ "/agents/{agent_name}/code:download": { "get": { "operationId": "Agents_downloadAgentCode", - "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`.", + "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`.", "parameters": [ { "name": "Foundry-Features", @@ -1355,23 +1680,14 @@ "content": { "application/zip": { "schema": { - "contentMediaType": "application/zip" - } - } - } - }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" + "type": "string", + "format": "binary" } } } }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -1394,7 +1710,6 @@ "/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": [ { @@ -1451,130 +1766,109 @@ "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": {} - } - } - }, - "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.", + "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.", "content": { "application/json": { "schema": { - "type": "object", - "unevaluatedProperties": {} + "$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", + "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" + } }, - "4XX": { - "description": "Client error", + { + "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", + "additionalProperties": {} } } } }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -1597,7 +1891,6 @@ "/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": [ { @@ -1668,18 +1961,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -1702,7 +1985,6 @@ "/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": [ { @@ -1773,18 +2055,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -1816,7 +2088,6 @@ "/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": [ { @@ -1871,18 +2142,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -1893,7 +2154,7 @@ } }, "tags": [ - "Agent Sessions" + "Agents" ], "requestBody": { "required": true, @@ -1913,8 +2174,7 @@ }, "get": { "operationId": "Agents_listSessions", - "summary": "List sessions for an agent", - "description": "Returns a paged collection of sessions associated with the specified agent endpoint.", + "description": "Returns a list of sessions for the specified agent.", "parameters": [ { "name": "Foundry-Features", @@ -2036,18 +2296,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -2058,7 +2308,7 @@ } }, "tags": [ - "Agent Sessions" + "Agents" ], "x-ms-foundry-meta": { "required_previews": [ @@ -2070,8 +2320,7 @@ "/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.\nThe response includes only the immediate children of the target directory and defaults to the session home directory when no path is supplied.", + "description": "List files and directories at a given path in the session sandbox.\nReturns only the immediate children of the specified directory (non-recursive).", "parameters": [ { "name": "Foundry-Features", @@ -2106,8 +2355,8 @@ { "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.", + "required": true, + "description": "The directory path to list, relative to the session home directory.", "schema": { "type": "string" }, @@ -2122,48 +2371,6 @@ "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", @@ -2186,18 +2393,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -2218,8 +2415,7 @@ }, "delete": { "operationId": "AgentSessionFiles_deleteSessionFile", - "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.", + "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.", "parameters": [ { "name": "Foundry-Features", @@ -2265,7 +2461,7 @@ "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.", + "description": "Whether to recursively delete directory contents. Defaults to false.", "schema": { "type": "boolean", "default": false @@ -2296,18 +2492,8 @@ "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", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -2330,8 +2516,7 @@ "/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.\nThe service stores the file relative to the session home directory and rejects payloads larger than 50 MB.", + "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.", "parameters": [ { "name": "Foundry-Features", @@ -2404,18 +2589,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -2433,7 +2608,8 @@ "content": { "application/octet-stream": { "schema": { - "contentMediaType": "application/octet-stream" + "type": "string", + "format": "binary" } } } @@ -2446,8 +2622,7 @@ }, "get": { "operationId": "AgentSessionFiles_downloadSessionFile", - "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.", + "description": "Download a file from the session sandbox as a binary stream.", "parameters": [ { "name": "Foundry-Features", @@ -2515,23 +2690,14 @@ "content": { "application/octet-stream": { "schema": { - "contentMediaType": "application/octet-stream" - } - } - } - }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" + "type": "string", + "format": "binary" } } } }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -2554,8 +2720,7 @@ "/agents/{agent_name}/endpoint/sessions/{session_id}": { "get": { "operationId": "Agents_getSession", - "summary": "Get a session", - "description": "Retrieves the details of a hosted agent session by agent name and session identifier.", + "description": "Retrieves a session by ID.", "parameters": [ { "name": "Foundry-Features", @@ -2618,18 +2783,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -2640,7 +2795,7 @@ } }, "tags": [ - "Agent Sessions" + "Agents" ], "x-ms-foundry-meta": { "required_previews": [ @@ -2650,7 +2805,6 @@ }, "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": [ { @@ -2707,18 +2861,8 @@ "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", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -2729,7 +2873,7 @@ } }, "tags": [ - "Agent Sessions" + "Agents" ], "x-ms-foundry-meta": { "required_previews": [ @@ -2741,8 +2885,7 @@ "/agents/{agent_name}/endpoint/sessions/{session_id}:stop": { "post": { "operationId": "Agents_stopSession", - "summary": "Stop a session", - "description": "Terminates the specified hosted agent session and returns 204 No Content when the request succeeds.", + "description": "Stops a session.\nReturns 204 No Content when the stop succeeds.", "parameters": [ { "name": "Foundry-Features", @@ -2789,18 +2932,8 @@ "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", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -2811,7 +2944,7 @@ } }, "tags": [ - "Agent Sessions" + "Agents" ], "x-ms-foundry-meta": { "required_previews": [ @@ -2823,7 +2956,6 @@ "/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": [ { @@ -2857,18 +2989,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -2936,8 +3058,7 @@ } } ], - "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", + "description": "Create a new agent version.", "responses": { "200": { "description": "The request has succeeded.", @@ -2949,18 +3070,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -2970,15 +3081,13 @@ } } }, - "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": [ - "Agent Versions" + "Agents" ], "requestBody": { "required": true, @@ -3003,8 +3112,7 @@ }, "get": { "operationId": "Agents_listAgentVersions", - "summary": "List agent versions", - "description": "Returns a paged collection of versions for the specified agent.", + "description": "Returns the list of versions of an agent.", "parameters": [ { "name": "agent_name", @@ -3105,18 +3213,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -3127,15 +3225,14 @@ } }, "tags": [ - "Agent Versions" + "Agents" ] } }, "/agents/{agent_name}/versions/{agent_version}": { "get": { "operationId": "Agents_getAgentVersion", - "summary": "Get an agent version", - "description": "Retrieves the specified version of an agent by its agent name and version identifier.", + "description": "Retrieves a specific version of an agent.", "parameters": [ { "name": "agent_name", @@ -3177,18 +3274,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -3199,12 +3286,11 @@ } }, "tags": [ - "Agent Versions" + "Agents" ] }, "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": [ { @@ -3229,7 +3315,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. The service defaults to `false` if a value is not specified by the caller. 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. Defaults to `false`. This value is not relevant for other Agent types.", "schema": { "type": "boolean", "default": false @@ -3258,18 +3344,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -3280,14 +3356,13 @@ } }, "tags": [ - "Agent Versions" + "Agents" ] } }, "/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": [ { @@ -3351,18 +3426,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -3373,7 +3438,7 @@ } }, "tags": [ - "Agent Sessions" + "Agents" ], "x-ms-foundry-meta": { "required_previews": [ @@ -3385,8 +3450,7 @@ "/agents/{agent_name}/versions:import": { "post": { "operationId": "Agents_createAgentVersionFromManifest", - "summary": "Create an agent version from manifest", - "description": "Imports the provided manifest to create a new version for the specified agent.", + "description": "Create a new agent version from a manifest.", "parameters": [ { "name": "agent_name", @@ -3420,18 +3484,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -3442,7 +3496,7 @@ } }, "tags": [ - "Agent Versions" + "Agents" ], "requestBody": { "required": true, @@ -3459,8 +3513,7 @@ "/agents:import": { "post": { "operationId": "Agents_createAgentFromManifest", - "summary": "Create an agent from a manifest", - "description": "Imports the provided manifest to create an agent and returns the created resource.", + "description": "Creates an agent from a manifest.", "parameters": [ { "name": "api-version", @@ -3484,18 +3537,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -3523,8 +3566,7 @@ "/connections": { "get": { "operationId": "Connections_list", - "summary": "List connections", - "description": "Returns the connections available in the current project, optionally filtered by type or default status.", + "description": "List all connections in the project, without populating connection credentials", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -3533,7 +3575,7 @@ "name": "connectionType", "in": "query", "required": false, - "description": "Lists connections of this specific type", + "description": "List connections of this specific type", "schema": { "$ref": "#/components/schemas/ConnectionType" }, @@ -3543,7 +3585,7 @@ "name": "defaultConnection", "in": "query", "required": false, - "description": "Lists connections that are default connections", + "description": "List connections that are default connections", "schema": { "type": "boolean" }, @@ -3573,27 +3615,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -3620,8 +3643,7 @@ "/connections/{name}": { "get": { "operationId": "Connections_get", - "summary": "Get a connection", - "description": "Retrieves the specified connection and its configuration details without including credential values.", + "description": "Get a connection by name, without populating connection credentials", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -3659,27 +3681,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -3706,8 +3709,7 @@ "/connections/{name}/getConnectionWithCredentials": { "post": { "operationId": "Connections_getWithCredentials", - "summary": "Get a connection with credentials", - "description": "Retrieves the specified connection together with its credential values.", + "description": "Get a connection by name, with its connection credentials", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -3745,27 +3747,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -3792,7 +3775,7 @@ "/data_generation_jobs": { "get": { "operationId": "DataGenerationJobs_list", - "summary": "List data generation jobs", + "summary": "Returns a list of data generation jobs", "description": "Returns a list of data generation jobs.", "parameters": [ { @@ -3897,18 +3880,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -3929,8 +3902,8 @@ }, "post": { "operationId": "DataGenerationJobs_create", - "summary": "Create a data generation job", - "description": "Submits a new data generation job for asynchronous execution.", + "summary": "Creates a data generation job.", + "description": "Creates a data generation job.", "parameters": [ { "name": "Foundry-Features", @@ -3991,18 +3964,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -4036,8 +3999,8 @@ "/data_generation_jobs/{jobId}": { "get": { "operationId": "DataGenerationJobs_get", - "summary": "Get a data generation job", - "description": "Retrieves the specified data generation job and its current status.", + "summary": "Get info about a data generation job.", + "description": "Gets the details of a data generation job by its ID.", "parameters": [ { "name": "Foundry-Features", @@ -4092,18 +4055,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -4124,8 +4077,8 @@ }, "delete": { "operationId": "DataGenerationJobs_delete", - "summary": "Delete a data generation job", - "description": "Removes the specified data generation job and its associated output.", + "summary": "Deletes a data generation job.", + "description": "Deletes a data generation job by its ID.", "parameters": [ { "name": "Foundry-Features", @@ -4163,18 +4116,8 @@ "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", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -4197,8 +4140,8 @@ "/data_generation_jobs/{jobId}:cancel": { "post": { "operationId": "DataGenerationJobs_cancel", - "summary": "Cancel a data generation job", - "description": "Cancels the specified data generation job if it is still in progress.", + "summary": "Cancels a data generation job.", + "description": "Cancels a data generation job by its ID.", "parameters": [ { "name": "Foundry-Features", @@ -4243,18 +4186,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -4277,7 +4210,6 @@ "/datasets": { "get": { "operationId": "Datasets_listLatest", - "summary": "List latest versions", "description": "List the latest version of each DatasetVersion", "parameters": [ { @@ -4295,27 +4227,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -4342,7 +4255,6 @@ "/datasets/{name}/versions": { "get": { "operationId": "Datasets_listVersions", - "summary": "List versions", "description": "List all versions of the given DatasetVersion", "parameters": [ { @@ -4369,27 +4281,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -4416,7 +4309,6 @@ "/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": [ { @@ -4452,27 +4344,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -4497,7 +4370,6 @@ }, "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": [ { @@ -4526,27 +4398,8 @@ "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -4571,7 +4424,6 @@ }, "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": [ { @@ -4617,27 +4469,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -4675,8 +4508,7 @@ "/datasets/{name}/versions/{version}/credentials": { "post": { "operationId": "Datasets_getCredentials", - "summary": "Get dataset credentials", - "description": "Gets the SAS credential to access the storage account associated with a Dataset version.", + "description": "Get the SAS credential to access the storage account associated with a Dataset version.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -4711,27 +4543,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -4758,8 +4571,7 @@ "/datasets/{name}/versions/{version}/startPendingUpload": { "post": { "operationId": "Datasets_startPendingUploadVersion", - "summary": "Start a pending upload", - "description": "Initiates a new pending upload or retrieves an existing one for the specified dataset version.", + "description": "Start a new or get an existing pending upload of a dataset for a specific version.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -4794,27 +4606,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -4852,8 +4645,7 @@ "/deployments": { "get": { "operationId": "Deployments_list", - "summary": "List deployments", - "description": "Returns the deployed models available in the current project, optionally filtered by publisher, model name, or deployment type.", + "description": "List all deployed models in the project", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -4912,27 +4704,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -4959,8 +4732,7 @@ "/deployments/{name}": { "get": { "operationId": "Deployments_get", - "summary": "Get a deployment", - "description": "Gets a deployed model.", + "description": "Get a deployed model.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -4998,27 +4770,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -5045,8 +4798,7 @@ "/evaluationrules": { "get": { "operationId": "EvaluationRules_list", - "summary": "List evaluation rules", - "description": "Returns the evaluation rules configured for the project, optionally filtered by action type, agent name, or enabled state.", + "description": "List all evaluation rules.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -5093,27 +4845,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -5140,8 +4873,7 @@ "/evaluationrules/{id}": { "get": { "operationId": "EvaluationRules_get", - "summary": "Get an evaluation rule", - "description": "Retrieves the specified evaluation rule and its configuration.", + "description": "Get an evaluation rule.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -5167,27 +4899,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -5212,8 +4925,7 @@ }, "delete": { "operationId": "EvaluationRules_delete", - "summary": "Delete an evaluation rule", - "description": "Removes the specified evaluation rule from the project.", + "description": "Delete an evaluation rule.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -5232,27 +4944,8 @@ "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -5277,8 +4970,7 @@ }, "put": { "operationId": "EvaluationRules_createOrUpdate", - "summary": "Create or update an evaluation rule", - "description": "Creates a new evaluation rule, or replaces the existing rule when the identifier matches.", + "description": "Create or update an evaluation rule.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -5326,27 +5018,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -5384,8 +5057,7 @@ "/evaluationtaxonomies": { "get": { "operationId": "EvaluationTaxonomies_list", - "summary": "List evaluation taxonomies", - "description": "Returns the evaluation taxonomies available in the project, optionally filtered by input name or input type.", + "description": "List evaluation taxonomies", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -5434,27 +5106,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -5481,8 +5134,7 @@ "/evaluationtaxonomies/{name}": { "get": { "operationId": "EvaluationTaxonomies_get", - "summary": "Get an evaluation taxonomy", - "description": "Retrieves the specified evaluation taxonomy.", + "description": "Get an evaluation run by name.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -5520,27 +5172,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -5565,8 +5198,7 @@ }, "delete": { "operationId": "EvaluationTaxonomies_delete", - "summary": "Delete an evaluation taxonomy", - "description": "Removes the specified evaluation taxonomy from the project.", + "description": "Delete an evaluation taxonomy by name.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -5597,27 +5229,8 @@ "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -5642,8 +5255,7 @@ }, "put": { "operationId": "EvaluationTaxonomies_create", - "summary": "Create an evaluation taxonomy", - "description": "Creates or replaces the specified evaluation taxonomy with the provided definition.", + "description": "Create an evaluation taxonomy.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -5691,27 +5303,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -5747,7 +5340,6 @@ }, "patch": { "operationId": "EvaluationTaxonomies_update", - "summary": "Update an evaluation taxonomy", "description": "Update an evaluation taxonomy.", "parameters": [ { @@ -5786,27 +5378,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -5844,7 +5417,7 @@ "/evaluator_generation_jobs": { "post": { "operationId": "EvaluatorGenerationJobs_create", - "summary": "Create an evaluator generation job", + "summary": "Creates an evaluator generation job.", "description": "Creates an evaluator generation job. The service generates rubric-based evaluator\ndefinitions from the provided source materials asynchronously.", "parameters": [ { @@ -5906,18 +5479,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -5949,8 +5512,8 @@ }, "get": { "operationId": "EvaluatorGenerationJobs_list", - "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.", + "summary": "Returns a list of evaluator generation jobs.", + "description": "Returns a list of evaluator generation jobs.", "parameters": [ { "name": "Foundry-Features", @@ -6054,18 +5617,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -6088,7 +5641,7 @@ "/evaluator_generation_jobs/{jobId}": { "get": { "operationId": "EvaluatorGenerationJobs_get", - "summary": "Get an evaluator generation job", + "summary": "Get info about an evaluator generation job.", "description": "Gets the details of an evaluator generation job by its ID.", "parameters": [ { @@ -6144,18 +5697,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -6176,7 +5719,6 @@ }, "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": [ { @@ -6215,18 +5757,8 @@ "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", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -6249,7 +5781,7 @@ "/evaluator_generation_jobs/{jobId}:cancel": { "post": { "operationId": "EvaluatorGenerationJobs_cancel", - "summary": "Cancel an evaluator generation job", + "summary": "Cancels an evaluator generation job.", "description": "Cancels an evaluator generation job by its ID.", "parameters": [ { @@ -6295,18 +5827,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -6329,8 +5851,7 @@ "/evaluators": { "get": { "operationId": "Evaluators_listLatestVersions", - "summary": "List latest evaluator versions", - "description": "Lists the latest version of each evaluator", + "description": "List the latest version of each evaluator", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -6391,27 +5912,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -6438,8 +5940,7 @@ "/evaluators/{name}/versions": { "get": { "operationId": "Evaluators_listVersions", - "summary": "List evaluator versions", - "description": "Returns the available versions for the specified evaluator.", + "description": "List all versions of the given evaluator", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -6509,27 +6010,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -6554,8 +6036,7 @@ }, "post": { "operationId": "Evaluators_createVersion", - "summary": "Create an evaluator version", - "description": "Creates a new evaluator version with an auto-incremented version identifier.", + "description": "Create a new EvaluatorVersion with auto incremented version id", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -6593,27 +6074,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -6650,8 +6112,7 @@ "/evaluators/{name}/versions/{version}": { "get": { "operationId": "Evaluators_getVersion", - "summary": "Get an evaluator version", - "description": "Retrieves the specified evaluator version, returning 404 if it does not exist.", + "description": "Get the specific version of the EvaluatorVersion. The service returns 404 Not Found error if the EvaluatorVersion does not exist.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -6698,27 +6159,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -6743,8 +6185,7 @@ }, "delete": { "operationId": "Evaluators_deleteVersion", - "summary": "Delete an evaluator version", - "description": "Removes the specified evaluator version. Returns 204 whether the version existed or not.", + "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.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -6784,27 +6225,8 @@ "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -6829,8 +6251,7 @@ }, "patch": { "operationId": "Evaluators_updateVersion", - "summary": "Update an evaluator version", - "description": "Updates the specified evaluator version in place.", + "description": "Update an existing EvaluatorVersion with the given version id", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -6877,27 +6298,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -6935,8 +6337,7 @@ "/evaluators/{name}/versions/{version}/credentials": { "post": { "operationId": "Evaluators_getCredentials", - "summary": "Get evaluator credentials", - "description": "Retrieves SAS credentials for accessing the storage account associated with the specified evaluator version.", + "description": "Get the SAS credential to access the storage account associated with an Evaluator version.", "parameters": [ { "name": "Foundry-Features", @@ -6989,18 +6390,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -7034,8 +6425,7 @@ "/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.", + "description": "Start a new or get an existing pending upload of an evaluator for a specific version.", "parameters": [ { "name": "Foundry-Features", @@ -7088,18 +6478,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -7133,7 +6513,6 @@ "/indexes": { "get": { "operationId": "Indexes_listLatest", - "summary": "List latest versions", "description": "List the latest version of each Index", "parameters": [ { @@ -7151,27 +6530,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -7198,7 +6558,6 @@ "/indexes/{name}/versions": { "get": { "operationId": "Indexes_listVersions", - "summary": "List versions", "description": "List all versions of the given Index", "parameters": [ { @@ -7225,27 +6584,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -7272,7 +6612,6 @@ "/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": [ { @@ -7308,27 +6647,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -7353,7 +6673,6 @@ }, "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": [ { @@ -7382,27 +6701,8 @@ "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -7427,7 +6727,6 @@ }, "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": [ { @@ -7473,27 +6772,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -7531,8 +6811,7 @@ "/insights": { "post": { "operationId": "Insights_generate", - "summary": "Generate insights", - "description": "Generates an insights report from the provided evaluation configuration.", + "description": "Generate Insights", "parameters": [ { "name": "Foundry-Features", @@ -7587,18 +6866,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -7625,8 +6894,7 @@ }, "get": { "operationId": "Insights_list", - "summary": "List insights", - "description": "Returns insights in reverse chronological order, with the most recent entries first.", + "description": "List all insights in reverse chronological order (newest first).", "parameters": [ { "name": "Foundry-Features", @@ -7712,18 +6980,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -7741,8 +6999,7 @@ "/insights/{id}": { "get": { "operationId": "Insights_get", - "summary": "Get an insight", - "description": "Retrieves the specified insight report and its results.", + "description": "Get a specific insight by Id.", "parameters": [ { "name": "Foundry-Features", @@ -7797,18 +7054,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -7826,8 +7073,7 @@ "/memory_stores": { "post": { "operationId": "createMemoryStore", - "summary": "Create a memory store", - "description": "Creates a memory store resource with the provided configuration.", + "description": "Create a memory store.", "parameters": [ { "name": "Foundry-Features", @@ -7863,18 +7109,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -7906,7 +7142,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Arbitrary key-value metadata to associate with the memory store." @@ -7936,8 +7172,7 @@ }, "get": { "operationId": "listMemoryStores", - "summary": "List memory stores", - "description": "Returns the memory stores available to the caller.", + "description": "List all memory stores.", "parameters": [ { "name": "Foundry-Features", @@ -8041,18 +7276,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -8075,8 +7300,7 @@ "/memory_stores/{name}": { "post": { "operationId": "updateMemoryStore", - "summary": "Update a memory store", - "description": "Updates the specified memory store with the supplied configuration changes.", + "description": "Update a memory store.", "parameters": [ { "name": "Foundry-Features", @@ -8121,18 +7345,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -8159,7 +7373,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Arbitrary key-value metadata to associate with the memory store." @@ -8177,8 +7391,7 @@ }, "get": { "operationId": "getMemoryStore", - "summary": "Get a memory store", - "description": "Retrieves the specified memory store and its current configuration.", + "description": "Retrieve a memory store.", "parameters": [ { "name": "Foundry-Features", @@ -8223,18 +7436,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -8255,8 +7458,7 @@ }, "delete": { "operationId": "deleteMemoryStore", - "summary": "Delete a memory store", - "description": "Deletes the specified memory store.", + "description": "Delete a memory store.", "parameters": [ { "name": "Foundry-Features", @@ -8301,18 +7503,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -8335,8 +7527,7 @@ "/memory_stores/{name}/items": { "post": { "operationId": "createMemory", - "summary": "Create a memory item", - "description": "Creates a memory item in the specified memory store.", + "description": "Create a memory item in a memory store.", "parameters": [ { "name": "Foundry-Features", @@ -8381,18 +7572,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -8448,8 +7629,7 @@ "/memory_stores/{name}/items/{memory_id}": { "post": { "operationId": "updateMemory", - "summary": "Update a memory item", - "description": "Updates the specified memory item in the memory store.", + "description": "Update a memory item in a memory store.", "parameters": [ { "name": "Foundry-Features", @@ -8503,18 +7683,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -8554,8 +7724,7 @@ }, "get": { "operationId": "getMemory", - "summary": "Get a memory item", - "description": "Retrieves the specified memory item from the memory store.", + "description": "Retrieve a memory item from a memory store.", "parameters": [ { "name": "Foundry-Features", @@ -8609,18 +7778,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -8641,8 +7800,7 @@ }, "delete": { "operationId": "deleteMemory", - "summary": "Delete a memory item", - "description": "Deletes the specified memory item from the memory store.", + "description": "Delete a memory item from a memory store.", "parameters": [ { "name": "Foundry-Features", @@ -8696,18 +7854,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -8730,8 +7878,7 @@ "/memory_stores/{name}/items:list": { "post": { "operationId": "listMemories", - "summary": "List memory items", - "description": "Returns memory items from the specified memory store.", + "description": "List all memory items in a memory store.", "parameters": [ { "name": "Foundry-Features", @@ -8854,18 +8001,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -8907,8 +8044,7 @@ "/memory_stores/{name}/updates/{update_id}": { "get": { "operationId": "getUpdateResult", - "summary": "Get an update result", - "description": "Retrieves the status and result of a memory store update operation.", + "description": "Get memory store update result.", "parameters": [ { "name": "Foundry-Features", @@ -8962,18 +8098,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -8996,8 +8122,7 @@ "/memory_stores/{name}:delete_scope": { "post": { "operationId": "deleteScopeMemories", - "summary": "Delete memories by scope", - "description": "Deletes all memories in the specified memory store that are associated with the provided scope.", + "description": "Delete all memories associated with a specific scope from a memory store.", "parameters": [ { "name": "Foundry-Features", @@ -9042,18 +8167,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -9095,8 +8210,7 @@ "/memory_stores/{name}:search_memories": { "post": { "operationId": "searchMemories", - "summary": "Search memories", - "description": "Searches the specified memory store for memories relevant to the provided conversation context.", + "description": "Search for relevant memories from a memory store based on conversation context.", "parameters": [ { "name": "Foundry-Features", @@ -9141,18 +8255,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -9213,8 +8317,7 @@ "/memory_stores/{name}:update_memories": { "post": { "operationId": "updateMemories", - "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.", + "description": "Update memory store with conversation memories.", "parameters": [ { "name": "Foundry-Features", @@ -9269,18 +8372,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -9339,7 +8432,6 @@ "/models": { "get": { "operationId": "Models_listLatest", - "summary": "List latest versions", "description": "List the latest version of each ModelVersion", "parameters": [ { @@ -9369,27 +8461,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -9416,7 +8489,6 @@ "/models/{name}/versions": { "get": { "operationId": "Models_listVersions", - "summary": "List versions", "description": "List all versions of the given ModelVersion", "parameters": [ { @@ -9455,27 +8527,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -9502,8 +8555,7 @@ "/models/{name}/versions/{version}": { "get": { "operationId": "Models_getVersion", - "summary": "Get a model version", - "description": "Retrieves the specified model version, returning 404 if it does not exist.", + "description": "Get the specific version of the ModelVersion. The service returns 404 Not Found error if the ModelVersion does not exist.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -9550,27 +8602,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -9600,7 +8633,6 @@ }, "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": [ { @@ -9641,27 +8673,8 @@ "200": { "description": "The request has succeeded." }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -9691,7 +8704,6 @@ }, "patch": { "operationId": "Models_updateVersion", - "summary": "Update a model version", "description": "Update an existing ModelVersion with the given version id", "parameters": [ { @@ -9749,27 +8761,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -9812,8 +8805,7 @@ "/models/{name}/versions/{version}/createAsync": { "post": { "operationId": "Models_createAsync", - "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.", + "description": "Creates a model version asynchronously with blob content validation. Returns 202 Accepted with a Location header for polling.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -9873,15 +8865,9 @@ "description": "URL to poll for operation status." }, "operationResult": { - "anyOf": [ - { - "type": "string", - "format": "uri" - }, - { - "type": "null" - } - ], + "type": "string", + "format": "uri", + "nullable": true, "description": "URL to the operation result, or null if the operation is still in progress." } } @@ -9889,27 +8875,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -9952,8 +8919,7 @@ "/models/{name}/versions/{version}/credentials": { "post": { "operationId": "Models_getCredentials", - "summary": "Get model asset credentials", - "description": "Retrieves temporary credentials for accessing the storage backing the specified model version.", + "description": "Get credentials for a model version asset.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -10000,27 +8966,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -10062,8 +9009,7 @@ "/models/{name}/versions/{version}/startPendingUpload": { "post": { "operationId": "Models_startPendingUpload", - "summary": "Start a pending upload", - "description": "Initiates a new pending upload or retrieves an existing one for the specified model version.", + "description": "Start or retrieve a pending upload for a model version.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -10110,27 +9056,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -10172,8 +9099,7 @@ "/openai/v1/conversations": { "post": { "operationId": "createConversation", - "summary": "Create a conversation", - "description": "Creates a new conversation resource.", + "description": "Create a conversation.", "parameters": [ { "name": "x-ms-user-isolation-key", @@ -10196,18 +9122,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -10233,8 +9149,7 @@ }, "get": { "operationId": "listConversations", - "summary": "List conversations", - "description": "Returns the conversations available in the current project.", + "description": "Returns the list of all conversations.", "parameters": [ { "name": "limit", @@ -10345,18 +9260,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -10374,8 +9279,7 @@ "/openai/v1/conversations/{conversation_id}": { "post": { "operationId": "updateConversation", - "summary": "Update a conversation", - "description": "Modifies the specified conversation's properties.", + "description": "Update a conversation.", "parameters": [ { "name": "conversation_id", @@ -10407,18 +9311,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -10444,8 +9338,7 @@ }, "get": { "operationId": "getConversation", - "summary": "Retrieve a conversation", - "description": "Retrieves the specified conversation and its metadata.", + "description": "Retrieves a conversation.", "parameters": [ { "name": "conversation_id", @@ -10477,18 +9370,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -10504,8 +9387,7 @@ }, "delete": { "operationId": "deleteConversation", - "summary": "Delete a conversation", - "description": "Removes the specified conversation resource from the current project.", + "description": "Deletes a conversation.", "parameters": [ { "name": "conversation_id", @@ -10537,18 +9419,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -10566,8 +9438,7 @@ "/openai/v1/conversations/{conversation_id}/items": { "post": { "operationId": "createConversationItems", - "summary": "Create conversation items", - "description": "Adds one or more items to the specified conversation.", + "description": "Create items in a conversation with the given ID.", "parameters": [ { "name": "conversation_id", @@ -10612,18 +9483,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -10662,8 +9523,7 @@ }, "get": { "operationId": "listConversationItems", - "summary": "List conversation items", - "description": "Returns the items belonging to the specified conversation.", + "description": "List all items for a conversation with the given ID.", "parameters": [ { "name": "conversation_id", @@ -10773,18 +9633,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -10802,8 +9652,7 @@ "/openai/v1/conversations/{conversation_id}/items/{item_id}": { "get": { "operationId": "getConversationItem", - "summary": "Get a conversation item", - "description": "Retrieves a specific item from the specified conversation.", + "description": "Get a single item from a conversation with the given IDs.", "parameters": [ { "name": "conversation_id", @@ -10844,18 +9693,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -10871,8 +9710,7 @@ }, "delete": { "operationId": "deleteConversationItem", - "summary": "Delete a conversation item", - "description": "Removes the specified item from a conversation.", + "description": "Delete an item from a conversation with the given IDs.", "parameters": [ { "name": "conversation_id", @@ -10913,18 +9751,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -10942,8 +9770,8 @@ "/openai/v1/evals": { "get": { "operationId": "Evals_listEvals", - "summary": "List evaluations", - "description": "Returns the evaluations configured in the current project.", + "summary": "List all evaluations", + "description": "List evaluations for a project.", "parameters": [ { "name": "after", @@ -10961,7 +9789,11 @@ "required": false, "description": "Number of runs to retrieve.", "schema": { - "$ref": "#/components/schemas/integer", + "allOf": [ + { + "$ref": "#/components/schemas/integer" + } + ], "default": 20 }, "explode": false @@ -11033,18 +9865,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -11060,8 +9882,8 @@ }, "post": { "operationId": "Evals_createEval", - "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).", + "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).", "parameters": [], "responses": { "200": { @@ -11074,18 +9896,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -11114,7 +9926,7 @@ "delete": { "operationId": "Evals_deleteEval", "summary": "Delete an evaluation", - "description": "Removes the specified evaluation and its associated data.", + "description": "Delete an evaluation.", "parameters": [ { "name": "eval_id", @@ -11137,18 +9949,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -11165,7 +9967,7 @@ "get": { "operationId": "Evals_getEval", "summary": "Get an evaluation", - "description": "Retrieves the specified evaluation and its configuration.", + "description": "Get an evaluation by ID.", "parameters": [ { "name": "eval_id", @@ -11188,18 +9990,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -11216,7 +10008,7 @@ "post": { "operationId": "Evals_updateEval", "summary": "Update an evaluation", - "description": "Updates certain properties of an evaluation.", + "description": "Update certain properties of an evaluation.", "parameters": [ { "name": "eval_id", @@ -11239,18 +10031,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -11278,8 +10060,8 @@ "/openai/v1/evals/{eval_id}/runs": { "get": { "operationId": "Evals_listRuns", - "summary": "List evaluation runs", - "description": "Returns the runs associated with the specified evaluation.", + "summary": "Get a list of runs for an evaluation", + "description": "Get a list of runs for an evaluation.", "parameters": [ { "name": "eval_id", @@ -11306,7 +10088,11 @@ "required": false, "description": "Number of runs to retrieve.", "schema": { - "$ref": "#/components/schemas/integer", + "allOf": [ + { + "$ref": "#/components/schemas/integer" + } + ], "default": 20 }, "explode": false @@ -11381,18 +10167,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -11408,8 +10184,7 @@ }, "post": { "operationId": "Evals_createEvalRun", - "summary": "Create an evaluation run", - "description": "Creates an evaluation run for the specified evaluation.", + "summary": "Create evaluation run", "parameters": [ { "name": "eval_id", @@ -11432,18 +10207,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -11471,8 +10236,8 @@ "/openai/v1/evals/{eval_id}/runs/{run_id}": { "delete": { "operationId": "Evals_deleteEvalRun", - "summary": "Delete an evaluation run", - "description": "Removes the specified evaluation run.", + "summary": "Delete evaluation run", + "description": "Delete an eval run.", "parameters": [ { "name": "eval_id", @@ -11504,18 +10269,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -11532,7 +10287,7 @@ "get": { "operationId": "Evals_getEvalRun", "summary": "Get an evaluation run", - "description": "Retrieves the specified evaluation run and its current status.", + "description": "Get an evaluation run by ID.", "parameters": [ { "name": "eval_id", @@ -11564,18 +10319,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -11591,8 +10336,8 @@ }, "post": { "operationId": "Evals_cancelEvalRun", - "summary": "Cancel an evaluation run", - "description": "Cancels an ongoing evaluation run.", + "summary": "Cancel evaluation run", + "description": "Cancel an ongoing evaluation run.", "parameters": [ { "name": "eval_id", @@ -11624,18 +10369,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -11653,8 +10388,8 @@ "/openai/v1/evals/{eval_id}/runs/{run_id}/output_items": { "get": { "operationId": "Evals_getEvalRunOutputItems", - "summary": "List evaluation run output items", - "description": "Returns the output items produced by the specified evaluation run.", + "summary": "Get evaluation run output items", + "description": "Get a list of output items for an evaluation run.", "parameters": [ { "name": "eval_id", @@ -11689,7 +10424,11 @@ "required": false, "description": "Number of runs to retrieve.", "schema": { - "$ref": "#/components/schemas/integer", + "allOf": [ + { + "$ref": "#/components/schemas/integer" + } + ], "default": 20 }, "explode": false @@ -11760,18 +10499,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -11790,7 +10519,7 @@ "get": { "operationId": "Evals_getEvalRunOutputItem", "summary": "Get an output item of an evaluation run", - "description": "Retrieves a single output item from the specified evaluation run.", + "description": "Get an evaluation run output item by ID.", "parameters": [ { "name": "eval_id", @@ -11831,18 +10560,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -11860,7 +10579,6 @@ "/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": [ { @@ -11885,18 +10603,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -11922,8 +10630,7 @@ }, "get": { "operationId": "listPaginatedFineTuningJobs", - "summary": "List fine-tuning jobs", - "description": "Returns the fine-tuning jobs for the current organization.", + "description": "List your organization's fine-tuning jobs", "parameters": [ { "name": "after", @@ -11969,18 +10676,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -11998,8 +10695,7 @@ "/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}": { "get": { "operationId": "retrieveFineTuningJob", - "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)", + "description": "Get 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", @@ -12032,18 +10728,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -12061,8 +10747,7 @@ "/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel": { "post": { "operationId": "cancelFineTuningJob", - "summary": "Cancel a fine-tuning job", - "description": "Immediately cancels the specified fine-tuning job.", + "description": "Immediately cancel a fine-tune job.", "parameters": [ { "name": "fine_tuning_job_id", @@ -12095,18 +10780,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -12124,8 +10799,7 @@ "/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints": { "get": { "operationId": "listFineTuningJobCheckpoints", - "summary": "List fine-tuning job checkpoints", - "description": "Returns the checkpoints saved during the specified fine-tuning job.", + "description": "List checkpoints for a fine-tuning job.", "parameters": [ { "name": "fine_tuning_job_id", @@ -12180,18 +10854,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -12209,8 +10873,7 @@ "/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events": { "get": { "operationId": "listFineTuningJobEvents", - "summary": "List fine-tuning job events", - "description": "Returns the status events emitted during the specified fine-tuning job.", + "description": "Get fine-grained status updates for a fine-tuning job.", "parameters": [ { "name": "fine_tuning_job_id", @@ -12265,18 +10928,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -12294,8 +10947,7 @@ "/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause": { "post": { "operationId": "pauseFineTuningJob", - "summary": "Pause a fine-tuning job", - "description": "Pauses the specified fine-tuning job while it is running.", + "description": "Pause a running fine-tune job.", "parameters": [ { "name": "fine_tuning_job_id", @@ -12328,18 +10980,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -12357,8 +10999,7 @@ "/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume": { "post": { "operationId": "resumeFineTuningJob", - "summary": "Resume a fine-tuning job", - "description": "Resumes the specified fine-tuning job after it has been paused.", + "description": "Resume a paused fine-tune job.", "parameters": [ { "name": "fine_tuning_job_id", @@ -12391,18 +11032,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -12419,9 +11050,7 @@ }, "/openai/v1/responses": { "post": { - "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.", + "operationId": "createResponse_createResponseStream", "parameters": [ { "name": "x-ms-user-isolation-key", @@ -12433,6 +11062,7 @@ } } ], + "description": "Creates a model response. Creates a model response (streaming response).", "responses": { "200": { "description": "The request has succeeded.", @@ -12448,322 +11078,7 @@ "content": { "application/json": { "schema": { - "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" - ] + "$ref": "#/components/schemas/OpenAI.Response" } }, "text/event-stream": { @@ -12773,18 +11088,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -12802,285 +11107,408 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "metadata": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.Metadata" + "anyOf": [ + { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Metadata" + } + ], + "nullable": true }, - { - "type": "null" - } - ] - }, - "top_logprobs": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" + "top_logprobs": { + "type": "integer", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + } + ], + "nullable": true }, - { - "type": "null" - } - ] - }, - "temperature": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.numeric" + "temperature": { + "type": "number", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.numeric" + } + ], + "nullable": true, + "default": 1 }, - { - "type": "null" - } - ], - "default": 1 - }, - "top_p": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.numeric" + "top_p": { + "type": "number", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.numeric" + } + ], + "nullable": true, + "default": 1 }, - { - "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": [ - { + "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", + "in-memory", "24h" - ] + ], + "nullable": true }, - { - "type": "null" - } - ] - }, - "previous_response_id": { - "anyOf": [ - { - "type": "string" + "previous_response_id": { + "type": "string", + "nullable": true }, - { - "type": "null" - } - ] - }, - "model": { - "type": "string", - "description": "The model deployment to use for the creation of this response." - }, - "reasoning": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.Reasoning" + "model": { + "type": "string", + "description": "The model deployment to use for the creation of this response." }, - { - "type": "null" - } - ] - }, - "background": { - "anyOf": [ - { - "type": "boolean" + "reasoning": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Reasoning" + } + ], + "nullable": true }, - { - "type": "null" - } - ] - }, - "max_tool_calls": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" + "background": { + "type": "boolean", + "nullable": true }, - { - "type": "null" - } - ] - }, - "text": { - "$ref": "#/components/schemas/OpenAI.ResponseTextParam" - }, - "tools": { - "$ref": "#/components/schemas/OpenAI.ToolsArray" - }, - "tool_choice": { - "oneOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolChoiceOptions" + "max_output_tokens": { + "type": "integer", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + } + ], + "nullable": true }, - { - "$ref": "#/components/schemas/OpenAI.ToolChoiceParam" - } - ] - }, - "prompt": { - "$ref": "#/components/schemas/OpenAI.Prompt" - }, - "truncation": { - "anyOf": [ - { + "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" }, - { - "type": "null" - } - ], - "default": "disabled" - }, - "input": { - "$ref": "#/components/schemas/OpenAI.InputParam" - }, - "include": { - "anyOf": [ - { + "input": { + "$ref": "#/components/schemas/OpenAI.InputParam" + }, + "include": { "type": "array", "items": { "$ref": "#/components/schemas/OpenAI.IncludeEnum" - } + }, + "nullable": true }, - { - "type": "null" - } - ] - }, - "parallel_tool_calls": { - "anyOf": [ - { - "type": "boolean" + "parallel_tool_calls": { + "type": "boolean", + "nullable": true, + "default": true }, - { - "type": "null" - } - ], - "default": true - }, - "store": { - "anyOf": [ - { - "type": "boolean" + "store": { + "type": "boolean", + "nullable": true, + "default": true }, - { - "type": "null" - } - ], - "default": true - }, - "instructions": { - "anyOf": [ - { - "type": "string" + "instructions": { + "type": "string", + "nullable": true }, - { - "type": "null" - } - ] - }, - "moderation": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.ModerationParam" + "stream": { + "type": "boolean", + "nullable": true }, - { - "type": "null" - } - ] - }, - "stream": { - "anyOf": [ - { - "type": "boolean" + "stream_options": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamOptions" + } + ], + "nullable": true }, - { - "type": "null" - } - ] - }, - "stream_options": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamOptions" + "conversation": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationParam" + } + ], + "nullable": true }, - { - "type": "null" - } - ] - }, - "conversation": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.ConversationParam" + "context_management": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ContextManagementParam" + }, + "nullable": true, + "description": "Context management configuration for this request." }, - { - "type": "null" + "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." } - ] + } }, - "context_management": { - "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 + }, + "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 + }, + "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." }, - { - "type": "null" - } - ], - "description": "Context management configuration for this request." - }, - "max_output_tokens": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" + "agent_reference": { + "allOf": [ + { + "$ref": "#/components/schemas/AgentReference" + } + ], + "description": "The agent to use for generating the response." }, - { - "type": "null" + "structured_inputs": { + "type": "object", + "additionalProperties": {}, + "description": "The structured inputs to the response that can participate in prompt template substitution or tool argument bindings." } - ] - }, - "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." + } } - } + ] } } } @@ -13088,8 +11516,7 @@ }, "get": { "operationId": "listResponses", - "summary": "List responses", - "description": "Returns a collection of all stored responses matching specified filter criteria.", + "description": "Returns the list of all responses.", "parameters": [ { "name": "limit", @@ -13210,18 +11637,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -13239,8 +11656,7 @@ "/openai/v1/responses/compact": { "post": { "operationId": "compactResponseConversation", - "summary": "Compact a conversation", - "description": "Compacts a conversation into a response object suitable for long-running and zero-data-retention scenarios.", + "description": "Produces a compaction of a responses conversation.", "parameters": [], "responses": { "200": { @@ -13253,18 +11669,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -13291,9 +11697,7 @@ }, "/openai/v1/responses/{response_id}": { "get": { - "operationId": "getResponse", - "summary": "Retrieve a model response", - "description": "Retrieves a model response with the given ID.", + "operationId": "getResponse_getResponseStream", "parameters": [ { "name": "response_id", @@ -13343,8 +11747,20 @@ "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.", @@ -13370,18 +11786,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -13397,7 +11803,6 @@ }, "delete": { "operationId": "deleteResponse", - "summary": "Delete a model response", "description": "Deletes a model response.", "parameters": [ { @@ -13439,18 +11844,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -13468,8 +11863,7 @@ "/openai/v1/responses/{response_id}/cancel": { "post": { "operationId": "cancelResponse", - "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.", + "description": "Cancels a model response.", "parameters": [ { "name": "response_id", @@ -13510,18 +11904,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -13539,8 +11923,7 @@ "/openai/v1/responses/{response_id}/input_items": { "get": { "operationId": "listInputItems", - "summary": "List input items for a response", - "description": "Retrieves the input items associated with the specified response.", + "description": "Returns a list of input items for a given response.", "parameters": [ { "name": "response_id", @@ -13648,18 +12031,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -13677,8 +12050,7 @@ "/redTeams/runs": { "get": { "operationId": "RedTeams_list", - "summary": "List redteams", - "description": "Returns the redteams available in the current project.", + "description": "List a redteam by name.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -13707,27 +12079,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -13754,8 +12107,7 @@ "/redTeams/runs/{name}": { "get": { "operationId": "RedTeams_get", - "summary": "Get a redteam", - "description": "Retrieves the specified redteam and its configuration.", + "description": "Get a redteam by name.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -13793,27 +12145,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -13840,8 +12173,7 @@ "/redTeams/runs:run": { "post": { "operationId": "RedTeams_create", - "summary": "Create a redteam run", - "description": "Submits a new redteam run for execution with the provided configuration.", + "description": "Creates a redteam run.", "parameters": [ { "name": "Foundry-Features", @@ -13877,18 +12209,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -13917,8 +12239,7 @@ "/routines": { "get": { "operationId": "listRoutines", - "summary": "List routines", - "description": "Returns the routines available in the current project.", + "description": "List routines.", "parameters": [ { "name": "Foundry-Features", @@ -13933,16 +12254,46 @@ } }, { - "$ref": "#/components/parameters/ListRoutinesParameters.limit" + "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.after" + "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.before" + "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.order" + "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", @@ -13992,18 +12343,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -14026,8 +12367,7 @@ "/routines/{routine_name}": { "put": { "operationId": "createOrUpdateRoutine", - "summary": "Create or update a routine", - "description": "Creates a new routine or replaces an existing routine with the supplied definition.", + "description": "Create or update a routine.", "parameters": [ { "name": "Foundry-Features", @@ -14066,18 +12406,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -14108,8 +12438,7 @@ }, "get": { "operationId": "getRoutine", - "summary": "Get a routine", - "description": "Retrieves the specified routine and its current configuration.", + "description": "Retrieve a routine.", "parameters": [ { "name": "Foundry-Features", @@ -14148,18 +12477,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -14180,8 +12499,7 @@ }, "delete": { "operationId": "deleteRoutine", - "summary": "Delete a routine", - "description": "Deletes the specified routine.", + "description": "Delete a routine.", "parameters": [ { "name": "Foundry-Features", @@ -14213,18 +12531,8 @@ "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", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -14247,8 +12555,7 @@ "/routines/{routine_name}/runs": { "get": { "operationId": "listRoutineRuns", - "summary": "List prior runs for a routine", - "description": "Returns prior runs recorded for the specified routine.", + "description": "List prior runs for a routine.", "parameters": [ { "name": "Foundry-Features", @@ -14269,16 +12576,46 @@ "$ref": "#/components/parameters/ListRoutineRunsParameters.filter" }, { - "$ref": "#/components/parameters/ListRoutineRunsParameters.limit" + "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.after" + "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.before" + "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.order" + "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", @@ -14328,18 +12665,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -14362,8 +12689,7 @@ "/routines/{routine_name}:disable": { "post": { "operationId": "disableRoutine", - "summary": "Disable a routine", - "description": "Disables the specified routine so it no longer runs.", + "description": "Disable a routine.", "parameters": [ { "name": "Foundry-Features", @@ -14402,18 +12728,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -14436,8 +12752,7 @@ "/routines/{routine_name}:dispatch_async": { "post": { "operationId": "dispatchRoutineAsync", - "summary": "Queue an asynchronous routine dispatch", - "description": "Queues an asynchronous dispatch for the specified routine.", + "description": "Queue an asynchronous routine dispatch.", "parameters": [ { "name": "Foundry-Features", @@ -14476,18 +12791,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -14520,8 +12825,7 @@ "/routines/{routine_name}:enable": { "post": { "operationId": "enableRoutine", - "summary": "Enable a routine", - "description": "Enables the specified routine so it can be dispatched.", + "description": "Enable a routine.", "parameters": [ { "name": "Foundry-Features", @@ -14560,18 +12864,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -14594,8 +12888,7 @@ "/schedules": { "get": { "operationId": "Schedules_list", - "summary": "List schedules", - "description": "Returns schedules that match the supplied type and enabled filters.", + "description": "List all schedules.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -14644,27 +12937,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -14691,8 +12965,7 @@ "/schedules/{id}": { "delete": { "operationId": "Schedules_delete", - "summary": "Delete a schedule", - "description": "Deletes the specified schedule resource.", + "description": "Delete a schedule.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -14723,27 +12996,8 @@ "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -14768,8 +13022,7 @@ }, "get": { "operationId": "Schedules_get", - "summary": "Get a schedule", - "description": "Retrieves the specified schedule resource.", + "description": "Get a schedule by id.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -14807,27 +13060,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -14852,8 +13086,7 @@ }, "put": { "operationId": "Schedules_createOrUpdate", - "summary": "Create or update a schedule", - "description": "Creates a new schedule or updates an existing schedule with the supplied definition.", + "description": "Create or update operation template.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -14901,27 +13134,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -14959,8 +13173,7 @@ "/schedules/{id}/runs": { "get": { "operationId": "Schedules_listRuns", - "summary": "List schedule runs", - "description": "Returns schedule runs that match the supplied filters.", + "description": "List all schedule runs.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -15018,27 +13231,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -15065,8 +13259,7 @@ "/schedules/{schedule_id}/runs/{run_id}": { "get": { "operationId": "Schedules_getRun", - "summary": "Get a schedule run", - "description": "Retrieves the specified run for a schedule.", + "description": "Get a schedule run by id.", "parameters": [ { "name": "schedule_id", @@ -15120,18 +13313,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -15149,8 +13332,7 @@ "/skills": { "get": { "operationId": "Skills_listSkills", - "summary": "List skills", - "description": "Returns the skills available in the current project.", + "description": "Returns the list of all skills.", "parameters": [ { "name": "limit", @@ -15254,18 +13436,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -15288,8 +13460,7 @@ "/skills/{name}": { "get": { "operationId": "Skills_getSkill", - "summary": "Retrieve a skill", - "description": "Retrieves the specified skill and its current configuration.", + "description": "Retrieves a skill.", "parameters": [ { "name": "name", @@ -15334,18 +13505,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -15366,8 +13527,7 @@ }, "post": { "operationId": "updateSkill", - "summary": "Update a skill", - "description": "Modifies the specified skill's configuration.", + "description": "Update a skill.", "parameters": [ { "name": "name", @@ -15407,110 +13567,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Skill" - } - } - } - }, - "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" - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "default_version": { - "type": "string", - "description": "The version identifier that the skill should point to. When set, the skill's default version will resolve to this version instead of the latest." - } - }, - "required": [ - "default_version" - ] - } - } - } - }, - "x-ms-foundry-meta": { - "required_previews": [ - "Skills=V1Preview" - ] - } - }, - "delete": { - "operationId": "Skills_deleteSkill", - "summary": "Delete a skill", - "description": "Removes the specified skill and its associated versions.", - "parameters": [ - { - "name": "name", - "in": "path", - "required": true, - "description": "The unique name of the skill.", - "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 - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeleteSkillResponse" + "$ref": "#/components/schemas/Skill" } } } }, - "4XX": { - "description": "Client error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -15518,9 +13581,85 @@ } } } + } + }, + "tags": [ + "Skills" + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_version": { + "type": "string", + "description": "The version identifier that the skill should point to. When set, the skill's default version will resolve to this version instead of the latest." + } + }, + "required": [ + "default_version" + ] + } + } + } + }, + "x-ms-foundry-meta": { + "required_previews": [ + "Skills=V1Preview" + ] + } + }, + "delete": { + "operationId": "Skills_deleteSkill", + "description": "Deletes a skill.", + "parameters": [ + { + "name": "name", + "in": "path", + "required": true, + "description": "The unique name of the skill.", + "schema": { + "$ref": "#/components/schemas/SkillName" + } }, - "5XX": { - "description": "Server error", + { + "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 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteSkillResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -15543,8 +13682,7 @@ "/skills/{name}/content": { "get": { "operationId": "getSkillContent", - "summary": "Download the zip content for the default version of a skill", - "description": "Downloads the zip content for the default version of a skill.", + "description": "Download the zip content for the default version of a skill.", "parameters": [ { "name": "name", @@ -15584,23 +13722,14 @@ "content": { "application/zip": { "schema": { - "contentMediaType": "application/zip" - } - } - } - }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" + "type": "string", + "format": "binary" } } } }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -15657,7 +13786,6 @@ } ], "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.", @@ -15669,18 +13797,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -15690,8 +13808,6 @@ } } }, - "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" @@ -15740,8 +13856,7 @@ }, "get": { "operationId": "listSkillVersions", - "summary": "List skill versions", - "description": "Returns the available versions for the specified skill.", + "description": "List all versions of a skill.", "parameters": [ { "name": "name", @@ -15854,18 +13969,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -15888,8 +13993,7 @@ "/skills/{name}/versions/{version}": { "get": { "operationId": "getSkillVersion", - "summary": "Retrieve a specific version of a skill", - "description": "Retrieves the specified version of a skill by name and version identifier.", + "description": "Retrieve a specific version of a skill.", "parameters": [ { "name": "name", @@ -15943,18 +14047,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -15975,8 +14069,7 @@ }, "delete": { "operationId": "deleteSkillVersion", - "summary": "Delete a specific version of a skill", - "description": "Removes the specified version of a skill.", + "description": "Delete a specific version of a skill.", "parameters": [ { "name": "name", @@ -16030,18 +14123,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -16064,8 +14147,7 @@ "/skills/{name}/versions/{version}/content": { "get": { "operationId": "getSkillVersionContent", - "summary": "Download the zip content for a specific version of a skill", - "description": "Downloads the zip content for a specific version of a skill.", + "description": "Download the zip content for a specific version of a skill.", "parameters": [ { "name": "name", @@ -16114,23 +14196,14 @@ "content": { "application/zip": { "schema": { - "contentMediaType": "application/zip" - } - } - } - }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" + "type": "string", + "format": "binary" } } } }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -16153,8 +14226,7 @@ "/toolboxes": { "get": { "operationId": "listToolboxes", - "summary": "List toolboxes", - "description": "Returns the toolboxes available in the current project.", + "description": "List all toolboxes.", "parameters": [ { "name": "limit", @@ -16198,18 +14270,6 @@ }, "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", @@ -16258,18 +14318,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -16281,19 +14331,13 @@ }, "tags": [ "Toolboxes" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "Toolboxes=V1Preview" - ] - } + ] } }, "/toolboxes/{name}": { "get": { "operationId": "getToolbox", - "summary": "Retrieve a toolbox", - "description": "Retrieves the specified toolbox and its current configuration.", + "description": "Retrieve a toolbox.", "parameters": [ { "name": "name", @@ -16304,18 +14348,6 @@ "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", @@ -16338,18 +14370,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -16361,33 +14383,15 @@ }, "tags": [ "Toolboxes" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "Toolboxes=V1Preview" - ] - } + ] }, "patch": { "operationId": "updateToolbox", - "summary": "Update a toolbox to point to a specific version", - "description": "Updates the toolbox's default version pointer to the specified version.", + "description": "Update a toolbox to point to a specific 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", @@ -16410,18 +14414,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -16443,17 +14437,11 @@ } } } - }, - "x-ms-foundry-meta": { - "conditional_previews": [ - "Toolboxes=V1Preview" - ] } }, "delete": { "operationId": "deleteToolbox", - "summary": "Delete a toolbox", - "description": "Removes the specified toolbox along with all of its versions.", + "description": "Delete a toolbox and all its versions.", "parameters": [ { "name": "name", @@ -16464,18 +14452,6 @@ "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", @@ -16491,18 +14467,8 @@ "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", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -16514,19 +14480,13 @@ }, "tags": [ "Toolboxes" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "Toolboxes=V1Preview" - ] - } + ] } }, "/toolboxes/{name}/versions": { "post": { "operationId": "createToolboxVersion", - "summary": "Create a new version of a toolbox", - "description": "Creates a new toolbox version, provisioning the toolbox itself if it does not already exist.", + "description": "Create a new version of a toolbox. If the toolbox does not exist, it will be created.", "parameters": [ { "name": "name", @@ -16538,18 +14498,6 @@ "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", @@ -16572,18 +14520,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -16610,7 +14548,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Arbitrary key-value metadata to associate with the toolbox." @@ -16644,17 +14582,11 @@ } } } - }, - "x-ms-foundry-meta": { - "conditional_previews": [ - "Toolboxes=V1Preview" - ] } }, "get": { "operationId": "listToolboxVersions", - "summary": "List toolbox versions", - "description": "Returns the available versions for the specified toolbox.", + "description": "List all versions of a toolbox.", "parameters": [ { "name": "name", @@ -16707,18 +14639,6 @@ }, "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", @@ -16767,18 +14687,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -16790,19 +14700,13 @@ }, "tags": [ "Toolboxes" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "Toolboxes=V1Preview" - ] - } + ] } }, "/toolboxes/{name}/versions/{version}": { "get": { "operationId": "getToolboxVersion", - "summary": "Retrieve a specific version of a toolbox", - "description": "Retrieves the specified version of a toolbox by name and version identifier.", + "description": "Retrieve a specific version of a toolbox.", "parameters": [ { "name": "name", @@ -16822,18 +14726,6 @@ "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", @@ -16856,18 +14748,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -16879,17 +14761,11 @@ }, "tags": [ "Toolboxes" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "Toolboxes=V1Preview" - ] - } + ] }, "delete": { "operationId": "deleteToolboxVersion", - "summary": "Delete a specific version of a toolbox", - "description": "Removes the specified version of a toolbox.", + "description": "Delete a specific version of a toolbox.", "parameters": [ { "name": "name", @@ -16909,18 +14785,6 @@ "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", @@ -16936,18 +14800,8 @@ "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", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -16959,12 +14813,7 @@ }, "tags": [ "Toolboxes" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "Toolboxes=V1Preview" - ] - } + ] } } }, @@ -17057,26 +14906,6 @@ "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", @@ -17087,27 +14916,6 @@ }, "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", @@ -17118,47 +14926,6 @@ "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", @@ -17903,6 +15670,23 @@ ], "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": [ @@ -18057,7 +15841,6 @@ "enum": [ "activity_protocol", "responses", - "a2a", "mcp", "invocations", "invocations_ws" @@ -18159,6 +15942,7 @@ "idle", "updating", "failed", + "stopping", "deleting", "deleted", "expired" @@ -18256,17 +16040,11 @@ ], "properties": { "metadata": { - "anyOf": [ - { - "type": "object", - "unevaluatedProperties": { - "type": "string" - } - }, - { - "type": "null" - } - ], + "type": "object", + "additionalProperties": { + "type": "string" + }, + "nullable": true, "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" }, @@ -19610,7 +17388,7 @@ }, "parameters": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The parameters the functions accepts, described as a JSON Schema object." } }, @@ -20394,6 +18172,160 @@ }, "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": [ @@ -20508,7 +18440,7 @@ }, "coordinates": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$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." @@ -20762,7 +18694,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Metadata of the connection", @@ -20803,9 +18735,7 @@ "image": { "type": "string", "description": "The container image for the hosted agent.", - "examples": [ - "my-registry.azurecr.io/my-hosted-agent:latest" - ] + "example": "my-registry.azurecr.io/my-hosted-agent:latest" } }, "description": "Container-based deployment configuration for a hosted agent.", @@ -20867,14 +18797,6 @@ "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": [ @@ -20916,7 +18838,7 @@ }, "data_mapping": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Mapping from source fields to response_id field, which is required for retrieving chat history." @@ -21020,6 +18942,8 @@ "description": "JSON metadata including description and hosted definition." }, "code": { + "type": "string", + "format": "binary", "description": "The code zip file (max 250 MB)." } }, @@ -21043,7 +18967,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "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.", @@ -21060,7 +18984,7 @@ }, "parameter_values": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The inputs to the manifest that will result in a fully materialized Agent." } } @@ -21079,7 +19003,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "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.", @@ -21193,6 +19117,8 @@ "description": "JSON metadata including description and hosted definition." }, "code": { + "type": "string", + "format": "binary", "description": "The code zip file (max 250 MB)." } }, @@ -21214,7 +19140,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "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.", @@ -21245,7 +19171,7 @@ "properties": { "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "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.", @@ -21262,7 +19188,7 @@ }, "parameter_values": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The inputs to the manifest that will result in a fully materialized Agent." } } @@ -21275,7 +19201,7 @@ "properties": { "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "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.", @@ -21337,14 +19263,13 @@ "description": "The name of the evaluation." }, "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "data_source_config": { "oneOf": [ @@ -21394,7 +19319,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "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." @@ -21413,14 +19338,13 @@ "description": "The name of the run." }, "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "data_source": { "oneOf": [ @@ -21441,7 +19365,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "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." @@ -21463,7 +19387,10 @@ "properties": { "files": { "type": "array", - "items": {}, + "items": { + "type": "string", + "format": "binary" + }, "description": "Skill files to upload. Upload a single zip file or multiple individual files with relative paths." }, "default": { @@ -21547,7 +19474,7 @@ "readOnly": true } }, - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "allOf": [ @@ -21557,49 +19484,6 @@ ], "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": [ @@ -21829,7 +19713,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tags to assign to the output. Applies only to dataset outputs (evaluation scenario); ignored for Azure OpenAI file outputs." @@ -22015,15 +19899,13 @@ }, "schema": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The overall object JSON schema for the run data source items." } }, "discriminator": { "propertyName": "type", - "mapping": { - "azure_ai_source": "#/components/schemas/AzureAIDataSourceConfig" - } + "mapping": {} }, "description": "Base class for run data sources with discriminator support." }, @@ -22062,7 +19944,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary of the output dataset.", @@ -22110,6 +19992,50 @@ ], "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": [ @@ -22220,7 +20146,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -22575,7 +20501,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. The service defaults to `false` if a value is not specified by the caller.", + "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`.", "default": false } }, @@ -22782,14 +20708,13 @@ "description": "The Unix timestamp (in seconds) for when the eval was created." }, "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "modified_at": { "allOf": [ @@ -22805,7 +20730,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "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." @@ -22997,14 +20922,13 @@ "description": "Information about the run's data source." }, "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "error": { "$ref": "#/components/schemas/OpenAI.EvalApiError" @@ -23023,7 +20947,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "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." @@ -23127,7 +21051,7 @@ }, "datasource_item": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "Details of the input data source item." }, "results": { @@ -23183,15 +21107,9 @@ "description": "Whether the grader considered the output a pass." }, "sample": { - "anyOf": [ - { - "type": "object", - "unevaluatedProperties": {} - }, - { - "type": "null" - } - ], + "type": "object", + "additionalProperties": {}, + "nullable": true, "description": "Optional sample or intermediate data produced by the grader." }, "status": { @@ -23221,13 +21139,13 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Additional details about the test criteria metric." } }, - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "A single grader result for an evaluation run output item.", "title": "EvalRunOutputItemResult" }, @@ -23583,7 +21501,7 @@ }, "systemData": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "System metadata for the evaluation rule.", @@ -23746,7 +21664,6 @@ }, "evalRun": { "type": "object", - "unevaluatedProperties": {}, "description": "The evaluation run payload." } }, @@ -23797,7 +21714,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Additional properties for the evaluation taxonomy." @@ -23817,7 +21734,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -23839,7 +21756,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Additional properties for the evaluation taxonomy." @@ -23917,7 +21834,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -23939,7 +21856,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Additional properties for the evaluation taxonomy." @@ -23998,17 +21915,17 @@ }, "init_parameters": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The JSON schema (Draft 2020-12) for the evaluator's input parameters. This includes parameters like type, properties, required." }, "data_schema": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The JSON schema (Draft 2020-12) for the evaluator's input data. This includes parameters like type, properties, required." }, "metrics": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/EvaluatorMetric" }, "description": "List of output metrics produced by this evaluator" @@ -24373,7 +22290,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Metadata about the evaluator" @@ -24393,16 +22310,6 @@ }, "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": [ { @@ -24467,7 +22374,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Metadata about the evaluator" @@ -24487,16 +22394,6 @@ }, "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": [ { @@ -24511,7 +22408,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -24528,7 +22425,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Metadata about the evaluator" @@ -24540,23 +22437,13 @@ }, "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", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -24718,13 +22605,17 @@ "require_approval": { "anyOf": [ { - "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" - }, - { - "type": "string" + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" + } + ], + "nullable": true }, { - "type": "null" + "type": "string", + "nullable": true } ], "description": "(Optional) Whether the agent requires approval before executing actions. Default is always.", @@ -24775,13 +22666,17 @@ "require_approval": { "anyOf": [ { - "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" - }, - { - "type": "string" + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" + } + ], + "nullable": true }, { - "type": "null" + "type": "string", + "nullable": true } ], "description": "(Optional) Whether the agent requires approval before executing actions. Default is always.", @@ -24925,14 +22820,12 @@ "description": "Ranking options for search." }, "filters": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Filters" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "vector_store_ids": { "type": "array", @@ -25158,40 +23051,19 @@ }, "description": "Details of a function tool call." }, - "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": { + "GitHubIssueOpenedRoutineTrigger": { "type": "object", "required": [ "type", "connection_id", - "owner", - "repository", - "issue_event" + "assignee", + "repository" ], "properties": { "type": { "type": "string", "enum": [ - "github_issue" + "github_issue_opened" ], "description": "The trigger type." }, @@ -25200,23 +23072,15 @@ "maxLength": 256, "description": "The workspace connection identifier that resolves the GitHub configuration for the trigger." }, - "owner": { + "assignee": { "type": "string", "maxLength": 128, - "description": "The GitHub owner or organization that scopes which issues can fire the trigger." + "description": "The GitHub assignee or organization filter 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": [ @@ -25224,7 +23088,7 @@ "$ref": "#/components/schemas/RoutineTrigger" } ], - "description": "A GitHub issue routine trigger.", + "description": "A GitHub issue-opened routine trigger.", "x-ms-foundry-meta": { "conditional_previews": [ "Routines=V1Preview" @@ -25274,23 +23138,17 @@ "header_name": { "type": "string", "description": "The name of the HTTP header to inject the secret value into.", - "examples": [ - "X-Otlp-Api-Key" - ] + "example": "X-Otlp-Api-Key" }, "secret_id": { "type": "string", "description": "The identifier of the secret store or connection.", - "examples": [ - "my-secret-store" - ] + "example": "my-secret-store" }, "secret_key": { "type": "string", "description": "The key within the secret to retrieve the authentication value.", - "examples": [ - "OTLP_KEY" - ] + "example": "OTLP_KEY" } }, "allOf": [ @@ -25329,29 +23187,23 @@ "cpu": { "type": "string", "description": "The CPU configuration for the hosted agent.", - "examples": [ - "0.25" - ] + "example": "0.25" }, "memory": { "type": "string", "description": "The memory configuration for the hosted agent.", - "examples": [ - "0.5Gi" - ] + "example": "0.5Gi" }, "environment_variables": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Environment variables to set in the hosted agent container.", - "examples": [ - { - "name": "LOG_LEVEL", - "value": "debug" - } - ] + "example": { + "name": "LOG_LEVEL", + "value": "debug" + } }, "container_configuration": { "allOf": [ @@ -25372,17 +23224,15 @@ "$ref": "#/components/schemas/ProtocolVersionRecord" }, "description": "The protocols that the agent supports for ingress communication.", - "examples": [ - [ - { - "protocol": "responses", - "version": "v0.1.1" - }, - { - "protocol": "a2a", - "version": "v0.3.0" - } - ] + "example": [ + { + "protocol": "responses", + "version": "v0.1.1" + }, + { + "protocol": "a2a", + "version": "v0.3.0" + } ], "x-ms-foundry-meta": { "required_previews": [ @@ -25550,7 +23400,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -25762,12 +23612,12 @@ }, "features": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "Features to help with additional filtering of data in UX." }, "correlationInfo": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "Info about the correlation for the analysis sample." } }, @@ -25886,8 +23736,7 @@ "InvokeAgentInvocationsApiDispatchPayload": { "type": "object", "required": [ - "type", - "input" + "type" ], "properties": { "type": { @@ -25898,7 +23747,9 @@ "description": "The manual dispatch payload type." }, "input": { - "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." + "type": "string", + "maxLength": 32768, + "description": "The raw input sent to the downstream invocations target." } }, "allOf": [ @@ -25916,7 +23767,8 @@ "InvokeAgentInvocationsApiRoutineAction": { "type": "object", "required": [ - "type" + "type", + "agent_endpoint_id" ], "properties": { "type": { @@ -25926,18 +23778,10 @@ ], "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": "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." + "description": "The endpoint-scoped agent identifier for invocations API dispatch." }, "session_id": { "type": "string", @@ -25950,7 +23794,7 @@ "$ref": "#/components/schemas/RoutineAction" } ], - "description": "Dispatches a routine through the raw invocations API. Exactly one of agent_name or agent_endpoint_id must be provided.", + "description": "Dispatches a routine through the raw invocations API.", "x-ms-foundry-meta": { "conditional_previews": [ "Routines=V1Preview" @@ -25960,8 +23804,7 @@ "InvokeAgentResponsesApiDispatchPayload": { "type": "object", "required": [ - "type", - "input" + "type" ], "properties": { "type": { @@ -25972,7 +23815,9 @@ "description": "The manual dispatch payload type." }, "input": { - "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." + "type": "string", + "maxLength": 32768, + "description": "The user input sent to the downstream responses target." } }, "allOf": [ @@ -26003,17 +23848,14 @@ "agent_name": { "type": "string", "maxLength": 256, - "description": "The project-scoped agent name for routine dispatch." + "description": "The project-scoped agent name for responses API dispatch." }, "agent_endpoint_id": { "type": "string", "maxLength": 256, - "description": "Legacy endpoint-scoped agent identifier for routine dispatch." + "description": "The endpoint-scoped agent identifier for responses API 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": { + "conversation_id": { "type": "string", "maxLength": 256, "description": "An optional existing conversation identifier to continue during the downstream dispatch." @@ -26095,8 +23937,7 @@ "red_team_seed_prompts": "#/components/schemas/RedTeamSeedPromptsItemGenerationParams", "red_team_taxonomy": "#/components/schemas/RedTeamTaxonomyItemGenerationParams", "response_retrieval": "#/components/schemas/ResponseRetrievalItemGenerationParams", - "conversation_gen_preview": "#/components/schemas/ConversationGenPreviewItemGenerationParams", - "synthetic_data_gen_preview": "#/components/schemas/SyntheticDataGenerationPreviewItemGenerationParams" + "conversation_gen_preview": "#/components/schemas/ConversationGenPreviewItemGenerationParams" } }, "description": "Represents the set of parameters used to control item generation operations." @@ -26211,17 +24052,11 @@ "description": "Optional description of the MCP server, used to provide more context." }, "headers": { - "anyOf": [ - { - "type": "object", - "unevaluatedProperties": { - "type": "string" - } - }, - { - "type": "null" - } - ] + "type": "object", + "additionalProperties": { + "type": "string" + }, + "nullable": true }, "allowed_tools": { "anyOf": [ @@ -26229,38 +24064,42 @@ "type": "array", "items": { "type": "string" - } - }, - { - "$ref": "#/components/schemas/OpenAI.MCPToolFilter" + }, + "nullable": true }, { - "type": "null" + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MCPToolFilter" + } + ], + "nullable": true } ] }, "require_approval": { "anyOf": [ { - "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" + } + ], + "nullable": true }, { "type": "string", "enum": [ "always", "never" - ] - }, - { - "type": "null" + ], + "nullable": true } ], "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." @@ -26657,17 +24496,11 @@ "description": "The status of the tool call." }, "memories": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/MemoryItem" - } - }, - { - "type": "null" - } - ], + "type": "array", + "items": { + "$ref": "#/components/schemas/MemoryItem" + }, + "nullable": true, "description": "The results returned from the memory search." } }, @@ -26745,7 +24578,7 @@ }, "procedural_memory_enabled": { "type": "boolean", - "description": "Whether to enable procedural memory extraction and storage. The service defaults to `true` if a value is not specified by the caller.", + "description": "Whether to enable procedural memory extraction and storage. Defaults to `true`.", "default": true }, "default_ttl_seconds": { @@ -26895,7 +24728,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Arbitrary key-value metadata to associate with the memory store." @@ -27202,7 +25035,7 @@ }, "capabilities": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Capabilities of deployed model", @@ -27423,7 +25256,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -27630,7 +25463,8 @@ "create_file" ], "description": "Create a new file with the provided diff.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "create_file" }, "path": { "type": "string", @@ -27663,7 +25497,8 @@ "create_file" ], "description": "The operation type. Always `create_file`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "create_file" }, "path": { "type": "string", @@ -27697,7 +25532,8 @@ "delete_file" ], "description": "Delete the specified file.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "delete_file" }, "path": { "type": "string", @@ -27725,7 +25561,8 @@ "delete_file" ], "description": "The operation type. Always `delete_file`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "delete_file" }, "path": { "type": "string", @@ -27825,7 +25662,8 @@ "apply_patch" ], "description": "The type of the tool. Always `apply_patch`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "apply_patch" } }, "allOf": [ @@ -27850,7 +25688,8 @@ "update_file" ], "description": "Update an existing file with the provided diff.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "update_file" }, "path": { "type": "string", @@ -27883,7 +25722,8 @@ "update_file" ], "description": "The operation type. Always `update_file`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "update_file" }, "path": { "type": "string", @@ -27920,44 +25760,20 @@ "default": "approximate" }, "country": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "region": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "city": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "timezone": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } } }, @@ -27985,14 +25801,12 @@ "description": "An optional list of uploaded files to make available to your code." }, "memory_limit": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.ContainerMemoryLimit" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "network_policy": { "$ref": "#/components/schemas/OpenAI.ContainerNetworkPolicyParam" @@ -28026,12 +25840,6 @@ "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", @@ -28131,7 +25939,8 @@ "click" ], "description": "Specifies the event type. For a click action, this property is always `click`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "click" }, "button": { "allOf": [ @@ -28156,19 +25965,6 @@ } ], "description": "The y-coordinate where the click occurred." - }, - "keys": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] } }, "allOf": [ @@ -28335,61 +26131,17 @@ "items": { "$ref": "#/components/schemas/OpenAI.InputItem" } - }, - { - "type": "null" } - ] + ], + "nullable": true }, "previous_response_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "instructions": { - "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" - } - ] + "type": "string", + "nullable": true } } }, @@ -28409,9 +26161,7 @@ "gt", "gte", "lt", - "lte", - "in", - "nin" + "lte" ], "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" @@ -28513,14 +26263,6 @@ } } }, - "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": [ { @@ -28553,24 +26295,12 @@ "description": "The ID of the pending safety check." }, "code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "message": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "description": "A pending safety check for the computer call." @@ -28590,8 +26320,7 @@ "required": [ "type", "image_url", - "file_id", - "detail" + "file_id" ], "properties": { "type": { @@ -28600,36 +26329,17 @@ "computer_screenshot" ], "description": "Specifies the event type. For a computer screenshot, this property is always set to `computer_screenshot`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "computer_screenshot" }, "image_url": { - "anyOf": [ - { - "type": "string", - "format": "uri" - }, - { - "type": "null" - } - ] + "type": "string", + "format": "uri", + "nullable": true }, "file_id": { - "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`." + "type": "string", + "nullable": true } }, "allOf": [ @@ -28667,29 +26377,6 @@ }, "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": [ @@ -28705,7 +26392,8 @@ "computer_use_preview" ], "description": "The type of the computer use tool. Always `computer_use_preview`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "computer_use_preview" }, "environment": { "allOf": [ @@ -28752,7 +26440,8 @@ "container_auto" ], "description": "Automatically creates a container for this request", - "x-stainless-const": true + "x-stainless-const": true, + "default": "container_auto" }, "file_ids": { "type": "array", @@ -28763,14 +26452,12 @@ "description": "An optional list of uploaded files to make available to your code." }, "memory_limit": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.ContainerMemoryLimit" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "skills": { "type": "array", @@ -28807,7 +26494,8 @@ "container_file_citation" ], "description": "The type of the container file citation. Always `container_file_citation`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "container_file_citation" }, "container_id": { "type": "string", @@ -28868,7 +26556,8 @@ "allowlist" ], "description": "Allow outbound network access only to specified domains. Always `allowlist`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "allowlist" }, "allowed_domains": { "type": "array", @@ -28877,6 +26566,14 @@ }, "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": [ @@ -28897,7 +26594,8 @@ "disabled" ], "description": "Disable outbound network access. Always `disabled`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "disabled" } }, "allOf": [ @@ -28906,6 +26604,32 @@ } ] }, + "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": [ @@ -28952,7 +26676,8 @@ "container_reference" ], "description": "The environment type. Always `container_reference`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "container_reference" }, "container_id": { "type": "string" @@ -29009,14 +26734,13 @@ "description": "The context management entry type. Currently only 'compaction' is supported." }, "compact_threshold": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true } } }, @@ -29034,18 +26758,14 @@ "propertyName": "type", "mapping": { "message": "#/components/schemas/OpenAI.ConversationItemMessage", - "function_call": "#/components/schemas/OpenAI.ConversationItemFunctionToolCall", - "function_call_output": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutput", + "function_call": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallResource", + "function_call_output": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutputResource", "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.ConversationItemComputerToolCallOutput", - "tool_search_call": "#/components/schemas/OpenAI.ConversationItemToolSearchCall", - "tool_search_output": "#/components/schemas/OpenAI.ConversationItemToolSearchOutput", - "additional_tools": "#/components/schemas/OpenAI.ConversationItemAdditionalTools", + "computer_call_output": "#/components/schemas/OpenAI.ConversationItemComputerToolCallOutputResource", "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", @@ -29057,57 +26777,13 @@ "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.ConversationItemCustomToolCallResource", - "custom_tool_call_output": "#/components/schemas/OpenAI.ConversationItemCustomToolCallOutputResource" + "custom_tool_call": "#/components/schemas/OpenAI.ConversationItemCustomToolCall", + "custom_tool_call_output": "#/components/schemas/OpenAI.ConversationItemCustomToolCallOutput" } }, "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": [ @@ -29200,14 +26876,8 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "created_by": { "type": "string", @@ -29262,34 +26932,22 @@ "description": "The ID of the container used to run the code." }, "code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "outputs": { - "anyOf": [ - { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" - } - ] + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" } - }, - { - "type": "null" - } - ] + ] + }, + "nullable": true } }, "allOf": [ @@ -29300,50 +26958,13 @@ "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" ], @@ -29367,9 +26988,6 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, - "actions": { - "$ref": "#/components/schemas/OpenAI.ComputerActionList" - }, "pending_safety_checks": { "type": "array", "items": { @@ -29395,11 +27013,10 @@ "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.ConversationItemComputerToolCallOutput": { + "OpenAI.ConversationItemComputerToolCallOutputResource": { "type": "object", "required": [ "type", - "id", "call_id", "output" ], @@ -29415,8 +27032,7 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output.", - "readOnly": true + "description": "The ID of the computer tool call output." }, "call_id": { "type": "string", @@ -29446,60 +27062,40 @@ { "$ref": "#/components/schemas/OpenAI.ConversationItem" } - ], - "description": "The output of a computer tool call.", - "title": "Computer tool call output" + ] }, - "OpenAI.ConversationItemCustomToolCallOutputResource": { + "OpenAI.ConversationItemCustomToolCall": { "type": "object", "required": [ "type", "call_id", - "output", - "status" + "name", + "input" ], "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." - }, - "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." + "description": "An identifier used to map this custom tool call to a tool call output." }, - "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." + "name": { + "type": "string", + "description": "The name of the custom tool being called." }, - "created_by": { + "input": { "type": "string", - "description": "The identifier of the actor that created the item." + "description": "The input for the custom tool call generated by the model." } }, "allOf": [ @@ -29507,57 +27103,46 @@ "$ref": "#/components/schemas/OpenAI.ConversationItem" } ], - "title": "ResponseCustomToolCallOutputItem" + "description": "A call to a custom tool created by the model.", + "title": "Custom tool call" }, - "OpenAI.ConversationItemCustomToolCallResource": { + "OpenAI.ConversationItemCustomToolCallOutput": { "type": "object", "required": [ "type", "call_id", - "name", - "input", - "status" + "output" ], "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." - }, - "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." + "description": "The call ID, used to map this custom tool call output to a custom tool call." }, - "status": { - "allOf": [ + "output": { + "oneOf": [ + { + "type": "string" + }, { - "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } } ], - "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." + "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." } }, "allOf": [ @@ -29565,7 +27150,8 @@ "$ref": "#/components/schemas/OpenAI.ConversationItem" } ], - "title": "ResponseCustomToolCallItem" + "description": "The output of a custom tool call from your code, being sent back to the model.", + "title": "Custom tool call output" }, "OpenAI.ConversationItemFileSearchToolCall": { "type": "object", @@ -29607,17 +27193,11 @@ "description": "The queries used to search for files." }, "results": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + }, + "nullable": true } }, "allOf": [ @@ -29667,20 +27247,19 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" + "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." }, "environment": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallEnvironment" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "created_by": { "type": "string", @@ -29726,7 +27305,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -29739,14 +27318,13 @@ "description": "An array of shell call output contents" }, "max_output_length": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "created_by": { "type": "string", @@ -29761,44 +27339,43 @@ "description": "The output of a shell tool call that was emitted.", "title": "Shell call output" }, - "OpenAI.ConversationItemFunctionToolCall": { + "OpenAI.ConversationItemFunctionToolCallOutputResource": { "type": "object", "required": [ - "id", "type", "call_id", - "name", - "arguments" + "output" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call.", - "readOnly": true + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." }, "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." }, - "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." + "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", @@ -29814,49 +27391,40 @@ { "$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.ConversationItemFunctionToolCallOutput": { + "OpenAI.ConversationItemFunctionToolCallResource": { "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.", - "readOnly": true + "description": "The unique ID of the function tool call." }, "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." + "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", @@ -29872,9 +27440,7 @@ { "$ref": "#/components/schemas/OpenAI.ConversationItem" } - ], - "description": "The output of a function tool call.", - "title": "Function tool call output" + ] }, "OpenAI.ConversationItemImageGenToolCall": { "type": "object", @@ -29908,14 +27474,8 @@ "description": "The status of the image generation call." }, "result": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -30045,19 +27605,13 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "anyOf": [ - { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, - { - "type": "null" - } - ] + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "nullable": true } }, "allOf": [ @@ -30141,14 +27695,8 @@ "description": "Whether the request was approved." }, "reason": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -30192,7 +27740,8 @@ "description": "The tools available on the server." }, "error": { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + "type": "string", + "nullable": true } }, "allOf": [ @@ -30238,18 +27787,12 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "error": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, "status": { "allOf": [ @@ -30260,14 +27803,8 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -30323,16 +27860,6 @@ "$ref": "#/components/schemas/OpenAI.MessageContent" }, "description": "The content of the message" - }, - "phase": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessagePhase" - }, - { - "type": "null" - } - ] } }, "allOf": [ @@ -30364,14 +27891,8 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "summary": { "type": "array", @@ -30405,138 +27926,6 @@ "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": [ { @@ -30553,11 +27942,7 @@ "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", @@ -30746,8 +28131,7 @@ "propertyName": "type", "mapping": { "text": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText", - "json_object": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject", - "json_schema": "#/components/schemas/OpenAI.ResponseFormatJsonSchema" + "json_object": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject" } }, "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." @@ -30817,27 +28201,20 @@ "type": "object", "properties": { "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "items": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.InputItem" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.InputItem" + }, + "nullable": true } } }, @@ -31015,7 +28392,7 @@ }, "item_schema": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The json schema for each row in the data source." }, "include_sample_schema": { @@ -31084,7 +28461,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "Metadata filters for the logs data source." } }, @@ -31279,7 +28656,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "Metadata filters for the stored completions data source." } }, @@ -31331,52 +28708,33 @@ "deprecated": true }, "suffix": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "type": "string", + "nullable": true, "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": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "type": "string", + "nullable": true, "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": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.CreateFineTuningJobRequestIntegrations" - } - }, - { - "type": "null" - } - ], + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.CreateFineTuningJobRequestIntegrations" + }, + "nullable": true, "description": "A list of integrations to enable for your fine-tuning job." }, "seed": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$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." @@ -31385,14 +28743,13 @@ "$ref": "#/components/schemas/OpenAI.FineTuneMethod" }, "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true } } }, @@ -31472,24 +28829,12 @@ "type": "string" }, "name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "entity": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "tags": { "type": "array", @@ -31676,7 +29021,8 @@ "grammar" ], "description": "Grammar format. Always `grammar`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "grammar" }, "syntax": { "allOf": [ @@ -31711,7 +29057,8 @@ "text" ], "description": "Unconstrained text format. Always `text`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "text" } }, "allOf": [ @@ -31735,7 +29082,8 @@ "custom" ], "description": "The type of the custom tool. Always `custom`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "custom" }, "name": { "type": "string", @@ -31752,10 +29100,6 @@ } ], "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": [ @@ -31828,8 +29172,7 @@ "enum": [ "low", "high", - "auto", - "original" + "auto" ] }, "OpenAI.DoubleClickAction": { @@ -31837,8 +29180,7 @@ "required": [ "type", "x", - "y", - "keys" + "y" ], "properties": { "type": { @@ -31847,7 +29189,8 @@ "double_click" ], "description": "Specifies the event type. For a double click action, this property is always set to `double_click`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "double_click" }, "x": { "allOf": [ @@ -31864,19 +29207,6 @@ } ], "description": "The y-coordinate where the double click occurred." - }, - "keys": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] } }, "allOf": [ @@ -31900,7 +29230,8 @@ "drag" ], "description": "Specifies the event type. For a drag action, this property is always set to `drag`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "drag" }, "path": { "type": "array", @@ -31908,19 +29239,6 @@ "$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": [ @@ -31960,16 +29278,6 @@ ], "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": [ @@ -31996,9 +29304,6 @@ "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": [ @@ -32007,27 +29312,15 @@ ], "properties": { "code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "message": { "type": "string" }, "param": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "type": { "type": "string" @@ -32040,11 +29333,11 @@ }, "additionalInfo": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, "debugInfo": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} } } }, @@ -32223,45 +29516,41 @@ "type": "object", "properties": { "seed": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "top_p": { - "anyOf": [ + "type": "number", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" - }, - { - "type": "null" } ], + "nullable": true, "default": 1 }, "temperature": { - "anyOf": [ + "type": "number", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "max_completions_tokens": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "reasoning_effort": { "$ref": "#/components/schemas/OpenAI.ReasoningEffort" @@ -32602,11 +29891,11 @@ "properties": { "item": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, "sample": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} } } }, @@ -32647,111 +29936,75 @@ "description": "The type of run data source. Always `responses`." }, "metadata": { - "anyOf": [ - { - "type": "object", - "unevaluatedProperties": {} - }, - { - "type": "null" - } - ] + "type": "object", + "additionalProperties": {}, + "nullable": true }, "model": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "instructions_search": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "created_after": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "created_before": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "reasoning_effort": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.ReasoningEffort" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "temperature": { - "anyOf": [ + "type": "number", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "top_p": { - "anyOf": [ + "type": "number", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "users": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "type": "string" + }, + "nullable": true }, "tools": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "type": "string" + }, + "nullable": true } }, "description": "A EvalResponsesSource object describing a run data source configuration.", @@ -32951,54 +30204,44 @@ "default": "stored_completions" }, "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "model": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "created_after": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "created_before": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "limit": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "description": "A StoredCompletionsRunDataSource configuration describing a set of filters", @@ -33024,7 +30267,8 @@ "file_citation" ], "description": "The type of the file citation. Always `file_citation`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "file_citation" }, "file_id": { "type": "string", @@ -33051,13 +30295,6 @@ "description": "A citation to a file.", "title": "File citation" }, - "OpenAI.FileInputDetail": { - "type": "string", - "enum": [ - "low", - "high" - ] - }, "OpenAI.FilePath": { "type": "object", "required": [ @@ -33108,7 +30345,8 @@ "file_search" ], "description": "The type of the file search tool. Always `file_search`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "file_search" }, "vector_store_ids": { "type": "array", @@ -33134,14 +30372,12 @@ "description": "Ranking options for search." }, "filters": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Filters" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "name": { "type": "string", @@ -33173,14 +30409,13 @@ "type": "string" }, "attributes": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.VectorStoreFileAttributes" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "score": { "type": "number", @@ -33535,24 +30770,12 @@ "type": "string" }, "name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "entity": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "tags": { "type": "array", @@ -33592,37 +30815,22 @@ "description": "The Unix timestamp (in seconds) for when the fine-tuning job was created." }, "error": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FineTuningJobError" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "fine_tuned_model": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "finished_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], "type": "integer", - "format": "unixTimestamp" + "format": "unixtime", + "nullable": true }, "hyperparameters": { "allOf": [ @@ -33668,41 +30876,28 @@ "description": "The current status of the fine-tuning job, which can be either `validating_files`, `queued`, `running`, `succeeded`, `failed`, or `cancelled`." }, "trained_tokens": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$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": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "integrations": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FineTuningIntegration" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FineTuningIntegration" + }, + "nullable": true }, "seed": { "allOf": [ @@ -33713,30 +30908,21 @@ "description": "The seed used for the fine-tuning job." }, "estimated_finish": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], "type": "integer", - "format": "unixTimestamp" + "format": "unixtime", + "nullable": true }, "method": { "$ref": "#/components/schemas/OpenAI.FineTuneMethod" }, "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$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.", @@ -33848,14 +31034,8 @@ "type": "string" }, "param": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } } }, @@ -33934,13 +31114,17 @@ "type": "string", "enum": [ "auto" - ] + ], + "nullable": true }, { - "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" + "type": "integer", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + } + ], + "nullable": true } ], "default": "auto" @@ -34010,35 +31194,21 @@ "default": "input_file" }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "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." }, - "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`." + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." } }, "allOf": [ @@ -34066,25 +31236,13 @@ "default": "input_image" }, "image_url": { - "anyOf": [ - { - "type": "string", - "format": "uri" - }, - { - "type": "null" - } - ] + "type": "string", + "format": "uri", + "nullable": true }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "detail": { "allOf": [ @@ -34092,7 +31250,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." } }, "allOf": [ @@ -34155,22 +31313,6 @@ "incomplete" ] }, - "OpenAI.FunctionCallOutputStatusEnum": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, - "OpenAI.FunctionCallStatus": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, "OpenAI.FunctionObject": { "type": "object", "required": [ @@ -34189,20 +31331,14 @@ "$ref": "#/components/schemas/OpenAI.FunctionParameters" }, "strict": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ] + "type": "boolean", + "nullable": true } } }, "OpenAI.FunctionParameters": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "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": { @@ -34220,24 +31356,22 @@ } }, "timeout_ms": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "max_output_length": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "description": "Execute a shell command.", @@ -34257,24 +31391,22 @@ "description": "Ordered shell commands for the execution environment to run." }, "timeout_ms": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "max_output_length": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "description": "Commands and limits describing how to run the shell tool call.", @@ -34488,7 +31620,8 @@ "exit" ], "description": "The outcome type. Always `exit`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "exit" }, "exit_code": { "allOf": [ @@ -34520,7 +31653,8 @@ "exit" ], "description": "The outcome type. Always `exit`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "exit" }, "exit_code": { "allOf": [ @@ -34607,14 +31741,6 @@ } ] }, - "OpenAI.FunctionShellCallOutputStatusEnum": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, "OpenAI.FunctionShellCallOutputTimeoutOutcome": { "type": "object", "required": [ @@ -34627,7 +31753,8 @@ "timeout" ], "description": "The outcome type. Always `timeout`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "timeout" } }, "allOf": [ @@ -34650,7 +31777,8 @@ "timeout" ], "description": "The outcome type. Always `timeout`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "timeout" } }, "allOf": [ @@ -34661,14 +31789,6 @@ "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": [ @@ -34681,17 +31801,17 @@ "shell" ], "description": "The type of the shell tool. Always `shell`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "shell" }, "environment": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellToolParamEnvironment" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "name": { "type": "string", @@ -34816,46 +31936,25 @@ "function" ], "description": "The type of the function tool. Always `function`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "function" }, "name": { "type": "string", "description": "The name of the function to call." }, "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "parameters": { - "anyOf": [ - { - "type": "object", - "unevaluatedProperties": {} - }, - { - "type": "null" - } - ] + "type": "object", + "additionalProperties": {}, + "nullable": true }, "strict": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ] - }, - "defer_loading": { "type": "boolean", - "description": "Whether this function is deferred and loaded via tool search." + "nullable": true } }, "allOf": [ @@ -34866,62 +31965,61 @@ "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.FunctionToolParam": { + "OpenAI.FunctionToolCallOutput": { "type": "object", "required": [ - "name", - "type" + "type", + "call_id", + "output" ], "properties": { - "name": { + "id": { "type": "string", - "minLength": 1, - "maxLength": 128, - "pattern": "^[a-zA-Z0-9_-]+$" + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." }, - "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": { + "type": "string", + "enum": [ + "function_call_output" + ], + "description": "The type of the function tool call output. Always `function_call_output`.", + "x-stainless-const": true }, - "parameters": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.EmptyModelParam" - }, - { - "type": "null" - } - ] + "call_id": { + "type": "string", + "description": "The unique ID of the function tool call generated by the model." }, - "strict": { - "anyOf": [ + "output": { + "oneOf": [ { - "type": "boolean" + "type": "string" }, { - "type": "null" + "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." }, - "type": { + "status": { "type": "string", "enum": [ - "function" + "in_progress", + "completed", + "incomplete" ], - "x-stainless-const": true, - "default": "function" - }, - "defer_loading": { - "type": "boolean", - "description": "Whether this function should be deferred and discovered via tool search." + "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.GraderLabelModel": { "type": "object", @@ -35269,8 +32367,7 @@ "enum": [ "low", "high", - "auto", - "original" + "auto" ] }, "OpenAI.ImageGenActionEnum": { @@ -35293,7 +32390,8 @@ "image_generation" ], "description": "The type of the image generation tool. Always `image_generation`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "image_generation" }, "model": { "anyOf": [ @@ -35323,21 +32421,14 @@ "default": "auto" }, "size": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "enum": [ - "1024x1024", - "1024x1536", - "1536x1024", - "auto" - ] - } + "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`.", + "description": "The size of the generated image. One of `1024x1024`, `1024x1536`,\n `1536x1024`, or `auto`. Default: `auto`.", "default": "auto" }, "output_format": { @@ -35381,14 +32472,12 @@ "default": "auto" }, "input_fidelity": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.InputFidelity" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "input_image_mask": { "allOf": [ @@ -35465,7 +32554,7 @@ ] } ], - "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)." + "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)." }, "OpenAI.InlineSkillParam": { "type": "object", @@ -35482,7 +32571,8 @@ "inline" ], "description": "Defines an inline skill for this request.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "inline" }, "name": { "type": "string", @@ -35623,35 +32713,21 @@ "default": "input_file" }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "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." }, - "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`." + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." } }, "allOf": [ @@ -35679,25 +32755,13 @@ "default": "input_image" }, "image_url": { - "anyOf": [ - { - "type": "string", - "format": "uri" - }, - { - "type": "null" - } - ] + "type": "string", + "format": "uri", + "nullable": true }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "detail": { "allOf": [ @@ -35705,7 +32769,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." } }, "allOf": [ @@ -35784,35 +32848,21 @@ "default": "input_file" }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "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." }, - "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`." + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." } }, "description": "A file input to the model.", @@ -35834,53 +32884,21 @@ "default": "input_file" }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "filename": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "file_data": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "file_url": { - "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`." + "type": "string", + "format": "uri", + "nullable": true } }, "description": "A file input to the model.", @@ -35903,25 +32921,13 @@ "default": "input_image" }, "image_url": { - "anyOf": [ - { - "type": "string", - "format": "uri" - }, - { - "type": "null" - } - ] + "type": "string", + "format": "uri", + "nullable": true }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "detail": { "allOf": [ @@ -35929,7 +32935,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." } }, "description": "An image input to the model. Learn about [image inputs](/docs/guides/vision).", @@ -35951,35 +32957,21 @@ "default": "input_image" }, "image_url": { - "anyOf": [ - { - "type": "string", - "format": "uri" - }, - { - "type": "null" - } - ] + "type": "string", + "format": "uri", + "nullable": true }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "detail": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.DetailEnum" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "description": "An image input to the model. Learn about [image inputs](/docs/guides/vision)", @@ -36007,9 +32999,6 @@ "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", @@ -36030,56 +33019,6 @@ }, "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": [ @@ -36099,14 +33038,8 @@ "default": "apply_patch_call" }, "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -36157,14 +33090,8 @@ "default": "apply_patch_call_output" }, "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -36181,14 +33108,8 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -36239,34 +33160,22 @@ "description": "The ID of the container used to run the code." }, "code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "outputs": { - "anyOf": [ - { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" - } - ] + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" } - }, - { - "type": "null" - } - ] + ] + }, + "nullable": true } }, "allOf": [ @@ -36285,14 +33194,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "type": { "type": "string", @@ -36326,14 +33229,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -36354,27 +33251,19 @@ "$ref": "#/components/schemas/OpenAI.ComputerScreenshotImage" }, "acknowledged_safety_checks": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" + }, + "nullable": true }, "status": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "allOf": [ @@ -36391,6 +33280,7 @@ "type", "id", "call_id", + "action", "pending_safety_checks", "status" ], @@ -36414,9 +33304,6 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, - "actions": { - "$ref": "#/components/schemas/OpenAI.ComputerActionList" - }, "pending_safety_checks": { "type": "array", "items": { @@ -36467,10 +33354,6 @@ "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." @@ -36575,17 +33458,11 @@ "description": "The queries used to search for files." }, "results": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + }, + "nullable": true } }, "allOf": [ @@ -36605,14 +33482,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -36654,14 +33525,12 @@ "description": "Text, image, or file output of the function tool call." }, "status": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "allOf": [ @@ -36681,14 +33550,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -36714,24 +33577,21 @@ "description": "The shell commands and limits that describe how to run the tool call." }, "status": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemStatus" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "environment": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemParamEnvironment" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "allOf": [ @@ -36751,14 +33611,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -36783,24 +33637,21 @@ "description": "Captured chunks of stdout and stderr output, along with their associated outcomes." }, "status": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemStatus" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "max_output_length": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "allOf": [ @@ -36814,7 +33665,6 @@ "OpenAI.InputItemFunctionToolCall": { "type": "object", "required": [ - "id", "type", "call_id", "name", @@ -36823,8 +33673,7 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call.", - "readOnly": true + "description": "The unique ID of the function tool call." }, "type": { "type": "string", @@ -36838,10 +33687,6 @@ "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." @@ -36900,14 +33745,8 @@ "description": "The status of the image generation call." }, "result": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -36990,19 +33829,13 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "anyOf": [ - { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, - { - "type": "null" - } - ] + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "nullable": true } }, "allOf": [ @@ -37073,14 +33906,8 @@ "x-stainless-const": true }, "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "approval_request_id": { "type": "string", @@ -37091,14 +33918,8 @@ "description": "Whether the request was approved." }, "reason": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -37142,7 +33963,8 @@ "description": "The tools available on the server." }, "error": { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + "type": "string", + "nullable": true } }, "allOf": [ @@ -37188,18 +34010,12 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "error": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, "status": { "allOf": [ @@ -37210,14 +34026,8 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -37265,16 +34075,6 @@ }, "description": "The content of the output message." }, - "phase": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessagePhase" - }, - { - "type": "null" - } - ] - }, "status": { "type": "string", "enum": [ @@ -37314,14 +34114,8 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "summary": { "type": "array", @@ -37355,143 +34149,6 @@ "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": [ { @@ -37508,9 +34165,6 @@ "web_search_call", "function_call", "function_call_output", - "tool_search_call", - "tool_search_output", - "additional_tools", "reasoning", "compaction", "image_generation_call", @@ -37586,6 +34240,52 @@ "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": { @@ -37594,6 +34294,55 @@ "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": [ { @@ -37670,7 +34419,7 @@ "discriminator": { "propertyName": "type", "mapping": { - "message": "#/components/schemas/OpenAI.ItemInputMessage", + "message": "#/components/schemas/OpenAI.InputMessage", "output_message": "#/components/schemas/OpenAI.ItemOutputMessage", "file_search_call": "#/components/schemas/OpenAI.ItemFileSearchToolCall", "computer_call": "#/components/schemas/OpenAI.ItemComputerToolCall", @@ -37678,9 +34427,6 @@ "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", @@ -37701,56 +34447,6 @@ }, "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": [ @@ -37770,14 +34466,8 @@ "default": "apply_patch_call" }, "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -37828,14 +34518,8 @@ "default": "apply_patch_call_output" }, "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -37852,14 +34536,8 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -37910,34 +34588,22 @@ "description": "The ID of the container used to run the code." }, "code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "outputs": { - "anyOf": [ - { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" - } - ] + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" } - }, - { - "type": "null" - } - ] + ] + }, + "nullable": true } }, "allOf": [ @@ -37956,14 +34622,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "type": { "type": "string", @@ -37997,14 +34657,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -38025,27 +34679,19 @@ "$ref": "#/components/schemas/OpenAI.ComputerScreenshotImage" }, "acknowledged_safety_checks": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" + }, + "nullable": true }, "status": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "allOf": [ @@ -38062,6 +34708,7 @@ "type", "id", "call_id", + "action", "pending_safety_checks", "status" ], @@ -38085,9 +34732,6 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, - "actions": { - "$ref": "#/components/schemas/OpenAI.ComputerActionList" - }, "pending_safety_checks": { "type": "array", "items": { @@ -38138,10 +34782,6 @@ "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." @@ -38219,17 +34859,14 @@ "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.ItemFieldComputerToolCallOutput", + "computer_call_output": "#/components/schemas/OpenAI.ItemFieldComputerToolCallOutputResource", "reasoning": "#/components/schemas/OpenAI.ItemFieldReasoningItem", "compaction": "#/components/schemas/OpenAI.ItemFieldCompactionBody", "code_interpreter_call": "#/components/schemas/OpenAI.ItemFieldCodeInterpreterToolCall", @@ -38249,50 +34886,6 @@ }, "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": [ @@ -38385,14 +34978,8 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "created_by": { "type": "string", @@ -38447,34 +35034,22 @@ "description": "The ID of the container used to run the code." }, "code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "outputs": { - "anyOf": [ - { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" - } - ] + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" } - }, - { - "type": "null" - } - ] + ] + }, + "nullable": true } }, "allOf": [ @@ -38529,6 +35104,7 @@ "type", "id", "call_id", + "action", "pending_safety_checks", "status" ], @@ -38552,9 +35128,6 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, - "actions": { - "$ref": "#/components/schemas/OpenAI.ComputerActionList" - }, "pending_safety_checks": { "type": "array", "items": { @@ -38580,11 +35153,10 @@ "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.ItemFieldComputerToolCallOutput": { + "OpenAI.ItemFieldComputerToolCallOutputResource": { "type": "object", "required": [ "type", - "id", "call_id", "output" ], @@ -38600,8 +35172,7 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output.", - "readOnly": true + "description": "The ID of the computer tool call output." }, "call_id": { "type": "string", @@ -38631,9 +35202,7 @@ { "$ref": "#/components/schemas/OpenAI.ItemField" } - ], - "description": "The output of a computer tool call.", - "title": "Computer tool call output" + ] }, "OpenAI.ItemFieldCustomToolCall": { "type": "object", @@ -38660,10 +35229,6 @@ "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." @@ -38768,17 +35333,11 @@ "description": "The queries used to search for files." }, "results": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + }, + "nullable": true } }, "allOf": [ @@ -38828,20 +35387,19 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" + "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." }, "environment": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallEnvironment" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "created_by": { "type": "string", @@ -38887,7 +35445,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -38900,14 +35458,13 @@ "description": "An array of shell call output contents" }, "max_output_length": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "created_by": { "type": "string", @@ -38925,7 +35482,6 @@ "OpenAI.ItemFieldFunctionToolCall": { "type": "object", "required": [ - "id", "type", "call_id", "name", @@ -38934,8 +35490,7 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call.", - "readOnly": true + "description": "The unique ID of the function tool call." }, "type": { "type": "string", @@ -38949,10 +35504,6 @@ "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." @@ -38979,64 +35530,6 @@ "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": [ @@ -39069,14 +35562,8 @@ "description": "The status of the image generation call." }, "result": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -39159,19 +35646,13 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "anyOf": [ - { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, - { - "type": "null" - } - ] + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "nullable": true } }, "allOf": [ @@ -39255,14 +35736,8 @@ "description": "Whether the request was approved." }, "reason": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -39306,7 +35781,8 @@ "description": "The tools available on the server." }, "error": { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + "type": "string", + "nullable": true } }, "allOf": [ @@ -39352,18 +35828,12 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "error": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, "status": { "allOf": [ @@ -39374,14 +35844,8 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -39437,16 +35901,6 @@ "$ref": "#/components/schemas/OpenAI.MessageContent" }, "description": "The content of the message" - }, - "phase": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessagePhase" - }, - { - "type": "null" - } - ] } }, "allOf": [ @@ -39478,14 +35932,8 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "summary": { "type": "array", @@ -39519,138 +35967,6 @@ "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": [ { @@ -39661,9 +35977,6 @@ "enum": [ "message", "function_call", - "tool_search_call", - "tool_search_output", - "additional_tools", "function_call_output", "file_search_call", "web_search_call", @@ -39783,17 +36096,11 @@ "description": "The queries used to search for files." }, "results": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + }, + "nullable": true } }, "allOf": [ @@ -39813,14 +36120,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -39862,14 +36163,12 @@ "description": "Text, image, or file output of the function tool call." }, "status": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "allOf": [ @@ -39889,14 +36188,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -39922,24 +36215,21 @@ "description": "The shell commands and limits that describe how to run the tool call." }, "status": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemStatus" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "environment": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemParamEnvironment" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "allOf": [ @@ -39959,14 +36249,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -39991,24 +36275,21 @@ "description": "Captured chunks of stdout and stderr output, along with their associated outcomes." }, "status": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemStatus" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "max_output_length": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "allOf": [ @@ -40022,7 +36303,6 @@ "OpenAI.ItemFunctionToolCall": { "type": "object", "required": [ - "id", "type", "call_id", "name", @@ -40031,8 +36311,7 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call.", - "readOnly": true + "description": "The unique ID of the function tool call." }, "type": { "type": "string", @@ -40046,10 +36325,6 @@ "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." @@ -40108,14 +36383,8 @@ "description": "The status of the image generation call." }, "result": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -40126,59 +36395,6 @@ "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": [ @@ -40251,19 +36467,13 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "anyOf": [ - { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, - { - "type": "null" - } - ] + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "nullable": true } }, "allOf": [ @@ -40334,14 +36544,8 @@ "x-stainless-const": true }, "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "approval_request_id": { "type": "string", @@ -40352,14 +36556,8 @@ "description": "Whether the request was approved." }, "reason": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -40403,7 +36601,8 @@ "description": "The tools available on the server." }, "error": { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + "type": "string", + "nullable": true } }, "allOf": [ @@ -40449,18 +36648,12 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "error": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, "status": { "allOf": [ @@ -40471,14 +36664,8 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -40526,16 +36713,6 @@ }, "description": "The content of the output message." }, - "phase": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessagePhase" - }, - { - "type": "null" - } - ] - }, "status": { "type": "string", "enum": [ @@ -40575,14 +36752,8 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "summary": { "type": "array", @@ -40629,7 +36800,8 @@ "item_reference" ], "description": "The type of item to reference. Always `item_reference`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "item_reference" }, "id": { "type": "string", @@ -40657,19 +36829,14 @@ "discriminator": { "propertyName": "type", "mapping": { - "message": "#/components/schemas/OpenAI.ItemResourceInputMessage", + "message": "#/components/schemas/OpenAI.InputMessageResource", "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.ItemResourceComputerToolCallOutput", + "computer_call_output": "#/components/schemas/OpenAI.ItemResourceComputerToolCallOutputResource", "web_search_call": "#/components/schemas/OpenAI.ItemResourceWebSearchToolCall", - "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", + "function_call": "#/components/schemas/OpenAI.ItemResourceFunctionToolCallResource", + "function_call_output": "#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutputResource", "image_generation_call": "#/components/schemas/OpenAI.ItemResourceImageGenToolCall", "code_interpreter_call": "#/components/schemas/OpenAI.ItemResourceCodeInterpreterToolCall", "local_shell_call": "#/components/schemas/OpenAI.ItemResourceLocalShellToolCall", @@ -40681,57 +36848,11 @@ "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", - "custom_tool_call": "#/components/schemas/OpenAI.ItemResourceCustomToolCallResource", - "custom_tool_call_output": "#/components/schemas/OpenAI.ItemResourceCustomToolCallOutputResource" + "mcp_call": "#/components/schemas/OpenAI.ItemResourceMcpToolCall" } }, "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": [ @@ -40824,14 +36945,8 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "created_by": { "type": "string", @@ -40886,34 +37001,22 @@ "description": "The ID of the container used to run the code." }, "code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "outputs": { - "anyOf": [ - { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" - } - ] + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" } - }, - { - "type": "null" - } - ] + ] + }, + "nullable": true } }, "allOf": [ @@ -40924,50 +37027,13 @@ "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" ], @@ -40991,9 +37057,6 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, - "actions": { - "$ref": "#/components/schemas/OpenAI.ComputerActionList" - }, "pending_safety_checks": { "type": "array", "items": { @@ -41019,11 +37082,10 @@ "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.ItemResourceComputerToolCallOutput": { + "OpenAI.ItemResourceComputerToolCallOutputResource": { "type": "object", "required": [ "type", - "id", "call_id", "output" ], @@ -41039,8 +37101,7 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output.", - "readOnly": true + "description": "The ID of the computer tool call output." }, "call_id": { "type": "string", @@ -41070,126 +37131,7 @@ { "$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", @@ -41231,17 +37173,11 @@ "description": "The queries used to search for files." }, "results": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + }, + "nullable": true } }, "allOf": [ @@ -41291,20 +37227,19 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" + "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." }, "environment": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallEnvironment" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "created_by": { "type": "string", @@ -41350,88 +37285,30 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" } ], - "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" - }, - "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." + "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." }, - "name": { - "type": "string", - "description": "The name of the function to run." + "output": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputContent" + }, + "description": "An array of shell call output contents" }, - "arguments": { - "type": "string", - "description": "A JSON string of the arguments to pass to the function." + "max_output_length": { + "type": "integer", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + } + ], + "nullable": true }, - "status": { + "created_by": { "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." + "description": "The identifier of the actor that created the item." } }, "allOf": [ @@ -41439,13 +37316,12 @@ "$ref": "#/components/schemas/OpenAI.ItemResource" } ], - "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 shell tool call that was emitted.", + "title": "Shell call output" }, - "OpenAI.ItemResourceFunctionToolCallOutput": { + "OpenAI.ItemResourceFunctionToolCallOutputResource": { "type": "object", "required": [ - "id", "type", "call_id", "output" @@ -41453,8 +37329,7 @@ "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 + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." }, "type": { "type": "string", @@ -41496,103 +37371,91 @@ { "$ref": "#/components/schemas/OpenAI.ItemResource" } - ], - "description": "The output of a function tool call.", - "title": "Function tool call output" + ] }, - "OpenAI.ItemResourceImageGenToolCall": { + "OpenAI.ItemResourceFunctionToolCallResource": { "type": "object", "required": [ "type", - "id", - "status", - "result" + "call_id", + "name", + "arguments" ], "properties": { + "id": { + "type": "string", + "description": "The unique ID of the function tool call." + }, "type": { "type": "string", "enum": [ - "image_generation_call" + "function_call" ], - "description": "The type of the image generation call. Always `image_generation_call`.", + "description": "The type of the function tool call. Always `function_call`.", "x-stainless-const": true }, - "id": { + "call_id": { "type": "string", - "description": "The unique ID of the image generation call." + "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." }, "status": { "type": "string", "enum": [ "in_progress", "completed", - "generating", - "failed" + "incomplete" ], - "description": "The status of the image generation call." - }, - "result": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "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": "An image generation request made by the model.", - "title": "Image generation call" + ] }, - "OpenAI.ItemResourceInputMessage": { + "OpenAI.ItemResourceImageGenToolCall": { "type": "object", "required": [ "type", - "role", - "content", - "id" + "id", + "status", + "result" ], "properties": { "type": { "type": "string", "enum": [ - "message" + "image_generation_call" ], - "description": "The type of the message input. Always set to `message`.", - "x-stainless-const": true, - "default": "message" + "description": "The type of the image generation call. Always `image_generation_call`.", + "x-stainless-const": true }, - "role": { + "id": { "type": "string", - "enum": [ - "user", - "system", - "developer" - ], - "description": "The role of the message input. One of `user`, `system`, or `developer`." + "description": "The unique ID of the image generation call." }, "status": { "type": "string", "enum": [ "in_progress", "completed", - "incomplete" + "generating", + "failed" ], - "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" + "description": "The status of the image generation call." }, - "id": { + "result": { "type": "string", - "description": "The unique ID of the message input.", - "readOnly": true + "nullable": true } }, "allOf": [ @@ -41600,8 +37463,8 @@ "$ref": "#/components/schemas/OpenAI.ItemResource" } ], - "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" + "description": "An image generation request made by the model.", + "title": "Image generation call" }, "OpenAI.ItemResourceLocalShellToolCall": { "type": "object", @@ -41675,19 +37538,13 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "anyOf": [ - { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, - { - "type": "null" - } - ] + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "nullable": true } }, "allOf": [ @@ -41771,14 +37628,8 @@ "description": "Whether the request was approved." }, "reason": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -41822,7 +37673,8 @@ "description": "The tools available on the server." }, "error": { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + "type": "string", + "nullable": true } }, "allOf": [ @@ -41868,18 +37720,12 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "error": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, "status": { "allOf": [ @@ -41890,14 +37736,8 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -41945,16 +37785,6 @@ }, "description": "The content of the output message." }, - "phase": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessagePhase" - }, - { - "type": "null" - } - ] - }, "status": { "type": "string", "enum": [ @@ -41973,200 +37803,6 @@ "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": [ { @@ -42183,11 +37819,6 @@ "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", @@ -42200,8 +37831,6 @@ "mcp_approval_request", "mcp_approval_response", "mcp_call", - "custom_tool_call", - "custom_tool_call_output", "structured_outputs", "oauth_consent_request", "memory_search_call", @@ -42284,143 +37913,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.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": [ { @@ -42437,9 +37929,6 @@ "web_search_call", "function_call", "function_call_output", - "tool_search_call", - "tool_search_output", - "additional_tools", "reasoning", "compaction", "image_generation_call", @@ -42551,7 +38040,8 @@ "keypress" ], "description": "Specifies the event type. For a keypress action, this property is always set to `keypress`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "keypress" }, "keys": { "type": "array", @@ -42592,24 +38082,12 @@ "x-stainless-const": true }, "first_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "last_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "type": "string", + "nullable": true, "x-ms-list-continuation-token": true }, "has_more": { @@ -42683,7 +38161,8 @@ "local" ], "description": "The environment type. Always `local`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "local" } }, "allOf": [ @@ -42694,6 +38173,22 @@ "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": [ @@ -42719,42 +38214,29 @@ "description": "The command to run." }, "timeout_ms": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "working_directory": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "env": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Environment variables to set for the command.", "x-oaiTypeLabel": "map" }, "user": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "description": "Execute a shell command on the server.", @@ -42772,7 +38254,8 @@ "local_shell" ], "description": "The type of the local shell tool. Always `local_shell`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "local_shell" }, "name": { "type": "string", @@ -42856,14 +38339,8 @@ "description": "The name of the tool." }, "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "input_schema": { "allOf": [ @@ -42874,14 +38351,13 @@ "description": "The JSON schema describing the tool's input." }, "annotations": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.MCPListToolsToolAnnotations" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "description": "A tool available on an MCP server.", @@ -42940,17 +38416,11 @@ "description": "Optional description of the MCP server, used to provide more context." }, "headers": { - "anyOf": [ - { - "type": "object", - "unevaluatedProperties": { - "type": "string" - } - }, - { - "type": "null" - } - ] + "type": "object", + "additionalProperties": { + "type": "string" + }, + "nullable": true }, "allowed_tools": { "anyOf": [ @@ -42958,38 +38428,42 @@ "type": "array", "items": { "type": "string" - } - }, - { - "$ref": "#/components/schemas/OpenAI.MCPToolFilter" + }, + "nullable": true }, { - "type": "null" + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MCPToolFilter" + } + ], + "nullable": true } ] }, "require_approval": { "anyOf": [ { - "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" + } + ], + "nullable": true }, { "type": "string", "enum": [ "always", "never" - ] - }, - { - "type": "null" + ], + "nullable": true } ], "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." @@ -43063,8 +38537,7 @@ "reasoning_text": "#/components/schemas/OpenAI.MessageContentReasoningTextContent", "refusal": "#/components/schemas/OpenAI.MessageContentRefusalContent", "input_image": "#/components/schemas/OpenAI.MessageContentInputImageContent", - "input_file": "#/components/schemas/OpenAI.MessageContentInputFileContent", - "summary_text": "#/components/schemas/OpenAI.SummaryTextContent" + "input_file": "#/components/schemas/OpenAI.MessageContentInputFileContent" } }, "description": "A content part that makes up an input or output item." @@ -43085,35 +38558,21 @@ "default": "input_file" }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "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." }, - "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`." + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." } }, "allOf": [ @@ -43141,25 +38600,13 @@ "default": "input_image" }, "image_url": { - "anyOf": [ - { - "type": "string", - "format": "uri" - }, - { - "type": "null" - } - ] + "type": "string", + "format": "uri", + "nullable": true }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "detail": { "allOf": [ @@ -43167,7 +38614,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." } }, "allOf": [ @@ -43330,14 +38777,6 @@ } ] }, - "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": [ @@ -43361,7 +38800,7 @@ }, "OpenAI.Metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "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.", @@ -43370,13 +38809,18 @@ "OpenAI.ModelIdsCompaction": { "anyOf": [ { - "$ref": "#/components/schemas/OpenAI.ModelIdsResponses" - }, - { - "type": "string" + "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 }, { - "type": "null" + "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 } ], "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." @@ -43417,182 +38861,6 @@ } ] }, - "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": [ @@ -43607,7 +38875,8 @@ "move" ], "description": "Specifies the event type. For a move action, this property is always set to `move`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "move" }, "x": { "allOf": [ @@ -43624,19 +38893,6 @@ } ], "description": "The y-coordinate to move to." - }, - "keys": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] } }, "allOf": [ @@ -43647,57 +38903,6 @@ "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": [ @@ -43886,19 +39091,13 @@ "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", @@ -43906,56 +39105,10 @@ "mcp_call": "#/components/schemas/OpenAI.OutputItemMcpToolCall", "mcp_list_tools": "#/components/schemas/OpenAI.OutputItemMcpListTools", "mcp_approval_request": "#/components/schemas/OpenAI.OutputItemMcpApprovalRequest", - "mcp_approval_response": "#/components/schemas/OpenAI.OutputItemMcpApprovalResponseResource", - "custom_tool_call": "#/components/schemas/OpenAI.OutputItemCustomToolCallResource", - "custom_tool_call_output": "#/components/schemas/OpenAI.OutputItemCustomToolCallOutputResource" + "custom_tool_call": "#/components/schemas/OpenAI.OutputItemCustomToolCall" } } }, - "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": [ @@ -44048,14 +39201,8 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "created_by": { "type": "string", @@ -44110,34 +39257,22 @@ "description": "The ID of the container used to run the code." }, "code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "outputs": { - "anyOf": [ - { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" - } - ] + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" } - }, - { - "type": "null" - } - ] + ] + }, + "nullable": true } }, "allOf": [ @@ -44192,6 +39327,7 @@ "type", "id", "call_id", + "action", "pending_safety_checks", "status" ], @@ -44215,9 +39351,6 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, - "actions": { - "$ref": "#/components/schemas/OpenAI.ComputerActionList" - }, "pending_safety_checks": { "type": "array", "items": { @@ -44243,128 +39376,13 @@ "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.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": { + "OpenAI.OutputItemCustomToolCall": { "type": "object", "required": [ "type", "call_id", "name", - "input", - "status" + "input" ], "properties": { "type": { @@ -44383,10 +39401,6 @@ "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." @@ -44394,18 +39408,6 @@ "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": [ @@ -44413,7 +39415,8 @@ "$ref": "#/components/schemas/OpenAI.OutputItem" } ], - "title": "ResponseCustomToolCallItem" + "description": "A call to a custom tool created by the model.", + "title": "Custom tool call" }, "OpenAI.OutputItemFileSearchToolCall": { "type": "object", @@ -44455,17 +39458,11 @@ "description": "The queries used to search for files." }, "results": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + }, + "nullable": true } }, "allOf": [ @@ -44515,20 +39512,19 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" + "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." }, "environment": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallEnvironment" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "created_by": { "type": "string", @@ -44574,7 +39570,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -44587,14 +39583,13 @@ "description": "An array of shell call output contents" }, "max_output_length": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "created_by": { "type": "string", @@ -44612,99 +39607,35 @@ "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", - "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.", - "readOnly": true + "description": "The unique ID of the function tool call." }, "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." + "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", @@ -44721,8 +39652,8 @@ "$ref": "#/components/schemas/OpenAI.OutputItem" } ], - "description": "The output of a function tool call.", - "title": "Function tool 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.OutputItemImageGenToolCall": { "type": "object", @@ -44756,14 +39687,8 @@ "description": "The status of the image generation call." }, "result": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -44821,54 +39746,6 @@ "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": [ @@ -44912,54 +39789,6 @@ "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": [ @@ -44993,7 +39822,8 @@ "description": "The tools available on the server." }, "error": { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + "type": "string", + "nullable": true } }, "allOf": [ @@ -45039,18 +39869,12 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "error": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, "status": { "allOf": [ @@ -45061,14 +39885,8 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -45116,16 +39934,6 @@ }, "description": "The content of the output message." }, - "phase": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessagePhase" - }, - { - "type": "null" - } - ] - }, "status": { "type": "string", "enum": [ @@ -45165,14 +39973,8 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "summary": { "type": "array", @@ -45206,138 +40008,6 @@ "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": [ { @@ -45349,19 +40019,13 @@ "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", @@ -45369,9 +40033,7 @@ "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", @@ -45570,35 +40232,21 @@ "description": "The unique identifier of the prompt template to use." }, "version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "variables": { - "anyOf": [ + "type": "object", + "allOf": [ { "$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": [ @@ -45635,181 +40283,46 @@ } } }, - "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": { + "OpenAI.Reasoning": { "type": "object", - "required": [ - "type", - "code", - "message" - ], "properties": { - "type": { - "type": "string", - "enum": [ - "http_error" - ], - "x-stainless-const": true - }, - "code": { - "$ref": "#/components/schemas/OpenAI.integer" + "effort": { + "$ref": "#/components/schemas/OpenAI.ReasoningEffort" }, - "message": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" - } - ], - "title": "Realtime MCP HTTP error" - }, - "OpenAI.RealtimeMCPProtocolError": { - "type": "object", - "required": [ - "type", - "code", - "message" - ], - "properties": { - "type": { + "summary": { "type": "string", "enum": [ - "protocol_error" + "auto", + "concise", + "detailed" ], - "x-stainless-const": true - }, - "code": { - "$ref": "#/components/schemas/OpenAI.integer" + "nullable": true }, - "message": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" - } - ], - "title": "Realtime MCP protocol error" - }, - "OpenAI.RealtimeMCPToolExecutionError": { - "type": "object", - "required": [ - "type", - "message" - ], - "properties": { - "type": { + "generate_summary": { "type": "string", "enum": [ - "tool_execution_error" + "auto", + "concise", + "detailed" ], - "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" - } - ] + "nullable": true } }, "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": { - "anyOf": [ - { - "type": "string", - "enum": [ - "none", - "minimal", - "low", - "medium", - "high", - "xhigh" - ] - }, - { - "type": "null" - } + "type": "string", + "enum": [ + "none", + "minimal", + "low", + "medium", + "high", + "xhigh" ], - "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`." + "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 }, "OpenAI.ReasoningTextContent": { "type": "object", @@ -45850,45 +40363,41 @@ ], "properties": { "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "top_logprobs": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "temperature": { - "anyOf": [ + "type": "number", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" - }, - { - "type": "null" } ], + "nullable": true, "default": 1 }, "top_p": { - "anyOf": [ + "type": "number", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" - }, - { - "type": "null" } ], + "nullable": true, "default": 1 }, "user": { @@ -45898,8 +40407,7 @@ }, "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)." + "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", @@ -45909,62 +40417,51 @@ "$ref": "#/components/schemas/OpenAI.ServiceTier" }, "prompt_cache_retention": { - "anyOf": [ - { - "type": "string", - "enum": [ - "in_memory", - "24h" - ] - }, - { - "type": "null" - } - ] + "type": "string", + "enum": [ + "in-memory", + "24h" + ], + "nullable": true }, "previous_response_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "model": { "type": "string", "description": "The model deployment to use for the creation of this response." }, "reasoning": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Reasoning" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "background": { - "anyOf": [ - { - "type": "boolean" - }, + "type": "boolean", + "nullable": true + }, + "max_output_tokens": { + "type": "integer", + "allOf": [ { - "type": "null" + "$ref": "#/components/schemas/OpenAI.integer" } - ] + ], + "nullable": true }, "max_tool_calls": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "text": { "$ref": "#/components/schemas/OpenAI.ResponseTextParam" @@ -45986,18 +40483,12 @@ "$ref": "#/components/schemas/OpenAI.Prompt" }, "truncation": { - "anyOf": [ - { - "type": "string", - "enum": [ - "auto", - "disabled" - ] - }, - { - "type": "null" - } + "type": "string", + "enum": [ + "auto", + "disabled" ], + "nullable": true, "default": "disabled" }, "id": { @@ -46030,37 +40521,27 @@ "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" + "format": "unixtime", + "nullable": true }, "error": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.ResponseError" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "incomplete_details": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.ResponseIncompleteDetails" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "output": { "type": "array", @@ -46079,69 +40560,39 @@ "items": { "$ref": "#/components/schemas/OpenAI.InputItem" } - }, - { - "type": "null" } - ] + ], + "nullable": true }, "output_text": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "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": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.ConversationReference" - }, - { - "type": "null" - } - ] - }, - "max_output_tokens": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "agent_reference": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/AgentReference" - }, - { - "type": "null" } ], + "nullable": true, "description": "The agent used for this response" }, "content_filters": { @@ -46180,15 +40631,10 @@ }, "delta": { "type": "string", - "contentEncoding": "base64", + "format": "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", @@ -46220,11 +40666,6 @@ "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", @@ -46261,11 +40702,6 @@ "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", @@ -46297,11 +40733,6 @@ "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", @@ -46352,11 +40783,6 @@ "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", @@ -46407,11 +40833,6 @@ "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", @@ -46457,11 +40878,6 @@ "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", @@ -46507,11 +40923,6 @@ "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", @@ -46557,11 +40968,6 @@ "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", @@ -46602,11 +41008,6 @@ "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", @@ -46670,11 +41071,6 @@ "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", @@ -46738,11 +41134,6 @@ "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", @@ -46783,11 +41174,6 @@ "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", @@ -46838,11 +41224,6 @@ "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": { @@ -46894,11 +41275,6 @@ "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": { @@ -46967,28 +41343,16 @@ "x-stainless-const": true }, "code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "message": { "type": "string", "description": "The error message." }, "param": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "sequence_number": { "allOf": [ @@ -46999,11 +41363,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when an error occurs.", "x-oaiMeta": { "name": "error", @@ -47044,11 +41403,6 @@ "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", @@ -47094,11 +41448,6 @@ "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", @@ -47144,11 +41493,6 @@ "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", @@ -47194,11 +41538,6 @@ "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", @@ -47273,20 +41612,14 @@ "$ref": "#/components/schemas/OpenAI.ResponseFormatJsonSchemaSchema" }, "strict": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ] + "type": "boolean", + "nullable": true } } }, "OpenAI.ResponseFormatJsonSchemaSchema": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "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" }, @@ -47351,11 +41684,6 @@ "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", @@ -47410,11 +41738,6 @@ "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", @@ -47460,11 +41783,6 @@ "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": { @@ -47511,11 +41829,6 @@ "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": { @@ -47562,11 +41875,6 @@ "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": { @@ -47627,11 +41935,6 @@ "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": { @@ -47673,11 +41976,6 @@ "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", @@ -47730,11 +42028,6 @@ "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", @@ -47766,7 +42059,7 @@ "items": { "$ref": "#/components/schemas/OpenAI.ResponseLogProbTopLogprobs" }, - "description": "The log probabilities of up to 20 of the most likely tokens." + "description": "The log probability of the top 20 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." @@ -47825,11 +42118,6 @@ "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": { @@ -47881,11 +42169,6 @@ "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": { @@ -47932,11 +42215,6 @@ "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": { @@ -47983,11 +42261,6 @@ "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": { @@ -48034,11 +42307,6 @@ "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": { @@ -48085,11 +42353,6 @@ "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": { @@ -48136,11 +42399,6 @@ "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": { @@ -48187,11 +42445,6 @@ "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": { @@ -48242,11 +42495,6 @@ "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", @@ -48296,11 +42544,6 @@ "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", @@ -48373,11 +42616,6 @@ "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": { @@ -48388,7 +42626,7 @@ }, "OpenAI.ResponsePromptVariables": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "anyOf": [ { "type": "string" @@ -48442,11 +42680,6 @@ "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": { @@ -48511,11 +42744,6 @@ "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", @@ -48598,11 +42826,6 @@ "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", @@ -48681,11 +42904,6 @@ "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", @@ -48745,11 +42963,6 @@ "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", @@ -48809,11 +43022,6 @@ "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", @@ -48873,11 +43081,6 @@ "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", @@ -48937,11 +43140,6 @@ "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", @@ -49001,11 +43199,6 @@ "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", @@ -49013,140 +43206,6 @@ "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": { @@ -49217,11 +43276,6 @@ "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", @@ -49289,11 +43343,6 @@ "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", @@ -49426,11 +43475,6 @@ "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", @@ -49476,11 +43520,6 @@ "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", @@ -49526,11 +43565,6 @@ "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", @@ -49550,7 +43584,8 @@ "screenshot" ], "description": "Specifies the event type. For a screenshot action, this property is always set to `screenshot`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "screenshot" } }, "allOf": [ @@ -49577,7 +43612,8 @@ "scroll" ], "description": "Specifies the event type. For a scroll action, this property is always set to `scroll`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "scroll" }, "x": { "allOf": [ @@ -49610,19 +43646,6 @@ } ], "description": "The vertical scroll distance." - }, - "keys": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] } }, "allOf": [ @@ -49633,13 +43656,6 @@ "description": "A scroll action.", "title": "Scroll" }, - "OpenAI.SearchContentType": { - "type": "string", - "enum": [ - "text", - "image" - ] - }, "OpenAI.SearchContextSize": { "type": "string", "enum": [ @@ -49649,31 +43665,16 @@ ] }, "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", @@ -49688,7 +43689,8 @@ "skill_reference" ], "description": "References a skill created with the /v1/skills endpoint.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "skill_reference" }, "skill_id": { "type": "string", @@ -49719,7 +43721,8 @@ "apply_patch" ], "description": "The tool to call. Always `apply_patch`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "apply_patch" } }, "allOf": [ @@ -49742,7 +43745,8 @@ "shell" ], "description": "The tool to call. Always `shell`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "shell" } }, "allOf": [ @@ -49766,7 +43770,8 @@ "summary_text" ], "description": "The type of the object. Always `summary_text`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "summary_text" }, "text": { "type": "string", @@ -49793,7 +43798,8 @@ "enum": [ "text" ], - "x-stainless-const": true + "x-stainless-const": true, + "default": "text" }, "text": { "type": "string" @@ -49916,14 +43922,8 @@ "$ref": "#/components/schemas/OpenAI.ResponseFormatJsonSchemaSchema" }, "strict": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ] + "type": "boolean", + "nullable": true } }, "allOf": [ @@ -49971,10 +43971,7 @@ "shell": "#/components/schemas/OpenAI.FunctionShellToolParam", "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" + "apply_patch": "#/components/schemas/OpenAI.ApplyPatchToolParam" } }, "description": "A tool that can be used to generate a response." @@ -50007,7 +44004,7 @@ "type": "array", "items": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, "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 ```" } @@ -50040,46 +44037,6 @@ ], "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": [ @@ -50216,14 +44173,8 @@ "description": "The label of the MCP server to use." }, "name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -50268,9 +44219,7 @@ "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", - "computer": "#/components/schemas/OpenAI.ToolChoiceComputer", - "computer_use": "#/components/schemas/OpenAI.ToolChoiceComputerUse" + "code_interpreter": "#/components/schemas/OpenAI.ToolChoiceCodeInterpreter" } }, "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." @@ -50294,9 +44243,7 @@ "computer_use_preview", "web_search_preview_2025_03_11", "image_generation", - "code_interpreter", - "computer", - "computer_use" + "code_interpreter" ] } ] @@ -50341,64 +44288,6 @@ ], "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": [ { @@ -50409,7 +44298,6 @@ "enum": [ "function", "file_search", - "computer", "computer_use_preview", "web_search", "mcp", @@ -50418,8 +44306,6 @@ "local_shell", "shell", "custom", - "namespace", - "tool_search", "web_search_preview", "apply_patch", "a2a_preview", @@ -50483,7 +44369,8 @@ "type" ], "description": "Specifies the event type. For a type action, this property is always set to `type`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "type" }, "text": { "type": "string", @@ -50505,14 +44392,13 @@ ], "properties": { "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$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." } } @@ -50533,7 +44419,8 @@ "url_citation" ], "description": "The type of the URL citation. Always `url_citation`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "url_citation" }, "url": { "type": "string", @@ -50571,7 +44458,7 @@ }, "OpenAI.VectorStoreFileAttributes": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "anyOf": [ { "type": "string" @@ -50588,20 +44475,14 @@ "x-oaiTypeLabel": "map" }, "OpenAI.Verbosity": { - "anyOf": [ - { - "type": "string", - "enum": [ - "low", - "medium", - "high" - ] - }, - { - "type": "null" - } + "type": "string", + "enum": [ + "low", + "medium", + "high" ], - "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`." + "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 }, "OpenAI.WaitParam": { "type": "object", @@ -50615,7 +44496,8 @@ "wait" ], "description": "Specifies the event type. For a wait action, this property is always set to `wait`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "wait" } }, "allOf": [ @@ -50670,15 +44552,9 @@ "x-stainless-const": true }, "url": { - "anyOf": [ - { - "type": "string", - "format": "uri" - }, - { - "type": "null" - } - ], + "type": "string", + "format": "uri", + "nullable": true, "description": "The URL opened by the model." } }, @@ -50688,7 +44564,8 @@ "OpenAI.WebSearchActionSearch": { "type": "object", "required": [ - "type" + "type", + "query" ], "properties": { "type": { @@ -50701,7 +44578,7 @@ }, "query": { "type": "string", - "description": "The search query.", + "description": "[DEPRECATED] The search query.", "deprecated": true }, "queries": { @@ -50739,8 +44616,7 @@ "x-stainless-const": true }, "url": { - "type": "string", - "format": "uri" + "type": "string" } } }, @@ -50760,44 +44636,20 @@ "default": "approximate" }, "country": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "region": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "city": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "timezone": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "description": "The approximate location of the user.", @@ -50815,17 +44667,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 + "x-stainless-const": true, + "default": "web_search_preview" }, "user_location": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.ApproximateLocation" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "search_context_size": { "allOf": [ @@ -50834,12 +44686,6 @@ } ], "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": [ @@ -50861,27 +44707,26 @@ "enum": [ "web_search" ], - "description": "The type of the web search tool. One of `web_search` or `web_search_2025_08_26`." + "description": "The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.", + "default": "web_search" }, "filters": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.WebSearchToolFilters" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "user_location": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.WebSearchApproximateLocation" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "search_context_size": { "type": "string", @@ -50922,17 +44767,11 @@ "type": "object", "properties": { "allowed_domains": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "type": "string" + }, + "nullable": true } } }, @@ -51024,7 +44863,7 @@ }, "spec": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The openapi function shape, described as a JSON Schema object." }, "auth": { @@ -51057,7 +44896,7 @@ }, "parameters": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The parameters the functions accepts, described as a JSON Schema object." } }, @@ -51308,32 +45147,58 @@ ], "description": "An OpenAPI tool stored in a toolbox." }, - "OptimizationAgentIdentifier": { + "OptimizationAgentDefinition": { "type": "object", - "required": [ - "agent_name" - ], "properties": { - "agent_name": { + "agentName": { "type": "string", - "description": "Registered Foundry agent name (required)." + "description": "Agent name." }, - "agent_version": { + "agentVersion": { "type": "string", - "description": "Pinned agent version. Defaults to latest if omitted." + "description": "Agent version." + }, + "model": { + "type": "string", + "description": "Model deployment name." + }, + "systemPrompt": { + "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": "Identifies the registered Foundry agent to optimize (request-only). Skills, tools, and system_prompt are specified in options.optimization_config." + "description": "Agent definition returned in response payloads (includes resolved config)." }, "OptimizationCandidate": { "type": "object", "required": [ "name", - "avg_score", - "avg_tokens" + "config", + "mutations", + "avgScore", + "avgTokens", + "passRate", + "taskScores", + "isParetoOptimal" ], "properties": { - "candidate_id": { + "candidateId": { "type": "string", "description": "Server-assigned candidate identifier. Use with GET /candidates/{id} sub-endpoints." }, @@ -51341,26 +45206,50 @@ "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", - "unevaluatedProperties": {}, - "description": "What was mutated from the baseline (e.g., {system_prompt: 'new prompt'})." + "additionalProperties": {}, + "description": "What was mutated from the baseline (e.g., {systemPrompt: 'new prompt'})." }, - "avg_score": { + "avgScore": { "type": "number", "format": "double", "description": "Average composite score across all tasks." }, - "avg_tokens": { + "avgTokens": { "type": "number", "format": "double", "description": "Average token usage across all tasks." }, - "eval_id": { + "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": { "type": "string", "description": "Foundry evaluation identifier used to score this candidate." }, - "eval_run_id": { + "evalRunId": { "type": "string", "description": "Foundry evaluation run identifier for this candidate's scoring run." }, @@ -51375,144 +45264,12 @@ }, "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", - "created_at", - "updated_at" + "createdAt" ], "properties": { "id": { @@ -51520,42 +45277,42 @@ "description": "Server-assigned unique identifier.", "readOnly": true }, - "inputs": { + "status": { "allOf": [ { - "$ref": "#/components/schemas/OptimizationJobInputs" + "$ref": "#/components/schemas/JobStatus" } ], - "description": "Caller-supplied inputs." + "description": "Current lifecycle status.", + "readOnly": true }, - "result": { + "error": { "allOf": [ { - "$ref": "#/components/schemas/OptimizationJobResult" + "$ref": "#/components/schemas/OpenAI.Error" } ], - "description": "Result produced on success.", + "description": "Error details — populated only on failure.", "readOnly": true }, - "status": { + "result": { "allOf": [ { - "$ref": "#/components/schemas/JobStatus" + "$ref": "#/components/schemas/OptimizationJobResult" } ], - "description": "Current lifecycle status.", + "description": "Result produced on success.", "readOnly": true }, - "error": { + "inputs": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.Error" + "$ref": "#/components/schemas/OptimizationJobInputs" } ], - "description": "Error details — populated only on failure.", - "readOnly": true + "description": "Caller-supplied inputs." }, - "created_at": { + "createdAt": { "allOf": [ { "$ref": "#/components/schemas/FoundryTimestamp" @@ -51564,7 +45321,7 @@ "description": "The timestamp when the job was created, represented in Unix time.", "readOnly": true }, - "updated_at": { + "updatedAt": { "allOf": [ { "$ref": "#/components/schemas/FoundryTimestamp" @@ -51579,15 +45336,16 @@ "$ref": "#/components/schemas/OptimizationJobProgress" } ], - "description": "Progress snapshot. May be present in terminal states reflecting last-known progress.", + "description": "Progress while in flight. Absent in terminal states.", "readOnly": true }, - "warnings": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Non-fatal warnings emitted at any point during optimization.", + "dataset": { + "allOf": [ + { + "$ref": "#/components/schemas/DatasetInfo" + } + ], + "description": "Metadata about the dataset used for this optimization job.", "readOnly": true } }, @@ -51597,30 +45355,29 @@ "type": "object", "required": [ "agent", - "train_dataset", - "evaluators" + "trainDatasetReference" ], "properties": { "agent": { "allOf": [ { - "$ref": "#/components/schemas/OptimizationAgentIdentifier" + "$ref": "#/components/schemas/AgentIdentifier" } ], "description": "The agent (and pinned version) being optimized." }, - "train_dataset": { + "trainDatasetReference": { "allOf": [ { - "$ref": "#/components/schemas/OptimizationDatasetInput" + "$ref": "#/components/schemas/DatasetRef" } ], - "description": "Training dataset — either inline items or a reference to a registered dataset. Required." + "description": "Reference to a registered training dataset (required)." }, - "validation_dataset": { + "validationDatasetReference": { "allOf": [ { - "$ref": "#/components/schemas/OptimizationDatasetInput" + "$ref": "#/components/schemas/DatasetRef" } ], "description": "Optional held-out validation dataset for measuring generalization of the final candidate." @@ -51628,9 +45385,9 @@ "evaluators": { "type": "array", "items": { - "$ref": "#/components/schemas/OptimizationEvaluatorRef" + "type": "string" }, - "description": "Job-level evaluators referenced by name and optional version. Required; at least one must be provided." + "description": "Job-level evaluators (referenced by name). Per-task criteria may override. Default: ['task_adherence']." }, "options": { "allOf": [ @@ -51643,96 +45400,25 @@ }, "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": [ - "candidates_completed", - "best_score", - "elapsed_seconds" + "currentIteration", + "bestScore", + "elapsedSeconds" ], "properties": { - "candidates_completed": { + "currentIteration": { "type": "integer", "format": "int32", - "description": "Number of candidates whose evaluation has completed so far." + "description": "1-based current iteration index." }, - "best_score": { + "bestScore": { "type": "number", "format": "double", "description": "Best score observed so far across all candidates." }, - "elapsed_seconds": { + "elapsedSeconds": { "type": "number", "format": "double", "description": "Wall-clock time elapsed in seconds since the job began executing." @@ -51744,12 +45430,20 @@ "type": "object", "properties": { "baseline": { - "type": "string", - "description": "Candidate ID of the original (un-optimized) baseline evaluation." + "allOf": [ + { + "$ref": "#/components/schemas/OptimizationCandidate" + } + ], + "description": "Evaluation scores for the original (un-optimized) agent configuration." }, "best": { - "type": "string", - "description": "Candidate ID of the highest-scoring candidate found during optimization." + "allOf": [ + { + "$ref": "#/components/schemas/OptimizationCandidate" + } + ], + "description": "The highest-scoring candidate found during optimization." }, "candidates": { "type": "array", @@ -51757,6 +45451,25 @@ "$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." @@ -51764,27 +45477,26 @@ "OptimizationOptions": { "type": "object", "properties": { - "max_candidates": { + "maxIterations": { "type": "integer", "format": "int32", - "minimum": 1, - "description": "Maximum number of optimization candidates to generate. Must be >= 1. Default: 5.", + "description": "Maximum optimization iterations per strategy. Must be >= 1. Default: 5.", "default": 5 }, - "optimization_config": { + "optimizationConfig": { "type": "object", - "unevaluatedProperties": {}, - "description": "Per-target-attribute configuration overrides. Contains skills, tools, system_prompt for the agent, plus model space for model optimization." + "additionalProperties": {}, + "description": "Per-target-attribute configuration overrides. Contains skills, tools, systemPrompt for the agent, plus model space for model optimization." }, - "eval_model": { + "evalModel": { "type": "string", "description": "Model deployment used for evaluation. Defaults to server config (typically 'gpt-4o')." }, - "optimization_model": { + "optimizationModel": { "type": "string", "description": "Model deployment for optimization reasoning (must be gpt-5 family). Falls back to the default eval model when not set." }, - "evaluation_level": { + "evaluationLevel": { "allOf": [ { "$ref": "#/components/schemas/EvaluationLevel" @@ -51795,35 +45507,73 @@ }, "description": "Tuning knobs and run-mode for an optimization job." }, - "OptimizationReferenceDatasetInput": { + "OptimizationTaskResult": { "type": "object", "required": [ - "type", - "name" + "taskName", + "scores", + "compositeScore", + "tokens", + "durationSeconds", + "passed" ], "properties": { - "type": { + "taskName": { "type": "string", - "enum": [ - "reference" - ], - "description": "Dataset input type discriminator." + "description": "Task name (from the dataset)." }, - "name": { + "query": { "type": "string", - "description": "Registered dataset name." + "description": "The user query / input for the task." }, - "version": { + "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": "string", - "description": "Dataset version. If not specified, the latest version is used." + "description": "Error message if the task failed during execution." + }, + "rationales": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Per-evaluator reasoning keyed by evaluator name." + }, + "response": { + "type": "string", + "description": "Raw agent response text." + }, + "runId": { + "type": "string", + "description": "Identifier of the agent run that produced this result." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OptimizationDatasetInput" - } - ], - "description": "Reference to a registered Foundry dataset." + "description": "Per-task evaluation result for a single candidate." }, "OtlpTelemetryEndpoint": { "type": "object", @@ -51843,9 +45593,7 @@ "endpoint": { "type": "string", "description": "The OTLP collector endpoint URL.", - "examples": [ - "https://my-collector.example.com/otlp" - ] + "example": "https://my-collector.example.com/otlp" }, "protocol": { "allOf": [ @@ -51854,9 +45602,7 @@ } ], "description": "The transport protocol for the OTLP endpoint.", - "examples": [ - "Http" - ] + "example": "Http" } }, "allOf": [ @@ -52240,15 +45986,70 @@ ] } }, + "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": [ - "promoted_at", - "agent_name", - "agent_version" + "promotedAt", + "agentName", + "agentVersion" ], "properties": { - "promoted_at": { + "promotedAt": { "allOf": [ { "$ref": "#/components/schemas/FoundryTimestamp" @@ -52256,11 +46057,11 @@ ], "description": "Timestamp when promotion occurred, represented in Unix time." }, - "agent_name": { + "agentName": { "type": "string", "description": "Name of the Foundry agent this candidate was promoted to." }, - "agent_version": { + "agentVersion": { "type": "string", "description": "Version of the Foundry agent this candidate was promoted to." } @@ -52285,55 +46086,36 @@ "description": "The model deployment to use for this agent." }, "instructions": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "type": "string", + "nullable": true, "description": "A system (or developer) message inserted into the model's context." }, "temperature": { - "anyOf": [ - { - "type": "number", - "format": "float" - }, - { - "type": "null" - } - ], + "type": "number", + "format": "float", + "nullable": true, "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": { - "anyOf": [ - { - "type": "number", - "format": "float" - }, - { - "type": "null" - } - ], + "type": "number", + "format": "float", + "nullable": true, "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": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Reasoning" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "tools": { "type": "array", @@ -52363,7 +46145,7 @@ }, "structured_inputs": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/StructuredInputDefinition" }, "description": "Set of structured inputs that can participate in prompt template substitution or tool argument bindings." @@ -52627,7 +46409,7 @@ }, "simulationOnly": { "type": "boolean", - "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.", + "description": "Simulation-only or Simulation + Evaluation. Default false, if true the scan outputs conversation not evaluation result.", "default": false }, "riskCategories": { @@ -52643,14 +46425,14 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Red team's tags. Unlike properties, tags are fully mutable." }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed." @@ -52878,7 +46660,7 @@ }, "data_mapping": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Mapping from source fields to response_id field, required for retrieving chat history." @@ -52928,7 +46710,10 @@ "Routine": { "type": "object", "required": [ - "enabled" + "name", + "enabled", + "triggers", + "action" ], "properties": { "name": { @@ -52947,7 +46732,7 @@ }, "triggers": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/RoutineTrigger" }, "description": "The triggers configured for the routine." @@ -53058,6 +46843,10 @@ }, "RoutineCreateOrUpdateRequest": { "type": "object", + "required": [ + "triggers", + "action" + ], "properties": { "description": { "type": "string", @@ -53070,7 +46859,7 @@ }, "triggers": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/RoutineTrigger" }, "description": "The triggers configured for the routine. In v1, exactly one trigger entry is supported." @@ -53143,21 +46932,19 @@ "RoutineRun": { "type": "object", "required": [ - "id" + "id", + "status", + "trigger_type", + "started_at" ], "properties": { "id": { "type": "string", - "description": "The unique run identifier for the routine attempt.", - "readOnly": true + "description": "The MLflow run identifier for the routine attempt." }, "status": { - "allOf": [ - { - "$ref": "#/components/schemas/RoutineRunStatus" - } - ], - "description": "The run status." + "type": "string", + "description": "The underlying MLflow run status." }, "phase": { "allOf": [ @@ -53175,10 +46962,6 @@ ], "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": [ { @@ -53195,22 +46978,6 @@ ], "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": [ { @@ -53219,14 +46986,6 @@ ], "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": [ { @@ -53259,11 +47018,6 @@ "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." @@ -53271,6 +47025,14 @@ "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.", @@ -53280,6 +47042,44 @@ ] } }, + "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": [ { @@ -53302,15 +47102,6 @@ ] } }, - "RoutineRunStatus": { - "type": "string", - "description": "The status of a routine run.", - "x-ms-foundry-meta": { - "conditional_previews": [ - "Routines=V1Preview" - ] - } - }, "RoutineTrigger": { "type": "object", "required": [ @@ -53331,8 +47122,7 @@ "mapping": { "schedule": "#/components/schemas/ScheduleRoutineTrigger", "timer": "#/components/schemas/TimerRoutineTrigger", - "github_issue": "#/components/schemas/GitHubIssueRoutineTrigger", - "custom": "#/components/schemas/CustomRoutineTrigger" + "github_issue_opened": "#/components/schemas/GitHubIssueOpenedRoutineTrigger" } }, "description": "Base model for a routine trigger.", @@ -53350,8 +47140,7 @@ { "type": "string", "enum": [ - "custom", - "github_issue", + "github_issue_opened", "schedule", "timer" ] @@ -53518,21 +47307,21 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Schedule's tags. Unlike properties, tags are fully mutable." }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Schedule's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed." }, "systemData": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "System metadata for the resource.", @@ -53629,7 +47418,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Properties of the schedule run.", @@ -53654,7 +47443,7 @@ }, "configuration": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Configuration for the task." @@ -53718,23 +47507,10 @@ "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." @@ -53746,7 +47522,8 @@ }, "description": "The directory entries." } - } + }, + "description": "Response from listing a directory in a session sandbox." }, "SessionFileWriteResponse": { "type": "object", @@ -53781,16 +47558,12 @@ } ], "description": "The SSE event type. Currently `log`, but additional event types may be added in the future. Clients should ignore unrecognized event types.", - "examples": [ - "log" - ] + "example": "log" }, "data": { "type": "string", "description": "The event payload as plain text. Currently JSON-formatted but the schema is not contractual and may change.", - "examples": [ - "{\"timestamp\":\"2026-03-10T09:33:17.121467567+00:00\",\"stream\":\"stdout\",\"message\":\"Starting server on port 18080\"}" - ] + "example": "{\"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```", @@ -54069,7 +47842,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Arbitrary key-value metadata for additional properties." @@ -54183,12 +47956,12 @@ }, "schema": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The JSON schema for the structured input (optional)." }, "required": { "type": "boolean", - "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.", + "description": "Whether the input property is required when the agent is invoked. Defaults to `false`.", "default": false } }, @@ -54213,18 +47986,12 @@ }, "schema": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The JSON schema for the structured output." }, "strict": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], + "type": "boolean", + "nullable": true, "description": "Whether to enforce strict validation. Default `true`." } }, @@ -54519,7 +48286,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Additional properties for the taxonomy category." @@ -54553,7 +48320,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Additional properties for the taxonomy sub-category." @@ -54626,12 +48393,10 @@ "$ref": "#/components/schemas/TelemetryDataKind" }, "description": "Data types to export to this endpoint. Use an empty array to export no data.", - "examples": [ - [ - "ContainerStdoutStderr", - "ContainerOtel", - "Metrics" - ] + "example": [ + "ContainerStdoutStderr", + "ContainerOtel", + "Metrics" ] }, "auth": { @@ -54771,12 +48536,11 @@ }, "initialization_parameters": { "type": "object", - "unevaluatedProperties": {}, "description": "The initialization parameters for the evaluation. Must support structured outputs." }, "data_mapping": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "The model to use for the evaluation. Must support structured outputs." @@ -54788,7 +48552,8 @@ "TimerRoutineTrigger": { "type": "object", "required": [ - "type" + "type", + "at" ], "properties": { "type": { @@ -54799,12 +48564,12 @@ "description": "The trigger type." }, "at": { - "allOf": [ - { - "$ref": "#/components/schemas/FoundryTimestamp" - } - ], - "description": "The UTC date and time at which the timer fires." + "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": [ @@ -54823,7 +48588,7 @@ "anyOf": [ { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, { "type": "string" @@ -55044,7 +48809,7 @@ }, "tool_configs": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$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." @@ -55095,17 +48860,11 @@ ], "properties": { "metadata": { - "anyOf": [ - { - "type": "object", - "unevaluatedProperties": { - "type": "string" - } - }, - { - "type": "null" - } - ], + "type": "object", + "additionalProperties": { + "type": "string" + }, + "nullable": true, "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" }, @@ -55493,7 +49252,7 @@ "properties": { "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "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.", @@ -55510,7 +49269,7 @@ }, "parameter_values": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The inputs to the manifest that will result in a fully materialized Agent." } } @@ -55523,7 +49282,7 @@ "properties": { "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "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.", @@ -55572,18 +49331,17 @@ "type": "string" }, "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "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." @@ -55599,7 +49357,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -55834,24 +49592,22 @@ ] }, "filters": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.WebSearchToolFilters" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "user_location": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.WebSearchApproximateLocation" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "search_context_size": { "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 cd2e3ce92afb..4bce8fdf5f24 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,117 +1,33 @@ -openapi: 3.2.0 +openapi: 3.0.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 - parent: Agents Root - description: Agent Management - - name: Agent Invocations - 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: Agent Invocations + - name: Connections - name: Datasets - parent: Platform APIs + - name: Deployments + - name: Evaluation Taxonomies + - name: Evaluation Rules + - name: Evaluators + - name: EvaluatorGenerationJobs - name: Indexes - parent: Platform APIs - - name: Connections - parent: Platform APIs - - name: Scheduler - parent: Platform APIs - - name: Fine-tuning - parent: Platform APIs - summary: Fine-Tuning + - name: Insights - 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: Conversations + - name: Evals + - name: Fine-Tuning + - name: Responses + - name: Redteams - 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: @@ -126,7 +42,7 @@ paths: schema: type: string enum: - - AgentsOptimization=V2Preview + - AgentsOptimization=V1Preview - name: Operation-Id in: header required: false @@ -158,14 +74,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OptimizationJob' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -177,15 +87,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/OptimizationJob' - description: The job to create. + $ref: '#/components/schemas/OptimizationJobInputs' + description: The optimization job inputs. x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V2Preview + - AgentsOptimization=V1Preview get: operationId: AgentOptimizationJobs_list summary: Returns a list of agent optimization jobs. - description: List optimization jobs. Supports cursor pagination and optional status / agent_name filters. + description: List optimization jobs. Supports cursor pagination and optional status / agentName filters. parameters: - name: Foundry-Features in: header @@ -194,7 +104,7 @@ paths: schema: type: string enum: - - AgentsOptimization=V2Preview + - AgentsOptimization=V1Preview - name: limit in: query required: false @@ -242,7 +152,7 @@ paths: schema: $ref: '#/components/schemas/JobStatus' explode: false - - name: agent_name + - name: agentName in: query required: false description: Filter to jobs targeting this agent name. @@ -270,7 +180,7 @@ paths: data: type: array items: - $ref: '#/components/schemas/OptimizationJobListItem' + $ref: '#/components/schemas/OptimizationJob' description: The requested list of items. first_id: type: string @@ -282,14 +192,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -298,12 +202,12 @@ paths: - AgentOptimizationJobs x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V2Preview + - AgentsOptimization=V1Preview /agent_optimization_jobs/{jobId}: get: operationId: AgentOptimizationJobs_get summary: Get info about an agent optimization job. - description: Get an optimization job by id. + description: Get an optimization job by id. Returns 202 while in progress, 200 when terminal. parameters: - name: Foundry-Features in: header @@ -312,7 +216,7 @@ paths: schema: type: string enum: - - AgentsOptimization=V2Preview + - AgentsOptimization=V1Preview - name: jobId in: path required: true @@ -332,7 +236,6 @@ paths: headers: Retry-After: required: false - description: Recommended number of seconds to wait before polling again. schema: type: integer format: int32 @@ -340,14 +243,20 @@ paths: application/json: schema: $ref: '#/components/schemas/OptimizationJob' - 4XX: - description: Client error + '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 content: application/json: schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + $ref: '#/components/schemas/OptimizationJob' + default: + description: An unexpected error response. content: application/json: schema: @@ -356,7 +265,7 @@ paths: - AgentOptimizationJobs x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V2Preview + - AgentsOptimization=V1Preview delete: operationId: AgentOptimizationJobs_delete summary: Deletes an agent optimization job. @@ -369,13 +278,20 @@ paths: schema: type: string enum: - - AgentsOptimization=V2Preview + - AgentsOptimization=V1Preview - 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 @@ -386,14 +302,214 @@ paths: responses: '204': description: There is no content to send for this request, but the headers may be useful. - 4XX: - description: Client error + 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. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + 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: @@ -402,12 +518,180 @@ paths: - AgentOptimizationJobs x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V2Preview + - 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 of a running or queued job. Returns an error if the job is already in a terminal state. + description: Request cancellation. Idempotent on terminal states. parameters: - name: Foundry-Features in: header @@ -416,7 +700,7 @@ paths: schema: type: string enum: - - AgentsOptimization=V2Preview + - AgentsOptimization=V1Preview - name: jobId in: path required: true @@ -437,14 +721,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OptimizationJob' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -453,7 +731,7 @@ paths: - AgentOptimizationJobs x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V2Preview + - AgentsOptimization=V1Preview /agents: post: operationId: Agents_createAgent_Agents_createAgentFromCode @@ -485,12 +763,11 @@ paths: 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. + Creates the 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. @@ -498,20 +775,12 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. 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 @@ -531,8 +800,7 @@ paths: contentType: application/json get: operationId: Agents_listAgents - summary: List agents - description: Returns a paged collection of agent resources. + description: Returns the list of all agents. parameters: - name: kind in: query @@ -614,14 +882,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -631,8 +893,7 @@ paths: /agents/{agent_name}: get: operationId: Agents_getAgent - summary: Get an agent - description: Retrieves an agent definition by its unique name. + description: Retrieves the agent. parameters: - name: agent_name in: path @@ -654,14 +915,8 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -702,7 +957,6 @@ 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. @@ -710,20 +964,12 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. 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 @@ -743,7 +989,6 @@ 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 @@ -758,7 +1003,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. The service defaults to `false` if a value is not specified by the caller. 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. Defaults to `false`. This value is not relevant for other Agent types. schema: type: boolean default: false @@ -777,14 +1022,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteAgentResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -793,8 +1032,7 @@ paths: - Agents patch: operationId: Agents_patchAgentObject - summary: Update an agent endpoint - description: Applies a merge-patch update to the specified agent endpoint configuration. + description: Updates an agent endpoint. parameters: - name: Foundry-Features in: header @@ -810,7 +1048,6 @@ 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 @@ -825,14 +1062,8 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -851,9 +1082,8 @@ paths: /agents/{agent_name}/code:download: get: operationId: Agents_downloadAgentCode - summary: Download agent code description: |- - Downloads the code zip for a code-based hosted agent. + Download 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 @@ -908,15 +1138,10 @@ paths: content: application/zip: schema: - contentMediaType: application/zip - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + type: string + format: binary + default: + description: An unexpected error response. content: application/json: schema: @@ -929,7 +1154,6 @@ 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 @@ -983,14 +1207,8 @@ paths: content: '*/*': schema: {} - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -1009,7 +1227,6 @@ 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. @@ -1042,15 +1259,9 @@ paths: application/json: schema: type: object - unevaluatedProperties: {} - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + additionalProperties: {} + default: + description: An unexpected error response. content: application/json: schema: @@ -1063,7 +1274,6 @@ 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. @@ -1113,14 +1323,8 @@ paths: content: '*/*': schema: {} - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -1133,7 +1337,6 @@ 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. @@ -1183,14 +1386,8 @@ paths: content: '*/*': schema: {} - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -1209,7 +1406,6 @@ 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 @@ -1249,20 +1445,14 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentSessionResource' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Sessions + - Agents requestBody: required: true content: @@ -1274,8 +1464,7 @@ paths: - AgentEndpoints=V1Preview get: operationId: Agents_listSessions - summary: List sessions for an agent - description: Returns a paged collection of sessions associated with the specified agent endpoint. + description: Returns a list of sessions for the specified agent. parameters: - name: Foundry-Features in: header @@ -1370,30 +1559,23 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Sessions + - Agents 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. + List files and directories at a given path in the session sandbox. + Returns only the immediate children of the specified directory (non-recursive). parameters: - name: Foundry-Features in: header @@ -1417,8 +1599,8 @@ paths: 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. + required: true + description: The directory path to list, relative to the session home directory. schema: type: string explode: false @@ -1428,46 +1610,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: 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 @@ -1482,14 +1624,8 @@ paths: application/json: schema: $ref: '#/components/schemas/SessionDirectoryListResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -1501,10 +1637,9 @@ paths: - 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. + 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 @@ -1536,7 +1671,7 @@ paths: - 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. + description: Whether to recursively delete directory contents. Defaults to false. schema: type: boolean default: false @@ -1557,14 +1692,8 @@ paths: 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 + default: + description: An unexpected error response. content: application/json: schema: @@ -1577,10 +1706,9 @@ paths: /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. + 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 @@ -1629,14 +1757,8 @@ paths: application/json: schema: $ref: '#/components/schemas/SessionFileWriteResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -1648,16 +1770,14 @@ paths: content: application/octet-stream: schema: - contentMediaType: application/octet-stream + type: string + format: binary x-ms-foundry-meta: required_previews: - HostedAgents=V1Preview get: operationId: AgentSessionFiles_downloadSessionFile - 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. + description: Download a file from the session sandbox as a binary stream. parameters: - name: Foundry-Features in: header @@ -1705,15 +1825,10 @@ paths: content: application/octet-stream: schema: - contentMediaType: application/octet-stream - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + type: string + format: binary + default: + description: An unexpected error response. content: application/json: schema: @@ -1726,8 +1841,7 @@ paths: /agents/{agent_name}/endpoint/sessions/{session_id}: get: operationId: Agents_getSession - summary: Get a session - description: Retrieves the details of a hosted agent session by agent name and session identifier. + description: Retrieves a session by ID. parameters: - name: Foundry-Features in: header @@ -1769,26 +1883,19 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentSessionResource' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Sessions + - Agents 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. @@ -1829,28 +1936,23 @@ paths: 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 + default: + description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Sessions + - Agents x-ms-foundry-meta: required_previews: - AgentEndpoints=V1Preview /agents/{agent_name}/endpoint/sessions/{session_id}:stop: post: operationId: Agents_stopSession - summary: Stop a session - description: Terminates the specified hosted agent session and returns 204 No Content when the request succeeds. + description: |- + Stops a session. + Returns 204 No Content when the stop succeeds. parameters: - name: Foundry-Features in: header @@ -1882,27 +1984,20 @@ paths: 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 + default: + description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Sessions + - Agents 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. @@ -1927,14 +2022,8 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -1981,13 +2070,7 @@ paths: 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 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 + description: Create a new agent version. responses: '200': description: The request has succeeded. @@ -1995,25 +2078,17 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentVersionObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. 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: - - Agent Versions + - Agents requestBody: required: true content: @@ -2028,8 +2103,7 @@ paths: contentType: application/json get: operationId: Agents_listAgentVersions - summary: List agent versions - description: Returns a paged collection of versions for the specified agent. + description: Returns the list of versions of an agent. parameters: - name: agent_name in: path @@ -2110,25 +2184,18 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Versions + - Agents /agents/{agent_name}/versions/{agent_version}: get: operationId: Agents_getAgentVersion - summary: Get an agent version - description: Retrieves the specified version of an agent by its agent name and version identifier. + description: Retrieves a specific version of an agent. parameters: - name: agent_name in: path @@ -2156,23 +2223,16 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentVersionObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Versions + - Agents 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 @@ -2193,7 +2253,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. The service defaults to `false` if a value is not specified by the caller. 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. Defaults to `false`. This value is not relevant for other Agent types. schema: type: boolean default: false @@ -2212,24 +2272,17 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteAgentVersionResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Versions + - Agents /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. @@ -2298,28 +2351,21 @@ paths: text/event-stream: schema: $ref: '#/components/schemas/SessionLogEvent' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Sessions + - Agents x-ms-foundry-meta: required_previews: - HostedAgents=V1Preview /agents/{agent_name}/versions:import: post: operationId: Agents_createAgentVersionFromManifest - summary: Create an agent version from manifest - description: Imports the provided manifest to create a new version for the specified agent. + description: Create a new agent version from a manifest. parameters: - name: agent_name in: path @@ -2346,20 +2392,14 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentVersionObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Versions + - Agents requestBody: required: true content: @@ -2369,8 +2409,7 @@ paths: /agents:import: post: operationId: Agents_createAgentFromManifest - summary: Create an agent from a manifest - description: Imports the provided manifest to create an agent and returns the created resource. + description: Creates an agent from a manifest. parameters: - name: api-version in: query @@ -2386,14 +2425,8 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -2409,21 +2442,20 @@ paths: /connections: get: operationId: Connections_list - summary: List connections - description: Returns the connections available in the current project, optionally filtered by type or default status. + description: List all connections in the project, without populating connection credentials parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: connectionType in: query required: false - description: Lists connections of this specific type + description: List connections of this specific type schema: $ref: '#/components/schemas/ConnectionType' explode: false - name: defaultConnection in: query required: false - description: Lists connections that are default connections + description: List connections that are default connections schema: type: boolean explode: false @@ -2441,20 +2473,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedConnection' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -2470,61 +2490,7 @@ paths: /connections/{name}: get: operationId: Connections_get - 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 - in: path - required: true - description: The friendly name of the connection, provided by the user. - schema: - type: string - - $ref: '#/components/parameters/Azure.Core.ClientRequestIdHeader' - responses: - '200': - description: The request has succeeded. - headers: - x-ms-client-request-id: - required: false - description: An opaque, globally-unique, client-generated string identifier for the request. - schema: - $ref: '#/components/schemas/Azure.Core.uuid' - content: - application/json: - schema: - $ref: '#/components/schemas/Connection' - 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: - - Connections - /connections/{name}/getConnectionWithCredentials: - post: - operationId: Connections_getWithCredentials - summary: Get a connection with credentials - description: Retrieves the specified connection together with its credential values. + description: Get a connection by name, without populating connection credentials parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -2547,8 +2513,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Connection' - 4XX: - description: Client error + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -2559,8 +2525,36 @@ paths: application/json: schema: $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' - 5XX: - description: Server error + tags: + - Connections + /connections/{name}/getConnectionWithCredentials: + post: + operationId: Connections_getWithCredentials + description: Get a connection by name, with its connection credentials + parameters: + - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' + - name: name + in: path + required: true + description: The friendly name of the connection, provided by the user. + schema: + type: string + - $ref: '#/components/parameters/Azure.Core.ClientRequestIdHeader' + responses: + '200': + description: The request has succeeded. + headers: + x-ms-client-request-id: + required: false + description: An opaque, globally-unique, client-generated string identifier for the request. + schema: + $ref: '#/components/schemas/Azure.Core.uuid' + content: + application/json: + schema: + $ref: '#/components/schemas/Connection' + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -2576,7 +2570,7 @@ paths: /data_generation_jobs: get: operationId: DataGenerationJobs_list - summary: List data generation jobs + summary: Returns a list of data generation jobs description: Returns a list of data generation jobs. parameters: - name: Foundry-Features @@ -2660,14 +2654,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -2679,8 +2667,8 @@ paths: - DataGenerationJobs=V1Preview post: operationId: DataGenerationJobs_create - summary: Create a data generation job - description: Submits a new data generation job for asynchronous execution. + summary: Creates a data generation job. + description: Creates a data generation job. parameters: - name: Foundry-Features in: header @@ -2721,14 +2709,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DataGenerationJob' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -2748,8 +2730,8 @@ paths: /data_generation_jobs/{jobId}: get: operationId: DataGenerationJobs_get - summary: Get a data generation job - description: Retrieves the specified data generation job and its current status. + summary: Get info about a data generation job. + description: Gets the details of a data generation job by its ID. parameters: - name: Foundry-Features in: header @@ -2786,14 +2768,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DataGenerationJob' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -2805,8 +2781,8 @@ paths: - DataGenerationJobs=V1Preview delete: operationId: DataGenerationJobs_delete - summary: Delete a data generation job - description: Removes the specified data generation job and its associated output. + summary: Deletes a data generation job. + description: Deletes a data generation job by its ID. parameters: - name: Foundry-Features in: header @@ -2832,14 +2808,8 @@ paths: 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 + default: + description: An unexpected error response. content: application/json: schema: @@ -2852,8 +2822,8 @@ paths: /data_generation_jobs/{jobId}:cancel: post: operationId: DataGenerationJobs_cancel - summary: Cancel a data generation job - description: Cancels the specified data generation job if it is still in progress. + summary: Cancels a data generation job. + description: Cancels a data generation job by its ID. parameters: - name: Foundry-Features in: header @@ -2883,14 +2853,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DataGenerationJob' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -2903,7 +2867,6 @@ 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' @@ -2914,20 +2877,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedDatasetVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -2943,7 +2894,6 @@ 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' @@ -2960,20 +2910,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedDatasetVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -2989,7 +2927,6 @@ 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' @@ -3012,20 +2949,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DatasetVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -3040,7 +2965,6 @@ 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' @@ -3059,20 +2983,8 @@ paths: 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -3087,7 +2999,6 @@ 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' @@ -3116,20 +3027,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DatasetVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -3152,8 +3051,7 @@ paths: /datasets/{name}/versions/{version}/credentials: post: operationId: Datasets_getCredentials - summary: Get dataset credentials - description: Gets the SAS credential to access the storage account associated with a Dataset version. + description: Get the SAS credential to access the storage account associated with a Dataset version. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -3175,20 +3073,8 @@ paths: application/json: schema: $ref: '#/components/schemas/AssetCredentialResponse' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -3204,8 +3090,7 @@ paths: /datasets/{name}/versions/{version}/startPendingUpload: post: operationId: Datasets_startPendingUploadVersion - summary: Start a pending upload - description: Initiates a new pending upload or retrieves an existing one for the specified dataset version. + description: Start a new or get an existing pending upload of a dataset for a specific version. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -3227,20 +3112,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PendingUploadResponse' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -3263,8 +3136,7 @@ paths: /deployments: get: operationId: Deployments_list - summary: List deployments - description: Returns the deployed models available in the current project, optionally filtered by publisher, model name, or deployment type. + description: List all deployed models in the project parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: modelPublisher @@ -3302,20 +3174,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedDeployment' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -3331,8 +3191,7 @@ paths: /deployments/{name}: get: operationId: Deployments_get - summary: Get a deployment - description: Gets a deployed model. + description: Get a deployed model. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -3355,20 +3214,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Deployment' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -3384,8 +3231,7 @@ paths: /evaluationrules: get: operationId: EvaluationRules_list - summary: List evaluation rules - description: Returns the evaluation rules configured for the project, optionally filtered by action type, agent name, or enabled state. + description: List all evaluation rules. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: actionType @@ -3416,20 +3262,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedEvaluationRule' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -3445,8 +3279,7 @@ paths: /evaluationrules/{id}: get: operationId: EvaluationRules_get - summary: Get an evaluation rule - description: Retrieves the specified evaluation rule and its configuration. + description: Get an evaluation rule. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: id @@ -3462,20 +3295,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluationRule' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -3490,8 +3311,7 @@ paths: - Evaluation Rules delete: operationId: EvaluationRules_delete - summary: Delete an evaluation rule - description: Removes the specified evaluation rule from the project. + description: Delete an evaluation rule. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: id @@ -3503,20 +3323,8 @@ paths: 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -3531,8 +3339,7 @@ paths: - Evaluation Rules put: operationId: EvaluationRules_createOrUpdate - summary: Create or update an evaluation rule - description: Creates a new evaluation rule, or replaces the existing rule when the identifier matches. + description: Create or update an evaluation rule. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: id @@ -3562,20 +3369,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluationRule' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -3598,8 +3393,7 @@ paths: /evaluationtaxonomies: get: operationId: EvaluationTaxonomies_list - summary: List evaluation taxonomies - description: Returns the evaluation taxonomies available in the project, optionally filtered by input name or input type. + description: List evaluation taxonomies parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: inputName @@ -3631,20 +3425,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedEvaluationTaxonomy' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -3660,8 +3442,7 @@ paths: /evaluationtaxonomies/{name}: get: operationId: EvaluationTaxonomies_get - summary: Get an evaluation taxonomy - description: Retrieves the specified evaluation taxonomy. + description: Get an evaluation run by name. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -3685,20 +3466,8 @@ paths: 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -3713,8 +3482,7 @@ paths: - Evaluation Taxonomies delete: operationId: EvaluationTaxonomies_delete - summary: Delete an evaluation taxonomy - description: Removes the specified evaluation taxonomy from the project. + description: Delete an evaluation taxonomy by name. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -3734,20 +3502,8 @@ paths: 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -3762,8 +3518,7 @@ paths: - Evaluation Taxonomies put: operationId: EvaluationTaxonomies_create - summary: Create an evaluation taxonomy - description: Creates or replaces the specified evaluation taxonomy with the provided definition. + description: Create an evaluation taxonomy. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: Foundry-Features @@ -3793,20 +3548,8 @@ paths: 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -3828,7 +3571,6 @@ 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' @@ -3853,20 +3595,8 @@ paths: 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -3889,7 +3619,7 @@ paths: /evaluator_generation_jobs: post: operationId: EvaluatorGenerationJobs_create - summary: Create an evaluator generation job + summary: Creates an evaluator generation job. description: |- Creates an evaluator generation job. The service generates rubric-based evaluator definitions from the provided source materials asynchronously. @@ -3933,14 +3663,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluatorGenerationJob' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -3959,12 +3683,8 @@ paths: - Evaluations=V1Preview get: operationId: EvaluatorGenerationJobs_list - 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. + summary: Returns a list of evaluator generation jobs. + description: Returns a list of evaluator generation jobs. parameters: - name: Foundry-Features in: header @@ -4047,14 +3767,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -4067,7 +3781,7 @@ paths: /evaluator_generation_jobs/{jobId}: get: operationId: EvaluatorGenerationJobs_get - summary: Get an evaluator generation job + summary: Get info about an evaluator generation job. description: Gets the details of an evaluator generation job by its ID. parameters: - name: Foundry-Features @@ -4105,14 +3819,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluatorGenerationJob' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -4124,7 +3832,6 @@ 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. @@ -4153,14 +3860,8 @@ paths: 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 + default: + description: An unexpected error response. content: application/json: schema: @@ -4173,7 +3874,7 @@ paths: /evaluator_generation_jobs/{jobId}:cancel: post: operationId: EvaluatorGenerationJobs_cancel - summary: Cancel an evaluator generation job + summary: Cancels an evaluator generation job. description: Cancels an evaluator generation job by its ID. parameters: - name: Foundry-Features @@ -4204,14 +3905,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluatorGenerationJob' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -4224,8 +3919,7 @@ paths: /evaluators: get: operationId: Evaluators_listLatestVersions - summary: List latest evaluator versions - description: Lists the latest version of each evaluator + description: List the latest version of each evaluator parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: type @@ -4263,20 +3957,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedEvaluatorVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -4292,8 +3974,7 @@ paths: /evaluators/{name}/versions: get: operationId: Evaluators_listVersions - summary: List evaluator versions - description: Returns the available versions for the specified evaluator. + description: List all versions of the given evaluator parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -4337,20 +4018,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedEvaluatorVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -4365,8 +4034,7 @@ paths: - Evaluators post: operationId: Evaluators_createVersion - summary: Create an evaluator version - description: Creates a new evaluator version with an auto-incremented version identifier. + description: Create a new EvaluatorVersion with auto incremented version id parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -4390,20 +4058,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluatorVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -4425,8 +4081,7 @@ paths: /evaluators/{name}/versions/{version}: get: operationId: Evaluators_getVersion - summary: Get an evaluator version - description: Retrieves the specified evaluator version, returning 404 if it does not exist. + description: Get the specific version of the EvaluatorVersion. The service returns 404 Not Found error if the EvaluatorVersion does not exist. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -4456,20 +4111,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluatorVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -4484,8 +4127,7 @@ paths: - Evaluators delete: operationId: Evaluators_deleteVersion - summary: Delete an evaluator version - description: Removes the specified evaluator version. Returns 204 whether the version existed or not. + 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. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -4511,20 +4153,8 @@ paths: 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -4539,8 +4169,7 @@ paths: - Evaluators patch: operationId: Evaluators_updateVersion - summary: Update an evaluator version - description: Updates the specified evaluator version in place. + description: Update an existing EvaluatorVersion with the given version id parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -4570,20 +4199,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluatorVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -4606,8 +4223,7 @@ paths: /evaluators/{name}/versions/{version}/credentials: post: operationId: Evaluators_getCredentials - summary: Get evaluator credentials - description: Retrieves SAS credentials for accessing the storage account associated with the specified evaluator version. + description: Get the SAS credential to access the storage account associated with an Evaluator version. parameters: - name: Foundry-Features in: header @@ -4642,14 +4258,8 @@ paths: application/json: schema: $ref: '#/components/schemas/AssetCredentialResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -4669,8 +4279,7 @@ paths: /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. + description: Start a new or get an existing pending upload of an evaluator for a specific version. parameters: - name: Foundry-Features in: header @@ -4705,14 +4314,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PendingUploadResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -4732,7 +4335,6 @@ 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' @@ -4743,20 +4345,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedIndex' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -4772,7 +4362,6 @@ 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' @@ -4789,20 +4378,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedIndex' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -4818,7 +4395,6 @@ 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' @@ -4841,20 +4417,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Index' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -4869,7 +4433,6 @@ 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' @@ -4888,20 +4451,8 @@ paths: 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -4916,7 +4467,6 @@ 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' @@ -4945,20 +4495,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Index' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -4981,8 +4519,7 @@ paths: /insights: post: operationId: Insights_generate - summary: Generate insights - description: Generates an insights report from the provided evaluation configuration. + description: Generate Insights parameters: - name: Foundry-Features in: header @@ -5019,14 +4556,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Insight' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -5042,8 +4573,7 @@ paths: description: Complete evaluation configuration including data source, evaluators, and result settings get: operationId: Insights_list - summary: List insights - description: Returns insights in reverse chronological order, with the most recent entries first. + description: List all insights in reverse chronological order (newest first). parameters: - name: Foundry-Features in: header @@ -5102,14 +4632,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedInsight' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -5119,8 +4643,7 @@ paths: /insights/{id}: get: operationId: Insights_get - summary: Get an insight - description: Retrieves the specified insight report and its results. + description: Get a specific insight by Id. parameters: - name: Foundry-Features in: header @@ -5157,14 +4680,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Insight' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -5174,8 +4691,7 @@ paths: /memory_stores: post: operationId: createMemoryStore - summary: Create a memory store - description: Creates a memory store resource with the provided configuration. + description: Create a memory store. parameters: - name: Foundry-Features in: header @@ -5199,14 +4715,8 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryStoreObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -5230,7 +4740,7 @@ paths: description: A human-readable description of the memory store. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Arbitrary key-value metadata to associate with the memory store. definition: @@ -5245,8 +4755,7 @@ paths: - MemoryStores=V1Preview get: operationId: listMemoryStores - summary: List memory stores - description: Returns the memory stores available to the caller. + description: List all memory stores. parameters: - name: Foundry-Features in: header @@ -5329,14 +4838,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -5349,8 +4852,7 @@ paths: /memory_stores/{name}: post: operationId: updateMemoryStore - summary: Update a memory store - description: Updates the specified memory store with the supplied configuration changes. + description: Update a memory store. parameters: - name: Foundry-Features in: header @@ -5380,14 +4882,8 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryStoreObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -5407,7 +4903,7 @@ paths: description: A human-readable description of the memory store. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Arbitrary key-value metadata to associate with the memory store. x-ms-foundry-meta: @@ -5415,8 +4911,7 @@ paths: - MemoryStores=V1Preview get: operationId: getMemoryStore - summary: Get a memory store - description: Retrieves the specified memory store and its current configuration. + description: Retrieve a memory store. parameters: - name: Foundry-Features in: header @@ -5446,14 +4941,8 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryStoreObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -5465,8 +4954,7 @@ paths: - MemoryStores=V1Preview delete: operationId: deleteMemoryStore - summary: Delete a memory store - description: Deletes the specified memory store. + description: Delete a memory store. parameters: - name: Foundry-Features in: header @@ -5496,14 +4984,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteMemoryStoreResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -5516,8 +4998,7 @@ paths: /memory_stores/{name}/items: post: operationId: createMemory - summary: Create a memory item - description: Creates a memory item in the specified memory store. + description: Create a memory item in a memory store. parameters: - name: Foundry-Features in: header @@ -5547,14 +5028,8 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryItem' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -5588,8 +5063,7 @@ paths: /memory_stores/{name}/items/{memory_id}: post: operationId: updateMemory - summary: Update a memory item - description: Updates the specified memory item in the memory store. + description: Update a memory item in a memory store. parameters: - name: Foundry-Features in: header @@ -5625,14 +5099,8 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryItem' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -5656,8 +5124,7 @@ paths: - MemoryStores=V1Preview get: operationId: getMemory - summary: Get a memory item - description: Retrieves the specified memory item from the memory store. + description: Retrieve a memory item from a memory store. parameters: - name: Foundry-Features in: header @@ -5693,14 +5160,8 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryItem' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -5712,8 +5173,7 @@ paths: - MemoryStores=V1Preview delete: operationId: deleteMemory - summary: Delete a memory item - description: Deletes the specified memory item from the memory store. + description: Delete a memory item from a memory store. parameters: - name: Foundry-Features in: header @@ -5749,14 +5209,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteMemoryResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -5769,8 +5223,7 @@ paths: /memory_stores/{name}/items:list: post: operationId: listMemories - summary: List memory items - description: Returns memory items from the specified memory store. + description: List all memory items in a memory store. parameters: - name: Foundry-Features in: header @@ -5866,14 +5319,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -5898,8 +5345,7 @@ paths: /memory_stores/{name}/updates/{update_id}: get: operationId: getUpdateResult - summary: Get an update result - description: Retrieves the status and result of a memory store update operation. + description: Get memory store update result. parameters: - name: Foundry-Features in: header @@ -5935,14 +5381,8 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryStoreUpdateResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -5955,8 +5395,7 @@ paths: /memory_stores/{name}:delete_scope: post: operationId: deleteScopeMemories - summary: Delete memories by scope - description: Deletes all memories in the specified memory store that are associated with the provided scope. + description: Delete all memories associated with a specific scope from a memory store. parameters: - name: Foundry-Features in: header @@ -5986,14 +5425,8 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryStoreDeleteScopeResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -6018,8 +5451,7 @@ paths: /memory_stores/{name}:search_memories: post: operationId: searchMemories - summary: Search memories - description: Searches the specified memory store for memories relevant to the provided conversation context. + description: Search for relevant memories from a memory store based on conversation context. parameters: - name: Foundry-Features in: header @@ -6049,14 +5481,8 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryStoreSearchResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -6093,10 +5519,7 @@ paths: /memory_stores/{name}:update_memories: post: operationId: updateMemories - 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. + description: Update memory store with conversation memories. parameters: - name: Foundry-Features in: header @@ -6133,14 +5556,8 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryStoreUpdateResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -6182,7 +5599,6 @@ 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' @@ -6201,20 +5617,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedModelVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -6230,7 +5634,6 @@ 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' @@ -6255,20 +5658,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedModelVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -6284,8 +5675,7 @@ paths: /models/{name}/versions/{version}: get: operationId: Models_getVersion - summary: Get a model version - description: Retrieves the specified model version, returning 404 if it does not exist. + description: Get the specific version of the ModelVersion. The service returns 404 Not Found error if the ModelVersion does not exist. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -6315,20 +5705,8 @@ paths: application/json: schema: $ref: '#/components/schemas/ModelVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -6346,7 +5724,6 @@ 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' @@ -6373,20 +5750,8 @@ paths: responses: '200': description: The request has succeeded. - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -6404,7 +5769,6 @@ 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' @@ -6441,20 +5805,8 @@ paths: application/json: schema: $ref: '#/components/schemas/ModelVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -6480,8 +5832,7 @@ paths: /models/{name}/versions/{version}/createAsync: post: operationId: Models_createAsync - 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. + description: Creates a model version asynchronously with blob content validation. Returns 202 Accepted with a Location header for polling. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: Foundry-Features @@ -6524,25 +5875,12 @@ paths: format: uri description: URL to poll for operation status. operationResult: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true description: URL to the operation result, or null if the operation is still in progress. - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -6568,8 +5906,7 @@ paths: /models/{name}/versions/{version}/credentials: post: operationId: Models_getCredentials - summary: Get model asset credentials - description: Retrieves temporary credentials for accessing the storage backing the specified model version. + description: Get credentials for a model version asset. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: Foundry-Features @@ -6599,20 +5936,8 @@ paths: application/json: schema: $ref: '#/components/schemas/AssetCredentialResponse' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -6637,8 +5962,7 @@ paths: /models/{name}/versions/{version}/startPendingUpload: post: operationId: Models_startPendingUpload - summary: Start a pending upload - description: Initiates a new pending upload or retrieves an existing one for the specified model version. + description: Start or retrieve a pending upload for a model version. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: Foundry-Features @@ -6668,20 +5992,8 @@ paths: application/json: schema: $ref: '#/components/schemas/ModelPendingUploadResponse' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -6706,8 +6018,7 @@ paths: /openai/v1/conversations: post: operationId: createConversation - summary: Create a conversation - description: Creates a new conversation resource. + description: Create a conversation. parameters: - name: x-ms-user-isolation-key in: header @@ -6722,14 +6033,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ConversationResource' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -6744,8 +6049,7 @@ paths: $ref: '#/components/schemas/OpenAI.CreateConversationBody' get: operationId: listConversations - summary: List conversations - description: Returns the conversations available in the current project. + description: Returns the list of all conversations. parameters: - name: limit in: query @@ -6833,14 +6137,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -6850,8 +6148,7 @@ paths: /openai/v1/conversations/{conversation_id}: post: operationId: updateConversation - summary: Update a conversation - description: Modifies the specified conversation's properties. + description: Update a conversation. parameters: - name: conversation_id in: path @@ -6872,14 +6169,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ConversationResource' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -6894,8 +6185,7 @@ paths: $ref: '#/components/schemas/OpenAI.UpdateConversationBody' get: operationId: getConversation - summary: Retrieve a conversation - description: Retrieves the specified conversation and its metadata. + description: Retrieves a conversation. parameters: - name: conversation_id in: path @@ -6916,14 +6206,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ConversationResource' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -6932,8 +6216,7 @@ paths: - Conversations delete: operationId: deleteConversation - summary: Delete a conversation - description: Removes the specified conversation resource from the current project. + description: Deletes a conversation. parameters: - name: conversation_id in: path @@ -6954,14 +6237,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.DeletedConversationResource' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -6971,8 +6248,7 @@ paths: /openai/v1/conversations/{conversation_id}/items: post: operationId: createConversationItems - summary: Create conversation items - description: Adds one or more items to the specified conversation. + description: Create items in a conversation with the given ID. parameters: - name: conversation_id in: path @@ -7004,14 +6280,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ConversationItemList' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7035,8 +6305,7 @@ paths: - items get: operationId: listConversationItems - summary: List conversation items - description: Returns the items belonging to the specified conversation. + description: List all items for a conversation with the given ID. parameters: - name: conversation_id in: path @@ -7123,14 +6392,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7140,8 +6403,7 @@ paths: /openai/v1/conversations/{conversation_id}/items/{item_id}: get: operationId: getConversationItem - summary: Get a conversation item - description: Retrieves a specific item from the specified conversation. + description: Get a single item from a conversation with the given IDs. parameters: - name: conversation_id in: path @@ -7168,14 +6430,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.OutputItem' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7184,8 +6440,7 @@ paths: - Conversations delete: operationId: deleteConversationItem - summary: Delete a conversation item - description: Removes the specified item from a conversation. + description: Delete an item from a conversation with the given IDs. parameters: - name: conversation_id in: path @@ -7212,14 +6467,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ConversationResource' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7229,8 +6478,8 @@ paths: /openai/v1/evals: get: operationId: Evals_listEvals - summary: List evaluations - description: Returns the evaluations configured in the current project. + summary: List all evaluations + description: List evaluations for a project. parameters: - name: after in: query @@ -7244,7 +6493,8 @@ paths: required: false description: Number of runs to retrieve. schema: - $ref: '#/components/schemas/integer' + allOf: + - $ref: '#/components/schemas/integer' default: 20 explode: false - name: order @@ -7296,14 +6546,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7312,9 +6556,9 @@ paths: - Evals post: operationId: Evals_createEval - summary: Create an evaluation + summary: Create evaluation description: |- - Creates the structure of an evaluation that can be used to test a model's performance. + Create 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: [] @@ -7325,14 +6569,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Eval' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7349,7 +6587,7 @@ paths: delete: operationId: Evals_deleteEval summary: Delete an evaluation - description: Removes the specified evaluation and its associated data. + description: Delete an evaluation. parameters: - name: eval_id in: path @@ -7364,14 +6602,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteEvalResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7381,7 +6613,7 @@ paths: get: operationId: Evals_getEval summary: Get an evaluation - description: Retrieves the specified evaluation and its configuration. + description: Get an evaluation by ID. parameters: - name: eval_id in: path @@ -7396,14 +6628,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Eval' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7413,7 +6639,7 @@ paths: post: operationId: Evals_updateEval summary: Update an evaluation - description: Updates certain properties of an evaluation. + description: Update certain properties of an evaluation. parameters: - name: eval_id in: path @@ -7428,14 +6654,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Eval' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7451,8 +6671,8 @@ paths: /openai/v1/evals/{eval_id}/runs: get: operationId: Evals_listRuns - summary: List evaluation runs - description: Returns the runs associated with the specified evaluation. + summary: Get a list of runs for an evaluation + description: Get a list of runs for an evaluation. parameters: - name: eval_id in: path @@ -7472,7 +6692,8 @@ paths: required: false description: Number of runs to retrieve. schema: - $ref: '#/components/schemas/integer' + allOf: + - $ref: '#/components/schemas/integer' default: 20 explode: false - name: order @@ -7525,14 +6746,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7541,8 +6756,7 @@ paths: - Evals post: operationId: Evals_createEvalRun - summary: Create an evaluation run - description: Creates an evaluation run for the specified evaluation. + summary: Create evaluation run parameters: - name: eval_id in: path @@ -7557,14 +6771,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvalRun' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7580,8 +6788,8 @@ paths: /openai/v1/evals/{eval_id}/runs/{run_id}: delete: operationId: Evals_deleteEvalRun - summary: Delete an evaluation run - description: Removes the specified evaluation run. + summary: Delete evaluation run + description: Delete an eval run. parameters: - name: eval_id in: path @@ -7602,14 +6810,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteEvalRunResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7619,7 +6821,7 @@ paths: get: operationId: Evals_getEvalRun summary: Get an evaluation run - description: Retrieves the specified evaluation run and its current status. + description: Get an evaluation run by ID. parameters: - name: eval_id in: path @@ -7640,14 +6842,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvalRun' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7656,8 +6852,8 @@ paths: - Evals post: operationId: Evals_cancelEvalRun - summary: Cancel an evaluation run - description: Cancels an ongoing evaluation run. + summary: Cancel evaluation run + description: Cancel an ongoing evaluation run. parameters: - name: eval_id in: path @@ -7678,14 +6874,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvalRun' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7695,8 +6885,8 @@ paths: /openai/v1/evals/{eval_id}/runs/{run_id}/output_items: get: operationId: Evals_getEvalRunOutputItems - summary: List evaluation run output items - description: Returns the output items produced by the specified evaluation run. + summary: Get evaluation run output items + description: Get a list of output items for an evaluation run. parameters: - name: eval_id in: path @@ -7721,7 +6911,8 @@ paths: required: false description: Number of runs to retrieve. schema: - $ref: '#/components/schemas/integer' + allOf: + - $ref: '#/components/schemas/integer' default: 20 explode: false - name: order @@ -7772,14 +6963,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7790,7 +6975,7 @@ paths: get: operationId: Evals_getEvalRunOutputItem summary: Get an output item of an evaluation run - description: Retrieves a single output item from the specified evaluation run. + description: Get an evaluation run output item by ID. parameters: - name: eval_id in: path @@ -7817,14 +7002,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvalRunOutputItem' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7834,7 +7013,6 @@ 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. @@ -7856,14 +7034,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.FineTuningJob' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7878,8 +7050,7 @@ paths: $ref: '#/components/schemas/OpenAI.CreateFineTuningJobRequest' get: operationId: listPaginatedFineTuningJobs - summary: List fine-tuning jobs - description: Returns the fine-tuning jobs for the current organization. + description: List your organization's fine-tuning jobs parameters: - name: after in: query @@ -7911,14 +7082,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ListPaginatedFineTuningJobsResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7928,9 +7093,8 @@ paths: /openai/v1/fine_tuning/jobs/{fine_tuning_job_id}: get: operationId: retrieveFineTuningJob - summary: Get a fine-tuning job description: |- - Gets info about a fine-tuning job. + Get info about a fine-tuning job. [Learn more about fine-tuning](https://platform.openai.com/docs/guides/fine-tuning) parameters: @@ -7954,14 +7118,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.FineTuningJob' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7971,8 +7129,7 @@ paths: /openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel: post: operationId: cancelFineTuningJob - summary: Cancel a fine-tuning job - description: Immediately cancels the specified fine-tuning job. + description: Immediately cancel a fine-tune job. parameters: - name: fine_tuning_job_id in: path @@ -7994,14 +7151,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.FineTuningJob' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -8011,8 +7162,7 @@ paths: /openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints: get: operationId: listFineTuningJobCheckpoints - summary: List fine-tuning job checkpoints - description: Returns the checkpoints saved during the specified fine-tuning job. + description: List checkpoints for a fine-tuning job. parameters: - name: fine_tuning_job_id in: path @@ -8050,14 +7200,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ListFineTuningJobCheckpointsResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -8067,8 +7211,7 @@ paths: /openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events: get: operationId: listFineTuningJobEvents - summary: List fine-tuning job events - description: Returns the status events emitted during the specified fine-tuning job. + description: Get fine-grained status updates for a fine-tuning job. parameters: - name: fine_tuning_job_id in: path @@ -8106,14 +7249,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ListFineTuningJobEventsResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -8123,8 +7260,7 @@ paths: /openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause: post: operationId: pauseFineTuningJob - summary: Pause a fine-tuning job - description: Pauses the specified fine-tuning job while it is running. + description: Pause a running fine-tune job. parameters: - name: fine_tuning_job_id in: path @@ -8146,14 +7282,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.FineTuningJob' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -8163,8 +7293,7 @@ paths: /openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume: post: operationId: resumeFineTuningJob - summary: Resume a fine-tuning job - description: Resumes the specified fine-tuning job after it has been paused. + description: Resume a paused fine-tune job. parameters: - name: fine_tuning_job_id in: path @@ -8186,14 +7315,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.FineTuningJob' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -8202,9 +7325,7 @@ paths: - Fine-Tuning /openai/v1/responses: post: - 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. + operationId: createResponse_createResponseStream parameters: - name: x-ms-user-isolation-key in: header @@ -8212,6 +7333,7 @@ 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. @@ -8224,200 +7346,12 @@ paths: content: application/json: schema: - 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 + $ref: '#/components/schemas/OpenAI.Response' text/event-stream: schema: $ref: '#/components/schemas/OpenAI.CreateResponseStreamingResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -8429,149 +7363,274 @@ paths: content: application/json: schema: - 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 + 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 + - 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 + 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 - - type: 'null' - default: disabled - input: - $ref: '#/components/schemas/OpenAI.InputParam' - include: - anyOf: - - type: array + nullable: true + default: disabled + input: + $ref: '#/components/schemas/OpenAI.InputParam' + include: + type: array items: $ref: '#/components/schemas/OpenAI.IncludeEnum' - - 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 + 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' - - 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. + 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 + 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. get: operationId: listResponses - summary: List responses - description: Returns a collection of all stored responses matching specified filter criteria. + description: Returns the list of all responses. parameters: - name: limit in: query @@ -8666,14 +7725,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -8683,8 +7736,7 @@ paths: /openai/v1/responses/compact: post: operationId: compactResponseConversation - summary: Compact a conversation - description: Compacts a conversation into a response object suitable for long-running and zero-data-retention scenarios. + description: Produces a compaction of a responses conversation. parameters: [] responses: '200': @@ -8693,14 +7745,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.CompactResource' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -8715,9 +7761,7 @@ paths: $ref: '#/components/schemas/OpenAI.CompactResponseMethodPublicBody' /openai/v1/responses/{response_id}: get: - operationId: getResponse - summary: Retrieve a model response - description: Retrieves a model response with the given ID. + operationId: getResponse_getResponseStream parameters: - name: response_id in: path @@ -8752,6 +7796,14 @@ 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. @@ -8768,14 +7820,8 @@ paths: text/event-stream: schema: $ref: '#/components/schemas/OpenAI.CreateResponseStreamingResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -8784,7 +7830,6 @@ paths: - Responses delete: operationId: deleteResponse - summary: Delete a model response description: Deletes a model response. parameters: - name: response_id @@ -8812,14 +7857,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteResponseResult' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -8829,8 +7868,7 @@ paths: /openai/v1/responses/{response_id}/cancel: post: operationId: cancelResponse - 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. + description: Cancels a model response. parameters: - name: response_id in: path @@ -8857,14 +7895,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.Response' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -8874,8 +7906,7 @@ paths: /openai/v1/responses/{response_id}/input_items: get: operationId: listInputItems - summary: List input items for a response - description: Retrieves the input items associated with the specified response. + description: Returns a list of input items for a given response. parameters: - name: response_id in: path @@ -8960,14 +7991,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -8977,8 +8002,7 @@ paths: /redTeams/runs: get: operationId: RedTeams_list - summary: List redteams - description: Returns the redteams available in the current project. + description: List a redteam by name. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: Foundry-Features @@ -8996,20 +8020,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedRedTeam' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -9025,8 +8037,7 @@ paths: /redTeams/runs/{name}: get: operationId: RedTeams_get - summary: Get a redteam - description: Retrieves the specified redteam and its configuration. + description: Get a redteam by name. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -9050,20 +8061,8 @@ paths: application/json: schema: $ref: '#/components/schemas/RedTeam' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -9079,8 +8078,7 @@ paths: /redTeams/runs:run: post: operationId: RedTeams_create - summary: Create a redteam run - description: Submits a new redteam run for execution with the provided configuration. + description: Creates a redteam run. parameters: - name: Foundry-Features in: header @@ -9104,14 +8102,8 @@ paths: application/json: schema: $ref: '#/components/schemas/RedTeam' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -9128,8 +8120,7 @@ paths: /routines: get: operationId: listRoutines - summary: List routines - description: Returns the routines available in the current project. + description: List routines. parameters: - name: Foundry-Features in: header @@ -9139,10 +8130,46 @@ paths: type: string enum: - Routines=V1Preview - - $ref: '#/components/parameters/ListRoutinesParameters.limit' - - $ref: '#/components/parameters/ListRoutinesParameters.after' - - $ref: '#/components/parameters/ListRoutinesParameters.before' - - $ref: '#/components/parameters/ListRoutinesParameters.order' + - 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 @@ -9176,14 +8203,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -9196,8 +8217,7 @@ paths: /routines/{routine_name}: put: operationId: createOrUpdateRoutine - summary: Create or update a routine - description: Creates a new routine or replaces an existing routine with the supplied definition. + description: Create or update a routine. parameters: - name: Foundry-Features in: header @@ -9222,14 +8242,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Routine' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -9247,8 +8261,7 @@ paths: - Routines=V1Preview get: operationId: getRoutine - summary: Get a routine - description: Retrieves the specified routine and its current configuration. + description: Retrieve a routine. parameters: - name: Foundry-Features in: header @@ -9273,14 +8286,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Routine' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -9292,8 +8299,7 @@ paths: - Routines=V1Preview delete: operationId: deleteRoutine - summary: Delete a routine - description: Deletes the specified routine. + description: Delete a routine. parameters: - name: Foundry-Features in: header @@ -9314,14 +8320,8 @@ paths: 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 + default: + description: An unexpected error response. content: application/json: schema: @@ -9334,8 +8334,7 @@ paths: /routines/{routine_name}/runs: get: operationId: listRoutineRuns - summary: List prior runs for a routine - description: Returns prior runs recorded for the specified routine. + description: List prior runs for a routine. parameters: - name: Foundry-Features in: header @@ -9347,10 +8346,46 @@ paths: - Routines=V1Preview - $ref: '#/components/parameters/ListRoutineRunsParameters.routine_name' - $ref: '#/components/parameters/ListRoutineRunsParameters.filter' - - $ref: '#/components/parameters/ListRoutineRunsParameters.limit' - - $ref: '#/components/parameters/ListRoutineRunsParameters.after' - - $ref: '#/components/parameters/ListRoutineRunsParameters.before' - - $ref: '#/components/parameters/ListRoutineRunsParameters.order' + - 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 @@ -9384,14 +8419,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -9404,8 +8433,7 @@ paths: /routines/{routine_name}:disable: post: operationId: disableRoutine - summary: Disable a routine - description: Disables the specified routine so it no longer runs. + description: Disable a routine. parameters: - name: Foundry-Features in: header @@ -9430,14 +8458,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Routine' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -9450,8 +8472,7 @@ paths: /routines/{routine_name}:dispatch_async: post: operationId: dispatchRoutineAsync - summary: Queue an asynchronous routine dispatch - description: Queues an asynchronous dispatch for the specified routine. + description: Queue an asynchronous routine dispatch. parameters: - name: Foundry-Features in: header @@ -9476,14 +8497,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DispatchRoutineResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -9502,8 +8517,7 @@ paths: /routines/{routine_name}:enable: post: operationId: enableRoutine - summary: Enable a routine - description: Enables the specified routine so it can be dispatched. + description: Enable a routine. parameters: - name: Foundry-Features in: header @@ -9528,14 +8542,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Routine' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -9548,8 +8556,7 @@ paths: /schedules: get: operationId: Schedules_list - summary: List schedules - description: Returns schedules that match the supplied type and enabled filters. + description: List all schedules. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: type @@ -9581,20 +8588,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedSchedule' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -9610,8 +8605,7 @@ paths: /schedules/{id}: delete: operationId: Schedules_delete - summary: Delete a schedule - description: Deletes the specified schedule resource. + description: Delete a schedule. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: id @@ -9631,20 +8625,8 @@ paths: 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -9659,8 +8641,7 @@ paths: - Schedules get: operationId: Schedules_get - summary: Get a schedule - description: Retrieves the specified schedule resource. + description: Get a schedule by id. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: id @@ -9684,20 +8665,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Schedule' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -9712,8 +8681,7 @@ paths: - Schedules put: operationId: Schedules_createOrUpdate - summary: Create or update a schedule - description: Creates a new schedule or updates an existing schedule with the supplied definition. + description: Create or update operation template. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: id @@ -9743,20 +8711,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Schedule' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -9779,8 +8735,7 @@ paths: /schedules/{id}/runs: get: operationId: Schedules_listRuns - summary: List schedule runs - description: Returns schedule runs that match the supplied filters. + description: List all schedule runs. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: id @@ -9818,20 +8773,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedScheduleRun' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -9847,8 +8790,7 @@ paths: /schedules/{schedule_id}/runs/{run_id}: get: operationId: Schedules_getRun - summary: Get a schedule run - description: Retrieves the specified run for a schedule. + description: Get a schedule run by id. parameters: - name: schedule_id in: path @@ -9884,14 +8826,8 @@ paths: application/json: schema: $ref: '#/components/schemas/ScheduleRun' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -9901,8 +8837,7 @@ paths: /skills: get: operationId: Skills_listSkills - summary: List skills - description: Returns the skills available in the current project. + description: Returns the list of all skills. parameters: - name: limit in: query @@ -9985,14 +8920,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -10005,8 +8934,7 @@ paths: /skills/{name}: get: operationId: Skills_getSkill - summary: Retrieve a skill - description: Retrieves the specified skill and its current configuration. + description: Retrieves a skill. parameters: - name: name in: path @@ -10036,14 +8964,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Skill' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -10055,8 +8977,7 @@ paths: - Skills=V1Preview post: operationId: updateSkill - summary: Update a skill - description: Modifies the specified skill's configuration. + description: Update a skill. parameters: - name: name in: path @@ -10086,14 +9007,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Skill' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -10117,8 +9032,7 @@ paths: - Skills=V1Preview delete: operationId: Skills_deleteSkill - summary: Delete a skill - description: Removes the specified skill and its associated versions. + description: Deletes a skill. parameters: - name: name in: path @@ -10148,14 +9062,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteSkillResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -10168,8 +9076,7 @@ paths: /skills/{name}/content: get: operationId: getSkillContent - summary: Download the zip content for the default version of a skill - description: Downloads the zip content for the default version of a skill. + description: Download the zip content for the default version of a skill. parameters: - name: name in: path @@ -10198,15 +9105,10 @@ paths: content: application/zip: schema: - contentMediaType: application/zip - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + type: string + format: binary + default: + description: An unexpected error response. content: application/json: schema: @@ -10242,7 +9144,6 @@ 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. @@ -10250,20 +9151,12 @@ paths: application/json: schema: $ref: '#/components/schemas/SkillVersion' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. 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 @@ -10293,8 +9186,7 @@ paths: contentType: text/plain get: operationId: listSkillVersions - summary: List skill versions - description: Returns the available versions for the specified skill. + description: List all versions of a skill. parameters: - name: name in: path @@ -10383,14 +9275,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -10403,8 +9289,7 @@ paths: /skills/{name}/versions/{version}: get: operationId: getSkillVersion - summary: Retrieve a specific version of a skill - description: Retrieves the specified version of a skill by name and version identifier. + description: Retrieve a specific version of a skill. parameters: - name: name in: path @@ -10440,14 +9325,8 @@ paths: application/json: schema: $ref: '#/components/schemas/SkillVersion' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -10459,8 +9338,7 @@ paths: - Skills=V1Preview delete: operationId: deleteSkillVersion - summary: Delete a specific version of a skill - description: Removes the specified version of a skill. + description: Delete a specific version of a skill. parameters: - name: name in: path @@ -10496,14 +9374,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteSkillVersionResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -10516,8 +9388,7 @@ paths: /skills/{name}/versions/{version}/content: get: operationId: getSkillVersionContent - summary: Download the zip content for a specific version of a skill - description: Downloads the zip content for a specific version of a skill. + description: Download the zip content for a specific version of a skill. parameters: - name: name in: path @@ -10552,15 +9423,10 @@ paths: content: application/zip: schema: - contentMediaType: application/zip - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + type: string + format: binary + default: + description: An unexpected error response. content: application/json: schema: @@ -10573,8 +9439,7 @@ paths: /toolboxes: get: operationId: listToolboxes - summary: List toolboxes - description: Returns the toolboxes available in the current project. + description: List all toolboxes. parameters: - name: limit in: query @@ -10616,14 +9481,6 @@ 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 @@ -10657,28 +9514,18 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - Toolboxes - x-ms-foundry-meta: - conditional_previews: - - Toolboxes=V1Preview /toolboxes/{name}: get: operationId: getToolbox - summary: Retrieve a toolbox - description: Retrieves the specified toolbox and its current configuration. + description: Retrieve a toolbox. parameters: - name: name in: path @@ -10686,14 +9533,6 @@ 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 @@ -10708,37 +9547,19 @@ paths: application/json: schema: $ref: '#/components/schemas/ToolboxObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - Toolboxes - x-ms-foundry-meta: - conditional_previews: - - Toolboxes=V1Preview patch: operationId: updateToolbox - summary: Update a toolbox to point to a specific version - description: Updates the toolbox's default version pointer to the specified version. + description: Update a toolbox to point to a specific 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 @@ -10753,14 +9574,8 @@ paths: application/json: schema: $ref: '#/components/schemas/ToolboxObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -10773,13 +9588,9 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateToolboxRequest' - x-ms-foundry-meta: - conditional_previews: - - Toolboxes=V1Preview delete: operationId: deleteToolbox - summary: Delete a toolbox - description: Removes the specified toolbox along with all of its versions. + description: Delete a toolbox and all its versions. parameters: - name: name in: path @@ -10787,14 +9598,6 @@ 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 @@ -10805,28 +9608,18 @@ paths: 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 + default: + description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - Toolboxes - x-ms-foundry-meta: - conditional_previews: - - Toolboxes=V1Preview /toolboxes/{name}/versions: post: operationId: createToolboxVersion - summary: Create a new version of a toolbox - description: Creates a new toolbox version, provisioning the toolbox itself if it does not already exist. + description: Create a new version of a toolbox. If the toolbox does not exist, it will be created. parameters: - name: name in: path @@ -10835,14 +9628,6 @@ 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 @@ -10857,14 +9642,8 @@ paths: application/json: schema: $ref: '#/components/schemas/ToolboxVersionObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -10884,7 +9663,7 @@ paths: description: A human-readable description of the toolbox. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Arbitrary key-value metadata to associate with the toolbox. tools: @@ -10903,13 +9682,9 @@ paths: description: Policy configuration for this toolbox version. required: - tools - x-ms-foundry-meta: - conditional_previews: - - Toolboxes=V1Preview get: operationId: listToolboxVersions - summary: List toolbox versions - description: Returns the available versions for the specified toolbox. + description: List all versions of a toolbox. parameters: - name: name in: path @@ -10957,14 +9732,6 @@ 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 @@ -10998,28 +9765,18 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. 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 - summary: Retrieve a specific version of a toolbox - description: Retrieves the specified version of a toolbox by name and version identifier. + description: Retrieve a specific version of a toolbox. parameters: - name: name in: path @@ -11033,14 +9790,6 @@ 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 @@ -11055,27 +9804,17 @@ paths: application/json: schema: $ref: '#/components/schemas/ToolboxVersionObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - Toolboxes - x-ms-foundry-meta: - conditional_previews: - - Toolboxes=V1Preview delete: operationId: deleteToolboxVersion - summary: Delete a specific version of a toolbox - description: Removes the specified version of a toolbox. + description: Delete a specific version of a toolbox. parameters: - name: name in: path @@ -11089,14 +9828,6 @@ 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 @@ -11107,23 +9838,14 @@ paths: 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 + default: + description: An unexpected error response. 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 @@ -11193,22 +9915,6 @@ 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 @@ -11217,23 +9923,6 @@ 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 @@ -11242,39 +9931,6 @@ 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 @@ -11774,6 +10430,18 @@ 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: @@ -11870,7 +10538,6 @@ components: enum: - activity_protocol - responses - - a2a - mcp - invocations - invocations_ws @@ -11941,6 +10608,7 @@ components: - idle - updating - failed + - stopping - deleting - deleted - expired @@ -12004,11 +10672,10 @@ components: - definition properties: metadata: - anyOf: - - type: object - unevaluatedProperties: - type: string - - type: 'null' + type: object + additionalProperties: + type: string + 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 @@ -12889,7 +11556,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 - unevaluatedProperties: {} + additionalProperties: {} description: The parameters the functions accepts, described as a JSON Schema object. required: - name @@ -13393,6 +12060,116 @@ 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: @@ -13470,7 +12247,7 @@ components: description: List of clusters identified in the insights. coordinates: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ChartCoordinate' description: |2- Optional mapping of IDs to 2D coordinates used by the UX for visualization. @@ -13665,7 +12442,7 @@ components: readOnly: true metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Metadata of the connection readOnly: true @@ -13694,8 +12471,7 @@ components: image: type: string description: The container image for the hosted agent. - examples: - - my-registry.azurecr.io/my-hosted-agent:latest + example: my-registry.azurecr.io/my-hosted-agent:latest description: Container-based deployment configuration for a hosted agent. x-ms-foundry-meta: required_previews: @@ -13738,13 +12514,6 @@ 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. @@ -13774,7 +12543,7 @@ components: default: 5 data_mapping: type: object - unevaluatedProperties: + additionalProperties: type: string description: Mapping from source fields to response_id field, which is required for retrieving chat history. sampling_params: @@ -13837,6 +12606,8 @@ 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 @@ -13858,7 +12629,7 @@ components: - Must not exceed 63 characters. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -13877,7 +12648,7 @@ components: description: The manifest ID to import the agent version from. parameter_values: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The inputs to the manifest that will result in a fully materialized Agent. CreateAgentRequest: type: object @@ -13895,7 +12666,7 @@ components: - Must not exceed 63 characters. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -13970,6 +12741,8 @@ 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 @@ -13985,7 +12758,7 @@ components: description: A human-readable description of the agent. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -14015,7 +12788,7 @@ components: properties: metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -14034,7 +12807,7 @@ components: description: The manifest ID to import the agent version from. parameter_values: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The inputs to the manifest that will result in a fully materialized Agent. CreateAgentVersionRequest: type: object @@ -14043,7 +12816,7 @@ components: properties: metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -14090,9 +12863,10 @@ components: type: string description: The name of the evaluation. metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true data_source_config: oneOf: - $ref: '#/components/schemas/OpenAI.CreateEvalCustomDataSourceConfig' @@ -14114,7 +12888,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 - unevaluatedProperties: + additionalProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -14129,9 +12903,10 @@ components: type: string description: The name of the run. metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true data_source: oneOf: - $ref: '#/components/schemas/OpenAI.CreateEvalJsonlRunDataSource' @@ -14141,7 +12916,7 @@ components: description: Details about the run's data source. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -14157,7 +12932,9 @@ components: properties: files: type: array - items: {} + items: + type: string + format: binary description: Skill files to upload. Upload a single zip file or multiple individual files with relative paths. default: type: boolean @@ -14213,41 +12990,11 @@ components: - CustomKeys description: The credential type readOnly: true - unevaluatedProperties: + additionalProperties: 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: @@ -14395,7 +13142,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 - unevaluatedProperties: + additionalProperties: 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. @@ -14517,12 +13264,11 @@ components: description: The data source type discriminator. schema: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The overall object JSON schema for the run data source items. discriminator: propertyName: type - mapping: - azure_ai_source: '#/components/schemas/AzureAIDataSourceConfig' + mapping: {} description: Base class for run data sources with discriminator support. DatasetDataGenerationJobOutput: type: object @@ -14552,7 +13298,7 @@ components: readOnly: true tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary of the output dataset. readOnly: true @@ -14582,6 +13328,38 @@ 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: @@ -14659,7 +13437,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. discriminator: @@ -14907,7 +13685,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. The service defaults to `false` if a value is not specified by the caller. + 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`. default: false description: A single dimension — one independent, measurable quality dimension within a rubric evaluator's scoring blueprint. DispatchRoutineRequest: @@ -15031,9 +13809,10 @@ components: format: unixtime description: The Unix timestamp (in seconds) for when the eval was created. metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true modified_at: allOf: - $ref: '#/components/schemas/integer' @@ -15043,7 +13822,7 @@ components: description: the name of the person who created the run. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -15214,9 +13993,10 @@ components: - $ref: '#/components/schemas/EvalRunDataSource' description: Information about the run's data source. metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true error: $ref: '#/components/schemas/OpenAI.EvalApiError' modified_at: @@ -15228,7 +14008,7 @@ components: description: the name of the person who created the run. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -15487,7 +14267,7 @@ components: description: The identifier for the data source item. datasource_item: type: object - unevaluatedProperties: {} + additionalProperties: {} description: Details of the input data source item. results: type: array @@ -15577,10 +14357,9 @@ components: type: boolean description: Whether the grader considered the output a pass. sample: - anyOf: - - type: object - unevaluatedProperties: {} - - type: 'null' + type: object + additionalProperties: {} + nullable: true description: Optional sample or intermediate data produced by the grader. status: allOf: @@ -15601,10 +14380,10 @@ components: description: The reason for the test criteria metric. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Additional details about the test criteria metric. - unevaluatedProperties: {} + additionalProperties: {} description: A single grader result for an evaluation run output item. title: EvalRunOutputItemResult EvalRunOutputItemResultStatus: @@ -15844,7 +14623,7 @@ components: description: Indicates whether the evaluation rule is enabled. Default is true. systemData: type: object - unevaluatedProperties: + additionalProperties: type: string description: System metadata for the evaluation rule. readOnly: true @@ -15948,7 +14727,6 @@ components: description: Identifier of the evaluation group. evalRun: type: object - unevaluatedProperties: {} description: The evaluation run payload. allOf: - $ref: '#/components/schemas/ScheduleTask' @@ -15983,7 +14761,7 @@ components: description: List of taxonomy categories. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Additional properties for the evaluation taxonomy. description: Evaluation Taxonomy Definition @@ -15997,7 +14775,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. taxonomyInput: @@ -16011,7 +14789,7 @@ components: description: List of taxonomy categories. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Additional properties for the evaluation taxonomy. description: Evaluation Taxonomy Definition @@ -16059,7 +14837,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. taxonomyInput: @@ -16073,7 +14851,7 @@ components: description: List of taxonomy categories. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Additional properties for the evaluation taxonomy. description: Evaluation Taxonomy Definition @@ -16110,15 +14888,15 @@ components: description: The type of evaluator definition init_parameters: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The JSON schema (Draft 2020-12) for the evaluator's input parameters. This includes parameters like type, properties, required. data_schema: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The JSON schema (Draft 2020-12) for the evaluator's input data. This includes parameters like type, properties, required. metrics: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/EvaluatorMetric' description: List of output metrics produced by this evaluator discriminator: @@ -16355,7 +15133,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 - unevaluatedProperties: + additionalProperties: type: string description: Metadata about the evaluator evaluator_type: @@ -16367,13 +15145,6 @@ 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' @@ -16420,7 +15191,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 - unevaluatedProperties: + additionalProperties: type: string description: Metadata about the evaluator evaluator_type: @@ -16432,13 +15203,6 @@ 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' @@ -16448,7 +15212,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Evaluator Definition @@ -16460,7 +15224,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 - unevaluatedProperties: + additionalProperties: type: string description: Metadata about the evaluator categories: @@ -16468,19 +15232,12 @@ 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 - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Evaluator Definition @@ -16595,9 +15352,12 @@ 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: - - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' + - type: object + allOf: + - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' + nullable: true - type: string - - type: 'null' + nullable: true description: (Optional) Whether the agent requires approval before executing actions. Default is always. default: always name: @@ -16631,9 +15391,12 @@ 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: - - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' + - type: object + allOf: + - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' + nullable: true - type: string - - type: 'null' + nullable: true description: (Optional) Whether the agent requires approval before executing actions. Default is always. default: always allOf: @@ -16723,9 +15486,9 @@ components: - $ref: '#/components/schemas/OpenAI.RankingOptions' description: Ranking options for search. filters: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.Filters' - - type: 'null' + nullable: true vector_store_ids: type: array items: @@ -16861,50 +15624,34 @@ 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. - 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: + GitHubIssueOpenedRoutineTrigger: type: object required: - type - connection_id - - owner + - assignee - repository - - issue_event properties: type: type: string enum: - - github_issue + - github_issue_opened description: The trigger type. connection_id: type: string maxLength: 256 description: The workspace connection identifier that resolves the GitHub configuration for the trigger. - owner: + assignee: type: string maxLength: 128 - description: The GitHub owner or organization that scopes which issues can fire the trigger. + description: The GitHub assignee or organization filter 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 routine trigger. + description: A GitHub issue-opened routine trigger. x-ms-foundry-meta: conditional_previews: - Routines=V1Preview @@ -16938,18 +15685,15 @@ components: header_name: type: string description: The name of the HTTP header to inject the secret value into. - examples: - - X-Otlp-Api-Key + example: X-Otlp-Api-Key secret_id: type: string description: The identifier of the secret store or connection. - examples: - - my-secret-store + example: my-secret-store secret_key: type: string description: The key within the secret to retrieve the authentication value. - examples: - - OTLP_KEY + example: 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. @@ -16977,21 +15721,19 @@ components: cpu: type: string description: The CPU configuration for the hosted agent. - examples: - - '0.25' + example: '0.25' memory: type: string description: The memory configuration for the hosted agent. - examples: - - 0.5Gi + example: 0.5Gi environment_variables: type: object - unevaluatedProperties: + additionalProperties: type: string description: Environment variables to set in the hosted agent container. - examples: - - name: LOG_LEVEL - value: debug + example: + name: LOG_LEVEL + value: debug container_configuration: allOf: - $ref: '#/components/schemas/ContainerConfiguration' @@ -17004,11 +15746,11 @@ components: items: $ref: '#/components/schemas/ProtocolVersionRecord' description: The protocols that the agent supports for ingress communication. - examples: - - - protocol: responses - version: v0.1.1 - - protocol: a2a - version: v0.3.0 + example: + - protocol: responses + version: v0.1.1 + - protocol: a2a + version: v0.3.0 x-ms-foundry-meta: required_previews: - CodeAgents=V1Preview @@ -17110,7 +15852,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. discriminator: @@ -17254,11 +15996,11 @@ components: description: Sample type features: type: object - unevaluatedProperties: {} + additionalProperties: {} description: Features to help with additional filtering of data in UX. correlationInfo: type: object - unevaluatedProperties: {} + additionalProperties: {} description: Info about the correlation for the analysis sample. discriminator: propertyName: type @@ -17338,7 +16080,6 @@ components: type: object required: - type - - input properties: type: type: string @@ -17346,7 +16087,9 @@ components: - invoke_agent_invocations_api description: The manual dispatch payload type. input: - 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. + type: string + maxLength: 32768 + description: The raw input sent to the downstream invocations target. allOf: - $ref: '#/components/schemas/RoutineDispatchPayload' description: A manual payload used to test an invocations API routine dispatch. @@ -17357,29 +16100,24 @@ 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: 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. + description: The endpoint-scoped agent identifier for invocations API dispatch. 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. Exactly one of agent_name or agent_endpoint_id must be provided. + description: Dispatches a routine through the raw invocations API. x-ms-foundry-meta: conditional_previews: - Routines=V1Preview @@ -17387,7 +16125,6 @@ components: type: object required: - type - - input properties: type: type: string @@ -17395,7 +16132,9 @@ components: - invoke_agent_responses_api description: The manual dispatch payload type. input: - 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. + type: string + maxLength: 32768 + description: The user input sent to the downstream responses target. allOf: - $ref: '#/components/schemas/RoutineDispatchPayload' description: A manual payload used to test a responses API routine dispatch. @@ -17415,14 +16154,12 @@ components: agent_name: type: string maxLength: 256 - description: The project-scoped agent name for routine dispatch. + description: The project-scoped agent name for responses API dispatch. agent_endpoint_id: type: string maxLength: 256 - 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: + description: The endpoint-scoped agent identifier for responses API dispatch. + conversation_id: type: string maxLength: 256 description: An optional existing conversation identifier to continue during the downstream dispatch. @@ -17474,7 +16211,6 @@ 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: @@ -17573,30 +16309,32 @@ components: type: string description: Optional description of the MCP server, used to provide more context. headers: - anyOf: - - type: object - unevaluatedProperties: - type: string - - type: 'null' + type: object + additionalProperties: + type: string + nullable: true allowed_tools: anyOf: - type: array items: type: string - - $ref: '#/components/schemas/OpenAI.MCPToolFilter' - - type: 'null' + nullable: true + - type: object + allOf: + - $ref: '#/components/schemas/OpenAI.MCPToolFilter' + nullable: true require_approval: anyOf: - - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' + - type: object + allOf: + - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' + nullable: true - type: string enum: - always - never - - type: 'null' + nullable: true 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. @@ -17849,11 +16587,10 @@ components: - $ref: '#/components/schemas/ToolCallStatus' description: The status of the tool call. memories: - anyOf: - - type: array - items: - $ref: '#/components/schemas/MemoryItem' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/MemoryItem' + nullable: true description: The results returned from the memory search. allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' @@ -17905,7 +16642,7 @@ components: default: true procedural_memory_enabled: type: boolean - description: Whether to enable procedural memory extraction and storage. The service defaults to `true` if a value is not specified by the caller. + description: Whether to enable procedural memory extraction and storage. Defaults to `true`. default: true default_ttl_seconds: type: integer @@ -18005,7 +16742,7 @@ components: description: A human-readable description of the memory store. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Arbitrary key-value metadata to associate with the memory store. definition: @@ -18201,7 +16938,7 @@ components: readOnly: true capabilities: type: object - unevaluatedProperties: + additionalProperties: type: string description: Capabilities of deployed model readOnly: true @@ -18350,7 +17087,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Model Version Definition @@ -18492,6 +17229,7 @@ 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. @@ -18515,6 +17253,7 @@ components: - create_file description: The operation type. Always `create_file`. x-stainless-const: true + default: create_file path: type: string minLength: 1 @@ -18539,6 +17278,7 @@ 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. @@ -18558,6 +17298,7 @@ components: - delete_file description: The operation type. Always `delete_file`. x-stainless-const: true + default: delete_file path: type: string minLength: 1 @@ -18623,6 +17364,7 @@ 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. @@ -18640,6 +17382,7 @@ 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. @@ -18663,6 +17406,7 @@ components: - update_file description: The operation type. Always `update_file`. x-stainless-const: true + default: update_file path: type: string minLength: 1 @@ -18688,21 +17432,17 @@ components: x-stainless-const: true default: approximate country: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true region: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true city: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true timezone: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true OpenAI.AutoCodeInterpreterToolParam: type: object required: @@ -18722,9 +17462,9 @@ components: maxItems: 50 description: An optional list of uploaded files to make available to your code. memory_limit: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.ContainerMemoryLimit' - - type: 'null' + nullable: true 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. @@ -18748,12 +17488,6 @@ 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 @@ -18848,6 +17582,7 @@ 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' @@ -18860,12 +17595,6 @@ 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. @@ -18983,27 +17712,13 @@ components: - type: array items: $ref: '#/components/schemas/OpenAI.InputItem' - - type: 'null' + nullable: true previous_response_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true instructions: - 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' + type: string + nullable: true OpenAI.ComparisonFilter: type: object required: @@ -19020,8 +17735,6 @@ components: - gte - lt - lte - - in - - nin description: |- Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`. - `eq`: equals @@ -19093,14 +17806,6 @@ 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 @@ -19124,13 +17829,11 @@ components: type: string description: The ID of the pending safety check. code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true message: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true description: A pending safety check for the computer call. OpenAI.ComputerEnvironment: type: string @@ -19146,7 +17849,6 @@ components: - type - image_url - file_id - - detail properties: type: type: string @@ -19154,19 +17856,14 @@ 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: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true file_id: - 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`. + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.MessageContent' description: A screenshot of a computer. @@ -19193,21 +17890,6 @@ 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: @@ -19222,6 +17904,7 @@ 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' @@ -19249,6 +17932,7 @@ components: - container_auto description: Automatically creates a container for this request x-stainless-const: true + default: container_auto file_ids: type: array items: @@ -19256,9 +17940,9 @@ components: maxItems: 50 description: An optional list of uploaded files to make available to your code. memory_limit: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.ContainerMemoryLimit' - - type: 'null' + nullable: true skills: type: array items: @@ -19285,6 +17969,7 @@ 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. @@ -19325,12 +18010,19 @@ 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: @@ -19344,8 +18036,29 @@ 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: @@ -19378,6 +18091,7 @@ components: - container_reference description: The environment type. Always `container_reference`. x-stainless-const: true + default: container_reference container_id: type: string allOf: @@ -19412,9 +18126,10 @@ components: type: string description: The context management entry type. Currently only 'compaction' is supported. compact_threshold: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true OpenAI.ConversationItem: type: object required: @@ -19426,18 +18141,14 @@ components: propertyName: type mapping: message: '#/components/schemas/OpenAI.ConversationItemMessage' - function_call: '#/components/schemas/OpenAI.ConversationItemFunctionToolCall' - function_call_output: '#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutput' + function_call: '#/components/schemas/OpenAI.ConversationItemFunctionToolCallResource' + function_call_output: '#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutputResource' 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.ConversationItemComputerToolCallOutput' - tool_search_call: '#/components/schemas/OpenAI.ConversationItemToolSearchCall' - tool_search_output: '#/components/schemas/OpenAI.ConversationItemToolSearchOutput' - additional_tools: '#/components/schemas/OpenAI.ConversationItemAdditionalTools' + computer_call_output: '#/components/schemas/OpenAI.ConversationItemComputerToolCallOutputResource' 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' @@ -19449,39 +18160,10 @@ 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.ConversationItemCustomToolCallResource' - custom_tool_call_output: '#/components/schemas/OpenAI.ConversationItemCustomToolCallOutputResource' + custom_tool_call: '#/components/schemas/OpenAI.ConversationItemCustomToolCall' + custom_tool_call_output: '#/components/schemas/OpenAI.ConversationItemCustomToolCallOutput' 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: @@ -19546,9 +18228,8 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true created_by: type: string description: The ID of the entity that created this tool call output. @@ -19589,54 +18270,26 @@ components: type: string description: The ID of the container used to run the code. code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true outputs: - anyOf: - - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - - type: 'null' + type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + nullable: true 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: @@ -19654,8 +18307,6 @@ 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: @@ -19676,11 +18327,10 @@ 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.ConversationItemComputerToolCallOutput: + OpenAI.ConversationItemComputerToolCallOutputResource: type: object required: - type - - id - call_id - output properties: @@ -19694,7 +18344,6 @@ 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. @@ -19718,91 +18367,68 @@ components: `incomplete`. Populated when input items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - description: The output of a computer tool call. - title: Computer tool call output - OpenAI.ConversationItemCustomToolCallOutputResource: + OpenAI.ConversationItemCustomToolCall: type: object required: - type - call_id - - output - - status + - name + - input 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: |- - 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: + description: An identifier used to map this custom tool call to a tool call output. + name: type: string - description: The identifier of the actor that created the item. + description: The name of the custom tool being called. + input: + type: string + description: The input for the custom tool call generated by the model. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - title: ResponseCustomToolCallOutputItem - OpenAI.ConversationItemCustomToolCallResource: + description: A call to a custom tool created by the model. + title: Custom tool call + OpenAI.ConversationItemCustomToolCallOutput: type: object required: - type - call_id - - name - - input - - status + - output 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. - 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 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 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. + The output from the custom tool call generated by your code. + Can be a string or an list of output content. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - title: ResponseCustomToolCallItem + description: The output of a custom tool call from your code, being sent back to the model. + title: Custom tool call output OpenAI.ConversationItemFileSearchToolCall: type: object required: @@ -19837,11 +18463,10 @@ components: type: string description: The queries used to search for files. results: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: |- @@ -19877,12 +18502,13 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' + - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - - type: 'null' + nullable: true created_by: type: string description: The ID of the entity that created this tool call. @@ -19915,7 +18541,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -19923,9 +18549,10 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true created_by: type: string description: The identifier of the actor that created the item. @@ -19933,37 +18560,36 @@ components: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: The output of a shell tool call that was emitted. title: Shell call output - OpenAI.ConversationItemFunctionToolCall: + OpenAI.ConversationItemFunctionToolCallOutputResource: type: object required: - - id - type - call_id - - name - - arguments + - output properties: id: type: string - description: The unique ID of the function tool call. - readOnly: true + description: |- + The unique ID of the function tool call output. Populated when this item + is returned via API. 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. - 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. + 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: @@ -19975,42 +18601,32 @@ components: `incomplete`. Populated when items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - 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: + OpenAI.ConversationItemFunctionToolCallResource: 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. - readOnly: true + description: The unique ID of the function tool call. 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. + 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: @@ -20022,8 +18638,6 @@ 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: @@ -20050,9 +18664,8 @@ components: - failed description: The status of the image generation call. result: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: An image generation request made by the model. @@ -20147,13 +18760,12 @@ components: 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' + type: string + enum: + - in_progress + - completed + - incomplete + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: The output of a local shell tool call. @@ -20213,9 +18825,8 @@ components: type: boolean description: Whether the request was approved. reason: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: A response to an MCP approval request. @@ -20246,7 +18857,8 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: A list of tools available on an MCP server. @@ -20279,20 +18891,18 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true error: type: object - unevaluatedProperties: {} + additionalProperties: {} 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: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: An invocation of a tool on an MCP server. @@ -20329,10 +18939,6 @@ 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. @@ -20354,9 +18960,8 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true summary: type: array items: @@ -20384,87 +18989,6 @@ 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 @@ -20478,11 +19002,7 @@ 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 @@ -20618,7 +19138,6 @@ 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 @@ -20674,15 +19193,15 @@ components: type: object properties: metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true items: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.InputItem' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.InputItem' + nullable: true OpenAI.CreateEvalCompletionsRunDataSource: type: object required: @@ -20803,7 +19322,7 @@ components: default: custom item_schema: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The json schema for each row in the data source. include_sample_schema: type: boolean @@ -20875,7 +19394,7 @@ components: default: logs metadata: type: object - unevaluatedProperties: {} + additionalProperties: {} description: Metadata filters for the logs data source. description: |- A data source config which specifies the metadata property of your logs query. @@ -21020,7 +19539,7 @@ components: default: stored_completions metadata: type: object - unevaluatedProperties: {} + additionalProperties: {} description: Metadata filters for the stored completions data source. description: Deprecated in favor of LogsDataSourceConfig. title: StoredCompletionsDataSourceConfig @@ -21070,18 +19589,16 @@ components: This value is now deprecated in favor of `method`, and should be passed in under the `method` parameter. deprecated: true suffix: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true 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: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true description: |- The ID of an uploaded file that contains validation data. If you provide this file, the data is used to generate validation @@ -21091,16 +19608,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: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.CreateFineTuningJobRequestIntegrations' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.CreateFineTuningJobRequestIntegrations' + nullable: true description: A list of integrations to enable for your fine-tuning job. seed: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true minimum: 0 maximum: 2147483647 description: |- @@ -21109,9 +19626,10 @@ components: method: $ref: '#/components/schemas/OpenAI.FineTuneMethod' metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true OpenAI.CreateFineTuningJobRequestHyperparameters: type: object properties: @@ -21157,13 +19675,11 @@ components: project: type: string name: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true entity: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true tags: type: array items: @@ -21236,6 +19752,7 @@ components: - grammar description: Grammar format. Always `grammar`. x-stainless-const: true + default: grammar syntax: allOf: - $ref: '#/components/schemas/OpenAI.GrammarSyntax1' @@ -21258,6 +19775,7 @@ 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. @@ -21274,6 +19792,7 @@ 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. @@ -21284,9 +19803,6 @@ 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) @@ -21334,14 +19850,12 @@ components: - low - high - auto - - original OpenAI.DoubleClickAction: type: object required: - type - x - 'y' - - keys properties: type: type: string @@ -21349,6 +19863,7 @@ 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' @@ -21357,12 +19872,6 @@ 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. @@ -21379,6 +19888,7 @@ 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: @@ -21391,12 +19901,6 @@ components: { x: 200, y: 300 } ] ``` - keys: - anyOf: - - type: array - items: - type: string - - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A drag action. @@ -21425,10 +19929,6 @@ 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: @@ -21453,8 +19953,6 @@ 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: @@ -21462,15 +19960,13 @@ components: - message properties: code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true message: type: string param: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true type: type: string details: @@ -21479,10 +19975,10 @@ components: $ref: '#/components/schemas/OpenAI.Error' additionalInfo: type: object - unevaluatedProperties: {} + additionalProperties: {} debugInfo: type: object - unevaluatedProperties: {} + additionalProperties: {} OpenAI.EvalApiError: type: object required: @@ -21612,22 +20108,26 @@ components: type: object properties: seed: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true top_p: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true default: 1 temperature: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true max_completions_tokens: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true reasoning_effort: $ref: '#/components/schemas/OpenAI.ReasoningEffort' OpenAI.EvalGraderStringCheck: @@ -21880,10 +20380,10 @@ components: properties: item: type: object - unevaluatedProperties: {} + additionalProperties: {} sample: type: object - unevaluatedProperties: {} + additionalProperties: {} OpenAI.EvalJsonlFileIdSource: type: object required: @@ -21912,50 +20412,49 @@ components: - responses description: The type of run data source. Always `responses`. metadata: - anyOf: - - type: object - unevaluatedProperties: {} - - type: 'null' + type: object + additionalProperties: {} + nullable: true model: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true instructions_search: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true created_after: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true created_before: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true reasoning_effort: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.ReasoningEffort' - - type: 'null' + nullable: true temperature: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true top_p: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true users: - anyOf: - - type: array - items: - type: string - - type: 'null' + type: array + items: + type: string + nullable: true tools: - anyOf: - - type: array - items: - type: string - - type: 'null' + type: array + items: + type: string + nullable: true description: A EvalResponsesSource object describing a run data source configuration. title: EvalResponsesSource x-oaiMeta: @@ -22101,25 +20600,28 @@ components: x-stainless-const: true default: stored_completions metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true model: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true created_after: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true created_before: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true limit: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true description: A StoredCompletionsRunDataSource configuration describing a set of filters title: StoredCompletionsRunDataSource x-oaiMeta: @@ -22148,6 +20650,7 @@ 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. @@ -22162,11 +20665,6 @@ 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: @@ -22203,6 +20701,7 @@ 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: @@ -22217,9 +20716,9 @@ components: - $ref: '#/components/schemas/OpenAI.RankingOptions' description: Ranking options for search. filters: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.Filters' - - type: 'null' + nullable: true name: type: string description: Optional user-defined name for this tool or configuration. @@ -22240,9 +20739,10 @@ components: filename: type: string attributes: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.VectorStoreFileAttributes' - - type: 'null' + nullable: true score: type: number format: float @@ -22450,13 +20950,11 @@ components: project: type: string name: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true entity: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true tags: type: array items: @@ -22488,20 +20986,17 @@ components: format: unixtime description: The Unix timestamp (in seconds) for when the fine-tuning job was created. error: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FineTuningJobError' - - type: 'null' + nullable: true fine_tuned_model: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true finished_at: - anyOf: - - type: string - format: date-time - - type: 'null' type: integer - format: unixTimestamp + format: unixtime + nullable: true hyperparameters: allOf: - $ref: '#/components/schemas/OpenAI.FineTuningJobHyperparameters' @@ -22534,39 +21029,36 @@ 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: - anyOf: + type: integer + allOf: - $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: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true integrations: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.FineTuningIntegration' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.FineTuningIntegration' + nullable: true 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: unixTimestamp + format: unixtime + nullable: true method: $ref: '#/components/schemas/OpenAI.FineTuneMethod' metadata: - anyOf: + type: object + allOf: - $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. title: FineTuningJob x-oaiMeta: @@ -22698,9 +21190,8 @@ components: message: type: string param: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true OpenAI.FineTuningJobEvent: type: object required: @@ -22766,8 +21257,11 @@ components: - type: string enum: - auto - - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true + - type: integer + allOf: + - $ref: '#/components/schemas/OpenAI.integer' + nullable: true default: auto learning_rate_multiplier: oneOf: @@ -22809,23 +21303,18 @@ components: x-stainless-const: true default: input_file file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true 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. - 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`. + file_data: + type: string + description: The content of the file to be sent to the model. allOf: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' description: A file input to the model. @@ -22844,18 +21333,16 @@ components: x-stainless-const: true default: input_image image_url: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. allOf: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' description: An image input to the model. Learn about [image inputs](/docs/guides/vision). @@ -22894,18 +21381,6 @@ 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: @@ -22920,12 +21395,11 @@ components: parameters: $ref: '#/components/schemas/OpenAI.FunctionParameters' strict: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true OpenAI.FunctionParameters: type: object - unevaluatedProperties: {} + additionalProperties: {} 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. @@ -22941,13 +21415,15 @@ components: items: type: string timeout_ms: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true description: Execute a shell command. title: Shell exec action OpenAI.FunctionShellActionParam: @@ -22961,13 +21437,15 @@ components: type: string description: Ordered shell commands for the execution environment to run. timeout_ms: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true description: Commands and limits describing how to run the shell tool call. title: Shell action OpenAI.FunctionShellCallEnvironment: @@ -23111,6 +21589,7 @@ components: - exit description: The outcome type. Always `exit`. x-stainless-const: true + default: exit exit_code: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -23131,6 +21610,7 @@ components: - exit description: The outcome type. Always `exit`. x-stainless-const: true + default: exit exit_code: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -23181,12 +21661,6 @@ components: enum: - timeout - exit - OpenAI.FunctionShellCallOutputStatusEnum: - type: string - enum: - - in_progress - - completed - - incomplete OpenAI.FunctionShellCallOutputTimeoutOutcome: type: object required: @@ -23198,6 +21672,7 @@ 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. @@ -23213,16 +21688,11 @@ 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: @@ -23234,10 +21704,12 @@ components: - shell description: The type of the shell tool. Always `shell`. x-stainless-const: true + default: shell environment: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellToolParamEnvironment' - - type: 'null' + nullable: true name: type: string description: Optional user-defined name for this tool or configuration. @@ -23321,61 +21793,67 @@ 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: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true parameters: - anyOf: - - type: object - unevaluatedProperties: {} - - type: 'null' + type: object + additionalProperties: {} + nullable: true strict: - anyOf: - - type: boolean - - type: 'null' - defer_loading: type: boolean - description: Whether this function is deferred and loaded via tool search. + nullable: true 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.FunctionToolParam: + OpenAI.FunctionToolCallOutput: type: object required: - - name - type + - call_id + - output properties: - name: + id: type: string - 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' + description: |- + The unique ID of the function tool call output. Populated when this item + is returned via API. type: type: string enum: - - function + - function_call_output + description: The type of the function tool call output. Always `function_call_output`. x-stainless-const: true - default: function - defer_loading: - type: boolean - description: Whether this function should be deferred and discovered via tool search. + 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.GraderLabelModel: type: object required: @@ -23752,7 +22230,6 @@ components: - low - high - auto - - original OpenAI.ImageGenActionEnum: type: string enum: @@ -23770,6 +22247,7 @@ 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 @@ -23791,15 +22269,15 @@ components: or `auto`. Default: `auto`. default: auto size: - 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`. + type: string + enum: + - 1024x1024 + - 1024x1536 + - 1536x1024 + - auto + description: |- + The size of the generated image. One of `1024x1024`, `1024x1536`, + `1536x1024`, or `auto`. Default: `auto`. default: auto output_format: type: string @@ -23836,9 +22314,9 @@ components: `opaque`, or `auto`. Default: `auto`. default: auto input_fidelity: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.InputFidelity' - - type: 'null' + nullable: true input_image_mask: allOf: - $ref: '#/components/schemas/OpenAI.ImageGenToolInputImageMask' @@ -23889,7 +22367,6 @@ 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. @@ -23911,6 +22388,7 @@ 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. @@ -24007,23 +22485,18 @@ components: x-stainless-const: true default: input_file file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true 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. - 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`. + file_data: + type: string + description: The content of the file to be sent to the model. allOf: - $ref: '#/components/schemas/OpenAI.InputContent' description: A file input to the model. @@ -24042,18 +22515,16 @@ components: x-stainless-const: true default: input_image image_url: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. allOf: - $ref: '#/components/schemas/OpenAI.InputContent' description: An image input to the model. Learn about [image inputs](/docs/guides/vision). @@ -24105,23 +22576,18 @@ components: x-stainless-const: true default: input_file file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true 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. - 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`. + file_data: + type: string + description: The content of the file to be sent to the model. description: A file input to the model. title: Input file OpenAI.InputFileContentParam: @@ -24137,26 +22603,18 @@ components: x-stainless-const: true default: input_file file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true filename: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true file_data: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true file_url: - 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`. + type: string + format: uri + nullable: true description: A file input to the model. title: Input file OpenAI.InputImageContent: @@ -24173,18 +22631,16 @@ components: x-stainless-const: true default: input_image image_url: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. description: An image input to the model. Learn about [image inputs](/docs/guides/vision). title: Input image OpenAI.InputImageContentParamAutoParam: @@ -24200,18 +22656,16 @@ components: x-stainless-const: true default: input_image image_url: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true detail: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.DetailEnum' - - type: 'null' + nullable: true description: An image input to the model. Learn about [image inputs](/docs/guides/vision) title: Input image OpenAI.InputItem: @@ -24233,9 +22687,6 @@ 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' @@ -24256,38 +22707,6 @@ 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: @@ -24304,9 +22723,8 @@ components: x-stainless-const: true default: apply_patch_call id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -24339,9 +22757,8 @@ components: x-stainless-const: true default: apply_patch_call_output id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -24352,9 +22769,8 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatusParam' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The streamed output emitted by an apply patch tool call. @@ -24392,17 +22808,15 @@ components: type: string description: The ID of the container used to run the code. code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true outputs: - anyOf: - - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - - type: 'null' + type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A tool call to run code. @@ -24414,9 +22828,8 @@ components: - encrypted_content properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true type: type: string enum: @@ -24440,9 +22853,8 @@ components: - output properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -24458,15 +22870,14 @@ components: output: $ref: '#/components/schemas/OpenAI.ComputerScreenshotImage' acknowledged_safety_checks: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' + nullable: true status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The output of a computer tool call. @@ -24477,6 +22888,7 @@ components: - type - id - call_id + - action - pending_safety_checks - status properties: @@ -24494,8 +22906,6 @@ 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: @@ -24536,9 +22946,6 @@ 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. @@ -24615,11 +23022,10 @@ components: type: string description: The queries used to search for files. results: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: |- @@ -24634,9 +23040,8 @@ components: - output properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -24660,9 +23065,9 @@ components: - $ref: '#/components/schemas/OpenAI.InputFileContentParam' description: Text, image, or file output of the function tool call. status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The output of a function tool call. @@ -24675,9 +23080,8 @@ components: - action properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -24695,13 +23099,14 @@ components: - $ref: '#/components/schemas/OpenAI.FunctionShellActionParam' description: The shell commands and limits that describe how to run the tool call. status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - - type: 'null' + nullable: true environment: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemParamEnvironment' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A tool representing a request to execute one or more shell commands. @@ -24714,9 +23119,8 @@ components: - output properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -24735,13 +23139,14 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContentParam' description: Captured chunks of stdout and stderr output, along with their associated outcomes. status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - - type: 'null' + nullable: true max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The streamed output items emitted by a shell tool call. @@ -24749,7 +23154,6 @@ components: OpenAI.InputItemFunctionToolCall: type: object required: - - id - type - call_id - name @@ -24758,7 +23162,6 @@ components: id: type: string description: The unique ID of the function tool call. - readOnly: true type: type: string enum: @@ -24768,9 +23171,6 @@ 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. @@ -24818,9 +23218,8 @@ components: - failed description: The status of the image generation call. result: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: An image generation request made by the model. @@ -24879,13 +23278,12 @@ components: 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' + type: string + enum: + - in_progress + - completed + - incomplete + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The output of a local shell tool call. @@ -24935,9 +23333,8 @@ components: description: The type of the item. Always `mcp_approval_response`. x-stainless-const: true id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true approval_request_id: type: string description: The ID of the approval request being answered. @@ -24945,9 +23342,8 @@ components: type: boolean description: Whether the request was approved. reason: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A response to an MCP approval request. @@ -24978,7 +23374,8 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A list of tools available on an MCP server. @@ -25011,20 +23408,18 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true error: type: object - unevaluatedProperties: {} + additionalProperties: {} 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: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: An invocation of a tool on an MCP server. @@ -25058,10 +23453,6 @@ 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: @@ -25092,9 +23483,8 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true summary: type: array items: @@ -25122,77 +23512,6 @@ 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 @@ -25206,9 +23525,6 @@ components: - web_search_call - function_call - function_call_output - - tool_search_call - - tool_search_output - - additional_tools - reasoning - compaction - image_generation_call @@ -25265,6 +23581,44 @@ 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: @@ -25273,6 +23627,43 @@ 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 @@ -25334,7 +23725,7 @@ components: discriminator: propertyName: type mapping: - message: '#/components/schemas/OpenAI.ItemInputMessage' + message: '#/components/schemas/OpenAI.InputMessage' output_message: '#/components/schemas/OpenAI.ItemOutputMessage' file_search_call: '#/components/schemas/OpenAI.ItemFileSearchToolCall' computer_call: '#/components/schemas/OpenAI.ItemComputerToolCall' @@ -25342,9 +23733,6 @@ 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' @@ -25362,38 +23750,6 @@ 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: @@ -25410,9 +23766,8 @@ components: x-stainless-const: true default: apply_patch_call id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -25445,9 +23800,8 @@ components: x-stainless-const: true default: apply_patch_call_output id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -25458,9 +23812,8 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatusParam' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The streamed output emitted by an apply patch tool call. @@ -25498,17 +23851,15 @@ components: type: string description: The ID of the container used to run the code. code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true outputs: - anyOf: - - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - - type: 'null' + type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A tool call to run code. @@ -25520,9 +23871,8 @@ components: - encrypted_content properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true type: type: string enum: @@ -25546,9 +23896,8 @@ components: - output properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -25564,15 +23913,14 @@ components: output: $ref: '#/components/schemas/OpenAI.ComputerScreenshotImage' acknowledged_safety_checks: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' + nullable: true status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The output of a computer tool call. @@ -25583,6 +23931,7 @@ components: - type - id - call_id + - action - pending_safety_checks - status properties: @@ -25600,8 +23949,6 @@ 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: @@ -25642,9 +23989,6 @@ 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. @@ -25697,17 +24041,14 @@ 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.ItemFieldComputerToolCallOutput' + computer_call_output: '#/components/schemas/OpenAI.ItemFieldComputerToolCallOutputResource' reasoning: '#/components/schemas/OpenAI.ItemFieldReasoningItem' compaction: '#/components/schemas/OpenAI.ItemFieldCompactionBody' code_interpreter_call: '#/components/schemas/OpenAI.ItemFieldCodeInterpreterToolCall' @@ -25724,35 +24065,6 @@ 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: @@ -25817,9 +24129,8 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true created_by: type: string description: The ID of the entity that created this tool call output. @@ -25860,17 +24171,15 @@ components: type: string description: The ID of the container used to run the code. code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true outputs: - anyOf: - - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - - type: 'null' + type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A tool call to run code. @@ -25908,6 +24217,7 @@ components: - type - id - call_id + - action - pending_safety_checks - status properties: @@ -25925,8 +24235,6 @@ 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: @@ -25947,11 +24255,10 @@ 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.ItemFieldComputerToolCallOutput: + OpenAI.ItemFieldComputerToolCallOutputResource: type: object required: - type - - id - call_id - output properties: @@ -25965,7 +24272,6 @@ 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. @@ -25989,8 +24295,6 @@ 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: @@ -26011,9 +24315,6 @@ 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. @@ -26090,11 +24391,10 @@ components: type: string description: The queries used to search for files. results: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: |- @@ -26130,12 +24430,13 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' + - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - - type: 'null' + nullable: true created_by: type: string description: The ID of the entity that created this tool call. @@ -26168,7 +24469,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -26176,9 +24477,10 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true created_by: type: string description: The identifier of the actor that created the item. @@ -26189,7 +24491,6 @@ components: OpenAI.ItemFieldFunctionToolCall: type: object required: - - id - type - call_id - name @@ -26198,7 +24499,6 @@ components: id: type: string description: The unique ID of the function tool call. - readOnly: true type: type: string enum: @@ -26208,9 +24508,6 @@ 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. @@ -26232,51 +24529,6 @@ 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: @@ -26303,9 +24555,8 @@ components: - failed description: The status of the image generation call. result: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: An image generation request made by the model. @@ -26364,13 +24615,12 @@ components: 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' + type: string + enum: + - in_progress + - completed + - incomplete + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: The output of a local shell tool call. @@ -26430,9 +24680,8 @@ components: type: boolean description: Whether the request was approved. reason: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A response to an MCP approval request. @@ -26463,7 +24712,8 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A list of tools available on an MCP server. @@ -26496,20 +24746,18 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true error: type: object - unevaluatedProperties: {} + additionalProperties: {} 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: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: An invocation of a tool on an MCP server. @@ -26546,10 +24794,6 @@ 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. @@ -26571,9 +24815,8 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true summary: type: array items: @@ -26601,87 +24844,6 @@ 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 @@ -26689,9 +24851,6 @@ components: enum: - message - function_call - - tool_search_call - - tool_search_output - - additional_tools - function_call_output - file_search_call - web_search_call @@ -26786,11 +24945,10 @@ components: type: string description: The queries used to search for files. results: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: |- @@ -26805,9 +24963,8 @@ components: - output properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -26831,9 +24988,9 @@ components: - $ref: '#/components/schemas/OpenAI.InputFileContentParam' description: Text, image, or file output of the function tool call. status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The output of a function tool call. @@ -26846,9 +25003,8 @@ components: - action properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -26866,13 +25022,14 @@ components: - $ref: '#/components/schemas/OpenAI.FunctionShellActionParam' description: The shell commands and limits that describe how to run the tool call. status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - - type: 'null' + nullable: true environment: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemParamEnvironment' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A tool representing a request to execute one or more shell commands. @@ -26885,9 +25042,8 @@ components: - output properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -26906,13 +25062,14 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContentParam' description: Captured chunks of stdout and stderr output, along with their associated outcomes. status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - - type: 'null' + nullable: true max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The streamed output items emitted by a shell tool call. @@ -26920,7 +25077,6 @@ components: OpenAI.ItemFunctionToolCall: type: object required: - - id - type - call_id - name @@ -26929,7 +25085,6 @@ components: id: type: string description: The unique ID of the function tool call. - readOnly: true type: type: string enum: @@ -26939,9 +25094,6 @@ 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. @@ -26989,57 +25141,12 @@ components: - failed description: The status of the image generation call. result: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true 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: @@ -27094,13 +25201,12 @@ components: 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' + type: string + enum: + - in_progress + - completed + - incomplete + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The output of a local shell tool call. @@ -27150,9 +25256,8 @@ components: description: The type of the item. Always `mcp_approval_response`. x-stainless-const: true id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true approval_request_id: type: string description: The ID of the approval request being answered. @@ -27160,9 +25265,8 @@ components: type: boolean description: Whether the request was approved. reason: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A response to an MCP approval request. @@ -27193,7 +25297,8 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A list of tools available on an MCP server. @@ -27226,20 +25331,18 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true error: type: object - unevaluatedProperties: {} + additionalProperties: {} 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: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: An invocation of a tool on an MCP server. @@ -27273,10 +25376,6 @@ 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: @@ -27307,9 +25406,8 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true summary: type: array items: @@ -27349,6 +25447,7 @@ 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. @@ -27366,19 +25465,14 @@ components: discriminator: propertyName: type mapping: - message: '#/components/schemas/OpenAI.ItemResourceInputMessage' + message: '#/components/schemas/OpenAI.InputMessageResource' 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.ItemResourceComputerToolCallOutput' + computer_call_output: '#/components/schemas/OpenAI.ItemResourceComputerToolCallOutputResource' web_search_call: '#/components/schemas/OpenAI.ItemResourceWebSearchToolCall' - 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' + function_call: '#/components/schemas/OpenAI.ItemResourceFunctionToolCallResource' + function_call_output: '#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutputResource' image_generation_call: '#/components/schemas/OpenAI.ItemResourceImageGenToolCall' code_interpreter_call: '#/components/schemas/OpenAI.ItemResourceCodeInterpreterToolCall' local_shell_call: '#/components/schemas/OpenAI.ItemResourceLocalShellToolCall' @@ -27391,38 +25485,7 @@ 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: @@ -27487,9 +25550,8 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true created_by: type: string description: The ID of the entity that created this tool call output. @@ -27530,54 +25592,26 @@ components: type: string description: The ID of the container used to run the code. code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true outputs: - anyOf: - - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - - type: 'null' + type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + nullable: true 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: @@ -27595,8 +25629,6 @@ 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: @@ -27617,11 +25649,10 @@ 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.ItemResourceComputerToolCallOutput: + OpenAI.ItemResourceComputerToolCallOutputResource: type: object required: - type - - id - call_id - output properties: @@ -27635,7 +25666,6 @@ 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. @@ -27659,91 +25689,6 @@ 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: @@ -27778,11 +25723,10 @@ components: type: string description: The queries used to search for files. results: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: |- @@ -27818,12 +25762,13 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' + - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - - type: 'null' + nullable: true created_by: type: string description: The ID of the entity that created this tool call. @@ -27856,7 +25801,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -27864,9 +25809,10 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true created_by: type: string description: The identifier of the actor that created the item. @@ -27874,37 +25820,36 @@ components: - $ref: '#/components/schemas/OpenAI.ItemResource' description: The output of a shell tool call that was emitted. title: Shell call output - OpenAI.ItemResourceFunctionToolCall: + OpenAI.ItemResourceFunctionToolCallOutputResource: type: object required: - - id - type - call_id - - name - - arguments + - output properties: id: type: string - description: The unique ID of the function tool call. - readOnly: true + description: |- + The unique ID of the function tool call output. Populated when this item + is returned via API. 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. - 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. + 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: @@ -27916,42 +25861,32 @@ components: `incomplete`. Populated when items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' - 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: + OpenAI.ItemResourceFunctionToolCallResource: 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. - readOnly: true + description: The unique ID of the function tool call. 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. + 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: @@ -27963,8 +25898,6 @@ 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: @@ -27991,57 +25924,12 @@ components: - failed description: The status of the image generation call. result: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true 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: @@ -28096,13 +25984,12 @@ components: 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' + type: string + enum: + - in_progress + - completed + - incomplete + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: The output of a local shell tool call. @@ -28162,9 +26049,8 @@ components: type: boolean description: Whether the request was approved. reason: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: A response to an MCP approval request. @@ -28195,7 +26081,8 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: A list of tools available on an MCP server. @@ -28228,20 +26115,18 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true error: type: object - unevaluatedProperties: {} + additionalProperties: {} 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: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: An invocation of a tool on an MCP server. @@ -28275,10 +26160,6 @@ 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: @@ -28292,134 +26173,6 @@ 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 @@ -28433,11 +26186,6 @@ 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 @@ -28450,8 +26198,6 @@ components: - mcp_approval_request - mcp_approval_response - mcp_call - - custom_tool_call - - custom_tool_call_output - structured_outputs - oauth_consent_request - memory_search_call @@ -28515,77 +26261,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.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 @@ -28599,9 +26274,6 @@ components: - web_search_call - function_call - function_call_output - - tool_search_call - - tool_search_output - - additional_tools - reasoning - compaction - image_generation_call @@ -28693,6 +26365,7 @@ 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: @@ -28720,13 +26393,11 @@ components: - list x-stainless-const: true first_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true last_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true x-ms-list-continuation-token: true has_more: type: boolean @@ -28779,10 +26450,23 @@ 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: @@ -28803,23 +26487,22 @@ components: type: string description: The command to run. timeout_ms: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true working_directory: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true env: type: object - unevaluatedProperties: + additionalProperties: type: string description: Environment variables to set for the command. x-oaiTypeLabel: map user: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true description: Execute a shell command on the server. title: Local shell exec action OpenAI.LocalShellToolParam: @@ -28833,6 +26516,7 @@ 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. @@ -28891,17 +26575,17 @@ components: type: string description: The name of the tool. description: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true input_schema: allOf: - $ref: '#/components/schemas/OpenAI.MCPListToolsToolInputSchema' description: The JSON schema describing the tool's input. annotations: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.MCPListToolsToolAnnotations' - - type: 'null' + nullable: true description: A tool available on an MCP server. title: MCP list tools tool OpenAI.MCPListToolsToolAnnotations: @@ -28963,30 +26647,32 @@ components: type: string description: Optional description of the MCP server, used to provide more context. headers: - anyOf: - - type: object - unevaluatedProperties: - type: string - - type: 'null' + type: object + additionalProperties: + type: string + nullable: true allowed_tools: anyOf: - type: array items: type: string - - $ref: '#/components/schemas/OpenAI.MCPToolFilter' - - type: 'null' + nullable: true + - type: object + allOf: + - $ref: '#/components/schemas/OpenAI.MCPToolFilter' + nullable: true require_approval: anyOf: - - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' + - type: object + allOf: + - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' + nullable: true - type: string enum: - always - never - - type: 'null' + nullable: true 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. @@ -29046,7 +26732,6 @@ 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 @@ -29061,23 +26746,18 @@ components: x-stainless-const: true default: input_file file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true 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. - 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`. + file_data: + type: string + description: The content of the file to be sent to the model. allOf: - $ref: '#/components/schemas/OpenAI.MessageContent' description: A file input to the model. @@ -29096,18 +26776,16 @@ components: x-stainless-const: true default: input_image image_url: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. allOf: - $ref: '#/components/schemas/OpenAI.MessageContent' description: An image input to the model. Learn about [image inputs](/docs/guides/vision). @@ -29217,15 +26895,6 @@ 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: @@ -29245,7 +26914,7 @@ components: - incomplete OpenAI.Metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -29256,9 +26925,13 @@ components: x-oaiTypeLabel: map OpenAI.ModelIdsCompaction: anyOf: - - $ref: '#/components/schemas/OpenAI.ModelIdsResponses' + - 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 - 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. + nullable: true 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: @@ -29283,125 +26956,6 @@ 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: @@ -29415,6 +26969,7 @@ 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' @@ -29423,50 +26978,10 @@ 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: @@ -29603,19 +27118,13 @@ 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' @@ -29623,38 +27132,7 @@ components: mcp_call: '#/components/schemas/OpenAI.OutputItemMcpToolCall' mcp_list_tools: '#/components/schemas/OpenAI.OutputItemMcpListTools' mcp_approval_request: '#/components/schemas/OpenAI.OutputItemMcpApprovalRequest' - 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' + custom_tool_call: '#/components/schemas/OpenAI.OutputItemCustomToolCall' OpenAI.OutputItemApplyPatchToolCall: type: object required: @@ -29719,9 +27197,8 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true created_by: type: string description: The ID of the entity that created this tool call output. @@ -29762,17 +27239,15 @@ components: type: string description: The ID of the container used to run the code. code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true outputs: - anyOf: - - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - - type: 'null' + type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: A tool call to run code. @@ -29810,6 +27285,7 @@ components: - type - id - call_id + - action - pending_safety_checks - status properties: @@ -29827,8 +27303,6 @@ 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: @@ -29849,99 +27323,13 @@ 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.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: + OpenAI.OutputItemCustomToolCall: type: object required: - type - call_id - name - input - - status properties: type: type: string @@ -29955,27 +27343,16 @@ 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' - title: ResponseCustomToolCallItem + description: A call to a custom tool created by the model. + title: Custom tool call OpenAI.OutputItemFileSearchToolCall: type: object required: @@ -30010,11 +27387,10 @@ components: type: string description: The queries used to search for files. results: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: |- @@ -30050,12 +27426,13 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' + - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - - type: 'null' + nullable: true created_by: type: string description: The ID of the entity that created this tool call. @@ -30088,7 +27465,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -30096,9 +27473,10 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true created_by: type: string description: The identifier of the actor that created the item. @@ -30109,7 +27487,6 @@ components: OpenAI.OutputItemFunctionToolCall: type: object required: - - id - type - call_id - name @@ -30118,7 +27495,6 @@ components: id: type: string description: The unique ID of the function tool call. - readOnly: true type: type: string enum: @@ -30128,9 +27504,6 @@ 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. @@ -30152,51 +27525,6 @@ 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: @@ -30223,9 +27551,8 @@ components: - failed description: The status of the image generation call. result: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: An image generation request made by the model. @@ -30264,37 +27591,6 @@ 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: @@ -30326,37 +27622,6 @@ 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: @@ -30383,7 +27648,8 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: A list of tools available on an MCP server. @@ -30416,20 +27682,18 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true error: type: object - unevaluatedProperties: {} + additionalProperties: {} 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: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: An invocation of a tool on an MCP server. @@ -30463,10 +27727,6 @@ 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: @@ -30497,9 +27757,8 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true summary: type: array items: @@ -30527,87 +27786,6 @@ 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 @@ -30616,19 +27794,13 @@ 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 @@ -30636,9 +27808,7 @@ 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 @@ -30781,21 +27951,16 @@ components: type: string description: The unique identifier of the prompt template to use. version: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true variables: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.ResponsePromptVariables' - - type: 'null' + nullable: true 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: @@ -30816,118 +27981,39 @@ 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: - anyOf: - - type: string - enum: - - auto - - concise - - detailed - - type: 'null' + type: string + enum: + - auto + - concise + - detailed + nullable: true generate_summary: - anyOf: - - type: string - enum: - - auto - - concise - - detailed - - type: 'null' + type: string + enum: + - auto + - concise + - detailed + nullable: true description: |- **gpt-5 and o-series models only** Configuration options for [reasoning models](https://platform.openai.com/docs/guides/reasoning). title: Reasoning OpenAI.ReasoningEffort: - anyOf: - - type: string - enum: - - none - - minimal - - low - - medium - - high - - xhigh - - type: 'null' + type: string + enum: + - none + - minimal + - low + - medium + - high + - xhigh description: |- Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). @@ -30938,6 +28024,7 @@ 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: @@ -30970,22 +28057,26 @@ components: - agent_reference properties: metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true top_logprobs: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true temperature: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true default: 1 top_p: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true default: 1 user: type: string @@ -30996,41 +28087,44 @@ 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, 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). + 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: - anyOf: - - type: string - enum: - - in_memory - - 24h - - type: 'null' + type: string + enum: + - in-memory + - 24h + nullable: true previous_response_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true model: type: string description: The model deployment to use for the creation of this response. reasoning: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Reasoning' - - type: 'null' + nullable: true background: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true + max_output_tokens: + type: integer + allOf: + - $ref: '#/components/schemas/OpenAI.integer' + nullable: true max_tool_calls: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true text: $ref: '#/components/schemas/OpenAI.ResponseTextParam' tools: @@ -31042,12 +28136,11 @@ components: prompt: $ref: '#/components/schemas/OpenAI.Prompt' truncation: - anyOf: - - type: string - enum: - - auto - - disabled - - type: 'null' + type: string + enum: + - auto + - disabled + nullable: true default: disabled id: type: string @@ -31075,20 +28168,19 @@ 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: unixTimestamp + format: unixtime + nullable: true error: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.ResponseError' - - type: 'null' + nullable: true incomplete_details: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.ResponseIncompleteDetails' - - type: 'null' + nullable: true output: type: array items: @@ -31107,33 +28199,26 @@ components: - type: array items: $ref: '#/components/schemas/OpenAI.InputItem' - - type: 'null' + nullable: true output_text: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true 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: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.ConversationReference' - - type: 'null' - max_output_tokens: - anyOf: - - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true agent_reference: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/AgentReference' - - type: 'null' + nullable: true description: The agent used for this response content_filters: type: array @@ -31160,10 +28245,8 @@ components: description: A sequence number for this chunk of the stream response. delta: type: string - contentEncoding: base64 + format: 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 @@ -31191,8 +28274,6 @@ 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 @@ -31223,8 +28304,6 @@ 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 @@ -31252,8 +28331,6 @@ 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 @@ -31293,8 +28370,6 @@ 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 @@ -31336,8 +28411,6 @@ 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 @@ -31375,8 +28448,6 @@ 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 @@ -31413,8 +28484,6 @@ 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,8 +28520,6 @@ 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 @@ -31485,8 +28552,6 @@ 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 @@ -31581,8 +28646,6 @@ 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 @@ -31635,8 +28698,6 @@ 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 @@ -31675,8 +28736,6 @@ 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 @@ -31748,8 +28807,6 @@ 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: @@ -31791,8 +28848,6 @@ 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: @@ -31855,22 +28910,18 @@ components: description: The type of the event. Always `error`. x-stainless-const: true code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true message: type: string description: The error message. param: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true 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 @@ -31904,8 +28955,6 @@ 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 @@ -31971,8 +29020,6 @@ 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 @@ -32009,8 +29056,6 @@ 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 @@ -32047,8 +29092,6 @@ 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 @@ -32112,12 +29155,11 @@ components: schema: $ref: '#/components/schemas/OpenAI.ResponseFormatJsonSchemaSchema' strict: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true OpenAI.ResponseFormatJsonSchemaSchema: type: object - unevaluatedProperties: {} + additionalProperties: {} description: |- The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). @@ -32164,8 +29206,6 @@ 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 @@ -32210,8 +29250,6 @@ 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 @@ -32250,8 +29288,6 @@ 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: @@ -32289,8 +29325,6 @@ 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: @@ -32328,8 +29362,6 @@ 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: @@ -32376,8 +29408,6 @@ 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: @@ -32413,8 +29443,6 @@ 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 @@ -32486,8 +29514,6 @@ 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 @@ -32545,7 +29571,7 @@ components: type: array items: $ref: '#/components/schemas/OpenAI.ResponseLogProbTopLogprobs' - description: The log probabilities of up to 20 of the most likely tokens. + description: The log probability of the top 20 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) @@ -32586,8 +29612,6 @@ 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: @@ -32630,8 +29654,6 @@ 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: @@ -32670,8 +29692,6 @@ 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: @@ -32709,8 +29729,6 @@ 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: @@ -32748,8 +29766,6 @@ 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: @@ -32787,8 +29803,6 @@ 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: @@ -32826,8 +29840,6 @@ 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: @@ -32865,8 +29877,6 @@ 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: @@ -32905,8 +29915,6 @@ 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 @@ -32950,8 +29958,6 @@ 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 @@ -33015,8 +30021,6 @@ 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: @@ -33039,7 +30043,7 @@ components: } OpenAI.ResponsePromptVariables: type: object - unevaluatedProperties: + additionalProperties: anyOf: - type: string - $ref: '#/components/schemas/OpenAI.InputTextContent' @@ -33073,8 +30077,6 @@ 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: @@ -33126,8 +30128,6 @@ 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 @@ -33192,8 +30192,6 @@ 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 @@ -33259,8 +30257,6 @@ 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 @@ -33310,8 +30306,6 @@ 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 @@ -33361,8 +30355,6 @@ 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 @@ -33410,8 +30402,6 @@ 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 @@ -33459,8 +30449,6 @@ 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 @@ -33508,8 +30496,6 @@ 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 @@ -33523,127 +30509,6 @@ 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: @@ -33698,8 +30563,6 @@ 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 @@ -33753,8 +30616,6 @@ 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 @@ -33851,8 +30712,6 @@ 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 @@ -33889,8 +30748,6 @@ 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 @@ -33927,8 +30784,6 @@ 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 @@ -33951,6 +30806,7 @@ 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. @@ -33970,6 +30826,7 @@ 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' @@ -33986,21 +30843,10 @@ 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: @@ -34008,15 +30854,13 @@ components: - medium - high OpenAI.ServiceTier: - anyOf: - - type: string - enum: - - auto - - default - - flex - - scale - - priority - - type: 'null' + type: string + enum: + - auto + - default + - flex + - scale + - priority 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'. @@ -34024,13 +30868,7 @@ 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. - OpenAI.ServiceTierEnum: - type: string - enum: - - auto - - default - - flex - - priority + nullable: true OpenAI.SkillReferenceParam: type: object required: @@ -34043,6 +30881,7 @@ 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 @@ -34064,6 +30903,7 @@ 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. @@ -34079,6 +30919,7 @@ 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. @@ -34095,6 +30936,7 @@ 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. @@ -34113,6 +30955,7 @@ components: enum: - text x-stainless-const: true + default: text text: type: string allOf: @@ -34210,9 +31053,8 @@ components: schema: $ref: '#/components/schemas/OpenAI.ResponseFormatJsonSchemaSchema' strict: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.TextResponseFormatConfiguration' description: |- @@ -34254,9 +31096,6 @@ 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 @@ -34285,7 +31124,7 @@ components: type: array items: type: object - unevaluatedProperties: {} + additionalProperties: {} 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: @@ -34314,34 +31153,6 @@ 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: @@ -34438,9 +31249,8 @@ components: type: string description: The label of the MCP server to use. name: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' description: Use this option to force the model to call a specific tool on a remote MCP server. @@ -34480,8 +31290,6 @@ 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 @@ -34503,8 +31311,6 @@ components: - web_search_preview_2025_03_11 - image_generation - code_interpreter - - computer - - computer_use OpenAI.ToolChoiceWebSearchPreview: type: object required: @@ -34533,38 +31339,6 @@ 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 @@ -34572,7 +31346,6 @@ components: enum: - function - file_search - - computer - computer_use_preview - web_search - mcp @@ -34581,8 +31354,6 @@ components: - local_shell - shell - custom - - namespace - - tool_search - web_search_preview - apply_patch - a2a_preview @@ -34647,6 +31418,7 @@ 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. @@ -34660,9 +31432,10 @@ components: - metadata properties: metadata: - anyOf: + type: object + allOf: - $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. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. @@ -34681,6 +31454,7 @@ 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 @@ -34702,7 +31476,7 @@ components: title: URL citation OpenAI.VectorStoreFileAttributes: type: object - unevaluatedProperties: + additionalProperties: anyOf: - type: string - $ref: '#/components/schemas/OpenAI.numeric' @@ -34715,17 +31489,16 @@ components: length of 512 characters, booleans, or numbers. x-oaiTypeLabel: map OpenAI.Verbosity: - anyOf: - - type: string - enum: - - low - - medium - - high - - type: 'null' + type: string + enum: + - low + - medium + - high 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: @@ -34737,6 +31510,7 @@ 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. @@ -34775,10 +31549,9 @@ components: description: The action type. x-stainless-const: true url: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true description: The URL opened by the model. description: Action type "open_page" - Opens a specific URL from search results. title: Open page action @@ -34786,6 +31559,7 @@ components: type: object required: - type + - query properties: type: type: string @@ -34795,7 +31569,7 @@ components: x-stainless-const: true query: type: string - description: The search query. + description: '[DEPRECATED] The search query.' deprecated: true queries: type: array @@ -34824,7 +31598,6 @@ components: x-stainless-const: true url: type: string - format: uri OpenAI.WebSearchApproximateLocation: type: object required: @@ -34838,21 +31611,17 @@ components: x-stainless-const: true default: approximate country: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true region: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true city: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true timezone: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true description: The approximate location of the user. title: Web search approximate location OpenAI.WebSearchPreviewTool: @@ -34866,18 +31635,16 @@ 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: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.ApproximateLocation' - - type: 'null' + nullable: true 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). @@ -34892,14 +31659,17 @@ 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: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.WebSearchToolFilters' - - type: 'null' + nullable: true user_location: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.WebSearchApproximateLocation' - - type: 'null' + nullable: true search_context_size: type: string enum: @@ -34930,11 +31700,10 @@ components: type: object properties: allowed_domains: - anyOf: - - type: array - items: - type: string - - type: 'null' + type: array + items: + type: string + nullable: true OpenAI.integer: type: integer format: int64 @@ -34998,7 +31767,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 - unevaluatedProperties: {} + additionalProperties: {} description: The openapi function shape, described as a JSON Schema object. auth: allOf: @@ -35022,7 +31791,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 - unevaluatedProperties: {} + additionalProperties: {} description: The parameters the functions accepts, described as a JSON Schema object. required: - name @@ -35177,47 +31946,84 @@ components: allOf: - $ref: '#/components/schemas/ToolboxTool' description: An OpenAPI tool stored in a toolbox. - OptimizationAgentIdentifier: + OptimizationAgentDefinition: type: object - required: - - agent_name properties: - agent_name: + agentName: type: string - description: Registered Foundry agent name (required). - agent_version: + description: Agent name. + 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 system_prompt are specified in options.optimization_config. + description: Agent version. + model: + type: string + description: Model deployment name. + systemPrompt: + 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). OptimizationCandidate: type: object required: - name - - avg_score - - avg_tokens + - config + - mutations + - avgScore + - avgTokens + - passRate + - taskScores + - isParetoOptimal properties: - candidate_id: + candidateId: 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 - unevaluatedProperties: {} - description: "What was mutated from the baseline (e.g., {system_prompt: 'new prompt'})." - avg_score: + additionalProperties: {} + description: "What was mutated from the baseline (e.g., {systemPrompt: 'new prompt'})." + avgScore: type: number format: double description: Average composite score across all tasks. - avg_tokens: + avgTokens: type: number format: double description: Average token usage across all tasks. - eval_id: + 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: type: string description: Foundry evaluation identifier used to score this candidate. - eval_run_id: + evalRunId: type: string description: Foundry evaluation run identifier for this candidate's scoring run. promotion: @@ -35225,115 +32031,17 @@ 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 - - created_at - - updated_at + - createdAt 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' @@ -35344,12 +32052,21 @@ components: - $ref: '#/components/schemas/OpenAI.Error' description: Error details — populated only on failure. readOnly: true - created_at: + result: + allOf: + - $ref: '#/components/schemas/OptimizationJobResult' + description: Result produced on success. + readOnly: true + inputs: + allOf: + - $ref: '#/components/schemas/OptimizationJobInputs' + description: Caller-supplied inputs. + createdAt: allOf: - $ref: '#/components/schemas/FoundryTimestamp' description: The timestamp when the job was created, represented in Unix time. readOnly: true - updated_at: + updatedAt: allOf: - $ref: '#/components/schemas/FoundryTimestamp' description: The timestamp when the job was last updated, represented in Unix time. @@ -35357,103 +32074,58 @@ components: progress: allOf: - $ref: '#/components/schemas/OptimizationJobProgress' - description: Progress snapshot. May be present in terminal states reflecting last-known progress. + description: Progress while in flight. Absent in terminal states. readOnly: true - warnings: - type: array - items: - type: string - description: Non-fatal warnings emitted at any point during optimization. + dataset: + allOf: + - $ref: '#/components/schemas/DatasetInfo' + description: Metadata about the dataset used for this optimization job. 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 - - train_dataset - - evaluators + - trainDatasetReference properties: agent: allOf: - - $ref: '#/components/schemas/OptimizationAgentIdentifier' + - $ref: '#/components/schemas/AgentIdentifier' description: The agent (and pinned version) being optimized. - train_dataset: + trainDatasetReference: allOf: - - $ref: '#/components/schemas/OptimizationDatasetInput' - description: Training dataset — either inline items or a reference to a registered dataset. Required. - validation_dataset: + - $ref: '#/components/schemas/DatasetRef' + description: Reference to a registered training dataset (required). + validationDatasetReference: allOf: - - $ref: '#/components/schemas/OptimizationDatasetInput' + - $ref: '#/components/schemas/DatasetRef' description: Optional held-out validation dataset for measuring generalization of the final candidate. evaluators: type: array items: - $ref: '#/components/schemas/OptimizationEvaluatorRef' - description: Job-level evaluators referenced by name and optional version. Required; at least one must be provided. + type: string + description: "Job-level evaluators (referenced by name). Per-task criteria may override. Default: ['task_adherence']." 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: - - candidates_completed - - best_score - - elapsed_seconds + - currentIteration + - bestScore + - elapsedSeconds properties: - candidates_completed: + currentIteration: type: integer format: int32 - description: Number of candidates whose evaluation has completed so far. - best_score: + description: 1-based current iteration index. + bestScore: type: number format: double description: Best score observed so far across all candidates. - elapsed_seconds: + elapsedSeconds: type: number format: double description: Wall-clock time elapsed in seconds since the job began executing. @@ -35462,61 +32134,106 @@ components: type: object properties: baseline: - type: string - description: Candidate ID of the original (un-optimized) baseline evaluation. + allOf: + - $ref: '#/components/schemas/OptimizationCandidate' + description: Evaluation scores for the original (un-optimized) agent configuration. best: - type: string - description: Candidate ID of the highest-scoring candidate found during optimization. + allOf: + - $ref: '#/components/schemas/OptimizationCandidate' + description: 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: - max_candidates: + maxIterations: type: integer format: int32 - minimum: 1 - description: 'Maximum number of optimization candidates to generate. Must be >= 1. Default: 5.' + description: 'Maximum optimization iterations per strategy. Must be >= 1. Default: 5.' default: 5 - optimization_config: + optimizationConfig: type: object - unevaluatedProperties: {} - description: Per-target-attribute configuration overrides. Contains skills, tools, system_prompt for the agent, plus model space for model optimization. - eval_model: + additionalProperties: {} + description: Per-target-attribute configuration overrides. Contains skills, tools, systemPrompt for the agent, plus model space for model optimization. + evalModel: type: string description: Model deployment used for evaluation. Defaults to server config (typically 'gpt-4o'). - optimization_model: + optimizationModel: type: string description: Model deployment for optimization reasoning (must be gpt-5 family). Falls back to the default eval model when not set. - evaluation_level: + evaluationLevel: 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. - OptimizationReferenceDatasetInput: + OptimizationTaskResult: type: object required: - - type - - name + - taskName + - scores + - compositeScore + - tokens + - durationSeconds + - passed properties: - type: + taskName: type: string - enum: - - reference - description: Dataset input type discriminator. - name: + description: Task name (from the dataset). + query: type: string - description: Registered dataset name. - version: + 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: string - description: Dataset version. If not specified, the latest version is used. - allOf: - - $ref: '#/components/schemas/OptimizationDatasetInput' - description: Reference to a registered Foundry dataset. + description: Error message if the task failed during execution. + rationales: + type: object + additionalProperties: + type: string + description: Per-evaluator reasoning keyed by evaluator name. + response: + type: string + description: Raw agent response text. + runId: + type: string + description: Identifier of the agent run that produced this result. + description: Per-task evaluation result for a single candidate. OtlpTelemetryEndpoint: type: object required: @@ -35532,14 +32249,12 @@ components: endpoint: type: string description: The OTLP collector endpoint URL. - examples: - - https://my-collector.example.com/otlp + example: https://my-collector.example.com/otlp protocol: allOf: - $ref: '#/components/schemas/TelemetryTransportProtocol' description: The transport protocol for the OTLP endpoint. - examples: - - Http + example: Http allOf: - $ref: '#/components/schemas/TelemetryEndpoint' description: An OTLP (OpenTelemetry Protocol) telemetry export endpoint. @@ -35801,21 +32516,60 @@ 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: - - promoted_at - - agent_name - - agent_version + - promotedAt + - agentName + - agentVersion properties: - promoted_at: + promotedAt: allOf: - $ref: '#/components/schemas/FoundryTimestamp' description: Timestamp when promotion occurred, represented in Unix time. - agent_name: + agentName: type: string description: Name of the Foundry agent this candidate was promoted to. - agent_version: + agentVersion: 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. @@ -35833,15 +32587,13 @@ components: type: string description: The model deployment to use for this agent. instructions: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true description: A system (or developer) message inserted into the model's context. temperature: - anyOf: - - type: number - format: float - - type: 'null' + type: number + format: float + nullable: true minimum: 0 maximum: 2 description: |- @@ -35849,10 +32601,9 @@ components: We generally recommend altering this or `top_p` but not both. Defaults to `1`. default: 1 top_p: - anyOf: - - type: number - format: float - - type: 'null' + type: number + format: float + nullable: true minimum: 0 maximum: 1 description: |- @@ -35863,9 +32614,10 @@ components: Defaults to `1`. default: 1 reasoning: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Reasoning' - - type: 'null' + nullable: true tools: type: array items: @@ -35886,7 +32638,7 @@ components: description: Configuration options for a text response from the model. Can be plain text or structured JSON data. structured_inputs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/StructuredInputDefinition' description: Set of structured inputs that can participate in prompt template substitution or tool argument bindings. allOf: @@ -36061,7 +32813,7 @@ components: description: List of attack strategies or nested lists of attack strategies. simulationOnly: type: boolean - 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. + description: Simulation-only or Simulation + Evaluation. Default false, if true the scan outputs conversation not evaluation result. default: false riskCategories: type: array @@ -36073,12 +32825,12 @@ components: description: Application scenario for the red team operation, to generate scenario specific attacks. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Red team's tags. Unlike properties, tags are fully mutable. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. status: @@ -36230,7 +32982,7 @@ components: description: The maximum number of turns of chat history to evaluate. data_mapping: type: object - unevaluatedProperties: + additionalProperties: type: string description: Mapping from source fields to response_id field, required for retrieving chat history. source: @@ -36260,7 +33012,10 @@ components: Routine: type: object required: + - name - enabled + - triggers + - action properties: name: type: string @@ -36275,7 +33030,7 @@ components: description: Whether the routine is enabled. triggers: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/RoutineTrigger' description: The triggers configured for the routine. action: @@ -36339,6 +33094,9 @@ components: - Routines=V1Preview RoutineCreateOrUpdateRequest: type: object + required: + - triggers + - action properties: description: type: string @@ -36349,7 +33107,7 @@ components: description: Whether the routine is enabled. triggers: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/RoutineTrigger' description: The triggers configured for the routine. In v1, exactly one trigger entry is supported. action: @@ -36393,15 +33151,16 @@ components: type: object required: - id + - status + - trigger_type + - started_at properties: id: type: string - description: The unique run identifier for the routine attempt. - readOnly: true + description: The MLflow run identifier for the routine attempt. status: - allOf: - - $ref: '#/components/schemas/RoutineRunStatus' - description: The run status. + type: string + description: The underlying MLflow run status. phase: allOf: - $ref: '#/components/schemas/RoutineRunPhase' @@ -36410,9 +33169,6 @@ 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' @@ -36421,26 +33177,10 @@ 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' @@ -36461,20 +33201,47 @@ 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 @@ -36488,12 +33255,6 @@ 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: @@ -36508,8 +33269,7 @@ components: mapping: schedule: '#/components/schemas/ScheduleRoutineTrigger' timer: '#/components/schemas/TimerRoutineTrigger' - github_issue: '#/components/schemas/GitHubIssueRoutineTrigger' - custom: '#/components/schemas/CustomRoutineTrigger' + github_issue_opened: '#/components/schemas/GitHubIssueOpenedRoutineTrigger' description: Base model for a routine trigger. x-ms-foundry-meta: conditional_previews: @@ -36519,8 +33279,7 @@ components: - type: string - type: string enum: - - custom - - github_issue + - github_issue_opened - schedule - timer description: The discriminator values supported for routine triggers. @@ -36631,17 +33390,17 @@ components: description: Task for the schedule. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Schedule's tags. Unlike properties, tags are fully mutable. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Schedule's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. systemData: type: object - unevaluatedProperties: + additionalProperties: type: string description: System metadata for the resource. readOnly: true @@ -36709,7 +33468,7 @@ components: readOnly: true properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Properties of the schedule run. readOnly: true @@ -36725,7 +33484,7 @@ components: description: Type of the task. configuration: type: object - unevaluatedProperties: + additionalProperties: type: string description: Configuration for the task. discriminator: @@ -36769,19 +33528,9 @@ 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. @@ -36790,6 +33539,7 @@ components: items: $ref: '#/components/schemas/SessionDirectoryEntry' description: The directory entries. + description: Response from listing a directory in a session sandbox. SessionFileWriteResponse: type: object required: @@ -36814,13 +33564,11 @@ 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. - examples: - - log + example: log data: type: string description: The event payload as plain text. Currently JSON-formatted but the schema is not contractual and may change. - examples: - - '{"timestamp":"2026-03-10T09:33:17.121467567+00:00","stream":"stdout","message":"Starting server on port 18080"}' + example: '{"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. @@ -37022,7 +33770,7 @@ components: description: Environment requirements or compatibility notes for the skill. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Arbitrary key-value metadata for additional properties. allowed_tools: @@ -37104,11 +33852,11 @@ components: description: The default value for the input if no run-time value is provided. schema: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The JSON schema for the structured input (optional). required: type: boolean - 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. + description: Whether the input property is required when the agent is invoked. Defaults to `false`. default: false description: An structured input that can participate in prompt template substitutions and tool argument binding. StructuredOutputDefinition: @@ -37127,12 +33875,11 @@ components: description: A description of the output to emit. Used by the model to determine when to emit the output. schema: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The JSON schema for the structured output. strict: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true description: Whether to enforce strict validation. Default `true`. description: A structured output that can be produced by the agent. StructuredOutputsOutputItem: @@ -37320,7 +34067,7 @@ components: description: List of taxonomy sub categories. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Additional properties for the taxonomy category. description: Taxonomy category definition. @@ -37345,7 +34092,7 @@ components: description: List of taxonomy items under this sub-category. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Additional properties for the taxonomy sub-category. description: Taxonomy sub-category definition. @@ -37392,10 +34139,10 @@ components: items: $ref: '#/components/schemas/TelemetryDataKind' description: Data types to export to this endpoint. Use an empty array to export no data. - examples: - - - ContainerStdoutStderr - - ContainerOtel - - Metrics + example: + - ContainerStdoutStderr + - ContainerOtel + - Metrics auth: allOf: - $ref: '#/components/schemas/TelemetryEndpointAuth' @@ -37479,11 +34226,10 @@ 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 - unevaluatedProperties: + additionalProperties: 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. @@ -37492,6 +34238,7 @@ components: type: object required: - type + - at properties: type: type: string @@ -37499,9 +34246,11 @@ components: - timer description: The trigger type. at: - allOf: - - $ref: '#/components/schemas/FoundryTimestamp' - description: The UTC date and time at which the timer fires. + 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/RoutineTrigger' description: A one-shot timer routine trigger. @@ -37511,7 +34260,7 @@ components: ToolCallOutputContent: anyOf: - type: object - unevaluatedProperties: {} + additionalProperties: {} - type: string - type: array items: {} @@ -37661,7 +34410,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -37706,11 +34455,10 @@ components: - tools properties: metadata: - anyOf: - - type: object - unevaluatedProperties: - type: string - - type: 'null' + type: object + additionalProperties: + type: string + 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 @@ -37971,7 +34719,7 @@ components: properties: metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -37990,7 +34738,7 @@ components: description: The manifest ID to import the agent version from. parameter_values: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The inputs to the manifest that will result in a fully materialized Agent. UpdateAgentRequest: type: object @@ -37999,7 +34747,7 @@ components: properties: metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -38036,12 +34784,13 @@ components: name: type: string metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -38054,7 +34803,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: 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. @@ -38201,13 +34950,15 @@ components: enum: - web_search filters: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.WebSearchToolFilters' - - type: 'null' + nullable: true user_location: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.WebSearchApproximateLocation' - - type: 'null' + nullable: true search_context_size: type: string enum: 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 48707aec53d4..9206381b031b 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,223 +1,93 @@ { - "openapi": "3.2.0", + "openapi": "3.0.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", - "parent": "Agents Root", - "description": "Agent Management" - }, - { - "name": "Agent Invocations", - "parent": "Agents Root" - }, - { - "name": "Agent Invocations WebSocket", - "parent": "Agents Root", - "description": "Agent Invocations (WebSocket)" + "name": "Agents" }, { - "name": "Agent Sessions", - "parent": "Agents Root" + "name": "Agent Containers" }, { - "name": "Agent Session Files", - "parent": "Agents Root" + "name": "Agent Session Files" }, { - "name": "Agent Versions", - "parent": "Agents Root" + "name": "Agent Invocations" }, { - "name": "Agent Containers", - "parent": "Agents Root" + "name": "Agent Invocations WebSocket" }, { - "name": "Platform APIs" + "name": "Connections" }, { - "name": "Datasets", - "parent": "Platform APIs" + "name": "Datasets" }, { - "name": "Indexes", - "parent": "Platform APIs" + "name": "Deployments" }, { - "name": "Connections", - "parent": "Platform APIs" + "name": "Evaluation Taxonomies" }, { - "name": "Scheduler", - "parent": "Platform APIs" + "name": "Evaluation Rules" }, { - "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": "EvaluationSuiteGenerationJobs" }, { - "name": "Videos", - "parent": "Platform APIs" + "name": "Evaluators" }, { - "name": "Routines", - "parent": "Platform APIs" + "name": "EvaluatorGenerationJobs" }, { - "name": "Schedules", - "parent": "Platform APIs" + "name": "Indexes" }, { - "name": "Skills", - "parent": "Platform APIs" + "name": "Insights" }, { - "name": "Toolboxes", - "parent": "Platform APIs" + "name": "Models" }, { - "name": "Deployments", - "parent": "Platform APIs" + "name": "Memory Stores" }, { - "name": "DataGenerationJobs", - "parent": "Platform APIs", - "summary": "Data generation jobs" + "name": "Conversations" }, { - "name": "AgentOptimizationJobs", - "parent": "Platform APIs", - "summary": "Agent optimization jobs" + "name": "Evals" }, { - "name": "EvaluatorGenerationJobs", - "parent": "Platform APIs", - "summary": "Evaluator generation jobs" + "name": "Fine-Tuning" }, { - "name": "Evaluations" + "name": "Responses" }, { - "name": "Evals", - "parent": "Evaluations" + "name": "Redteams" }, { - "name": "Evaluation Rules", - "parent": "Evaluations" + "name": "Routines" }, { - "name": "Evaluators", - "parent": "Evaluations" + "name": "Schedules" }, { - "name": "Evaluation Taxonomies", - "parent": "Evaluations" + "name": "Skills" }, { - "name": "Redteams", - "parent": "Evaluations", - "summary": "Red Teaming" + "name": "Toolboxes" }, { - "name": "Evalsuite", - "parent": "Evaluations" + "name": "DataGenerationJobs" }, { - "name": "Insights", - "parent": "Evaluations" + "name": "AgentOptimizationJobs" } ], "paths": { @@ -235,7 +105,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V2Preview" + "AgentsOptimization=V1Preview" ] } }, @@ -286,18 +156,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -315,22 +175,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OptimizationJob" + "$ref": "#/components/schemas/OptimizationJobInputs" } } }, - "description": "The job to create." + "description": "The optimization job inputs." }, "x-ms-foundry-meta": { "conditional_previews": [ - "AgentsOptimization=V2Preview" + "AgentsOptimization=V1Preview" ] } }, "get": { "operationId": "AgentOptimizationJobs_list", "summary": "Returns a list of agent optimization jobs.", - "description": "List optimization jobs. Supports cursor pagination and optional status / agent_name filters.", + "description": "List optimization jobs. Supports cursor pagination and optional status / agentName filters.", "parameters": [ { "name": "Foundry-Features", @@ -340,7 +200,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V2Preview" + "AgentsOptimization=V1Preview" ] } }, @@ -397,7 +257,7 @@ "explode": false }, { - "name": "agent_name", + "name": "agentName", "in": "query", "required": false, "description": "Filter to jobs targeting this agent name.", @@ -432,7 +292,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OptimizationJobListItem" + "$ref": "#/components/schemas/OptimizationJob" }, "description": "The requested list of items." }, @@ -454,18 +314,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -480,7 +330,7 @@ ], "x-ms-foundry-meta": { "conditional_previews": [ - "AgentsOptimization=V2Preview" + "AgentsOptimization=V1Preview" ] } } @@ -489,7 +339,7 @@ "get": { "operationId": "AgentOptimizationJobs_get", "summary": "Get info about an agent optimization job.", - "description": "Get an optimization job by id.", + "description": "Get an optimization job by id. Returns 202 while in progress, 200 when terminal.", "parameters": [ { "name": "Foundry-Features", @@ -499,7 +349,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V2Preview" + "AgentsOptimization=V1Preview" ] } }, @@ -529,7 +379,6 @@ "headers": { "Retry-After": { "required": false, - "description": "Recommended number of seconds to wait before polling again.", "schema": { "type": "integer", "format": "int32" @@ -544,18 +393,27 @@ } } }, - "4XX": { - "description": "Client error", + "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" + } + } + }, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" + "$ref": "#/components/schemas/OptimizationJob" } } } }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -570,7 +428,7 @@ ], "x-ms-foundry-meta": { "conditional_previews": [ - "AgentsOptimization=V2Preview" + "AgentsOptimization=V1Preview" ] } }, @@ -587,7 +445,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V2Preview" + "AgentsOptimization=V1Preview" ] } }, @@ -600,6 +458,16 @@ "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", @@ -615,18 +483,8 @@ "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", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -641,16 +499,16 @@ ], "x-ms-foundry-meta": { "conditional_previews": [ - "AgentsOptimization=V2Preview" + "AgentsOptimization=V1Preview" ] } } }, - "/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.", + "/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", @@ -660,7 +518,7 @@ "schema": { "type": "string", "enum": [ - "AgentsOptimization=V2Preview" + "AgentsOptimization=V1Preview" ] } }, @@ -668,187 +526,11 @@ "name": "jobId", "in": "path", "required": true, - "description": "The ID of the job to cancel.", + "description": "The optimization job 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/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", @@ -917,7 +599,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AgentObject" + "$ref": "#/components/schemas/OptimizationCandidate" }, "description": "The requested list of items." }, @@ -939,8 +621,87 @@ } } }, - "4XX": { - "description": "Client error", + "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": { @@ -948,9 +709,627 @@ } } } + } + }, + "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" + } + } + } }, - "5XX": { - "description": "Server error", + "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.", "content": { "application/json": { "schema": { @@ -968,7 +1347,6 @@ "/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": [ { @@ -1067,18 +1445,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -1101,8 +1469,7 @@ "/agents/{agent_name}": { "get": { "operationId": "Agents_getAgent", - "summary": "Get an agent", - "description": "Retrieves an agent definition by its unique name.", + "description": "Retrieves the agent.", "parameters": [ { "name": "agent_name", @@ -1135,18 +1502,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -1202,7 +1559,6 @@ } ], "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.", @@ -1214,18 +1570,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -1235,8 +1581,6 @@ } } }, - "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" @@ -1268,7 +1612,6 @@ }, "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": [ { @@ -1284,7 +1627,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. The service defaults to `false` if a value is not specified by the caller. 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. Defaults to `false`. This value is not relevant for other Agent types.", "schema": { "type": "boolean", "default": false @@ -1313,18 +1656,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -1340,8 +1673,7 @@ }, "patch": { "operationId": "Agents_patchAgentObject", - "summary": "Update an agent endpoint", - "description": "Applies a merge-patch update to the specified agent endpoint configuration.", + "description": "Updates an agent endpoint.", "parameters": [ { "name": "Foundry-Features", @@ -1361,8 +1693,7 @@ "required": true, "description": "The name of the agent to retrieve.", "schema": { - "type": "string", - "title": "The name of the agent to retrieve" + "type": "string" } }, { @@ -1387,18 +1718,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -1431,8 +1752,7 @@ "/agents/{agent_name}/code:download": { "get": { "operationId": "Agents_downloadAgentCode", - "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`.", + "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`.", "parameters": [ { "name": "Foundry-Features", @@ -1491,23 +1811,14 @@ "content": { "application/zip": { "schema": { - "contentMediaType": "application/zip" - } - } - } - }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" + "type": "string", + "format": "binary" } } } }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -1530,7 +1841,6 @@ "/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": [ { @@ -1609,18 +1919,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -1652,7 +1952,6 @@ "/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": [ { @@ -1694,23 +1993,13 @@ "application/json": { "schema": { "type": "object", - "unevaluatedProperties": {} - } - } - } - }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" + "additionalProperties": {} } } } }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -1733,7 +2022,6 @@ "/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": [ { @@ -1804,18 +2092,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -1838,7 +2116,6 @@ "/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": [ { @@ -1909,18 +2186,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -1952,7 +2219,6 @@ "/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": [ { @@ -2007,18 +2273,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -2029,7 +2285,7 @@ } }, "tags": [ - "Agent Sessions" + "Agents" ], "requestBody": { "required": true, @@ -2049,8 +2305,7 @@ }, "get": { "operationId": "Agents_listSessions", - "summary": "List sessions for an agent", - "description": "Returns a paged collection of sessions associated with the specified agent endpoint.", + "description": "Returns a list of sessions for the specified agent.", "parameters": [ { "name": "Foundry-Features", @@ -2172,18 +2427,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -2194,7 +2439,7 @@ } }, "tags": [ - "Agent Sessions" + "Agents" ], "x-ms-foundry-meta": { "required_previews": [ @@ -2206,8 +2451,7 @@ "/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.\nThe response includes only the immediate children of the target directory and defaults to the session home directory when no path is supplied.", + "description": "List files and directories at a given path in the session sandbox.\nReturns only the immediate children of the specified directory (non-recursive).", "parameters": [ { "name": "Foundry-Features", @@ -2242,8 +2486,8 @@ { "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.", + "required": true, + "description": "The directory path to list, relative to the session home directory.", "schema": { "type": "string" }, @@ -2258,48 +2502,6 @@ "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", @@ -2322,18 +2524,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -2354,8 +2546,7 @@ }, "delete": { "operationId": "AgentSessionFiles_deleteSessionFile", - "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.", + "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.", "parameters": [ { "name": "Foundry-Features", @@ -2401,7 +2592,7 @@ "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.", + "description": "Whether to recursively delete directory contents. Defaults to false.", "schema": { "type": "boolean", "default": false @@ -2432,18 +2623,8 @@ "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", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -2466,8 +2647,7 @@ "/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.\nThe service stores the file relative to the session home directory and rejects payloads larger than 50 MB.", + "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.", "parameters": [ { "name": "Foundry-Features", @@ -2540,18 +2720,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -2569,7 +2739,8 @@ "content": { "application/octet-stream": { "schema": { - "contentMediaType": "application/octet-stream" + "type": "string", + "format": "binary" } } } @@ -2582,8 +2753,7 @@ }, "get": { "operationId": "AgentSessionFiles_downloadSessionFile", - "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.", + "description": "Download a file from the session sandbox as a binary stream.", "parameters": [ { "name": "Foundry-Features", @@ -2651,23 +2821,14 @@ "content": { "application/octet-stream": { "schema": { - "contentMediaType": "application/octet-stream" - } - } - } - }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" + "type": "string", + "format": "binary" } } } }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -2690,8 +2851,7 @@ "/agents/{agent_name}/endpoint/sessions/{session_id}": { "get": { "operationId": "Agents_getSession", - "summary": "Get a session", - "description": "Retrieves the details of a hosted agent session by agent name and session identifier.", + "description": "Retrieves a session by ID.", "parameters": [ { "name": "Foundry-Features", @@ -2754,18 +2914,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -2776,7 +2926,7 @@ } }, "tags": [ - "Agent Sessions" + "Agents" ], "x-ms-foundry-meta": { "required_previews": [ @@ -2786,7 +2936,6 @@ }, "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": [ { @@ -2843,18 +2992,8 @@ "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", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -2865,7 +3004,7 @@ } }, "tags": [ - "Agent Sessions" + "Agents" ], "x-ms-foundry-meta": { "required_previews": [ @@ -2877,8 +3016,7 @@ "/agents/{agent_name}/endpoint/sessions/{session_id}:stop": { "post": { "operationId": "Agents_stopSession", - "summary": "Stop a session", - "description": "Terminates the specified hosted agent session and returns 204 No Content when the request succeeds.", + "description": "Stops a session.\nReturns 204 No Content when the stop succeeds.", "parameters": [ { "name": "Foundry-Features", @@ -2925,18 +3063,8 @@ "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", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -2947,7 +3075,7 @@ } }, "tags": [ - "Agent Sessions" + "Agents" ], "x-ms-foundry-meta": { "required_previews": [ @@ -2959,7 +3087,6 @@ "/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": [ { @@ -2993,18 +3120,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -3032,8 +3149,7 @@ "/agents/{agent_name}/operations": { "get": { "operationId": "AgentContainers_listAgentContainerOperations", - "summary": "List agent container operations", - "description": "Returns container operations recorded for the specified agent across its container lifecycle.", + "description": "List container operations for an agent.", "parameters": [ { "name": "Foundry-Features", @@ -3146,18 +3262,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -3180,8 +3286,7 @@ "/agents/{agent_name}/operations/{operation_id}": { "get": { "operationId": "AgentContainers_getAgentContainerOperation", - "summary": "Get an agent container operation", - "description": "Retrieves the status and details of the specified container operation for an agent.", + "description": "Get the status of a container operation for an agent.", "parameters": [ { "name": "Foundry-Features", @@ -3235,18 +3340,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -3309,8 +3404,7 @@ } } ], - "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", + "description": "Create a new agent version.", "responses": { "200": { "description": "The request has succeeded.", @@ -3322,18 +3416,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -3343,15 +3427,13 @@ } } }, - "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": [ - "Agent Versions" + "Agents" ], "requestBody": { "required": true, @@ -3376,8 +3458,7 @@ }, "get": { "operationId": "Agents_listAgentVersions", - "summary": "List agent versions", - "description": "Returns a paged collection of versions for the specified agent.", + "description": "Returns the list of versions of an agent.", "parameters": [ { "name": "agent_name", @@ -3478,18 +3559,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -3500,15 +3571,14 @@ } }, "tags": [ - "Agent Versions" + "Agents" ] } }, "/agents/{agent_name}/versions/{agent_version}": { "get": { "operationId": "Agents_getAgentVersion", - "summary": "Get an agent version", - "description": "Retrieves the specified version of an agent by its agent name and version identifier.", + "description": "Retrieves a specific version of an agent.", "parameters": [ { "name": "agent_name", @@ -3550,18 +3620,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -3572,12 +3632,11 @@ } }, "tags": [ - "Agent Versions" + "Agents" ] }, "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": [ { @@ -3602,7 +3661,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. The service defaults to `false` if a value is not specified by the caller. 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. Defaults to `false`. This value is not relevant for other Agent types.", "schema": { "type": "boolean", "default": false @@ -3631,18 +3690,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -3653,15 +3702,14 @@ } }, "tags": [ - "Agent Versions" + "Agents" ] } }, "/agents/{agent_name}/versions/{agent_version}/containers/default": { "get": { "operationId": "AgentContainers_getAgentContainer", - "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.", + "description": "Get a container for a specific version of an agent.", "parameters": [ { "name": "Foundry-Features", @@ -3715,18 +3763,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -3749,8 +3787,7 @@ "/agents/{agent_name}/versions/{agent_version}/containers/default/operations": { "get": { "operationId": "AgentContainers_listAgentVersionContainerOperations", - "summary": "List agent version container operations", - "description": "Returns container operations for the default container of the specified agent version.", + "description": "List container operations for a specific version of an agent.", "parameters": [ { "name": "Foundry-Features", @@ -3872,18 +3909,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -3906,8 +3933,7 @@ "/agents/{agent_name}/versions/{agent_version}/containers/default:delete": { "post": { "operationId": "AgentContainers_deleteAgentContainer", - "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.", + "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", "parameters": [ { "name": "Foundry-Features", @@ -3970,18 +3996,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -4004,8 +4020,7 @@ "/agents/{agent_name}/versions/{agent_version}/containers/default:logstream": { "post": { "operationId": "AgentContainers_streamAgentContainerLogs", - "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.", + "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", "parameters": [ { "name": "Foundry-Features", @@ -4083,18 +4098,8 @@ "200": { "description": "The request has succeeded." }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -4117,8 +4122,7 @@ "/agents/{agent_name}/versions/{agent_version}/containers/default:start": { "post": { "operationId": "AgentContainers_startAgentContainer", - "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.", + "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", "parameters": [ { "name": "Foundry-Features", @@ -4181,18 +4185,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -4239,8 +4233,7 @@ "/agents/{agent_name}/versions/{agent_version}/containers/default:stop": { "post": { "operationId": "AgentContainers_stopAgentContainer", - "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.", + "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", "parameters": [ { "name": "Foundry-Features", @@ -4303,18 +4296,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -4337,8 +4320,7 @@ "/agents/{agent_name}/versions/{agent_version}/containers/default:update": { "post": { "operationId": "AgentContainers_updateAgentContainer", - "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.", + "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", "parameters": [ { "name": "Foundry-Features", @@ -4401,18 +4383,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -4457,7 +4429,6 @@ "/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": [ { @@ -4521,18 +4492,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -4543,7 +4504,7 @@ } }, "tags": [ - "Agent Sessions" + "Agents" ], "x-ms-foundry-meta": { "required_previews": [ @@ -4555,8 +4516,7 @@ "/agents/{agent_name}/versions:import": { "post": { "operationId": "Agents_createAgentVersionFromManifest", - "summary": "Create an agent version from manifest", - "description": "Imports the provided manifest to create a new version for the specified agent.", + "description": "Create a new agent version from a manifest.", "parameters": [ { "name": "agent_name", @@ -4590,18 +4550,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -4612,7 +4562,7 @@ } }, "tags": [ - "Agent Versions" + "Agents" ], "requestBody": { "required": true, @@ -4629,8 +4579,7 @@ "/agents:import": { "post": { "operationId": "Agents_createAgentFromManifest", - "summary": "Create an agent from a manifest", - "description": "Imports the provided manifest to create an agent and returns the created resource.", + "description": "Creates an agent from a manifest.", "parameters": [ { "name": "api-version", @@ -4654,18 +4603,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -4693,8 +4632,7 @@ "/connections": { "get": { "operationId": "Connections_list", - "summary": "List connections", - "description": "Returns the connections available in the current project, optionally filtered by type or default status.", + "description": "List all connections in the project, without populating connection credentials", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -4703,7 +4641,7 @@ "name": "connectionType", "in": "query", "required": false, - "description": "Lists connections of this specific type", + "description": "List connections of this specific type", "schema": { "$ref": "#/components/schemas/ConnectionType" }, @@ -4713,7 +4651,7 @@ "name": "defaultConnection", "in": "query", "required": false, - "description": "Lists connections that are default connections", + "description": "List connections that are default connections", "schema": { "type": "boolean" }, @@ -4743,27 +4681,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -4790,8 +4709,7 @@ "/connections/{name}": { "get": { "operationId": "Connections_get", - "summary": "Get a connection", - "description": "Retrieves the specified connection and its configuration details without including credential values.", + "description": "Get a connection by name, without populating connection credentials", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -4829,27 +4747,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -4876,8 +4775,7 @@ "/connections/{name}/getConnectionWithCredentials": { "post": { "operationId": "Connections_getWithCredentials", - "summary": "Get a connection with credentials", - "description": "Retrieves the specified connection together with its credential values.", + "description": "Get a connection by name, with its connection credentials", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -4915,27 +4813,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -4962,7 +4841,7 @@ "/data_generation_jobs": { "get": { "operationId": "DataGenerationJobs_list", - "summary": "List data generation jobs", + "summary": "Returns a list of data generation jobs", "description": "Returns a list of data generation jobs.", "parameters": [ { @@ -5067,18 +4946,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -5099,8 +4968,8 @@ }, "post": { "operationId": "DataGenerationJobs_create", - "summary": "Create a data generation job", - "description": "Submits a new data generation job for asynchronous execution.", + "summary": "Creates a data generation job.", + "description": "Creates a data generation job.", "parameters": [ { "name": "Foundry-Features", @@ -5161,18 +5030,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -5206,8 +5065,8 @@ "/data_generation_jobs/{jobId}": { "get": { "operationId": "DataGenerationJobs_get", - "summary": "Get a data generation job", - "description": "Retrieves the specified data generation job and its current status.", + "summary": "Get info about a data generation job.", + "description": "Gets the details of a data generation job by its ID.", "parameters": [ { "name": "Foundry-Features", @@ -5262,18 +5121,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -5294,8 +5143,8 @@ }, "delete": { "operationId": "DataGenerationJobs_delete", - "summary": "Delete a data generation job", - "description": "Removes the specified data generation job and its associated output.", + "summary": "Deletes a data generation job.", + "description": "Deletes a data generation job by its ID.", "parameters": [ { "name": "Foundry-Features", @@ -5333,18 +5182,8 @@ "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", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -5367,8 +5206,8 @@ "/data_generation_jobs/{jobId}:cancel": { "post": { "operationId": "DataGenerationJobs_cancel", - "summary": "Cancel a data generation job", - "description": "Cancels the specified data generation job if it is still in progress.", + "summary": "Cancels a data generation job.", + "description": "Cancels a data generation job by its ID.", "parameters": [ { "name": "Foundry-Features", @@ -5413,18 +5252,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -5447,7 +5276,6 @@ "/datasets": { "get": { "operationId": "Datasets_listLatest", - "summary": "List latest versions", "description": "List the latest version of each DatasetVersion", "parameters": [ { @@ -5465,27 +5293,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -5512,7 +5321,6 @@ "/datasets/{name}/versions": { "get": { "operationId": "Datasets_listVersions", - "summary": "List versions", "description": "List all versions of the given DatasetVersion", "parameters": [ { @@ -5539,27 +5347,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -5586,7 +5375,6 @@ "/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": [ { @@ -5622,27 +5410,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -5667,7 +5436,6 @@ }, "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": [ { @@ -5696,27 +5464,8 @@ "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -5741,7 +5490,6 @@ }, "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": [ { @@ -5787,27 +5535,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -5845,8 +5574,7 @@ "/datasets/{name}/versions/{version}/credentials": { "post": { "operationId": "Datasets_getCredentials", - "summary": "Get dataset credentials", - "description": "Gets the SAS credential to access the storage account associated with a Dataset version.", + "description": "Get the SAS credential to access the storage account associated with a Dataset version.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -5881,27 +5609,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -5928,8 +5637,7 @@ "/datasets/{name}/versions/{version}/startPendingUpload": { "post": { "operationId": "Datasets_startPendingUploadVersion", - "summary": "Start a pending upload", - "description": "Initiates a new pending upload or retrieves an existing one for the specified dataset version.", + "description": "Start a new or get an existing pending upload of a dataset for a specific version.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -5964,27 +5672,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -6022,8 +5711,7 @@ "/deployments": { "get": { "operationId": "Deployments_list", - "summary": "List deployments", - "description": "Returns the deployed models available in the current project, optionally filtered by publisher, model name, or deployment type.", + "description": "List all deployed models in the project", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -6082,27 +5770,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -6129,8 +5798,7 @@ "/deployments/{name}": { "get": { "operationId": "Deployments_get", - "summary": "Get a deployment", - "description": "Gets a deployed model.", + "description": "Get a deployed model.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -6168,27 +5836,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -6215,7 +5864,7 @@ "/evaluation_suite_generation_jobs": { "post": { "operationId": "EvaluationSuiteGenerationJobs_create", - "summary": "Create an evaluation suite generation job", + "summary": "Creates an evaluation suite generation job.", "description": "Create a new job (preview). Includes optional Foundry-Features header and Operation-Id for idempotent retries.", "parameters": [ { @@ -6277,18 +5926,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -6320,7 +5959,7 @@ }, "get": { "operationId": "EvaluationSuiteGenerationJobs_list", - "summary": "List evaluation suite generation jobs", + "summary": "Returns a list of evaluation suite generation jobs.", "description": "List jobs with cursor-based pagination (preview). Includes optional Foundry-Features header.", "parameters": [ { @@ -6425,18 +6064,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -6459,7 +6088,7 @@ "/evaluation_suite_generation_jobs/{jobId}": { "get": { "operationId": "EvaluationSuiteGenerationJobs_get", - "summary": "Get an evaluation suite generation job", + "summary": "Get info about an evaluation suite generation job.", "description": "Get a job by ID (preview). Includes optional Foundry-Features header.", "parameters": [ { @@ -6515,18 +6144,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -6547,7 +6166,7 @@ }, "delete": { "operationId": "EvaluationSuiteGenerationJobs_delete", - "summary": "Delete an evaluation suite generation job", + "summary": "Deletes an evaluation suite generation job.", "description": "Delete a job (preview). Returns 204 No Content.", "parameters": [ { @@ -6586,18 +6205,8 @@ "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", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -6620,7 +6229,7 @@ "/evaluation_suite_generation_jobs/{jobId}:cancel": { "post": { "operationId": "EvaluationSuiteGenerationJobs_cancel", - "summary": "Cancel an evaluation suite generation job", + "summary": "Cancels an evaluation suite generation job.", "description": "Cancel a running job (preview). Returns 200 with the updated job.", "parameters": [ { @@ -6666,18 +6275,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -6700,7 +6299,6 @@ "/evaluation_suites": { "get": { "operationId": "EvaluationSuites_listLatest", - "summary": "List latest versions", "description": "List the latest version of each EvaluationSuiteVersion", "parameters": [ { @@ -6728,27 +6326,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -6772,7 +6351,6 @@ "/evaluation_suites/{name}/versions": { "get": { "operationId": "EvaluationSuites_listVersions", - "summary": "List versions", "description": "List all versions of the given EvaluationSuiteVersion", "parameters": [ { @@ -6799,27 +6377,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -6841,7 +6400,6 @@ }, "post": { "operationId": "EvaluationSuites_createEvaluationSuiteVersion", - "summary": "Create an evaluation suite version", "description": "Create a new EvaluationSuiteVersion with auto incremented version id", "parameters": [ { @@ -6887,18 +6445,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -6929,7 +6477,6 @@ "/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": [ { @@ -6965,27 +6512,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -7007,7 +6535,6 @@ }, "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": [ { @@ -7036,27 +6563,8 @@ "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -7078,7 +6586,6 @@ }, "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": [ { @@ -7124,27 +6631,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -7179,8 +6667,7 @@ "/evaluation_suites/{name}:run": { "post": { "operationId": "EvaluationSuites_run", - "summary": "Run an evaluation suite", - "description": "Runs an evaluation using the suite's testing criteria and dataset.", + "description": "Run an evaluation using the suite's testing criteria and dataset.", "parameters": [ { "name": "Foundry-Features", @@ -7225,18 +6712,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -7267,8 +6744,7 @@ "/evaluationrules": { "get": { "operationId": "EvaluationRules_list", - "summary": "List evaluation rules", - "description": "Returns the evaluation rules configured for the project, optionally filtered by action type, agent name, or enabled state.", + "description": "List all evaluation rules.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -7315,27 +6791,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -7362,8 +6819,7 @@ "/evaluationrules/{id}": { "get": { "operationId": "EvaluationRules_get", - "summary": "Get an evaluation rule", - "description": "Retrieves the specified evaluation rule and its configuration.", + "description": "Get an evaluation rule.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -7389,27 +6845,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -7434,8 +6871,7 @@ }, "delete": { "operationId": "EvaluationRules_delete", - "summary": "Delete an evaluation rule", - "description": "Removes the specified evaluation rule from the project.", + "description": "Delete an evaluation rule.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -7454,27 +6890,8 @@ "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -7499,8 +6916,7 @@ }, "put": { "operationId": "EvaluationRules_createOrUpdate", - "summary": "Create or update an evaluation rule", - "description": "Creates a new evaluation rule, or replaces the existing rule when the identifier matches.", + "description": "Create or update an evaluation rule.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -7548,27 +6964,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -7606,8 +7003,7 @@ "/evaluations/runs": { "get": { "operationId": "Evaluations_list", - "summary": "List evaluation runs", - "description": "Returns the evaluation runs available in the current project.", + "description": "List evaluation runs", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -7636,27 +7032,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -7680,8 +7057,7 @@ "/evaluations/runs/{name}": { "get": { "operationId": "Evaluations_get", - "summary": "Get an evaluation run", - "description": "Retrieves the specified evaluation run and its current status.", + "description": "Get an evaluation run by name.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -7719,27 +7095,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -7761,8 +7118,7 @@ }, "delete": { "operationId": "Evaluations_delete", - "summary": "Delete an evaluation run", - "description": "Removes the specified evaluation run from the project.", + "description": "Delete an evaluation run by name", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -7793,27 +7149,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -7837,8 +7174,7 @@ "/evaluations/runs/{name}:cancel": { "post": { "operationId": "Evaluations_cancel", - "summary": "Cancel an evaluation run", - "description": "Cancels the specified evaluation run before it completes.", + "description": "Cancel an evaluation run by name", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -7869,27 +7205,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -7913,8 +7230,7 @@ "/evaluations/runs:run": { "post": { "operationId": "Evaluations_create", - "summary": "Create an evaluation run", - "description": "Submits a new evaluation run with the provided configuration.", + "description": "Creates an evaluation run.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -7931,27 +7247,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -7986,8 +7283,7 @@ "/evaluations/runs:runAgent": { "post": { "operationId": "Evaluations_createAgentEvaluation", - "summary": "Create an agent evaluation run", - "description": "Submits a new agent evaluation run with the provided request.", + "description": "Creates an agent evaluation run.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -8004,27 +7300,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -8059,8 +7336,7 @@ "/evaluationtaxonomies": { "get": { "operationId": "EvaluationTaxonomies_list", - "summary": "List evaluation taxonomies", - "description": "Returns the evaluation taxonomies available in the project, optionally filtered by input name or input type.", + "description": "List evaluation taxonomies", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -8109,27 +7385,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -8156,8 +7413,7 @@ "/evaluationtaxonomies/{name}": { "get": { "operationId": "EvaluationTaxonomies_get", - "summary": "Get an evaluation taxonomy", - "description": "Retrieves the specified evaluation taxonomy.", + "description": "Get an evaluation run by name.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -8195,27 +7451,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -8240,8 +7477,7 @@ }, "delete": { "operationId": "EvaluationTaxonomies_delete", - "summary": "Delete an evaluation taxonomy", - "description": "Removes the specified evaluation taxonomy from the project.", + "description": "Delete an evaluation taxonomy by name.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -8272,27 +7508,8 @@ "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -8317,113 +7534,7 @@ }, "put": { "operationId": "EvaluationTaxonomies_create", - "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.", + "description": "Create an evaluation taxonomy.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -8461,8 +7572,18 @@ } } }, - "4XX": { - "description": "Client error", + "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.", "headers": { "x-ms-error-code": { "required": false, @@ -8479,9 +7600,65 @@ } } } + } + }, + "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" + } + } + } }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -8519,7 +7696,7 @@ "/evaluator_generation_jobs": { "post": { "operationId": "EvaluatorGenerationJobs_create", - "summary": "Create an evaluator generation job", + "summary": "Creates an evaluator generation job.", "description": "Creates an evaluator generation job. The service generates rubric-based evaluator\ndefinitions from the provided source materials asynchronously.", "parameters": [ { @@ -8581,18 +7758,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -8624,8 +7791,8 @@ }, "get": { "operationId": "EvaluatorGenerationJobs_list", - "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.", + "summary": "Returns a list of evaluator generation jobs.", + "description": "Returns a list of evaluator generation jobs.", "parameters": [ { "name": "Foundry-Features", @@ -8729,18 +7896,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -8763,7 +7920,7 @@ "/evaluator_generation_jobs/{jobId}": { "get": { "operationId": "EvaluatorGenerationJobs_get", - "summary": "Get an evaluator generation job", + "summary": "Get info about an evaluator generation job.", "description": "Gets the details of an evaluator generation job by its ID.", "parameters": [ { @@ -8819,18 +7976,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -8851,7 +7998,6 @@ }, "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": [ { @@ -8890,18 +8036,8 @@ "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", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -8924,7 +8060,7 @@ "/evaluator_generation_jobs/{jobId}:cancel": { "post": { "operationId": "EvaluatorGenerationJobs_cancel", - "summary": "Cancel an evaluator generation job", + "summary": "Cancels an evaluator generation job.", "description": "Cancels an evaluator generation job by its ID.", "parameters": [ { @@ -8970,18 +8106,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -9004,8 +8130,7 @@ "/evaluators": { "get": { "operationId": "Evaluators_listLatestVersions", - "summary": "List latest evaluator versions", - "description": "Lists the latest version of each evaluator", + "description": "List the latest version of each evaluator", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -9066,27 +8191,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -9113,8 +8219,7 @@ "/evaluators/{name}/versions": { "get": { "operationId": "Evaluators_listVersions", - "summary": "List evaluator versions", - "description": "Returns the available versions for the specified evaluator.", + "description": "List all versions of the given evaluator", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -9184,27 +8289,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -9229,8 +8315,7 @@ }, "post": { "operationId": "Evaluators_createVersion", - "summary": "Create an evaluator version", - "description": "Creates a new evaluator version with an auto-incremented version identifier.", + "description": "Create a new EvaluatorVersion with auto incremented version id", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -9268,27 +8353,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -9325,8 +8391,7 @@ "/evaluators/{name}/versions/{version}": { "get": { "operationId": "Evaluators_getVersion", - "summary": "Get an evaluator version", - "description": "Retrieves the specified evaluator version, returning 404 if it does not exist.", + "description": "Get the specific version of the EvaluatorVersion. The service returns 404 Not Found error if the EvaluatorVersion does not exist.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -9373,27 +8438,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -9418,94 +8464,7 @@ }, "delete": { "operationId": "Evaluators_deleteVersion", - "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.", + "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.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -9535,25 +8494,18 @@ "name": "version", "in": "path", "required": true, - "description": "The version of the EvaluatorVersion to update.", + "description": "The version of the EvaluatorVersion to delete.", "schema": { "type": "string" } } ], "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EvaluatorVersion" - } - } - } + "204": { + "description": "There is no content to send for this request, but the headers may be useful." }, - "4XX": { - "description": "Client error", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -9570,9 +8522,63 @@ } } } + } + }, + "tags": [ + "Evaluators" + ] + }, + "patch": { + "operationId": "Evaluators_updateVersion", + "description": "Update an existing EvaluatorVersion with the given version id", + "parameters": [ + { + "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" }, - "5XX": { - "description": "Server error", + { + "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.", "headers": { "x-ms-error-code": { "required": false, @@ -9610,8 +8616,7 @@ "/evaluators/{name}/versions/{version}/credentials": { "post": { "operationId": "Evaluators_getCredentials", - "summary": "Get evaluator credentials", - "description": "Retrieves SAS credentials for accessing the storage account associated with the specified evaluator version.", + "description": "Get the SAS credential to access the storage account associated with an Evaluator version.", "parameters": [ { "name": "Foundry-Features", @@ -9664,18 +8669,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -9709,8 +8704,7 @@ "/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.", + "description": "Start a new or get an existing pending upload of an evaluator for a specific version.", "parameters": [ { "name": "Foundry-Features", @@ -9763,18 +8757,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -9808,7 +8792,6 @@ "/indexes": { "get": { "operationId": "Indexes_listLatest", - "summary": "List latest versions", "description": "List the latest version of each Index", "parameters": [ { @@ -9826,27 +8809,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -9873,7 +8837,6 @@ "/indexes/{name}/versions": { "get": { "operationId": "Indexes_listVersions", - "summary": "List versions", "description": "List all versions of the given Index", "parameters": [ { @@ -9900,27 +8863,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -9947,7 +8891,6 @@ "/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": [ { @@ -9983,27 +8926,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -10028,7 +8952,6 @@ }, "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": [ { @@ -10057,27 +8980,8 @@ "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -10102,7 +9006,6 @@ }, "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": [ { @@ -10148,27 +9051,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -10206,8 +9090,7 @@ "/insights": { "post": { "operationId": "Insights_generate", - "summary": "Generate insights", - "description": "Generates an insights report from the provided evaluation configuration.", + "description": "Generate Insights", "parameters": [ { "name": "Foundry-Features", @@ -10262,18 +9145,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -10300,8 +9173,7 @@ }, "get": { "operationId": "Insights_list", - "summary": "List insights", - "description": "Returns insights in reverse chronological order, with the most recent entries first.", + "description": "List all insights in reverse chronological order (newest first).", "parameters": [ { "name": "Foundry-Features", @@ -10387,18 +9259,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -10416,8 +9278,7 @@ "/insights/{id}": { "get": { "operationId": "Insights_get", - "summary": "Get an insight", - "description": "Retrieves the specified insight report and its results.", + "description": "Get a specific insight by Id.", "parameters": [ { "name": "Foundry-Features", @@ -10472,18 +9333,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -10501,8 +9352,6 @@ "/managedAgentIdentityBlueprints": { "get": { "operationId": "ManagedAgentIdentityBlueprints_listManagedAgentIdentityBlueprints", - "summary": "List blueprints", - "description": "Lists all managed agent identity blueprints.", "parameters": [ { "name": "Foundry-Features", @@ -10560,18 +9409,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -10591,8 +9430,6 @@ "/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", @@ -10637,18 +9474,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -10676,7 +9503,6 @@ }, "get": { "operationId": "ManagedAgentIdentityBlueprints_getManagedAgentIdentityBlueprint", - "summary": "Get a blueprint", "description": "Retrieves a managed agent identity blueprint by name.", "parameters": [ { @@ -10722,18 +9548,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -10751,7 +9567,6 @@ }, "delete": { "operationId": "ManagedAgentIdentityBlueprints_deleteManagedAgentIdentityBlueprint", - "summary": "Delete a blueprint", "description": "Deletes a managed agent identity blueprint by name.", "parameters": [ { @@ -10790,18 +9605,8 @@ "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", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -10821,8 +9626,7 @@ "/memory_stores": { "post": { "operationId": "createMemoryStore", - "summary": "Create a memory store", - "description": "Creates a memory store resource with the provided configuration.", + "description": "Create a memory store.", "parameters": [ { "name": "Foundry-Features", @@ -10858,18 +9662,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -10901,7 +9695,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Arbitrary key-value metadata to associate with the memory store." @@ -10931,8 +9725,7 @@ }, "get": { "operationId": "listMemoryStores", - "summary": "List memory stores", - "description": "Returns the memory stores available to the caller.", + "description": "List all memory stores.", "parameters": [ { "name": "Foundry-Features", @@ -11036,18 +9829,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -11070,8 +9853,7 @@ "/memory_stores/{name}": { "post": { "operationId": "updateMemoryStore", - "summary": "Update a memory store", - "description": "Updates the specified memory store with the supplied configuration changes.", + "description": "Update a memory store.", "parameters": [ { "name": "Foundry-Features", @@ -11116,18 +9898,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -11154,7 +9926,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Arbitrary key-value metadata to associate with the memory store." @@ -11172,8 +9944,7 @@ }, "get": { "operationId": "getMemoryStore", - "summary": "Get a memory store", - "description": "Retrieves the specified memory store and its current configuration.", + "description": "Retrieve a memory store.", "parameters": [ { "name": "Foundry-Features", @@ -11218,18 +9989,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -11250,8 +10011,7 @@ }, "delete": { "operationId": "deleteMemoryStore", - "summary": "Delete a memory store", - "description": "Deletes the specified memory store.", + "description": "Delete a memory store.", "parameters": [ { "name": "Foundry-Features", @@ -11296,18 +10056,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -11330,8 +10080,7 @@ "/memory_stores/{name}/items": { "post": { "operationId": "createMemory", - "summary": "Create a memory item", - "description": "Creates a memory item in the specified memory store.", + "description": "Create a memory item in a memory store.", "parameters": [ { "name": "Foundry-Features", @@ -11376,18 +10125,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -11443,8 +10182,7 @@ "/memory_stores/{name}/items/{memory_id}": { "post": { "operationId": "updateMemory", - "summary": "Update a memory item", - "description": "Updates the specified memory item in the memory store.", + "description": "Update a memory item in a memory store.", "parameters": [ { "name": "Foundry-Features", @@ -11498,18 +10236,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -11549,8 +10277,7 @@ }, "get": { "operationId": "getMemory", - "summary": "Get a memory item", - "description": "Retrieves the specified memory item from the memory store.", + "description": "Retrieve a memory item from a memory store.", "parameters": [ { "name": "Foundry-Features", @@ -11604,18 +10331,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -11636,8 +10353,7 @@ }, "delete": { "operationId": "deleteMemory", - "summary": "Delete a memory item", - "description": "Deletes the specified memory item from the memory store.", + "description": "Delete a memory item from a memory store.", "parameters": [ { "name": "Foundry-Features", @@ -11691,18 +10407,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -11725,8 +10431,7 @@ "/memory_stores/{name}/items:list": { "post": { "operationId": "listMemories", - "summary": "List memory items", - "description": "Returns memory items from the specified memory store.", + "description": "List all memory items in a memory store.", "parameters": [ { "name": "Foundry-Features", @@ -11849,18 +10554,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -11902,8 +10597,7 @@ "/memory_stores/{name}/updates/{update_id}": { "get": { "operationId": "getUpdateResult", - "summary": "Get an update result", - "description": "Retrieves the status and result of a memory store update operation.", + "description": "Get memory store update result.", "parameters": [ { "name": "Foundry-Features", @@ -11957,18 +10651,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -11991,8 +10675,7 @@ "/memory_stores/{name}:delete_scope": { "post": { "operationId": "deleteScopeMemories", - "summary": "Delete memories by scope", - "description": "Deletes all memories in the specified memory store that are associated with the provided scope.", + "description": "Delete all memories associated with a specific scope from a memory store.", "parameters": [ { "name": "Foundry-Features", @@ -12037,18 +10720,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -12090,8 +10763,7 @@ "/memory_stores/{name}:search_memories": { "post": { "operationId": "searchMemories", - "summary": "Search memories", - "description": "Searches the specified memory store for memories relevant to the provided conversation context.", + "description": "Search for relevant memories from a memory store based on conversation context.", "parameters": [ { "name": "Foundry-Features", @@ -12136,18 +10808,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -12208,8 +10870,7 @@ "/memory_stores/{name}:update_memories": { "post": { "operationId": "updateMemories", - "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.", + "description": "Update memory store with conversation memories.", "parameters": [ { "name": "Foundry-Features", @@ -12264,18 +10925,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -12334,7 +10985,6 @@ "/models": { "get": { "operationId": "Models_listLatest", - "summary": "List latest versions", "description": "List the latest version of each ModelVersion", "parameters": [ { @@ -12364,27 +11014,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -12411,7 +11042,6 @@ "/models/{name}/versions": { "get": { "operationId": "Models_listVersions", - "summary": "List versions", "description": "List all versions of the given ModelVersion", "parameters": [ { @@ -12450,27 +11080,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -12497,8 +11108,7 @@ "/models/{name}/versions/{version}": { "get": { "operationId": "Models_getVersion", - "summary": "Get a model version", - "description": "Retrieves the specified model version, returning 404 if it does not exist.", + "description": "Get the specific version of the ModelVersion. The service returns 404 Not Found error if the ModelVersion does not exist.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -12545,27 +11155,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -12595,7 +11186,6 @@ }, "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": [ { @@ -12636,27 +11226,8 @@ "200": { "description": "The request has succeeded." }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -12686,7 +11257,6 @@ }, "patch": { "operationId": "Models_updateVersion", - "summary": "Update a model version", "description": "Update an existing ModelVersion with the given version id", "parameters": [ { @@ -12744,27 +11314,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -12807,8 +11358,7 @@ "/models/{name}/versions/{version}/createAsync": { "post": { "operationId": "Models_createAsync", - "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.", + "description": "Creates a model version asynchronously with blob content validation. Returns 202 Accepted with a Location header for polling.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -12868,15 +11418,9 @@ "description": "URL to poll for operation status." }, "operationResult": { - "anyOf": [ - { - "type": "string", - "format": "uri" - }, - { - "type": "null" - } - ], + "type": "string", + "format": "uri", + "nullable": true, "description": "URL to the operation result, or null if the operation is still in progress." } } @@ -12884,27 +11428,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -12947,8 +11472,7 @@ "/models/{name}/versions/{version}/credentials": { "post": { "operationId": "Models_getCredentials", - "summary": "Get model asset credentials", - "description": "Retrieves temporary credentials for accessing the storage backing the specified model version.", + "description": "Get credentials for a model version asset.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -12995,27 +11519,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -13057,8 +11562,7 @@ "/models/{name}/versions/{version}/startPendingUpload": { "post": { "operationId": "Models_startPendingUpload", - "summary": "Start a pending upload", - "description": "Initiates a new pending upload or retrieves an existing one for the specified model version.", + "description": "Start or retrieve a pending upload for a model version.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -13105,27 +11609,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -13167,8 +11652,7 @@ "/openai/v1/conversations": { "post": { "operationId": "createConversation", - "summary": "Create a conversation", - "description": "Creates a new conversation resource.", + "description": "Create a conversation.", "parameters": [ { "name": "x-ms-user-isolation-key", @@ -13191,18 +11675,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -13228,8 +11702,7 @@ }, "get": { "operationId": "listConversations", - "summary": "List conversations", - "description": "Returns the conversations available in the current project.", + "description": "Returns the list of all conversations.", "parameters": [ { "name": "limit", @@ -13340,18 +11813,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -13369,8 +11832,7 @@ "/openai/v1/conversations/{conversation_id}": { "post": { "operationId": "updateConversation", - "summary": "Update a conversation", - "description": "Modifies the specified conversation's properties.", + "description": "Update a conversation.", "parameters": [ { "name": "conversation_id", @@ -13402,18 +11864,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -13439,8 +11891,7 @@ }, "get": { "operationId": "getConversation", - "summary": "Retrieve a conversation", - "description": "Retrieves the specified conversation and its metadata.", + "description": "Retrieves a conversation.", "parameters": [ { "name": "conversation_id", @@ -13472,18 +11923,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -13499,8 +11940,7 @@ }, "delete": { "operationId": "deleteConversation", - "summary": "Delete a conversation", - "description": "Removes the specified conversation resource from the current project.", + "description": "Deletes a conversation.", "parameters": [ { "name": "conversation_id", @@ -13532,18 +11972,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -13561,8 +11991,7 @@ "/openai/v1/conversations/{conversation_id}/items": { "post": { "operationId": "createConversationItems", - "summary": "Create conversation items", - "description": "Adds one or more items to the specified conversation.", + "description": "Create items in a conversation with the given ID.", "parameters": [ { "name": "conversation_id", @@ -13607,18 +12036,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -13657,8 +12076,7 @@ }, "get": { "operationId": "listConversationItems", - "summary": "List conversation items", - "description": "Returns the items belonging to the specified conversation.", + "description": "List all items for a conversation with the given ID.", "parameters": [ { "name": "conversation_id", @@ -13768,18 +12186,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -13797,8 +12205,7 @@ "/openai/v1/conversations/{conversation_id}/items/{item_id}": { "get": { "operationId": "getConversationItem", - "summary": "Get a conversation item", - "description": "Retrieves a specific item from the specified conversation.", + "description": "Get a single item from a conversation with the given IDs.", "parameters": [ { "name": "conversation_id", @@ -13839,18 +12246,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -13866,8 +12263,7 @@ }, "delete": { "operationId": "deleteConversationItem", - "summary": "Delete a conversation item", - "description": "Removes the specified item from a conversation.", + "description": "Delete an item from a conversation with the given IDs.", "parameters": [ { "name": "conversation_id", @@ -13908,18 +12304,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -13937,8 +12323,8 @@ "/openai/v1/evals": { "get": { "operationId": "Evals_listEvals", - "summary": "List evaluations", - "description": "Returns the evaluations configured in the current project.", + "summary": "List all evaluations", + "description": "List evaluations for a project.", "parameters": [ { "name": "after", @@ -13956,7 +12342,11 @@ "required": false, "description": "Number of runs to retrieve.", "schema": { - "$ref": "#/components/schemas/integer", + "allOf": [ + { + "$ref": "#/components/schemas/integer" + } + ], "default": 20 }, "explode": false @@ -14028,18 +12418,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -14055,8 +12435,8 @@ }, "post": { "operationId": "Evals_createEval", - "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).", + "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).", "parameters": [], "responses": { "200": { @@ -14069,18 +12449,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -14109,7 +12479,7 @@ "delete": { "operationId": "Evals_deleteEval", "summary": "Delete an evaluation", - "description": "Removes the specified evaluation and its associated data.", + "description": "Delete an evaluation.", "parameters": [ { "name": "eval_id", @@ -14132,18 +12502,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -14160,7 +12520,7 @@ "get": { "operationId": "Evals_getEval", "summary": "Get an evaluation", - "description": "Retrieves the specified evaluation and its configuration.", + "description": "Get an evaluation by ID.", "parameters": [ { "name": "eval_id", @@ -14183,18 +12543,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -14211,7 +12561,7 @@ "post": { "operationId": "Evals_updateEval", "summary": "Update an evaluation", - "description": "Updates certain properties of an evaluation.", + "description": "Update certain properties of an evaluation.", "parameters": [ { "name": "eval_id", @@ -14234,18 +12584,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -14273,8 +12613,8 @@ "/openai/v1/evals/{eval_id}/runs": { "get": { "operationId": "Evals_listRuns", - "summary": "List evaluation runs", - "description": "Returns the runs associated with the specified evaluation.", + "summary": "Get a list of runs for an evaluation", + "description": "Get a list of runs for an evaluation.", "parameters": [ { "name": "eval_id", @@ -14301,7 +12641,11 @@ "required": false, "description": "Number of runs to retrieve.", "schema": { - "$ref": "#/components/schemas/integer", + "allOf": [ + { + "$ref": "#/components/schemas/integer" + } + ], "default": 20 }, "explode": false @@ -14376,18 +12720,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -14403,8 +12737,7 @@ }, "post": { "operationId": "Evals_createEvalRun", - "summary": "Create an evaluation run", - "description": "Creates an evaluation run for the specified evaluation.", + "summary": "Create evaluation run", "parameters": [ { "name": "eval_id", @@ -14427,18 +12760,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -14466,8 +12789,8 @@ "/openai/v1/evals/{eval_id}/runs/{run_id}": { "delete": { "operationId": "Evals_deleteEvalRun", - "summary": "Delete an evaluation run", - "description": "Removes the specified evaluation run.", + "summary": "Delete evaluation run", + "description": "Delete an eval run.", "parameters": [ { "name": "eval_id", @@ -14499,18 +12822,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -14527,7 +12840,7 @@ "get": { "operationId": "Evals_getEvalRun", "summary": "Get an evaluation run", - "description": "Retrieves the specified evaluation run and its current status.", + "description": "Get an evaluation run by ID.", "parameters": [ { "name": "eval_id", @@ -14559,18 +12872,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -14586,8 +12889,8 @@ }, "post": { "operationId": "Evals_cancelEvalRun", - "summary": "Cancel an evaluation run", - "description": "Cancels an ongoing evaluation run.", + "summary": "Cancel evaluation run", + "description": "Cancel an ongoing evaluation run.", "parameters": [ { "name": "eval_id", @@ -14619,18 +12922,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -14648,8 +12941,8 @@ "/openai/v1/evals/{eval_id}/runs/{run_id}/output_items": { "get": { "operationId": "Evals_getEvalRunOutputItems", - "summary": "List evaluation run output items", - "description": "Returns the output items produced by the specified evaluation run.", + "summary": "Get evaluation run output items", + "description": "Get a list of output items for an evaluation run.", "parameters": [ { "name": "eval_id", @@ -14684,7 +12977,11 @@ "required": false, "description": "Number of runs to retrieve.", "schema": { - "$ref": "#/components/schemas/integer", + "allOf": [ + { + "$ref": "#/components/schemas/integer" + } + ], "default": 20 }, "explode": false @@ -14755,18 +13052,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -14785,7 +13072,7 @@ "get": { "operationId": "Evals_getEvalRunOutputItem", "summary": "Get an output item of an evaluation run", - "description": "Retrieves a single output item from the specified evaluation run.", + "description": "Get an evaluation run output item by ID.", "parameters": [ { "name": "eval_id", @@ -14826,18 +13113,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -14855,7 +13132,6 @@ "/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": [ { @@ -14880,18 +13156,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -14917,8 +13183,7 @@ }, "get": { "operationId": "listPaginatedFineTuningJobs", - "summary": "List fine-tuning jobs", - "description": "Returns the fine-tuning jobs for the current organization.", + "description": "List your organization's fine-tuning jobs", "parameters": [ { "name": "after", @@ -14964,18 +13229,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -14993,8 +13248,7 @@ "/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}": { "get": { "operationId": "retrieveFineTuningJob", - "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)", + "description": "Get 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", @@ -15027,18 +13281,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -15056,8 +13300,7 @@ "/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel": { "post": { "operationId": "cancelFineTuningJob", - "summary": "Cancel a fine-tuning job", - "description": "Immediately cancels the specified fine-tuning job.", + "description": "Immediately cancel a fine-tune job.", "parameters": [ { "name": "fine_tuning_job_id", @@ -15090,18 +13333,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -15119,8 +13352,7 @@ "/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints": { "get": { "operationId": "listFineTuningJobCheckpoints", - "summary": "List fine-tuning job checkpoints", - "description": "Returns the checkpoints saved during the specified fine-tuning job.", + "description": "List checkpoints for a fine-tuning job.", "parameters": [ { "name": "fine_tuning_job_id", @@ -15175,18 +13407,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -15204,8 +13426,7 @@ "/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events": { "get": { "operationId": "listFineTuningJobEvents", - "summary": "List fine-tuning job events", - "description": "Returns the status events emitted during the specified fine-tuning job.", + "description": "Get fine-grained status updates for a fine-tuning job.", "parameters": [ { "name": "fine_tuning_job_id", @@ -15260,18 +13481,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -15289,8 +13500,7 @@ "/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause": { "post": { "operationId": "pauseFineTuningJob", - "summary": "Pause a fine-tuning job", - "description": "Pauses the specified fine-tuning job while it is running.", + "description": "Pause a running fine-tune job.", "parameters": [ { "name": "fine_tuning_job_id", @@ -15323,18 +13533,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -15352,8 +13552,7 @@ "/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume": { "post": { "operationId": "resumeFineTuningJob", - "summary": "Resume a fine-tuning job", - "description": "Resumes the specified fine-tuning job after it has been paused.", + "description": "Resume a paused fine-tune job.", "parameters": [ { "name": "fine_tuning_job_id", @@ -15386,18 +13585,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -15414,9 +13603,7 @@ }, "/openai/v1/responses": { "post": { - "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.", + "operationId": "createResponse_createResponseStream", "parameters": [ { "name": "x-ms-user-isolation-key", @@ -15428,6 +13615,7 @@ } } ], + "description": "Creates a model response. Creates a model response (streaming response).", "responses": { "200": { "description": "The request has succeeded.", @@ -15443,334 +13631,7 @@ "content": { "application/json": { "schema": { - "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" - ] + "$ref": "#/components/schemas/OpenAI.Response" } }, "text/event-stream": { @@ -15780,18 +13641,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -15809,297 +13660,432 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "metadata": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.Metadata" + "anyOf": [ + { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Metadata" + } + ], + "nullable": true }, - { - "type": "null" - } - ] - }, - "top_logprobs": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" + "top_logprobs": { + "type": "integer", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + } + ], + "nullable": true }, - { - "type": "null" - } - ] - }, - "temperature": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.numeric" + "temperature": { + "type": "number", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.numeric" + } + ], + "nullable": true, + "default": 1 }, - { - "type": "null" - } - ], - "default": 1 - }, - "top_p": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.numeric" + "top_p": { + "type": "number", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.numeric" + } + ], + "nullable": true, + "default": 1 }, - { - "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": [ - { + "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", + "in-memory", "24h" - ] + ], + "nullable": true }, - { - "type": "null" - } - ] - }, - "previous_response_id": { - "anyOf": [ - { - "type": "string" + "previous_response_id": { + "type": "string", + "nullable": true }, - { - "type": "null" - } - ] - }, - "model": { - "type": "string", - "description": "The model deployment to use for the creation of this response." - }, - "reasoning": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.Reasoning" + "model": { + "type": "string", + "description": "The model deployment to use for the creation of this response." }, - { - "type": "null" - } - ] - }, - "background": { - "anyOf": [ - { - "type": "boolean" + "reasoning": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Reasoning" + } + ], + "nullable": true }, - { - "type": "null" - } - ] - }, - "max_tool_calls": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" + "background": { + "type": "boolean", + "nullable": true }, - { - "type": "null" - } - ] - }, - "text": { - "$ref": "#/components/schemas/OpenAI.ResponseTextParam" - }, - "tools": { - "$ref": "#/components/schemas/OpenAI.ToolsArray" - }, - "tool_choice": { - "oneOf": [ - { - "$ref": "#/components/schemas/OpenAI.ToolChoiceOptions" + "max_output_tokens": { + "type": "integer", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + } + ], + "nullable": true }, - { - "$ref": "#/components/schemas/OpenAI.ToolChoiceParam" - } - ] - }, - "prompt": { - "$ref": "#/components/schemas/OpenAI.Prompt" - }, - "truncation": { - "anyOf": [ - { + "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" }, - { - "type": "null" - } - ], - "default": "disabled" - }, - "input": { - "$ref": "#/components/schemas/OpenAI.InputParam" - }, - "include": { - "anyOf": [ - { + "input": { + "$ref": "#/components/schemas/OpenAI.InputParam" + }, + "include": { "type": "array", "items": { "$ref": "#/components/schemas/OpenAI.IncludeEnum" - } + }, + "nullable": true }, - { - "type": "null" - } - ] - }, - "parallel_tool_calls": { - "anyOf": [ - { - "type": "boolean" + "parallel_tool_calls": { + "type": "boolean", + "nullable": true, + "default": true }, - { - "type": "null" - } - ], - "default": true - }, - "store": { - "anyOf": [ - { - "type": "boolean" + "store": { + "type": "boolean", + "nullable": true, + "default": true }, - { - "type": "null" - } - ], - "default": true - }, - "instructions": { - "anyOf": [ - { - "type": "string" + "instructions": { + "type": "string", + "nullable": true }, - { - "type": "null" - } - ] - }, - "moderation": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.ModerationParam" + "stream": { + "type": "boolean", + "nullable": true }, - { - "type": "null" - } - ] - }, - "stream": { - "anyOf": [ - { - "type": "boolean" + "stream_options": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamOptions" + } + ], + "nullable": true }, - { - "type": "null" - } - ] - }, - "stream_options": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamOptions" + "conversation": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationParam" + } + ], + "nullable": true }, - { - "type": "null" - } - ] - }, - "conversation": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.ConversationParam" + "context_management": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ContextManagementParam" + }, + "nullable": true, + "description": "Context management configuration for this request." }, - { - "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", + "additionalProperties": {}, + "description": "The structured inputs to the response that can participate in prompt template substitution or tool argument bindings." } - ] + } }, - "context_management": { - "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 + }, + "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 + }, + "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." }, - { - "type": "null" - } - ], - "description": "Context management configuration for this request." - }, - "max_output_tokens": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" + "agent": { + "allOf": [ + { + "$ref": "#/components/schemas/AgentReference" + } + ], + "description": "(Deprecated) Use agent_reference instead.\nThe agent to use for generating the response." }, - { - "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" + "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." } - ], - "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." + } } - } + ] } } } @@ -16107,8 +14093,7 @@ }, "get": { "operationId": "listResponses", - "summary": "List responses", - "description": "Returns a collection of all stored responses matching specified filter criteria.", + "description": "Returns the list of all responses.", "parameters": [ { "name": "limit", @@ -16229,18 +14214,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -16258,8 +14233,7 @@ "/openai/v1/responses/compact": { "post": { "operationId": "compactResponseConversation", - "summary": "Compact a conversation", - "description": "Compacts a conversation into a response object suitable for long-running and zero-data-retention scenarios.", + "description": "Produces a compaction of a responses conversation.", "parameters": [], "responses": { "200": { @@ -16272,18 +14246,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -16310,9 +14274,7 @@ }, "/openai/v1/responses/{response_id}": { "get": { - "operationId": "getResponse", - "summary": "Retrieve a model response", - "description": "Retrieves a model response with the given ID.", + "operationId": "getResponse_getResponseStream", "parameters": [ { "name": "response_id", @@ -16362,8 +14324,20 @@ "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.", @@ -16389,18 +14363,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -16416,7 +14380,6 @@ }, "delete": { "operationId": "deleteResponse", - "summary": "Delete a model response", "description": "Deletes a model response.", "parameters": [ { @@ -16458,18 +14421,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -16487,8 +14440,7 @@ "/openai/v1/responses/{response_id}/cancel": { "post": { "operationId": "cancelResponse", - "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.", + "description": "Cancels a model response.", "parameters": [ { "name": "response_id", @@ -16529,18 +14481,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -16558,8 +14500,7 @@ "/openai/v1/responses/{response_id}/input_items": { "get": { "operationId": "listInputItems", - "summary": "List input items for a response", - "description": "Retrieves the input items associated with the specified response.", + "description": "Returns a list of input items for a given response.", "parameters": [ { "name": "response_id", @@ -16667,18 +14608,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -16696,8 +14627,7 @@ "/redTeams/runs": { "get": { "operationId": "RedTeams_list", - "summary": "List redteams", - "description": "Returns the redteams available in the current project.", + "description": "List a redteam by name.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -16726,27 +14656,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -16773,8 +14684,7 @@ "/redTeams/runs/{name}": { "get": { "operationId": "RedTeams_get", - "summary": "Get a redteam", - "description": "Retrieves the specified redteam and its configuration.", + "description": "Get a redteam by name.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -16812,27 +14722,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -16859,8 +14750,7 @@ "/redTeams/runs:run": { "post": { "operationId": "RedTeams_create", - "summary": "Create a redteam run", - "description": "Submits a new redteam run for execution with the provided configuration.", + "description": "Creates a redteam run.", "parameters": [ { "name": "Foundry-Features", @@ -16896,18 +14786,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -16936,8 +14816,7 @@ "/routines": { "get": { "operationId": "listRoutines", - "summary": "List routines", - "description": "Returns the routines available in the current project.", + "description": "List routines.", "parameters": [ { "name": "Foundry-Features", @@ -16952,16 +14831,46 @@ } }, { - "$ref": "#/components/parameters/ListRoutinesParameters.limit" + "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.after" + "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.before" + "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.order" + "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", @@ -17011,18 +14920,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -17045,8 +14944,7 @@ "/routines/{routine_name}": { "put": { "operationId": "createOrUpdateRoutine", - "summary": "Create or update a routine", - "description": "Creates a new routine or replaces an existing routine with the supplied definition.", + "description": "Create or update a routine.", "parameters": [ { "name": "Foundry-Features", @@ -17085,18 +14983,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -17127,8 +15015,7 @@ }, "get": { "operationId": "getRoutine", - "summary": "Get a routine", - "description": "Retrieves the specified routine and its current configuration.", + "description": "Retrieve a routine.", "parameters": [ { "name": "Foundry-Features", @@ -17167,18 +15054,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -17199,8 +15076,7 @@ }, "delete": { "operationId": "deleteRoutine", - "summary": "Delete a routine", - "description": "Deletes the specified routine.", + "description": "Delete a routine.", "parameters": [ { "name": "Foundry-Features", @@ -17232,18 +15108,8 @@ "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", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -17266,8 +15132,7 @@ "/routines/{routine_name}/runs": { "get": { "operationId": "listRoutineRuns", - "summary": "List prior runs for a routine", - "description": "Returns prior runs recorded for the specified routine.", + "description": "List prior runs for a routine.", "parameters": [ { "name": "Foundry-Features", @@ -17288,16 +15153,46 @@ "$ref": "#/components/parameters/ListRoutineRunsParameters.filter" }, { - "$ref": "#/components/parameters/ListRoutineRunsParameters.limit" + "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.after" + "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.before" + "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.order" + "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", @@ -17347,18 +15242,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -17381,8 +15266,7 @@ "/routines/{routine_name}:disable": { "post": { "operationId": "disableRoutine", - "summary": "Disable a routine", - "description": "Disables the specified routine so it no longer runs.", + "description": "Disable a routine.", "parameters": [ { "name": "Foundry-Features", @@ -17421,18 +15305,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -17455,8 +15329,7 @@ "/routines/{routine_name}:dispatch_async": { "post": { "operationId": "dispatchRoutineAsync", - "summary": "Queue an asynchronous routine dispatch", - "description": "Queues an asynchronous dispatch for the specified routine.", + "description": "Queue an asynchronous routine dispatch.", "parameters": [ { "name": "Foundry-Features", @@ -17495,18 +15368,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -17539,8 +15402,7 @@ "/routines/{routine_name}:enable": { "post": { "operationId": "enableRoutine", - "summary": "Enable a routine", - "description": "Enables the specified routine so it can be dispatched.", + "description": "Enable a routine.", "parameters": [ { "name": "Foundry-Features", @@ -17579,18 +15441,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -17613,8 +15465,7 @@ "/schedules": { "get": { "operationId": "Schedules_list", - "summary": "List schedules", - "description": "Returns schedules that match the supplied type and enabled filters.", + "description": "List all schedules.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -17663,27 +15514,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -17710,8 +15542,7 @@ "/schedules/{id}": { "delete": { "operationId": "Schedules_delete", - "summary": "Delete a schedule", - "description": "Deletes the specified schedule resource.", + "description": "Delete a schedule.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -17742,27 +15573,8 @@ "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -17787,8 +15599,7 @@ }, "get": { "operationId": "Schedules_get", - "summary": "Get a schedule", - "description": "Retrieves the specified schedule resource.", + "description": "Get a schedule by id.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -17826,27 +15637,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -17871,8 +15663,7 @@ }, "put": { "operationId": "Schedules_createOrUpdate", - "summary": "Create or update a schedule", - "description": "Creates a new schedule or updates an existing schedule with the supplied definition.", + "description": "Create or update operation template.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -17920,27 +15711,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -17978,8 +15750,7 @@ "/schedules/{id}/runs": { "get": { "operationId": "Schedules_listRuns", - "summary": "List schedule runs", - "description": "Returns schedule runs that match the supplied filters.", + "description": "List all schedule runs.", "parameters": [ { "$ref": "#/components/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -18037,27 +15808,8 @@ } } }, - "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", + "default": { + "description": "An unexpected error response.", "headers": { "x-ms-error-code": { "required": false, @@ -18084,8 +15836,7 @@ "/schedules/{schedule_id}/runs/{run_id}": { "get": { "operationId": "Schedules_getRun", - "summary": "Get a schedule run", - "description": "Retrieves the specified run for a schedule.", + "description": "Get a schedule run by id.", "parameters": [ { "name": "schedule_id", @@ -18139,18 +15890,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -18168,8 +15909,7 @@ "/skills": { "get": { "operationId": "Skills_listSkills", - "summary": "List skills", - "description": "Returns the skills available in the current project.", + "description": "Returns the list of all skills.", "parameters": [ { "name": "limit", @@ -18273,18 +16013,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -18307,8 +16037,7 @@ "/skills/{name}": { "get": { "operationId": "Skills_getSkill", - "summary": "Retrieve a skill", - "description": "Retrieves the specified skill and its current configuration.", + "description": "Retrieves a skill.", "parameters": [ { "name": "name", @@ -18353,86 +16082,8 @@ } } }, - "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" - ] - } - }, - "post": { - "operationId": "updateSkill", - "summary": "Update a skill", - "description": "Modifies the specified skill's configuration.", - "parameters": [ - { - "name": "name", - "in": "path", - "required": true, - "description": "The name of the skill to update.", - "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 - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Skill" - } - } - } - }, - "4XX": { - "description": "Client error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -18440,9 +16091,66 @@ } } } + } + }, + "tags": [ + "Skills" + ], + "x-ms-foundry-meta": { + "required_previews": [ + "Skills=V1Preview" + ] + } + }, + "post": { + "operationId": "updateSkill", + "description": "Update a skill.", + "parameters": [ + { + "name": "name", + "in": "path", + "required": true, + "description": "The name of the skill to update.", + "schema": { + "$ref": "#/components/schemas/SkillName" + } }, - "5XX": { - "description": "Server error", + { + "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 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Skill" + } + } + } + }, + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -18482,8 +16190,7 @@ }, "delete": { "operationId": "Skills_deleteSkill", - "summary": "Delete a skill", - "description": "Removes the specified skill and its associated versions.", + "description": "Deletes a skill.", "parameters": [ { "name": "name", @@ -18528,18 +16235,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -18562,8 +16259,7 @@ "/skills/{name}/content": { "get": { "operationId": "getSkillContent", - "summary": "Download the zip content for the default version of a skill", - "description": "Downloads the zip content for the default version of a skill.", + "description": "Download the zip content for the default version of a skill.", "parameters": [ { "name": "name", @@ -18603,23 +16299,14 @@ "content": { "application/zip": { "schema": { - "contentMediaType": "application/zip" - } - } - } - }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" + "type": "string", + "format": "binary" } } } }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -18676,7 +16363,6 @@ } ], "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.", @@ -18688,18 +16374,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -18709,8 +16385,6 @@ } } }, - "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" @@ -18759,8 +16433,7 @@ }, "get": { "operationId": "listSkillVersions", - "summary": "List skill versions", - "description": "Returns the available versions for the specified skill.", + "description": "List all versions of a skill.", "parameters": [ { "name": "name", @@ -18873,18 +16546,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -18907,8 +16570,7 @@ "/skills/{name}/versions/{version}": { "get": { "operationId": "getSkillVersion", - "summary": "Retrieve a specific version of a skill", - "description": "Retrieves the specified version of a skill by name and version identifier.", + "description": "Retrieve a specific version of a skill.", "parameters": [ { "name": "name", @@ -18962,18 +16624,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -18994,8 +16646,7 @@ }, "delete": { "operationId": "deleteSkillVersion", - "summary": "Delete a specific version of a skill", - "description": "Removes the specified version of a skill.", + "description": "Delete a specific version of a skill.", "parameters": [ { "name": "name", @@ -19049,18 +16700,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -19083,8 +16724,7 @@ "/skills/{name}/versions/{version}/content": { "get": { "operationId": "getSkillVersionContent", - "summary": "Download the zip content for a specific version of a skill", - "description": "Downloads the zip content for a specific version of a skill.", + "description": "Download the zip content for a specific version of a skill.", "parameters": [ { "name": "name", @@ -19133,23 +16773,14 @@ "content": { "application/zip": { "schema": { - "contentMediaType": "application/zip" - } - } - } - }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" + "type": "string", + "format": "binary" } } } }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -19172,8 +16803,7 @@ "/toolboxes": { "get": { "operationId": "listToolboxes", - "summary": "List toolboxes", - "description": "Returns the toolboxes available in the current project.", + "description": "List all toolboxes.", "parameters": [ { "name": "limit", @@ -19217,18 +16847,6 @@ }, "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", @@ -19277,18 +16895,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -19300,19 +16908,13 @@ }, "tags": [ "Toolboxes" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "Toolboxes=V1Preview" - ] - } + ] } }, "/toolboxes/{name}": { "get": { "operationId": "getToolbox", - "summary": "Retrieve a toolbox", - "description": "Retrieves the specified toolbox and its current configuration.", + "description": "Retrieve a toolbox.", "parameters": [ { "name": "name", @@ -19323,18 +16925,6 @@ "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", @@ -19357,18 +16947,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -19380,33 +16960,15 @@ }, "tags": [ "Toolboxes" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "Toolboxes=V1Preview" - ] - } + ] }, "patch": { "operationId": "updateToolbox", - "summary": "Update a toolbox to point to a specific version", - "description": "Updates the toolbox's default version pointer to the specified version.", + "description": "Update a toolbox to point to a specific 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", @@ -19429,18 +16991,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -19462,17 +17014,11 @@ } } } - }, - "x-ms-foundry-meta": { - "conditional_previews": [ - "Toolboxes=V1Preview" - ] } }, "delete": { "operationId": "deleteToolbox", - "summary": "Delete a toolbox", - "description": "Removes the specified toolbox along with all of its versions.", + "description": "Delete a toolbox and all its versions.", "parameters": [ { "name": "name", @@ -19483,18 +17029,6 @@ "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", @@ -19510,18 +17044,8 @@ "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", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -19533,19 +17057,13 @@ }, "tags": [ "Toolboxes" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "Toolboxes=V1Preview" - ] - } + ] } }, "/toolboxes/{name}/versions": { "post": { "operationId": "createToolboxVersion", - "summary": "Create a new version of a toolbox", - "description": "Creates a new toolbox version, provisioning the toolbox itself if it does not already exist.", + "description": "Create a new version of a toolbox. If the toolbox does not exist, it will be created.", "parameters": [ { "name": "name", @@ -19557,18 +17075,6 @@ "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", @@ -19591,18 +17097,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -19629,7 +17125,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Arbitrary key-value metadata to associate with the toolbox." @@ -19663,17 +17159,11 @@ } } } - }, - "x-ms-foundry-meta": { - "conditional_previews": [ - "Toolboxes=V1Preview" - ] } }, "get": { "operationId": "listToolboxVersions", - "summary": "List toolbox versions", - "description": "Returns the available versions for the specified toolbox.", + "description": "List all versions of a toolbox.", "parameters": [ { "name": "name", @@ -19726,18 +17216,6 @@ }, "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", @@ -19786,18 +17264,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -19809,19 +17277,13 @@ }, "tags": [ "Toolboxes" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "Toolboxes=V1Preview" - ] - } + ] } }, "/toolboxes/{name}/versions/{version}": { "get": { "operationId": "getToolboxVersion", - "summary": "Retrieve a specific version of a toolbox", - "description": "Retrieves the specified version of a toolbox by name and version identifier.", + "description": "Retrieve a specific version of a toolbox.", "parameters": [ { "name": "name", @@ -19841,18 +17303,6 @@ "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", @@ -19875,18 +17325,8 @@ } } }, - "4XX": { - "description": "Client error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "5XX": { - "description": "Server error", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -19898,17 +17338,11 @@ }, "tags": [ "Toolboxes" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "Toolboxes=V1Preview" - ] - } + ] }, "delete": { "operationId": "deleteToolboxVersion", - "summary": "Delete a specific version of a toolbox", - "description": "Removes the specified version of a toolbox.", + "description": "Delete a specific version of a toolbox.", "parameters": [ { "name": "name", @@ -19928,18 +17362,6 @@ "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", @@ -19955,18 +17377,8 @@ "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", + "default": { + "description": "An unexpected error response.", "content": { "application/json": { "schema": { @@ -19978,12 +17390,7 @@ }, "tags": [ "Toolboxes" - ], - "x-ms-foundry-meta": { - "conditional_previews": [ - "Toolboxes=V1Preview" - ] - } + ] } } }, @@ -20076,26 +17483,6 @@ "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", @@ -20106,27 +17493,6 @@ }, "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", @@ -20137,47 +17503,6 @@ "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", @@ -20654,17 +17979,13 @@ "type": "integer", "format": "int32", "description": "The maximum number of replicas for the container. Default is 1.", - "examples": [ - 10 - ] + "example": 10 }, "min_replicas": { "type": "integer", "format": "int32", "description": "The minimum number of replicas for the container. Default is 1.", - "examples": [ - 1 - ] + "example": 1 }, "error_message": { "type": "string", @@ -21088,7 +18409,7 @@ }, "evaluators": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/EvaluatorConfiguration" }, "description": "Evaluators to be used for the evaluation." @@ -21165,7 +18486,7 @@ }, "additionalDetails": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Additional properties relevant to the evaluator. These will differ between evaluators." @@ -21353,6 +18674,23 @@ } } }, + "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": [ @@ -21508,7 +18846,6 @@ "enum": [ "activity_protocol", "responses", - "a2a", "mcp", "invocations", "invocations_ws" @@ -21610,6 +18947,7 @@ "idle", "updating", "failed", + "stopping", "deleting", "deleted", "expired" @@ -21707,17 +19045,11 @@ ], "properties": { "metadata": { - "anyOf": [ - { - "type": "object", - "unevaluatedProperties": { - "type": "string" - } - }, - { - "type": "null" - } - ], + "type": "object", + "additionalProperties": { + "type": "string" + }, + "nullable": true, "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" }, @@ -23095,7 +20427,7 @@ }, "parameters": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The parameters the functions accepts, described as a JSON Schema object." } }, @@ -23879,6 +21211,160 @@ }, "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": [ @@ -23993,7 +21479,7 @@ }, "coordinates": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$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." @@ -24247,7 +21733,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Metadata of the connection", @@ -24300,17 +21786,15 @@ "$ref": "#/components/schemas/ProtocolVersionRecord" }, "description": "The protocols that the agent supports for ingress communication of the containers.", - "examples": [ - [ - { - "protocol": "responses", - "version": "v0.1.1" - }, - { - "protocol": "a2a", - "version": "v0.3.0" - } - ] + "example": [ + { + "protocol": "responses", + "version": "v0.1.1" + }, + { + "protocol": "a2a", + "version": "v0.3.0" + } ] }, "container_app_resource_id": { @@ -24320,11 +21804,7 @@ "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.", - "examples": [ - "--0000001", - "---current", - "" - ] + "example": "--0000001" } }, "allOf": [ @@ -24348,9 +21828,7 @@ "image": { "type": "string", "description": "The container image for the hosted agent.", - "examples": [ - "my-registry.azurecr.io/my-hosted-agent:latest" - ] + "example": "my-registry.azurecr.io/my-hosted-agent:latest" } }, "description": "Container-based deployment configuration for a hosted agent.", @@ -24499,14 +21977,6 @@ "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": [ @@ -24548,7 +22018,7 @@ }, "data_mapping": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Mapping from source fields to response_id field, which is required for retrieving chat history." @@ -24652,6 +22122,8 @@ "description": "JSON metadata including description and hosted definition." }, "code": { + "type": "string", + "format": "binary", "description": "The code zip file (max 250 MB)." } }, @@ -24675,7 +22147,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "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.", @@ -24692,7 +22164,7 @@ }, "parameter_values": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The inputs to the manifest that will result in a fully materialized Agent." } } @@ -24711,7 +22183,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "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.", @@ -24825,6 +22297,8 @@ "description": "JSON metadata including description and hosted definition." }, "code": { + "type": "string", + "format": "binary", "description": "The code zip file (max 250 MB)." } }, @@ -24846,7 +22320,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "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.", @@ -24877,7 +22351,7 @@ "properties": { "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "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.", @@ -24894,7 +22368,7 @@ }, "parameter_values": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The inputs to the manifest that will result in a fully materialized Agent." } } @@ -24907,7 +22381,7 @@ "properties": { "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "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.", @@ -24969,14 +22443,13 @@ "description": "The name of the evaluation." }, "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "data_source_config": { "oneOf": [ @@ -25026,7 +22499,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "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." @@ -25045,14 +22518,13 @@ "description": "The name of the run." }, "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "data_source": { "oneOf": [ @@ -25073,7 +22545,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "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." @@ -25113,7 +22585,10 @@ "properties": { "files": { "type": "array", - "items": {}, + "items": { + "type": "string", + "format": "binary" + }, "description": "Skill files to upload. Upload a single zip file or multiple individual files with relative paths." }, "default": { @@ -25214,7 +22689,7 @@ "readOnly": true } }, - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "allOf": [ @@ -25224,49 +22699,6 @@ ], "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": [ @@ -25496,7 +22928,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tags to assign to the output. Applies only to dataset outputs (evaluation scenario); ignored for Azure OpenAI file outputs." @@ -25682,15 +23114,13 @@ }, "schema": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The overall object JSON schema for the run data source items." } }, "discriminator": { "propertyName": "type", - "mapping": { - "azure_ai_source": "#/components/schemas/AzureAIDataSourceConfig" - } + "mapping": {} }, "description": "Base class for run data sources with discriminator support." }, @@ -25729,7 +23159,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary of the output dataset.", @@ -25811,6 +23241,50 @@ ], "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": [ @@ -25921,7 +23395,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -26302,7 +23776,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. The service defaults to `false` if a value is not specified by the caller.", + "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`.", "default": false } }, @@ -26509,14 +23983,13 @@ "description": "The Unix timestamp (in seconds) for when the eval was created." }, "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "modified_at": { "allOf": [ @@ -26532,7 +24005,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "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." @@ -26724,14 +24197,13 @@ "description": "Information about the run's data source." }, "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "error": { "$ref": "#/components/schemas/OpenAI.EvalApiError" @@ -26750,7 +24222,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "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." @@ -26854,7 +24326,7 @@ }, "datasource_item": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "Details of the input data source item." }, "results": { @@ -26910,15 +24382,9 @@ "description": "Whether the grader considered the output a pass." }, "sample": { - "anyOf": [ - { - "type": "object", - "unevaluatedProperties": {} - }, - { - "type": "null" - } - ], + "type": "object", + "additionalProperties": {}, + "nullable": true, "description": "Optional sample or intermediate data produced by the grader." }, "status": { @@ -26948,13 +24414,13 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Additional details about the test criteria metric." } }, - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "A single grader result for an evaluation run output item.", "title": "EvalRunOutputItemResult" }, @@ -27170,21 +24636,21 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Evaluation's tags. Unlike properties, tags are fully mutable." }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Evaluation's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed." }, "evaluators": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/EvaluatorConfiguration" }, "description": "Evaluators to be used for the evaluation." @@ -27414,7 +24880,7 @@ }, "systemData": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "System metadata for the evaluation rule.", @@ -27579,7 +25045,6 @@ }, "evalRun": { "type": "object", - "unevaluatedProperties": {}, "description": "The evaluation run payload." } }, @@ -27752,7 +25217,7 @@ }, "initialization_parameters": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "Optional initialization parameters applied to all generated evaluators.\nFor example, deployment_name for LLM judge model, default threshold." }, "data_generation_options": { @@ -28141,7 +25606,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -28235,7 +25700,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -28320,7 +25785,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Additional properties for the evaluation taxonomy." @@ -28340,7 +25805,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -28362,7 +25827,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Additional properties for the evaluation taxonomy." @@ -28440,7 +25905,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -28462,7 +25927,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Additional properties for the evaluation taxonomy." @@ -28498,12 +25963,12 @@ }, "initParams": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "Initialization parameters of the evaluator." }, "dataMapping": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Data parameters of the evaluator." @@ -28546,17 +26011,17 @@ }, "init_parameters": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The JSON schema (Draft 2020-12) for the evaluator's input parameters. This includes parameters like type, properties, required." }, "data_schema": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The JSON schema (Draft 2020-12) for the evaluator's input data. This includes parameters like type, properties, required." }, "metrics": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/EvaluatorMetric" }, "description": "List of output metrics produced by this evaluator" @@ -28921,7 +26386,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Metadata about the evaluator" @@ -28941,16 +26406,6 @@ }, "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": [ { @@ -29015,7 +26470,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Metadata about the evaluator" @@ -29035,16 +26490,6 @@ }, "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": [ { @@ -29059,7 +26504,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -29076,7 +26521,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Metadata about the evaluator" @@ -29088,23 +26533,13 @@ }, "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", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -29266,13 +26701,17 @@ "require_approval": { "anyOf": [ { - "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" - }, - { - "type": "string" + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" + } + ], + "nullable": true }, { - "type": "null" + "type": "string", + "nullable": true } ], "description": "(Optional) Whether the agent requires approval before executing actions. Default is always.", @@ -29323,13 +26762,17 @@ "require_approval": { "anyOf": [ { - "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" - }, - { - "type": "string" + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" + } + ], + "nullable": true }, { - "type": "null" + "type": "string", + "nullable": true } ], "description": "(Optional) Whether the agent requires approval before executing actions. Default is always.", @@ -29473,14 +26916,12 @@ "description": "Ranking options for search." }, "filters": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Filters" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "vector_store_ids": { "type": "array", @@ -29706,40 +27147,19 @@ }, "description": "Details of a function tool call." }, - "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": { + "GitHubIssueOpenedRoutineTrigger": { "type": "object", "required": [ "type", "connection_id", - "owner", - "repository", - "issue_event" + "assignee", + "repository" ], "properties": { "type": { "type": "string", "enum": [ - "github_issue" + "github_issue_opened" ], "description": "The trigger type." }, @@ -29748,23 +27168,15 @@ "maxLength": 256, "description": "The workspace connection identifier that resolves the GitHub configuration for the trigger." }, - "owner": { + "assignee": { "type": "string", "maxLength": 128, - "description": "The GitHub owner or organization that scopes which issues can fire the trigger." + "description": "The GitHub assignee or organization filter 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": [ @@ -29772,7 +27184,7 @@ "$ref": "#/components/schemas/RoutineTrigger" } ], - "description": "A GitHub issue routine trigger.", + "description": "A GitHub issue-opened routine trigger.", "x-ms-foundry-meta": { "conditional_previews": [ "Routines=V1Preview" @@ -29822,23 +27234,17 @@ "header_name": { "type": "string", "description": "The name of the HTTP header to inject the secret value into.", - "examples": [ - "X-Otlp-Api-Key" - ] + "example": "X-Otlp-Api-Key" }, "secret_id": { "type": "string", "description": "The identifier of the secret store or connection.", - "examples": [ - "my-secret-store" - ] + "example": "my-secret-store" }, "secret_key": { "type": "string", "description": "The key within the secret to retrieve the authentication value.", - "examples": [ - "OTLP_KEY" - ] + "example": "OTLP_KEY" } }, "allOf": [ @@ -29877,29 +27283,23 @@ "cpu": { "type": "string", "description": "The CPU configuration for the hosted agent.", - "examples": [ - "0.25" - ] + "example": "0.25" }, "memory": { "type": "string", "description": "The memory configuration for the hosted agent.", - "examples": [ - "0.5Gi" - ] + "example": "0.5Gi" }, "environment_variables": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Environment variables to set in the hosted agent container.", - "examples": [ - { - "name": "LOG_LEVEL", - "value": "debug" - } - ] + "example": { + "name": "LOG_LEVEL", + "value": "debug" + } }, "container_configuration": { "allOf": [ @@ -29920,17 +27320,15 @@ "$ref": "#/components/schemas/ProtocolVersionRecord" }, "description": "The protocols that the agent supports for ingress communication.", - "examples": [ - [ - { - "protocol": "responses", - "version": "v0.1.1" - }, - { - "protocol": "a2a", - "version": "v0.3.0" - } - ] + "example": [ + { + "protocol": "responses", + "version": "v0.1.1" + }, + { + "protocol": "a2a", + "version": "v0.3.0" + } ], "x-ms-foundry-meta": { "required_previews": [ @@ -30127,7 +27525,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -30383,12 +27781,12 @@ }, "features": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "Features to help with additional filtering of data in UX." }, "correlationInfo": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "Info about the correlation for the analysis sample." } }, @@ -30507,8 +27905,7 @@ "InvokeAgentInvocationsApiDispatchPayload": { "type": "object", "required": [ - "type", - "input" + "type" ], "properties": { "type": { @@ -30519,7 +27916,9 @@ "description": "The manual dispatch payload type." }, "input": { - "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." + "type": "string", + "maxLength": 32768, + "description": "The raw input sent to the downstream invocations target." } }, "allOf": [ @@ -30537,7 +27936,8 @@ "InvokeAgentInvocationsApiRoutineAction": { "type": "object", "required": [ - "type" + "type", + "agent_endpoint_id" ], "properties": { "type": { @@ -30547,18 +27947,10 @@ ], "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": "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." + "description": "The endpoint-scoped agent identifier for invocations API dispatch." }, "session_id": { "type": "string", @@ -30571,7 +27963,7 @@ "$ref": "#/components/schemas/RoutineAction" } ], - "description": "Dispatches a routine through the raw invocations API. Exactly one of agent_name or agent_endpoint_id must be provided.", + "description": "Dispatches a routine through the raw invocations API.", "x-ms-foundry-meta": { "conditional_previews": [ "Routines=V1Preview" @@ -30581,8 +27973,7 @@ "InvokeAgentResponsesApiDispatchPayload": { "type": "object", "required": [ - "type", - "input" + "type" ], "properties": { "type": { @@ -30593,7 +27984,9 @@ "description": "The manual dispatch payload type." }, "input": { - "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." + "type": "string", + "maxLength": 32768, + "description": "The user input sent to the downstream responses target." } }, "allOf": [ @@ -30624,17 +28017,14 @@ "agent_name": { "type": "string", "maxLength": 256, - "description": "The project-scoped agent name for routine dispatch." + "description": "The project-scoped agent name for responses API dispatch." }, "agent_endpoint_id": { "type": "string", "maxLength": 256, - "description": "Legacy endpoint-scoped agent identifier for routine dispatch." + "description": "The endpoint-scoped agent identifier for responses API 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": { + "conversation_id": { "type": "string", "maxLength": 256, "description": "An optional existing conversation identifier to continue during the downstream dispatch." @@ -30716,8 +28106,7 @@ "red_team_seed_prompts": "#/components/schemas/RedTeamSeedPromptsItemGenerationParams", "red_team_taxonomy": "#/components/schemas/RedTeamTaxonomyItemGenerationParams", "response_retrieval": "#/components/schemas/ResponseRetrievalItemGenerationParams", - "conversation_gen_preview": "#/components/schemas/ConversationGenPreviewItemGenerationParams", - "synthetic_data_gen_preview": "#/components/schemas/SyntheticDataGenerationPreviewItemGenerationParams" + "conversation_gen_preview": "#/components/schemas/ConversationGenPreviewItemGenerationParams" } }, "description": "Represents the set of parameters used to control item generation operations." @@ -30832,17 +28221,11 @@ "description": "Optional description of the MCP server, used to provide more context." }, "headers": { - "anyOf": [ - { - "type": "object", - "unevaluatedProperties": { - "type": "string" - } - }, - { - "type": "null" - } - ] + "type": "object", + "additionalProperties": { + "type": "string" + }, + "nullable": true }, "allowed_tools": { "anyOf": [ @@ -30850,38 +28233,42 @@ "type": "array", "items": { "type": "string" - } - }, - { - "$ref": "#/components/schemas/OpenAI.MCPToolFilter" + }, + "nullable": true }, { - "type": "null" + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MCPToolFilter" + } + ], + "nullable": true } ] }, "require_approval": { "anyOf": [ { - "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" + } + ], + "nullable": true }, { "type": "string", "enum": [ "always", "never" - ] - }, - { - "type": "null" + ], + "nullable": true } ], "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." @@ -31343,17 +28730,11 @@ "description": "The status of the tool call." }, "memories": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/MemoryItem" - } - }, - { - "type": "null" - } - ], + "type": "array", + "items": { + "$ref": "#/components/schemas/MemoryItem" + }, + "nullable": true, "description": "The results returned from the memory search." } }, @@ -31431,7 +28812,7 @@ }, "procedural_memory_enabled": { "type": "boolean", - "description": "Whether to enable procedural memory extraction and storage. The service defaults to `true` if a value is not specified by the caller.", + "description": "Whether to enable procedural memory extraction and storage. Defaults to `true`.", "default": true }, "default_ttl_seconds": { @@ -31581,7 +28962,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Arbitrary key-value metadata to associate with the memory store." @@ -31923,7 +29304,7 @@ }, "capabilities": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Capabilities of deployed model", @@ -32144,7 +29525,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -32351,7 +29732,8 @@ "create_file" ], "description": "Create a new file with the provided diff.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "create_file" }, "path": { "type": "string", @@ -32384,7 +29766,8 @@ "create_file" ], "description": "The operation type. Always `create_file`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "create_file" }, "path": { "type": "string", @@ -32418,7 +29801,8 @@ "delete_file" ], "description": "Delete the specified file.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "delete_file" }, "path": { "type": "string", @@ -32446,7 +29830,8 @@ "delete_file" ], "description": "The operation type. Always `delete_file`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "delete_file" }, "path": { "type": "string", @@ -32546,7 +29931,8 @@ "apply_patch" ], "description": "The type of the tool. Always `apply_patch`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "apply_patch" } }, "allOf": [ @@ -32571,7 +29957,8 @@ "update_file" ], "description": "Update an existing file with the provided diff.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "update_file" }, "path": { "type": "string", @@ -32604,7 +29991,8 @@ "update_file" ], "description": "The operation type. Always `update_file`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "update_file" }, "path": { "type": "string", @@ -32641,44 +30029,20 @@ "default": "approximate" }, "country": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "region": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "city": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "timezone": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } } }, @@ -32706,14 +30070,12 @@ "description": "An optional list of uploaded files to make available to your code." }, "memory_limit": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.ContainerMemoryLimit" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "network_policy": { "$ref": "#/components/schemas/OpenAI.ContainerNetworkPolicyParam" @@ -32747,12 +30109,6 @@ "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", @@ -32852,7 +30208,8 @@ "click" ], "description": "Specifies the event type. For a click action, this property is always `click`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "click" }, "button": { "allOf": [ @@ -32877,19 +30234,6 @@ } ], "description": "The y-coordinate where the click occurred." - }, - "keys": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] } }, "allOf": [ @@ -33056,61 +30400,17 @@ "items": { "$ref": "#/components/schemas/OpenAI.InputItem" } - }, - { - "type": "null" } - ] + ], + "nullable": true }, "previous_response_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "instructions": { - "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" - } - ] + "type": "string", + "nullable": true } } }, @@ -33130,9 +30430,7 @@ "gt", "gte", "lt", - "lte", - "in", - "nin" + "lte" ], "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" @@ -33234,14 +30532,6 @@ } } }, - "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": [ { @@ -33274,24 +30564,12 @@ "description": "The ID of the pending safety check." }, "code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "message": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "description": "A pending safety check for the computer call." @@ -33311,8 +30589,7 @@ "required": [ "type", "image_url", - "file_id", - "detail" + "file_id" ], "properties": { "type": { @@ -33321,36 +30598,17 @@ "computer_screenshot" ], "description": "Specifies the event type. For a computer screenshot, this property is always set to `computer_screenshot`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "computer_screenshot" }, "image_url": { - "anyOf": [ - { - "type": "string", - "format": "uri" - }, - { - "type": "null" - } - ] + "type": "string", + "format": "uri", + "nullable": true }, "file_id": { - "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`." + "type": "string", + "nullable": true } }, "allOf": [ @@ -33388,29 +30646,6 @@ }, "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": [ @@ -33426,7 +30661,8 @@ "computer_use_preview" ], "description": "The type of the computer use tool. Always `computer_use_preview`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "computer_use_preview" }, "environment": { "allOf": [ @@ -33473,7 +30709,8 @@ "container_auto" ], "description": "Automatically creates a container for this request", - "x-stainless-const": true + "x-stainless-const": true, + "default": "container_auto" }, "file_ids": { "type": "array", @@ -33484,14 +30721,12 @@ "description": "An optional list of uploaded files to make available to your code." }, "memory_limit": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.ContainerMemoryLimit" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "skills": { "type": "array", @@ -33528,7 +30763,8 @@ "container_file_citation" ], "description": "The type of the container file citation. Always `container_file_citation`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "container_file_citation" }, "container_id": { "type": "string", @@ -33589,7 +30825,8 @@ "allowlist" ], "description": "Allow outbound network access only to specified domains. Always `allowlist`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "allowlist" }, "allowed_domains": { "type": "array", @@ -33598,6 +30835,14 @@ }, "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": [ @@ -33618,7 +30863,8 @@ "disabled" ], "description": "Disable outbound network access. Always `disabled`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "disabled" } }, "allOf": [ @@ -33627,6 +30873,32 @@ } ] }, + "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": [ @@ -33673,7 +30945,8 @@ "container_reference" ], "description": "The environment type. Always `container_reference`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "container_reference" }, "container_id": { "type": "string" @@ -33730,14 +31003,13 @@ "description": "The context management entry type. Currently only 'compaction' is supported." }, "compact_threshold": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true } } }, @@ -33755,18 +31027,14 @@ "propertyName": "type", "mapping": { "message": "#/components/schemas/OpenAI.ConversationItemMessage", - "function_call": "#/components/schemas/OpenAI.ConversationItemFunctionToolCall", - "function_call_output": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutput", + "function_call": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallResource", + "function_call_output": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutputResource", "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.ConversationItemComputerToolCallOutput", - "tool_search_call": "#/components/schemas/OpenAI.ConversationItemToolSearchCall", - "tool_search_output": "#/components/schemas/OpenAI.ConversationItemToolSearchOutput", - "additional_tools": "#/components/schemas/OpenAI.ConversationItemAdditionalTools", + "computer_call_output": "#/components/schemas/OpenAI.ConversationItemComputerToolCallOutputResource", "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", @@ -33778,57 +31046,13 @@ "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.ConversationItemCustomToolCallResource", - "custom_tool_call_output": "#/components/schemas/OpenAI.ConversationItemCustomToolCallOutputResource" + "custom_tool_call": "#/components/schemas/OpenAI.ConversationItemCustomToolCall", + "custom_tool_call_output": "#/components/schemas/OpenAI.ConversationItemCustomToolCallOutput" } }, "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": [ @@ -33921,14 +31145,8 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "created_by": { "type": "string", @@ -33983,34 +31201,22 @@ "description": "The ID of the container used to run the code." }, "code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "outputs": { - "anyOf": [ - { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" - } - ] + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" } - }, - { - "type": "null" - } - ] + ] + }, + "nullable": true } }, "allOf": [ @@ -34021,50 +31227,13 @@ "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" ], @@ -34088,9 +31257,6 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, - "actions": { - "$ref": "#/components/schemas/OpenAI.ComputerActionList" - }, "pending_safety_checks": { "type": "array", "items": { @@ -34116,11 +31282,10 @@ "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.ConversationItemComputerToolCallOutput": { + "OpenAI.ConversationItemComputerToolCallOutputResource": { "type": "object", "required": [ "type", - "id", "call_id", "output" ], @@ -34136,8 +31301,7 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output.", - "readOnly": true + "description": "The ID of the computer tool call output." }, "call_id": { "type": "string", @@ -34167,60 +31331,40 @@ { "$ref": "#/components/schemas/OpenAI.ConversationItem" } - ], - "description": "The output of a computer tool call.", - "title": "Computer tool call output" + ] }, - "OpenAI.ConversationItemCustomToolCallOutputResource": { + "OpenAI.ConversationItemCustomToolCall": { "type": "object", "required": [ "type", "call_id", - "output", - "status" + "name", + "input" ], "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." - }, - "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." + "description": "An identifier used to map this custom tool call to a tool call output." }, - "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." + "name": { + "type": "string", + "description": "The name of the custom tool being called." }, - "created_by": { + "input": { "type": "string", - "description": "The identifier of the actor that created the item." + "description": "The input for the custom tool call generated by the model." } }, "allOf": [ @@ -34228,57 +31372,46 @@ "$ref": "#/components/schemas/OpenAI.ConversationItem" } ], - "title": "ResponseCustomToolCallOutputItem" + "description": "A call to a custom tool created by the model.", + "title": "Custom tool call" }, - "OpenAI.ConversationItemCustomToolCallResource": { + "OpenAI.ConversationItemCustomToolCallOutput": { "type": "object", "required": [ "type", "call_id", - "name", - "input", - "status" + "output" ], "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." - }, - "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." + "description": "The call ID, used to map this custom tool call output to a custom tool call." }, - "status": { - "allOf": [ + "output": { + "oneOf": [ + { + "type": "string" + }, { - "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } } ], - "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." + "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." } }, "allOf": [ @@ -34286,7 +31419,8 @@ "$ref": "#/components/schemas/OpenAI.ConversationItem" } ], - "title": "ResponseCustomToolCallItem" + "description": "The output of a custom tool call from your code, being sent back to the model.", + "title": "Custom tool call output" }, "OpenAI.ConversationItemFileSearchToolCall": { "type": "object", @@ -34328,17 +31462,11 @@ "description": "The queries used to search for files." }, "results": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + }, + "nullable": true } }, "allOf": [ @@ -34388,20 +31516,19 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" + "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." }, "environment": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallEnvironment" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "created_by": { "type": "string", @@ -34447,7 +31574,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -34460,14 +31587,13 @@ "description": "An array of shell call output contents" }, "max_output_length": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "created_by": { "type": "string", @@ -34482,44 +31608,43 @@ "description": "The output of a shell tool call that was emitted.", "title": "Shell call output" }, - "OpenAI.ConversationItemFunctionToolCall": { + "OpenAI.ConversationItemFunctionToolCallOutputResource": { "type": "object", "required": [ - "id", "type", "call_id", - "name", - "arguments" + "output" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call.", - "readOnly": true + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." }, "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." }, - "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." + "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", @@ -34535,49 +31660,40 @@ { "$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.ConversationItemFunctionToolCallOutput": { + "OpenAI.ConversationItemFunctionToolCallResource": { "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.", - "readOnly": true + "description": "The unique ID of the function tool call." }, "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." + "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", @@ -34593,9 +31709,7 @@ { "$ref": "#/components/schemas/OpenAI.ConversationItem" } - ], - "description": "The output of a function tool call.", - "title": "Function tool call output" + ] }, "OpenAI.ConversationItemImageGenToolCall": { "type": "object", @@ -34629,14 +31743,8 @@ "description": "The status of the image generation call." }, "result": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -34766,19 +31874,13 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "anyOf": [ - { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, - { - "type": "null" - } - ] + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "nullable": true } }, "allOf": [ @@ -34862,14 +31964,8 @@ "description": "Whether the request was approved." }, "reason": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -34913,7 +32009,8 @@ "description": "The tools available on the server." }, "error": { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + "type": "string", + "nullable": true } }, "allOf": [ @@ -34959,18 +32056,12 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "error": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, "status": { "allOf": [ @@ -34981,14 +32072,8 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -35044,16 +32129,6 @@ "$ref": "#/components/schemas/OpenAI.MessageContent" }, "description": "The content of the message" - }, - "phase": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessagePhase" - }, - { - "type": "null" - } - ] } }, "allOf": [ @@ -35085,14 +32160,8 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "summary": { "type": "array", @@ -35126,138 +32195,6 @@ "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": [ { @@ -35274,11 +32211,7 @@ "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", @@ -35467,8 +32400,7 @@ "propertyName": "type", "mapping": { "text": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText", - "json_object": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject", - "json_schema": "#/components/schemas/OpenAI.ResponseFormatJsonSchema" + "json_object": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject" } }, "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." @@ -35538,27 +32470,20 @@ "type": "object", "properties": { "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "items": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.InputItem" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.InputItem" + }, + "nullable": true } } }, @@ -35736,7 +32661,7 @@ }, "item_schema": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The json schema for each row in the data source." }, "include_sample_schema": { @@ -35805,7 +32730,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "Metadata filters for the logs data source." } }, @@ -36000,7 +32925,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "Metadata filters for the stored completions data source." } }, @@ -36052,52 +32977,33 @@ "deprecated": true }, "suffix": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "type": "string", + "nullable": true, "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": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "type": "string", + "nullable": true, "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": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.CreateFineTuningJobRequestIntegrations" - } - }, - { - "type": "null" - } - ], + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.CreateFineTuningJobRequestIntegrations" + }, + "nullable": true, "description": "A list of integrations to enable for your fine-tuning job." }, "seed": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$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." @@ -36106,14 +33012,13 @@ "$ref": "#/components/schemas/OpenAI.FineTuneMethod" }, "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true } } }, @@ -36193,24 +33098,12 @@ "type": "string" }, "name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "entity": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "tags": { "type": "array", @@ -36397,7 +33290,8 @@ "grammar" ], "description": "Grammar format. Always `grammar`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "grammar" }, "syntax": { "allOf": [ @@ -36432,7 +33326,8 @@ "text" ], "description": "Unconstrained text format. Always `text`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "text" } }, "allOf": [ @@ -36456,7 +33351,8 @@ "custom" ], "description": "The type of the custom tool. Always `custom`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "custom" }, "name": { "type": "string", @@ -36473,10 +33369,6 @@ } ], "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": [ @@ -36549,8 +33441,7 @@ "enum": [ "low", "high", - "auto", - "original" + "auto" ] }, "OpenAI.DoubleClickAction": { @@ -36558,8 +33449,7 @@ "required": [ "type", "x", - "y", - "keys" + "y" ], "properties": { "type": { @@ -36568,7 +33458,8 @@ "double_click" ], "description": "Specifies the event type. For a double click action, this property is always set to `double_click`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "double_click" }, "x": { "allOf": [ @@ -36585,19 +33476,6 @@ } ], "description": "The y-coordinate where the double click occurred." - }, - "keys": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] } }, "allOf": [ @@ -36621,7 +33499,8 @@ "drag" ], "description": "Specifies the event type. For a drag action, this property is always set to `drag`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "drag" }, "path": { "type": "array", @@ -36629,19 +33508,6 @@ "$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": [ @@ -36681,16 +33547,6 @@ ], "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": [ @@ -36717,9 +33573,6 @@ "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": [ @@ -36728,27 +33581,15 @@ ], "properties": { "code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "message": { "type": "string" }, "param": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "type": { "type": "string" @@ -36761,11 +33602,11 @@ }, "additionalInfo": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, "debugInfo": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} } } }, @@ -36944,45 +33785,41 @@ "type": "object", "properties": { "seed": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "top_p": { - "anyOf": [ + "type": "number", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" - }, - { - "type": "null" } ], + "nullable": true, "default": 1 }, "temperature": { - "anyOf": [ + "type": "number", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "max_completions_tokens": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "reasoning_effort": { "$ref": "#/components/schemas/OpenAI.ReasoningEffort" @@ -37323,11 +34160,11 @@ "properties": { "item": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, "sample": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} } } }, @@ -37368,111 +34205,75 @@ "description": "The type of run data source. Always `responses`." }, "metadata": { - "anyOf": [ - { - "type": "object", - "unevaluatedProperties": {} - }, - { - "type": "null" - } - ] + "type": "object", + "additionalProperties": {}, + "nullable": true }, "model": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "instructions_search": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "created_after": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "created_before": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "reasoning_effort": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.ReasoningEffort" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "temperature": { - "anyOf": [ + "type": "number", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "top_p": { - "anyOf": [ + "type": "number", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "users": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "type": "string" + }, + "nullable": true }, "tools": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "type": "string" + }, + "nullable": true } }, "description": "A EvalResponsesSource object describing a run data source configuration.", @@ -37672,54 +34473,44 @@ "default": "stored_completions" }, "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "model": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "created_after": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "created_before": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "limit": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "description": "A StoredCompletionsRunDataSource configuration describing a set of filters", @@ -37745,7 +34536,8 @@ "file_citation" ], "description": "The type of the file citation. Always `file_citation`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "file_citation" }, "file_id": { "type": "string", @@ -37772,13 +34564,6 @@ "description": "A citation to a file.", "title": "File citation" }, - "OpenAI.FileInputDetail": { - "type": "string", - "enum": [ - "low", - "high" - ] - }, "OpenAI.FilePath": { "type": "object", "required": [ @@ -37829,7 +34614,8 @@ "file_search" ], "description": "The type of the file search tool. Always `file_search`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "file_search" }, "vector_store_ids": { "type": "array", @@ -37855,14 +34641,12 @@ "description": "Ranking options for search." }, "filters": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Filters" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "name": { "type": "string", @@ -37894,14 +34678,13 @@ "type": "string" }, "attributes": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.VectorStoreFileAttributes" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "score": { "type": "number", @@ -38256,24 +35039,12 @@ "type": "string" }, "name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "entity": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "tags": { "type": "array", @@ -38313,37 +35084,22 @@ "description": "The Unix timestamp (in seconds) for when the fine-tuning job was created." }, "error": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FineTuningJobError" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "fine_tuned_model": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "finished_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], "type": "integer", - "format": "unixTimestamp" + "format": "unixtime", + "nullable": true }, "hyperparameters": { "allOf": [ @@ -38389,41 +35145,28 @@ "description": "The current status of the fine-tuning job, which can be either `validating_files`, `queued`, `running`, `succeeded`, `failed`, or `cancelled`." }, "trained_tokens": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$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": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "integrations": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FineTuningIntegration" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FineTuningIntegration" + }, + "nullable": true }, "seed": { "allOf": [ @@ -38434,30 +35177,21 @@ "description": "The seed used for the fine-tuning job." }, "estimated_finish": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], "type": "integer", - "format": "unixTimestamp" + "format": "unixtime", + "nullable": true }, "method": { "$ref": "#/components/schemas/OpenAI.FineTuneMethod" }, "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$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.", @@ -38569,14 +35303,8 @@ "type": "string" }, "param": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } } }, @@ -38655,13 +35383,17 @@ "type": "string", "enum": [ "auto" - ] + ], + "nullable": true }, { - "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" + "type": "integer", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + } + ], + "nullable": true } ], "default": "auto" @@ -38731,35 +35463,21 @@ "default": "input_file" }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "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." }, - "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`." + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." } }, "allOf": [ @@ -38787,25 +35505,13 @@ "default": "input_image" }, "image_url": { - "anyOf": [ - { - "type": "string", - "format": "uri" - }, - { - "type": "null" - } - ] + "type": "string", + "format": "uri", + "nullable": true }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "detail": { "allOf": [ @@ -38813,7 +35519,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." } }, "allOf": [ @@ -38876,22 +35582,6 @@ "incomplete" ] }, - "OpenAI.FunctionCallOutputStatusEnum": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, - "OpenAI.FunctionCallStatus": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, "OpenAI.FunctionObject": { "type": "object", "required": [ @@ -38910,20 +35600,14 @@ "$ref": "#/components/schemas/OpenAI.FunctionParameters" }, "strict": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ] + "type": "boolean", + "nullable": true } } }, "OpenAI.FunctionParameters": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "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": { @@ -38941,24 +35625,22 @@ } }, "timeout_ms": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "max_output_length": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "description": "Execute a shell command.", @@ -38978,24 +35660,22 @@ "description": "Ordered shell commands for the execution environment to run." }, "timeout_ms": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "max_output_length": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "description": "Commands and limits describing how to run the shell tool call.", @@ -39209,7 +35889,8 @@ "exit" ], "description": "The outcome type. Always `exit`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "exit" }, "exit_code": { "allOf": [ @@ -39241,7 +35922,8 @@ "exit" ], "description": "The outcome type. Always `exit`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "exit" }, "exit_code": { "allOf": [ @@ -39328,14 +36010,6 @@ } ] }, - "OpenAI.FunctionShellCallOutputStatusEnum": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, "OpenAI.FunctionShellCallOutputTimeoutOutcome": { "type": "object", "required": [ @@ -39348,7 +36022,8 @@ "timeout" ], "description": "The outcome type. Always `timeout`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "timeout" } }, "allOf": [ @@ -39371,7 +36046,8 @@ "timeout" ], "description": "The outcome type. Always `timeout`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "timeout" } }, "allOf": [ @@ -39382,14 +36058,6 @@ "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": [ @@ -39402,17 +36070,17 @@ "shell" ], "description": "The type of the shell tool. Always `shell`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "shell" }, "environment": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellToolParamEnvironment" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "name": { "type": "string", @@ -39537,46 +36205,25 @@ "function" ], "description": "The type of the function tool. Always `function`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "function" }, "name": { "type": "string", "description": "The name of the function to call." }, "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "parameters": { - "anyOf": [ - { - "type": "object", - "unevaluatedProperties": {} - }, - { - "type": "null" - } - ] + "type": "object", + "additionalProperties": {}, + "nullable": true }, "strict": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ] - }, - "defer_loading": { "type": "boolean", - "description": "Whether this function is deferred and loaded via tool search." + "nullable": true } }, "allOf": [ @@ -39587,62 +36234,61 @@ "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.FunctionToolParam": { + "OpenAI.FunctionToolCallOutput": { "type": "object", "required": [ - "name", - "type" + "type", + "call_id", + "output" ], "properties": { - "name": { + "id": { "type": "string", - "minLength": 1, - "maxLength": 128, - "pattern": "^[a-zA-Z0-9_-]+$" + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." }, - "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": { + "type": "string", + "enum": [ + "function_call_output" + ], + "description": "The type of the function tool call output. Always `function_call_output`.", + "x-stainless-const": true }, - "parameters": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.EmptyModelParam" - }, - { - "type": "null" - } - ] + "call_id": { + "type": "string", + "description": "The unique ID of the function tool call generated by the model." }, - "strict": { - "anyOf": [ + "output": { + "oneOf": [ { - "type": "boolean" + "type": "string" }, { - "type": "null" + "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." }, - "type": { + "status": { "type": "string", "enum": [ - "function" + "in_progress", + "completed", + "incomplete" ], - "x-stainless-const": true, - "default": "function" - }, - "defer_loading": { - "type": "boolean", - "description": "Whether this function should be deferred and discovered via tool search." + "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.GraderLabelModel": { "type": "object", @@ -39990,8 +36636,7 @@ "enum": [ "low", "high", - "auto", - "original" + "auto" ] }, "OpenAI.ImageGenActionEnum": { @@ -40014,7 +36659,8 @@ "image_generation" ], "description": "The type of the image generation tool. Always `image_generation`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "image_generation" }, "model": { "anyOf": [ @@ -40044,21 +36690,14 @@ "default": "auto" }, "size": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "enum": [ - "1024x1024", - "1024x1536", - "1536x1024", - "auto" - ] - } + "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`.", + "description": "The size of the generated image. One of `1024x1024`, `1024x1536`,\n `1536x1024`, or `auto`. Default: `auto`.", "default": "auto" }, "output_format": { @@ -40102,14 +36741,12 @@ "default": "auto" }, "input_fidelity": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.InputFidelity" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "input_image_mask": { "allOf": [ @@ -40186,7 +36823,7 @@ ] } ], - "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)." + "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)." }, "OpenAI.InlineSkillParam": { "type": "object", @@ -40203,7 +36840,8 @@ "inline" ], "description": "Defines an inline skill for this request.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "inline" }, "name": { "type": "string", @@ -40344,35 +36982,21 @@ "default": "input_file" }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "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." }, - "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`." + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." } }, "allOf": [ @@ -40400,25 +37024,13 @@ "default": "input_image" }, "image_url": { - "anyOf": [ - { - "type": "string", - "format": "uri" - }, - { - "type": "null" - } - ] + "type": "string", + "format": "uri", + "nullable": true }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "detail": { "allOf": [ @@ -40426,7 +37038,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." } }, "allOf": [ @@ -40505,35 +37117,21 @@ "default": "input_file" }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "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." }, - "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`." + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." } }, "description": "A file input to the model.", @@ -40555,53 +37153,21 @@ "default": "input_file" }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "filename": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "file_data": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "file_url": { - "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`." + "type": "string", + "format": "uri", + "nullable": true } }, "description": "A file input to the model.", @@ -40624,25 +37190,13 @@ "default": "input_image" }, "image_url": { - "anyOf": [ - { - "type": "string", - "format": "uri" - }, - { - "type": "null" - } - ] + "type": "string", + "format": "uri", + "nullable": true }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "detail": { "allOf": [ @@ -40650,7 +37204,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." } }, "description": "An image input to the model. Learn about [image inputs](/docs/guides/vision).", @@ -40672,35 +37226,21 @@ "default": "input_image" }, "image_url": { - "anyOf": [ - { - "type": "string", - "format": "uri" - }, - { - "type": "null" - } - ] + "type": "string", + "format": "uri", + "nullable": true }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "detail": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.DetailEnum" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "description": "An image input to the model. Learn about [image inputs](/docs/guides/vision)", @@ -40728,9 +37268,6 @@ "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", @@ -40751,56 +37288,6 @@ }, "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": [ @@ -40820,14 +37307,8 @@ "default": "apply_patch_call" }, "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -40878,14 +37359,8 @@ "default": "apply_patch_call_output" }, "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -40902,14 +37377,8 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -40960,34 +37429,22 @@ "description": "The ID of the container used to run the code." }, "code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "outputs": { - "anyOf": [ - { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" - } - ] + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" } - }, - { - "type": "null" - } - ] + ] + }, + "nullable": true } }, "allOf": [ @@ -41006,14 +37463,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "type": { "type": "string", @@ -41047,14 +37498,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -41075,27 +37520,19 @@ "$ref": "#/components/schemas/OpenAI.ComputerScreenshotImage" }, "acknowledged_safety_checks": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" + }, + "nullable": true }, "status": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "allOf": [ @@ -41112,6 +37549,7 @@ "type", "id", "call_id", + "action", "pending_safety_checks", "status" ], @@ -41135,9 +37573,6 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, - "actions": { - "$ref": "#/components/schemas/OpenAI.ComputerActionList" - }, "pending_safety_checks": { "type": "array", "items": { @@ -41188,10 +37623,6 @@ "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." @@ -41296,17 +37727,11 @@ "description": "The queries used to search for files." }, "results": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + }, + "nullable": true } }, "allOf": [ @@ -41326,14 +37751,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -41375,14 +37794,12 @@ "description": "Text, image, or file output of the function tool call." }, "status": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "allOf": [ @@ -41402,14 +37819,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -41435,24 +37846,21 @@ "description": "The shell commands and limits that describe how to run the tool call." }, "status": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemStatus" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "environment": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemParamEnvironment" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "allOf": [ @@ -41472,14 +37880,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -41504,24 +37906,21 @@ "description": "Captured chunks of stdout and stderr output, along with their associated outcomes." }, "status": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemStatus" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "max_output_length": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "allOf": [ @@ -41535,7 +37934,6 @@ "OpenAI.InputItemFunctionToolCall": { "type": "object", "required": [ - "id", "type", "call_id", "name", @@ -41544,8 +37942,7 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call.", - "readOnly": true + "description": "The unique ID of the function tool call." }, "type": { "type": "string", @@ -41559,10 +37956,6 @@ "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." @@ -41621,14 +38014,8 @@ "description": "The status of the image generation call." }, "result": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -41711,19 +38098,13 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "anyOf": [ - { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, - { - "type": "null" - } - ] + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "nullable": true } }, "allOf": [ @@ -41794,14 +38175,8 @@ "x-stainless-const": true }, "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "approval_request_id": { "type": "string", @@ -41812,14 +38187,8 @@ "description": "Whether the request was approved." }, "reason": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -41863,7 +38232,8 @@ "description": "The tools available on the server." }, "error": { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + "type": "string", + "nullable": true } }, "allOf": [ @@ -41909,18 +38279,12 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "error": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, "status": { "allOf": [ @@ -41931,14 +38295,8 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -41986,16 +38344,6 @@ }, "description": "The content of the output message." }, - "phase": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessagePhase" - }, - { - "type": "null" - } - ] - }, "status": { "type": "string", "enum": [ @@ -42035,14 +38383,8 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "summary": { "type": "array", @@ -42076,143 +38418,6 @@ "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": [ { @@ -42229,9 +38434,6 @@ "web_search_call", "function_call", "function_call_output", - "tool_search_call", - "tool_search_output", - "additional_tools", "reasoning", "compaction", "image_generation_call", @@ -42307,6 +38509,52 @@ "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": { @@ -42315,6 +38563,55 @@ "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": [ { @@ -42391,7 +38688,7 @@ "discriminator": { "propertyName": "type", "mapping": { - "message": "#/components/schemas/OpenAI.ItemInputMessage", + "message": "#/components/schemas/OpenAI.InputMessage", "output_message": "#/components/schemas/OpenAI.ItemOutputMessage", "file_search_call": "#/components/schemas/OpenAI.ItemFileSearchToolCall", "computer_call": "#/components/schemas/OpenAI.ItemComputerToolCall", @@ -42399,9 +38696,6 @@ "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", @@ -42422,56 +38716,6 @@ }, "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": [ @@ -42491,14 +38735,8 @@ "default": "apply_patch_call" }, "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -42549,14 +38787,8 @@ "default": "apply_patch_call_output" }, "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -42573,14 +38805,8 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -42631,34 +38857,22 @@ "description": "The ID of the container used to run the code." }, "code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "outputs": { - "anyOf": [ - { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" - } - ] + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" } - }, - { - "type": "null" - } - ] + ] + }, + "nullable": true } }, "allOf": [ @@ -42677,14 +38891,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "type": { "type": "string", @@ -42718,14 +38926,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -42746,27 +38948,19 @@ "$ref": "#/components/schemas/OpenAI.ComputerScreenshotImage" }, "acknowledged_safety_checks": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" + }, + "nullable": true }, "status": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "allOf": [ @@ -42783,6 +38977,7 @@ "type", "id", "call_id", + "action", "pending_safety_checks", "status" ], @@ -42806,9 +39001,6 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, - "actions": { - "$ref": "#/components/schemas/OpenAI.ComputerActionList" - }, "pending_safety_checks": { "type": "array", "items": { @@ -42859,10 +39051,6 @@ "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." @@ -42940,17 +39128,14 @@ "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.ItemFieldComputerToolCallOutput", + "computer_call_output": "#/components/schemas/OpenAI.ItemFieldComputerToolCallOutputResource", "reasoning": "#/components/schemas/OpenAI.ItemFieldReasoningItem", "compaction": "#/components/schemas/OpenAI.ItemFieldCompactionBody", "code_interpreter_call": "#/components/schemas/OpenAI.ItemFieldCodeInterpreterToolCall", @@ -42970,50 +39155,6 @@ }, "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": [ @@ -43106,14 +39247,8 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "created_by": { "type": "string", @@ -43168,34 +39303,22 @@ "description": "The ID of the container used to run the code." }, "code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "outputs": { - "anyOf": [ - { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" - } - ] + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" } - }, - { - "type": "null" - } - ] + ] + }, + "nullable": true } }, "allOf": [ @@ -43250,6 +39373,7 @@ "type", "id", "call_id", + "action", "pending_safety_checks", "status" ], @@ -43273,9 +39397,6 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, - "actions": { - "$ref": "#/components/schemas/OpenAI.ComputerActionList" - }, "pending_safety_checks": { "type": "array", "items": { @@ -43301,11 +39422,10 @@ "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.ItemFieldComputerToolCallOutput": { + "OpenAI.ItemFieldComputerToolCallOutputResource": { "type": "object", "required": [ "type", - "id", "call_id", "output" ], @@ -43321,8 +39441,7 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output.", - "readOnly": true + "description": "The ID of the computer tool call output." }, "call_id": { "type": "string", @@ -43352,9 +39471,7 @@ { "$ref": "#/components/schemas/OpenAI.ItemField" } - ], - "description": "The output of a computer tool call.", - "title": "Computer tool call output" + ] }, "OpenAI.ItemFieldCustomToolCall": { "type": "object", @@ -43381,10 +39498,6 @@ "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." @@ -43489,17 +39602,11 @@ "description": "The queries used to search for files." }, "results": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + }, + "nullable": true } }, "allOf": [ @@ -43549,20 +39656,19 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" + "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." }, "environment": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallEnvironment" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "created_by": { "type": "string", @@ -43608,7 +39714,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -43621,14 +39727,13 @@ "description": "An array of shell call output contents" }, "max_output_length": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "created_by": { "type": "string", @@ -43646,7 +39751,6 @@ "OpenAI.ItemFieldFunctionToolCall": { "type": "object", "required": [ - "id", "type", "call_id", "name", @@ -43655,8 +39759,7 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call.", - "readOnly": true + "description": "The unique ID of the function tool call." }, "type": { "type": "string", @@ -43670,10 +39773,6 @@ "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." @@ -43700,64 +39799,6 @@ "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": [ @@ -43790,14 +39831,8 @@ "description": "The status of the image generation call." }, "result": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -43880,19 +39915,13 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "anyOf": [ - { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, - { - "type": "null" - } - ] + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "nullable": true } }, "allOf": [ @@ -43976,14 +40005,8 @@ "description": "Whether the request was approved." }, "reason": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -44027,7 +40050,8 @@ "description": "The tools available on the server." }, "error": { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + "type": "string", + "nullable": true } }, "allOf": [ @@ -44073,18 +40097,12 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "error": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, "status": { "allOf": [ @@ -44095,14 +40113,8 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -44158,16 +40170,6 @@ "$ref": "#/components/schemas/OpenAI.MessageContent" }, "description": "The content of the message" - }, - "phase": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessagePhase" - }, - { - "type": "null" - } - ] } }, "allOf": [ @@ -44199,14 +40201,8 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "summary": { "type": "array", @@ -44240,138 +40236,6 @@ "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": [ { @@ -44382,9 +40246,6 @@ "enum": [ "message", "function_call", - "tool_search_call", - "tool_search_output", - "additional_tools", "function_call_output", "file_search_call", "web_search_call", @@ -44504,17 +40365,11 @@ "description": "The queries used to search for files." }, "results": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + }, + "nullable": true } }, "allOf": [ @@ -44534,14 +40389,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -44583,14 +40432,12 @@ "description": "Text, image, or file output of the function tool call." }, "status": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "allOf": [ @@ -44610,14 +40457,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -44643,24 +40484,21 @@ "description": "The shell commands and limits that describe how to run the tool call." }, "status": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemStatus" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "environment": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemParamEnvironment" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "allOf": [ @@ -44680,14 +40518,8 @@ ], "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "call_id": { "type": "string", @@ -44712,24 +40544,21 @@ "description": "Captured chunks of stdout and stderr output, along with their associated outcomes." }, "status": { - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallItemStatus" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "max_output_length": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "allOf": [ @@ -44743,7 +40572,6 @@ "OpenAI.ItemFunctionToolCall": { "type": "object", "required": [ - "id", "type", "call_id", "name", @@ -44752,8 +40580,7 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call.", - "readOnly": true + "description": "The unique ID of the function tool call." }, "type": { "type": "string", @@ -44767,10 +40594,6 @@ "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." @@ -44829,14 +40652,8 @@ "description": "The status of the image generation call." }, "result": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -44847,59 +40664,6 @@ "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": [ @@ -44972,19 +40736,13 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "anyOf": [ - { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, - { - "type": "null" - } - ] + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "nullable": true } }, "allOf": [ @@ -45055,14 +40813,8 @@ "x-stainless-const": true }, "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "approval_request_id": { "type": "string", @@ -45073,14 +40825,8 @@ "description": "Whether the request was approved." }, "reason": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -45124,7 +40870,8 @@ "description": "The tools available on the server." }, "error": { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + "type": "string", + "nullable": true } }, "allOf": [ @@ -45170,18 +40917,12 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "error": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, "status": { "allOf": [ @@ -45192,14 +40933,8 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -45247,16 +40982,6 @@ }, "description": "The content of the output message." }, - "phase": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessagePhase" - }, - { - "type": "null" - } - ] - }, "status": { "type": "string", "enum": [ @@ -45296,14 +41021,8 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "summary": { "type": "array", @@ -45350,7 +41069,8 @@ "item_reference" ], "description": "The type of item to reference. Always `item_reference`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "item_reference" }, "id": { "type": "string", @@ -45378,19 +41098,14 @@ "discriminator": { "propertyName": "type", "mapping": { - "message": "#/components/schemas/OpenAI.ItemResourceInputMessage", + "message": "#/components/schemas/OpenAI.InputMessageResource", "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.ItemResourceComputerToolCallOutput", + "computer_call_output": "#/components/schemas/OpenAI.ItemResourceComputerToolCallOutputResource", "web_search_call": "#/components/schemas/OpenAI.ItemResourceWebSearchToolCall", - "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", + "function_call": "#/components/schemas/OpenAI.ItemResourceFunctionToolCallResource", + "function_call_output": "#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutputResource", "image_generation_call": "#/components/schemas/OpenAI.ItemResourceImageGenToolCall", "code_interpreter_call": "#/components/schemas/OpenAI.ItemResourceCodeInterpreterToolCall", "local_shell_call": "#/components/schemas/OpenAI.ItemResourceLocalShellToolCall", @@ -45402,57 +41117,11 @@ "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", - "custom_tool_call": "#/components/schemas/OpenAI.ItemResourceCustomToolCallResource", - "custom_tool_call_output": "#/components/schemas/OpenAI.ItemResourceCustomToolCallOutputResource" + "mcp_call": "#/components/schemas/OpenAI.ItemResourceMcpToolCall" } }, "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": [ @@ -45545,14 +41214,8 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "created_by": { "type": "string", @@ -45607,34 +41270,22 @@ "description": "The ID of the container used to run the code." }, "code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "outputs": { - "anyOf": [ - { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" - } - ] + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" } - }, - { - "type": "null" - } - ] + ] + }, + "nullable": true } }, "allOf": [ @@ -45645,50 +41296,13 @@ "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" ], @@ -45712,9 +41326,6 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, - "actions": { - "$ref": "#/components/schemas/OpenAI.ComputerActionList" - }, "pending_safety_checks": { "type": "array", "items": { @@ -45740,11 +41351,10 @@ "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.ItemResourceComputerToolCallOutput": { + "OpenAI.ItemResourceComputerToolCallOutputResource": { "type": "object", "required": [ "type", - "id", "call_id", "output" ], @@ -45760,8 +41370,7 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output.", - "readOnly": true + "description": "The ID of the computer tool call output." }, "call_id": { "type": "string", @@ -45791,126 +41400,7 @@ { "$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", @@ -45952,17 +41442,11 @@ "description": "The queries used to search for files." }, "results": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + }, + "nullable": true } }, "allOf": [ @@ -46012,20 +41496,19 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" + "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." }, "environment": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallEnvironment" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "created_by": { "type": "string", @@ -46071,88 +41554,30 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" } ], - "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" - }, - "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." + "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." }, - "name": { - "type": "string", - "description": "The name of the function to run." + "output": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputContent" + }, + "description": "An array of shell call output contents" }, - "arguments": { - "type": "string", - "description": "A JSON string of the arguments to pass to the function." + "max_output_length": { + "type": "integer", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + } + ], + "nullable": true }, - "status": { + "created_by": { "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." + "description": "The identifier of the actor that created the item." } }, "allOf": [ @@ -46160,13 +41585,12 @@ "$ref": "#/components/schemas/OpenAI.ItemResource" } ], - "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 shell tool call that was emitted.", + "title": "Shell call output" }, - "OpenAI.ItemResourceFunctionToolCallOutput": { + "OpenAI.ItemResourceFunctionToolCallOutputResource": { "type": "object", "required": [ - "id", "type", "call_id", "output" @@ -46174,8 +41598,7 @@ "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 + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." }, "type": { "type": "string", @@ -46217,103 +41640,91 @@ { "$ref": "#/components/schemas/OpenAI.ItemResource" } - ], - "description": "The output of a function tool call.", - "title": "Function tool call output" + ] }, - "OpenAI.ItemResourceImageGenToolCall": { + "OpenAI.ItemResourceFunctionToolCallResource": { "type": "object", "required": [ "type", - "id", - "status", - "result" + "call_id", + "name", + "arguments" ], "properties": { + "id": { + "type": "string", + "description": "The unique ID of the function tool call." + }, "type": { "type": "string", "enum": [ - "image_generation_call" + "function_call" ], - "description": "The type of the image generation call. Always `image_generation_call`.", + "description": "The type of the function tool call. Always `function_call`.", "x-stainless-const": true }, - "id": { + "call_id": { "type": "string", - "description": "The unique ID of the image generation call." + "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." }, "status": { "type": "string", "enum": [ "in_progress", "completed", - "generating", - "failed" + "incomplete" ], - "description": "The status of the image generation call." - }, - "result": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "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": "An image generation request made by the model.", - "title": "Image generation call" + ] }, - "OpenAI.ItemResourceInputMessage": { + "OpenAI.ItemResourceImageGenToolCall": { "type": "object", "required": [ "type", - "role", - "content", - "id" + "id", + "status", + "result" ], "properties": { "type": { "type": "string", "enum": [ - "message" + "image_generation_call" ], - "description": "The type of the message input. Always set to `message`.", - "x-stainless-const": true, - "default": "message" + "description": "The type of the image generation call. Always `image_generation_call`.", + "x-stainless-const": true }, - "role": { + "id": { "type": "string", - "enum": [ - "user", - "system", - "developer" - ], - "description": "The role of the message input. One of `user`, `system`, or `developer`." + "description": "The unique ID of the image generation call." }, "status": { "type": "string", "enum": [ "in_progress", "completed", - "incomplete" + "generating", + "failed" ], - "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" + "description": "The status of the image generation call." }, - "id": { + "result": { "type": "string", - "description": "The unique ID of the message input.", - "readOnly": true + "nullable": true } }, "allOf": [ @@ -46321,8 +41732,8 @@ "$ref": "#/components/schemas/OpenAI.ItemResource" } ], - "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" + "description": "An image generation request made by the model.", + "title": "Image generation call" }, "OpenAI.ItemResourceLocalShellToolCall": { "type": "object", @@ -46396,19 +41807,13 @@ "description": "A JSON string of the output of the local shell tool call." }, "status": { - "anyOf": [ - { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, - { - "type": "null" - } - ] + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "nullable": true } }, "allOf": [ @@ -46492,14 +41897,8 @@ "description": "Whether the request was approved." }, "reason": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -46543,7 +41942,8 @@ "description": "The tools available on the server." }, "error": { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + "type": "string", + "nullable": true } }, "allOf": [ @@ -46589,18 +41989,12 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "error": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, "status": { "allOf": [ @@ -46611,14 +42005,8 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -46666,16 +42054,6 @@ }, "description": "The content of the output message." }, - "phase": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessagePhase" - }, - { - "type": "null" - } - ] - }, "status": { "type": "string", "enum": [ @@ -46694,200 +42072,6 @@ "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": [ { @@ -46904,11 +42088,6 @@ "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", @@ -46921,8 +42100,6 @@ "mcp_approval_request", "mcp_approval_response", "mcp_call", - "custom_tool_call", - "custom_tool_call_output", "structured_outputs", "oauth_consent_request", "memory_search_call", @@ -47005,143 +42182,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.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": [ { @@ -47158,9 +42198,6 @@ "web_search_call", "function_call", "function_call_output", - "tool_search_call", - "tool_search_output", - "additional_tools", "reasoning", "compaction", "image_generation_call", @@ -47272,7 +42309,8 @@ "keypress" ], "description": "Specifies the event type. For a keypress action, this property is always set to `keypress`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "keypress" }, "keys": { "type": "array", @@ -47313,24 +42351,12 @@ "x-stainless-const": true }, "first_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "last_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "type": "string", + "nullable": true, "x-ms-list-continuation-token": true }, "has_more": { @@ -47404,7 +42430,8 @@ "local" ], "description": "The environment type. Always `local`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "local" } }, "allOf": [ @@ -47415,6 +42442,22 @@ "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": [ @@ -47440,42 +42483,29 @@ "description": "The command to run." }, "timeout_ms": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "working_directory": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "env": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Environment variables to set for the command.", "x-oaiTypeLabel": "map" }, "user": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "description": "Execute a shell command on the server.", @@ -47493,7 +42523,8 @@ "local_shell" ], "description": "The type of the local shell tool. Always `local_shell`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "local_shell" }, "name": { "type": "string", @@ -47577,14 +42608,8 @@ "description": "The name of the tool." }, "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "input_schema": { "allOf": [ @@ -47595,14 +42620,13 @@ "description": "The JSON schema describing the tool's input." }, "annotations": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.MCPListToolsToolAnnotations" - }, - { - "type": "null" } - ] + ], + "nullable": true } }, "description": "A tool available on an MCP server.", @@ -47661,17 +42685,11 @@ "description": "Optional description of the MCP server, used to provide more context." }, "headers": { - "anyOf": [ - { - "type": "object", - "unevaluatedProperties": { - "type": "string" - } - }, - { - "type": "null" - } - ] + "type": "object", + "additionalProperties": { + "type": "string" + }, + "nullable": true }, "allowed_tools": { "anyOf": [ @@ -47679,38 +42697,42 @@ "type": "array", "items": { "type": "string" - } - }, - { - "$ref": "#/components/schemas/OpenAI.MCPToolFilter" + }, + "nullable": true }, { - "type": "null" + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MCPToolFilter" + } + ], + "nullable": true } ] }, "require_approval": { "anyOf": [ { - "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MCPToolRequireApproval" + } + ], + "nullable": true }, { "type": "string", "enum": [ "always", "never" - ] - }, - { - "type": "null" + ], + "nullable": true } ], "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." @@ -47784,8 +42806,7 @@ "reasoning_text": "#/components/schemas/OpenAI.MessageContentReasoningTextContent", "refusal": "#/components/schemas/OpenAI.MessageContentRefusalContent", "input_image": "#/components/schemas/OpenAI.MessageContentInputImageContent", - "input_file": "#/components/schemas/OpenAI.MessageContentInputFileContent", - "summary_text": "#/components/schemas/OpenAI.SummaryTextContent" + "input_file": "#/components/schemas/OpenAI.MessageContentInputFileContent" } }, "description": "A content part that makes up an input or output item." @@ -47806,35 +42827,21 @@ "default": "input_file" }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "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." }, - "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`." + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." } }, "allOf": [ @@ -47862,25 +42869,13 @@ "default": "input_image" }, "image_url": { - "anyOf": [ - { - "type": "string", - "format": "uri" - }, - { - "type": "null" - } - ] + "type": "string", + "format": "uri", + "nullable": true }, "file_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "detail": { "allOf": [ @@ -47888,7 +42883,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." } }, "allOf": [ @@ -48051,14 +43046,6 @@ } ] }, - "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": [ @@ -48082,7 +43069,7 @@ }, "OpenAI.Metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "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.", @@ -48091,13 +43078,18 @@ "OpenAI.ModelIdsCompaction": { "anyOf": [ { - "$ref": "#/components/schemas/OpenAI.ModelIdsResponses" - }, - { - "type": "string" + "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 }, { - "type": "null" + "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 } ], "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." @@ -48138,182 +43130,6 @@ } ] }, - "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": [ @@ -48328,7 +43144,8 @@ "move" ], "description": "Specifies the event type. For a move action, this property is always set to `move`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "move" }, "x": { "allOf": [ @@ -48345,19 +43162,6 @@ } ], "description": "The y-coordinate to move to." - }, - "keys": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] } }, "allOf": [ @@ -48368,57 +43172,6 @@ "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": [ @@ -48618,19 +43371,13 @@ "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", @@ -48638,56 +43385,10 @@ "mcp_call": "#/components/schemas/OpenAI.OutputItemMcpToolCall", "mcp_list_tools": "#/components/schemas/OpenAI.OutputItemMcpListTools", "mcp_approval_request": "#/components/schemas/OpenAI.OutputItemMcpApprovalRequest", - "mcp_approval_response": "#/components/schemas/OpenAI.OutputItemMcpApprovalResponseResource", - "custom_tool_call": "#/components/schemas/OpenAI.OutputItemCustomToolCallResource", - "custom_tool_call_output": "#/components/schemas/OpenAI.OutputItemCustomToolCallOutputResource" + "custom_tool_call": "#/components/schemas/OpenAI.OutputItemCustomToolCall" } } }, - "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": [ @@ -48780,14 +43481,8 @@ "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "created_by": { "type": "string", @@ -48842,34 +43537,22 @@ "description": "The ID of the container used to run the code." }, "code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "outputs": { - "anyOf": [ - { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" - }, - { - "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" - } - ] + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputLogs" + }, + { + "$ref": "#/components/schemas/OpenAI.CodeInterpreterOutputImage" } - }, - { - "type": "null" - } - ] + ] + }, + "nullable": true } }, "allOf": [ @@ -48924,6 +43607,7 @@ "type", "id", "call_id", + "action", "pending_safety_checks", "status" ], @@ -48947,9 +43631,6 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, - "actions": { - "$ref": "#/components/schemas/OpenAI.ComputerActionList" - }, "pending_safety_checks": { "type": "array", "items": { @@ -48975,128 +43656,13 @@ "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.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": { + "OpenAI.OutputItemCustomToolCall": { "type": "object", "required": [ "type", "call_id", "name", - "input", - "status" + "input" ], "properties": { "type": { @@ -49115,10 +43681,6 @@ "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." @@ -49126,18 +43688,6 @@ "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": [ @@ -49145,7 +43695,8 @@ "$ref": "#/components/schemas/OpenAI.OutputItem" } ], - "title": "ResponseCustomToolCallItem" + "description": "A call to a custom tool created by the model.", + "title": "Custom tool call" }, "OpenAI.OutputItemFileSearchToolCall": { "type": "object", @@ -49187,17 +43738,11 @@ "description": "The queries used to search for files." }, "results": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FileSearchToolCallResults" + }, + "nullable": true } }, "allOf": [ @@ -49247,20 +43792,19 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" + "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." }, "environment": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.FunctionShellCallEnvironment" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "created_by": { "type": "string", @@ -49306,7 +43850,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -49319,14 +43863,13 @@ "description": "An array of shell call output contents" }, "max_output_length": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "created_by": { "type": "string", @@ -49344,99 +43887,35 @@ "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", - "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.", - "readOnly": true + "description": "The unique ID of the function tool call." }, "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." + "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", @@ -49453,8 +43932,8 @@ "$ref": "#/components/schemas/OpenAI.OutputItem" } ], - "description": "The output of a function tool call.", - "title": "Function tool 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.OutputItemImageGenToolCall": { "type": "object", @@ -49488,14 +43967,8 @@ "description": "The status of the image generation call." }, "result": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -49553,54 +44026,6 @@ "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": [ @@ -49644,54 +44069,6 @@ "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": [ @@ -49725,7 +44102,8 @@ "description": "The tools available on the server." }, "error": { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + "type": "string", + "nullable": true } }, "allOf": [ @@ -49771,18 +44149,12 @@ "description": "A JSON string of the arguments passed to the tool." }, "output": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "error": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, "status": { "allOf": [ @@ -49793,14 +44165,8 @@ "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`." }, "approval_request_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -49848,16 +44214,6 @@ }, "description": "The content of the output message." }, - "phase": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.MessagePhase" - }, - { - "type": "null" - } - ] - }, "status": { "type": "string", "enum": [ @@ -49897,14 +44253,8 @@ "description": "The unique identifier of the reasoning content." }, "encrypted_content": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "summary": { "type": "array", @@ -49938,138 +44288,6 @@ "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": [ { @@ -50081,19 +44299,13 @@ "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", @@ -50101,9 +44313,7 @@ "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", @@ -50302,35 +44512,21 @@ "description": "The unique identifier of the prompt template to use." }, "version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "variables": { - "anyOf": [ + "type": "object", + "allOf": [ { "$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": [ @@ -50367,181 +44563,46 @@ } } }, - "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": { + "OpenAI.Reasoning": { "type": "object", - "required": [ - "type", - "code", - "message" - ], "properties": { - "type": { - "type": "string", - "enum": [ - "http_error" - ], - "x-stainless-const": true - }, - "code": { - "$ref": "#/components/schemas/OpenAI.integer" + "effort": { + "$ref": "#/components/schemas/OpenAI.ReasoningEffort" }, - "message": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" - } - ], - "title": "Realtime MCP HTTP error" - }, - "OpenAI.RealtimeMCPProtocolError": { - "type": "object", - "required": [ - "type", - "code", - "message" - ], - "properties": { - "type": { + "summary": { "type": "string", "enum": [ - "protocol_error" + "auto", + "concise", + "detailed" ], - "x-stainless-const": true - }, - "code": { - "$ref": "#/components/schemas/OpenAI.integer" + "nullable": true }, - "message": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" - } - ], - "title": "Realtime MCP protocol error" - }, - "OpenAI.RealtimeMCPToolExecutionError": { - "type": "object", - "required": [ - "type", - "message" - ], - "properties": { - "type": { + "generate_summary": { "type": "string", "enum": [ - "tool_execution_error" + "auto", + "concise", + "detailed" ], - "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" - } - ] + "nullable": true } }, "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": { - "anyOf": [ - { - "type": "string", - "enum": [ - "none", - "minimal", - "low", - "medium", - "high", - "xhigh" - ] - }, - { - "type": "null" - } + "type": "string", + "enum": [ + "none", + "minimal", + "low", + "medium", + "high", + "xhigh" ], - "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`." + "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 }, "OpenAI.ReasoningTextContent": { "type": "object", @@ -50582,45 +44643,41 @@ ], "properties": { "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "top_logprobs": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "temperature": { - "anyOf": [ + "type": "number", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" - }, - { - "type": "null" } ], + "nullable": true, "default": 1 }, "top_p": { - "anyOf": [ + "type": "number", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.numeric" - }, - { - "type": "null" } ], + "nullable": true, "default": 1 }, "user": { @@ -50630,8 +44687,7 @@ }, "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)." + "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", @@ -50641,62 +44697,51 @@ "$ref": "#/components/schemas/OpenAI.ServiceTier" }, "prompt_cache_retention": { - "anyOf": [ - { - "type": "string", - "enum": [ - "in_memory", - "24h" - ] - }, - { - "type": "null" - } - ] + "type": "string", + "enum": [ + "in-memory", + "24h" + ], + "nullable": true }, "previous_response_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "model": { "type": "string", "description": "The model deployment to use for the creation of this response." }, "reasoning": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Reasoning" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "background": { - "anyOf": [ - { - "type": "boolean" - }, + "type": "boolean", + "nullable": true + }, + "max_output_tokens": { + "type": "integer", + "allOf": [ { - "type": "null" + "$ref": "#/components/schemas/OpenAI.integer" } - ] + ], + "nullable": true }, "max_tool_calls": { - "anyOf": [ + "type": "integer", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "text": { "$ref": "#/components/schemas/OpenAI.ResponseTextParam" @@ -50718,18 +44763,12 @@ "$ref": "#/components/schemas/OpenAI.Prompt" }, "truncation": { - "anyOf": [ - { - "type": "string", - "enum": [ - "auto", - "disabled" - ] - }, - { - "type": "null" - } + "type": "string", + "enum": [ + "auto", + "disabled" ], + "nullable": true, "default": "disabled" }, "id": { @@ -50762,37 +44801,27 @@ "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" + "format": "unixtime", + "nullable": true }, "error": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.ResponseError" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "incomplete_details": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.ResponseIncompleteDetails" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "output": { "type": "array", @@ -50811,59 +44840,30 @@ "items": { "$ref": "#/components/schemas/OpenAI.InputItem" } - }, - { - "type": "null" } - ] + ], + "nullable": true }, "output_text": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "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": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.ConversationReference" - }, - { - "type": "null" } - ] - }, - "max_output_tokens": { - "anyOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - }, - { - "type": "null" - } - ] + ], + "nullable": true }, "agent": { "allOf": [ @@ -50878,14 +44878,13 @@ "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": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/AgentReference" - }, - { - "type": "null" } ], + "nullable": true, "description": "The agent used for this response" }, "content_filters": { @@ -50924,15 +44923,10 @@ }, "delta": { "type": "string", - "contentEncoding": "base64", + "format": "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", @@ -50964,11 +44958,6 @@ "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", @@ -51005,11 +44994,6 @@ "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", @@ -51041,11 +45025,6 @@ "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", @@ -51096,11 +45075,6 @@ "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", @@ -51151,11 +45125,6 @@ "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", @@ -51201,11 +45170,6 @@ "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", @@ -51251,11 +45215,6 @@ "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", @@ -51301,11 +45260,6 @@ "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", @@ -51346,11 +45300,6 @@ "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", @@ -51414,11 +45363,6 @@ "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", @@ -51482,11 +45426,6 @@ "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", @@ -51527,11 +45466,6 @@ "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", @@ -51582,11 +45516,6 @@ "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": { @@ -51638,11 +45567,6 @@ "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": { @@ -51711,28 +45635,16 @@ "x-stainless-const": true }, "code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "message": { "type": "string", "description": "The error message." }, "param": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "sequence_number": { "allOf": [ @@ -51743,11 +45655,6 @@ "description": "The sequence number of this event." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" - } - ], "description": "Emitted when an error occurs.", "x-oaiMeta": { "name": "error", @@ -51788,11 +45695,6 @@ "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", @@ -51838,11 +45740,6 @@ "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", @@ -51888,11 +45785,6 @@ "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", @@ -51938,11 +45830,6 @@ "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", @@ -52017,20 +45904,14 @@ "$ref": "#/components/schemas/OpenAI.ResponseFormatJsonSchemaSchema" }, "strict": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ] + "type": "boolean", + "nullable": true } } }, "OpenAI.ResponseFormatJsonSchemaSchema": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "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" }, @@ -52095,11 +45976,6 @@ "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", @@ -52154,11 +46030,6 @@ "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", @@ -52204,11 +46075,6 @@ "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": { @@ -52255,11 +46121,6 @@ "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": { @@ -52306,11 +46167,6 @@ "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": { @@ -52371,11 +46227,6 @@ "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": { @@ -52417,11 +46268,6 @@ "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", @@ -52474,11 +46320,6 @@ "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", @@ -52510,7 +46351,7 @@ "items": { "$ref": "#/components/schemas/OpenAI.ResponseLogProbTopLogprobs" }, - "description": "The log probabilities of up to 20 of the most likely tokens." + "description": "The log probability of the top 20 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." @@ -52569,11 +46410,6 @@ "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": { @@ -52625,11 +46461,6 @@ "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": { @@ -52676,11 +46507,6 @@ "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": { @@ -52727,11 +46553,6 @@ "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": { @@ -52778,11 +46599,6 @@ "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": { @@ -52829,11 +46645,6 @@ "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": { @@ -52880,11 +46691,6 @@ "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": { @@ -52931,11 +46737,6 @@ "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": { @@ -52986,11 +46787,6 @@ "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", @@ -53040,11 +46836,6 @@ "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", @@ -53117,11 +46908,6 @@ "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": { @@ -53132,7 +46918,7 @@ }, "OpenAI.ResponsePromptVariables": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "anyOf": [ { "type": "string" @@ -53186,11 +46972,6 @@ "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": { @@ -53255,11 +47036,6 @@ "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", @@ -53342,11 +47118,6 @@ "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", @@ -53425,11 +47196,6 @@ "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", @@ -53489,11 +47255,6 @@ "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", @@ -53553,11 +47314,6 @@ "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", @@ -53617,11 +47373,6 @@ "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", @@ -53681,11 +47432,6 @@ "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", @@ -53745,11 +47491,6 @@ "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", @@ -53757,140 +47498,6 @@ "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": { @@ -53961,11 +47568,6 @@ "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", @@ -54033,11 +47635,6 @@ "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", @@ -54170,11 +47767,6 @@ "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", @@ -54220,11 +47812,6 @@ "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", @@ -54270,11 +47857,6 @@ "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", @@ -54294,7 +47876,8 @@ "screenshot" ], "description": "Specifies the event type. For a screenshot action, this property is always set to `screenshot`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "screenshot" } }, "allOf": [ @@ -54321,7 +47904,8 @@ "scroll" ], "description": "Specifies the event type. For a scroll action, this property is always set to `scroll`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "scroll" }, "x": { "allOf": [ @@ -54354,19 +47938,6 @@ } ], "description": "The vertical scroll distance." - }, - "keys": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] } }, "allOf": [ @@ -54377,13 +47948,6 @@ "description": "A scroll action.", "title": "Scroll" }, - "OpenAI.SearchContentType": { - "type": "string", - "enum": [ - "text", - "image" - ] - }, "OpenAI.SearchContextSize": { "type": "string", "enum": [ @@ -54393,31 +47957,16 @@ ] }, "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", @@ -54432,7 +47981,8 @@ "skill_reference" ], "description": "References a skill created with the /v1/skills endpoint.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "skill_reference" }, "skill_id": { "type": "string", @@ -54463,7 +48013,8 @@ "apply_patch" ], "description": "The tool to call. Always `apply_patch`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "apply_patch" } }, "allOf": [ @@ -54486,7 +48037,8 @@ "shell" ], "description": "The tool to call. Always `shell`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "shell" } }, "allOf": [ @@ -54510,7 +48062,8 @@ "summary_text" ], "description": "The type of the object. Always `summary_text`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "summary_text" }, "text": { "type": "string", @@ -54537,7 +48090,8 @@ "enum": [ "text" ], - "x-stainless-const": true + "x-stainless-const": true, + "default": "text" }, "text": { "type": "string" @@ -54660,14 +48214,8 @@ "$ref": "#/components/schemas/OpenAI.ResponseFormatJsonSchemaSchema" }, "strict": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ] + "type": "boolean", + "nullable": true } }, "allOf": [ @@ -54716,10 +48264,7 @@ "shell": "#/components/schemas/OpenAI.FunctionShellToolParam", "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" + "apply_patch": "#/components/schemas/OpenAI.ApplyPatchToolParam" } }, "description": "A tool that can be used to generate a response." @@ -54752,7 +48297,7 @@ "type": "array", "items": { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, "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 ```" } @@ -54785,46 +48330,6 @@ ], "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": [ @@ -54961,14 +48466,8 @@ "description": "The label of the MCP server to use." }, "name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "allOf": [ @@ -55013,9 +48512,7 @@ "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", - "computer": "#/components/schemas/OpenAI.ToolChoiceComputer", - "computer_use": "#/components/schemas/OpenAI.ToolChoiceComputerUse" + "code_interpreter": "#/components/schemas/OpenAI.ToolChoiceCodeInterpreter" } }, "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." @@ -55039,9 +48536,7 @@ "computer_use_preview", "web_search_preview_2025_03_11", "image_generation", - "code_interpreter", - "computer", - "computer_use" + "code_interpreter" ] } ] @@ -55086,64 +48581,6 @@ ], "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": [ { @@ -55154,7 +48591,6 @@ "enum": [ "function", "file_search", - "computer", "computer_use_preview", "web_search", "mcp", @@ -55163,8 +48599,6 @@ "local_shell", "shell", "custom", - "namespace", - "tool_search", "web_search_preview", "apply_patch", "a2a_preview", @@ -55229,7 +48663,8 @@ "type" ], "description": "Specifies the event type. For a type action, this property is always set to `type`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "type" }, "text": { "type": "string", @@ -55251,14 +48686,13 @@ ], "properties": { "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$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." } } @@ -55279,7 +48713,8 @@ "url_citation" ], "description": "The type of the URL citation. Always `url_citation`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "url_citation" }, "url": { "type": "string", @@ -55317,7 +48752,7 @@ }, "OpenAI.VectorStoreFileAttributes": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "anyOf": [ { "type": "string" @@ -55334,20 +48769,14 @@ "x-oaiTypeLabel": "map" }, "OpenAI.Verbosity": { - "anyOf": [ - { - "type": "string", - "enum": [ - "low", - "medium", - "high" - ] - }, - { - "type": "null" - } + "type": "string", + "enum": [ + "low", + "medium", + "high" ], - "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`." + "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 }, "OpenAI.WaitParam": { "type": "object", @@ -55361,7 +48790,8 @@ "wait" ], "description": "Specifies the event type. For a wait action, this property is always set to `wait`.", - "x-stainless-const": true + "x-stainless-const": true, + "default": "wait" } }, "allOf": [ @@ -55416,15 +48846,9 @@ "x-stainless-const": true }, "url": { - "anyOf": [ - { - "type": "string", - "format": "uri" - }, - { - "type": "null" - } - ], + "type": "string", + "format": "uri", + "nullable": true, "description": "The URL opened by the model." } }, @@ -55434,7 +48858,8 @@ "OpenAI.WebSearchActionSearch": { "type": "object", "required": [ - "type" + "type", + "query" ], "properties": { "type": { @@ -55447,7 +48872,7 @@ }, "query": { "type": "string", - "description": "The search query.", + "description": "[DEPRECATED] The search query.", "deprecated": true }, "queries": { @@ -55485,8 +48910,7 @@ "x-stainless-const": true }, "url": { - "type": "string", - "format": "uri" + "type": "string" } } }, @@ -55506,44 +48930,20 @@ "default": "approximate" }, "country": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "region": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "city": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true }, "timezone": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "type": "string", + "nullable": true } }, "description": "The approximate location of the user.", @@ -55561,17 +48961,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 + "x-stainless-const": true, + "default": "web_search_preview" }, "user_location": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.ApproximateLocation" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "search_context_size": { "allOf": [ @@ -55580,12 +48980,6 @@ } ], "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": [ @@ -55607,27 +49001,26 @@ "enum": [ "web_search" ], - "description": "The type of the web search tool. One of `web_search` or `web_search_2025_08_26`." + "description": "The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.", + "default": "web_search" }, "filters": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.WebSearchToolFilters" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "user_location": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.WebSearchApproximateLocation" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "search_context_size": { "type": "string", @@ -55668,17 +49061,11 @@ "type": "object", "properties": { "allowed_domains": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] + "type": "array", + "items": { + "type": "string" + }, + "nullable": true } } }, @@ -55770,7 +49157,7 @@ }, "spec": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The openapi function shape, described as a JSON Schema object." }, "auth": { @@ -55803,7 +49190,7 @@ }, "parameters": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The parameters the functions accepts, described as a JSON Schema object." } }, @@ -56054,32 +49441,58 @@ ], "description": "An OpenAPI tool stored in a toolbox." }, - "OptimizationAgentIdentifier": { + "OptimizationAgentDefinition": { "type": "object", - "required": [ - "agent_name" - ], "properties": { - "agent_name": { + "agentName": { "type": "string", - "description": "Registered Foundry agent name (required)." + "description": "Agent name." }, - "agent_version": { + "agentVersion": { "type": "string", - "description": "Pinned agent version. Defaults to latest if omitted." + "description": "Agent version." + }, + "model": { + "type": "string", + "description": "Model deployment name." + }, + "systemPrompt": { + "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": "Identifies the registered Foundry agent to optimize (request-only). Skills, tools, and system_prompt are specified in options.optimization_config." + "description": "Agent definition returned in response payloads (includes resolved config)." }, "OptimizationCandidate": { "type": "object", "required": [ "name", - "avg_score", - "avg_tokens" + "config", + "mutations", + "avgScore", + "avgTokens", + "passRate", + "taskScores", + "isParetoOptimal" ], "properties": { - "candidate_id": { + "candidateId": { "type": "string", "description": "Server-assigned candidate identifier. Use with GET /candidates/{id} sub-endpoints." }, @@ -56087,26 +49500,50 @@ "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", - "unevaluatedProperties": {}, - "description": "What was mutated from the baseline (e.g., {system_prompt: 'new prompt'})." + "additionalProperties": {}, + "description": "What was mutated from the baseline (e.g., {systemPrompt: 'new prompt'})." }, - "avg_score": { + "avgScore": { "type": "number", "format": "double", "description": "Average composite score across all tasks." }, - "avg_tokens": { + "avgTokens": { "type": "number", "format": "double", "description": "Average token usage across all tasks." }, - "eval_id": { + "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": { "type": "string", "description": "Foundry evaluation identifier used to score this candidate." }, - "eval_run_id": { + "evalRunId": { "type": "string", "description": "Foundry evaluation run identifier for this candidate's scoring run." }, @@ -56121,144 +49558,12 @@ }, "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", - "created_at", - "updated_at" + "createdAt" ], "properties": { "id": { @@ -56266,42 +49571,42 @@ "description": "Server-assigned unique identifier.", "readOnly": true }, - "inputs": { + "status": { "allOf": [ { - "$ref": "#/components/schemas/OptimizationJobInputs" + "$ref": "#/components/schemas/JobStatus" } ], - "description": "Caller-supplied inputs." + "description": "Current lifecycle status.", + "readOnly": true }, - "result": { + "error": { "allOf": [ { - "$ref": "#/components/schemas/OptimizationJobResult" + "$ref": "#/components/schemas/OpenAI.Error" } ], - "description": "Result produced on success.", + "description": "Error details — populated only on failure.", "readOnly": true }, - "status": { + "result": { "allOf": [ { - "$ref": "#/components/schemas/JobStatus" + "$ref": "#/components/schemas/OptimizationJobResult" } ], - "description": "Current lifecycle status.", + "description": "Result produced on success.", "readOnly": true }, - "error": { + "inputs": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.Error" + "$ref": "#/components/schemas/OptimizationJobInputs" } ], - "description": "Error details — populated only on failure.", - "readOnly": true + "description": "Caller-supplied inputs." }, - "created_at": { + "createdAt": { "allOf": [ { "$ref": "#/components/schemas/FoundryTimestamp" @@ -56310,7 +49615,7 @@ "description": "The timestamp when the job was created, represented in Unix time.", "readOnly": true }, - "updated_at": { + "updatedAt": { "allOf": [ { "$ref": "#/components/schemas/FoundryTimestamp" @@ -56325,15 +49630,16 @@ "$ref": "#/components/schemas/OptimizationJobProgress" } ], - "description": "Progress snapshot. May be present in terminal states reflecting last-known progress.", + "description": "Progress while in flight. Absent in terminal states.", "readOnly": true }, - "warnings": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Non-fatal warnings emitted at any point during optimization.", + "dataset": { + "allOf": [ + { + "$ref": "#/components/schemas/DatasetInfo" + } + ], + "description": "Metadata about the dataset used for this optimization job.", "readOnly": true } }, @@ -56343,30 +49649,29 @@ "type": "object", "required": [ "agent", - "train_dataset", - "evaluators" + "trainDatasetReference" ], "properties": { "agent": { "allOf": [ { - "$ref": "#/components/schemas/OptimizationAgentIdentifier" + "$ref": "#/components/schemas/AgentIdentifier" } ], "description": "The agent (and pinned version) being optimized." }, - "train_dataset": { + "trainDatasetReference": { "allOf": [ { - "$ref": "#/components/schemas/OptimizationDatasetInput" + "$ref": "#/components/schemas/DatasetRef" } ], - "description": "Training dataset — either inline items or a reference to a registered dataset. Required." + "description": "Reference to a registered training dataset (required)." }, - "validation_dataset": { + "validationDatasetReference": { "allOf": [ { - "$ref": "#/components/schemas/OptimizationDatasetInput" + "$ref": "#/components/schemas/DatasetRef" } ], "description": "Optional held-out validation dataset for measuring generalization of the final candidate." @@ -56374,9 +49679,9 @@ "evaluators": { "type": "array", "items": { - "$ref": "#/components/schemas/OptimizationEvaluatorRef" + "type": "string" }, - "description": "Job-level evaluators referenced by name and optional version. Required; at least one must be provided." + "description": "Job-level evaluators (referenced by name). Per-task criteria may override. Default: ['task_adherence']." }, "options": { "allOf": [ @@ -56389,96 +49694,25 @@ }, "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": [ - "candidates_completed", - "best_score", - "elapsed_seconds" + "currentIteration", + "bestScore", + "elapsedSeconds" ], "properties": { - "candidates_completed": { + "currentIteration": { "type": "integer", "format": "int32", - "description": "Number of candidates whose evaluation has completed so far." + "description": "1-based current iteration index." }, - "best_score": { + "bestScore": { "type": "number", "format": "double", "description": "Best score observed so far across all candidates." }, - "elapsed_seconds": { + "elapsedSeconds": { "type": "number", "format": "double", "description": "Wall-clock time elapsed in seconds since the job began executing." @@ -56490,12 +49724,20 @@ "type": "object", "properties": { "baseline": { - "type": "string", - "description": "Candidate ID of the original (un-optimized) baseline evaluation." + "allOf": [ + { + "$ref": "#/components/schemas/OptimizationCandidate" + } + ], + "description": "Evaluation scores for the original (un-optimized) agent configuration." }, "best": { - "type": "string", - "description": "Candidate ID of the highest-scoring candidate found during optimization." + "allOf": [ + { + "$ref": "#/components/schemas/OptimizationCandidate" + } + ], + "description": "The highest-scoring candidate found during optimization." }, "candidates": { "type": "array", @@ -56503,6 +49745,25 @@ "$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." @@ -56510,27 +49771,26 @@ "OptimizationOptions": { "type": "object", "properties": { - "max_candidates": { + "maxIterations": { "type": "integer", "format": "int32", - "minimum": 1, - "description": "Maximum number of optimization candidates to generate. Must be >= 1. Default: 5.", + "description": "Maximum optimization iterations per strategy. Must be >= 1. Default: 5.", "default": 5 }, - "optimization_config": { + "optimizationConfig": { "type": "object", - "unevaluatedProperties": {}, - "description": "Per-target-attribute configuration overrides. Contains skills, tools, system_prompt for the agent, plus model space for model optimization." + "additionalProperties": {}, + "description": "Per-target-attribute configuration overrides. Contains skills, tools, systemPrompt for the agent, plus model space for model optimization." }, - "eval_model": { + "evalModel": { "type": "string", "description": "Model deployment used for evaluation. Defaults to server config (typically 'gpt-4o')." }, - "optimization_model": { + "optimizationModel": { "type": "string", "description": "Model deployment for optimization reasoning (must be gpt-5 family). Falls back to the default eval model when not set." }, - "evaluation_level": { + "evaluationLevel": { "allOf": [ { "$ref": "#/components/schemas/EvaluationLevel" @@ -56541,35 +49801,73 @@ }, "description": "Tuning knobs and run-mode for an optimization job." }, - "OptimizationReferenceDatasetInput": { + "OptimizationTaskResult": { "type": "object", "required": [ - "type", - "name" + "taskName", + "scores", + "compositeScore", + "tokens", + "durationSeconds", + "passed" ], "properties": { - "type": { + "taskName": { "type": "string", - "enum": [ - "reference" - ], - "description": "Dataset input type discriminator." + "description": "Task name (from the dataset)." }, - "name": { + "query": { "type": "string", - "description": "Registered dataset name." + "description": "The user query / input for the task." }, - "version": { + "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": "string", - "description": "Dataset version. If not specified, the latest version is used." + "description": "Error message if the task failed during execution." + }, + "rationales": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Per-evaluator reasoning keyed by evaluator name." + }, + "response": { + "type": "string", + "description": "Raw agent response text." + }, + "runId": { + "type": "string", + "description": "Identifier of the agent run that produced this result." } }, - "allOf": [ - { - "$ref": "#/components/schemas/OptimizationDatasetInput" - } - ], - "description": "Reference to a registered Foundry dataset." + "description": "Per-task evaluation result for a single candidate." }, "OtlpTelemetryEndpoint": { "type": "object", @@ -56589,9 +49887,7 @@ "endpoint": { "type": "string", "description": "The OTLP collector endpoint URL.", - "examples": [ - "https://my-collector.example.com/otlp" - ] + "example": "https://my-collector.example.com/otlp" }, "protocol": { "allOf": [ @@ -56600,9 +49896,7 @@ } ], "description": "The transport protocol for the OTLP endpoint.", - "examples": [ - "Http" - ] + "example": "Http" } }, "allOf": [ @@ -57049,15 +50343,70 @@ ] } }, + "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": [ - "promoted_at", - "agent_name", - "agent_version" + "promotedAt", + "agentName", + "agentVersion" ], "properties": { - "promoted_at": { + "promotedAt": { "allOf": [ { "$ref": "#/components/schemas/FoundryTimestamp" @@ -57065,11 +50414,11 @@ ], "description": "Timestamp when promotion occurred, represented in Unix time." }, - "agent_name": { + "agentName": { "type": "string", "description": "Name of the Foundry agent this candidate was promoted to." }, - "agent_version": { + "agentVersion": { "type": "string", "description": "Version of the Foundry agent this candidate was promoted to." } @@ -57094,55 +50443,36 @@ "description": "The model deployment to use for this agent." }, "instructions": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "type": "string", + "nullable": true, "description": "A system (or developer) message inserted into the model's context." }, "temperature": { - "anyOf": [ - { - "type": "number", - "format": "float" - }, - { - "type": "null" - } - ], + "type": "number", + "format": "float", + "nullable": true, "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": { - "anyOf": [ - { - "type": "number", - "format": "float" - }, - { - "type": "null" - } - ], + "type": "number", + "format": "float", + "nullable": true, "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": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Reasoning" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "tools": { "type": "array", @@ -57172,7 +50502,7 @@ }, "structured_inputs": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/StructuredInputDefinition" }, "description": "Set of structured inputs that can participate in prompt template substitution or tool argument bindings." @@ -57466,7 +50796,7 @@ }, "simulationOnly": { "type": "boolean", - "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.", + "description": "Simulation-only or Simulation + Evaluation. Default false, if true the scan outputs conversation not evaluation result.", "default": false }, "riskCategories": { @@ -57482,14 +50812,14 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Red team's tags. Unlike properties, tags are fully mutable." }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed." @@ -57717,7 +51047,7 @@ }, "data_mapping": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Mapping from source fields to response_id field, required for retrieving chat history." @@ -57767,7 +51097,10 @@ "Routine": { "type": "object", "required": [ - "enabled" + "name", + "enabled", + "triggers", + "action" ], "properties": { "name": { @@ -57786,7 +51119,7 @@ }, "triggers": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/RoutineTrigger" }, "description": "The triggers configured for the routine." @@ -57897,6 +51230,10 @@ }, "RoutineCreateOrUpdateRequest": { "type": "object", + "required": [ + "triggers", + "action" + ], "properties": { "description": { "type": "string", @@ -57909,7 +51246,7 @@ }, "triggers": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$ref": "#/components/schemas/RoutineTrigger" }, "description": "The triggers configured for the routine. In v1, exactly one trigger entry is supported." @@ -57982,21 +51319,19 @@ "RoutineRun": { "type": "object", "required": [ - "id" + "id", + "status", + "trigger_type", + "started_at" ], "properties": { "id": { "type": "string", - "description": "The unique run identifier for the routine attempt.", - "readOnly": true + "description": "The MLflow run identifier for the routine attempt." }, "status": { - "allOf": [ - { - "$ref": "#/components/schemas/RoutineRunStatus" - } - ], - "description": "The run status." + "type": "string", + "description": "The underlying MLflow run status." }, "phase": { "allOf": [ @@ -58014,10 +51349,6 @@ ], "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": [ { @@ -58034,22 +51365,6 @@ ], "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": [ { @@ -58058,14 +51373,6 @@ ], "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": [ { @@ -58098,11 +51405,6 @@ "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." @@ -58110,6 +51412,14 @@ "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.", @@ -58119,6 +51429,44 @@ ] } }, + "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": [ { @@ -58141,15 +51489,6 @@ ] } }, - "RoutineRunStatus": { - "type": "string", - "description": "The status of a routine run.", - "x-ms-foundry-meta": { - "conditional_previews": [ - "Routines=V1Preview" - ] - } - }, "RoutineTrigger": { "type": "object", "required": [ @@ -58170,8 +51509,7 @@ "mapping": { "schedule": "#/components/schemas/ScheduleRoutineTrigger", "timer": "#/components/schemas/TimerRoutineTrigger", - "github_issue": "#/components/schemas/GitHubIssueRoutineTrigger", - "custom": "#/components/schemas/CustomRoutineTrigger" + "github_issue_opened": "#/components/schemas/GitHubIssueOpenedRoutineTrigger" } }, "description": "Base model for a routine trigger.", @@ -58189,8 +51527,7 @@ { "type": "string", "enum": [ - "custom", - "github_issue", + "github_issue_opened", "schedule", "timer" ] @@ -58357,21 +51694,21 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Schedule's tags. Unlike properties, tags are fully mutable." }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Schedule's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed." }, "systemData": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "System metadata for the resource.", @@ -58468,7 +51805,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Properties of the schedule run.", @@ -58493,7 +51830,7 @@ }, "configuration": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Configuration for the task." @@ -58557,23 +51894,10 @@ "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." @@ -58585,7 +51909,8 @@ }, "description": "The directory entries." } - } + }, + "description": "Response from listing a directory in a session sandbox." }, "SessionFileWriteResponse": { "type": "object", @@ -58620,16 +51945,12 @@ } ], "description": "The SSE event type. Currently `log`, but additional event types may be added in the future. Clients should ignore unrecognized event types.", - "examples": [ - "log" - ] + "example": "log" }, "data": { "type": "string", "description": "The event payload as plain text. Currently JSON-formatted but the schema is not contractual and may change.", - "examples": [ - "{\"timestamp\":\"2026-03-10T09:33:17.121467567+00:00\",\"stream\":\"stdout\",\"message\":\"Starting server on port 18080\"}" - ] + "example": "{\"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```", @@ -58908,7 +52229,7 @@ }, "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Arbitrary key-value metadata for additional properties." @@ -59022,12 +52343,12 @@ }, "schema": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The JSON schema for the structured input (optional)." }, "required": { "type": "boolean", - "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.", + "description": "Whether the input property is required when the agent is invoked. Defaults to `false`.", "default": false } }, @@ -59052,18 +52373,12 @@ }, "schema": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The JSON schema for the structured output." }, "strict": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], + "type": "boolean", + "nullable": true, "description": "Whether to enforce strict validation. Default `true`." } }, @@ -59384,7 +52699,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Additional properties for the taxonomy category." @@ -59418,7 +52733,7 @@ }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Additional properties for the taxonomy sub-category." @@ -59491,12 +52806,10 @@ "$ref": "#/components/schemas/TelemetryDataKind" }, "description": "Data types to export to this endpoint. Use an empty array to export no data.", - "examples": [ - [ - "ContainerStdoutStderr", - "ContainerOtel", - "Metrics" - ] + "example": [ + "ContainerStdoutStderr", + "ContainerOtel", + "Metrics" ] }, "auth": { @@ -59636,12 +52949,11 @@ }, "initialization_parameters": { "type": "object", - "unevaluatedProperties": {}, "description": "The initialization parameters for the evaluation. Must support structured outputs." }, "data_mapping": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "The model to use for the evaluation. Must support structured outputs." @@ -59653,7 +52965,8 @@ "TimerRoutineTrigger": { "type": "object", "required": [ - "type" + "type", + "at" ], "properties": { "type": { @@ -59664,12 +52977,12 @@ "description": "The trigger type." }, "at": { - "allOf": [ - { - "$ref": "#/components/schemas/FoundryTimestamp" - } - ], - "description": "The UTC date and time at which the timer fires." + "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": [ @@ -59688,7 +53001,7 @@ "anyOf": [ { "type": "object", - "unevaluatedProperties": {} + "additionalProperties": {} }, { "type": "string" @@ -59909,7 +53222,7 @@ }, "tool_configs": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "$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." @@ -59960,17 +53273,11 @@ ], "properties": { "metadata": { - "anyOf": [ - { - "type": "object", - "unevaluatedProperties": { - "type": "string" - } - }, - { - "type": "null" - } - ], + "type": "object", + "additionalProperties": { + "type": "string" + }, + "nullable": true, "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" }, @@ -60412,7 +53719,7 @@ "properties": { "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "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.", @@ -60429,7 +53736,7 @@ }, "parameter_values": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "description": "The inputs to the manifest that will result in a fully materialized Agent." } } @@ -60442,7 +53749,7 @@ "properties": { "metadata": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "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.", @@ -60491,18 +53798,17 @@ "type": "string" }, "metadata": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.Metadata" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "properties": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "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." @@ -60518,7 +53824,7 @@ }, "tags": { "type": "object", - "unevaluatedProperties": { + "additionalProperties": { "type": "string" }, "description": "Tag dictionary. Tags can be added, removed, and updated." @@ -60779,24 +54085,22 @@ ] }, "filters": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.WebSearchToolFilters" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "user_location": { - "anyOf": [ + "type": "object", + "allOf": [ { "$ref": "#/components/schemas/OpenAI.WebSearchApproximateLocation" - }, - { - "type": "null" } - ] + ], + "nullable": true }, "search_context_size": { "type": "string", @@ -61022,7 +54326,7 @@ }, "modelParams": { "type": "object", - "unevaluatedProperties": {}, + "additionalProperties": {}, "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 dbb65b803891..e0e5e62c548d 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,118 +1,36 @@ -openapi: 3.2.0 +openapi: 3.0.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 - parent: Agents Root - description: Agent Management + - name: Agent Containers + - name: Agent Session Files - name: Agent Invocations - 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: Connections - name: Datasets - parent: Platform APIs + - name: Deployments + - name: Evaluation Taxonomies + - name: Evaluation Rules + - name: EvaluationSuiteGenerationJobs + - name: Evaluators + - name: EvaluatorGenerationJobs - name: Indexes - parent: Platform APIs - - name: Connections - parent: Platform APIs - - name: Scheduler - parent: Platform APIs - - name: Fine-tuning - parent: Platform APIs - summary: Fine-Tuning + - name: Insights - 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: Conversations + - name: Evals + - name: Fine-Tuning + - name: Responses + - name: Redteams - 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: @@ -127,7 +45,7 @@ paths: schema: type: string enum: - - AgentsOptimization=V2Preview + - AgentsOptimization=V1Preview - name: Operation-Id in: header required: false @@ -159,14 +77,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OptimizationJob' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -178,15 +90,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/OptimizationJob' - description: The job to create. + $ref: '#/components/schemas/OptimizationJobInputs' + description: The optimization job inputs. x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V2Preview + - AgentsOptimization=V1Preview get: operationId: AgentOptimizationJobs_list summary: Returns a list of agent optimization jobs. - description: List optimization jobs. Supports cursor pagination and optional status / agent_name filters. + description: List optimization jobs. Supports cursor pagination and optional status / agentName filters. parameters: - name: Foundry-Features in: header @@ -195,7 +107,7 @@ paths: schema: type: string enum: - - AgentsOptimization=V2Preview + - AgentsOptimization=V1Preview - name: limit in: query required: false @@ -243,7 +155,7 @@ paths: schema: $ref: '#/components/schemas/JobStatus' explode: false - - name: agent_name + - name: agentName in: query required: false description: Filter to jobs targeting this agent name. @@ -271,7 +183,7 @@ paths: data: type: array items: - $ref: '#/components/schemas/OptimizationJobListItem' + $ref: '#/components/schemas/OptimizationJob' description: The requested list of items. first_id: type: string @@ -283,14 +195,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -299,12 +205,12 @@ paths: - AgentOptimizationJobs x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V2Preview + - AgentsOptimization=V1Preview /agent_optimization_jobs/{jobId}: get: operationId: AgentOptimizationJobs_get summary: Get info about an agent optimization job. - description: Get an optimization job by id. + description: Get an optimization job by id. Returns 202 while in progress, 200 when terminal. parameters: - name: Foundry-Features in: header @@ -313,7 +219,7 @@ paths: schema: type: string enum: - - AgentsOptimization=V2Preview + - AgentsOptimization=V1Preview - name: jobId in: path required: true @@ -333,7 +239,6 @@ paths: headers: Retry-After: required: false - description: Recommended number of seconds to wait before polling again. schema: type: integer format: int32 @@ -341,14 +246,20 @@ paths: application/json: schema: $ref: '#/components/schemas/OptimizationJob' - 4XX: - description: Client error + '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 content: application/json: schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + $ref: '#/components/schemas/OptimizationJob' + default: + description: An unexpected error response. content: application/json: schema: @@ -357,7 +268,7 @@ paths: - AgentOptimizationJobs x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V2Preview + - AgentsOptimization=V1Preview delete: operationId: AgentOptimizationJobs_delete summary: Deletes an agent optimization job. @@ -370,13 +281,20 @@ paths: schema: type: string enum: - - AgentsOptimization=V2Preview + - AgentsOptimization=V1Preview - 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 @@ -387,14 +305,163 @@ paths: responses: '204': description: There is no content to send for this request, but the headers may be useful. - 4XX: - description: Client error + default: + description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + 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. content: application/json: schema: @@ -403,12 +470,231 @@ paths: - AgentOptimizationJobs x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V2Preview + - 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 of a running or queued job. Returns an error if the job is already in a terminal state. + description: Request cancellation. Idempotent on terminal states. parameters: - name: Foundry-Features in: header @@ -417,7 +703,7 @@ paths: schema: type: string enum: - - AgentsOptimization=V2Preview + - AgentsOptimization=V1Preview - name: jobId in: path required: true @@ -438,14 +724,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OptimizationJob' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -454,7 +734,7 @@ paths: - AgentOptimizationJobs x-ms-foundry-meta: conditional_previews: - - AgentsOptimization=V2Preview + - AgentsOptimization=V1Preview /agents: post: operationId: Agents_createAgent_Agents_createAgentFromCode @@ -486,12 +766,11 @@ paths: 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. + Creates the 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. @@ -499,20 +778,12 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. 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 @@ -532,8 +803,7 @@ paths: contentType: application/json get: operationId: Agents_listAgents - summary: List agents - description: Returns a paged collection of agent resources. + description: Returns the list of all agents. parameters: - name: kind in: query @@ -615,14 +885,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -632,7 +896,6 @@ 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 @@ -706,14 +969,8 @@ paths: content: application/json: schema: {} - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -726,8 +983,7 @@ paths: /agents/{agent_name}: get: operationId: Agents_getAgent - summary: Get an agent - description: Retrieves an agent definition by its unique name. + description: Retrieves the agent. parameters: - name: agent_name in: path @@ -749,14 +1005,8 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -797,7 +1047,6 @@ 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. @@ -805,20 +1054,12 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. 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 @@ -838,7 +1079,6 @@ 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 @@ -853,7 +1093,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. The service defaults to `false` if a value is not specified by the caller. 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. Defaults to `false`. This value is not relevant for other Agent types. schema: type: boolean default: false @@ -872,14 +1112,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteAgentResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -888,8 +1122,7 @@ paths: - Agents patch: operationId: Agents_patchAgentObject - summary: Update an agent endpoint - description: Applies a merge-patch update to the specified agent endpoint configuration. + description: Updates an agent endpoint. parameters: - name: Foundry-Features in: header @@ -905,7 +1138,6 @@ 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 @@ -920,14 +1152,8 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -946,9 +1172,8 @@ paths: /agents/{agent_name}/code:download: get: operationId: Agents_downloadAgentCode - summary: Download agent code description: |- - Downloads the code zip for a code-based hosted agent. + Download 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 @@ -1003,15 +1228,10 @@ paths: content: application/zip: schema: - contentMediaType: application/zip - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + type: string + format: binary + default: + description: An unexpected error response. content: application/json: schema: @@ -1024,7 +1244,6 @@ 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 @@ -1078,14 +1297,8 @@ paths: content: '*/*': schema: {} - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -1104,7 +1317,6 @@ 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. @@ -1137,15 +1349,9 @@ paths: application/json: schema: type: object - unevaluatedProperties: {} - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + additionalProperties: {} + default: + description: An unexpected error response. content: application/json: schema: @@ -1158,7 +1364,6 @@ 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. @@ -1208,14 +1413,8 @@ paths: content: '*/*': schema: {} - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -1228,7 +1427,6 @@ 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. @@ -1278,14 +1476,8 @@ paths: content: '*/*': schema: {} - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -1304,7 +1496,6 @@ 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 @@ -1344,20 +1535,14 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentSessionResource' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Sessions + - Agents requestBody: required: true content: @@ -1369,8 +1554,7 @@ paths: - AgentEndpoints=V1Preview get: operationId: Agents_listSessions - summary: List sessions for an agent - description: Returns a paged collection of sessions associated with the specified agent endpoint. + description: Returns a list of sessions for the specified agent. parameters: - name: Foundry-Features in: header @@ -1465,30 +1649,23 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Sessions + - Agents 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. + List files and directories at a given path in the session sandbox. + Returns only the immediate children of the specified directory (non-recursive). parameters: - name: Foundry-Features in: header @@ -1512,8 +1689,8 @@ paths: 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. + required: true + description: The directory path to list, relative to the session home directory. schema: type: string explode: false @@ -1523,46 +1700,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: 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 @@ -1577,14 +1714,8 @@ paths: application/json: schema: $ref: '#/components/schemas/SessionDirectoryListResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -1596,10 +1727,9 @@ paths: - 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. + 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 @@ -1631,7 +1761,7 @@ paths: - 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. + description: Whether to recursively delete directory contents. Defaults to false. schema: type: boolean default: false @@ -1652,14 +1782,8 @@ paths: 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 + default: + description: An unexpected error response. content: application/json: schema: @@ -1672,10 +1796,9 @@ paths: /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. + 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 @@ -1724,14 +1847,8 @@ paths: application/json: schema: $ref: '#/components/schemas/SessionFileWriteResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -1743,16 +1860,14 @@ paths: content: application/octet-stream: schema: - contentMediaType: application/octet-stream + type: string + format: binary x-ms-foundry-meta: required_previews: - HostedAgents=V1Preview get: operationId: AgentSessionFiles_downloadSessionFile - 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. + description: Download a file from the session sandbox as a binary stream. parameters: - name: Foundry-Features in: header @@ -1800,15 +1915,10 @@ paths: content: application/octet-stream: schema: - contentMediaType: application/octet-stream - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + type: string + format: binary + default: + description: An unexpected error response. content: application/json: schema: @@ -1821,8 +1931,7 @@ paths: /agents/{agent_name}/endpoint/sessions/{session_id}: get: operationId: Agents_getSession - summary: Get a session - description: Retrieves the details of a hosted agent session by agent name and session identifier. + description: Retrieves a session by ID. parameters: - name: Foundry-Features in: header @@ -1864,26 +1973,19 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentSessionResource' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Sessions + - Agents 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. @@ -1924,28 +2026,23 @@ paths: 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 + default: + description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Sessions + - Agents x-ms-foundry-meta: required_previews: - AgentEndpoints=V1Preview /agents/{agent_name}/endpoint/sessions/{session_id}:stop: post: operationId: Agents_stopSession - summary: Stop a session - description: Terminates the specified hosted agent session and returns 204 No Content when the request succeeds. + description: |- + Stops a session. + Returns 204 No Content when the stop succeeds. parameters: - name: Foundry-Features in: header @@ -1977,27 +2074,20 @@ paths: 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 + default: + description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Sessions + - Agents 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,14 +2112,8 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -2045,8 +2129,7 @@ paths: /agents/{agent_name}/operations: get: operationId: AgentContainers_listAgentContainerOperations - summary: List agent container operations - description: Returns container operations recorded for the specified agent across its container lifecycle. + description: List container operations for an agent. parameters: - name: Foundry-Features in: header @@ -2135,14 +2218,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -2155,8 +2232,7 @@ paths: /agents/{agent_name}/operations/{operation_id}: get: operationId: AgentContainers_getAgentContainerOperation - summary: Get an agent container operation - description: Retrieves the status and details of the specified container operation for an agent. + description: Get the status of a container operation for an agent. parameters: - name: Foundry-Features in: header @@ -2192,14 +2268,8 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentContainerOperationObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -2243,13 +2313,7 @@ paths: 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 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 + description: Create a new agent version. responses: '200': description: The request has succeeded. @@ -2257,25 +2321,17 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentVersionObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. 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: - - Agent Versions + - Agents requestBody: required: true content: @@ -2290,8 +2346,7 @@ paths: contentType: application/json get: operationId: Agents_listAgentVersions - summary: List agent versions - description: Returns a paged collection of versions for the specified agent. + description: Returns the list of versions of an agent. parameters: - name: agent_name in: path @@ -2372,25 +2427,18 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Versions + - Agents /agents/{agent_name}/versions/{agent_version}: get: operationId: Agents_getAgentVersion - summary: Get an agent version - description: Retrieves the specified version of an agent by its agent name and version identifier. + description: Retrieves a specific version of an agent. parameters: - name: agent_name in: path @@ -2418,23 +2466,16 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentVersionObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Versions + - Agents 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 @@ -2455,7 +2496,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. The service defaults to `false` if a value is not specified by the caller. 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. Defaults to `false`. This value is not relevant for other Agent types. schema: type: boolean default: false @@ -2474,27 +2515,18 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteAgentVersionResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Versions + - Agents /agents/{agent_name}/versions/{agent_version}/containers/default: get: operationId: AgentContainers_getAgentContainer - 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. + description: Get a container for a specific version of an agent. parameters: - name: Foundry-Features in: header @@ -2530,14 +2562,8 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentContainerObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -2550,8 +2576,7 @@ paths: /agents/{agent_name}/versions/{agent_version}/containers/default/operations: get: operationId: AgentContainers_listAgentVersionContainerOperations - summary: List agent version container operations - description: Returns container operations for the default container of the specified agent version. + description: List container operations for a specific version of an agent. parameters: - name: Foundry-Features in: header @@ -2646,14 +2671,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -2666,10 +2685,10 @@ paths: /agents/{agent_name}/versions/{agent_version}/containers/default:delete: post: operationId: AgentContainers_deleteAgentContainer - summary: Delete an agent container description: |- - Deletes the default container for the specified agent version. - The long-running operation returns an operation resource that can be polled to completion. + 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 parameters: - name: Foundry-Features in: header @@ -2711,14 +2730,8 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentContainerOperationObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -2731,10 +2744,23 @@ paths: /agents/{agent_name}/versions/{agent_version}/containers/default:logstream: post: operationId: AgentContainers_streamAgentContainerLogs - summary: Stream agent container logs description: |- - 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. + 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 parameters: - name: Foundry-Features in: header @@ -2788,14 +2814,8 @@ paths: responses: '200': description: The request has succeeded. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -2808,10 +2828,10 @@ paths: /agents/{agent_name}/versions/{agent_version}/containers/default:start: post: operationId: AgentContainers_startAgentContainer - summary: Start an agent container description: |- - Starts the default container for the specified agent version. - The long-running operation provisions replicas when a container is not already running. + 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 parameters: - name: Foundry-Features in: header @@ -2853,14 +2873,8 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentContainerOperationObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -2890,10 +2904,10 @@ paths: /agents/{agent_name}/versions/{agent_version}/containers/default:stop: post: operationId: AgentContainers_stopAgentContainer - summary: Stop an agent container description: |- - Stops the default container for the specified agent version. - The long-running operation completes even when the container is already stopped. + 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 parameters: - name: Foundry-Features in: header @@ -2935,14 +2949,8 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentContainerOperationObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -2955,10 +2963,10 @@ paths: /agents/{agent_name}/versions/{agent_version}/containers/default:update: post: operationId: AgentContainers_updateAgentContainer - summary: Update an agent container description: |- - 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. + 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 parameters: - name: Foundry-Features in: header @@ -3000,14 +3008,8 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentContainerOperationObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -3035,7 +3037,6 @@ 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. @@ -3104,28 +3105,21 @@ paths: text/event-stream: schema: $ref: '#/components/schemas/SessionLogEvent' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Sessions + - Agents x-ms-foundry-meta: required_previews: - HostedAgents=V1Preview /agents/{agent_name}/versions:import: post: operationId: Agents_createAgentVersionFromManifest - summary: Create an agent version from manifest - description: Imports the provided manifest to create a new version for the specified agent. + description: Create a new agent version from a manifest. parameters: - name: agent_name in: path @@ -3152,20 +3146,14 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentVersionObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - - Agent Versions + - Agents requestBody: required: true content: @@ -3175,8 +3163,7 @@ paths: /agents:import: post: operationId: Agents_createAgentFromManifest - summary: Create an agent from a manifest - description: Imports the provided manifest to create an agent and returns the created resource. + description: Creates an agent from a manifest. parameters: - name: api-version in: query @@ -3192,14 +3179,8 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -3215,21 +3196,20 @@ paths: /connections: get: operationId: Connections_list - summary: List connections - description: Returns the connections available in the current project, optionally filtered by type or default status. + description: List all connections in the project, without populating connection credentials parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: connectionType in: query required: false - description: Lists connections of this specific type + description: List connections of this specific type schema: $ref: '#/components/schemas/ConnectionType' explode: false - name: defaultConnection in: query required: false - description: Lists connections that are default connections + description: List connections that are default connections schema: type: boolean explode: false @@ -3247,20 +3227,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedConnection' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -3276,8 +3244,7 @@ paths: /connections/{name}: get: operationId: Connections_get - summary: Get a connection - description: Retrieves the specified connection and its configuration details without including credential values. + description: Get a connection by name, without populating connection credentials parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -3300,20 +3267,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Connection' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -3329,8 +3284,7 @@ paths: /connections/{name}/getConnectionWithCredentials: post: operationId: Connections_getWithCredentials - summary: Get a connection with credentials - description: Retrieves the specified connection together with its credential values. + description: Get a connection by name, with its connection credentials parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -3353,20 +3307,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Connection' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -3382,7 +3324,7 @@ paths: /data_generation_jobs: get: operationId: DataGenerationJobs_list - summary: List data generation jobs + summary: Returns a list of data generation jobs description: Returns a list of data generation jobs. parameters: - name: Foundry-Features @@ -3466,14 +3408,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -3485,8 +3421,8 @@ paths: - DataGenerationJobs=V1Preview post: operationId: DataGenerationJobs_create - summary: Create a data generation job - description: Submits a new data generation job for asynchronous execution. + summary: Creates a data generation job. + description: Creates a data generation job. parameters: - name: Foundry-Features in: header @@ -3527,14 +3463,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DataGenerationJob' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -3554,8 +3484,8 @@ paths: /data_generation_jobs/{jobId}: get: operationId: DataGenerationJobs_get - summary: Get a data generation job - description: Retrieves the specified data generation job and its current status. + summary: Get info about a data generation job. + description: Gets the details of a data generation job by its ID. parameters: - name: Foundry-Features in: header @@ -3592,14 +3522,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DataGenerationJob' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -3611,8 +3535,8 @@ paths: - DataGenerationJobs=V1Preview delete: operationId: DataGenerationJobs_delete - summary: Delete a data generation job - description: Removes the specified data generation job and its associated output. + summary: Deletes a data generation job. + description: Deletes a data generation job by its ID. parameters: - name: Foundry-Features in: header @@ -3638,14 +3562,8 @@ paths: 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 + default: + description: An unexpected error response. content: application/json: schema: @@ -3658,8 +3576,8 @@ paths: /data_generation_jobs/{jobId}:cancel: post: operationId: DataGenerationJobs_cancel - summary: Cancel a data generation job - description: Cancels the specified data generation job if it is still in progress. + summary: Cancels a data generation job. + description: Cancels a data generation job by its ID. parameters: - name: Foundry-Features in: header @@ -3689,14 +3607,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DataGenerationJob' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -3709,7 +3621,6 @@ 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' @@ -3720,20 +3631,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedDatasetVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -3749,7 +3648,6 @@ 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' @@ -3766,20 +3664,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedDatasetVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -3795,7 +3681,6 @@ 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' @@ -3818,20 +3703,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DatasetVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -3846,7 +3719,6 @@ 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' @@ -3865,20 +3737,8 @@ paths: 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -3893,7 +3753,6 @@ 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' @@ -3922,20 +3781,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DatasetVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -3958,8 +3805,7 @@ paths: /datasets/{name}/versions/{version}/credentials: post: operationId: Datasets_getCredentials - summary: Get dataset credentials - description: Gets the SAS credential to access the storage account associated with a Dataset version. + description: Get the SAS credential to access the storage account associated with a Dataset version. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -3981,20 +3827,8 @@ paths: application/json: schema: $ref: '#/components/schemas/AssetCredentialResponse' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -4010,8 +3844,7 @@ paths: /datasets/{name}/versions/{version}/startPendingUpload: post: operationId: Datasets_startPendingUploadVersion - summary: Start a pending upload - description: Initiates a new pending upload or retrieves an existing one for the specified dataset version. + description: Start a new or get an existing pending upload of a dataset for a specific version. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -4033,20 +3866,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PendingUploadResponse' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -4069,8 +3890,7 @@ paths: /deployments: get: operationId: Deployments_list - summary: List deployments - description: Returns the deployed models available in the current project, optionally filtered by publisher, model name, or deployment type. + description: List all deployed models in the project parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: modelPublisher @@ -4108,20 +3928,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedDeployment' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -4137,8 +3945,7 @@ paths: /deployments/{name}: get: operationId: Deployments_get - summary: Get a deployment - description: Gets a deployed model. + description: Get a deployed model. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -4161,20 +3968,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Deployment' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -4190,7 +3985,7 @@ paths: /evaluation_suite_generation_jobs: post: operationId: EvaluationSuiteGenerationJobs_create - summary: Create an evaluation suite generation job + summary: Creates 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 @@ -4232,14 +4027,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluationSuiteGenerationJob' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -4258,7 +4047,7 @@ paths: - Evaluations=V1Preview get: operationId: EvaluationSuiteGenerationJobs_list - summary: List evaluation suite generation jobs + summary: Returns a list of evaluation suite generation jobs. description: List jobs with cursor-based pagination (preview). Includes optional Foundry-Features header. parameters: - name: Foundry-Features @@ -4342,14 +4131,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -4362,7 +4145,7 @@ paths: /evaluation_suite_generation_jobs/{jobId}: get: operationId: EvaluationSuiteGenerationJobs_get - summary: Get an evaluation suite generation job + summary: Get info about an evaluation suite generation job. description: Get a job by ID (preview). Includes optional Foundry-Features header. parameters: - name: Foundry-Features @@ -4400,14 +4183,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluationSuiteGenerationJob' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -4419,7 +4196,7 @@ paths: - Evaluations=V1Preview delete: operationId: EvaluationSuiteGenerationJobs_delete - summary: Delete an evaluation suite generation job + summary: Deletes an evaluation suite generation job. description: Delete a job (preview). Returns 204 No Content. parameters: - name: Foundry-Features @@ -4446,14 +4223,8 @@ paths: 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 + default: + description: An unexpected error response. content: application/json: schema: @@ -4466,7 +4237,7 @@ paths: /evaluation_suite_generation_jobs/{jobId}:cancel: post: operationId: EvaluationSuiteGenerationJobs_cancel - summary: Cancel an evaluation suite generation job + summary: Cancels an evaluation suite generation job. description: Cancel a running job (preview). Returns 200 with the updated job. parameters: - name: Foundry-Features @@ -4497,14 +4268,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluationSuiteGenerationJob' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -4517,7 +4282,6 @@ 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' @@ -4535,20 +4299,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedEvaluationSuiteVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -4562,7 +4314,6 @@ 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' @@ -4579,20 +4330,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedEvaluationSuiteVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -4605,7 +4344,6 @@ 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 @@ -4636,14 +4374,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluationSuiteVersion' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -4661,7 +4393,6 @@ 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' @@ -4684,20 +4415,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluationSuiteVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -4710,7 +4429,6 @@ 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' @@ -4729,20 +4447,8 @@ paths: 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -4755,7 +4461,6 @@ 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' @@ -4784,20 +4489,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluationSuiteVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -4818,8 +4511,7 @@ paths: /evaluation_suites/{name}:run: post: operationId: EvaluationSuites_run - summary: Run an evaluation suite - description: Runs an evaluation using the suite's testing criteria and dataset. + description: Run an evaluation using the suite's testing criteria and dataset. parameters: - name: Foundry-Features in: header @@ -4849,14 +4541,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluationSuiteRunResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -4874,8 +4560,7 @@ paths: /evaluationrules: get: operationId: EvaluationRules_list - summary: List evaluation rules - description: Returns the evaluation rules configured for the project, optionally filtered by action type, agent name, or enabled state. + description: List all evaluation rules. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: actionType @@ -4906,20 +4591,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedEvaluationRule' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -4935,8 +4608,7 @@ paths: /evaluationrules/{id}: get: operationId: EvaluationRules_get - summary: Get an evaluation rule - description: Retrieves the specified evaluation rule and its configuration. + description: Get an evaluation rule. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: id @@ -4952,20 +4624,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluationRule' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -4980,8 +4640,7 @@ paths: - Evaluation Rules delete: operationId: EvaluationRules_delete - summary: Delete an evaluation rule - description: Removes the specified evaluation rule from the project. + description: Delete an evaluation rule. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: id @@ -4993,20 +4652,8 @@ paths: 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -5021,8 +4668,7 @@ paths: - Evaluation Rules put: operationId: EvaluationRules_createOrUpdate - summary: Create or update an evaluation rule - description: Creates a new evaluation rule, or replaces the existing rule when the identifier matches. + description: Create or update an evaluation rule. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: id @@ -5052,20 +4698,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluationRule' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -5088,8 +4722,7 @@ paths: /evaluations/runs: get: operationId: Evaluations_list - summary: List evaluation runs - description: Returns the evaluation runs available in the current project. + description: List evaluation runs parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - $ref: '#/components/parameters/Azure.Core.ClientRequestIdHeader' @@ -5106,20 +4739,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedEvaluation' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -5133,8 +4754,7 @@ paths: /evaluations/runs/{name}: get: operationId: Evaluations_get - summary: Get an evaluation run - description: Retrieves the specified evaluation run and its current status. + description: Get an evaluation run by name. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -5157,20 +4777,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Evaluation' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -5183,8 +4791,7 @@ paths: $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse' delete: operationId: Evaluations_delete - summary: Delete an evaluation run - description: Removes the specified evaluation run from the project. + description: Delete an evaluation run by name parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -5203,20 +4810,8 @@ paths: description: An opaque, globally-unique, client-generated string identifier for the request. schema: $ref: '#/components/schemas/Azure.Core.uuid' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -5230,8 +4825,7 @@ paths: /evaluations/runs/{name}:cancel: post: operationId: Evaluations_cancel - summary: Cancel an evaluation run - description: Cancels the specified evaluation run before it completes. + description: Cancel an evaluation run by name parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -5250,20 +4844,8 @@ paths: description: An opaque, globally-unique, client-generated string identifier for the request. schema: $ref: '#/components/schemas/Azure.Core.uuid' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -5277,8 +4859,7 @@ paths: /evaluations/runs:run: post: operationId: Evaluations_create - summary: Create an evaluation run - description: Submits a new evaluation run with the provided configuration. + description: Creates an evaluation run. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' responses: @@ -5288,20 +4869,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Evaluation' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -5322,8 +4891,7 @@ paths: /evaluations/runs:runAgent: post: operationId: Evaluations_createAgentEvaluation - summary: Create an agent evaluation run - description: Submits a new agent evaluation run with the provided request. + description: Creates an agent evaluation run. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' responses: @@ -5333,20 +4901,8 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentEvaluation' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -5367,8 +4923,7 @@ paths: /evaluationtaxonomies: get: operationId: EvaluationTaxonomies_list - summary: List evaluation taxonomies - description: Returns the evaluation taxonomies available in the project, optionally filtered by input name or input type. + description: List evaluation taxonomies parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: inputName @@ -5400,20 +4955,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedEvaluationTaxonomy' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -5429,8 +4972,7 @@ paths: /evaluationtaxonomies/{name}: get: operationId: EvaluationTaxonomies_get - summary: Get an evaluation taxonomy - description: Retrieves the specified evaluation taxonomy. + description: Get an evaluation run by name. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -5454,20 +4996,8 @@ paths: 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -5482,8 +5012,7 @@ paths: - Evaluation Taxonomies delete: operationId: EvaluationTaxonomies_delete - summary: Delete an evaluation taxonomy - description: Removes the specified evaluation taxonomy from the project. + description: Delete an evaluation taxonomy by name. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -5503,20 +5032,8 @@ paths: 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -5531,8 +5048,7 @@ paths: - Evaluation Taxonomies put: operationId: EvaluationTaxonomies_create - summary: Create an evaluation taxonomy - description: Creates or replaces the specified evaluation taxonomy with the provided definition. + description: Create an evaluation taxonomy. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: Foundry-Features @@ -5562,20 +5078,8 @@ paths: 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -5597,7 +5101,6 @@ 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' @@ -5622,20 +5125,8 @@ paths: 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -5658,7 +5149,7 @@ paths: /evaluator_generation_jobs: post: operationId: EvaluatorGenerationJobs_create - summary: Create an evaluator generation job + summary: Creates an evaluator generation job. description: |- Creates an evaluator generation job. The service generates rubric-based evaluator definitions from the provided source materials asynchronously. @@ -5702,14 +5193,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluatorGenerationJob' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -5728,12 +5213,8 @@ paths: - Evaluations=V1Preview get: operationId: EvaluatorGenerationJobs_list - 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. + summary: Returns a list of evaluator generation jobs. + description: Returns a list of evaluator generation jobs. parameters: - name: Foundry-Features in: header @@ -5816,14 +5297,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -5836,7 +5311,7 @@ paths: /evaluator_generation_jobs/{jobId}: get: operationId: EvaluatorGenerationJobs_get - summary: Get an evaluator generation job + summary: Get info about an evaluator generation job. description: Gets the details of an evaluator generation job by its ID. parameters: - name: Foundry-Features @@ -5874,14 +5349,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluatorGenerationJob' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -5893,7 +5362,6 @@ 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. @@ -5922,14 +5390,8 @@ paths: 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 + default: + description: An unexpected error response. content: application/json: schema: @@ -5942,7 +5404,7 @@ paths: /evaluator_generation_jobs/{jobId}:cancel: post: operationId: EvaluatorGenerationJobs_cancel - summary: Cancel an evaluator generation job + summary: Cancels an evaluator generation job. description: Cancels an evaluator generation job by its ID. parameters: - name: Foundry-Features @@ -5973,14 +5435,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluatorGenerationJob' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -5993,8 +5449,7 @@ paths: /evaluators: get: operationId: Evaluators_listLatestVersions - summary: List latest evaluator versions - description: Lists the latest version of each evaluator + description: List the latest version of each evaluator parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: type @@ -6032,20 +5487,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedEvaluatorVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -6061,8 +5504,7 @@ paths: /evaluators/{name}/versions: get: operationId: Evaluators_listVersions - summary: List evaluator versions - description: Returns the available versions for the specified evaluator. + description: List all versions of the given evaluator parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -6106,20 +5548,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedEvaluatorVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -6134,8 +5564,7 @@ paths: - Evaluators post: operationId: Evaluators_createVersion - summary: Create an evaluator version - description: Creates a new evaluator version with an auto-incremented version identifier. + description: Create a new EvaluatorVersion with auto incremented version id parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -6159,20 +5588,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluatorVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -6194,8 +5611,7 @@ paths: /evaluators/{name}/versions/{version}: get: operationId: Evaluators_getVersion - summary: Get an evaluator version - description: Retrieves the specified evaluator version, returning 404 if it does not exist. + description: Get the specific version of the EvaluatorVersion. The service returns 404 Not Found error if the EvaluatorVersion does not exist. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -6225,20 +5641,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluatorVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -6253,8 +5657,7 @@ paths: - Evaluators delete: operationId: Evaluators_deleteVersion - summary: Delete an evaluator version - description: Removes the specified evaluator version. Returns 204 whether the version existed or not. + 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. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -6280,20 +5683,8 @@ paths: 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -6308,8 +5699,7 @@ paths: - Evaluators patch: operationId: Evaluators_updateVersion - summary: Update an evaluator version - description: Updates the specified evaluator version in place. + description: Update an existing EvaluatorVersion with the given version id parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -6339,20 +5729,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvaluatorVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -6375,8 +5753,7 @@ paths: /evaluators/{name}/versions/{version}/credentials: post: operationId: Evaluators_getCredentials - summary: Get evaluator credentials - description: Retrieves SAS credentials for accessing the storage account associated with the specified evaluator version. + description: Get the SAS credential to access the storage account associated with an Evaluator version. parameters: - name: Foundry-Features in: header @@ -6411,14 +5788,8 @@ paths: application/json: schema: $ref: '#/components/schemas/AssetCredentialResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -6438,8 +5809,7 @@ paths: /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. + description: Start a new or get an existing pending upload of an evaluator for a specific version. parameters: - name: Foundry-Features in: header @@ -6474,14 +5844,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PendingUploadResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -6501,7 +5865,6 @@ 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' @@ -6512,20 +5875,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedIndex' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -6541,7 +5892,6 @@ 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' @@ -6558,20 +5908,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedIndex' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -6587,7 +5925,6 @@ 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' @@ -6610,20 +5947,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Index' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -6638,7 +5963,6 @@ 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' @@ -6657,20 +5981,8 @@ paths: 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -6685,7 +5997,6 @@ 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' @@ -6714,20 +6025,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Index' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -6750,8 +6049,7 @@ paths: /insights: post: operationId: Insights_generate - summary: Generate insights - description: Generates an insights report from the provided evaluation configuration. + description: Generate Insights parameters: - name: Foundry-Features in: header @@ -6788,14 +6086,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Insight' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -6811,8 +6103,7 @@ paths: description: Complete evaluation configuration including data source, evaluators, and result settings get: operationId: Insights_list - summary: List insights - description: Returns insights in reverse chronological order, with the most recent entries first. + description: List all insights in reverse chronological order (newest first). parameters: - name: Foundry-Features in: header @@ -6871,14 +6162,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedInsight' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -6888,8 +6173,7 @@ paths: /insights/{id}: get: operationId: Insights_get - summary: Get an insight - description: Retrieves the specified insight report and its results. + description: Get a specific insight by Id. parameters: - name: Foundry-Features in: header @@ -6926,14 +6210,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Insight' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -6943,8 +6221,6 @@ paths: /managedAgentIdentityBlueprints: get: operationId: ManagedAgentIdentityBlueprints_listManagedAgentIdentityBlueprints - summary: List blueprints - description: Lists all managed agent identity blueprints. parameters: - name: Foundry-Features in: header @@ -6988,14 +6264,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedManagedAgentIdentityBlueprint' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7006,8 +6276,6 @@ 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 @@ -7037,14 +6305,8 @@ paths: application/json: schema: $ref: '#/components/schemas/ManagedAgentIdentityBlueprint' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7060,7 +6322,6 @@ paths: - AgentEndpoints=V1Preview get: operationId: ManagedAgentIdentityBlueprints_getManagedAgentIdentityBlueprint - summary: Get a blueprint description: Retrieves a managed agent identity blueprint by name. parameters: - name: Foundry-Features @@ -7091,14 +6352,8 @@ paths: application/json: schema: $ref: '#/components/schemas/ManagedAgentIdentityBlueprint' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7108,7 +6363,6 @@ paths: - AgentEndpoints=V1Preview delete: operationId: ManagedAgentIdentityBlueprints_deleteManagedAgentIdentityBlueprint - summary: Delete a blueprint description: Deletes a managed agent identity blueprint by name. parameters: - name: Foundry-Features @@ -7135,14 +6389,8 @@ paths: 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 + default: + description: An unexpected error response. content: application/json: schema: @@ -7153,8 +6401,7 @@ paths: /memory_stores: post: operationId: createMemoryStore - summary: Create a memory store - description: Creates a memory store resource with the provided configuration. + description: Create a memory store. parameters: - name: Foundry-Features in: header @@ -7178,14 +6425,8 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryStoreObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7209,7 +6450,7 @@ paths: description: A human-readable description of the memory store. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Arbitrary key-value metadata to associate with the memory store. definition: @@ -7224,8 +6465,7 @@ paths: - MemoryStores=V1Preview get: operationId: listMemoryStores - summary: List memory stores - description: Returns the memory stores available to the caller. + description: List all memory stores. parameters: - name: Foundry-Features in: header @@ -7308,14 +6548,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7328,8 +6562,7 @@ paths: /memory_stores/{name}: post: operationId: updateMemoryStore - summary: Update a memory store - description: Updates the specified memory store with the supplied configuration changes. + description: Update a memory store. parameters: - name: Foundry-Features in: header @@ -7359,14 +6592,8 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryStoreObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7386,7 +6613,7 @@ paths: description: A human-readable description of the memory store. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Arbitrary key-value metadata to associate with the memory store. x-ms-foundry-meta: @@ -7394,8 +6621,7 @@ paths: - MemoryStores=V1Preview get: operationId: getMemoryStore - summary: Get a memory store - description: Retrieves the specified memory store and its current configuration. + description: Retrieve a memory store. parameters: - name: Foundry-Features in: header @@ -7425,14 +6651,8 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryStoreObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7444,8 +6664,7 @@ paths: - MemoryStores=V1Preview delete: operationId: deleteMemoryStore - summary: Delete a memory store - description: Deletes the specified memory store. + description: Delete a memory store. parameters: - name: Foundry-Features in: header @@ -7475,14 +6694,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteMemoryStoreResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7495,8 +6708,7 @@ paths: /memory_stores/{name}/items: post: operationId: createMemory - summary: Create a memory item - description: Creates a memory item in the specified memory store. + description: Create a memory item in a memory store. parameters: - name: Foundry-Features in: header @@ -7526,14 +6738,8 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryItem' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7567,8 +6773,7 @@ paths: /memory_stores/{name}/items/{memory_id}: post: operationId: updateMemory - summary: Update a memory item - description: Updates the specified memory item in the memory store. + description: Update a memory item in a memory store. parameters: - name: Foundry-Features in: header @@ -7604,14 +6809,8 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryItem' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7635,8 +6834,7 @@ paths: - MemoryStores=V1Preview get: operationId: getMemory - summary: Get a memory item - description: Retrieves the specified memory item from the memory store. + description: Retrieve a memory item from a memory store. parameters: - name: Foundry-Features in: header @@ -7672,14 +6870,8 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryItem' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7691,8 +6883,7 @@ paths: - MemoryStores=V1Preview delete: operationId: deleteMemory - summary: Delete a memory item - description: Deletes the specified memory item from the memory store. + description: Delete a memory item from a memory store. parameters: - name: Foundry-Features in: header @@ -7728,14 +6919,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteMemoryResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7748,8 +6933,7 @@ paths: /memory_stores/{name}/items:list: post: operationId: listMemories - summary: List memory items - description: Returns memory items from the specified memory store. + description: List all memory items in a memory store. parameters: - name: Foundry-Features in: header @@ -7845,14 +7029,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7877,8 +7055,7 @@ paths: /memory_stores/{name}/updates/{update_id}: get: operationId: getUpdateResult - summary: Get an update result - description: Retrieves the status and result of a memory store update operation. + description: Get memory store update result. parameters: - name: Foundry-Features in: header @@ -7914,14 +7091,8 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryStoreUpdateResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7934,8 +7105,7 @@ paths: /memory_stores/{name}:delete_scope: post: operationId: deleteScopeMemories - summary: Delete memories by scope - description: Deletes all memories in the specified memory store that are associated with the provided scope. + description: Delete all memories associated with a specific scope from a memory store. parameters: - name: Foundry-Features in: header @@ -7965,14 +7135,8 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryStoreDeleteScopeResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -7997,8 +7161,7 @@ paths: /memory_stores/{name}:search_memories: post: operationId: searchMemories - summary: Search memories - description: Searches the specified memory store for memories relevant to the provided conversation context. + description: Search for relevant memories from a memory store based on conversation context. parameters: - name: Foundry-Features in: header @@ -8028,14 +7191,8 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryStoreSearchResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -8072,10 +7229,7 @@ paths: /memory_stores/{name}:update_memories: post: operationId: updateMemories - 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. + description: Update memory store with conversation memories. parameters: - name: Foundry-Features in: header @@ -8112,14 +7266,8 @@ paths: application/json: schema: $ref: '#/components/schemas/MemoryStoreUpdateResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -8161,7 +7309,6 @@ 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' @@ -8180,20 +7327,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedModelVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -8209,7 +7344,6 @@ 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' @@ -8234,20 +7368,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedModelVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -8263,8 +7385,7 @@ paths: /models/{name}/versions/{version}: get: operationId: Models_getVersion - summary: Get a model version - description: Retrieves the specified model version, returning 404 if it does not exist. + description: Get the specific version of the ModelVersion. The service returns 404 Not Found error if the ModelVersion does not exist. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -8294,20 +7415,8 @@ paths: application/json: schema: $ref: '#/components/schemas/ModelVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -8325,7 +7434,6 @@ 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' @@ -8352,20 +7460,8 @@ paths: responses: '200': description: The request has succeeded. - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -8383,7 +7479,6 @@ 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' @@ -8420,20 +7515,8 @@ paths: application/json: schema: $ref: '#/components/schemas/ModelVersion' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -8459,8 +7542,7 @@ paths: /models/{name}/versions/{version}/createAsync: post: operationId: Models_createAsync - 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. + description: Creates a model version asynchronously with blob content validation. Returns 202 Accepted with a Location header for polling. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: Foundry-Features @@ -8503,25 +7585,12 @@ paths: format: uri description: URL to poll for operation status. operationResult: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true description: URL to the operation result, or null if the operation is still in progress. - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -8547,8 +7616,7 @@ paths: /models/{name}/versions/{version}/credentials: post: operationId: Models_getCredentials - summary: Get model asset credentials - description: Retrieves temporary credentials for accessing the storage backing the specified model version. + description: Get credentials for a model version asset. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: Foundry-Features @@ -8578,20 +7646,8 @@ paths: application/json: schema: $ref: '#/components/schemas/AssetCredentialResponse' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -8616,8 +7672,7 @@ paths: /models/{name}/versions/{version}/startPendingUpload: post: operationId: Models_startPendingUpload - summary: Start a pending upload - description: Initiates a new pending upload or retrieves an existing one for the specified model version. + description: Start or retrieve a pending upload for a model version. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: Foundry-Features @@ -8647,20 +7702,8 @@ paths: application/json: schema: $ref: '#/components/schemas/ModelPendingUploadResponse' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -8685,8 +7728,7 @@ paths: /openai/v1/conversations: post: operationId: createConversation - summary: Create a conversation - description: Creates a new conversation resource. + description: Create a conversation. parameters: - name: x-ms-user-isolation-key in: header @@ -8701,14 +7743,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ConversationResource' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -8723,8 +7759,7 @@ paths: $ref: '#/components/schemas/OpenAI.CreateConversationBody' get: operationId: listConversations - summary: List conversations - description: Returns the conversations available in the current project. + description: Returns the list of all conversations. parameters: - name: limit in: query @@ -8812,14 +7847,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -8829,8 +7858,7 @@ paths: /openai/v1/conversations/{conversation_id}: post: operationId: updateConversation - summary: Update a conversation - description: Modifies the specified conversation's properties. + description: Update a conversation. parameters: - name: conversation_id in: path @@ -8851,14 +7879,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ConversationResource' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -8873,8 +7895,7 @@ paths: $ref: '#/components/schemas/OpenAI.UpdateConversationBody' get: operationId: getConversation - summary: Retrieve a conversation - description: Retrieves the specified conversation and its metadata. + description: Retrieves a conversation. parameters: - name: conversation_id in: path @@ -8895,14 +7916,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ConversationResource' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -8911,8 +7926,7 @@ paths: - Conversations delete: operationId: deleteConversation - summary: Delete a conversation - description: Removes the specified conversation resource from the current project. + description: Deletes a conversation. parameters: - name: conversation_id in: path @@ -8933,14 +7947,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.DeletedConversationResource' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -8950,8 +7958,7 @@ paths: /openai/v1/conversations/{conversation_id}/items: post: operationId: createConversationItems - summary: Create conversation items - description: Adds one or more items to the specified conversation. + description: Create items in a conversation with the given ID. parameters: - name: conversation_id in: path @@ -8983,14 +7990,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ConversationItemList' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -9014,8 +8015,7 @@ paths: - items get: operationId: listConversationItems - summary: List conversation items - description: Returns the items belonging to the specified conversation. + description: List all items for a conversation with the given ID. parameters: - name: conversation_id in: path @@ -9102,14 +8102,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -9119,8 +8113,7 @@ paths: /openai/v1/conversations/{conversation_id}/items/{item_id}: get: operationId: getConversationItem - summary: Get a conversation item - description: Retrieves a specific item from the specified conversation. + description: Get a single item from a conversation with the given IDs. parameters: - name: conversation_id in: path @@ -9147,14 +8140,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.OutputItem' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -9163,8 +8150,7 @@ paths: - Conversations delete: operationId: deleteConversationItem - summary: Delete a conversation item - description: Removes the specified item from a conversation. + description: Delete an item from a conversation with the given IDs. parameters: - name: conversation_id in: path @@ -9191,14 +8177,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ConversationResource' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -9208,8 +8188,8 @@ paths: /openai/v1/evals: get: operationId: Evals_listEvals - summary: List evaluations - description: Returns the evaluations configured in the current project. + summary: List all evaluations + description: List evaluations for a project. parameters: - name: after in: query @@ -9223,7 +8203,8 @@ paths: required: false description: Number of runs to retrieve. schema: - $ref: '#/components/schemas/integer' + allOf: + - $ref: '#/components/schemas/integer' default: 20 explode: false - name: order @@ -9275,14 +8256,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -9291,9 +8266,9 @@ paths: - Evals post: operationId: Evals_createEval - summary: Create an evaluation + summary: Create evaluation description: |- - Creates the structure of an evaluation that can be used to test a model's performance. + Create 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: [] @@ -9304,14 +8279,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Eval' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -9328,7 +8297,7 @@ paths: delete: operationId: Evals_deleteEval summary: Delete an evaluation - description: Removes the specified evaluation and its associated data. + description: Delete an evaluation. parameters: - name: eval_id in: path @@ -9343,14 +8312,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteEvalResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -9360,7 +8323,7 @@ paths: get: operationId: Evals_getEval summary: Get an evaluation - description: Retrieves the specified evaluation and its configuration. + description: Get an evaluation by ID. parameters: - name: eval_id in: path @@ -9375,14 +8338,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Eval' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -9392,7 +8349,7 @@ paths: post: operationId: Evals_updateEval summary: Update an evaluation - description: Updates certain properties of an evaluation. + description: Update certain properties of an evaluation. parameters: - name: eval_id in: path @@ -9407,14 +8364,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Eval' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -9430,8 +8381,8 @@ paths: /openai/v1/evals/{eval_id}/runs: get: operationId: Evals_listRuns - summary: List evaluation runs - description: Returns the runs associated with the specified evaluation. + summary: Get a list of runs for an evaluation + description: Get a list of runs for an evaluation. parameters: - name: eval_id in: path @@ -9451,7 +8402,8 @@ paths: required: false description: Number of runs to retrieve. schema: - $ref: '#/components/schemas/integer' + allOf: + - $ref: '#/components/schemas/integer' default: 20 explode: false - name: order @@ -9504,14 +8456,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -9520,8 +8466,7 @@ paths: - Evals post: operationId: Evals_createEvalRun - summary: Create an evaluation run - description: Creates an evaluation run for the specified evaluation. + summary: Create evaluation run parameters: - name: eval_id in: path @@ -9536,14 +8481,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvalRun' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -9559,8 +8498,8 @@ paths: /openai/v1/evals/{eval_id}/runs/{run_id}: delete: operationId: Evals_deleteEvalRun - summary: Delete an evaluation run - description: Removes the specified evaluation run. + summary: Delete evaluation run + description: Delete an eval run. parameters: - name: eval_id in: path @@ -9581,14 +8520,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteEvalRunResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -9598,7 +8531,7 @@ paths: get: operationId: Evals_getEvalRun summary: Get an evaluation run - description: Retrieves the specified evaluation run and its current status. + description: Get an evaluation run by ID. parameters: - name: eval_id in: path @@ -9619,14 +8552,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvalRun' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -9635,8 +8562,8 @@ paths: - Evals post: operationId: Evals_cancelEvalRun - summary: Cancel an evaluation run - description: Cancels an ongoing evaluation run. + summary: Cancel evaluation run + description: Cancel an ongoing evaluation run. parameters: - name: eval_id in: path @@ -9657,14 +8584,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvalRun' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -9674,8 +8595,8 @@ paths: /openai/v1/evals/{eval_id}/runs/{run_id}/output_items: get: operationId: Evals_getEvalRunOutputItems - summary: List evaluation run output items - description: Returns the output items produced by the specified evaluation run. + summary: Get evaluation run output items + description: Get a list of output items for an evaluation run. parameters: - name: eval_id in: path @@ -9700,7 +8621,8 @@ paths: required: false description: Number of runs to retrieve. schema: - $ref: '#/components/schemas/integer' + allOf: + - $ref: '#/components/schemas/integer' default: 20 explode: false - name: order @@ -9751,14 +8673,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -9769,7 +8685,7 @@ paths: get: operationId: Evals_getEvalRunOutputItem summary: Get an output item of an evaluation run - description: Retrieves a single output item from the specified evaluation run. + description: Get an evaluation run output item by ID. parameters: - name: eval_id in: path @@ -9796,14 +8712,8 @@ paths: application/json: schema: $ref: '#/components/schemas/EvalRunOutputItem' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -9813,7 +8723,6 @@ 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. @@ -9835,14 +8744,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.FineTuningJob' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -9857,8 +8760,7 @@ paths: $ref: '#/components/schemas/OpenAI.CreateFineTuningJobRequest' get: operationId: listPaginatedFineTuningJobs - summary: List fine-tuning jobs - description: Returns the fine-tuning jobs for the current organization. + description: List your organization's fine-tuning jobs parameters: - name: after in: query @@ -9890,14 +8792,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ListPaginatedFineTuningJobsResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -9907,9 +8803,8 @@ paths: /openai/v1/fine_tuning/jobs/{fine_tuning_job_id}: get: operationId: retrieveFineTuningJob - summary: Get a fine-tuning job description: |- - Gets info about a fine-tuning job. + Get info about a fine-tuning job. [Learn more about fine-tuning](https://platform.openai.com/docs/guides/fine-tuning) parameters: @@ -9933,14 +8828,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.FineTuningJob' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -9950,8 +8839,7 @@ paths: /openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel: post: operationId: cancelFineTuningJob - summary: Cancel a fine-tuning job - description: Immediately cancels the specified fine-tuning job. + description: Immediately cancel a fine-tune job. parameters: - name: fine_tuning_job_id in: path @@ -9973,14 +8861,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.FineTuningJob' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -9990,8 +8872,7 @@ paths: /openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints: get: operationId: listFineTuningJobCheckpoints - summary: List fine-tuning job checkpoints - description: Returns the checkpoints saved during the specified fine-tuning job. + description: List checkpoints for a fine-tuning job. parameters: - name: fine_tuning_job_id in: path @@ -10029,14 +8910,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ListFineTuningJobCheckpointsResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -10046,8 +8921,7 @@ paths: /openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events: get: operationId: listFineTuningJobEvents - summary: List fine-tuning job events - description: Returns the status events emitted during the specified fine-tuning job. + description: Get fine-grained status updates for a fine-tuning job. parameters: - name: fine_tuning_job_id in: path @@ -10085,14 +8959,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.ListFineTuningJobEventsResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -10102,8 +8970,7 @@ paths: /openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause: post: operationId: pauseFineTuningJob - summary: Pause a fine-tuning job - description: Pauses the specified fine-tuning job while it is running. + description: Pause a running fine-tune job. parameters: - name: fine_tuning_job_id in: path @@ -10125,14 +8992,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.FineTuningJob' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -10142,8 +9003,7 @@ paths: /openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume: post: operationId: resumeFineTuningJob - summary: Resume a fine-tuning job - description: Resumes the specified fine-tuning job after it has been paused. + description: Resume a paused fine-tune job. parameters: - name: fine_tuning_job_id in: path @@ -10165,14 +9025,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.FineTuningJob' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -10181,9 +9035,7 @@ paths: - Fine-Tuning /openai/v1/responses: post: - 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. + operationId: createResponse_createResponseStream parameters: - name: x-ms-user-isolation-key in: header @@ -10191,6 +9043,7 @@ 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. @@ -10203,213 +9056,12 @@ paths: content: application/json: schema: - 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 + $ref: '#/components/schemas/OpenAI.Response' text/event-stream: schema: $ref: '#/components/schemas/OpenAI.CreateResponseStreamingResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -10421,161 +9073,298 @@ paths: content: application/json: schema: - 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 + 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 + - 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 + 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 - - type: 'null' - default: disabled - input: - $ref: '#/components/schemas/OpenAI.InputParam' - include: - anyOf: - - type: array + nullable: true + default: disabled + input: + $ref: '#/components/schemas/OpenAI.InputParam' + include: + type: array items: $ref: '#/components/schemas/OpenAI.IncludeEnum' - - 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 + 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' - - 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. + 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 + 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. get: operationId: listResponses - summary: List responses - description: Returns a collection of all stored responses matching specified filter criteria. + description: Returns the list of all responses. parameters: - name: limit in: query @@ -10670,14 +9459,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -10687,8 +9470,7 @@ paths: /openai/v1/responses/compact: post: operationId: compactResponseConversation - summary: Compact a conversation - description: Compacts a conversation into a response object suitable for long-running and zero-data-retention scenarios. + description: Produces a compaction of a responses conversation. parameters: [] responses: '200': @@ -10697,14 +9479,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.CompactResource' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -10719,9 +9495,7 @@ paths: $ref: '#/components/schemas/OpenAI.CompactResponseMethodPublicBody' /openai/v1/responses/{response_id}: get: - operationId: getResponse - summary: Retrieve a model response - description: Retrieves a model response with the given ID. + operationId: getResponse_getResponseStream parameters: - name: response_id in: path @@ -10756,6 +9530,14 @@ 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. @@ -10772,14 +9554,8 @@ paths: text/event-stream: schema: $ref: '#/components/schemas/OpenAI.CreateResponseStreamingResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -10788,7 +9564,6 @@ paths: - Responses delete: operationId: deleteResponse - summary: Delete a model response description: Deletes a model response. parameters: - name: response_id @@ -10816,14 +9591,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteResponseResult' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -10833,8 +9602,7 @@ paths: /openai/v1/responses/{response_id}/cancel: post: operationId: cancelResponse - 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. + description: Cancels a model response. parameters: - name: response_id in: path @@ -10861,14 +9629,8 @@ paths: application/json: schema: $ref: '#/components/schemas/OpenAI.Response' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -10878,8 +9640,7 @@ paths: /openai/v1/responses/{response_id}/input_items: get: operationId: listInputItems - summary: List input items for a response - description: Retrieves the input items associated with the specified response. + description: Returns a list of input items for a given response. parameters: - name: response_id in: path @@ -10964,14 +9725,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -10981,8 +9736,7 @@ paths: /redTeams/runs: get: operationId: RedTeams_list - summary: List redteams - description: Returns the redteams available in the current project. + description: List a redteam by name. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: Foundry-Features @@ -11000,20 +9754,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedRedTeam' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -11029,8 +9771,7 @@ paths: /redTeams/runs/{name}: get: operationId: RedTeams_get - summary: Get a redteam - description: Retrieves the specified redteam and its configuration. + description: Get a redteam by name. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: name @@ -11054,20 +9795,8 @@ paths: application/json: schema: $ref: '#/components/schemas/RedTeam' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -11083,8 +9812,7 @@ paths: /redTeams/runs:run: post: operationId: RedTeams_create - summary: Create a redteam run - description: Submits a new redteam run for execution with the provided configuration. + description: Creates a redteam run. parameters: - name: Foundry-Features in: header @@ -11108,14 +9836,8 @@ paths: application/json: schema: $ref: '#/components/schemas/RedTeam' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -11132,8 +9854,7 @@ paths: /routines: get: operationId: listRoutines - summary: List routines - description: Returns the routines available in the current project. + description: List routines. parameters: - name: Foundry-Features in: header @@ -11143,10 +9864,46 @@ paths: type: string enum: - Routines=V1Preview - - $ref: '#/components/parameters/ListRoutinesParameters.limit' - - $ref: '#/components/parameters/ListRoutinesParameters.after' - - $ref: '#/components/parameters/ListRoutinesParameters.before' - - $ref: '#/components/parameters/ListRoutinesParameters.order' + - 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 @@ -11180,14 +9937,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -11200,8 +9951,7 @@ paths: /routines/{routine_name}: put: operationId: createOrUpdateRoutine - summary: Create or update a routine - description: Creates a new routine or replaces an existing routine with the supplied definition. + description: Create or update a routine. parameters: - name: Foundry-Features in: header @@ -11226,14 +9976,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Routine' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -11251,8 +9995,7 @@ paths: - Routines=V1Preview get: operationId: getRoutine - summary: Get a routine - description: Retrieves the specified routine and its current configuration. + description: Retrieve a routine. parameters: - name: Foundry-Features in: header @@ -11277,14 +10020,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Routine' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -11296,8 +10033,7 @@ paths: - Routines=V1Preview delete: operationId: deleteRoutine - summary: Delete a routine - description: Deletes the specified routine. + description: Delete a routine. parameters: - name: Foundry-Features in: header @@ -11318,14 +10054,8 @@ paths: 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 + default: + description: An unexpected error response. content: application/json: schema: @@ -11338,8 +10068,7 @@ paths: /routines/{routine_name}/runs: get: operationId: listRoutineRuns - summary: List prior runs for a routine - description: Returns prior runs recorded for the specified routine. + description: List prior runs for a routine. parameters: - name: Foundry-Features in: header @@ -11351,10 +10080,46 @@ paths: - Routines=V1Preview - $ref: '#/components/parameters/ListRoutineRunsParameters.routine_name' - $ref: '#/components/parameters/ListRoutineRunsParameters.filter' - - $ref: '#/components/parameters/ListRoutineRunsParameters.limit' - - $ref: '#/components/parameters/ListRoutineRunsParameters.after' - - $ref: '#/components/parameters/ListRoutineRunsParameters.before' - - $ref: '#/components/parameters/ListRoutineRunsParameters.order' + - 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 @@ -11388,14 +10153,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -11408,8 +10167,7 @@ paths: /routines/{routine_name}:disable: post: operationId: disableRoutine - summary: Disable a routine - description: Disables the specified routine so it no longer runs. + description: Disable a routine. parameters: - name: Foundry-Features in: header @@ -11434,14 +10192,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Routine' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -11454,8 +10206,7 @@ paths: /routines/{routine_name}:dispatch_async: post: operationId: dispatchRoutineAsync - summary: Queue an asynchronous routine dispatch - description: Queues an asynchronous dispatch for the specified routine. + description: Queue an asynchronous routine dispatch. parameters: - name: Foundry-Features in: header @@ -11480,14 +10231,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DispatchRoutineResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -11506,8 +10251,7 @@ paths: /routines/{routine_name}:enable: post: operationId: enableRoutine - summary: Enable a routine - description: Enables the specified routine so it can be dispatched. + description: Enable a routine. parameters: - name: Foundry-Features in: header @@ -11532,14 +10276,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Routine' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -11552,8 +10290,7 @@ paths: /schedules: get: operationId: Schedules_list - summary: List schedules - description: Returns schedules that match the supplied type and enabled filters. + description: List all schedules. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: type @@ -11585,20 +10322,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedSchedule' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -11614,8 +10339,7 @@ paths: /schedules/{id}: delete: operationId: Schedules_delete - summary: Delete a schedule - description: Deletes the specified schedule resource. + description: Delete a schedule. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: id @@ -11635,20 +10359,8 @@ paths: 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -11663,8 +10375,7 @@ paths: - Schedules get: operationId: Schedules_get - summary: Get a schedule - description: Retrieves the specified schedule resource. + description: Get a schedule by id. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: id @@ -11688,20 +10399,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Schedule' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -11716,8 +10415,7 @@ paths: - Schedules put: operationId: Schedules_createOrUpdate - summary: Create or update a schedule - description: Creates a new schedule or updates an existing schedule with the supplied definition. + description: Create or update operation template. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: id @@ -11747,20 +10445,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Schedule' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -11783,8 +10469,7 @@ paths: /schedules/{id}/runs: get: operationId: Schedules_listRuns - summary: List schedule runs - description: Returns schedule runs that match the supplied filters. + description: List all schedule runs. parameters: - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: id @@ -11822,20 +10507,8 @@ paths: application/json: schema: $ref: '#/components/schemas/PagedScheduleRun' - 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 + default: + description: An unexpected error response. headers: x-ms-error-code: required: false @@ -11851,8 +10524,7 @@ paths: /schedules/{schedule_id}/runs/{run_id}: get: operationId: Schedules_getRun - summary: Get a schedule run - description: Retrieves the specified run for a schedule. + description: Get a schedule run by id. parameters: - name: schedule_id in: path @@ -11888,14 +10560,8 @@ paths: application/json: schema: $ref: '#/components/schemas/ScheduleRun' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -11905,8 +10571,7 @@ paths: /skills: get: operationId: Skills_listSkills - summary: List skills - description: Returns the skills available in the current project. + description: Returns the list of all skills. parameters: - name: limit in: query @@ -11989,14 +10654,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -12009,8 +10668,7 @@ paths: /skills/{name}: get: operationId: Skills_getSkill - summary: Retrieve a skill - description: Retrieves the specified skill and its current configuration. + description: Retrieves a skill. parameters: - name: name in: path @@ -12040,14 +10698,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Skill' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -12059,8 +10711,7 @@ paths: - Skills=V1Preview post: operationId: updateSkill - summary: Update a skill - description: Modifies the specified skill's configuration. + description: Update a skill. parameters: - name: name in: path @@ -12090,14 +10741,8 @@ paths: application/json: schema: $ref: '#/components/schemas/Skill' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -12121,8 +10766,7 @@ paths: - Skills=V1Preview delete: operationId: Skills_deleteSkill - summary: Delete a skill - description: Removes the specified skill and its associated versions. + description: Deletes a skill. parameters: - name: name in: path @@ -12152,14 +10796,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteSkillResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -12172,8 +10810,7 @@ paths: /skills/{name}/content: get: operationId: getSkillContent - summary: Download the zip content for the default version of a skill - description: Downloads the zip content for the default version of a skill. + description: Download the zip content for the default version of a skill. parameters: - name: name in: path @@ -12202,15 +10839,10 @@ paths: content: application/zip: schema: - contentMediaType: application/zip - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + type: string + format: binary + default: + description: An unexpected error response. content: application/json: schema: @@ -12246,7 +10878,6 @@ 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. @@ -12254,20 +10885,12 @@ paths: application/json: schema: $ref: '#/components/schemas/SkillVersion' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. 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 @@ -12297,8 +10920,7 @@ paths: contentType: text/plain get: operationId: listSkillVersions - summary: List skill versions - description: Returns the available versions for the specified skill. + description: List all versions of a skill. parameters: - name: name in: path @@ -12387,14 +11009,8 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -12407,8 +11023,7 @@ paths: /skills/{name}/versions/{version}: get: operationId: getSkillVersion - summary: Retrieve a specific version of a skill - description: Retrieves the specified version of a skill by name and version identifier. + description: Retrieve a specific version of a skill. parameters: - name: name in: path @@ -12444,14 +11059,8 @@ paths: application/json: schema: $ref: '#/components/schemas/SkillVersion' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -12463,8 +11072,7 @@ paths: - Skills=V1Preview delete: operationId: deleteSkillVersion - summary: Delete a specific version of a skill - description: Removes the specified version of a skill. + description: Delete a specific version of a skill. parameters: - name: name in: path @@ -12500,14 +11108,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteSkillVersionResponse' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -12520,8 +11122,7 @@ paths: /skills/{name}/versions/{version}/content: get: operationId: getSkillVersionContent - summary: Download the zip content for a specific version of a skill - description: Downloads the zip content for a specific version of a skill. + description: Download the zip content for a specific version of a skill. parameters: - name: name in: path @@ -12556,15 +11157,10 @@ paths: content: application/zip: schema: - contentMediaType: application/zip - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + type: string + format: binary + default: + description: An unexpected error response. content: application/json: schema: @@ -12577,8 +11173,7 @@ paths: /toolboxes: get: operationId: listToolboxes - summary: List toolboxes - description: Returns the toolboxes available in the current project. + description: List all toolboxes. parameters: - name: limit in: query @@ -12620,14 +11215,6 @@ 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 @@ -12661,28 +11248,18 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - Toolboxes - x-ms-foundry-meta: - conditional_previews: - - Toolboxes=V1Preview /toolboxes/{name}: get: operationId: getToolbox - summary: Retrieve a toolbox - description: Retrieves the specified toolbox and its current configuration. + description: Retrieve a toolbox. parameters: - name: name in: path @@ -12690,14 +11267,6 @@ 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 @@ -12712,37 +11281,19 @@ paths: application/json: schema: $ref: '#/components/schemas/ToolboxObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - Toolboxes - x-ms-foundry-meta: - conditional_previews: - - Toolboxes=V1Preview patch: operationId: updateToolbox - summary: Update a toolbox to point to a specific version - description: Updates the toolbox's default version pointer to the specified version. + description: Update a toolbox to point to a specific 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 @@ -12757,14 +11308,8 @@ paths: application/json: schema: $ref: '#/components/schemas/ToolboxObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -12777,13 +11322,9 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateToolboxRequest' - x-ms-foundry-meta: - conditional_previews: - - Toolboxes=V1Preview delete: operationId: deleteToolbox - summary: Delete a toolbox - description: Removes the specified toolbox along with all of its versions. + description: Delete a toolbox and all its versions. parameters: - name: name in: path @@ -12791,14 +11332,6 @@ 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 @@ -12809,28 +11342,18 @@ paths: 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 + default: + description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - Toolboxes - x-ms-foundry-meta: - conditional_previews: - - Toolboxes=V1Preview /toolboxes/{name}/versions: post: operationId: createToolboxVersion - summary: Create a new version of a toolbox - description: Creates a new toolbox version, provisioning the toolbox itself if it does not already exist. + description: Create a new version of a toolbox. If the toolbox does not exist, it will be created. parameters: - name: name in: path @@ -12839,14 +11362,6 @@ 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 @@ -12861,14 +11376,8 @@ paths: application/json: schema: $ref: '#/components/schemas/ToolboxVersionObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: @@ -12888,7 +11397,7 @@ paths: description: A human-readable description of the toolbox. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Arbitrary key-value metadata to associate with the toolbox. tools: @@ -12907,13 +11416,9 @@ paths: description: Policy configuration for this toolbox version. required: - tools - x-ms-foundry-meta: - conditional_previews: - - Toolboxes=V1Preview get: operationId: listToolboxVersions - summary: List toolbox versions - description: Returns the available versions for the specified toolbox. + description: List all versions of a toolbox. parameters: - name: name in: path @@ -12961,14 +11466,6 @@ 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 @@ -13002,28 +11499,18 @@ 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. - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. 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 - summary: Retrieve a specific version of a toolbox - description: Retrieves the specified version of a toolbox by name and version identifier. + description: Retrieve a specific version of a toolbox. parameters: - name: name in: path @@ -13037,14 +11524,6 @@ 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 @@ -13059,27 +11538,17 @@ paths: application/json: schema: $ref: '#/components/schemas/ToolboxVersionObject' - 4XX: - description: Client error - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorResponse' - 5XX: - description: Server error + default: + description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' tags: - Toolboxes - x-ms-foundry-meta: - conditional_previews: - - Toolboxes=V1Preview delete: operationId: deleteToolboxVersion - summary: Delete a specific version of a toolbox - description: Removes the specified version of a toolbox. + description: Delete a specific version of a toolbox. parameters: - name: name in: path @@ -13093,14 +11562,6 @@ 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 @@ -13111,23 +11572,14 @@ paths: 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 + default: + description: An unexpected error response. 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 @@ -13197,22 +11649,6 @@ 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 @@ -13221,23 +11657,6 @@ 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 @@ -13246,39 +11665,6 @@ 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 @@ -13610,14 +11996,12 @@ components: type: integer format: int32 description: The maximum number of replicas for the container. Default is 1. - examples: - - 10 + example: 10 min_replicas: type: integer format: int32 description: The minimum number of replicas for the container. Default is 1. - examples: - - 1 + example: 1 error_message: type: string description: The error message if the container failed to operate, if any. @@ -13901,7 +12285,7 @@ components: description: Identifier of the agent thread. This field is mandatory currently, but it will be optional in the future. evaluators: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/EvaluatorConfiguration' description: Evaluators to be used for the evaluation. samplingConfiguration: @@ -13955,7 +12339,7 @@ components: description: A string explaining why there was an error, if applicable. additionalDetails: type: object - unevaluatedProperties: + additionalProperties: type: string description: Additional properties relevant to the evaluator. These will differ between evaluators. description: Result for the agent evaluation evaluator run. @@ -14080,6 +12464,18 @@ 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: @@ -14177,7 +12573,6 @@ components: enum: - activity_protocol - responses - - a2a - mcp - invocations - invocations_ws @@ -14248,6 +12643,7 @@ components: - idle - updating - failed + - stopping - deleting - deleted - expired @@ -14311,11 +12707,10 @@ components: - definition properties: metadata: - anyOf: - - type: object - unevaluatedProperties: - type: string - - type: 'null' + type: object + additionalProperties: + type: string + 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 @@ -15217,7 +13612,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 - unevaluatedProperties: {} + additionalProperties: {} description: The parameters the functions accepts, described as a JSON Schema object. required: - name @@ -15721,6 +14116,116 @@ 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: @@ -15798,7 +14303,7 @@ components: description: List of clusters identified in the insights. coordinates: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ChartCoordinate' description: |2- Optional mapping of IDs to 2D coordinates used by the UX for visualization. @@ -15993,7 +14498,7 @@ components: readOnly: true metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Metadata of the connection readOnly: true @@ -16031,21 +14536,18 @@ components: items: $ref: '#/components/schemas/ProtocolVersionRecord' description: The protocols that the agent supports for ingress communication of the containers. - examples: - - - protocol: responses - version: v0.1.1 - - protocol: a2a - version: v0.3.0 + example: + - 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. - examples: - - --0000001 - - ---current - - '' + example: --0000001 allOf: - $ref: '#/components/schemas/AgentDefinition' description: The container app agent definition. @@ -16060,8 +14562,7 @@ components: image: type: string description: The container image for the hosted agent. - examples: - - my-registry.azurecr.io/my-hosted-agent:latest + example: my-registry.azurecr.io/my-hosted-agent:latest description: Container-based deployment configuration for a hosted agent. x-ms-foundry-meta: required_previews: @@ -16167,13 +14668,6 @@ 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. @@ -16203,7 +14697,7 @@ components: default: 5 data_mapping: type: object - unevaluatedProperties: + additionalProperties: type: string description: Mapping from source fields to response_id field, which is required for retrieving chat history. sampling_params: @@ -16266,6 +14760,8 @@ 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 @@ -16287,7 +14783,7 @@ components: - Must not exceed 63 characters. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -16306,7 +14802,7 @@ components: description: The manifest ID to import the agent version from. parameter_values: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The inputs to the manifest that will result in a fully materialized Agent. CreateAgentRequest: type: object @@ -16324,7 +14820,7 @@ components: - Must not exceed 63 characters. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -16399,6 +14895,8 @@ 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 @@ -16414,7 +14912,7 @@ components: description: A human-readable description of the agent. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -16444,7 +14942,7 @@ components: properties: metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -16463,7 +14961,7 @@ components: description: The manifest ID to import the agent version from. parameter_values: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The inputs to the manifest that will result in a fully materialized Agent. CreateAgentVersionRequest: type: object @@ -16472,7 +14970,7 @@ components: properties: metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -16519,9 +15017,10 @@ components: type: string description: The name of the evaluation. metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true data_source_config: oneOf: - $ref: '#/components/schemas/OpenAI.CreateEvalCustomDataSourceConfig' @@ -16543,7 +15042,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 - unevaluatedProperties: + additionalProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -16558,9 +15057,10 @@ components: type: string description: The name of the run. metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true data_source: oneOf: - $ref: '#/components/schemas/OpenAI.CreateEvalJsonlRunDataSource' @@ -16570,7 +15070,7 @@ components: description: Details about the run's data source. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -16603,7 +15103,9 @@ components: properties: files: type: array - items: {} + items: + type: string + format: binary description: Skill files to upload. Upload a single zip file or multiple individual files with relative paths. default: type: boolean @@ -16669,41 +15171,11 @@ components: - CustomKeys description: The credential type readOnly: true - unevaluatedProperties: + additionalProperties: 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: @@ -16851,7 +15323,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 - unevaluatedProperties: + additionalProperties: 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. @@ -16973,12 +15445,11 @@ components: description: The data source type discriminator. schema: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The overall object JSON schema for the run data source items. discriminator: propertyName: type - mapping: - azure_ai_source: '#/components/schemas/AzureAIDataSourceConfig' + mapping: {} description: Base class for run data sources with discriminator support. DatasetDataGenerationJobOutput: type: object @@ -17008,7 +15479,7 @@ components: readOnly: true tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary of the output dataset. readOnly: true @@ -17061,6 +15532,38 @@ 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: @@ -17138,7 +15641,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. discriminator: @@ -17403,7 +15906,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. The service defaults to `false` if a value is not specified by the caller. + 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`. default: false description: A single dimension — one independent, measurable quality dimension within a rubric evaluator's scoring blueprint. DispatchRoutineRequest: @@ -17527,9 +16030,10 @@ components: format: unixtime description: The Unix timestamp (in seconds) for when the eval was created. metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true modified_at: allOf: - $ref: '#/components/schemas/integer' @@ -17539,7 +16043,7 @@ components: description: the name of the person who created the run. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -17710,9 +16214,10 @@ components: - $ref: '#/components/schemas/EvalRunDataSource' description: Information about the run's data source. metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true error: $ref: '#/components/schemas/OpenAI.EvalApiError' modified_at: @@ -17724,7 +16229,7 @@ components: description: the name of the person who created the run. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -17983,7 +16488,7 @@ components: description: The identifier for the data source item. datasource_item: type: object - unevaluatedProperties: {} + additionalProperties: {} description: Details of the input data source item. results: type: array @@ -18073,10 +16578,9 @@ components: type: boolean description: Whether the grader considered the output a pass. sample: - anyOf: - - type: object - unevaluatedProperties: {} - - type: 'null' + type: object + additionalProperties: {} + nullable: true description: Optional sample or intermediate data produced by the grader. status: allOf: @@ -18097,10 +16601,10 @@ components: description: The reason for the test criteria metric. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Additional details about the test criteria metric. - unevaluatedProperties: {} + additionalProperties: {} description: A single grader result for an evaluation run output item. title: EvalRunOutputItemResult EvalRunOutputItemResultStatus: @@ -18252,17 +16756,17 @@ components: readOnly: true tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Evaluation's tags. Unlike properties, tags are fully mutable. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Evaluation's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. evaluators: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/EvaluatorConfiguration' description: Evaluators to be used for the evaluation. target: @@ -18413,7 +16917,7 @@ components: description: Indicates whether the evaluation rule is enabled. Default is true. systemData: type: object - unevaluatedProperties: + additionalProperties: type: string description: System metadata for the evaluation rule. readOnly: true @@ -18519,7 +17023,6 @@ components: description: Identifier of the evaluation group. evalRun: type: object - unevaluatedProperties: {} description: The evaluation run payload. allOf: - $ref: '#/components/schemas/ScheduleTask' @@ -18625,7 +17128,7 @@ components: default: quality initialization_parameters: type: object - unevaluatedProperties: {} + additionalProperties: {} description: |- Optional initialization parameters applied to all generated evaluators. For example, deployment_name for LLM judge model, default threshold. @@ -18900,7 +17403,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: |- @@ -18969,7 +17472,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: |- @@ -19027,7 +17530,7 @@ components: description: List of taxonomy categories. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Additional properties for the evaluation taxonomy. description: Evaluation Taxonomy Definition @@ -19041,7 +17544,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. taxonomyInput: @@ -19055,7 +17558,7 @@ components: description: List of taxonomy categories. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Additional properties for the evaluation taxonomy. description: Evaluation Taxonomy Definition @@ -19103,7 +17606,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. taxonomyInput: @@ -19117,7 +17620,7 @@ components: description: List of taxonomy categories. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Additional properties for the evaluation taxonomy. description: Evaluation Taxonomy Definition @@ -19140,11 +17643,11 @@ components: description: Identifier of the evaluator. initParams: type: object - unevaluatedProperties: {} + additionalProperties: {} description: Initialization parameters of the evaluator. dataMapping: type: object - unevaluatedProperties: + additionalProperties: type: string description: Data parameters of the evaluator. description: Evaluator Configuration @@ -19172,15 +17675,15 @@ components: description: The type of evaluator definition init_parameters: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The JSON schema (Draft 2020-12) for the evaluator's input parameters. This includes parameters like type, properties, required. data_schema: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The JSON schema (Draft 2020-12) for the evaluator's input data. This includes parameters like type, properties, required. metrics: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/EvaluatorMetric' description: List of output metrics produced by this evaluator discriminator: @@ -19417,7 +17920,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 - unevaluatedProperties: + additionalProperties: type: string description: Metadata about the evaluator evaluator_type: @@ -19429,13 +17932,6 @@ 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' @@ -19482,7 +17978,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 - unevaluatedProperties: + additionalProperties: type: string description: Metadata about the evaluator evaluator_type: @@ -19494,13 +17990,6 @@ 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' @@ -19510,7 +17999,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Evaluator Definition @@ -19522,7 +18011,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 - unevaluatedProperties: + additionalProperties: type: string description: Metadata about the evaluator categories: @@ -19530,19 +18019,12 @@ 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 - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Evaluator Definition @@ -19657,9 +18139,12 @@ 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: - - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' + - type: object + allOf: + - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' + nullable: true - type: string - - type: 'null' + nullable: true description: (Optional) Whether the agent requires approval before executing actions. Default is always. default: always name: @@ -19693,9 +18178,12 @@ 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: - - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' + - type: object + allOf: + - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' + nullable: true - type: string - - type: 'null' + nullable: true description: (Optional) Whether the agent requires approval before executing actions. Default is always. default: always allOf: @@ -19785,9 +18273,9 @@ components: - $ref: '#/components/schemas/OpenAI.RankingOptions' description: Ranking options for search. filters: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.Filters' - - type: 'null' + nullable: true vector_store_ids: type: array items: @@ -19923,50 +18411,34 @@ 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. - 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: + GitHubIssueOpenedRoutineTrigger: type: object required: - type - connection_id - - owner + - assignee - repository - - issue_event properties: type: type: string enum: - - github_issue + - github_issue_opened description: The trigger type. connection_id: type: string maxLength: 256 description: The workspace connection identifier that resolves the GitHub configuration for the trigger. - owner: + assignee: type: string maxLength: 128 - description: The GitHub owner or organization that scopes which issues can fire the trigger. + description: The GitHub assignee or organization filter 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 routine trigger. + description: A GitHub issue-opened routine trigger. x-ms-foundry-meta: conditional_previews: - Routines=V1Preview @@ -20000,18 +18472,15 @@ components: header_name: type: string description: The name of the HTTP header to inject the secret value into. - examples: - - X-Otlp-Api-Key + example: X-Otlp-Api-Key secret_id: type: string description: The identifier of the secret store or connection. - examples: - - my-secret-store + example: my-secret-store secret_key: type: string description: The key within the secret to retrieve the authentication value. - examples: - - OTLP_KEY + example: 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. @@ -20039,21 +18508,19 @@ components: cpu: type: string description: The CPU configuration for the hosted agent. - examples: - - '0.25' + example: '0.25' memory: type: string description: The memory configuration for the hosted agent. - examples: - - 0.5Gi + example: 0.5Gi environment_variables: type: object - unevaluatedProperties: + additionalProperties: type: string description: Environment variables to set in the hosted agent container. - examples: - - name: LOG_LEVEL - value: debug + example: + name: LOG_LEVEL + value: debug container_configuration: allOf: - $ref: '#/components/schemas/ContainerConfiguration' @@ -20066,11 +18533,11 @@ components: items: $ref: '#/components/schemas/ProtocolVersionRecord' description: The protocols that the agent supports for ingress communication. - examples: - - - protocol: responses - version: v0.1.1 - - protocol: a2a - version: v0.3.0 + example: + - protocol: responses + version: v0.1.1 + - protocol: a2a + version: v0.3.0 x-ms-foundry-meta: required_previews: - CodeAgents=V1Preview @@ -20189,7 +18656,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. discriminator: @@ -20362,11 +18829,11 @@ components: description: Sample type features: type: object - unevaluatedProperties: {} + additionalProperties: {} description: Features to help with additional filtering of data in UX. correlationInfo: type: object - unevaluatedProperties: {} + additionalProperties: {} description: Info about the correlation for the analysis sample. discriminator: propertyName: type @@ -20446,7 +18913,6 @@ components: type: object required: - type - - input properties: type: type: string @@ -20454,7 +18920,9 @@ components: - invoke_agent_invocations_api description: The manual dispatch payload type. input: - 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. + type: string + maxLength: 32768 + description: The raw input sent to the downstream invocations target. allOf: - $ref: '#/components/schemas/RoutineDispatchPayload' description: A manual payload used to test an invocations API routine dispatch. @@ -20465,29 +18933,24 @@ 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: 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. + description: The endpoint-scoped agent identifier for invocations API dispatch. 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. Exactly one of agent_name or agent_endpoint_id must be provided. + description: Dispatches a routine through the raw invocations API. x-ms-foundry-meta: conditional_previews: - Routines=V1Preview @@ -20495,7 +18958,6 @@ components: type: object required: - type - - input properties: type: type: string @@ -20503,7 +18965,9 @@ components: - invoke_agent_responses_api description: The manual dispatch payload type. input: - 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. + type: string + maxLength: 32768 + description: The user input sent to the downstream responses target. allOf: - $ref: '#/components/schemas/RoutineDispatchPayload' description: A manual payload used to test a responses API routine dispatch. @@ -20523,14 +18987,12 @@ components: agent_name: type: string maxLength: 256 - description: The project-scoped agent name for routine dispatch. + description: The project-scoped agent name for responses API dispatch. agent_endpoint_id: type: string maxLength: 256 - 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: + description: The endpoint-scoped agent identifier for responses API dispatch. + conversation_id: type: string maxLength: 256 description: An optional existing conversation identifier to continue during the downstream dispatch. @@ -20582,7 +19044,6 @@ 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: @@ -20681,30 +19142,32 @@ components: type: string description: Optional description of the MCP server, used to provide more context. headers: - anyOf: - - type: object - unevaluatedProperties: - type: string - - type: 'null' + type: object + additionalProperties: + type: string + nullable: true allowed_tools: anyOf: - type: array items: type: string - - $ref: '#/components/schemas/OpenAI.MCPToolFilter' - - type: 'null' + nullable: true + - type: object + allOf: + - $ref: '#/components/schemas/OpenAI.MCPToolFilter' + nullable: true require_approval: anyOf: - - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' + - type: object + allOf: + - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' + nullable: true - type: string enum: - always - never - - type: 'null' + nullable: true 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. @@ -21004,11 +19467,10 @@ components: - $ref: '#/components/schemas/ToolCallStatus' description: The status of the tool call. memories: - anyOf: - - type: array - items: - $ref: '#/components/schemas/MemoryItem' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/MemoryItem' + nullable: true description: The results returned from the memory search. allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' @@ -21060,7 +19522,7 @@ components: default: true procedural_memory_enabled: type: boolean - description: Whether to enable procedural memory extraction and storage. The service defaults to `true` if a value is not specified by the caller. + description: Whether to enable procedural memory extraction and storage. Defaults to `true`. default: true default_ttl_seconds: type: integer @@ -21160,7 +19622,7 @@ components: description: A human-readable description of the memory store. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Arbitrary key-value metadata to associate with the memory store. definition: @@ -21379,7 +19841,7 @@ components: readOnly: true capabilities: type: object - unevaluatedProperties: + additionalProperties: type: string description: Capabilities of deployed model readOnly: true @@ -21528,7 +19990,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Tag dictionary. Tags can be added, removed, and updated. description: Model Version Definition @@ -21670,6 +20132,7 @@ 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. @@ -21693,6 +20156,7 @@ components: - create_file description: The operation type. Always `create_file`. x-stainless-const: true + default: create_file path: type: string minLength: 1 @@ -21717,6 +20181,7 @@ 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. @@ -21736,6 +20201,7 @@ components: - delete_file description: The operation type. Always `delete_file`. x-stainless-const: true + default: delete_file path: type: string minLength: 1 @@ -21801,6 +20267,7 @@ 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. @@ -21818,6 +20285,7 @@ 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. @@ -21841,6 +20309,7 @@ components: - update_file description: The operation type. Always `update_file`. x-stainless-const: true + default: update_file path: type: string minLength: 1 @@ -21866,21 +20335,17 @@ components: x-stainless-const: true default: approximate country: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true region: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true city: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true timezone: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true OpenAI.AutoCodeInterpreterToolParam: type: object required: @@ -21900,9 +20365,9 @@ components: maxItems: 50 description: An optional list of uploaded files to make available to your code. memory_limit: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.ContainerMemoryLimit' - - type: 'null' + nullable: true 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. @@ -21926,12 +20391,6 @@ 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 @@ -22026,6 +20485,7 @@ 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' @@ -22038,12 +20498,6 @@ 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. @@ -22161,27 +20615,13 @@ components: - type: array items: $ref: '#/components/schemas/OpenAI.InputItem' - - type: 'null' + nullable: true previous_response_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true instructions: - 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' + type: string + nullable: true OpenAI.ComparisonFilter: type: object required: @@ -22198,8 +20638,6 @@ components: - gte - lt - lte - - in - - nin description: |- Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`. - `eq`: equals @@ -22271,14 +20709,6 @@ 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 @@ -22302,13 +20732,11 @@ components: type: string description: The ID of the pending safety check. code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true message: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true description: A pending safety check for the computer call. OpenAI.ComputerEnvironment: type: string @@ -22324,7 +20752,6 @@ components: - type - image_url - file_id - - detail properties: type: type: string @@ -22332,19 +20759,14 @@ 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: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true file_id: - 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`. + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.MessageContent' description: A screenshot of a computer. @@ -22371,21 +20793,6 @@ 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: @@ -22400,6 +20807,7 @@ 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' @@ -22427,6 +20835,7 @@ components: - container_auto description: Automatically creates a container for this request x-stainless-const: true + default: container_auto file_ids: type: array items: @@ -22434,9 +20843,9 @@ components: maxItems: 50 description: An optional list of uploaded files to make available to your code. memory_limit: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.ContainerMemoryLimit' - - type: 'null' + nullable: true skills: type: array items: @@ -22463,6 +20872,7 @@ 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. @@ -22503,12 +20913,19 @@ 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: @@ -22522,8 +20939,29 @@ 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: @@ -22556,6 +20994,7 @@ components: - container_reference description: The environment type. Always `container_reference`. x-stainless-const: true + default: container_reference container_id: type: string allOf: @@ -22590,9 +21029,10 @@ components: type: string description: The context management entry type. Currently only 'compaction' is supported. compact_threshold: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true OpenAI.ConversationItem: type: object required: @@ -22604,18 +21044,14 @@ components: propertyName: type mapping: message: '#/components/schemas/OpenAI.ConversationItemMessage' - function_call: '#/components/schemas/OpenAI.ConversationItemFunctionToolCall' - function_call_output: '#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutput' + function_call: '#/components/schemas/OpenAI.ConversationItemFunctionToolCallResource' + function_call_output: '#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutputResource' 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.ConversationItemComputerToolCallOutput' - tool_search_call: '#/components/schemas/OpenAI.ConversationItemToolSearchCall' - tool_search_output: '#/components/schemas/OpenAI.ConversationItemToolSearchOutput' - additional_tools: '#/components/schemas/OpenAI.ConversationItemAdditionalTools' + computer_call_output: '#/components/schemas/OpenAI.ConversationItemComputerToolCallOutputResource' 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' @@ -22627,39 +21063,10 @@ 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.ConversationItemCustomToolCallResource' - custom_tool_call_output: '#/components/schemas/OpenAI.ConversationItemCustomToolCallOutputResource' + custom_tool_call: '#/components/schemas/OpenAI.ConversationItemCustomToolCall' + custom_tool_call_output: '#/components/schemas/OpenAI.ConversationItemCustomToolCallOutput' 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: @@ -22724,9 +21131,8 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true created_by: type: string description: The ID of the entity that created this tool call output. @@ -22767,54 +21173,26 @@ components: type: string description: The ID of the container used to run the code. code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true outputs: - anyOf: - - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - - type: 'null' + type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + nullable: true 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: @@ -22832,8 +21210,6 @@ 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: @@ -22854,11 +21230,10 @@ 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.ConversationItemComputerToolCallOutput: + OpenAI.ConversationItemComputerToolCallOutputResource: type: object required: - type - - id - call_id - output properties: @@ -22872,7 +21247,6 @@ 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. @@ -22896,91 +21270,68 @@ components: `incomplete`. Populated when input items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - description: The output of a computer tool call. - title: Computer tool call output - OpenAI.ConversationItemCustomToolCallOutputResource: + OpenAI.ConversationItemCustomToolCall: type: object required: - type - call_id - - output - - status + - name + - input 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: |- - 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: + description: An identifier used to map this custom tool call to a tool call output. + name: type: string - description: The identifier of the actor that created the item. + description: The name of the custom tool being called. + input: + type: string + description: The input for the custom tool call generated by the model. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - title: ResponseCustomToolCallOutputItem - OpenAI.ConversationItemCustomToolCallResource: + description: A call to a custom tool created by the model. + title: Custom tool call + OpenAI.ConversationItemCustomToolCallOutput: type: object required: - type - call_id - - name - - input - - status + - output 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. - 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 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 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. + The output from the custom tool call generated by your code. + Can be a string or an list of output content. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - title: ResponseCustomToolCallItem + description: The output of a custom tool call from your code, being sent back to the model. + title: Custom tool call output OpenAI.ConversationItemFileSearchToolCall: type: object required: @@ -23015,11 +21366,10 @@ components: type: string description: The queries used to search for files. results: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: |- @@ -23055,12 +21405,13 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' + - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - - type: 'null' + nullable: true created_by: type: string description: The ID of the entity that created this tool call. @@ -23093,7 +21444,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -23101,9 +21452,10 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true created_by: type: string description: The identifier of the actor that created the item. @@ -23111,37 +21463,36 @@ components: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: The output of a shell tool call that was emitted. title: Shell call output - OpenAI.ConversationItemFunctionToolCall: + OpenAI.ConversationItemFunctionToolCallOutputResource: type: object required: - - id - type - call_id - - name - - arguments + - output properties: id: type: string - description: The unique ID of the function tool call. - readOnly: true + description: |- + The unique ID of the function tool call output. Populated when this item + is returned via API. 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. - 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. + 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: @@ -23153,42 +21504,32 @@ components: `incomplete`. Populated when items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' - 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: + OpenAI.ConversationItemFunctionToolCallResource: 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. - readOnly: true + description: The unique ID of the function tool call. 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. + 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: @@ -23200,8 +21541,6 @@ 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: @@ -23228,9 +21567,8 @@ components: - failed description: The status of the image generation call. result: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: An image generation request made by the model. @@ -23325,13 +21663,12 @@ components: 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' + type: string + enum: + - in_progress + - completed + - incomplete + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: The output of a local shell tool call. @@ -23391,9 +21728,8 @@ components: type: boolean description: Whether the request was approved. reason: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: A response to an MCP approval request. @@ -23424,7 +21760,8 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: A list of tools available on an MCP server. @@ -23457,20 +21794,18 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true error: type: object - unevaluatedProperties: {} + additionalProperties: {} 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: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ConversationItem' description: An invocation of a tool on an MCP server. @@ -23507,10 +21842,6 @@ 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. @@ -23532,9 +21863,8 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true summary: type: array items: @@ -23562,87 +21892,6 @@ 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 @@ -23656,11 +21905,7 @@ 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 @@ -23796,7 +22041,6 @@ 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 @@ -23852,15 +22096,15 @@ components: type: object properties: metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true items: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.InputItem' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.InputItem' + nullable: true OpenAI.CreateEvalCompletionsRunDataSource: type: object required: @@ -23981,7 +22225,7 @@ components: default: custom item_schema: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The json schema for each row in the data source. include_sample_schema: type: boolean @@ -24053,7 +22297,7 @@ components: default: logs metadata: type: object - unevaluatedProperties: {} + additionalProperties: {} description: Metadata filters for the logs data source. description: |- A data source config which specifies the metadata property of your logs query. @@ -24198,7 +22442,7 @@ components: default: stored_completions metadata: type: object - unevaluatedProperties: {} + additionalProperties: {} description: Metadata filters for the stored completions data source. description: Deprecated in favor of LogsDataSourceConfig. title: StoredCompletionsDataSourceConfig @@ -24248,18 +22492,16 @@ components: This value is now deprecated in favor of `method`, and should be passed in under the `method` parameter. deprecated: true suffix: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true 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: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true description: |- The ID of an uploaded file that contains validation data. If you provide this file, the data is used to generate validation @@ -24269,16 +22511,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: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.CreateFineTuningJobRequestIntegrations' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.CreateFineTuningJobRequestIntegrations' + nullable: true description: A list of integrations to enable for your fine-tuning job. seed: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true minimum: 0 maximum: 2147483647 description: |- @@ -24287,9 +22529,10 @@ components: method: $ref: '#/components/schemas/OpenAI.FineTuneMethod' metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true OpenAI.CreateFineTuningJobRequestHyperparameters: type: object properties: @@ -24335,13 +22578,11 @@ components: project: type: string name: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true entity: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true tags: type: array items: @@ -24414,6 +22655,7 @@ components: - grammar description: Grammar format. Always `grammar`. x-stainless-const: true + default: grammar syntax: allOf: - $ref: '#/components/schemas/OpenAI.GrammarSyntax1' @@ -24436,6 +22678,7 @@ 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. @@ -24452,6 +22695,7 @@ 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. @@ -24462,9 +22706,6 @@ 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) @@ -24512,14 +22753,12 @@ components: - low - high - auto - - original OpenAI.DoubleClickAction: type: object required: - type - x - 'y' - - keys properties: type: type: string @@ -24527,6 +22766,7 @@ 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' @@ -24535,12 +22775,6 @@ 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. @@ -24557,6 +22791,7 @@ 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: @@ -24569,12 +22804,6 @@ components: { x: 200, y: 300 } ] ``` - keys: - anyOf: - - type: array - items: - type: string - - type: 'null' allOf: - $ref: '#/components/schemas/OpenAI.ComputerAction' description: A drag action. @@ -24603,10 +22832,6 @@ 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: @@ -24631,8 +22856,6 @@ 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: @@ -24640,15 +22863,13 @@ components: - message properties: code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true message: type: string param: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true type: type: string details: @@ -24657,10 +22878,10 @@ components: $ref: '#/components/schemas/OpenAI.Error' additionalInfo: type: object - unevaluatedProperties: {} + additionalProperties: {} debugInfo: type: object - unevaluatedProperties: {} + additionalProperties: {} OpenAI.EvalApiError: type: object required: @@ -24790,22 +23011,26 @@ components: type: object properties: seed: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true top_p: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true default: 1 temperature: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true max_completions_tokens: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true reasoning_effort: $ref: '#/components/schemas/OpenAI.ReasoningEffort' OpenAI.EvalGraderStringCheck: @@ -25058,10 +23283,10 @@ components: properties: item: type: object - unevaluatedProperties: {} + additionalProperties: {} sample: type: object - unevaluatedProperties: {} + additionalProperties: {} OpenAI.EvalJsonlFileIdSource: type: object required: @@ -25090,50 +23315,49 @@ components: - responses description: The type of run data source. Always `responses`. metadata: - anyOf: - - type: object - unevaluatedProperties: {} - - type: 'null' + type: object + additionalProperties: {} + nullable: true model: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true instructions_search: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true created_after: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true created_before: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true reasoning_effort: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.ReasoningEffort' - - type: 'null' + nullable: true temperature: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true top_p: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true users: - anyOf: - - type: array - items: - type: string - - type: 'null' + type: array + items: + type: string + nullable: true tools: - anyOf: - - type: array - items: - type: string - - type: 'null' + type: array + items: + type: string + nullable: true description: A EvalResponsesSource object describing a run data source configuration. title: EvalResponsesSource x-oaiMeta: @@ -25279,25 +23503,28 @@ components: x-stainless-const: true default: stored_completions metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true model: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true created_after: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true created_before: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true limit: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true description: A StoredCompletionsRunDataSource configuration describing a set of filters title: StoredCompletionsRunDataSource x-oaiMeta: @@ -25326,6 +23553,7 @@ 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. @@ -25340,11 +23568,6 @@ 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: @@ -25381,6 +23604,7 @@ 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: @@ -25395,9 +23619,9 @@ components: - $ref: '#/components/schemas/OpenAI.RankingOptions' description: Ranking options for search. filters: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.Filters' - - type: 'null' + nullable: true name: type: string description: Optional user-defined name for this tool or configuration. @@ -25418,9 +23642,10 @@ components: filename: type: string attributes: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.VectorStoreFileAttributes' - - type: 'null' + nullable: true score: type: number format: float @@ -25628,13 +23853,11 @@ components: project: type: string name: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true entity: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true tags: type: array items: @@ -25666,20 +23889,17 @@ components: format: unixtime description: The Unix timestamp (in seconds) for when the fine-tuning job was created. error: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FineTuningJobError' - - type: 'null' + nullable: true fine_tuned_model: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true finished_at: - anyOf: - - type: string - format: date-time - - type: 'null' type: integer - format: unixTimestamp + format: unixtime + nullable: true hyperparameters: allOf: - $ref: '#/components/schemas/OpenAI.FineTuningJobHyperparameters' @@ -25712,39 +23932,36 @@ 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: - anyOf: + type: integer + allOf: - $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: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true integrations: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.FineTuningIntegration' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.FineTuningIntegration' + nullable: true 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: unixTimestamp + format: unixtime + nullable: true method: $ref: '#/components/schemas/OpenAI.FineTuneMethod' metadata: - anyOf: + type: object + allOf: - $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. title: FineTuningJob x-oaiMeta: @@ -25876,9 +24093,8 @@ components: message: type: string param: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true OpenAI.FineTuningJobEvent: type: object required: @@ -25944,8 +24160,11 @@ components: - type: string enum: - auto - - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true + - type: integer + allOf: + - $ref: '#/components/schemas/OpenAI.integer' + nullable: true default: auto learning_rate_multiplier: oneOf: @@ -25987,23 +24206,18 @@ components: x-stainless-const: true default: input_file file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true 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. - 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`. + file_data: + type: string + description: The content of the file to be sent to the model. allOf: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' description: A file input to the model. @@ -26022,18 +24236,16 @@ components: x-stainless-const: true default: input_image image_url: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. allOf: - $ref: '#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput' description: An image input to the model. Learn about [image inputs](/docs/guides/vision). @@ -26072,18 +24284,6 @@ 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: @@ -26098,12 +24298,11 @@ components: parameters: $ref: '#/components/schemas/OpenAI.FunctionParameters' strict: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true OpenAI.FunctionParameters: type: object - unevaluatedProperties: {} + additionalProperties: {} 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. @@ -26119,13 +24318,15 @@ components: items: type: string timeout_ms: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true description: Execute a shell command. title: Shell exec action OpenAI.FunctionShellActionParam: @@ -26139,13 +24340,15 @@ components: type: string description: Ordered shell commands for the execution environment to run. timeout_ms: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true description: Commands and limits describing how to run the shell tool call. title: Shell action OpenAI.FunctionShellCallEnvironment: @@ -26289,6 +24492,7 @@ components: - exit description: The outcome type. Always `exit`. x-stainless-const: true + default: exit exit_code: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -26309,6 +24513,7 @@ components: - exit description: The outcome type. Always `exit`. x-stainless-const: true + default: exit exit_code: allOf: - $ref: '#/components/schemas/OpenAI.integer' @@ -26359,12 +24564,6 @@ components: enum: - timeout - exit - OpenAI.FunctionShellCallOutputStatusEnum: - type: string - enum: - - in_progress - - completed - - incomplete OpenAI.FunctionShellCallOutputTimeoutOutcome: type: object required: @@ -26376,6 +24575,7 @@ 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. @@ -26391,16 +24591,11 @@ 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: @@ -26412,10 +24607,12 @@ components: - shell description: The type of the shell tool. Always `shell`. x-stainless-const: true + default: shell environment: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellToolParamEnvironment' - - type: 'null' + nullable: true name: type: string description: Optional user-defined name for this tool or configuration. @@ -26499,61 +24696,67 @@ 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: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true parameters: - anyOf: - - type: object - unevaluatedProperties: {} - - type: 'null' + type: object + additionalProperties: {} + nullable: true strict: - anyOf: - - type: boolean - - type: 'null' - defer_loading: type: boolean - description: Whether this function is deferred and loaded via tool search. + nullable: true 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.FunctionToolParam: + OpenAI.FunctionToolCallOutput: type: object required: - - name - type + - call_id + - output properties: - name: + id: type: string - 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' + description: |- + The unique ID of the function tool call output. Populated when this item + is returned via API. type: type: string enum: - - function + - function_call_output + description: The type of the function tool call output. Always `function_call_output`. x-stainless-const: true - default: function - defer_loading: - type: boolean - description: Whether this function should be deferred and discovered via tool search. + 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.GraderLabelModel: type: object required: @@ -26930,7 +25133,6 @@ components: - low - high - auto - - original OpenAI.ImageGenActionEnum: type: string enum: @@ -26948,6 +25150,7 @@ 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 @@ -26969,15 +25172,15 @@ components: or `auto`. Default: `auto`. default: auto size: - 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`. + type: string + enum: + - 1024x1024 + - 1024x1536 + - 1536x1024 + - auto + description: |- + The size of the generated image. One of `1024x1024`, `1024x1536`, + `1536x1024`, or `auto`. Default: `auto`. default: auto output_format: type: string @@ -27014,9 +25217,9 @@ components: `opaque`, or `auto`. Default: `auto`. default: auto input_fidelity: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.InputFidelity' - - type: 'null' + nullable: true input_image_mask: allOf: - $ref: '#/components/schemas/OpenAI.ImageGenToolInputImageMask' @@ -27067,7 +25270,6 @@ 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. @@ -27089,6 +25291,7 @@ 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. @@ -27185,23 +25388,18 @@ components: x-stainless-const: true default: input_file file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true 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. - 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`. + file_data: + type: string + description: The content of the file to be sent to the model. allOf: - $ref: '#/components/schemas/OpenAI.InputContent' description: A file input to the model. @@ -27220,18 +25418,16 @@ components: x-stainless-const: true default: input_image image_url: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. allOf: - $ref: '#/components/schemas/OpenAI.InputContent' description: An image input to the model. Learn about [image inputs](/docs/guides/vision). @@ -27283,23 +25479,18 @@ components: x-stainless-const: true default: input_file file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true 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. - 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`. + file_data: + type: string + description: The content of the file to be sent to the model. description: A file input to the model. title: Input file OpenAI.InputFileContentParam: @@ -27315,26 +25506,18 @@ components: x-stainless-const: true default: input_file file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true filename: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true file_data: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true file_url: - 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`. + type: string + format: uri + nullable: true description: A file input to the model. title: Input file OpenAI.InputImageContent: @@ -27351,18 +25534,16 @@ components: x-stainless-const: true default: input_image image_url: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. description: An image input to the model. Learn about [image inputs](/docs/guides/vision). title: Input image OpenAI.InputImageContentParamAutoParam: @@ -27378,18 +25559,16 @@ components: x-stainless-const: true default: input_image image_url: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true detail: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.DetailEnum' - - type: 'null' + nullable: true description: An image input to the model. Learn about [image inputs](/docs/guides/vision) title: Input image OpenAI.InputItem: @@ -27411,9 +25590,6 @@ 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' @@ -27434,38 +25610,6 @@ 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: @@ -27482,9 +25626,8 @@ components: x-stainless-const: true default: apply_patch_call id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -27517,9 +25660,8 @@ components: x-stainless-const: true default: apply_patch_call_output id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -27530,9 +25672,8 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatusParam' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The streamed output emitted by an apply patch tool call. @@ -27570,17 +25711,15 @@ components: type: string description: The ID of the container used to run the code. code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true outputs: - anyOf: - - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - - type: 'null' + type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A tool call to run code. @@ -27592,9 +25731,8 @@ components: - encrypted_content properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true type: type: string enum: @@ -27618,9 +25756,8 @@ components: - output properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -27636,15 +25773,14 @@ components: output: $ref: '#/components/schemas/OpenAI.ComputerScreenshotImage' acknowledged_safety_checks: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' + nullable: true status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The output of a computer tool call. @@ -27655,6 +25791,7 @@ components: - type - id - call_id + - action - pending_safety_checks - status properties: @@ -27672,8 +25809,6 @@ 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: @@ -27714,9 +25849,6 @@ 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. @@ -27793,11 +25925,10 @@ components: type: string description: The queries used to search for files. results: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: |- @@ -27812,9 +25943,8 @@ components: - output properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -27838,9 +25968,9 @@ components: - $ref: '#/components/schemas/OpenAI.InputFileContentParam' description: Text, image, or file output of the function tool call. status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The output of a function tool call. @@ -27853,9 +25983,8 @@ components: - action properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -27873,13 +26002,14 @@ components: - $ref: '#/components/schemas/OpenAI.FunctionShellActionParam' description: The shell commands and limits that describe how to run the tool call. status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - - type: 'null' + nullable: true environment: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemParamEnvironment' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A tool representing a request to execute one or more shell commands. @@ -27892,9 +26022,8 @@ components: - output properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -27913,13 +26042,14 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContentParam' description: Captured chunks of stdout and stderr output, along with their associated outcomes. status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - - type: 'null' + nullable: true max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The streamed output items emitted by a shell tool call. @@ -27927,7 +26057,6 @@ components: OpenAI.InputItemFunctionToolCall: type: object required: - - id - type - call_id - name @@ -27936,7 +26065,6 @@ components: id: type: string description: The unique ID of the function tool call. - readOnly: true type: type: string enum: @@ -27946,9 +26074,6 @@ 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. @@ -27996,9 +26121,8 @@ components: - failed description: The status of the image generation call. result: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: An image generation request made by the model. @@ -28057,13 +26181,12 @@ components: 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' + type: string + enum: + - in_progress + - completed + - incomplete + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: The output of a local shell tool call. @@ -28113,9 +26236,8 @@ components: description: The type of the item. Always `mcp_approval_response`. x-stainless-const: true id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true approval_request_id: type: string description: The ID of the approval request being answered. @@ -28123,9 +26245,8 @@ components: type: boolean description: Whether the request was approved. reason: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A response to an MCP approval request. @@ -28156,7 +26277,8 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: A list of tools available on an MCP server. @@ -28189,20 +26311,18 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true error: type: object - unevaluatedProperties: {} + additionalProperties: {} 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: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.InputItem' description: An invocation of a tool on an MCP server. @@ -28236,10 +26356,6 @@ 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: @@ -28270,9 +26386,8 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true summary: type: array items: @@ -28300,77 +26415,6 @@ 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 @@ -28384,9 +26428,6 @@ components: - web_search_call - function_call - function_call_output - - tool_search_call - - tool_search_output - - additional_tools - reasoning - compaction - image_generation_call @@ -28443,6 +26484,44 @@ 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: @@ -28451,6 +26530,43 @@ 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 @@ -28512,7 +26628,7 @@ components: discriminator: propertyName: type mapping: - message: '#/components/schemas/OpenAI.ItemInputMessage' + message: '#/components/schemas/OpenAI.InputMessage' output_message: '#/components/schemas/OpenAI.ItemOutputMessage' file_search_call: '#/components/schemas/OpenAI.ItemFileSearchToolCall' computer_call: '#/components/schemas/OpenAI.ItemComputerToolCall' @@ -28520,9 +26636,6 @@ 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' @@ -28540,38 +26653,6 @@ 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: @@ -28588,9 +26669,8 @@ components: x-stainless-const: true default: apply_patch_call id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -28623,9 +26703,8 @@ components: x-stainless-const: true default: apply_patch_call_output id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -28636,9 +26715,8 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatusParam' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The streamed output emitted by an apply patch tool call. @@ -28676,17 +26754,15 @@ components: type: string description: The ID of the container used to run the code. code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true outputs: - anyOf: - - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - - type: 'null' + type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A tool call to run code. @@ -28698,9 +26774,8 @@ components: - encrypted_content properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true type: type: string enum: @@ -28724,9 +26799,8 @@ components: - output properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -28742,15 +26816,14 @@ components: output: $ref: '#/components/schemas/OpenAI.ComputerScreenshotImage' acknowledged_safety_checks: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.ComputerCallSafetyCheckParam' + nullable: true status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The output of a computer tool call. @@ -28761,6 +26834,7 @@ components: - type - id - call_id + - action - pending_safety_checks - status properties: @@ -28778,8 +26852,6 @@ 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: @@ -28820,9 +26892,6 @@ 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. @@ -28875,17 +26944,14 @@ 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.ItemFieldComputerToolCallOutput' + computer_call_output: '#/components/schemas/OpenAI.ItemFieldComputerToolCallOutputResource' reasoning: '#/components/schemas/OpenAI.ItemFieldReasoningItem' compaction: '#/components/schemas/OpenAI.ItemFieldCompactionBody' code_interpreter_call: '#/components/schemas/OpenAI.ItemFieldCodeInterpreterToolCall' @@ -28902,35 +26968,6 @@ 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: @@ -28995,9 +27032,8 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true created_by: type: string description: The ID of the entity that created this tool call output. @@ -29038,17 +27074,15 @@ components: type: string description: The ID of the container used to run the code. code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true outputs: - anyOf: - - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - - type: 'null' + type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A tool call to run code. @@ -29086,6 +27120,7 @@ components: - type - id - call_id + - action - pending_safety_checks - status properties: @@ -29103,8 +27138,6 @@ 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: @@ -29125,11 +27158,10 @@ 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.ItemFieldComputerToolCallOutput: + OpenAI.ItemFieldComputerToolCallOutputResource: type: object required: - type - - id - call_id - output properties: @@ -29143,7 +27175,6 @@ 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. @@ -29167,8 +27198,6 @@ 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: @@ -29189,9 +27218,6 @@ 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. @@ -29268,11 +27294,10 @@ components: type: string description: The queries used to search for files. results: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: |- @@ -29308,12 +27333,13 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' + - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - - type: 'null' + nullable: true created_by: type: string description: The ID of the entity that created this tool call. @@ -29346,7 +27372,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -29354,9 +27380,10 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true created_by: type: string description: The identifier of the actor that created the item. @@ -29367,7 +27394,6 @@ components: OpenAI.ItemFieldFunctionToolCall: type: object required: - - id - type - call_id - name @@ -29376,7 +27402,6 @@ components: id: type: string description: The unique ID of the function tool call. - readOnly: true type: type: string enum: @@ -29386,9 +27411,6 @@ 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. @@ -29410,51 +27432,6 @@ 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: @@ -29481,9 +27458,8 @@ components: - failed description: The status of the image generation call. result: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: An image generation request made by the model. @@ -29542,13 +27518,12 @@ components: 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' + type: string + enum: + - in_progress + - completed + - incomplete + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: The output of a local shell tool call. @@ -29608,9 +27583,8 @@ components: type: boolean description: Whether the request was approved. reason: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A response to an MCP approval request. @@ -29641,7 +27615,8 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: A list of tools available on an MCP server. @@ -29674,20 +27649,18 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true error: type: object - unevaluatedProperties: {} + additionalProperties: {} 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: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemField' description: An invocation of a tool on an MCP server. @@ -29724,10 +27697,6 @@ 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. @@ -29749,9 +27718,8 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true summary: type: array items: @@ -29779,87 +27747,6 @@ 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 @@ -29867,9 +27754,6 @@ components: enum: - message - function_call - - tool_search_call - - tool_search_output - - additional_tools - function_call_output - file_search_call - web_search_call @@ -29964,11 +27848,10 @@ components: type: string description: The queries used to search for files. results: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: |- @@ -29983,9 +27866,8 @@ components: - output properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -30009,9 +27891,9 @@ components: - $ref: '#/components/schemas/OpenAI.InputFileContentParam' description: Text, image, or file output of the function tool call. status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionCallItemStatus' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The output of a function tool call. @@ -30024,9 +27906,8 @@ components: - action properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -30044,13 +27925,14 @@ components: - $ref: '#/components/schemas/OpenAI.FunctionShellActionParam' description: The shell commands and limits that describe how to run the tool call. status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - - type: 'null' + nullable: true environment: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemParamEnvironment' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A tool representing a request to execute one or more shell commands. @@ -30063,9 +27945,8 @@ components: - output properties: id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true call_id: type: string minLength: 1 @@ -30084,13 +27965,14 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContentParam' description: Captured chunks of stdout and stderr output, along with their associated outcomes. status: - anyOf: + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallItemStatus' - - type: 'null' + nullable: true max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The streamed output items emitted by a shell tool call. @@ -30098,7 +27980,6 @@ components: OpenAI.ItemFunctionToolCall: type: object required: - - id - type - call_id - name @@ -30107,7 +27988,6 @@ components: id: type: string description: The unique ID of the function tool call. - readOnly: true type: type: string enum: @@ -30117,9 +27997,6 @@ 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. @@ -30167,57 +28044,12 @@ components: - failed description: The status of the image generation call. result: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true 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: @@ -30272,13 +28104,12 @@ components: 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' + type: string + enum: + - in_progress + - completed + - incomplete + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: The output of a local shell tool call. @@ -30328,9 +28159,8 @@ components: description: The type of the item. Always `mcp_approval_response`. x-stainless-const: true id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true approval_request_id: type: string description: The ID of the approval request being answered. @@ -30338,9 +28168,8 @@ components: type: boolean description: Whether the request was approved. reason: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A response to an MCP approval request. @@ -30371,7 +28200,8 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: A list of tools available on an MCP server. @@ -30404,20 +28234,18 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true error: type: object - unevaluatedProperties: {} + additionalProperties: {} 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: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.Item' description: An invocation of a tool on an MCP server. @@ -30451,10 +28279,6 @@ 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: @@ -30485,9 +28309,8 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true summary: type: array items: @@ -30527,6 +28350,7 @@ 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. @@ -30544,19 +28368,14 @@ components: discriminator: propertyName: type mapping: - message: '#/components/schemas/OpenAI.ItemResourceInputMessage' + message: '#/components/schemas/OpenAI.InputMessageResource' 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.ItemResourceComputerToolCallOutput' + computer_call_output: '#/components/schemas/OpenAI.ItemResourceComputerToolCallOutputResource' web_search_call: '#/components/schemas/OpenAI.ItemResourceWebSearchToolCall' - 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' + function_call: '#/components/schemas/OpenAI.ItemResourceFunctionToolCallResource' + function_call_output: '#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutputResource' image_generation_call: '#/components/schemas/OpenAI.ItemResourceImageGenToolCall' code_interpreter_call: '#/components/schemas/OpenAI.ItemResourceCodeInterpreterToolCall' local_shell_call: '#/components/schemas/OpenAI.ItemResourceLocalShellToolCall' @@ -30569,38 +28388,7 @@ 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: @@ -30665,9 +28453,8 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true created_by: type: string description: The ID of the entity that created this tool call output. @@ -30708,54 +28495,26 @@ components: type: string description: The ID of the container used to run the code. code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true outputs: - anyOf: - - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - - type: 'null' + type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + nullable: true 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: @@ -30773,8 +28532,6 @@ 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: @@ -30795,11 +28552,10 @@ 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.ItemResourceComputerToolCallOutput: + OpenAI.ItemResourceComputerToolCallOutputResource: type: object required: - type - - id - call_id - output properties: @@ -30813,7 +28569,6 @@ 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. @@ -30837,91 +28592,6 @@ 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: @@ -30956,11 +28626,10 @@ components: type: string description: The queries used to search for files. results: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: |- @@ -30996,12 +28665,13 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' + - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - - type: 'null' + nullable: true created_by: type: string description: The ID of the entity that created this tool call. @@ -31034,7 +28704,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -31042,9 +28712,10 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true created_by: type: string description: The identifier of the actor that created the item. @@ -31052,37 +28723,36 @@ components: - $ref: '#/components/schemas/OpenAI.ItemResource' description: The output of a shell tool call that was emitted. title: Shell call output - OpenAI.ItemResourceFunctionToolCall: + OpenAI.ItemResourceFunctionToolCallOutputResource: type: object required: - - id - type - call_id - - name - - arguments + - output properties: id: type: string - description: The unique ID of the function tool call. - readOnly: true + description: |- + The unique ID of the function tool call output. Populated when this item + is returned via API. 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. - 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. + 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: @@ -31094,42 +28764,32 @@ components: `incomplete`. Populated when items are returned via API. allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' - 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: + OpenAI.ItemResourceFunctionToolCallResource: 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. - readOnly: true + description: The unique ID of the function tool call. 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. + 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: @@ -31141,8 +28801,6 @@ 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: @@ -31169,57 +28827,12 @@ components: - failed description: The status of the image generation call. result: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true 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: @@ -31274,13 +28887,12 @@ components: 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' + type: string + enum: + - in_progress + - completed + - incomplete + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: The output of a local shell tool call. @@ -31340,9 +28952,8 @@ components: type: boolean description: Whether the request was approved. reason: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: A response to an MCP approval request. @@ -31373,7 +28984,8 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: A list of tools available on an MCP server. @@ -31406,20 +29018,18 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true error: type: object - unevaluatedProperties: {} + additionalProperties: {} 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: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ItemResource' description: An invocation of a tool on an MCP server. @@ -31453,10 +29063,6 @@ 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: @@ -31470,134 +29076,6 @@ 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 @@ -31611,11 +29089,6 @@ 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 @@ -31628,8 +29101,6 @@ components: - mcp_approval_request - mcp_approval_response - mcp_call - - custom_tool_call - - custom_tool_call_output - structured_outputs - oauth_consent_request - memory_search_call @@ -31693,77 +29164,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.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 @@ -31777,9 +29177,6 @@ components: - web_search_call - function_call - function_call_output - - tool_search_call - - tool_search_output - - additional_tools - reasoning - compaction - image_generation_call @@ -31871,6 +29268,7 @@ 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: @@ -31898,13 +29296,11 @@ components: - list x-stainless-const: true first_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true last_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true x-ms-list-continuation-token: true has_more: type: boolean @@ -31957,10 +29353,23 @@ 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: @@ -31981,23 +29390,22 @@ components: type: string description: The command to run. timeout_ms: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true working_directory: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true env: type: object - unevaluatedProperties: + additionalProperties: type: string description: Environment variables to set for the command. x-oaiTypeLabel: map user: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true description: Execute a shell command on the server. title: Local shell exec action OpenAI.LocalShellToolParam: @@ -32011,6 +29419,7 @@ 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. @@ -32069,17 +29478,17 @@ components: type: string description: The name of the tool. description: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true input_schema: allOf: - $ref: '#/components/schemas/OpenAI.MCPListToolsToolInputSchema' description: The JSON schema describing the tool's input. annotations: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.MCPListToolsToolAnnotations' - - type: 'null' + nullable: true description: A tool available on an MCP server. title: MCP list tools tool OpenAI.MCPListToolsToolAnnotations: @@ -32141,30 +29550,32 @@ components: type: string description: Optional description of the MCP server, used to provide more context. headers: - anyOf: - - type: object - unevaluatedProperties: - type: string - - type: 'null' + type: object + additionalProperties: + type: string + nullable: true allowed_tools: anyOf: - type: array items: type: string - - $ref: '#/components/schemas/OpenAI.MCPToolFilter' - - type: 'null' + nullable: true + - type: object + allOf: + - $ref: '#/components/schemas/OpenAI.MCPToolFilter' + nullable: true require_approval: anyOf: - - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' + - type: object + allOf: + - $ref: '#/components/schemas/OpenAI.MCPToolRequireApproval' + nullable: true - type: string enum: - always - never - - type: 'null' + nullable: true 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. @@ -32224,7 +29635,6 @@ 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 @@ -32239,23 +29649,18 @@ components: x-stainless-const: true default: input_file file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true 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. - 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`. + file_data: + type: string + description: The content of the file to be sent to the model. allOf: - $ref: '#/components/schemas/OpenAI.MessageContent' description: A file input to the model. @@ -32274,18 +29679,16 @@ components: x-stainless-const: true default: input_image image_url: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true file_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true detail: allOf: - $ref: '#/components/schemas/OpenAI.ImageDetail' - description: The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + description: The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`. allOf: - $ref: '#/components/schemas/OpenAI.MessageContent' description: An image input to the model. Learn about [image inputs](/docs/guides/vision). @@ -32395,15 +29798,6 @@ 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: @@ -32423,7 +29817,7 @@ components: - incomplete OpenAI.Metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -32434,9 +29828,13 @@ components: x-oaiTypeLabel: map OpenAI.ModelIdsCompaction: anyOf: - - $ref: '#/components/schemas/OpenAI.ModelIdsResponses' + - 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 - 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. + nullable: true 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: @@ -32461,125 +29859,6 @@ 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: @@ -32593,6 +29872,7 @@ 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' @@ -32601,50 +29881,10 @@ 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: @@ -32786,19 +30026,13 @@ 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' @@ -32806,38 +30040,7 @@ components: mcp_call: '#/components/schemas/OpenAI.OutputItemMcpToolCall' mcp_list_tools: '#/components/schemas/OpenAI.OutputItemMcpListTools' mcp_approval_request: '#/components/schemas/OpenAI.OutputItemMcpApprovalRequest' - 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' + custom_tool_call: '#/components/schemas/OpenAI.OutputItemCustomToolCall' OpenAI.OutputItemApplyPatchToolCall: type: object required: @@ -32902,9 +30105,8 @@ components: - $ref: '#/components/schemas/OpenAI.ApplyPatchCallOutputStatus' description: The status of the apply patch tool call output. One of `completed` or `failed`. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true created_by: type: string description: The ID of the entity that created this tool call output. @@ -32945,17 +30147,15 @@ components: type: string description: The ID of the container used to run the code. code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true outputs: - anyOf: - - type: array - items: - anyOf: - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' - - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' - - type: 'null' + type: array + items: + anyOf: + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputLogs' + - $ref: '#/components/schemas/OpenAI.CodeInterpreterOutputImage' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: A tool call to run code. @@ -32993,6 +30193,7 @@ components: - type - id - call_id + - action - pending_safety_checks - status properties: @@ -33010,8 +30211,6 @@ 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: @@ -33032,99 +30231,13 @@ 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.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: + OpenAI.OutputItemCustomToolCall: type: object required: - type - call_id - name - input - - status properties: type: type: string @@ -33138,27 +30251,16 @@ 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' - title: ResponseCustomToolCallItem + description: A call to a custom tool created by the model. + title: Custom tool call OpenAI.OutputItemFileSearchToolCall: type: object required: @@ -33193,11 +30295,10 @@ components: type: string description: The queries used to search for files. results: - anyOf: - - type: array - items: - $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' - - type: 'null' + type: array + items: + $ref: '#/components/schemas/OpenAI.FileSearchToolCallResults' + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: |- @@ -33233,12 +30334,13 @@ components: description: The shell commands and limits that describe how to run the tool call. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallStatus' + - $ref: '#/components/schemas/OpenAI.LocalShellCallStatus' description: The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. environment: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.FunctionShellCallEnvironment' - - type: 'null' + nullable: true created_by: type: string description: The ID of the entity that created this tool call. @@ -33271,7 +30373,7 @@ components: description: The unique ID of the shell tool call generated by the model. status: allOf: - - $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum' + - $ref: '#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum' description: The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. output: type: array @@ -33279,9 +30381,10 @@ components: $ref: '#/components/schemas/OpenAI.FunctionShellCallOutputContent' description: An array of shell call output contents max_output_length: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true created_by: type: string description: The identifier of the actor that created the item. @@ -33292,7 +30395,6 @@ components: OpenAI.OutputItemFunctionToolCall: type: object required: - - id - type - call_id - name @@ -33301,7 +30403,6 @@ components: id: type: string description: The unique ID of the function tool call. - readOnly: true type: type: string enum: @@ -33311,9 +30412,6 @@ 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. @@ -33335,51 +30433,6 @@ 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: @@ -33406,9 +30459,8 @@ components: - failed description: The status of the image generation call. result: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: An image generation request made by the model. @@ -33447,37 +30499,6 @@ 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: @@ -33509,37 +30530,6 @@ 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: @@ -33566,7 +30556,8 @@ components: $ref: '#/components/schemas/OpenAI.MCPListToolsTool' description: The tools available on the server. error: - $ref: '#/components/schemas/OpenAI.RealtimeMCPError' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: A list of tools available on an MCP server. @@ -33599,20 +30590,18 @@ components: type: string description: A JSON string of the arguments passed to the tool. output: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true error: type: object - unevaluatedProperties: {} + additionalProperties: {} 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: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.OutputItem' description: An invocation of a tool on an MCP server. @@ -33646,10 +30635,6 @@ 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: @@ -33680,9 +30665,8 @@ components: type: string description: The unique identifier of the reasoning content. encrypted_content: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true summary: type: array items: @@ -33710,87 +30694,6 @@ 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 @@ -33799,19 +30702,13 @@ 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 @@ -33819,9 +30716,7 @@ 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 @@ -33964,21 +30859,16 @@ components: type: string description: The unique identifier of the prompt template to use. version: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true variables: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.ResponsePromptVariables' - - type: 'null' + nullable: true 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: @@ -33999,118 +30889,39 @@ 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: - anyOf: - - type: string - enum: - - auto - - concise - - detailed - - type: 'null' + type: string + enum: + - auto + - concise + - detailed + nullable: true generate_summary: - anyOf: - - type: string - enum: - - auto - - concise - - detailed - - type: 'null' + type: string + enum: + - auto + - concise + - detailed + nullable: true description: |- **gpt-5 and o-series models only** Configuration options for [reasoning models](https://platform.openai.com/docs/guides/reasoning). title: Reasoning OpenAI.ReasoningEffort: - anyOf: - - type: string - enum: - - none - - minimal - - low - - medium - - high - - xhigh - - type: 'null' + type: string + enum: + - none + - minimal + - low + - medium + - high + - xhigh description: |- Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). @@ -34121,6 +30932,7 @@ 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: @@ -34153,22 +30965,26 @@ components: - agent_reference properties: metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true top_logprobs: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true temperature: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true default: 1 top_p: - anyOf: + type: number + allOf: - $ref: '#/components/schemas/OpenAI.numeric' - - type: 'null' + nullable: true default: 1 user: type: string @@ -34179,41 +30995,44 @@ 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, 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). + 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: - anyOf: - - type: string - enum: - - in_memory - - 24h - - type: 'null' + type: string + enum: + - in-memory + - 24h + nullable: true previous_response_id: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true model: type: string description: The model deployment to use for the creation of this response. reasoning: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Reasoning' - - type: 'null' + nullable: true background: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true + max_output_tokens: + type: integer + allOf: + - $ref: '#/components/schemas/OpenAI.integer' + nullable: true max_tool_calls: - anyOf: + type: integer + allOf: - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true text: $ref: '#/components/schemas/OpenAI.ResponseTextParam' tools: @@ -34225,12 +31044,11 @@ components: prompt: $ref: '#/components/schemas/OpenAI.Prompt' truncation: - anyOf: - - type: string - enum: - - auto - - disabled - - type: 'null' + type: string + enum: + - auto + - disabled + nullable: true default: disabled id: type: string @@ -34258,20 +31076,19 @@ 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: unixTimestamp + format: unixtime + nullable: true error: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.ResponseError' - - type: 'null' + nullable: true incomplete_details: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.ResponseIncompleteDetails' - - type: 'null' + nullable: true output: type: array items: @@ -34290,29 +31107,21 @@ components: - type: array items: $ref: '#/components/schemas/OpenAI.InputItem' - - type: 'null' + nullable: true output_text: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true 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: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.ConversationReference' - - type: 'null' - max_output_tokens: - anyOf: - - $ref: '#/components/schemas/OpenAI.integer' - - type: 'null' + nullable: true agent: allOf: - $ref: '#/components/schemas/AgentId' @@ -34327,9 +31136,10 @@ components: or an auto-generated UUID. Use for session-scoped operations and to maintain sandbox affinity in follow-up calls. agent_reference: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/AgentReference' - - type: 'null' + nullable: true description: The agent used for this response content_filters: type: array @@ -34356,10 +31166,8 @@ components: description: A sequence number for this chunk of the stream response. delta: type: string - contentEncoding: base64 + format: 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 @@ -34387,8 +31195,6 @@ 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 @@ -34419,8 +31225,6 @@ 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 @@ -34448,8 +31252,6 @@ 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 @@ -34489,8 +31291,6 @@ 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 @@ -34532,8 +31332,6 @@ 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 @@ -34571,8 +31369,6 @@ 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 @@ -34609,8 +31405,6 @@ 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 @@ -34647,8 +31441,6 @@ 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 @@ -34681,8 +31473,6 @@ 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 @@ -34777,8 +31567,6 @@ 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 @@ -34831,8 +31619,6 @@ 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 @@ -34871,8 +31657,6 @@ 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 @@ -34944,8 +31728,6 @@ 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: @@ -34987,8 +31769,6 @@ 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: @@ -35051,22 +31831,18 @@ components: description: The type of the event. Always `error`. x-stainless-const: true code: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true message: type: string description: The error message. param: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true 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 @@ -35100,8 +31876,6 @@ 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 @@ -35167,8 +31941,6 @@ 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 @@ -35205,8 +31977,6 @@ 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 @@ -35243,8 +32013,6 @@ 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 @@ -35308,12 +32076,11 @@ components: schema: $ref: '#/components/schemas/OpenAI.ResponseFormatJsonSchemaSchema' strict: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true OpenAI.ResponseFormatJsonSchemaSchema: type: object - unevaluatedProperties: {} + additionalProperties: {} description: |- The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/). @@ -35360,8 +32127,6 @@ 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 @@ -35406,8 +32171,6 @@ 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 @@ -35446,8 +32209,6 @@ 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: @@ -35485,8 +32246,6 @@ 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: @@ -35524,8 +32283,6 @@ 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: @@ -35572,8 +32329,6 @@ 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: @@ -35609,8 +32364,6 @@ 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 @@ -35682,8 +32435,6 @@ 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 @@ -35741,7 +32492,7 @@ components: type: array items: $ref: '#/components/schemas/OpenAI.ResponseLogProbTopLogprobs' - description: The log probabilities of up to 20 of the most likely tokens. + description: The log probability of the top 20 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) @@ -35782,8 +32533,6 @@ 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: @@ -35826,8 +32575,6 @@ 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: @@ -35866,8 +32613,6 @@ 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: @@ -35905,8 +32650,6 @@ 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: @@ -35944,8 +32687,6 @@ 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: @@ -35983,8 +32724,6 @@ 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: @@ -36022,8 +32761,6 @@ 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: @@ -36061,8 +32798,6 @@ 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: @@ -36101,8 +32836,6 @@ 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 @@ -36146,8 +32879,6 @@ 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 @@ -36211,8 +32942,6 @@ 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: @@ -36235,7 +32964,7 @@ components: } OpenAI.ResponsePromptVariables: type: object - unevaluatedProperties: + additionalProperties: anyOf: - type: string - $ref: '#/components/schemas/OpenAI.InputTextContent' @@ -36269,8 +32998,6 @@ 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: @@ -36322,8 +33049,6 @@ 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 @@ -36388,8 +33113,6 @@ 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 @@ -36455,8 +33178,6 @@ 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 @@ -36506,8 +33227,6 @@ 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 @@ -36557,8 +33276,6 @@ 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 @@ -36606,8 +33323,6 @@ 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 @@ -36655,8 +33370,6 @@ 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 @@ -36704,8 +33417,6 @@ 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 @@ -36719,127 +33430,6 @@ 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: @@ -36894,8 +33484,6 @@ 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 @@ -36949,8 +33537,6 @@ 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 @@ -37047,8 +33633,6 @@ 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 @@ -37085,8 +33669,6 @@ 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 @@ -37123,8 +33705,6 @@ 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 @@ -37147,6 +33727,7 @@ 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. @@ -37166,6 +33747,7 @@ 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' @@ -37182,21 +33764,10 @@ 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: @@ -37204,15 +33775,13 @@ components: - medium - high OpenAI.ServiceTier: - anyOf: - - type: string - enum: - - auto - - default - - flex - - scale - - priority - - type: 'null' + type: string + enum: + - auto + - default + - flex + - scale + - priority 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'. @@ -37220,13 +33789,7 @@ 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. - OpenAI.ServiceTierEnum: - type: string - enum: - - auto - - default - - flex - - priority + nullable: true OpenAI.SkillReferenceParam: type: object required: @@ -37239,6 +33802,7 @@ 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 @@ -37260,6 +33824,7 @@ 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. @@ -37275,6 +33840,7 @@ 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. @@ -37291,6 +33857,7 @@ 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. @@ -37309,6 +33876,7 @@ components: enum: - text x-stainless-const: true + default: text text: type: string allOf: @@ -37406,9 +33974,8 @@ components: schema: $ref: '#/components/schemas/OpenAI.ResponseFormatJsonSchemaSchema' strict: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.TextResponseFormatConfiguration' description: |- @@ -37451,9 +34018,6 @@ 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 @@ -37482,7 +34046,7 @@ components: type: array items: type: object - unevaluatedProperties: {} + additionalProperties: {} 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: @@ -37511,34 +34075,6 @@ 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: @@ -37635,9 +34171,8 @@ components: type: string description: The label of the MCP server to use. name: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true allOf: - $ref: '#/components/schemas/OpenAI.ToolChoiceParam' description: Use this option to force the model to call a specific tool on a remote MCP server. @@ -37677,8 +34212,6 @@ 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 @@ -37700,8 +34233,6 @@ components: - web_search_preview_2025_03_11 - image_generation - code_interpreter - - computer - - computer_use OpenAI.ToolChoiceWebSearchPreview: type: object required: @@ -37730,38 +34261,6 @@ 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 @@ -37769,7 +34268,6 @@ components: enum: - function - file_search - - computer - computer_use_preview - web_search - mcp @@ -37778,8 +34276,6 @@ components: - local_shell - shell - custom - - namespace - - tool_search - web_search_preview - apply_patch - a2a_preview @@ -37845,6 +34341,7 @@ 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. @@ -37858,9 +34355,10 @@ components: - metadata properties: metadata: - anyOf: + type: object + allOf: - $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. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. @@ -37879,6 +34377,7 @@ 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 @@ -37900,7 +34399,7 @@ components: title: URL citation OpenAI.VectorStoreFileAttributes: type: object - unevaluatedProperties: + additionalProperties: anyOf: - type: string - $ref: '#/components/schemas/OpenAI.numeric' @@ -37913,17 +34412,16 @@ components: length of 512 characters, booleans, or numbers. x-oaiTypeLabel: map OpenAI.Verbosity: - anyOf: - - type: string - enum: - - low - - medium - - high - - type: 'null' + type: string + enum: + - low + - medium + - high 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: @@ -37935,6 +34433,7 @@ 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. @@ -37973,10 +34472,9 @@ components: description: The action type. x-stainless-const: true url: - anyOf: - - type: string - format: uri - - type: 'null' + type: string + format: uri + nullable: true description: The URL opened by the model. description: Action type "open_page" - Opens a specific URL from search results. title: Open page action @@ -37984,6 +34482,7 @@ components: type: object required: - type + - query properties: type: type: string @@ -37993,7 +34492,7 @@ components: x-stainless-const: true query: type: string - description: The search query. + description: '[DEPRECATED] The search query.' deprecated: true queries: type: array @@ -38022,7 +34521,6 @@ components: x-stainless-const: true url: type: string - format: uri OpenAI.WebSearchApproximateLocation: type: object required: @@ -38036,21 +34534,17 @@ components: x-stainless-const: true default: approximate country: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true region: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true city: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true timezone: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true description: The approximate location of the user. title: Web search approximate location OpenAI.WebSearchPreviewTool: @@ -38064,18 +34558,16 @@ 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: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.ApproximateLocation' - - type: 'null' + nullable: true 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). @@ -38090,14 +34582,17 @@ 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: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.WebSearchToolFilters' - - type: 'null' + nullable: true user_location: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.WebSearchApproximateLocation' - - type: 'null' + nullable: true search_context_size: type: string enum: @@ -38128,11 +34623,10 @@ components: type: object properties: allowed_domains: - anyOf: - - type: array - items: - type: string - - type: 'null' + type: array + items: + type: string + nullable: true OpenAI.integer: type: integer format: int64 @@ -38196,7 +34690,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 - unevaluatedProperties: {} + additionalProperties: {} description: The openapi function shape, described as a JSON Schema object. auth: allOf: @@ -38220,7 +34714,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 - unevaluatedProperties: {} + additionalProperties: {} description: The parameters the functions accepts, described as a JSON Schema object. required: - name @@ -38375,47 +34869,84 @@ components: allOf: - $ref: '#/components/schemas/ToolboxTool' description: An OpenAPI tool stored in a toolbox. - OptimizationAgentIdentifier: + OptimizationAgentDefinition: type: object - required: - - agent_name properties: - agent_name: + agentName: type: string - description: Registered Foundry agent name (required). - agent_version: + description: Agent name. + 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 system_prompt are specified in options.optimization_config. + description: Agent version. + model: + type: string + description: Model deployment name. + systemPrompt: + 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). OptimizationCandidate: type: object required: - name - - avg_score - - avg_tokens + - config + - mutations + - avgScore + - avgTokens + - passRate + - taskScores + - isParetoOptimal properties: - candidate_id: + candidateId: 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 - unevaluatedProperties: {} - description: "What was mutated from the baseline (e.g., {system_prompt: 'new prompt'})." - avg_score: + additionalProperties: {} + description: "What was mutated from the baseline (e.g., {systemPrompt: 'new prompt'})." + avgScore: type: number format: double description: Average composite score across all tasks. - avg_tokens: + avgTokens: type: number format: double description: Average token usage across all tasks. - eval_id: + 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: type: string description: Foundry evaluation identifier used to score this candidate. - eval_run_id: + evalRunId: type: string description: Foundry evaluation run identifier for this candidate's scoring run. promotion: @@ -38423,115 +34954,17 @@ 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 - - created_at - - updated_at + - createdAt 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' @@ -38542,12 +34975,21 @@ components: - $ref: '#/components/schemas/OpenAI.Error' description: Error details — populated only on failure. readOnly: true - created_at: + result: + allOf: + - $ref: '#/components/schemas/OptimizationJobResult' + description: Result produced on success. + readOnly: true + inputs: + allOf: + - $ref: '#/components/schemas/OptimizationJobInputs' + description: Caller-supplied inputs. + createdAt: allOf: - $ref: '#/components/schemas/FoundryTimestamp' description: The timestamp when the job was created, represented in Unix time. readOnly: true - updated_at: + updatedAt: allOf: - $ref: '#/components/schemas/FoundryTimestamp' description: The timestamp when the job was last updated, represented in Unix time. @@ -38555,103 +34997,58 @@ components: progress: allOf: - $ref: '#/components/schemas/OptimizationJobProgress' - description: Progress snapshot. May be present in terminal states reflecting last-known progress. + description: Progress while in flight. Absent in terminal states. readOnly: true - warnings: - type: array - items: - type: string - description: Non-fatal warnings emitted at any point during optimization. + dataset: + allOf: + - $ref: '#/components/schemas/DatasetInfo' + description: Metadata about the dataset used for this optimization job. 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 - - train_dataset - - evaluators + - trainDatasetReference properties: agent: allOf: - - $ref: '#/components/schemas/OptimizationAgentIdentifier' + - $ref: '#/components/schemas/AgentIdentifier' description: The agent (and pinned version) being optimized. - train_dataset: + trainDatasetReference: allOf: - - $ref: '#/components/schemas/OptimizationDatasetInput' - description: Training dataset — either inline items or a reference to a registered dataset. Required. - validation_dataset: + - $ref: '#/components/schemas/DatasetRef' + description: Reference to a registered training dataset (required). + validationDatasetReference: allOf: - - $ref: '#/components/schemas/OptimizationDatasetInput' + - $ref: '#/components/schemas/DatasetRef' description: Optional held-out validation dataset for measuring generalization of the final candidate. evaluators: type: array items: - $ref: '#/components/schemas/OptimizationEvaluatorRef' - description: Job-level evaluators referenced by name and optional version. Required; at least one must be provided. + type: string + description: "Job-level evaluators (referenced by name). Per-task criteria may override. Default: ['task_adherence']." 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: - - candidates_completed - - best_score - - elapsed_seconds + - currentIteration + - bestScore + - elapsedSeconds properties: - candidates_completed: + currentIteration: type: integer format: int32 - description: Number of candidates whose evaluation has completed so far. - best_score: + description: 1-based current iteration index. + bestScore: type: number format: double description: Best score observed so far across all candidates. - elapsed_seconds: + elapsedSeconds: type: number format: double description: Wall-clock time elapsed in seconds since the job began executing. @@ -38660,61 +35057,106 @@ components: type: object properties: baseline: - type: string - description: Candidate ID of the original (un-optimized) baseline evaluation. + allOf: + - $ref: '#/components/schemas/OptimizationCandidate' + description: Evaluation scores for the original (un-optimized) agent configuration. best: - type: string - description: Candidate ID of the highest-scoring candidate found during optimization. + allOf: + - $ref: '#/components/schemas/OptimizationCandidate' + description: 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: - max_candidates: + maxIterations: type: integer format: int32 - minimum: 1 - description: 'Maximum number of optimization candidates to generate. Must be >= 1. Default: 5.' + description: 'Maximum optimization iterations per strategy. Must be >= 1. Default: 5.' default: 5 - optimization_config: + optimizationConfig: type: object - unevaluatedProperties: {} - description: Per-target-attribute configuration overrides. Contains skills, tools, system_prompt for the agent, plus model space for model optimization. - eval_model: + additionalProperties: {} + description: Per-target-attribute configuration overrides. Contains skills, tools, systemPrompt for the agent, plus model space for model optimization. + evalModel: type: string description: Model deployment used for evaluation. Defaults to server config (typically 'gpt-4o'). - optimization_model: + optimizationModel: type: string description: Model deployment for optimization reasoning (must be gpt-5 family). Falls back to the default eval model when not set. - evaluation_level: + evaluationLevel: 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. - OptimizationReferenceDatasetInput: + OptimizationTaskResult: type: object required: - - type - - name + - taskName + - scores + - compositeScore + - tokens + - durationSeconds + - passed properties: - type: + taskName: type: string - enum: - - reference - description: Dataset input type discriminator. - name: + description: Task name (from the dataset). + query: type: string - description: Registered dataset name. - version: + 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: string - description: Dataset version. If not specified, the latest version is used. - allOf: - - $ref: '#/components/schemas/OptimizationDatasetInput' - description: Reference to a registered Foundry dataset. + description: Error message if the task failed during execution. + rationales: + type: object + additionalProperties: + type: string + description: Per-evaluator reasoning keyed by evaluator name. + response: + type: string + description: Raw agent response text. + runId: + type: string + description: Identifier of the agent run that produced this result. + description: Per-task evaluation result for a single candidate. OtlpTelemetryEndpoint: type: object required: @@ -38730,14 +35172,12 @@ components: endpoint: type: string description: The OTLP collector endpoint URL. - examples: - - https://my-collector.example.com/otlp + example: https://my-collector.example.com/otlp protocol: allOf: - $ref: '#/components/schemas/TelemetryTransportProtocol' description: The transport protocol for the OTLP endpoint. - examples: - - Http + example: Http allOf: - $ref: '#/components/schemas/TelemetryEndpoint' description: An OTLP (OpenTelemetry Protocol) telemetry export endpoint. @@ -39044,21 +35484,60 @@ 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: - - promoted_at - - agent_name - - agent_version + - promotedAt + - agentName + - agentVersion properties: - promoted_at: + promotedAt: allOf: - $ref: '#/components/schemas/FoundryTimestamp' description: Timestamp when promotion occurred, represented in Unix time. - agent_name: + agentName: type: string description: Name of the Foundry agent this candidate was promoted to. - agent_version: + agentVersion: 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. @@ -39076,15 +35555,13 @@ components: type: string description: The model deployment to use for this agent. instructions: - anyOf: - - type: string - - type: 'null' + type: string + nullable: true description: A system (or developer) message inserted into the model's context. temperature: - anyOf: - - type: number - format: float - - type: 'null' + type: number + format: float + nullable: true minimum: 0 maximum: 2 description: |- @@ -39092,10 +35569,9 @@ components: We generally recommend altering this or `top_p` but not both. Defaults to `1`. default: 1 top_p: - anyOf: - - type: number - format: float - - type: 'null' + type: number + format: float + nullable: true minimum: 0 maximum: 1 description: |- @@ -39106,9 +35582,10 @@ components: Defaults to `1`. default: 1 reasoning: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Reasoning' - - type: 'null' + nullable: true tools: type: array items: @@ -39129,7 +35606,7 @@ components: description: Configuration options for a text response from the model. Can be plain text or structured JSON data. structured_inputs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/StructuredInputDefinition' description: Set of structured inputs that can participate in prompt template substitution or tool argument bindings. allOf: @@ -39324,7 +35801,7 @@ components: description: List of attack strategies or nested lists of attack strategies. simulationOnly: type: boolean - 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. + description: Simulation-only or Simulation + Evaluation. Default false, if true the scan outputs conversation not evaluation result. default: false riskCategories: type: array @@ -39336,12 +35813,12 @@ components: description: Application scenario for the red team operation, to generate scenario specific attacks. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Red team's tags. Unlike properties, tags are fully mutable. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. status: @@ -39493,7 +35970,7 @@ components: description: The maximum number of turns of chat history to evaluate. data_mapping: type: object - unevaluatedProperties: + additionalProperties: type: string description: Mapping from source fields to response_id field, required for retrieving chat history. source: @@ -39523,7 +36000,10 @@ components: Routine: type: object required: + - name - enabled + - triggers + - action properties: name: type: string @@ -39538,7 +36018,7 @@ components: description: Whether the routine is enabled. triggers: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/RoutineTrigger' description: The triggers configured for the routine. action: @@ -39602,6 +36082,9 @@ components: - Routines=V1Preview RoutineCreateOrUpdateRequest: type: object + required: + - triggers + - action properties: description: type: string @@ -39612,7 +36095,7 @@ components: description: Whether the routine is enabled. triggers: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/RoutineTrigger' description: The triggers configured for the routine. In v1, exactly one trigger entry is supported. action: @@ -39656,15 +36139,16 @@ components: type: object required: - id + - status + - trigger_type + - started_at properties: id: type: string - description: The unique run identifier for the routine attempt. - readOnly: true + description: The MLflow run identifier for the routine attempt. status: - allOf: - - $ref: '#/components/schemas/RoutineRunStatus' - description: The run status. + type: string + description: The underlying MLflow run status. phase: allOf: - $ref: '#/components/schemas/RoutineRunPhase' @@ -39673,9 +36157,6 @@ 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' @@ -39684,26 +36165,10 @@ 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' @@ -39724,20 +36189,47 @@ 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 @@ -39751,12 +36243,6 @@ 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: @@ -39771,8 +36257,7 @@ components: mapping: schedule: '#/components/schemas/ScheduleRoutineTrigger' timer: '#/components/schemas/TimerRoutineTrigger' - github_issue: '#/components/schemas/GitHubIssueRoutineTrigger' - custom: '#/components/schemas/CustomRoutineTrigger' + github_issue_opened: '#/components/schemas/GitHubIssueOpenedRoutineTrigger' description: Base model for a routine trigger. x-ms-foundry-meta: conditional_previews: @@ -39782,8 +36267,7 @@ components: - type: string - type: string enum: - - custom - - github_issue + - github_issue_opened - schedule - timer description: The discriminator values supported for routine triggers. @@ -39894,17 +36378,17 @@ components: description: Task for the schedule. tags: type: object - unevaluatedProperties: + additionalProperties: type: string description: Schedule's tags. Unlike properties, tags are fully mutable. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Schedule's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. systemData: type: object - unevaluatedProperties: + additionalProperties: type: string description: System metadata for the resource. readOnly: true @@ -39972,7 +36456,7 @@ components: readOnly: true properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Properties of the schedule run. readOnly: true @@ -39988,7 +36472,7 @@ components: description: Type of the task. configuration: type: object - unevaluatedProperties: + additionalProperties: type: string description: Configuration for the task. discriminator: @@ -40032,19 +36516,9 @@ 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. @@ -40053,6 +36527,7 @@ components: items: $ref: '#/components/schemas/SessionDirectoryEntry' description: The directory entries. + description: Response from listing a directory in a session sandbox. SessionFileWriteResponse: type: object required: @@ -40077,13 +36552,11 @@ 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. - examples: - - log + example: log data: type: string description: The event payload as plain text. Currently JSON-formatted but the schema is not contractual and may change. - examples: - - '{"timestamp":"2026-03-10T09:33:17.121467567+00:00","stream":"stdout","message":"Starting server on port 18080"}' + example: '{"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. @@ -40285,7 +36758,7 @@ components: description: Environment requirements or compatibility notes for the skill. metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: Arbitrary key-value metadata for additional properties. allowed_tools: @@ -40367,11 +36840,11 @@ components: description: The default value for the input if no run-time value is provided. schema: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The JSON schema for the structured input (optional). required: type: boolean - 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. + description: Whether the input property is required when the agent is invoked. Defaults to `false`. default: false description: An structured input that can participate in prompt template substitutions and tool argument binding. StructuredOutputDefinition: @@ -40390,12 +36863,11 @@ components: description: A description of the output to emit. Used by the model to determine when to emit the output. schema: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The JSON schema for the structured output. strict: - anyOf: - - type: boolean - - type: 'null' + type: boolean + nullable: true description: Whether to enforce strict validation. Default `true`. description: A structured output that can be produced by the agent. StructuredOutputsOutputItem: @@ -40600,7 +37072,7 @@ components: description: List of taxonomy sub categories. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Additional properties for the taxonomy category. description: Taxonomy category definition. @@ -40625,7 +37097,7 @@ components: description: List of taxonomy items under this sub-category. properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: Additional properties for the taxonomy sub-category. description: Taxonomy sub-category definition. @@ -40672,10 +37144,10 @@ components: items: $ref: '#/components/schemas/TelemetryDataKind' description: Data types to export to this endpoint. Use an empty array to export no data. - examples: - - - ContainerStdoutStderr - - ContainerOtel - - Metrics + example: + - ContainerStdoutStderr + - ContainerOtel + - Metrics auth: allOf: - $ref: '#/components/schemas/TelemetryEndpointAuth' @@ -40759,11 +37231,10 @@ 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 - unevaluatedProperties: + additionalProperties: 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. @@ -40772,6 +37243,7 @@ components: type: object required: - type + - at properties: type: type: string @@ -40779,9 +37251,11 @@ components: - timer description: The trigger type. at: - allOf: - - $ref: '#/components/schemas/FoundryTimestamp' - description: The UTC date and time at which the timer fires. + 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/RoutineTrigger' description: A one-shot timer routine trigger. @@ -40791,7 +37265,7 @@ components: ToolCallOutputContent: anyOf: - type: object - unevaluatedProperties: {} + additionalProperties: {} - type: string - type: array items: {} @@ -40941,7 +37415,7 @@ components: description: Optional user-defined description for this tool or configuration. tool_configs: type: object - unevaluatedProperties: + additionalProperties: $ref: '#/components/schemas/ToolConfig' description: |- Per-tool configuration map. Keys are tool names or `*` (catch-all default). @@ -40986,11 +37460,10 @@ components: - tools properties: metadata: - anyOf: - - type: object - unevaluatedProperties: - type: string - - type: 'null' + type: object + additionalProperties: + type: string + 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 @@ -41285,7 +37758,7 @@ components: properties: metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -41304,7 +37777,7 @@ components: description: The manifest ID to import the agent version from. parameter_values: type: object - unevaluatedProperties: {} + additionalProperties: {} description: The inputs to the manifest that will result in a fully materialized Agent. UpdateAgentRequest: type: object @@ -41313,7 +37786,7 @@ components: properties: metadata: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of 16 key-value pairs that can be attached to an object. This can be @@ -41350,12 +37823,13 @@ components: name: type: string metadata: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.Metadata' - - type: 'null' + nullable: true properties: type: object - unevaluatedProperties: + additionalProperties: type: string description: |- Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. @@ -41368,7 +37842,7 @@ components: description: The asset description text. tags: type: object - unevaluatedProperties: + additionalProperties: 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. @@ -41532,13 +38006,15 @@ components: enum: - web_search filters: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.WebSearchToolFilters' - - type: 'null' + nullable: true user_location: - anyOf: + type: object + allOf: - $ref: '#/components/schemas/OpenAI.WebSearchApproximateLocation' - - type: 'null' + nullable: true search_context_size: type: string enum: @@ -41692,7 +38168,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 - unevaluatedProperties: {} + additionalProperties: {} 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 53e02b2ff2df..789f2666eacc 100644 --- a/specification/ai-foundry/data-plane/Foundry/src/toolboxes/models.tsp +++ b/specification/ai-foundry/data-plane/Foundry/src/toolboxes/models.tsp @@ -56,20 +56,31 @@ alias ToolFields = { ...OmitProperties; }; +alias ToolboxCodeInterpreterToolType = "code_interpreter"; +alias ToolboxFileSearchToolType = "file_search"; +alias ToolboxWebSearchToolType = "web_search"; +alias ToolboxMCPToolType = "mcp"; +alias ToolboxAzureAISearchToolType = "azure_ai_search"; +alias ToolboxOpenApiToolType = "openapi"; +alias ToolboxA2APreviewToolType = "a2a_preview"; +alias ToolboxWorkIQPreviewToolType = "work_iq_preview"; +alias ToolboxFabricIQPreviewToolType = "fabric_iq_preview"; +alias ToolboxSearchPreviewToolType = "toolbox_search_preview"; + /** * Supported tool types for tools stored in a toolbox. */ union ToolboxToolType { - code_interpreter: "code_interpreter", - file_search: "file_search", - web_search: "web_search", - mcp: "mcp", - azure_ai_search: "azure_ai_search", - openapi: "openapi", - a2a_preview: "a2a_preview", - work_iq_preview: "work_iq_preview", - fabric_iq_preview: "fabric_iq_preview", - toolbox_search_preview: "toolbox_search_preview", + code_interpreter: ToolboxCodeInterpreterToolType, + file_search: ToolboxFileSearchToolType, + web_search: ToolboxWebSearchToolType, + mcp: ToolboxMCPToolType, + azure_ai_search: ToolboxAzureAISearchToolType, + openapi: ToolboxOpenApiToolType, + a2a_preview: ToolboxA2APreviewToolType, + work_iq_preview: ToolboxWorkIQPreviewToolType, + fabric_iq_preview: ToolboxFabricIQPreviewToolType, + toolbox_search_preview: ToolboxSearchPreviewToolType, } /** @@ -90,7 +101,7 @@ model ToolboxTool { * A code interpreter tool stored in a toolbox. */ model CodeInterpreterToolboxTool extends ToolboxTool { - type: "code_interpreter"; + type: ToolboxCodeInterpreterToolType; ...ToolFields; } @@ -99,7 +110,7 @@ model CodeInterpreterToolboxTool extends ToolboxTool { * A file search tool stored in a toolbox. */ model FileSearchToolboxTool extends ToolboxTool { - type: "file_search"; + type: ToolboxFileSearchToolType; ...WithFieldsOptional< ToolFields, @@ -111,7 +122,7 @@ model FileSearchToolboxTool extends ToolboxTool { * A web search tool stored in a toolbox. */ model WebSearchToolboxTool extends ToolboxTool { - type: "web_search"; + type: ToolboxWebSearchToolType; ...ToolFields; } @@ -120,7 +131,7 @@ model WebSearchToolboxTool extends ToolboxTool { * An MCP tool stored in a toolbox. */ model MCPToolboxTool extends ToolboxTool { - type: "mcp"; + type: ToolboxMCPToolType; ...ToolFields; } @@ -129,7 +140,7 @@ model MCPToolboxTool extends ToolboxTool { * An Azure AI Search tool stored in a toolbox. */ model AzureAISearchToolboxTool extends ToolboxTool { - type: "azure_ai_search"; + type: ToolboxAzureAISearchToolType; ...ToolFields; } @@ -138,7 +149,7 @@ model AzureAISearchToolboxTool extends ToolboxTool { * An OpenAPI tool stored in a toolbox. */ model OpenApiToolboxTool extends ToolboxTool { - type: "openapi"; + type: ToolboxOpenApiToolType; ...ToolFields; } @@ -147,7 +158,7 @@ model OpenApiToolboxTool extends ToolboxTool { * An A2A tool stored in a toolbox. */ model A2APreviewToolboxTool extends ToolboxTool { - type: "a2a_preview"; + type: ToolboxA2APreviewToolType; ...ToolFields; } @@ -156,7 +167,7 @@ model A2APreviewToolboxTool extends ToolboxTool { * A WorkIQ tool stored in a toolbox. */ model WorkIQPreviewToolboxTool extends ToolboxTool { - type: "work_iq_preview"; + type: ToolboxWorkIQPreviewToolType; ...ToolFields; } @@ -165,7 +176,7 @@ model WorkIQPreviewToolboxTool extends ToolboxTool { * A FabricIQ tool stored in a toolbox. */ model FabricIQPreviewToolboxTool extends ToolboxTool { - type: "fabric_iq_preview"; + type: ToolboxFabricIQPreviewToolType; ...ToolFields; } @@ -177,7 +188,7 @@ model ToolboxSearchPreviewToolboxTool extends ToolboxTool { /** * The type of the tool. Always `toolbox_search_preview`. */ - type: "toolbox_search_preview"; + type: ToolboxSearchPreviewToolType; } @doc("Policy configuration for a toolbox, including content safety and other governance settings.")