Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
API Version: v1
Authentication
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Scopes:
https://ai.azure.com/.default
Agents
Agents - create agent
POST {endpoint}/agents?api-version=v1
Creates the agent.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | False | string Possible values: ContainerAgents=V1Preview, HostedAgents=V1Preview, WorkflowAgents=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| definition | AgentDefinition | Yes | ||
| └─ kind | AgentKind | Yes | ||
| └─ rai_config | RaiConfig | Configuration for Responsible AI (RAI) content filtering and safety features. | No | |
| description | string | A human-readable description of the agent. Constraints: maxLength: 512 |
No | |
| metadata | object | 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. |
No | |
| name | string | The unique name that identifies the agent. Name can be used to retrieve/update/delete the agent. - Must start and end with alphanumeric characters, - Can contain hyphens in the middle - Must not exceed 63 characters. Constraints: maxLength: 63 |
Yes |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | AgentObject |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Agents - list agents
GET {endpoint}/agents?api-version=v1
Returns the list of all agents.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| kind | query | No | string Possible values: prompt, hosted, container_app, workflow |
Filter agents by kind. If not provided, all agents are returned. |
| limit | query | No | integer | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. |
| order | query | No | string Possible values: asc, desc |
Sort order by the created_at timestamp of the objects. asc for ascending order anddescfor descending order. |
| after | query | No | string | 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. |
| before | query | No | string | 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. |
| api-version | query | Yes | string | The API version to use for this operation. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | object | The response data for a requested list of items. |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Agents - get agent
GET {endpoint}/agents/{agent_name}?api-version=v1
Retrieves the agent.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| agent_name | path | Yes | string | The name of the agent to retrieve. |
| api-version | query | Yes | string | The API version to use for this operation. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | AgentObject |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Agents - update agent
POST {endpoint}/agents/{agent_name}?api-version=v1
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.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| agent_name | path | Yes | string | The name of the agent to retrieve. |
| api-version | query | Yes | string | The API version to use for this operation. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | False | string Possible values: ContainerAgents=V1Preview, HostedAgents=V1Preview, WorkflowAgents=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| definition | AgentDefinition | Yes | ||
| └─ kind | AgentKind | Yes | ||
| └─ rai_config | RaiConfig | Configuration for Responsible AI (RAI) content filtering and safety features. | No | |
| description | string | A human-readable description of the agent. Constraints: maxLength: 512 |
No | |
| metadata | object | 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. |
No |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | AgentObject |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Agents - delete agent
DELETE {endpoint}/agents/{agent_name}?api-version=v1
Deletes an agent.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| agent_name | path | Yes | string | The name of the agent to delete. |
| api-version | query | Yes | string | The API version to use for this operation. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | DeleteAgentResponse |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Agents - update agent from manifest
POST {endpoint}/agents/{agent_name}/import?api-version=v1
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.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| agent_name | path | Yes | string | The name of the agent to update. |
| api-version | query | Yes | string | The API version to use for this operation. |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | A human-readable description of the agent. Constraints: maxLength: 512 |
No | |
| manifest_id | string | The manifest ID to import the agent version from. | Yes | |
| metadata | object | 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. |
No | |
| parameter_values | object | The inputs to the manifest that will result in a fully materialized Agent. | Yes |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | AgentObject |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Agents - create agent version
POST {endpoint}/agents/{agent_name}/versions?api-version=v1
Create a new agent version.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| agent_name | path | Yes | string | The unique name that identifies the agent. Name can be used to retrieve/update/delete the agent. - Must start and end with alphanumeric characters, - Can contain hyphens in the middle - Must not exceed 63 characters. |
| api-version | query | Yes | string | The API version to use for this operation. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | False | string Possible values: ContainerAgents=V1Preview, HostedAgents=V1Preview, WorkflowAgents=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| definition | AgentDefinition | Yes | ||
| └─ kind | AgentKind | Yes | ||
| └─ rai_config | RaiConfig | Configuration for Responsible AI (RAI) content filtering and safety features. | No | |
| description | string | A human-readable description of the agent. Constraints: maxLength: 512 |
No | |
| metadata | object | 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. |
No |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | AgentVersionObject |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Agents - list agent versions
GET {endpoint}/agents/{agent_name}/versions?api-version=v1
Returns the list of versions of an agent.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| agent_name | path | Yes | string | The name of the agent to retrieve versions for. |
| limit | query | No | integer | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. |
| order | query | No | string Possible values: asc, desc |
Sort order by the created_at timestamp of the objects. asc for ascending order anddescfor descending order. |
| after | query | No | string | 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. |
| before | query | No | string | 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. |
| api-version | query | Yes | string | The API version to use for this operation. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | object | The response data for a requested list of items. |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Agents - get agent version
GET {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=v1
Retrieves a specific version of an agent.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| agent_name | path | Yes | string | The name of the agent to retrieve. |
| agent_version | path | Yes | string | The version of the agent to retrieve. |
| api-version | query | Yes | string | The API version to use for this operation. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | AgentVersionObject |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Agents - delete agent version
DELETE {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=v1
Deletes a specific version of an agent.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| agent_name | path | Yes | string | The name of the agent to delete. |
| agent_version | path | Yes | string | The version of the agent to delete |
| api-version | query | Yes | string | The API version to use for this operation. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | DeleteAgentVersionResponse |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Agents - create agent version from manifest
POST {endpoint}/agents/{agent_name}/versions:import?api-version=v1
Create a new agent version from a manifest.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| agent_name | path | Yes | string | The unique name that identifies the agent. Name can be used to retrieve/update/delete the agent. - Must start and end with alphanumeric characters, - Can contain hyphens in the middle - Must not exceed 63 characters. |
| api-version | query | Yes | string | The API version to use for this operation. |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | A human-readable description of the agent. Constraints: maxLength: 512 |
No | |
| manifest_id | string | The manifest ID to import the agent version from. | Yes | |
| metadata | object | 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. |
No | |
| parameter_values | object | The inputs to the manifest that will result in a fully materialized Agent. | Yes |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | AgentVersionObject |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Agents - create agent from manifest
POST {endpoint}/agents:import?api-version=v1
Creates an agent from a manifest.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | A human-readable description of the agent. Constraints: maxLength: 512 |
No | |
| manifest_id | string | The manifest ID to import the agent version from. | Yes | |
| metadata | object | 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. |
No | |
| name | string | The unique name that identifies the agent. Name can be used to retrieve/update/delete the agent. - Must start and end with alphanumeric characters, - Can contain hyphens in the middle - Must not exceed 63 characters. Constraints: maxLength: 63 |
Yes | |
| parameter_values | object | The inputs to the manifest that will result in a fully materialized Agent. | Yes |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | AgentObject |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Agent Containers
Agent containers - list agent container operations
GET {endpoint}/agents/{agent_name}/operations?api-version=v1
List container operations for an agent.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| agent_name | path | Yes | string | The name of the agent. |
| limit | query | No | integer | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. |
| order | query | No | string Possible values: asc, desc |
Sort order by the created_at timestamp of the objects. asc for ascending order anddescfor descending order. |
| after | query | No | string | 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. |
| before | query | No | string | 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. |
| api-version | query | Yes | string | The API version to use for this operation. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | False | string Possible values: ContainerAgents=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | object | The response data for a requested list of items. |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Agent containers - get agent container operation
GET {endpoint}/agents/{agent_name}/operations/{operation_id}?api-version=v1
Get the status of a container operation for an agent.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| agent_name | path | Yes | string | The name of the agent. |
| operation_id | path | Yes | string | The operation ID. |
| api-version | query | Yes | string | The API version to use for this operation. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | False | string Possible values: ContainerAgents=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | AgentContainerOperationObject |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Agent containers - get agent container
GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default?api-version=v1
Get a container for a specific version of an agent.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| agent_name | path | Yes | string | The name of the agent. |
| agent_version | path | Yes | string | The version of the agent. |
| api-version | query | Yes | string | The API version to use for this operation. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | False | string Possible values: ContainerAgents=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | AgentContainerObject |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Agent containers - list agent version container operations
GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default/operations?api-version=v1
List container operations for a specific version of an agent.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| agent_name | path | Yes | string | The name of the agent. |
| agent_version | path | Yes | string | The version of the agent. |
| limit | query | No | integer | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. |
| order | query | No | string Possible values: asc, desc |
Sort order by the created_at timestamp of the objects. asc for ascending order anddescfor descending order. |
| after | query | No | string | 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. |
| before | query | No | string | 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. |
| api-version | query | Yes | string | The API version to use for this operation. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | False | string Possible values: ContainerAgents=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | object | The response data for a requested list of items. |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Agent containers - delete agent container
POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:delete?api-version=v1
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
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| agent_name | path | Yes | string | The name of the agent. |
| agent_version | path | Yes | string | The version of the agent. |
| api-version | query | Yes | string | The API version to use for this operation. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | False | string Possible values: ContainerAgents=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Responses
Status Code: 202
Description: The request has been accepted for processing, but processing has not yet completed.
| Content-Type | Type | Description |
|---|---|---|
| application/json | AgentContainerOperationObject |
Response Headers:
| Header | Type | Description |
|---|---|---|
| Operation-Location | string |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Agent containers - stream agent container logs
POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:logstream?api-version=v1
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
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| agent_name | path | Yes | string | The name of the agent. |
| agent_version | path | Yes | string | The version of the agent. |
| kind | query | No | string Possible values: console, system |
console returns container stdout/stderr, system returns container app event stream. defaults to console |
| replica_name | query | No | string | When omitted, the server chooses the first replica for console logs. Required to target a specific replica. |
| tail | query | No | integer | Number of trailing lines returned. Enforced to 1-300. Defaults to 20 |
| api-version | query | Yes | string | The API version to use for this operation. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | False | string Possible values: ContainerAgents=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Responses
Status Code: 200
Description: The request has succeeded.
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Agent containers - start agent container
POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:start?api-version=v1
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
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| agent_name | path | Yes | string | The name of the agent. |
| agent_version | path | Yes | string | The version of the agent. |
| api-version | query | Yes | string | The API version to use for this operation. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | False | string Possible values: ContainerAgents=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| max_replicas | integer | The maximum number of replicas. Defaults to 1. | No | 1 |
| min_replicas | integer | The minimum number of replicas. Defaults to 1. | No | 1 |
Responses
Status Code: 202
Description: The request has been accepted for processing, but processing has not yet completed.
| Content-Type | Type | Description |
|---|---|---|
| application/json | AgentContainerOperationObject |
Response Headers:
| Header | Type | Description |
|---|---|---|
| Operation-Location | string |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Agent containers - stop agent container
POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:stop?api-version=v1
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
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| agent_name | path | Yes | string | The name of the agent. |
| agent_version | path | Yes | string | The version of the agent. |
| api-version | query | Yes | string | The API version to use for this operation. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | False | string Possible values: ContainerAgents=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Responses
Status Code: 202
Description: The request has been accepted for processing, but processing has not yet completed.
| Content-Type | Type | Description |
|---|---|---|
| application/json | AgentContainerOperationObject |
Response Headers:
| Header | Type | Description |
|---|---|---|
| Operation-Location | string |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Agent containers - update agent container
POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:update?api-version=v1
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
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| agent_name | path | Yes | string | The name of the agent. |
| agent_version | path | Yes | string | The version of the agent. |
| api-version | query | Yes | string | The API version to use for this operation. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | False | string Possible values: ContainerAgents=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| max_replicas | integer | The maximum number of replicas. | No | |
| min_replicas | integer | The minimum number of replicas. | No |
Responses
Status Code: 202
Description: The request has been accepted for processing, but processing has not yet completed.
| Content-Type | Type | Description |
|---|---|---|
| application/json | AgentContainerOperationObject |
Response Headers:
| Header | Type | Description |
|---|---|---|
| Operation-Location | string |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Connections
Connections - list
GET {endpoint}/connections?api-version=v1
List all connections in the project, without populating connection credentials
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| connectionType | query | No | string Possible values: AzureOpenAI, AzureBlob, AzureStorageAccount, CognitiveSearch, CosmosDB, ApiKey, AppConfig, AppInsights, CustomKeys, RemoteTool_Preview |
List connections of this specific type |
| defaultConnection | query | No | boolean | List connections that are default connections |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| x-ms-client-request-id | False | string | An opaque, globally-unique, client-generated string identifier for the request. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | PagedConnection |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-client-request-id | An opaque, globally-unique, client-generated string identifier for the request. |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Connections - get
GET {endpoint}/connections/{name}?api-version=v1
Get a connection by name, without populating connection credentials
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| name | path | Yes | string | The friendly name of the connection, provided by the user. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| x-ms-client-request-id | False | string | An opaque, globally-unique, client-generated string identifier for the request. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Connection |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-client-request-id | An opaque, globally-unique, client-generated string identifier for the request. |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Connections - get with credentials
POST {endpoint}/connections/{name}/getConnectionWithCredentials?api-version=v1
Get a connection by name, with its connection credentials
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| name | path | Yes | string | The friendly name of the connection, provided by the user. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| x-ms-client-request-id | False | string | An opaque, globally-unique, client-generated string identifier for the request. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Connection |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-client-request-id | An opaque, globally-unique, client-generated string identifier for the request. |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Datasets
Datasets - list latest
GET {endpoint}/datasets?api-version=v1
List the latest version of each DatasetVersion
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | PagedDatasetVersion |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Datasets - list versions
GET {endpoint}/datasets/{name}/versions?api-version=v1
List all versions of the given DatasetVersion
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| name | path | Yes | string | The name of the resource |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | PagedDatasetVersion |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Datasets - get version
GET {endpoint}/datasets/{name}/versions/{version}?api-version=v1
Get the specific version of the DatasetVersion. The service returns 404 Not Found error if the DatasetVersion does not exist.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| name | path | Yes | string | The name of the resource |
| version | path | Yes | string | The specific version id of the DatasetVersion to retrieve. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | DatasetVersion |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Datasets - delete version
DELETE {endpoint}/datasets/{name}/versions/{version}?api-version=v1
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.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| name | path | Yes | string | The name of the resource |
| version | path | Yes | string | The version of the DatasetVersion to delete. |
Responses
Status Code: 204
Description: There is no content to send for this request, but the headers may be useful.
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Datasets - create or update version
PATCH {endpoint}/datasets/{name}/versions/{version}?api-version=v1
Create a new or update an existing DatasetVersion with the given version id
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| name | path | Yes | string | The name of the resource |
| version | path | Yes | string | The specific version id of the DatasetVersion to create or update. |
Request Body
Content-Type: application/merge-patch+json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | The asset description text. | No | |
| tags | object | Tag dictionary. Tags can be added, removed, and updated. | No | |
| type | DatasetType | Enum to determine the type of data. | Yes |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | DatasetVersion |
Status Code: 201
Description: The request has succeeded and a new resource has been created as a result.
| Content-Type | Type | Description |
|---|---|---|
| application/json | DatasetVersion |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Datasets - get credentials
POST {endpoint}/datasets/{name}/versions/{version}/credentials?api-version=v1
Get the SAS credential to access the storage account associated with a Dataset version.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| name | path | Yes | string | The name of the resource |
| version | path | Yes | string | The specific version id of the DatasetVersion to operate on. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | AssetCredentialResponse |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Datasets - start pending upload version
POST {endpoint}/datasets/{name}/versions/{version}/startPendingUpload?api-version=v1
Start a new or get an existing pending upload of a dataset for a specific version.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| name | path | Yes | string | The name of the resource |
| version | path | Yes | string | The specific version id of the DatasetVersion to operate on. |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| connectionName | string | Azure Storage Account connection name to use for generating temporary SAS token | No | |
| pendingUploadId | string | If PendingUploadId is not provided, a random GUID will be used. | No | |
| pendingUploadType | enum | BlobReference is the only supported type. Possible values: BlobReference |
Yes |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | PendingUploadResponse |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Deployments
Deployments - list
GET {endpoint}/deployments?api-version=v1
List all deployed models in the project
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| modelPublisher | query | No | string | Model publisher to filter models by |
| modelName | query | No | string | Model name (the publisher specific name) to filter models by |
| deploymentType | query | No | string Possible values: ModelDeployment |
Type of deployment to filter list by |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| x-ms-client-request-id | False | string | An opaque, globally-unique, client-generated string identifier for the request. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | PagedDeployment |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-client-request-id | An opaque, globally-unique, client-generated string identifier for the request. |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Deployments - get
GET {endpoint}/deployments/{name}?api-version=v1
Get a deployed model.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| name | path | Yes | string | Name of the deployment |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| x-ms-client-request-id | False | string | An opaque, globally-unique, client-generated string identifier for the request. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Deployment |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-client-request-id | An opaque, globally-unique, client-generated string identifier for the request. |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Evaluation Taxonomies
Evaluation taxonomies - list
GET {endpoint}/evaluationtaxonomies?api-version=v1
List evaluation taxonomies
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| inputName | query | No | string | Filter by the evaluation input name. |
| inputType | query | No | string | Filter by taxonomy input type. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: Evaluations=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | PagedEvaluationTaxonomy |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Evaluation taxonomies - get
GET {endpoint}/evaluationtaxonomies/{name}?api-version=v1
Get an evaluation run by name.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| name | path | Yes | string | The name of the resource |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: Evaluations=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | EvaluationTaxonomy |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Evaluation taxonomies - delete
DELETE {endpoint}/evaluationtaxonomies/{name}?api-version=v1
Delete an evaluation taxonomy by name.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| name | path | Yes | string | The name of the resource |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: Evaluations=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Responses
Status Code: 204
Description: There is no content to send for this request, but the headers may be useful.
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Evaluation taxonomies - create
PUT {endpoint}/evaluationtaxonomies/{name}?api-version=v1
Create an evaluation taxonomy.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| name | path | Yes | string | The name of the evaluation taxonomy. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: Evaluations=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | The asset description text. | No | |
| properties | object | Additional properties for the evaluation taxonomy. | No | |
| tags | object | Tag dictionary. Tags can be added, removed, and updated. | No | |
| taxonomyCategories | array of TaxonomyCategory | List of taxonomy categories. | No | |
| taxonomyInput | EvaluationTaxonomyInput | Input configuration for the evaluation taxonomy. | Yes | |
| └─ type | EvaluationTaxonomyInputType | Input type of the evaluation taxonomy. | Yes |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | EvaluationTaxonomy |
Status Code: 201
Description: The request has succeeded and a new resource has been created as a result.
| Content-Type | Type | Description |
|---|---|---|
| application/json | EvaluationTaxonomy |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Evaluation taxonomies - update
PATCH {endpoint}/evaluationtaxonomies/{name}?api-version=v1
Update an evaluation taxonomy.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| name | path | Yes | string | The name of the evaluation taxonomy. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: Evaluations=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | The asset description text. | No | |
| properties | object | Additional properties for the evaluation taxonomy. | No | |
| tags | object | Tag dictionary. Tags can be added, removed, and updated. | No | |
| taxonomyCategories | array of TaxonomyCategory | List of taxonomy categories. | No | |
| taxonomyInput | EvaluationTaxonomyInputUpdate | Input configuration for the evaluation taxonomy. | No | |
| └─ type | EvaluationTaxonomyInputType | Input type of the evaluation taxonomy. | Yes |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | EvaluationTaxonomy |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Evaluation Rules
Evaluation rules - list
GET {endpoint}/evaluationrules?api-version=v1
List all evaluation rules.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| actionType | query | No | string Possible values: continuousEvaluation, humanEvaluationPreview |
Filter by the type of evaluation rule. |
| agentName | query | No | string | Filter by the agent name. |
| enabled | query | No | boolean | Filter by the enabled status. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | PagedEvaluationRule |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Evaluation rules - get
GET {endpoint}/evaluationrules/{id}?api-version=v1
Get an evaluation rule.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| id | path | Yes | string | Unique identifier for the evaluation rule. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | EvaluationRule |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Evaluation rules - delete
DELETE {endpoint}/evaluationrules/{id}?api-version=v1
Delete an evaluation rule.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| id | path | Yes | string | Unique identifier for the evaluation rule. |
Responses
Status Code: 204
Description: There is no content to send for this request, but the headers may be useful.
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Evaluation rules - create or update
PUT {endpoint}/evaluationrules/{id}?api-version=v1
Create or update an evaluation rule.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| id | path | Yes | string | Unique identifier for the evaluation rule. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | False | string Possible values: Evaluations=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| action | EvaluationRuleAction | Evaluation action model. | Yes | |
| └─ type | EvaluationRuleActionType | Type of the evaluation action. | Yes | |
| description | string | Description for the evaluation rule. | No | |
| displayName | string | Display Name for the evaluation rule. | No | |
| enabled | boolean | Indicates whether the evaluation rule is enabled. Default is true. | Yes | |
| eventType | EvaluationRuleEventType | Type of the evaluation rule event. | Yes | |
| filter | EvaluationRuleFilter | Evaluation filter model. | No | |
| └─ agentName | string | Filter by agent name. | Yes | |
| id | string (read-only) | Unique identifier for the evaluation rule. | Yes | |
| systemData | object (read-only) | System metadata for the evaluation rule. | Yes |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | EvaluationRule |
Status Code: 201
Description: The request has succeeded and a new resource has been created as a result.
| Content-Type | Type | Description |
|---|---|---|
| application/json | EvaluationRule |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Evaluators
Evaluators - list latest versions
GET {endpoint}/evaluators?api-version=v1
List the latest version of each evaluator
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| type | query | No | string Possible values: builtin, custom, all |
Filter evaluators by type. Possible values: 'all', 'custom', 'builtin'. |
| limit | query | No | integer | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: Evaluations=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | PagedEvaluatorVersion |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Evaluators - list versions
GET {endpoint}/evaluators/{name}/versions?api-version=v1
List all versions of the given evaluator
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| name | path | Yes | string | The name of the resource |
| type | query | No | string Possible values: builtin, custom, all |
Filter evaluators by type. Possible values: 'all', 'custom', 'builtin'. |
| limit | query | No | integer | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: Evaluations=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | PagedEvaluatorVersion |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Evaluators - create version
POST {endpoint}/evaluators/{name}/versions?api-version=v1
Create a new EvaluatorVersion with auto incremented version id
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| name | path | Yes | string | The name of the resource |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: Evaluations=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| categories | array of EvaluatorCategory | The categories of the evaluator | Yes | |
| definition | EvaluatorDefinition | Base evaluator configuration with discriminator | Yes | |
| └─ data_schema | object | The JSON schema (Draft 2020-12) for the evaluator's input data. This includes parameters like type, properties, required. | No | |
| └─ init_parameters | object | The JSON schema (Draft 2020-12) for the evaluator's input parameters. This includes parameters like type, properties, required. | No | |
| └─ metrics | object | List of output metrics produced by this evaluator | No | |
| └─ type | EvaluatorDefinitionType | The type of evaluator definition | Yes | |
| description | string | The asset description text. | No | |
| display_name | string | Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique. | No | |
| evaluator_type | EvaluatorType | The type of the evaluator | Yes | |
| metadata | object | Metadata about the evaluator | No | |
| tags | object | Tag dictionary. Tags can be added, removed, and updated. | No |
Responses
Status Code: 201
Description: The request has succeeded and a new resource has been created as a result.
| Content-Type | Type | Description |
|---|---|---|
| application/json | EvaluatorVersion |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Evaluators - get version
GET {endpoint}/evaluators/{name}/versions/{version}?api-version=v1
Get the specific version of the EvaluatorVersion. The service returns 404 Not Found error if the EvaluatorVersion does not exist.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| name | path | Yes | string | The name of the resource |
| version | path | Yes | string | The specific version id of the EvaluatorVersion to retrieve. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: Evaluations=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | EvaluatorVersion |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Evaluators - delete version
DELETE {endpoint}/evaluators/{name}/versions/{version}?api-version=v1
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.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| name | path | Yes | string | The name of the resource |
| version | path | Yes | string | The version of the EvaluatorVersion to delete. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: Evaluations=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Responses
Status Code: 204
Description: There is no content to send for this request, but the headers may be useful.
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Evaluators - update version
PATCH {endpoint}/evaluators/{name}/versions/{version}?api-version=v1
Update an existing EvaluatorVersion with the given version id
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| name | path | Yes | string | The name of the resource |
| version | path | Yes | string | The version of the EvaluatorVersion to update. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: Evaluations=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| categories | array of EvaluatorCategory | The categories of the evaluator | No | |
| description | string | The asset description text. | No | |
| display_name | string | Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique. | No | |
| metadata | object | Metadata about the evaluator | No | |
| tags | object | Tag dictionary. Tags can be added, removed, and updated. | No |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | EvaluatorVersion |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Indexes
Indexes - list latest
GET {endpoint}/indexes?api-version=v1
List the latest version of each Index
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | PagedIndex |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Indexes - list versions
GET {endpoint}/indexes/{name}/versions?api-version=v1
List all versions of the given Index
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| name | path | Yes | string | The name of the resource |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | PagedIndex |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Indexes - get version
GET {endpoint}/indexes/{name}/versions/{version}?api-version=v1
Get the specific version of the Index. The service returns 404 Not Found error if the Index does not exist.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| name | path | Yes | string | The name of the resource |
| version | path | Yes | string | The specific version id of the Index to retrieve. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Index |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Indexes - delete version
DELETE {endpoint}/indexes/{name}/versions/{version}?api-version=v1
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.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| name | path | Yes | string | The name of the resource |
| version | path | Yes | string | The version of the Index to delete. |
Responses
Status Code: 204
Description: There is no content to send for this request, but the headers may be useful.
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Indexes - create or update version
PATCH {endpoint}/indexes/{name}/versions/{version}?api-version=v1
Create a new or update an existing Index with the given version id
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| name | path | Yes | string | The name of the resource |
| version | path | Yes | string | The specific version id of the Index to create or update. |
Request Body
Content-Type: application/merge-patch+json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | The asset description text. | No | |
| tags | object | Tag dictionary. Tags can be added, removed, and updated. | No | |
| type | IndexType | Yes |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Index |
Status Code: 201
Description: The request has succeeded and a new resource has been created as a result.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Index |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Insights
Insights - generate
POST {endpoint}/insights?api-version=v1
Generate Insights
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: Insights=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
| Repeatability-Request-ID | False | string | Unique, client-generated identifier for ensuring request idempotency. Use the same ID for retries to prevent duplicate evaluations. |
| Repeatability-First-Sent | False | string | Timestamp indicating when this request was first initiated. Used in conjunction with repeatability-request-id for idempotency control. |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| displayName | string | User friendly display name for the insight. | Yes | |
| id | string (read-only) | The unique identifier for the insights report. | Yes | |
| metadata | InsightsMetadata (read-only) | Metadata about the insights. | Yes | |
| └─ completedAt | string | The timestamp when the insights were completed. | No | |
| └─ createdAt | string | The timestamp when the insights were created. | Yes | |
| request | InsightRequest | The request of the insights report. | Yes | |
| └─ type | InsightType | The type of request. | Yes | |
| result | InsightResult (read-only) | The result of the insights. | No | |
| └─ type | InsightType | The type of insights result. | Yes | |
| state | Azure.Core.Foundations.OperationState (read-only) | Enum describing allowed operation states. | Yes |
Responses
Status Code: 201
Description: The request has succeeded and a new resource has been created as a result.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Insight |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Insights - list
GET {endpoint}/insights?api-version=v1
List all insights in reverse chronological order (newest first).
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| type | query | No | string Possible values: EvaluationRunClusterInsight, AgentClusterInsight, EvaluationComparison |
Filter by the type of analysis. |
| evalId | query | No | string | Filter by the evaluation ID. |
| runId | query | No | string | Filter by the evaluation run ID. |
| agentName | query | No | string | Filter by the agent name. |
| includeCoordinates | query | No | boolean | Whether to include coordinates for visualization in the response. Defaults to false. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: Insights=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | PagedInsight |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Insights - get
GET {endpoint}/insights/{id}?api-version=v1
Get a specific insight by Id.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| id | path | Yes | string | The unique identifier for the insights report. |
| includeCoordinates | query | No | boolean | Whether to include coordinates for visualization in the response. Defaults to false. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: Insights=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Insight |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Memory Stores
Create memory store
POST {endpoint}/memory_stores?api-version=v1
Create a memory store.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: MemoryStores=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| definition | MemoryStoreDefinition | Base definition for memory store configurations. | Yes | |
| └─ kind | MemoryStoreKind | The kind of the memory store. | Yes | |
| description | string | A human-readable description of the memory store. Constraints: maxLength: 512 |
No | |
| metadata | object | Arbitrary key-value metadata to associate with the memory store. | No | |
| name | string | The name of the memory store. Constraints: maxLength: 256 |
Yes |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | MemoryStoreObject |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
List memory stores
GET {endpoint}/memory_stores?api-version=v1
List all memory stores.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| limit | query | No | integer | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. |
| order | query | No | string Possible values: asc, desc |
Sort order by the created_at timestamp of the objects. asc for ascending order anddescfor descending order. |
| after | query | No | string | 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. |
| before | query | No | string | 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. |
| api-version | query | Yes | string | The API version to use for this operation. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: MemoryStores=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | object | The response data for a requested list of items. |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Update memory store
POST {endpoint}/memory_stores/{name}?api-version=v1
Update a memory store.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| name | path | Yes | string | The name of the memory store to update. |
| api-version | query | Yes | string | The API version to use for this operation. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: MemoryStores=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | A human-readable description of the memory store. Constraints: maxLength: 512 |
No | |
| metadata | object | Arbitrary key-value metadata to associate with the memory store. | No |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | MemoryStoreObject |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Get memory store
GET {endpoint}/memory_stores/{name}?api-version=v1
Retrieve a memory store.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| name | path | Yes | string | The name of the memory store to retrieve. |
| api-version | query | Yes | string | The API version to use for this operation. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: MemoryStores=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | MemoryStoreObject |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Delete memory store
DELETE {endpoint}/memory_stores/{name}?api-version=v1
Delete a memory store.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| name | path | Yes | string | The name of the memory store to delete. |
| api-version | query | Yes | string | The API version to use for this operation. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: MemoryStores=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | DeleteMemoryStoreResponse |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Get update result
GET {endpoint}/memory_stores/{name}/updates/{update_id}?api-version=v1
Get memory store update result.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| name | path | Yes | string | The name of the memory store. |
| update_id | path | Yes | string | The ID of the memory update operation. |
| api-version | query | Yes | string | The API version to use for this operation. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: MemoryStores=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | MemoryStoreUpdateResponse |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Delete scope memories
POST {endpoint}/memory_stores/{name}:delete_scope?api-version=v1
Delete all memories associated with a specific scope from a memory store.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| name | path | Yes | string | The name of the memory store. |
| api-version | query | Yes | string | The API version to use for this operation. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: MemoryStores=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| scope | string | The namespace that logically groups and isolates memories to delete, such as a user ID. | Yes |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | MemoryStoreDeleteScopeResponse |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Search memories
POST {endpoint}/memory_stores/{name}:search_memories?api-version=v1
Search for relevant memories from a memory store based on conversation context.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| name | path | Yes | string | The name of the memory store to search. |
| api-version | query | Yes | string | The API version to use for this operation. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: MemoryStores=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| items | array of OpenAI.InputItem | Items for which to search for relevant memories. | No | |
| options | MemorySearchOptions | Memory search options. | No | |
| └─ max_memories | integer | Maximum number of memory items to return. | No | |
| previous_search_id | string | The unique ID of the previous search request, enabling incremental memory search from where the last operation left off. | No | |
| scope | string | The namespace that logically groups and isolates memories, such as a user ID. | Yes |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | MemoryStoreSearchResponse |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Update memories
POST {endpoint}/memory_stores/{name}:update_memories?api-version=v1
Update memory store with conversation memories.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| name | path | Yes | string | The name of the memory store to update. |
| api-version | query | Yes | string | The API version to use for this operation. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: MemoryStores=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| items | array of OpenAI.InputItem | Conversation items from which to extract memories. | No | |
| previous_update_id | string | The unique ID of the previous update request, enabling incremental memory updates from where the last operation left off. | No | |
| scope | string | The namespace that logically groups and isolates memories, such as a user ID. | Yes | |
| update_delay | integer | Timeout period before processing the memory update in seconds. If a new update request is received during this period, it will cancel the current request and reset the timeout. Set to 0 to immediately trigger the update without delay. Defaults to 300 (5 minutes). |
No | 300 |
Responses
Status Code: 202
Description: The request has been accepted for processing, but processing has not yet completed.
| Content-Type | Type | Description |
|---|---|---|
| application/json | MemoryStoreUpdateResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| Operation-Location | string | The location for monitoring the operation state. |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Conversations
Create conversation
POST {endpoint}/openai/v1/conversations
Create a conversation.
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| items | array of OpenAI.InputItem | No | ||
| metadata | OpenAI.Metadata (nullable) | 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. |
No |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | OpenAI.ConversationResource |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
List conversations
GET {endpoint}/openai/v1/conversations
Returns the list of all conversations.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| limit | query | No | integer | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. |
| order | query | No | string Possible values: asc, desc |
Sort order by the created_at timestamp of the objects. asc for ascending order anddescfor descending order. |
| after | query | No | string | 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. |
| before | query | No | string | 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. |
| agent_name | query | No | string | Filter by agent name. If provided, only items associated with the specified agent will be returned. |
| agent_id | query | No | string | Filter by agent ID in the format name:version. If provided, only items associated with the specified agent ID will be returned. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | object | The response data for a requested list of items. |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Update conversation
POST {endpoint}/openai/v1/conversations/{conversation_id}
Update a conversation.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| conversation_id | path | Yes | string | The id of the conversation to update. |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| metadata | OpenAI.Metadata (nullable) | 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. |
Yes |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | OpenAI.ConversationResource |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Get conversation
GET {endpoint}/openai/v1/conversations/{conversation_id}
Retrieves a conversation.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| conversation_id | path | Yes | string | The id of the conversation to retrieve. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | OpenAI.ConversationResource |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Delete conversation
DELETE {endpoint}/openai/v1/conversations/{conversation_id}
Deletes a conversation.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| conversation_id | path | Yes | string | The id of the conversation to delete. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | OpenAI.DeletedConversationResource |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Create conversation items
POST {endpoint}/openai/v1/conversations/{conversation_id}/items
Create items in a conversation with the given ID.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| conversation_id | path | Yes | string | The id of the conversation on which the item needs to be created. |
| include | query | No | array | Additional fields to include in the response. See the include parameter for listing Conversation items for more information. |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| items | array of OpenAI.Item | The items to add to the conversation. You may add up to 20 items at a time. | Yes |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | OpenAI.ConversationItemList |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
List conversation items
GET {endpoint}/openai/v1/conversations/{conversation_id}/items
List all items for a conversation with the given ID.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| conversation_id | path | Yes | string | The id of the conversation on which the items needs to be listed. |
| limit | query | No | integer | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. |
| order | query | No | string Possible values: asc, desc |
Sort order by the created_at timestamp of the objects. asc for ascending order anddescfor descending order. |
| after | query | No | string | 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. |
| before | query | No | string | 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. |
| item_type | query | No | string Possible values: message, output_message, file_search_call, computer_call, computer_call_output, web_search_call, function_call, function_call_output, reasoning, compaction, image_generation_call, code_interpreter_call, local_shell_call, local_shell_call_output, shell_call, shell_call_output, apply_patch_call, apply_patch_call_output, mcp_list_tools, mcp_approval_request, mcp_approval_response, mcp_call, custom_tool_call_output, custom_tool_call, structured_outputs, oauth_consent_request, memory_search_call, workflow_action |
Filter by item type. If provided, only items of the specified type will be returned. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | object | The response data for a requested list of items. |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Get conversation item
GET {endpoint}/openai/v1/conversations/{conversation_id}/items/{item_id}
Get a single item from a conversation with the given IDs.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| conversation_id | path | Yes | string | The ID of the conversation that contains the item. |
| item_id | path | Yes | string | The id of the conversation item to retrieve. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | OpenAI.OutputItem |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Delete conversation item
DELETE {endpoint}/openai/v1/conversations/{conversation_id}/items/{item_id}
Delete an item from a conversation with the given IDs.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| conversation_id | path | Yes | string | The id of the conversation on which the item needs to be deleted from. |
| item_id | path | Yes | string | The id of the conversation item to delete. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | OpenAI.ConversationResource |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Evals
Evals - list evals
GET {endpoint}/openai/v1/evals
List all evaluations List evaluations for a project.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| after | query | No | string | Identifier for the last run from the previous pagination request. |
| limit | query | No | integer | Number of runs to retrieve. |
| order | query | No | string Possible values: asc, desc |
Sort order for runs by timestamp. Use asc for ascending order or desc for descending order. Defaults to asc. |
| order_by | query | No | string Possible values: created_at, updated_at |
Evals can be ordered by creation time or last updated time. Use created_at for creation time or updated_at for last updated time. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | object | The response data for a requested list of items. |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Evals - create eval
POST {endpoint}/openai/v1/evals
Create evaluation 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
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data_source_config | OpenAI.CreateEvalCustomDataSourceConfig or OpenAI.CreateEvalLogsDataSourceConfig or OpenAI.CreateEvalStoredCompletionsDataSourceConfig or AzureAIDataSourceConfig | The configuration for the data source used for the evaluation runs. Dictates the schema of the data used in the evaluation. | Yes | |
| metadata | OpenAI.Metadata (nullable) | 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. |
No | |
| name | string | The name of the evaluation. | No | |
| properties | object | Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. |
No | |
| testing_criteria | array of OpenAI.EvalGraderLabelModel or OpenAI.EvalGraderStringCheck or OpenAI.EvalGraderTextSimilarity or OpenAI.EvalGraderPython or OpenAI.EvalGraderScoreModel or EvalGraderAzureAIEvaluator | 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}}). |
Yes |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Eval |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Evals - delete eval
DELETE {endpoint}/openai/v1/evals/{eval_id}
Delete an evaluation Delete an evaluation.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| eval_id | path | Yes | string | The ID of the evaluation to delete. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | DeleteEvalResponse |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Evals - get eval
GET {endpoint}/openai/v1/evals/{eval_id}
Get an evaluation Get an evaluation by ID.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| eval_id | path | Yes | string | The ID of the evaluation to retrieve. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Eval |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Evals - update eval
POST {endpoint}/openai/v1/evals/{eval_id}
Update an evaluation Update certain properties of an evaluation.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| eval_id | path | Yes | string | The ID of the evaluation to update. |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| metadata | OpenAI.Metadata (nullable) | 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. |
No | |
| name | string | No | ||
| properties | object | Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. |
No |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Eval |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Evals - list runs
GET {endpoint}/openai/v1/evals/{eval_id}/runs
Get a list of runs for an evaluation Get a list of runs for an evaluation.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| eval_id | path | Yes | string | The ID of the evaluation to retrieve runs for. |
| after | query | No | string | Identifier for the last run from the previous pagination request. |
| limit | query | No | integer | Number of runs to retrieve. |
| order | query | No | string Possible values: asc, desc |
Sort order for runs by timestamp. Use asc for ascending order or desc for descending order. Defaults to asc. |
| status | query | No | string Possible values: queued, in_progress, completed, canceled, failed . Filter runs by status. One of queued, in_progress, failed, completed, canceled. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | object | The response data for a requested list of items. |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Evals - create eval run
POST {endpoint}/openai/v1/evals/{eval_id}/runs
Create evaluation run
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| eval_id | path | Yes | string | The ID of the evaluation to create a run for. |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data_source | OpenAI.CreateEvalJsonlRunDataSource or OpenAI.CreateEvalCompletionsRunDataSource or OpenAI.CreateEvalResponsesRunDataSource or EvalRunDataSource | Details about the run's data source. | Yes | |
| metadata | OpenAI.Metadata (nullable) | 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. |
No | |
| name | string | The name of the run. | No | |
| properties | object | Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. |
No |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | EvalRun |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Evals - delete eval run
DELETE {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}
Delete evaluation run Delete an eval run.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| eval_id | path | Yes | string | The ID of the evaluation to delete the run from. |
| run_id | path | Yes | string | The ID of the run to delete. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | DeleteEvalRunResponse |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Evals - get eval run
GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}
Get an evaluation run Get an evaluation run by ID.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| eval_id | path | Yes | string | The ID of the evaluation to retrieve runs for. |
| run_id | path | Yes | string | The ID of the run to retrieve. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | EvalRun |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Evals - cancel eval run
POST {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}
Cancel evaluation run Cancel an ongoing evaluation run.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| eval_id | path | Yes | string | The ID of the evaluation whose run you want to cancel. |
| run_id | path | Yes | string | The ID of the run to cancel. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | EvalRun |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Evals - get eval run output items
GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items
Get evaluation run output items Get a list of output items for an evaluation run.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| eval_id | path | Yes | string | |
| run_id | path | Yes | string | The ID of the run to retrieve output items for. |
| after | query | No | string | Identifier for the last run from the previous pagination request. |
| limit | query | No | integer | Number of runs to retrieve. |
| order | query | No | string Possible values: asc, desc |
Sort order for runs by timestamp. Use asc for ascending order or desc for descending order. Defaults to asc. |
| status | query | No | string Possible values: fail, pass |
Filter output items by status. Use failed to filter by failed outputitems or pass to filter by passed output items. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | object | The response data for a requested list of items. |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Evals - get eval run output item
GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}
Get an output item of an evaluation run Get an evaluation run output item by ID.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| eval_id | path | Yes | string | The ID of the evaluation to retrieve runs for. |
| run_id | path | Yes | string | The ID of the run to retrieve. |
| output_item_id | path | Yes | string | The ID of the output item to retrieve. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | EvalRunOutputItem |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Fine-Tuning
Create fine tuning job
POST {endpoint}/openai/v1/fine_tuning/jobs?api-version=v1
Creates a fine-tuning job which begins the process of creating a new model from a given dataset.
Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| hyperparameters | OpenAI.CreateFineTuningJobRequestHyperparameters | No | ||
| └─ batch_size | string or OpenAI.integer | No | auto | |
| └─ learning_rate_multiplier | string or OpenAI.numeric | No | ||
| └─ n_epochs | string or OpenAI.integer | No | auto | |
| integrations | array of OpenAI.CreateFineTuningJobRequestIntegrations | A list of integrations to enable for your fine-tuning job. | No | |
| metadata | OpenAI.Metadata (nullable) | 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. |
No | |
| method | OpenAI.FineTuneMethod | The method used for fine-tuning. | No | |
| model | string (see valid models below) | The name of the model to fine-tune. You can select one of the supported models. |
Yes | |
| seed | OpenAI.integer (nullable) | No | ||
| suffix | string (nullable) | 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.Constraints: minLength: 1, maxLength: 64 |
No | |
| training_file | string | The ID of an uploaded file that contains training data. See upload file for how to upload a file. Your dataset must be formatted as a JSONL file. Additionally, you must upload your file with the purpose fine-tune.The contents of the file should differ depending on if the model uses the chat, completions format, or if the fine-tuning method uses the preference format. See the fine-tuning guide for more details. |
Yes | |
| validation_file | string (nullable) | The ID of an uploaded file that contains validation data. If you provide this file, the data is used to generate validation metrics periodically during fine-tuning. These metrics can be viewed in the fine-tuning results file. The same data should not be present in both train and validation files. Your dataset must be formatted as a JSONL file. You must upload your file with the purpose fine-tune.See the fine-tuning guide for more details. |
No |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | OpenAI.FineTuningJob |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
List paginated fine tuning jobs
GET {endpoint}/openai/v1/fine_tuning/jobs?api-version=v1
List your organization's fine-tuning jobs
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| after | query | No | string | Identifier for the last job from the previous pagination request. |
| limit | query | No | integer | Number of fine-tuning jobs to retrieve. |
| api-version | query | Yes | string | The API version to use for this operation. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | OpenAI.ListPaginatedFineTuningJobsResponse |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Retrieve fine tuning job
GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}?api-version=v1
Get info about a fine-tuning job.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| fine_tuning_job_id | path | Yes | string | The ID of the fine-tuning job. |
| api-version | query | Yes | string | The API version to use for this operation. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | OpenAI.FineTuningJob |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Cancel fine tuning job
POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel?api-version=v1
Immediately cancel a fine-tune job.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| fine_tuning_job_id | path | Yes | string | The ID of the fine-tuning job to cancel. |
| api-version | query | Yes | string | The API version to use for this operation. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | OpenAI.FineTuningJob |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
List fine tuning job checkpoints
GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints?api-version=v1
List checkpoints for a fine-tuning job.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| fine_tuning_job_id | path | Yes | string | The ID of the fine-tuning job to get checkpoints for. |
| after | query | No | string | Identifier for the last checkpoint ID from the previous pagination request. |
| limit | query | No | integer | Number of checkpoints to retrieve. |
| api-version | query | Yes | string | The API version to use for this operation. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | OpenAI.ListFineTuningJobCheckpointsResponse |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
List fine tuning job events
GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events?api-version=v1
Get fine-grained status updates for a fine-tuning job.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| fine_tuning_job_id | path | Yes | string | The ID of the fine-tuning job to get events for. |
| after | query | No | string | Identifier for the last event from the previous pagination request. |
| limit | query | No | integer | Number of events to retrieve. |
| api-version | query | Yes | string | The API version to use for this operation. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | OpenAI.ListFineTuningJobEventsResponse |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Pause fine tuning job
POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause?api-version=v1
Pause a running fine-tune job.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| fine_tuning_job_id | path | Yes | string | The ID of the fine-tuning job to pause. |
| api-version | query | Yes | string | The API version to use for this operation. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | OpenAI.FineTuningJob |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Resume fine tuning job
POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume?api-version=v1
Resume a paused fine-tune job.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| fine_tuning_job_id | path | Yes | string | The ID of the fine-tuning job to resume. |
| api-version | query | Yes | string | The API version to use for this operation. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | OpenAI.FineTuningJob |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Responses
Create response - create response stream
POST {endpoint}/openai/v1/responses
Creates a model response. Creates a model response (streaming response).
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| agent_reference | AgentReference | No | ||
| └─ name | string | The name of the agent. Constraints: maxLength: 256 |
Yes | |
| └─ type | enum | Possible values: agent_reference |
Yes | |
| └─ version | string | The version identifier of the agent. | No | |
| background | boolean (nullable) | No | ||
| conversation | OpenAI.ConversationParam (nullable) | The conversation that this response belongs to. Items from this conversation are prepended to input_items for this response request.Input items and output items from this response are automatically added to this conversation after this response completes. |
No | |
| include | array of OpenAI.IncludeEnum | No | ||
| input | OpenAI.InputParam | Text, image, or file inputs to the model, used to generate a response. Learn more: - Text inputs and outputs - Image inputs - File inputs - Conversation state - Function calling |
No | |
| instructions | string (nullable) | No | ||
| max_output_tokens | OpenAI.integer (nullable) | No | ||
| max_tool_calls | OpenAI.integer (nullable) | No | ||
| metadata | OpenAI.Metadata (nullable) | 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. |
No | |
| model | string | The model deployment to use for the creation of this response. | No | |
| parallel_tool_calls | boolean (nullable) | No | True | |
| previous_response_id | string (nullable) | No | ||
| prompt | OpenAI.Prompt | Reference to a prompt template and its variables. Learn more. |
No | |
| prompt_cache_key | string | Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. Learn more. |
No | |
| prompt_cache_retention | enum | Possible values: in-memory, 24h |
No | |
| reasoning | OpenAI.Reasoning (nullable) | gpt-5 and o-series models only Configuration options for reasoning models. |
No | |
| └─ effort | OpenAI.ReasoningEffort | Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducingreasoning effort can result in faster responses and fewer tokens used on reasoning in a response. - 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.- 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. |
No | |
| └─ generate_summary | enum | Possible values: auto, concise, detailed |
No | |
| └─ summary | enum | Possible values: auto, concise, detailed |
No | |
| safety_identifier | string | 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. |
No | |
| service_tier | OpenAI.ServiceTier | 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'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to 'flex' or 'priority', 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. |
No | |
| store | boolean (nullable) | No | True | |
| stream | boolean (nullable) | No | ||
| stream_options | OpenAI.ResponseStreamOptions (nullable) | Options for streaming responses. Only set this when you set stream: true. |
No | |
| └─ include_obfuscation | boolean | When true, stream obfuscation will be enabled. Stream obfuscation adds random characters to an obfuscation field on streaming delta events tonormalize payload sizes as a mitigation to certain side-channel attacks. These obfuscation fields are included by default, but add a small amount of overhead to the data stream. You can set include_obfuscation tofalse to optimize for bandwidth if you trust the network links between your application and the OpenAI API. |
No | |
| structured_inputs | object | The structured inputs to the response that can participate in prompt template substitution or tool argument bindings. | No | |
| temperature | OpenAI.numeric (nullable) | No | 1 | |
| text | OpenAI.ResponseTextParam | Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more: - Text inputs and outputs - Structured Outputs |
No | |
| tool_choice | OpenAI.ToolChoiceOptions or OpenAI.ToolChoiceParam | No | ||
| tools | OpenAI.ToolsArray | An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter.We support the following categories of tools: - Built-in tools: Tools that are provided by OpenAI that extend the model's capabilities, like web search or file search. Learn more about built-in tools. - MCP Tools: Integrations with third-party systems via custom MCP servers or predefined connectors such as Google Drive and SharePoint. Learn more about MCP Tools. - Function calls (custom tools): Functions that are defined by you, enabling the model to call your own code with strongly typed arguments and outputs. Learn more about function calling. You can also use custom tools to call your own code. |
No | |
| top_logprobs | OpenAI.integer (nullable) | No | ||
| top_p | OpenAI.numeric (nullable) | No | 1 | |
| truncation | enum | Possible values: auto, disabled |
No | |
| user | string (deprecated) | 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. |
No |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | OpenAI.Response | |
| text/event-stream | OpenAI.CreateResponseStreamingResponse |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
List responses
GET {endpoint}/openai/v1/responses
Returns the list of all responses.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| limit | query | No | integer | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. |
| order | query | No | string Possible values: asc, desc |
Sort order by the created_at timestamp of the objects. asc for ascending order anddescfor descending order. |
| after | query | No | string | 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. |
| before | query | No | string | 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. |
| agent_name | query | No | string | Filter by agent name. If provided, only items associated with the specified agent will be returned. |
| agent_id | query | No | string | Filter by agent ID in the format name:version. If provided, only items associated with the specified agent ID will be returned. |
| conversation_id | query | No | string | Filter by conversation ID. If provided, only responses associated with the specified conversation will be returned. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | object | The response data for a requested list of items. |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Compact response conversation
POST {endpoint}/openai/v1/responses/compact
Produces a compaction of a responses conversation.
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| input | string or array of OpenAI.InputItem | No | ||
| instructions | string (nullable) | No | ||
| model | OpenAI.ModelIdsCompaction | 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 to browse and compare available models. |
Yes | |
| previous_response_id | string (nullable) | No |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | OpenAI.CompactResource |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Get response - get response stream
GET {endpoint}/openai/v1/responses/{response_id}
Retrieves a model response with the given ID. Retrieves a model response with the given ID (streaming response).
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| response_id | path | Yes | string | |
| include[] | query | No | array | |
| stream | query | No | boolean | |
| starting_after | query | No | integer |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| accept | False | string Possible values: text/event-stream |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | OpenAI.Response | |
| text/event-stream | OpenAI.CreateResponseStreamingResponse |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Delete response
DELETE {endpoint}/openai/v1/responses/{response_id}
Deletes a model response.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| response_id | path | Yes | string | The ID of the response to delete. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | DeleteResponseResult |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Cancel response
POST {endpoint}/openai/v1/responses/{response_id}/cancel
Cancels a model response.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| response_id | path | Yes | string | The ID of the response to cancel. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | OpenAI.Response |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
List input items
GET {endpoint}/openai/v1/responses/{response_id}/input_items
Returns a list of input items for a given response.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| response_id | path | Yes | string | |
| limit | query | No | integer | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. |
| order | query | No | string Possible values: asc, desc |
Sort order by the created_at timestamp of the objects. asc for ascending order anddescfor descending order. |
| after | query | No | string | 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. |
| before | query | No | string | 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. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | object | The response data for a requested list of items. |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Redteams
Redteams - list
GET {endpoint}/redTeams/runs?api-version=v1
List a redteam by name.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: RedTeams=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | PagedRedTeam |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Redteams - get
GET {endpoint}/redTeams/runs/{name}?api-version=v1
Get a redteam by name.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| name | path | Yes | string | Identifier of the red team run. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: RedTeams=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | RedTeam |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Redteams - create
POST {endpoint}/redTeams/runs:run?api-version=v1
Creates a redteam run.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: RedTeams=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| applicationScenario | string | Application scenario for the red team operation, to generate scenario specific attacks. | No | |
| attackStrategies | array of AttackStrategy | List of attack strategies or nested lists of attack strategies. | No | |
| displayName | string | Name of the red-team run. | No | |
| id | string (read-only) | Identifier of the red team run. | Yes | |
| numTurns | integer | Number of simulation rounds. | No | |
| properties | object | Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. | No | |
| riskCategories | array of RiskCategory | List of risk categories to generate attack objectives for. | No | |
| simulationOnly | boolean | Simulation-only or Simulation + Evaluation. Default false, if true the scan outputs conversation not evaluation result. | No | False |
| status | string (read-only) | Status of the red-team. It is set by service and is read-only. | No | |
| tags | object | Red team's tags. Unlike properties, tags are fully mutable. | No | |
| target | TargetConfig | Abstract class for target configuration. | Yes | |
| └─ type | string | Type of the model configuration. | Yes |
Responses
Status Code: 201
Description: The request has succeeded and a new resource has been created as a result.
| Content-Type | Type | Description |
|---|---|---|
| application/json | RedTeam |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Schedules
Schedules - list
GET {endpoint}/schedules?api-version=v1
List all schedules.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| type | query | No | string Possible values: Evaluation, Insight |
Filter by the type of schedule. |
| enabled | query | No | boolean | Filter by the enabled status. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: Schedules=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | PagedSchedule |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Schedules - delete
DELETE {endpoint}/schedules/{id}?api-version=v1
Delete a schedule.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| id | path | Yes | string | Identifier of the schedule. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: Schedules=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Responses
Status Code: 204
Description: There is no content to send for this request, but the headers may be useful.
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Schedules - get
GET {endpoint}/schedules/{id}?api-version=v1
Get a schedule by id.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| id | path | Yes | string | Identifier of the schedule. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: Schedules=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Schedule |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Schedules - create or update
PUT {endpoint}/schedules/{id}?api-version=v1
Create or update operation template.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| id | path | Yes | string | Identifier of the schedule. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: Schedules=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | Description of the schedule. | No | |
| displayName | string | Name of the schedule. | No | |
| enabled | boolean | Enabled status of the schedule. | Yes | |
| id | string (read-only) | Identifier of the schedule. | Yes | |
| properties | object | Schedule's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. | No | |
| provisioningStatus | ScheduleProvisioningStatus (read-only) | Schedule provisioning status. | No | |
| systemData | object (read-only) | System metadata for the resource. | Yes | |
| tags | object | Schedule's tags. Unlike properties, tags are fully mutable. | No | |
| task | ScheduleTask | Schedule task model. | Yes | |
| └─ configuration | object | Configuration for the task. | No | |
| └─ type | ScheduleTaskType | Type of the task. | Yes | |
| trigger | Trigger | Base model for Trigger of the schedule. | Yes | |
| └─ type | TriggerType | Type of the trigger. | Yes |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Schedule |
Status Code: 201
Description: The request has succeeded and a new resource has been created as a result.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Schedule |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Schedules - list runs
GET {endpoint}/schedules/{id}/runs?api-version=v1
List all schedule runs.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| api-version | query | Yes | string | The API version to use for this operation. |
| id | path | Yes | string | Identifier of the schedule. |
| type | query | No | string Possible values: Evaluation, Insight |
Filter by the type of schedule. |
| enabled | query | No | boolean | Filter by the enabled status. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: Schedules=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | PagedScheduleRun |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Response Headers:
| Header | Type | Description |
|---|---|---|
| x-ms-error-code | string | String error code indicating what went wrong. |
Schedules - get run
GET {endpoint}/schedules/{schedule_id}/runs/{run_id}?api-version=v1
Get a schedule run by id.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string | Foundry Project endpoint in the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". If you only have one Project in your Foundry Hub, or to target the default Project in your Hub, use the form "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project" |
| schedule_id | path | Yes | string | The unique identifier of the schedule. |
| run_id | path | Yes | string | The unique identifier of the schedule run. |
| api-version | query | Yes | string | The API version to use for this operation. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Foundry-Features | True | string Possible values: Schedules=V1Preview |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Responses
Status Code: 200
Description: The request has succeeded.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ScheduleRun |
Status Code: default
Description: An unexpected error response.
| Content-Type | Type | Description |
|---|---|---|
| application/json | ApiErrorResponse |
Components
A2APreviewTool
An agent implementing the A2A protocol.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| agent_card_path | string | The path to the agent card relative to the base_url.If not provided, defaults to /.well-known/agent-card.json |
No | |
| base_url | string | Base URL of the agent. | No | |
| project_connection_id | 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. |
No | |
| type | enum | The type of the tool. Always "a2a_preview.Possible values: a2a_preview |
Yes |
AISearchIndexResource
A AI Search Index resource.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| filter | string | filter string for search resource. Learn more here. | No | |
| index_asset_id | string | Index asset id for search resource. | No | |
| index_name | string | The name of an index in an IndexResource attached to this agent. | No | |
| project_connection_id | string | An index connection ID in an IndexResource attached to this agent. | No | |
| query_type | AzureAISearchQueryType | Available query types for Azure AI Search tool. | No | |
| top_k | integer | Number of documents to retrieve from search and present to the model. | No |
AgentClusterInsightRequest
Insights on set of Agent Evaluation Results
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| agentName | string | Identifier for the agent. | Yes | |
| modelConfiguration | InsightModelConfiguration | Configuration of the model used in the insight generation. | No | |
| └─ modelDeploymentName | string | The model deployment to be evaluated. Accepts either the deployment name alone or with the connection name as {connectionName}/<modelDeploymentName>. |
Yes | |
| type | enum | The type of request. Possible values: AgentClusterInsight |
Yes |
AgentClusterInsightResult
Insights from the agent cluster analysis.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| clusterInsight | ClusterInsightResult | Insights from the cluster analysis. | Yes | |
| type | enum | The type of insights result. Possible values: AgentClusterInsight |
Yes |
AgentContainerObject
The details of the container of a specific version of an agent.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| container | ContainerDetails (read-only) | Detailed information about the container. | No | |
| └─ health_state | string | The health state of the container. | Yes | |
| └─ provisioning_error | string | The provisioning error of the container, if any. | No | |
| └─ provisioning_state | string | The provisioning state of the container. | Yes | |
| └─ replicas | array of ContainerReplica | The list of replicas in the container. | Yes | |
| └─ state | string | The state of the container. | Yes | |
| └─ updated_on | string | The last update time of the container. | Yes | |
| created_at | string | The creation time of the container. | Yes | |
| error_message | string (read-only) | The error message if the container failed to operate, if any. | No | |
| id | string (read-only) | The identifier of the container. | No | |
| max_replicas | integer | The maximum number of replicas for the container. Default is 1. | No | |
| min_replicas | integer | The minimum number of replicas for the container. Default is 1. | No | |
| object | enum | The object type, which is always 'agent.container'. Possible values: agent.container |
Yes | |
| status | AgentContainerStatus (read-only) | Status of the container of a specific version of an agent. | Yes | |
| updated_at | string | The last update time of the container. | Yes |
AgentContainerOperationError
The error details of the container operation, if any.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| code | string | The error code of the container operation, if any. | Yes | |
| message | string | The error message of the container operation, if any. | Yes | |
| type | string | The error type of the container operation, if any. | Yes |
AgentContainerOperationObject
The container operation for a specific version of an agent.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| agent_id | string | The ID of the agent. | Yes | |
| agent_version_id | string | The ID of the agent version. | Yes | |
| container | AgentContainerObject | The details of the container of a specific version of an agent. | No | |
| └─ container | ContainerDetails (read-only) | The detailed container information. | No | |
| └─ created_at | string (read-only) | The creation time of the container. | Yes | |
| └─ error_message | string (read-only) | The error message if the container failed to operate, if any. | No | |
| └─ id | string (read-only) | The identifier of the container. | No | |
| └─ max_replicas | integer | The maximum number of replicas for the container. Default is 1. | No | |
| └─ min_replicas | integer | The minimum number of replicas for the container. Default is 1. | No | |
| └─ object | enum | The object type, which is always 'agent.container'. Possible values: agent.container |
Yes | |
| └─ status | AgentContainerStatus (read-only) | The status of the container of a specific version of an agent. | Yes | |
| └─ updated_at | string (read-only) | The last update time of the container. | Yes | |
| error | AgentContainerOperationError | The error details of the container operation, if any. | No | |
| └─ code | string | The error code of the container operation, if any. | Yes | |
| └─ message | string | The error message of the container operation, if any. | Yes | |
| └─ type | string | The error type of the container operation, if any. | Yes | |
| id | string | The ID of the container operation. This id is unique identifier across the system. | Yes | |
| status | AgentContainerOperationStatus | Status of the container operation for a specific version of an agent. | Yes |
AgentContainerOperationStatus
Status of the container operation for a specific version of an agent.
| Property | Value |
|---|---|
| Type | string |
| Values | NotStartedInProgressSucceededFailed |
AgentContainerStatus
Status of the container of a specific version of an agent.
| Property | Value |
|---|---|
| Type | string |
| Values | StartingRunningStoppingStoppedFailedDeletingDeletedUpdating |
AgentDefinition
Discriminator for AgentDefinition
This component uses the property kind to discriminate between different types:
| Type Value | Schema |
|---|---|
prompt |
PromptAgentDefinition |
workflow |
WorkflowAgentDefinition |
hosted |
HostedAgentDefinition |
container_app |
ContainerAppAgentDefinition |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| kind | AgentKind | Yes | ||
| rai_config | RaiConfig | Configuration for Responsible AI (RAI) content filtering and safety features. | No | |
| └─ rai_policy_name | string | The name of the RAI policy to apply. | Yes |
AgentKind
| Property | Value |
|---|---|
| Type | string |
| Values | prompthostedcontainer_appworkflow |
AgentObject
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| id | string | The unique identifier of the agent. | Yes | |
| name | string | The name of the agent. Constraints: maxLength: 63 |
Yes | |
| object | enum | The object type, which is always 'agent'. Possible values: agent |
Yes | |
| versions | object | The latest version of the agent. | Yes | |
| └─ latest | AgentVersionObject | Yes |
AgentProtocol
| Property | Value |
|---|---|
| Type | string |
| Values | activity_protocolresponses |
AgentReference
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| name | string | The name of the agent. Constraints: maxLength: 256 |
Yes | |
| type | enum | Possible values: agent_reference |
Yes | |
| version | string | The version identifier of the agent. | No |
AgentTaxonomyInput
Input configuration for the evaluation taxonomy when the input type is agent.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| riskCategories | array of RiskCategory | List of risk categories to evaluate against. | Yes | |
| target | Target | Base class for targets with discriminator support. | Yes | |
| └─ type | string | The type of target. | Yes | |
| type | enum | Input type of the evaluation taxonomy. Possible values: agent |
Yes |
AgentTaxonomyInputUpdate
Input configuration for the evaluation taxonomy when the input type is agent.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| riskCategories | array of RiskCategory | List of risk categories to evaluate against. | No | |
| target | TargetUpdate | Base class for targets with discriminator support. | No | |
| └─ type | string | The type of target. | Yes | |
| type | enum | Input type of the evaluation taxonomy. Possible values: agent |
Yes |
AgentVersionObject
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| created_at | integer | The Unix timestamp (seconds) when the agent was created. | Yes | |
| definition | AgentDefinition | Yes | ||
| description | string | A human-readable description of the agent. Constraints: maxLength: 512 |
No | |
| id | string | The unique identifier of the agent version. | Yes | |
| metadata | object (nullable) | 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. |
Yes | |
| name | string | The name of the agent. Name can be used to retrieve/update/delete the agent. Constraints: maxLength: 256 |
Yes | |
| object | enum | The object type, which is always 'agent.version'. Possible values: agent.version |
Yes | |
| version | string | The version identifier of the agent. Agents are immutable and every update creates a new version while keeping the name same. | Yes |
AgenticIdentityPreviewCredentials
Agentic identity credential definition
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | The credential type Possible values: AgenticIdentityToken_Preview |
Yes |
ApiErrorResponse
Error response for API failures.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| error | OpenAI.Error | Yes |
ApiKeyCredentials
API Key Credential definition
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| key | string (read-only) | API Key | No | |
| type | enum | The credential type Possible values: ApiKey |
Yes |
AssetCredentialResponse
Represents a reference to a blob for consumption
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| blobReference | BlobReference | Blob reference details. | Yes | |
| └─ blobUri | string | Blob URI path for client to upload data. Example: https://blob.windows.core.net/Container/Path |
Yes | |
| └─ credential | SasCredential | Credential info to access the storage account. | Yes | |
| └─ storageAccountArmId | string | ARM ID of the storage account to use. | Yes |
AssetId
Identifier of a saved asset.
Type: string
AttackStrategy
Strategies for attacks.
| Property | Value |
|---|---|
| Description | Strategies for attacks. |
| Type | string |
| Values | easymoderatedifficultascii_artascii_smuggleratbashbase64binarycaesarcharacter_spacejailbreakansi_attackcharacter_swapsuffix_appendstring_joinunicode_confusableunicode_substitutiondiacriticflipleetspeakrot13morseurlbaselineindirect_jailbreaktensemulti_turncrescendo |
Azure.Core.Foundations.Error
The error object.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| code | string | One of a server-defined set of error codes. | Yes | |
| details | array of Azure.Core.Foundations.Error | An array of details about specific errors that led to this reported error. | No | |
| innererror | Azure.Core.Foundations.InnerError | An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors. | No | |
| └─ code | string | One of a server-defined set of error codes. | No | |
| └─ innererror | Azure.Core.Foundations.InnerError | Inner error. | No | |
| message | string | A human-readable representation of the error. | Yes | |
| target | string | The target of the error. | No |
Azure.Core.Foundations.ErrorResponse
A response containing error details.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| error | Azure.Core.Foundations.Error | The error object. | Yes | |
| └─ code | string | One of a server-defined set of error codes. | Yes | |
| └─ details | array of Azure.Core.Foundations.Error | An array of details about specific errors that led to this reported error. | No | |
| └─ innererror | Azure.Core.Foundations.InnerError | An object containing more specific information than the current object about the error. | No | |
| └─ message | string | A human-readable representation of the error. | Yes | |
| └─ target | string | The target of the error. | No |
Azure.Core.Foundations.InnerError
An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| code | string | One of a server-defined set of error codes. | No | |
| innererror | Azure.Core.Foundations.InnerError | An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors. | No | |
| └─ code | string | One of a server-defined set of error codes. | No | |
| └─ innererror | Azure.Core.Foundations.InnerError | Inner error. | No |
Azure.Core.Foundations.OperationState
Enum describing allowed operation states.
| Property | Value |
|---|---|
| Description | Enum describing allowed operation states. |
| Type | string |
| Values | NotStartedRunningSucceededFailedCanceled |
Azure.Core.uuid
Universally Unique Identifier
Type: string
Format: uuid
AzureAIAgentTarget
Represents a target specifying an Azure AI agent.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| name | string | The unique identifier of the Azure AI agent. | Yes | |
| tool_descriptions | array of ToolDescription | The parameters used to control the sampling behavior of the agent during text generation. | No | |
| type | enum | The type of target, always azure_ai_agent.Possible values: azure_ai_agent |
Yes | |
| version | string | The version of the Azure AI agent. | No |
AzureAIAgentTargetUpdate
Represents a target specifying an Azure AI agent.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| name | string | The unique identifier of the Azure AI agent. | No | |
| tool_descriptions | array of ToolDescription | The parameters used to control the sampling behavior of the agent during text generation. | No | |
| type | enum | The type of target, always azure_ai_agent.Possible values: azure_ai_agent |
Yes | |
| version | string | The version of the Azure AI agent. | No |
AzureAIDataSourceConfig
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| scenario | enum | Data schema scenario. Possible values: red_team, responses, traces_preview, synthetic_data_gen_preview |
Yes | |
| schema | object | The overall object JSON schema for the run data source items. | Yes | |
| type | enum | The object type, which is always azure_ai_source.Possible values: azure_ai_source |
Yes |
AzureAIModelTarget
Represents a target specifying an Azure AI model for operations requiring model selection.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| model | string | The unique identifier of the Azure AI model. | No | |
| sampling_params | ModelSamplingParams | Represents a set of parameters used to control the sampling behavior of a language model during text generation. | No | |
| └─ max_completion_tokens | integer | The maximum number of tokens allowed in the completion. | Yes | |
| └─ seed | integer | The random seed for reproducibility. | Yes | |
| └─ temperature | number | The temperature parameter for sampling. | Yes | |
| └─ top_p | number | The top-p parameter for nucleus sampling. | Yes | |
| type | enum | The type of target, always azure_ai_model.Possible values: azure_ai_model |
Yes |
AzureAIModelTargetUpdate
Represents a target specifying an Azure AI model for operations requiring model selection.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| model | string | The unique identifier of the Azure AI model. | No | |
| sampling_params | ModelSamplingParamsUpdate | Represents a set of parameters used to control the sampling behavior of a language model during text generation. | No | |
| └─ max_completion_tokens | integer | The maximum number of tokens allowed in the completion. | No | |
| └─ seed | integer | The random seed for reproducibility. | No | |
| └─ temperature | number | The temperature parameter for sampling. | No | |
| └─ top_p | number | The top-p parameter for nucleus sampling. | No | |
| type | enum | The type of target, always azure_ai_model.Possible values: azure_ai_model |
Yes |
AzureAIResponsesEvalRunDataSource
Represents a data source for evaluation runs that are specific to Continuous Evaluation scenarios.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| event_configuration_id | string | The event configuration name associated with this evaluation run. | Yes | |
| item_generation_params | ResponseRetrievalItemGenerationParams | Represents the parameters for response retrieval item generation. | Yes | |
| └─ data_mapping | object | Mapping from source fields to response_id field, required for retrieving chat history. | Yes | |
| └─ max_num_turns | integer | The maximum number of turns of chat history to evaluate. | Yes | |
| └─ source | OpenAI.EvalJsonlFileContentSource or OpenAI.EvalJsonlFileIdSource | The source from which JSONL content is read. | Yes | |
| └─ type | enum | The type of item generation parameters, always response_retrieval.Possible values: response_retrieval |
Yes | |
| max_runs_hourly | integer | Maximum number of evaluation runs allowed per hour. | Yes | |
| type | enum | The type of data source, always azure_ai_responses.Possible values: azure_ai_responses |
Yes |
AzureAISearchIndex
Azure AI Search Index Definition
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| id | string (read-only) | Asset ID, a unique identifier for the asset | No | |
| name | string (read-only) | The name of the resource | Yes | |
| type | enum | Type of index Possible values: AzureSearch |
Yes | |
| version | string (read-only) | The version of the resource | Yes |
AzureAISearchIndexUpdate
Azure AI Search Index Definition
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | The asset description text. | No | |
| tags | object | Tag dictionary. Tags can be added, removed, and updated. | No | |
| type | enum | Type of index Possible values: AzureSearch |
Yes |
AzureAISearchQueryType
Available query types for Azure AI Search tool.
| Property | Value |
|---|---|
| Description | Available query types for Azure AI Search tool. |
| Type | string |
| Values | simplesemanticvectorvector_simple_hybridvector_semantic_hybrid |
AzureAISearchTool
The input definition information for an Azure AI search tool as used to configure an agent.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| azure_ai_search | AzureAISearchToolResource | A set of index resources used by the azure_ai_search tool. |
Yes | |
| └─ indexes | array of AISearchIndexResource | The indices attached to this agent. There can be a maximum of 1 index resource attached to the agent. Constraints: maxItems: 1 |
Yes | |
| type | enum | The object type, which is always 'azure_ai_search'. Possible values: azure_ai_search |
Yes |
AzureAISearchToolResource
A set of index resources used by the azure_ai_search tool.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| indexes | array of AISearchIndexResource | The indices attached to this agent. There can be a maximum of 1 index resource attached to the agent. |
Yes |
AzureFunctionBinding
The structure for keeping storage queue name and URI.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| storage_queue | AzureFunctionStorageQueue | The structure for keeping storage queue name and URI. | Yes | |
| └─ queue_name | string | The name of an Azure function storage queue. | Yes | |
| └─ queue_service_endpoint | string | URI to the Azure Storage Queue service allowing you to manipulate a queue. | Yes | |
| type | enum | The type of binding, which is always 'storage_queue'. Possible values: storage_queue |
Yes |
AzureFunctionDefinition
The definition of Azure function.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| function | object | The definition of azure function and its parameters. | Yes | |
| └─ description | string | A description of what the function does, used by the model to choose when and how to call the function. | No | |
| └─ name | string | The name of the function to be called. | Yes | |
| └─ parameters | object | The parameters the functions accepts, described as a JSON Schema object. | Yes | |
| input_binding | AzureFunctionBinding | The structure for keeping storage queue name and URI. | Yes | |
| └─ storage_queue | AzureFunctionStorageQueue | Storage queue. | Yes | |
| └─ type | enum | The type of binding, which is always 'storage_queue'. Possible values: storage_queue |
Yes | |
| output_binding | AzureFunctionBinding | The structure for keeping storage queue name and URI. | Yes | |
| └─ storage_queue | AzureFunctionStorageQueue | Storage queue. | Yes | |
| └─ type | enum | The type of binding, which is always 'storage_queue'. Possible values: storage_queue |
Yes |
AzureFunctionStorageQueue
The structure for keeping storage queue name and URI.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| queue_name | string | The name of an Azure function storage queue. | Yes | |
| queue_service_endpoint | string | URI to the Azure Storage Queue service allowing you to manipulate a queue. | Yes |
AzureFunctionTool
The input definition information for an Azure Function Tool, as used to configure an Agent.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| azure_function | AzureFunctionDefinition | The definition of Azure function. | Yes | |
| └─ function | object | The definition of azure function and its parameters. | Yes | |
| └─ description | string | A description of what the function does, used by the model to choose when and how to call the function. | No | |
| └─ name | string | The name of the function to be called. | Yes | |
| └─ parameters | object | The parameters the functions accepts, described as a JSON Schema object. | Yes | |
| └─ input_binding | AzureFunctionBinding | Input storage queue. The queue storage trigger runs a function as messages are added to it. | Yes | |
| └─ output_binding | AzureFunctionBinding | Output storage queue. The function writes output to this queue when the input items are processed. | Yes | |
| type | enum | The object type, which is always 'browser_automation'. Possible values: azure_function |
Yes |
AzureOpenAIModelConfiguration
Azure OpenAI model configuration. The API version would be selected by the service for querying the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| modelDeploymentName | string | Deployment name for AOAI model. Example: gpt-4o if in AIServices or connection based connection_name/deployment_name (e.g. my-aoai-connection/gpt-4o). |
Yes | |
| type | enum | Possible values: AzureOpenAIModel |
Yes |
BaseCredentials
A base class for connection credentials
Discriminator for BaseCredentials
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
ApiKey |
ApiKeyCredentials |
AAD |
EntraIDCredentials |
CustomKeys |
CustomCredential |
SAS |
SASCredentials |
None |
NoAuthenticationCredentials |
AgenticIdentityToken_Preview |
AgenticIdentityPreviewCredentials |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | CredentialType (read-only) | The credential type used by the connection | Yes |
BingCustomSearchConfiguration
A bing custom search configuration.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| count | integer | The number of search results to return in the bing api response | No | |
| freshness | string | Filter search results by a specific time range. See accepted values here. | No | |
| instance_name | string | Name of the custom configuration instance given to config. | Yes | |
| market | string | The market where the results come from. | No | |
| project_connection_id | string | Project connection id for grounding with bing search | Yes | |
| set_lang | string | The language to use for user interface strings when calling Bing API. | No |
BingCustomSearchPreviewTool
The input definition information for a Bing custom search tool as used to configure an agent.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| bing_custom_search_preview | BingCustomSearchToolParameters | The bing custom search tool parameters. | Yes | |
| └─ search_configurations | array of BingCustomSearchConfiguration | The project connections attached to this tool. There can be a maximum of 1 connection resource attached to the tool. Constraints: maxItems: 1 |
Yes | |
| type | enum | The object type, which is always 'bing_custom_search_preview'. Possible values: bing_custom_search_preview |
Yes |
BingCustomSearchToolParameters
The bing custom search tool parameters.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| search_configurations | array of BingCustomSearchConfiguration | The project connections attached to this tool. There can be a maximum of 1 connection resource attached to the tool. |
Yes |
BingGroundingSearchConfiguration
Search configuration for Bing Grounding
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| count | integer | The number of search results to return in the bing api response | No | |
| freshness | string | Filter search results by a specific time range. See accepted values here. | No | |
| market | string | The market where the results come from. | No | |
| project_connection_id | string | Project connection id for grounding with bing search | Yes | |
| set_lang | string | The language to use for user interface strings when calling Bing API. | No |
BingGroundingSearchToolParameters
The bing grounding search tool parameters.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| search_configurations | array of BingGroundingSearchConfiguration | The search configurations attached to this tool. There can be a maximum of 1 search configuration resource attached to the tool. |
Yes |
BingGroundingTool
The input definition information for a bing grounding search tool as used to configure an agent.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| bing_grounding | BingGroundingSearchToolParameters | The bing grounding search tool parameters. | Yes | |
| └─ search_configurations | array of BingGroundingSearchConfiguration | The search configurations attached to this tool. There can be a maximum of 1 search configuration resource attached to the tool. Constraints: maxItems: 1 |
Yes | |
| type | enum | The object type, which is always 'bing_grounding'. Possible values: bing_grounding |
Yes |
BlobReference
Blob reference details.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| blobUri | string | Blob URI path for client to upload data. Example: https://blob.windows.core.net/Container/Path |
Yes | |
| credential | SasCredential | SAS Credential definition | Yes | |
| └─ sasUri | string (read-only) | SAS uri | Yes | |
| └─ type | enum | Type of credential Possible values: SAS |
Yes | |
| storageAccountArmId | string | ARM ID of the storage account to use. | Yes |
BrowserAutomationPreviewTool
The input definition information for a Browser Automation Tool, as used to configure an Agent.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| browser_automation_preview | BrowserAutomationToolParameters | Definition of input parameters for the Browser Automation Tool. | Yes | |
| └─ connection | BrowserAutomationToolConnectionParameters | The project connection parameters associated with the Browser Automation Tool. | Yes | |
| type | enum | The object type, which is always 'browser_automation_preview'. Possible values: browser_automation_preview |
Yes |
BrowserAutomationToolConnectionParameters
Definition of input parameters for the connection used by the Browser Automation Tool.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| project_connection_id | string | The ID of the project connection to your Azure Playwright resource. | Yes |
BrowserAutomationToolParameters
Definition of input parameters for the Browser Automation Tool.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| connection | BrowserAutomationToolConnectionParameters | Definition of input parameters for the connection used by the Browser Automation Tool. | Yes | |
| └─ project_connection_id | string | The ID of the project connection to your Azure Playwright resource. | Yes |
CaptureStructuredOutputsTool
A tool for capturing structured outputs
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| outputs | StructuredOutputDefinition | A structured output that can be produced by the agent. | Yes | |
| └─ description | string | A description of the output to emit. Used by the model to determine when to emit the output. | Yes | |
| └─ name | string | The name of the structured output. | Yes | |
| └─ schema | object | The JSON schema for the structured output. | Yes | |
| └─ strict | boolean (nullable) | Whether to enforce strict validation. Default true. |
Yes | |
| type | enum | The type of the tool. Always capture_structured_outputs.Possible values: capture_structured_outputs |
Yes |
ChartCoordinate
Coordinates for the analysis chart.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| size | integer | Size of the chart element. | Yes | |
| x | integer | X-axis coordinate. | Yes | |
| y | integer | Y-axis coordinate. | Yes |
ChatSummaryMemoryItem
A memory item containing a summary extracted from conversations.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | string | The content of the memory. | Yes | |
| kind | enum | The kind of the memory item. Possible values: chat_summary |
Yes | |
| memory_id | string | The unique ID of the memory item. | Yes | |
| scope | string | The namespace that logically groups and isolates memories, such as a user ID. | Yes | |
| updated_at | integer | The last update time of the memory item. | Yes |
ClusterInsightResult
Insights from the cluster analysis.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| clusters | array of InsightCluster | List of clusters identified in the insights. | Yes | |
| coordinates | object | Optional mapping of IDs to 2D coordinates used by the UX for visualization. The map keys are string identifiers (for example, a cluster id or a sample id) and the values are the coordinates and visual size for rendering on a 2D chart. This property is omitted unless the client requests coordinates (for example, by passing includeCoordinates=true as a query parameter).Example: <br> {<br> "cluster-1": { "x": 12, "y": 34, "size": 8 },<br> "sample-123": { "x": 18, "y": 22, "size": 4 }<br> }<br> Coordinates are intended only for client-side visualization and do not modify the canonical insights results. |
No | |
| summary | InsightSummary | Summary of the error cluster analysis. | Yes | |
| └─ method | string | Method used for clustering. | Yes | |
| └─ sampleCount | integer | Total number of samples analyzed. | Yes | |
| └─ uniqueClusterCount | integer | Total number of unique clusters. | Yes | |
| └─ uniqueSubclusterCount | integer | Total number of unique subcluster labels. | Yes | |
| └─ usage | ClusterTokenUsage | Token usage while performing clustering analysis | Yes |
ClusterTokenUsage
Token usage for cluster analysis
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| inputTokenUsage | integer | input token usage | Yes | |
| outputTokenUsage | integer | output token usage | Yes | |
| totalTokenUsage | integer | total token usage | Yes |
CodeBasedEvaluatorDefinition
Code-based evaluator definition using python code
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| code_text | string | Inline code text for the evaluator | Yes | |
| data_schema | object | The JSON schema (Draft 2020-12) for the evaluator's input data. This includes parameters like type, properties, required. | No | |
| init_parameters | object | The JSON schema (Draft 2020-12) for the evaluator's input parameters. This includes parameters like type, properties, required. | No | |
| metrics | object | List of output metrics produced by this evaluator | No | |
| type | enum | Possible values: code |
Yes |
CompletionMessageToolCallChunk
Tool call details within a message.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| function | FunctionToolCall | Details of a function tool call. | No | |
| └─ arguments | string | The arguments to call the function with, as generated by the model in JSON format. | Yes | |
| └─ name | string | The name of the function to call. | Yes | |
| id | string | The Id for the tool call. | Yes | |
| type | enum | The type of tool call, which is always "function". Possible values: function |
Yes |
Connection
Response from the list and get connections operations
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| credentials | BaseCredentials (read-only) | A base class for connection credentials | Yes | |
| └─ type | CredentialType (read-only) | The type of credential used by the connection | Yes | |
| id | string (read-only) | A unique identifier for the connection, generated by the service | Yes | |
| isDefault | boolean (read-only) | Whether the connection is tagged as the default connection of its type | Yes | |
| metadata | object (read-only) | Metadata of the connection | Yes | |
| name | string (read-only) | The friendly name of the connection, provided by the user. | Yes | |
| target | string (read-only) | The connection URL to be used for this service | Yes | |
| type | ConnectionType (read-only) | The Type (or category) of the connection | Yes |
ConnectionType
The Type (or category) of the connection
| Property | Value |
|---|---|
| Description | The Type (or category) of the connection |
| Type | string |
| Values | AzureOpenAIAzureBlobAzureStorageAccountCognitiveSearchCosmosDBApiKeyAppConfigAppInsightsCustomKeysRemoteTool_Preview |
ContainerAppAgentDefinition
The container app agent definition.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| container_app_resource_id | string | The resource ID of the Azure Container App that hosts this agent. Not mutable across versions. | Yes | |
| container_protocol_versions | array of ProtocolVersionRecord | The protocols that the agent supports for ingress communication of the containers. | Yes | |
| ingress_subdomain_suffix | string | 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. | Yes | |
| kind | enum | Possible values: container_app |
Yes | |
| rai_config | RaiConfig | Configuration for Responsible AI (RAI) content filtering and safety features. | No | |
| └─ rai_policy_name | string | The name of the RAI policy to apply. | Yes |
ContainerDetails
Detailed information about the container.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| health_state | string | The health state of the container. | Yes | |
| provisioning_error | string | The provisioning error of the container, if any. | No | |
| provisioning_state | string | The provisioning state of the container. | Yes | |
| replicas | array of ContainerReplica | The list of replicas in the container. | Yes | |
| state | string | The state of the container. | Yes | |
| updated_on | string | The last update time of the container. | Yes |
ContainerLogKind
The type of logs to stream from a container.
| Property | Value |
|---|---|
| Type | string |
| Values | consolesystem |
ContainerReplica
Information about a container replica.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| container_state | string | The container state of the replica. | Yes | |
| name | string | The name of the replica. | Yes | |
| state | string | The state of the replica. | Yes |
ContinuousEvaluationRuleAction
Evaluation rule action for continuous evaluation.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| evalId | string | Eval Id to add continuous evaluation runs to. | Yes | |
| maxHourlyRuns | integer | Maximum number of evaluation runs allowed per hour. | No | |
| type | enum | Possible values: continuousEvaluation |
Yes |
CosmosDBIndex
CosmosDB Vector Store Index Definition
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| id | string (read-only) | Asset ID, a unique identifier for the asset | No | |
| name | string (read-only) | The name of the resource | Yes | |
| type | enum | Type of index Possible values: CosmosDBNoSqlVectorStore |
Yes | |
| version | string (read-only) | The version of the resource | Yes |
CosmosDBIndexUpdate
CosmosDB Vector Store Index Definition
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | The asset description text. | No | |
| tags | object | Tag dictionary. Tags can be added, removed, and updated. | No | |
| type | enum | Type of index Possible values: CosmosDBNoSqlVectorStore |
Yes |
CreateAgentFromManifestRequest
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | A human-readable description of the agent. Constraints: maxLength: 512 |
No | |
| manifest_id | string | The manifest ID to import the agent version from. | Yes | |
| metadata | object | 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. |
No | |
| name | string | The unique name that identifies the agent. Name can be used to retrieve/update/delete the agent. - Must start and end with alphanumeric characters, - Can contain hyphens in the middle - Must not exceed 63 characters. Constraints: maxLength: 63 |
Yes | |
| parameter_values | object | The inputs to the manifest that will result in a fully materialized Agent. | Yes |
CreateAgentRequest
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| definition | AgentDefinition | Yes | ||
| └─ kind | AgentKind | Yes | ||
| └─ rai_config | RaiConfig | Configuration for Responsible AI (RAI) content filtering and safety features. | No | |
| description | string | A human-readable description of the agent. Constraints: maxLength: 512 |
No | |
| metadata | object | 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. |
No | |
| name | string | The unique name that identifies the agent. Name can be used to retrieve/update/delete the agent. - Must start and end with alphanumeric characters, - Can contain hyphens in the middle - Must not exceed 63 characters. Constraints: maxLength: 63 |
Yes |
CreateAgentVersionFromManifestRequest
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | A human-readable description of the agent. Constraints: maxLength: 512 |
No | |
| manifest_id | string | The manifest ID to import the agent version from. | Yes | |
| metadata | object | 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. |
No | |
| parameter_values | object | The inputs to the manifest that will result in a fully materialized Agent. | Yes |
CreateAgentVersionRequest
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| definition | AgentDefinition | Yes | ||
| └─ kind | AgentKind | Yes | ||
| └─ rai_config | RaiConfig | Configuration for Responsible AI (RAI) content filtering and safety features. | No | |
| description | string | A human-readable description of the agent. Constraints: maxLength: 512 |
No | |
| metadata | object | 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. |
No |
CreateEvalRequest
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data_source_config | OpenAI.CreateEvalCustomDataSourceConfig or OpenAI.CreateEvalLogsDataSourceConfig or OpenAI.CreateEvalStoredCompletionsDataSourceConfig or AzureAIDataSourceConfig | The configuration for the data source used for the evaluation runs. Dictates the schema of the data used in the evaluation. | Yes | |
| metadata | OpenAI.Metadata (nullable) | 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. |
No | |
| name | string | The name of the evaluation. | No | |
| properties | object | Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. |
No | |
| testing_criteria | array of OpenAI.EvalGraderLabelModel or OpenAI.EvalGraderStringCheck or OpenAI.EvalGraderTextSimilarity or OpenAI.EvalGraderPython or OpenAI.EvalGraderScoreModel or EvalGraderAzureAIEvaluator | 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}}). |
Yes |
CreateEvalRunRequest
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data_source | OpenAI.CreateEvalJsonlRunDataSource or OpenAI.CreateEvalCompletionsRunDataSource or OpenAI.CreateEvalResponsesRunDataSource or EvalRunDataSource | Details about the run's data source. | Yes | |
| metadata | OpenAI.Metadata (nullable) | 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. |
No | |
| name | string | The name of the run. | No | |
| properties | object | Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. |
No |
CredentialType
The credential type used by the connection
| Property | Value |
|---|---|
| Description | The credential type used by the connection |
| Type | string |
| Values | ApiKeyAADSASCustomKeysNoneAgenticIdentityToken_Preview |
CronTrigger
Cron based trigger.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| endTime | string | End time for the cron schedule in ISO 8601 format. | No | |
| expression | string | Cron expression that defines the schedule frequency. | Yes | |
| startTime | string | Start time for the cron schedule in ISO 8601 format. | No | |
| timeZone | string | Time zone for the cron schedule. | No | UTC |
| type | enum | Possible values: Cron |
Yes |
CustomCredential
Custom credential definition
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | The credential type Possible values: CustomKeys |
Yes |
This object also accepts additional properties of type: string
DailyRecurrenceSchedule
Daily recurrence schedule.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| hours | array of integer | Hours for the recurrence schedule. | Yes | |
| type | enum | Daily recurrence type. Possible values: Daily |
Yes |
DataSourceConfig
Base class for run data sources with discriminator support.
Discriminator for DataSourceConfig
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| schema | object | The overall object JSON schema for the run data source items. | Yes | |
| type | string | The data source type discriminator. | Yes |
DatasetType
Enum to determine the type of data.
| Property | Value |
|---|---|
| Description | Enum to determine the type of data. |
| Type | string |
| Values | uri_fileuri_folder |
DatasetVersion
DatasetVersion Definition
Discriminator for DatasetVersion
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
uri_file |
FileDatasetVersion |
uri_folder |
FolderDatasetVersion |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| connectionName | string | The Azure Storage Account connection name. Required if startPendingUploadVersion was not called before creating the Dataset | No | |
| dataUri | string | URI of the data (example) Constraints: minLength: 1, pattern: [a-zA-Z0-9_] |
Yes | |
| id | string (read-only) | Asset ID, a unique identifier for the asset | No | |
| isReference | boolean (read-only) | Indicates if the dataset holds a reference to the storage, or the dataset manages storage itself. If true, the underlying data will not be deleted when the dataset version is deleted | No | |
| name | string (read-only) | The name of the resource | Yes | |
| type | DatasetType | Enum to determine the type of data. | Yes | |
| version | string (read-only) | The version of the resource | Yes |
DatasetVersionUpdate
DatasetVersion Definition
Discriminator for DatasetVersionUpdate
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
uri_file |
FileDatasetVersionUpdate |
uri_folder |
FolderDatasetVersionUpdate |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | The asset description text. | No | |
| tags | object | Tag dictionary. Tags can be added, removed, and updated. | No | |
| type | DatasetType | Enum to determine the type of data. | Yes |
DayOfWeek
Days of the week for recurrence schedule.
| Property | Value |
|---|---|
| Description | Days of the week for recurrence schedule. |
| Type | string |
| Values | SundayMondayTuesdayWednesdayThursdayFridaySaturday |
DeleteAgentResponse
A deleted agent Object
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| deleted | boolean | Whether the agent was successfully deleted. | Yes | |
| name | string | The name of the agent. | Yes | |
| object | enum | The object type. Always 'agent.deleted'. Possible values: agent.deleted |
Yes |
DeleteAgentVersionResponse
A deleted agent version Object
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| deleted | boolean | Whether the agent was successfully deleted. | Yes | |
| name | string | The name of the agent. | Yes | |
| object | enum | The object type. Always 'agent.version.deleted'. Possible values: agent.version.deleted |
Yes | |
| version | string | The version identifier of the agent. | Yes |
DeleteEvalResponse
A deleted evaluation Object
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| deleted | boolean | Whether the eval was successfully deleted. | Yes | |
| eval_id | string | id of the eval. | Yes | |
| object | enum | The object type. Always 'eval.deleted'. Possible values: eval.deleted |
Yes |
DeleteEvalRunResponse
A deleted evaluation run Object.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| deleted | boolean | Whether the eval was successfully deleted. | No | |
| object | enum | The object type. Always 'eval.deleted'. Possible values: eval.deleted |
No | |
| run_id | string | id of the eval. | No |
DeleteMemoryStoreResponse
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| deleted | boolean | Whether the memory store was successfully deleted. | Yes | |
| name | string | The name of the memory store. | Yes | |
| object | enum | The object type. Always 'memory_store.deleted'. Possible values: memory_store.deleted |
Yes |
DeleteResponseResult
The result of a delete response operation.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| deleted | enum | Always return true Possible values: True |
Yes | |
| id | string | The operation ID. | Yes | |
| object | enum | Always return 'response'. Possible values: response |
Yes |
Deployment
Model Deployment Definition
Discriminator for Deployment
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
ModelDeployment |
ModelDeployment |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| name | string (read-only) | Name of the deployment | Yes | |
| type | DeploymentType | Yes |
DeploymentType
| Property | Value |
|---|---|
| Type | string |
| Values | ModelDeployment |
EntraIDCredentials
Entra ID credential definition
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | The credential type Possible values: AAD |
Yes |
Eval
An Eval object with a data source config and testing criteria. An Eval represents a task to be done for your LLM integration. Like:
- Improve the quality of my chatbot
- See how well my chatbot handles customer support
- Check if o4-mini is better at my usecase than gpt-4o
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| created_at | integer | The Unix timestamp (in seconds) for when the eval was created. | Yes | |
| created_by | string | the name of the person who created the run. | No | |
| data_source_config | OpenAI.CreateEvalCustomDataSourceConfig or OpenAI.CreateEvalLogsDataSourceConfig or OpenAI.CreateEvalStoredCompletionsDataSourceConfig or AzureAIDataSourceConfig | Configuration of data sources used in runs of the evaluation. | Yes | |
| id | string | Unique identifier for the evaluation. | Yes | |
| metadata | OpenAI.Metadata (nullable) | 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. |
Yes | |
| modified_at | integer | No | ||
| name | string | The name of the evaluation. | Yes | |
| object | enum | The object type. Possible values: eval |
Yes | |
| properties | object | Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. |
No | |
| testing_criteria | array of OpenAI.EvalGraderLabelModel or OpenAI.EvalGraderStringCheck or OpenAI.EvalGraderTextSimilarity or OpenAI.EvalGraderPython or OpenAI.EvalGraderScoreModel or EvalGraderAzureAIEvaluator | A list of testing criteria. | Yes |
EvalCsvFileIdSource
Represents a reference to an uploaded CSV file used as a source for evaluation data.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| id | string | The identifier of the uploaded CSV file. | Yes | |
| type | enum | The type of source, always file_id.Possible values: file_id |
Yes |
EvalCsvRunDataSource
Represents a CSV data source for evaluation runs.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| source | EvalCsvFileIdSource | Represents a reference to an uploaded CSV file used as a source for evaluation data. | Yes | |
| └─ id | string | The identifier of the uploaded CSV file. | Yes | |
| └─ type | enum | The type of source, always file_id.Possible values: file_id |
Yes | |
| type | enum | The type of data source, always csv.Possible values: csv |
Yes |
EvalGraderAzureAIEvaluator
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data_mapping | object | The model to use for the evaluation. Must support structured outputs. | No | |
| evaluator_name | string | The name of the evaluator. | Yes | |
| evaluator_version | string | The version of the evaluator. Latest version if not specified. | No | |
| initialization_parameters | object | The initialization parameters for the evaluation. Must support structured outputs. | No | |
| name | string | The name of the grader. | Yes | |
| type | enum | The object type, which is always azure_ai_evaluator.Possible values: azure_ai_evaluator |
Yes |
EvalResult
Result of the evaluation.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| name | string | name of the check | Yes | |
| passed | boolean | indicates if the check passed or failed | Yes | |
| score | number | score | Yes | |
| type | string | type of the check | Yes |
EvalRun
A schema representing an evaluation run.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| created_at | integer | Unix timestamp (in seconds) when the evaluation run was created. | Yes | |
| created_by | string | the name of the person who created the run. | No | |
| data_source | OpenAI.CreateEvalJsonlRunDataSource or OpenAI.CreateEvalCompletionsRunDataSource or OpenAI.CreateEvalResponsesRunDataSource or EvalRunDataSource | Information about the run's data source. | Yes | |
| error | OpenAI.EvalApiError | An object representing an error response from the Eval API. | Yes | |
| eval_id | string | The identifier of the associated evaluation. | Yes | |
| id | string | Unique identifier for the evaluation run. | Yes | |
| metadata | OpenAI.Metadata (nullable) | 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. |
Yes | |
| model | string | The model that is evaluated, if applicable. | Yes | |
| modified_at | integer | No | ||
| name | string | The name of the evaluation run. | Yes | |
| object | enum | The type of the object. Always "eval.run". Possible values: eval.run |
Yes | |
| per_model_usage | array of OpenAI.EvalRunPerModelUsage | Usage statistics for each model during the evaluation run. | Yes | |
| per_testing_criteria_results | array of OpenAI.EvalRunPerTestingCriteriaResults | Results per testing criteria applied during the evaluation run. | Yes | |
| properties | object | Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. |
No | |
| report_url | string | The URL to the rendered evaluation run report on the UI dashboard. | Yes | |
| result_counts | OpenAI.EvalRunResultCounts | Yes | ||
| └─ errored | OpenAI.integer | Yes | ||
| └─ failed | OpenAI.integer | Yes | ||
| └─ passed | OpenAI.integer | Yes | ||
| └─ total | OpenAI.integer | Yes | ||
| status | string | The status of the evaluation run. | Yes |
EvalRunDataSource
Base class for run data sources with discriminator support.
Discriminator for EvalRunDataSource
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
azure_ai_traces_preview |
TracesPreviewEvalRunDataSource |
azure_ai_synthetic_data_gen_preview |
SyntheticDataGenerationPreviewEvalRunDataSource |
azure_ai_responses |
AzureAIResponsesEvalRunDataSource |
azure_ai_target_completions |
TargetCompletionEvalRunDataSource |
csv |
EvalCsvRunDataSource |
azure_ai_red_team |
RedTeamEvalRunDataSource |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | string | The data source type discriminator. | Yes |
EvalRunOutputItem
A schema representing an evaluation run output item.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| created_at | integer | Unix timestamp (in seconds) when the evaluation run was created. | Yes | |
| datasource_item | object | Details of the input data source item. | Yes | |
| datasource_item_id | OpenAI.integer | Yes | ||
| eval_id | string | The identifier of the evaluation group. | Yes | |
| id | string | Unique identifier for the evaluation run output item. | Yes | |
| object | enum | The type of the object. Always "eval.run.output_item". Possible values: eval.run.output_item |
Yes | |
| results | array of EvalRunOutputItemResult | A list of grader results for this output item. | Yes | |
| run_id | string | The identifier of the evaluation run associated with this output item. | Yes | |
| sample | OpenAI.EvalRunOutputItemSample | Yes | ||
| └─ error | OpenAI.EvalApiError | An object representing an error response from the Eval API. | Yes | |
| └─ finish_reason | string | Yes | ||
| └─ input | array of EvalRunOutputItemSampleInput | Yes | ||
| └─ max_completion_tokens | OpenAI.integer | Yes | ||
| └─ model | string | Yes | ||
| └─ output | array of EvalRunOutputItemSampleOutput | Yes | ||
| └─ seed | OpenAI.integer | Yes | ||
| └─ temperature | OpenAI.numeric | Yes | ||
| └─ top_p | OpenAI.numeric | Yes | ||
| └─ usage | OpenAI.EvalRunOutputItemSampleUsage | Yes | ||
| status | string | The status of the evaluation run. | Yes |
EvalRunOutputItemResult
A single grader result for an evaluation run output item.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| label | string | The label associated with the test criteria metric (e.g., "pass", "fail", "good", "bad"). | No | |
| metric | string | The name of the metric (e.g., "fluency", "f1_score"). | No | |
| name | string | The name of the grader. | Yes | |
| passed | boolean | Whether the grader considered the output a pass. | Yes | |
| properties | object | Additional details about the test criteria metric. | No | |
| reason | string | The reason for the test criteria metric. | No | |
| sample | object (nullable) | Optional sample or intermediate data produced by the grader. | No | |
| score | OpenAI.numeric | Yes | ||
| threshold | number | The threshold used to determine pass/fail for this test criteria, if it is numerical. | No | |
| type | string | The grader type (for example, "string-check-grader"). | No |
This object also accepts additional properties.
EvalRunOutputItemSampleInput
A message in the evaluation run.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | string | Yes | ||
| role | string | Yes | ||
| tool_calls | array of CompletionMessageToolCallChunk | Tool calls made within the message, if any. | Yes |
EvalRunOutputItemSampleOutput
A message in the evaluation run.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | string | No | ||
| role | string | No | ||
| tool_calls | array of CompletionMessageToolCallChunk | Tool calls made within the message, if any. | Yes |
EvalRunResultCompareItem
Metric comparison for a treatment against the baseline.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| deltaEstimate | number | Estimated difference between treatment and baseline. | Yes | |
| pValue | number | P-value for the treatment effect. | Yes | |
| treatmentEffect | TreatmentEffectType | Treatment Effect Type. | Yes | |
| treatmentRunId | string | The treatment run ID. | Yes | |
| treatmentRunSummary | EvalRunResultSummary | Summary statistics of a metric in an evaluation run. | Yes | |
| └─ average | number | Average value of the metric in the evaluation run. | Yes | |
| └─ runId | string | The evaluation run ID. | Yes | |
| └─ sampleCount | integer | Number of samples in the evaluation run. | Yes | |
| └─ standardDeviation | number | Standard deviation of the metric in the evaluation run. | Yes |
EvalRunResultComparison
Comparison results for treatment runs against the baseline.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| baselineRunSummary | EvalRunResultSummary | Summary statistics of a metric in an evaluation run. | Yes | |
| └─ average | number | Average value of the metric in the evaluation run. | Yes | |
| └─ runId | string | The evaluation run ID. | Yes | |
| └─ sampleCount | integer | Number of samples in the evaluation run. | Yes | |
| └─ standardDeviation | number | Standard deviation of the metric in the evaluation run. | Yes | |
| compareItems | array of EvalRunResultCompareItem | List of comparison results for each treatment run. | Yes | |
| evaluator | string | Name of the evaluator for this testing criteria. | Yes | |
| metric | string | Metric being evaluated. | Yes | |
| testingCriteria | string | Name of the testing criteria. | Yes |
EvalRunResultSummary
Summary statistics of a metric in an evaluation run.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| average | number | Average value of the metric in the evaluation run. | Yes | |
| runId | string | The evaluation run ID. | Yes | |
| sampleCount | integer | Number of samples in the evaluation run. | Yes | |
| standardDeviation | number | Standard deviation of the metric in the evaluation run. | Yes |
EvaluationComparisonInsightRequest
Evaluation Comparison Request
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| baselineRunId | string | The baseline run ID for comparison. | Yes | |
| evalId | string | Identifier for the evaluation. | Yes | |
| treatmentRunIds | array of string | List of treatment run IDs for comparison. | Yes | |
| type | enum | The type of request. Possible values: EvaluationComparison |
Yes |
EvaluationComparisonInsightResult
Insights from the evaluation comparison.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| comparisons | array of EvalRunResultComparison | Comparison results for each treatment run against the baseline. | Yes | |
| method | string | The statistical method used for comparison. | Yes | |
| type | enum | The type of insights result. Possible values: EvaluationComparison |
Yes |
EvaluationResultSample
A sample from the evaluation result.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| correlationInfo | object | Info about the correlation for the analysis sample. | Yes | |
| evaluationResult | EvalResult | Result of the evaluation. | Yes | |
| └─ name | string | name of the check | Yes | |
| └─ passed | boolean | indicates if the check passed or failed | Yes | |
| └─ score | number | score | Yes | |
| └─ type | string | type of the check | Yes | |
| features | object | Features to help with additional filtering of data in UX. | Yes | |
| id | string | The unique identifier for the analysis sample. | Yes | |
| type | enum | Evaluation Result Sample Type Possible values: EvaluationResultSample |
Yes |
EvaluationRule
Evaluation rule model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| action | EvaluationRuleAction | Evaluation action model. | Yes | |
| └─ type | EvaluationRuleActionType | Type of the evaluation action. | Yes | |
| description | string | Description for the evaluation rule. | No | |
| displayName | string | Display Name for the evaluation rule. | No | |
| enabled | boolean | Indicates whether the evaluation rule is enabled. Default is true. | Yes | |
| eventType | EvaluationRuleEventType | Type of the evaluation rule event. | Yes | |
| filter | EvaluationRuleFilter | Evaluation filter model. | No | |
| └─ agentName | string | Filter by agent name. | Yes | |
| id | string (read-only) | Unique identifier for the evaluation rule. | Yes | |
| systemData | object (read-only) | System metadata for the evaluation rule. | Yes |
EvaluationRuleAction
Evaluation action model.
Discriminator for EvaluationRuleAction
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
continuousEvaluation |
ContinuousEvaluationRuleAction |
humanEvaluationPreview |
HumanEvaluationPreviewRuleAction |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | EvaluationRuleActionType | Type of the evaluation action. | Yes |
EvaluationRuleActionType
Type of the evaluation action.
| Property | Value |
|---|---|
| Description | Type of the evaluation action. |
| Type | string |
| Values | continuousEvaluationhumanEvaluationPreview |
EvaluationRuleEventType
Type of the evaluation rule event.
| Property | Value |
|---|---|
| Description | Type of the evaluation rule event. |
| Type | string |
| Values | responseCompletedmanual |
EvaluationRuleFilter
Evaluation filter model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| agentName | string | Filter by agent name. | Yes |
EvaluationRunClusterInsightRequest
Insights on set of Evaluation Results
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| evalId | string | Evaluation Id for the insights. | Yes | |
| modelConfiguration | InsightModelConfiguration | Configuration of the model used in the insight generation. | No | |
| └─ modelDeploymentName | string | The model deployment to be evaluated. Accepts either the deployment name alone or with the connection name as {connectionName}/<modelDeploymentName>. |
Yes | |
| runIds | array of string | List of evaluation run IDs for the insights. | Yes | |
| type | enum | The type of insights request. Possible values: EvaluationRunClusterInsight |
Yes |
EvaluationRunClusterInsightResult
Insights from the evaluation run cluster analysis.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| clusterInsight | ClusterInsightResult | Insights from the cluster analysis. | Yes | |
| type | enum | The type of insights result. Possible values: EvaluationRunClusterInsight |
Yes |
EvaluationScheduleTask
Evaluation task for the schedule.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| configuration | object | Configuration for the task. | No | |
| evalId | string | Identifier of the evaluation group. | Yes | |
| evalRun | object | The evaluation run payload. | Yes | |
| type | enum | Possible values: Evaluation |
Yes |
EvaluationTaxonomy
Evaluation Taxonomy Definition
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| id | string (read-only) | Asset ID, a unique identifier for the asset | No | |
| name | string (read-only) | The name of the resource | Yes | |
| properties | object | Additional properties for the evaluation taxonomy. | No | |
| taxonomyCategories | array of TaxonomyCategory | List of taxonomy categories. | No | |
| taxonomyInput | EvaluationTaxonomyInput | Input configuration for the evaluation taxonomy. | Yes | |
| └─ type | EvaluationTaxonomyInputType | Input type of the evaluation taxonomy. | Yes | |
| version | string (read-only) | The version of the resource | Yes |
EvaluationTaxonomyCreateOrUpdate
Evaluation Taxonomy Definition
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | The asset description text. | No | |
| properties | object | Additional properties for the evaluation taxonomy. | No | |
| tags | object | Tag dictionary. Tags can be added, removed, and updated. | No | |
| taxonomyCategories | array of TaxonomyCategory | List of taxonomy categories. | No | |
| taxonomyInput | EvaluationTaxonomyInput | Input configuration for the evaluation taxonomy. | Yes | |
| └─ type | EvaluationTaxonomyInputType | Input type of the evaluation taxonomy. | Yes |
EvaluationTaxonomyInput
Input configuration for the evaluation taxonomy.
Discriminator for EvaluationTaxonomyInput
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
agent |
AgentTaxonomyInput |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | EvaluationTaxonomyInputType | Type of the evaluation taxonomy input. | Yes |
EvaluationTaxonomyInputType
Type of the evaluation taxonomy input.
| Property | Value |
|---|---|
| Description | Type of the evaluation taxonomy input. |
| Type | string |
| Values | agentpolicy |
EvaluationTaxonomyInputUpdate
Input configuration for the evaluation taxonomy.
Discriminator for EvaluationTaxonomyInputUpdate
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
agent |
AgentTaxonomyInputUpdate |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | EvaluationTaxonomyInputType | Type of the evaluation taxonomy input. | Yes |
EvaluationTaxonomyUpdate
Evaluation Taxonomy Definition
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | The asset description text. | No | |
| properties | object | Additional properties for the evaluation taxonomy. | No | |
| tags | object | Tag dictionary. Tags can be added, removed, and updated. | No | |
| taxonomyCategories | array of TaxonomyCategory | List of taxonomy categories. | No | |
| taxonomyInput | EvaluationTaxonomyInputUpdate | Input configuration for the evaluation taxonomy. | No | |
| └─ type | EvaluationTaxonomyInputType | Input type of the evaluation taxonomy. | Yes |
EvaluatorCategory
The category of the evaluator
| Property | Value |
|---|---|
| Description | The category of the evaluator |
| Type | string |
| Values | qualitysafetyagents |
EvaluatorDefinition
Base evaluator configuration with discriminator
Discriminator for EvaluatorDefinition
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
code |
CodeBasedEvaluatorDefinition |
prompt |
PromptBasedEvaluatorDefinition |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data_schema | object | The JSON schema (Draft 2020-12) for the evaluator's input data. This includes parameters like type, properties, required. | No | |
| init_parameters | object | The JSON schema (Draft 2020-12) for the evaluator's input parameters. This includes parameters like type, properties, required. | No | |
| metrics | object | List of output metrics produced by this evaluator | No | |
| type | EvaluatorDefinitionType | The type of evaluator definition | Yes |
EvaluatorDefinitionType
The type of evaluator definition
| Property | Value |
|---|---|
| Description | The type of evaluator definition |
| Type | string |
| Values | promptcodeprompt_and_codeserviceopenai_graders |
EvaluatorMetric
Evaluator Metric
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| desirable_direction | EvaluatorMetricDirection | The direction of the metric indicating whether a higher value is better, a lower value is better, or neutral | No | |
| is_primary | boolean | Indicates if this metric is primary when there are multiple metrics. | No | |
| max_value | number | Maximum value for the metric. If not specified, it is assumed to be unbounded. | No | |
| min_value | number | Minimum value for the metric | No | |
| type | EvaluatorMetricType | The type of the evaluator | No |
EvaluatorMetricDirection
The direction of the metric indicating whether a higher value is better, a lower value is better, or neutral
| Property | Value |
|---|---|
| Description | The direction of the metric indicating whether a higher value is better, a lower value is better, or neutral |
| Type | string |
| Values | increasedecreaseneutral |
EvaluatorMetricType
The type of the evaluator
| Property | Value |
|---|---|
| Description | The type of the evaluator |
| Type | string |
| Values | ordinalcontinuousboolean |
EvaluatorType
The type of the evaluator
| Property | Value |
|---|---|
| Description | The type of the evaluator |
| Type | string |
| Values | builtincustom |
EvaluatorVersion
Evaluator Definition
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| categories | array of EvaluatorCategory | The categories of the evaluator | Yes | |
| created_at | string (read-only) | Creation date/time of the evaluator | Yes | |
| created_by | string (read-only) | Creator of the evaluator | Yes | |
| definition | EvaluatorDefinition | Base evaluator configuration with discriminator | Yes | |
| └─ data_schema | object | The JSON schema (Draft 2020-12) for the evaluator's input data. This includes parameters like type, properties, required. | No | |
| └─ init_parameters | object | The JSON schema (Draft 2020-12) for the evaluator's input parameters. This includes parameters like type, properties, required. | No | |
| └─ metrics | object | List of output metrics produced by this evaluator | No | |
| └─ type | EvaluatorDefinitionType | The type of evaluator definition | Yes | |
| display_name | string | Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique. | No | |
| evaluator_type | EvaluatorType | The type of the evaluator | Yes | |
| id | string (read-only) | Asset ID, a unique identifier for the asset | No | |
| metadata | object | Metadata about the evaluator | No | |
| modified_at | string (read-only) | Last modified date/time of the evaluator | Yes | |
| name | string (read-only) | The name of the resource | Yes | |
| version | string (read-only) | The version of the resource | Yes |
EvaluatorVersionCreate
Evaluator Definition
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| categories | array of EvaluatorCategory | The categories of the evaluator | Yes | |
| definition | EvaluatorDefinition | Base evaluator configuration with discriminator | Yes | |
| └─ data_schema | object | The JSON schema (Draft 2020-12) for the evaluator's input data. This includes parameters like type, properties, required. | No | |
| └─ init_parameters | object | The JSON schema (Draft 2020-12) for the evaluator's input parameters. This includes parameters like type, properties, required. | No | |
| └─ metrics | object | List of output metrics produced by this evaluator | No | |
| └─ type | EvaluatorDefinitionType | The type of evaluator definition | Yes | |
| description | string | The asset description text. | No | |
| display_name | string | Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique. | No | |
| evaluator_type | EvaluatorType | The type of the evaluator | Yes | |
| metadata | object | Metadata about the evaluator | No | |
| tags | object | Tag dictionary. Tags can be added, removed, and updated. | No |
EvaluatorVersionUpdate
Evaluator Definition
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| categories | array of EvaluatorCategory | The categories of the evaluator | No | |
| description | string | The asset description text. | No | |
| display_name | string | Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique. | No | |
| metadata | object | Metadata about the evaluator | No | |
| tags | object | Tag dictionary. Tags can be added, removed, and updated. | No |
FabricDataAgentToolParameters
The fabric data agent tool parameters.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| project_connections | array of ToolProjectConnection | The project connections attached to this tool. There can be a maximum of 1 connection resource attached to the tool. |
No |
FileDatasetVersion
FileDatasetVersion Definition
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| connectionName | string | The Azure Storage Account connection name. Required if startPendingUploadVersion was not called before creating the Dataset | No | |
| dataUri | string | URI of the data (example) Constraints: minLength: 1, pattern: [a-zA-Z0-9_] |
Yes | |
| id | string (read-only) | Asset ID, a unique identifier for the asset | No | |
| isReference | boolean (read-only) | Indicates if the dataset holds a reference to the storage, or the dataset manages storage itself. If true, the underlying data will not be deleted when the dataset version is deleted | No | |
| name | string (read-only) | The name of the resource | Yes | |
| type | enum | Dataset type Possible values: uri_file |
Yes | |
| version | string (read-only) | The version of the resource | Yes |
FileDatasetVersionUpdate
FileDatasetVersion Definition
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | The asset description text. | No | |
| tags | object | Tag dictionary. Tags can be added, removed, and updated. | No | |
| type | enum | Dataset type Possible values: uri_file |
Yes |
FolderDatasetVersion
FileDatasetVersion Definition
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| connectionName | string | The Azure Storage Account connection name. Required if startPendingUploadVersion was not called before creating the Dataset | No | |
| dataUri | string | URI of the data (example) Constraints: minLength: 1, pattern: [a-zA-Z0-9_] |
Yes | |
| id | string (read-only) | Asset ID, a unique identifier for the asset | No | |
| isReference | boolean (read-only) | Indicates if the dataset holds a reference to the storage, or the dataset manages storage itself. If true, the underlying data will not be deleted when the dataset version is deleted | No | |
| name | string (read-only) | The name of the resource | Yes | |
| type | enum | Dataset type Possible values: uri_folder |
Yes | |
| version | string (read-only) | The version of the resource | Yes |
FolderDatasetVersionUpdate
FileDatasetVersion Definition
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | The asset description text. | No | |
| tags | object | Tag dictionary. Tags can be added, removed, and updated. | No | |
| type | enum | Dataset type Possible values: uri_folder |
Yes |
FunctionToolCall
Details of a function tool call.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| arguments | string | The arguments to call the function with, as generated by the model in JSON format. | Yes | |
| name | string | The name of the function to call. | Yes |
HostedAgentDefinition
The hosted agent definition.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| container_protocol_versions | array of ProtocolVersionRecord | The protocols that the agent supports for ingress communication of the containers. | Yes | |
| cpu | string | The CPU configuration for the hosted agent. | Yes | |
| environment_variables | object | Environment variables to set in the hosted agent container. | No | |
| image | string | The image ID for the agent, applicable to image-based hosted agents. | No | |
| kind | enum | Possible values: hosted |
Yes | |
| memory | string | The memory configuration for the hosted agent. | Yes | |
| rai_config | RaiConfig | Configuration for Responsible AI (RAI) content filtering and safety features. | No | |
| └─ rai_policy_name | string | The name of the RAI policy to apply. | Yes | |
| tools | array of OpenAI.Tool | An array of tools the hosted agent's model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter. |
No |
HourlyRecurrenceSchedule
Hourly recurrence schedule.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | Possible values: Hourly |
Yes |
HumanEvaluationPreviewRuleAction
Evaluation rule action for human evaluation.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| templateId | AssetId | Identifier of a saved asset. | Yes | |
| type | enum | Possible values: humanEvaluationPreview |
Yes |
Index
Index resource Definition
Discriminator for Index
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
AzureSearch |
AzureAISearchIndex |
ManagedAzureSearch |
ManagedAzureAISearchIndex |
CosmosDBNoSqlVectorStore |
CosmosDBIndex |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| id | string (read-only) | Asset ID, a unique identifier for the asset | No | |
| name | string (read-only) | The name of the resource | Yes | |
| type | IndexType | Yes | ||
| version | string (read-only) | The version of the resource | Yes |
IndexType
| Property | Value |
|---|---|
| Type | string |
| Values | AzureSearchCosmosDBNoSqlVectorStoreManagedAzureSearch |
IndexUpdate
Index resource Definition
Discriminator for IndexUpdate
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
AzureSearch |
AzureAISearchIndexUpdate |
ManagedAzureSearch |
ManagedAzureAISearchIndexUpdate |
CosmosDBNoSqlVectorStore |
CosmosDBIndexUpdate |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | The asset description text. | No | |
| tags | object | Tag dictionary. Tags can be added, removed, and updated. | No | |
| type | IndexType | Yes |
Insight
The response body for cluster insights.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| displayName | string | User friendly display name for the insight. | Yes | |
| id | string (read-only) | The unique identifier for the insights report. | Yes | |
| metadata | InsightsMetadata (read-only) | Metadata about the insights. | Yes | |
| └─ completedAt | string | The timestamp when the insights were completed. | No | |
| └─ createdAt | string | The timestamp when the insights were created. | Yes | |
| request | InsightRequest | The request of the insights report. | Yes | |
| └─ type | InsightType | The type of request. | Yes | |
| result | InsightResult (read-only) | The result of the insights. | No | |
| └─ type | InsightType | The type of insights result. | Yes | |
| state | Azure.Core.Foundations.OperationState (read-only) | Enum describing allowed operation states. | Yes |
InsightCluster
A cluster of analysis samples.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | Description of the analysis cluster. | Yes | |
| id | string | The id of the analysis cluster. | Yes | |
| label | string | Label for the cluster | Yes | |
| samples | array of InsightSample | List of samples that belong to this cluster. Empty if samples are part of subclusters. | No | |
| subClusters | array of InsightCluster | List of subclusters within this cluster. Empty if no subclusters exist. | No | |
| suggestion | string | Suggestion for the cluster | Yes | |
| suggestionTitle | string | The title of the suggestion for the cluster | Yes | |
| weight | integer | The weight of the analysis cluster. This indicate number of samples in the cluster. | Yes |
InsightModelConfiguration
Configuration of the model used in the insight generation.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| modelDeploymentName | string | The model deployment to be evaluated. Accepts either the deployment name alone or with the connection name as {connectionName}/<modelDeploymentName>. |
Yes |
InsightRequest
The request of the insights report.
Discriminator for InsightRequest
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
EvaluationRunClusterInsight |
EvaluationRunClusterInsightRequest |
AgentClusterInsight |
AgentClusterInsightRequest |
EvaluationComparison |
EvaluationComparisonInsightRequest |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | InsightType | The request of the insights. | Yes |
InsightResult
The result of the insights.
Discriminator for InsightResult
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
EvaluationComparison |
EvaluationComparisonInsightResult |
EvaluationRunClusterInsight |
EvaluationRunClusterInsightResult |
AgentClusterInsight |
AgentClusterInsightResult |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | InsightType | The request of the insights. | Yes |
InsightSample
A sample from the analysis.
Discriminator for InsightSample
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
EvaluationResultSample |
EvaluationResultSample |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| correlationInfo | object | Info about the correlation for the analysis sample. | Yes | |
| features | object | Features to help with additional filtering of data in UX. | Yes | |
| id | string | The unique identifier for the analysis sample. | Yes | |
| type | SampleType | The type of sample used in the analysis. | Yes |
InsightScheduleTask
Insight task for the schedule.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| configuration | object | Configuration for the task. | No | |
| insight | Insight | The response body for cluster insights. | Yes | |
| └─ displayName | string | User friendly display name for the insight. | Yes | |
| └─ id | string (read-only) | The unique identifier for the insights report. | Yes | |
| └─ metadata | InsightsMetadata (read-only) | Metadata about the insights report. | Yes | |
| └─ request | InsightRequest | Request for the insights analysis. | Yes | |
| └─ result | InsightResult (read-only) | The result of the insights report. | No | |
| └─ state | Azure.Core.Foundations.OperationState (read-only) | The current state of the insights. | Yes | |
| type | enum | Possible values: Insight |
Yes |
InsightSummary
Summary of the error cluster analysis.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| method | string | Method used for clustering. | Yes | |
| sampleCount | integer | Total number of samples analyzed. | Yes | |
| uniqueClusterCount | integer | Total number of unique clusters. | Yes | |
| uniqueSubclusterCount | integer | Total number of unique subcluster labels. | Yes | |
| usage | ClusterTokenUsage | Token usage for cluster analysis | Yes | |
| └─ inputTokenUsage | integer | input token usage | Yes | |
| └─ outputTokenUsage | integer | output token usage | Yes | |
| └─ totalTokenUsage | integer | total token usage | Yes |
InsightType
The request of the insights.
| Property | Value |
|---|---|
| Description | The request of the insights. |
| Type | string |
| Values | EvaluationRunClusterInsightAgentClusterInsightEvaluationComparison |
InsightsMetadata
Metadata about the insights.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| completedAt | string | The timestamp when the insights were completed. | No | |
| createdAt | string | The timestamp when the insights were created. | Yes |
ItemGenerationParams
Represents the set of parameters used to control item generation operations.
Discriminator for ItemGenerationParams
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
red_team |
RedTeamItemGenerationParams |
red_team_seed_prompts |
RedTeamSeedPromptsItemGenerationParams |
red_team_taxonomy |
RedTeamTaxonomyItemGenerationParams |
response_retrieval |
ResponseRetrievalItemGenerationParams |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | ItemGenerationParamsType | The types of parameters for red team item generation. | Yes |
ItemGenerationParamsType
The types of parameters for red team item generation.
| Property | Value |
|---|---|
| Description | The types of parameters for red team item generation. |
| Type | string |
| Values | red_teamresponse_retrievalred_team_seed_promptsred_team_taxonomysynthetic_data_gen_preview |
ManagedAzureAISearchIndex
Managed Azure AI Search Index Definition
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| id | string (read-only) | Asset ID, a unique identifier for the asset | No | |
| name | string (read-only) | The name of the resource | Yes | |
| type | enum | Type of index Possible values: ManagedAzureSearch |
Yes | |
| version | string (read-only) | The version of the resource | Yes |
ManagedAzureAISearchIndexUpdate
Managed Azure AI Search Index Definition
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | The asset description text. | No | |
| tags | object | Tag dictionary. Tags can be added, removed, and updated. | No | |
| type | enum | Type of index Possible values: ManagedAzureSearch |
Yes |
MemoryItem
A single memory item stored in the memory store, containing content and metadata.
Discriminator for MemoryItem
This component uses the property kind to discriminate between different types:
| Type Value | Schema |
|---|---|
user_profile |
UserProfileMemoryItem |
chat_summary |
ChatSummaryMemoryItem |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | string | The content of the memory. | Yes | |
| kind | MemoryItemKind | Memory item kind. | Yes | |
| memory_id | string | The unique ID of the memory item. | Yes | |
| scope | string | The namespace that logically groups and isolates memories, such as a user ID. | Yes | |
| updated_at | integer | The last update time of the memory item. | Yes |
MemoryItemKind
Memory item kind.
| Property | Value |
|---|---|
| Description | Memory item kind. |
| Type | string |
| Values | user_profilechat_summary |
MemoryOperation
Represents a single memory operation (create, update, or delete) performed on a memory item.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| kind | MemoryOperationKind | Memory operation kind. | Yes | |
| memory_item | MemoryItem | A single memory item stored in the memory store, containing content and metadata. | Yes | |
| └─ content | string | The content of the memory. | Yes | |
| └─ kind | MemoryItemKind | The kind of the memory item. | Yes | |
| └─ memory_id | string | The unique ID of the memory item. | Yes | |
| └─ scope | string | The namespace that logically groups and isolates memories, such as a user ID. | Yes | |
| └─ updated_at | integer | The last update time of the memory item. | Yes |
MemoryOperationKind
Memory operation kind.
| Property | Value |
|---|---|
| Description | Memory operation kind. |
| Type | string |
| Values | createupdatedelete |
MemorySearchItem
A retrieved memory item from memory search.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| memory_item | MemoryItem | A single memory item stored in the memory store, containing content and metadata. | Yes | |
| └─ content | string | The content of the memory. | Yes | |
| └─ kind | MemoryItemKind | The kind of the memory item. | Yes | |
| └─ memory_id | string | The unique ID of the memory item. | Yes | |
| └─ scope | string | The namespace that logically groups and isolates memories, such as a user ID. | Yes | |
| └─ updated_at | integer | The last update time of the memory item. | Yes |
MemorySearchOptions
Memory search options.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| max_memories | integer | Maximum number of memory items to return. | No |
MemorySearchPreviewTool
A tool for integrating memories into the agent.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| memory_store_name | string | The name of the memory store to use. | Yes | |
| scope | string | The namespace used to group and isolate memories, such as a user ID. Limits which memories can be retrieved or updated. Use special variable {{$userId}} to scope memories to the current signed-in user. |
Yes | |
| search_options | MemorySearchOptions | Memory search options. | No | |
| └─ max_memories | integer | Maximum number of memory items to return. | No | |
| type | enum | The type of the tool. Always memory_search_preview.Possible values: memory_search_preview |
Yes | |
| update_delay | integer | Time to wait before updating memories after inactivity (seconds). Default 300. | No | 300 |
MemorySearchToolCallItemParam
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| results | array of MemorySearchItem | The results returned from the memory search. | No | |
| type | enum | Possible values: memory_search_call |
Yes |
MemorySearchToolCallItemResource
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| agent_reference | AgentReference | No | ||
| └─ name | string | The name of the agent. Constraints: maxLength: 256 |
Yes | |
| └─ type | enum | Possible values: agent_reference |
Yes | |
| └─ version | string | The version identifier of the agent. | No | |
| response_id | string | The response on which the item is created. | No | |
| results | array of MemorySearchItem | The results returned from the memory search. | No | |
| status | enum | The status of the memory search tool call. One of in_progress,searching, completed, incomplete or failed,Possible values: in_progress, searching, completed, incomplete, failed |
Yes | |
| type | enum | Possible values: memory_search_call |
Yes |
MemoryStoreDefaultDefinition
Default memory store implementation.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| chat_model | string | The name or identifier of the chat completion model deployment used for memory processing. | Yes | |
| embedding_model | string | The name or identifier of the embedding model deployment used for memory processing. | Yes | |
| kind | enum | The kind of the memory store. Possible values: default |
Yes | |
| options | MemoryStoreDefaultOptions | Default memory store configurations. | No | |
| └─ chat_summary_enabled | boolean | Whether to enable chat summary extraction and storage. Default is true. | Yes | True |
| └─ user_profile_details | string | Specific categories or types of user profile information to extract and store. | No | |
| └─ user_profile_enabled | boolean | Whether to enable user profile extraction and storage. Default is true. | Yes | True |
MemoryStoreDefaultOptions
Default memory store configurations.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| chat_summary_enabled | boolean | Whether to enable chat summary extraction and storage. Default is true. | Yes | True |
| user_profile_details | string | Specific categories or types of user profile information to extract and store. | No | |
| user_profile_enabled | boolean | Whether to enable user profile extraction and storage. Default is true. | Yes | True |
MemoryStoreDefinition
Base definition for memory store configurations.
Discriminator for MemoryStoreDefinition
This component uses the property kind to discriminate between different types:
| Type Value | Schema |
|---|---|
default |
MemoryStoreDefaultDefinition |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| kind | MemoryStoreKind | The type of memory store implementation to use. | Yes |
MemoryStoreDeleteScopeResponse
Response for deleting memories from a scope.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| deleted | boolean | Whether the deletion operation was successful. | Yes | |
| name | string | The name of the memory store. | Yes | |
| object | enum | The object type. Always 'memory_store.scope.deleted'. Possible values: memory_store.scope.deleted |
Yes | |
| scope | string | The scope from which memories were deleted. | Yes |
MemoryStoreKind
The type of memory store implementation to use.
| Property | Value |
|---|---|
| Description | The type of memory store implementation to use. |
| Type | string |
| Values | default |
MemoryStoreObject
A memory store that can store and retrieve user memories.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| created_at | integer | The Unix timestamp (seconds) when the memory store was created. | Yes | |
| definition | MemoryStoreDefinition | Base definition for memory store configurations. | Yes | |
| └─ kind | MemoryStoreKind | The kind of the memory store. | Yes | |
| description | string | A human-readable description of the memory store. Constraints: maxLength: 512 |
No | |
| id | string | The unique identifier of the memory store. | Yes | |
| metadata | object | Arbitrary key-value metadata to associate with the memory store. | No | |
| name | string | The name of the memory store. Constraints: maxLength: 256 |
Yes | |
| object | enum | The object type, which is always 'memory_store'. Possible values: memory_store |
Yes | |
| updated_at | integer | The Unix timestamp (seconds) when the memory store was last updated. | Yes |
MemoryStoreOperationUsage
Usage statistics of a memory store operation.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| embedding_tokens | integer | The number of embedding tokens. | Yes | |
| input_tokens | OpenAI.integer | Yes | ||
| input_tokens_details | OpenAI.ResponseUsageInputTokensDetails | Yes | ||
| └─ cached_tokens | OpenAI.integer | Yes | ||
| output_tokens | OpenAI.integer | Yes | ||
| output_tokens_details | OpenAI.ResponseUsageOutputTokensDetails | Yes | ||
| └─ reasoning_tokens | OpenAI.integer | Yes | ||
| total_tokens | OpenAI.integer | Yes |
MemoryStoreSearchResponse
Memory search response.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| memories | array of MemorySearchItem | Related memory items found during the search operation. | Yes | |
| search_id | string | The unique ID of this search request. Use this value as previous_search_id in subsequent requests to perform incremental searches. | Yes | |
| usage | MemoryStoreOperationUsage | Usage statistics of a memory store operation. | Yes | |
| └─ embedding_tokens | integer | The number of embedding tokens. | Yes | |
| └─ input_tokens | OpenAI.integer | The number of input tokens. | Yes | |
| └─ input_tokens_details | OpenAI.ResponseUsageInputTokensDetails | A detailed breakdown of the input tokens. | Yes | |
| └─ output_tokens | OpenAI.integer | The number of output tokens. | Yes | |
| └─ output_tokens_details | OpenAI.ResponseUsageOutputTokensDetails | A detailed breakdown of the output tokens. | Yes | |
| └─ total_tokens | OpenAI.integer | The total number of tokens used. | Yes |
MemoryStoreUpdateCompletedResult
Memory update result.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| memory_operations | array of MemoryOperation | A list of individual memory operations that were performed during the update. | Yes | |
| usage | MemoryStoreOperationUsage | Usage statistics of a memory store operation. | Yes | |
| └─ embedding_tokens | integer | The number of embedding tokens. | Yes | |
| └─ input_tokens | OpenAI.integer | The number of input tokens. | Yes | |
| └─ input_tokens_details | OpenAI.ResponseUsageInputTokensDetails | A detailed breakdown of the input tokens. | Yes | |
| └─ output_tokens | OpenAI.integer | The number of output tokens. | Yes | |
| └─ output_tokens_details | OpenAI.ResponseUsageOutputTokensDetails | A detailed breakdown of the output tokens. | Yes | |
| └─ total_tokens | OpenAI.integer | The total number of tokens used. | Yes |
MemoryStoreUpdateResponse
Provides the status of a memory store update operation.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| error | OpenAI.Error | No | ||
| └─ additionalInfo | object | No | ||
| └─ code | string (nullable) | Yes | ||
| └─ debugInfo | object | No | ||
| └─ details | array of OpenAI.Error | No | ||
| └─ message | string | Yes | ||
| └─ param | string (nullable) | No | ||
| └─ type | string | No | ||
| result | MemoryStoreUpdateCompletedResult | Memory update result. | No | |
| └─ memory_operations | array of MemoryOperation | A list of individual memory operations that were performed during the update. | Yes | |
| └─ usage | MemoryStoreOperationUsage | Usage statistics associated with the memory update operation. | Yes | |
| status | MemoryStoreUpdateStatus | Status of a memory store update operation. | Yes | |
| superseded_by | string | The update_id the operation was superseded by when status is "superseded". | No | |
| update_id | string | The unique ID of this update request. Use this value as previous_update_id in subsequent requests to perform incremental updates. | Yes |
MemoryStoreUpdateStatus
Status of a memory store update operation.
| Property | Value |
|---|---|
| Type | string |
| Values | queuedin_progresscompletedfailedsuperseded |
MicrosoftFabricPreviewTool
The input definition information for a Microsoft Fabric tool as used to configure an agent.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| fabric_dataagent_preview | FabricDataAgentToolParameters | The fabric data agent tool parameters. | Yes | |
| └─ project_connections | array of ToolProjectConnection | The project connections attached to this tool. There can be a maximum of 1 connection resource attached to the tool. Constraints: maxItems: 1 |
No | |
| type | enum | The object type, which is always 'fabric_dataagent_preview'. Possible values: fabric_dataagent_preview |
Yes |
ModelDeployment
Model Deployment Definition
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| capabilities | object (read-only) | Capabilities of deployed model | Yes | |
| connectionName | string (read-only) | Name of the connection the deployment comes from | No | |
| modelName | string (read-only) | Publisher-specific name of the deployed model | Yes | |
| modelPublisher | string (read-only) | Name of the deployed model's publisher | Yes | |
| modelVersion | string (read-only) | Publisher-specific version of the deployed model | Yes | |
| name | string (read-only) | Name of the deployment | Yes | |
| sku | Sku (read-only) | Sku information | Yes | |
| └─ capacity | integer | Sku capacity | Yes | |
| └─ family | string | Sku family | Yes | |
| └─ name | string | Sku name | Yes | |
| └─ size | string | Sku size | Yes | |
| └─ tier | string | Sku tier | Yes | |
| type | enum | The type of the deployment Possible values: ModelDeployment |
Yes |
ModelSamplingParams
Represents a set of parameters used to control the sampling behavior of a language model during text generation.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| max_completion_tokens | integer | The maximum number of tokens allowed in the completion. | Yes | |
| seed | integer | The random seed for reproducibility. | Yes | |
| temperature | number | The temperature parameter for sampling. | Yes | |
| top_p | number | The top-p parameter for nucleus sampling. | Yes |
ModelSamplingParamsUpdate
Represents a set of parameters used to control the sampling behavior of a language model during text generation.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| max_completion_tokens | integer | The maximum number of tokens allowed in the completion. | No | |
| seed | integer | The random seed for reproducibility. | No | |
| temperature | number | The temperature parameter for sampling. | No | |
| top_p | number | The top-p parameter for nucleus sampling. | No |
MonthlyRecurrenceSchedule
Monthly recurrence schedule.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| daysOfMonth | array of integer | Days of the month for the recurrence schedule. | Yes | |
| type | enum | Monthly recurrence type. Possible values: Monthly |
Yes |
NoAuthenticationCredentials
Credentials that do not require authentication
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | The credential type Possible values: None |
Yes |
OAuthConsentRequestOutputItem
Request from the service for the user to perform OAuth consent.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| agent_reference | AgentReference | No | ||
| └─ name | string | The name of the agent. Constraints: maxLength: 256 |
Yes | |
| └─ type | enum | Possible values: agent_reference |
Yes | |
| └─ version | string | The version identifier of the agent. | No | |
| consent_link | string | The link the user can use to perform OAuth consent. | Yes | |
| id | string | Yes | ||
| response_id | string | The response on which the item is created. | No | |
| server_label | string | The server label for the OAuth consent request. | Yes | |
| type | enum | Possible values: oauth_consent_request |
Yes |
OneTimeTrigger
One-time trigger.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| timeZone | string | Time zone for the one-time trigger. | No | UTC |
| triggerAt | string | Date and time for the one-time trigger in ISO 8601 format. | Yes | |
| type | enum | Possible values: OneTime |
Yes |
OpenAI.Annotation
An annotation that applies to a span of output text.
Discriminator for OpenAI.Annotation
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
file_citation |
OpenAI.FileCitationBody |
url_citation |
OpenAI.UrlCitationBody |
container_file_citation |
OpenAI.ContainerFileCitationBody |
file_path |
OpenAI.FilePath |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | OpenAI.AnnotationType | Yes |
OpenAI.AnnotationType
| Property | Value |
|---|---|
| Type | string |
| Values | file_citationurl_citationcontainer_file_citationfile_path |
OpenAI.ApplyPatchCallOutputStatus
| Property | Value |
|---|---|
| Type | string |
| Values | completedfailed |
OpenAI.ApplyPatchCallOutputStatusParam
Outcome values reported for apply_patch tool call outputs.
| Property | Value |
|---|---|
| Type | string |
| Values | completedfailed |
OpenAI.ApplyPatchCallStatus
| Property | Value |
|---|---|
| Type | string |
| Values | in_progresscompleted |
OpenAI.ApplyPatchCallStatusParam
Status values reported for apply_patch tool calls.
| Property | Value |
|---|---|
| Type | string |
| Values | in_progresscompleted |
OpenAI.ApplyPatchCreateFileOperation
Instruction describing how to create a file via the apply_patch tool.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| diff | string | Diff to apply. | Yes | |
| path | string | Path of the file to create. | Yes | |
| type | enum | Create a new file with the provided diff. Possible values: create_file |
Yes |
OpenAI.ApplyPatchCreateFileOperationParam
Instruction for creating a new file via the apply_patch tool.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| diff | string | Unified diff content to apply when creating the file. Constraints: maxLength: 10485760 |
Yes | |
| path | string | Path of the file to create relative to the workspace root. Constraints: minLength: 1 |
Yes | |
| type | enum | The operation type. Always create_file.Possible values: create_file |
Yes |
OpenAI.ApplyPatchDeleteFileOperation
Instruction describing how to delete a file via the apply_patch tool.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| path | string | Path of the file to delete. | Yes | |
| type | enum | Delete the specified file. Possible values: delete_file |
Yes |
OpenAI.ApplyPatchDeleteFileOperationParam
Instruction for deleting an existing file via the apply_patch tool.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| path | string | Path of the file to delete relative to the workspace root. Constraints: minLength: 1 |
Yes | |
| type | enum | The operation type. Always delete_file.Possible values: delete_file |
Yes |
OpenAI.ApplyPatchFileOperation
One of the create_file, delete_file, or update_file operations applied via apply_patch.
Discriminator for OpenAI.ApplyPatchFileOperation
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
create_file |
OpenAI.ApplyPatchCreateFileOperation |
delete_file |
OpenAI.ApplyPatchDeleteFileOperation |
update_file |
OpenAI.ApplyPatchUpdateFileOperation |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | OpenAI.ApplyPatchFileOperationType | Yes |
OpenAI.ApplyPatchFileOperationType
| Property | Value |
|---|---|
| Type | string |
| Values | create_filedelete_fileupdate_file |
OpenAI.ApplyPatchOperationParam
One of the create_file, delete_file, or update_file operations supplied to the apply_patch tool.
Discriminator for OpenAI.ApplyPatchOperationParam
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
create_file |
OpenAI.ApplyPatchCreateFileOperationParam |
delete_file |
OpenAI.ApplyPatchDeleteFileOperationParam |
update_file |
OpenAI.ApplyPatchUpdateFileOperationParam |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | OpenAI.ApplyPatchOperationParamType | Yes |
OpenAI.ApplyPatchOperationParamType
| Property | Value |
|---|---|
| Type | string |
| Values | create_filedelete_fileupdate_file |
OpenAI.ApplyPatchToolParam
Allows the assistant to create, delete, or update files using unified diffs.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | The type of the tool. Always apply_patch.Possible values: apply_patch |
Yes |
OpenAI.ApplyPatchUpdateFileOperation
Instruction describing how to update a file via the apply_patch tool.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| diff | string | Diff to apply. | Yes | |
| path | string | Path of the file to update. | Yes | |
| type | enum | Update an existing file with the provided diff. Possible values: update_file |
Yes |
OpenAI.ApplyPatchUpdateFileOperationParam
Instruction for updating an existing file via the apply_patch tool.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| diff | string | Unified diff content to apply to the existing file. Constraints: maxLength: 10485760 |
Yes | |
| path | string | Path of the file to update relative to the workspace root. Constraints: minLength: 1 |
Yes | |
| type | enum | The operation type. Always update_file.Possible values: update_file |
Yes |
OpenAI.ApproximateLocation
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| city | string (nullable) | No | ||
| country | string (nullable) | No | ||
| region | string (nullable) | No | ||
| timezone | string (nullable) | No | ||
| type | enum | The type of location approximation. Always approximate.Possible values: approximate |
Yes |
OpenAI.ChatCompletionTool
A function tool that can be used to generate a response.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| function | OpenAI.FunctionObject | Yes | ||
| type | enum | The type of the tool. Currently, only function is supported.Possible values: function |
Yes |
OpenAI.ChatModel
| Property | Value |
|---|---|
| Type | string |
| Values | gpt-5.2gpt-5.2-2025-12-11gpt-5.2-chat-latestgpt-5.2-progpt-5.2-pro-2025-12-11gpt-5.1gpt-5.1-2025-11-13gpt-5.1-codexgpt-5.1-minigpt-5.1-chat-latestgpt-5gpt-5-minigpt-5-nanogpt-5-2025-08-07gpt-5-mini-2025-08-07gpt-5-nano-2025-08-07gpt-5-chat-latestgpt-4.1gpt-4.1-minigpt-4.1-nanogpt-4.1-2025-04-14gpt-4.1-mini-2025-04-14gpt-4.1-nano-2025-04-14o4-minio4-mini-2025-04-16o3o3-2025-04-16o3-minio3-mini-2025-01-31o1o1-2024-12-17o1-previewo1-preview-2024-09-12o1-minio1-mini-2024-09-12gpt-4ogpt-4o-2024-11-20gpt-4o-2024-08-06gpt-4o-2024-05-13gpt-4o-audio-previewgpt-4o-audio-preview-2024-10-01gpt-4o-audio-preview-2024-12-17gpt-4o-audio-preview-2025-06-03gpt-4o-mini-audio-previewgpt-4o-mini-audio-preview-2024-12-17gpt-4o-search-previewgpt-4o-mini-search-previewgpt-4o-search-preview-2025-03-11gpt-4o-mini-search-preview-2025-03-11chatgpt-4o-latestcodex-mini-latestgpt-4o-minigpt-4o-mini-2024-07-18gpt-4-turbogpt-4-turbo-2024-04-09gpt-4-0125-previewgpt-4-turbo-previewgpt-4-1106-previewgpt-4-vision-previewgpt-4gpt-4-0314gpt-4-0613gpt-4-32kgpt-4-32k-0314gpt-4-32k-0613gpt-3.5-turbogpt-3.5-turbo-16kgpt-3.5-turbo-0301gpt-3.5-turbo-0613gpt-3.5-turbo-1106gpt-3.5-turbo-0125gpt-3.5-turbo-16k-0613 |
OpenAI.ClickButtonType
| Property | Value |
|---|---|
| Type | string |
| Values | leftrightwheelbackforward |
OpenAI.ClickParam
A click action.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| button | OpenAI.ClickButtonType | Yes | ||
| type | enum | Specifies the event type. For a click action, this property is always click.Possible values: click |
Yes | |
| x | OpenAI.integer | Yes | ||
| y | OpenAI.integer | Yes |
OpenAI.CodeInterpreterContainerAuto
Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| file_ids | array of string | An optional list of uploaded files to make available to your code. | No | |
| memory_limit | OpenAI.ContainerMemoryLimit (nullable) | No | ||
| type | enum | Always auto.Possible values: auto |
Yes |
OpenAI.CodeInterpreterOutputImage
The image output from the code interpreter.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | The type of the output. Always image.Possible values: image |
Yes | |
| url | string | The URL of the image output from the code interpreter. | Yes |
OpenAI.CodeInterpreterOutputLogs
The logs output from the code interpreter.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| logs | string | The logs output from the code interpreter. | Yes | |
| type | enum | The type of the output. Always logs.Possible values: logs |
Yes |
OpenAI.CodeInterpreterTool
A tool that runs Python code to help generate a response to a prompt.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| container | string or OpenAI.CodeInterpreterContainerAuto | 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. |
No | |
| type | enum | The type of the code interpreter tool. Always code_interpreter.Possible values: code_interpreter |
Yes |
OpenAI.CompactResource
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| created_at | integer | Unix timestamp (in seconds) when the compacted conversation was created. | Yes | |
| id | string | The unique identifier for the compacted response. | Yes | |
| object | enum | The object type. Always response.compaction.Possible values: response.compaction |
Yes | |
| output | array of OpenAI.OutputItem | The compacted list of output items. This is a list of all user messages, followed by a single compaction item. | Yes | |
| usage | OpenAI.ResponseUsage | Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used. |
Yes | |
| └─ input_tokens | OpenAI.integer | The number of input tokens. | Yes | |
| └─ input_tokens_details | OpenAI.ResponseUsageInputTokensDetails | A detailed breakdown of the input tokens. | Yes | |
| └─ output_tokens | OpenAI.integer | The number of output tokens. | Yes | |
| └─ output_tokens_details | OpenAI.ResponseUsageOutputTokensDetails | A detailed breakdown of the output tokens. | Yes | |
| └─ total_tokens | OpenAI.integer | The total number of tokens used. | Yes |
OpenAI.CompactResponseMethodPublicBody
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| input | string or array of OpenAI.InputItem | No | ||
| instructions | string (nullable) | No | ||
| model | OpenAI.ModelIdsCompaction | 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 to browse and compare available models. |
Yes | |
| previous_response_id | string (nullable) | No |
OpenAI.ComparisonFilter
A filter used to compare a specified attribute key to a given value using a defined comparison operation.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| key | string | The key to compare against the value. | Yes | |
| type | enum | Specifies the comparison operator: eq, ne, gt, gte, lt, lte, in, nin.- eq: equals- ne: not equal- gt: greater than- gte: greater than or equal- lt: less than- lte: less than or equal- in: in- nin: not inPossible values: eq, ne, gt, gte, lt, lte |
Yes | |
| value | string or OpenAI.numeric or boolean or array of OpenAI.ComparisonFilterValueItems | The value to compare against the attribute key; supports string, number, or boolean types. | Yes |
OpenAI.ComparisonFilterValueItems
Type: string or OpenAI.numeric
OpenAI.CompoundFilter
Combine multiple filters using and or or.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| filters | array of OpenAI.ComparisonFilter or object | Array of filters to combine. Items can be ComparisonFilter or CompoundFilter. |
Yes | |
| type | enum | Type of operation: and or or.Possible values: and, or |
Yes |
OpenAI.ComputerAction
Discriminator for OpenAI.ComputerAction
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
click |
OpenAI.ClickParam |
double_click |
OpenAI.DoubleClickAction |
drag |
OpenAI.Drag |
keypress |
OpenAI.KeyPressAction |
move |
OpenAI.Move |
screenshot |
OpenAI.Screenshot |
scroll |
OpenAI.Scroll |
type |
OpenAI.Type |
wait |
OpenAI.Wait |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | OpenAI.ComputerActionType | Yes |
OpenAI.ComputerActionType
| Property | Value |
|---|---|
| Type | string |
| Values | clickdouble_clickdragkeypressmovescreenshotscrolltypewait |
OpenAI.ComputerCallSafetyCheckParam
A pending safety check for the computer call.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| code | string (nullable) | No | ||
| id | string | The ID of the pending safety check. | Yes | |
| message | string (nullable) | No |
OpenAI.ComputerEnvironment
| Property | Value |
|---|---|
| Type | string |
| Values | windowsmaclinuxubuntubrowser |
OpenAI.ComputerScreenshotContent
A screenshot of a computer.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| file_id | string (nullable) | Yes | ||
| image_url | string | Yes | ||
| type | enum | Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.Possible values: computer_screenshot |
Yes |
OpenAI.ComputerScreenshotImage
A computer screenshot image used with the computer use tool.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| file_id | string | The identifier of an uploaded file that contains the screenshot. | No | |
| image_url | string | The URL of the screenshot image. | No | |
| type | enum | Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.Possible values: computer_screenshot |
Yes |
OpenAI.ComputerUsePreviewTool
A tool that controls a virtual computer.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| display_height | OpenAI.integer | Yes | ||
| display_width | OpenAI.integer | Yes | ||
| environment | OpenAI.ComputerEnvironment | Yes | ||
| type | enum | The type of the computer use tool. Always computer_use_preview.Possible values: computer_use_preview |
Yes |
OpenAI.ContainerFileCitationBody
A citation for a container file used to generate a model response.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| container_id | string | The ID of the container file. | Yes | |
| end_index | OpenAI.integer | Yes | ||
| file_id | string | The ID of the file. | Yes | |
| filename | string | The filename of the container file cited. | Yes | |
| start_index | OpenAI.integer | Yes | ||
| type | enum | The type of the container file citation. Always container_file_citation.Possible values: container_file_citation |
Yes |
OpenAI.ContainerMemoryLimit
| Property | Value |
|---|---|
| Type | string |
| Values | 1g4g16g64g |
OpenAI.ConversationItem
A single item within a conversation. The set of possible types are the same as the output type of a Response object.
Discriminator for OpenAI.ConversationItem
This component uses the property type to discriminate between different types:
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | OpenAI.ConversationItemType | Yes |
OpenAI.ConversationItemApplyPatchToolCall
A tool call that applies file diffs by creating, deleting, or updating files.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| call_id | string | The unique ID of the apply patch tool call generated by the model. | Yes | |
| created_by | string | The ID of the entity that created this tool call. | No | |
| id | string | The unique ID of the apply patch tool call. Populated when this item is returned via API. | Yes | |
| operation | OpenAI.ApplyPatchFileOperation | One of the create_file, delete_file, or update_file operations applied via apply_patch. | Yes | |
| └─ type | OpenAI.ApplyPatchFileOperationType | Yes | ||
| status | OpenAI.ApplyPatchCallStatus | Yes | ||
| type | enum | The type of the item. Always apply_patch_call.Possible values: apply_patch_call |
Yes |
OpenAI.ConversationItemApplyPatchToolCallOutput
The output emitted by an apply patch tool call.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| call_id | string | The unique ID of the apply patch tool call generated by the model. | Yes | |
| created_by | string | The ID of the entity that created this tool call output. | No | |
| id | string | The unique ID of the apply patch tool call output. Populated when this item is returned via API. | Yes | |
| output | string (nullable) | No | ||
| status | OpenAI.ApplyPatchCallOutputStatus | Yes | ||
| type | enum | The type of the item. Always apply_patch_call_output.Possible values: apply_patch_call_output |
Yes |
OpenAI.ConversationItemCodeInterpreterToolCall
A tool call to run code.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| code | string (nullable) | Yes | ||
| container_id | string | The ID of the container used to run the code. | Yes | |
| id | string | The unique ID of the code interpreter tool call. | Yes | |
| outputs | array of OpenAI.CodeInterpreterOutputLogs or OpenAI.CodeInterpreterOutputImage | Yes | ||
| status | enum | The status of the code interpreter tool call. Valid values are in_progress, completed, incomplete, interpreting, and failed.Possible values: in_progress, completed, incomplete, interpreting, failed |
Yes | |
| type | enum | The type of the code interpreter tool call. Always code_interpreter_call.Possible values: code_interpreter_call |
Yes |
OpenAI.ConversationItemComputerToolCall
A tool call to a computer use tool. See the computer use guide for more information.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| action | OpenAI.ComputerAction | Yes | ||
| call_id | string | An identifier used when responding to the tool call with output. | Yes | |
| id | string | The unique ID of the computer call. | Yes | |
| pending_safety_checks | array of OpenAI.ComputerCallSafetyCheckParam | The pending safety checks for the computer call. | Yes | |
| status | enum | The status of the item. One of in_progress, completed, orincomplete. Populated when items are returned via API.Possible values: in_progress, completed, incomplete |
Yes | |
| type | enum | The type of the computer call. Always computer_call.Possible values: computer_call |
Yes |
OpenAI.ConversationItemComputerToolCallOutputResource
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| acknowledged_safety_checks | array of OpenAI.ComputerCallSafetyCheckParam | The safety checks reported by the API that have been acknowledged by the developer. |
No | |
| call_id | string | The ID of the computer tool call that produced the output. | Yes | |
| id | string | The ID of the computer tool call output. | No | |
| output | OpenAI.ComputerScreenshotImage | A computer screenshot image used with the computer use tool. | Yes | |
| status | enum | The status of the message input. One of in_progress, completed, orincomplete. Populated when input items are returned via API.Possible values: in_progress, completed, incomplete |
No | |
| type | enum | The type of the computer tool call output. Always computer_call_output.Possible values: computer_call_output |
Yes |
OpenAI.ConversationItemCustomToolCall
A call to a custom tool created by the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| call_id | string | An identifier used to map this custom tool call to a tool call output. | Yes | |
| id | string | The unique ID of the custom tool call in the OpenAI platform. | No | |
| input | string | The input for the custom tool call generated by the model. | Yes | |
| name | string | The name of the custom tool being called. | Yes | |
| type | enum | The type of the custom tool call. Always custom_tool_call.Possible values: custom_tool_call |
Yes |
OpenAI.ConversationItemCustomToolCallOutput
The output of a custom tool call from your code, being sent back to the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| call_id | string | The call ID, used to map this custom tool call output to a custom tool call. | Yes | |
| id | string | The unique ID of the custom tool call output in the OpenAI platform. | No | |
| output | string or array of OpenAI.FunctionAndCustomToolCallOutput | The output from the custom tool call generated by your code. Can be a string or an list of output content. |
Yes | |
| type | enum | The type of the custom tool call output. Always custom_tool_call_output.Possible values: custom_tool_call_output |
Yes |
OpenAI.ConversationItemFileSearchToolCall
The results of a file search tool call. See the file search guide for more information.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| id | string | The unique ID of the file search tool call. | Yes | |
| queries | array of string | The queries used to search for files. | Yes | |
| results | array of OpenAI.FileSearchToolCallResults | No | ||
| status | enum | The status of the file search tool call. One of in_progress,searching, incomplete or failed,Possible values: in_progress, searching, completed, incomplete, failed |
Yes | |
| type | enum | The type of the file search tool call. Always file_search_call.Possible values: file_search_call |
Yes |
OpenAI.ConversationItemFunctionShellCall
A tool call that executes one or more shell commands in a managed environment.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| action | OpenAI.FunctionShellAction | Execute a shell command. | Yes | |
| └─ commands | array of string | Yes | ||
| └─ max_output_length | OpenAI.integer (nullable) | Yes | ||
| └─ timeout_ms | OpenAI.integer (nullable) | Yes | ||
| call_id | string | The unique ID of the shell tool call generated by the model. | Yes | |
| created_by | string | The ID of the entity that created this tool call. | No | |
| id | string | The unique ID of the shell tool call. Populated when this item is returned via API. | Yes | |
| status | OpenAI.LocalShellCallStatus | Yes | ||
| type | enum | The type of the item. Always shell_call.Possible values: shell_call |
Yes |
OpenAI.ConversationItemFunctionShellCallOutput
The output of a shell tool call that was emitted.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| call_id | string | The unique ID of the shell tool call generated by the model. | Yes | |
| created_by | string | The identifier of the actor that created the item. | No | |
| id | string | The unique ID of the shell call output. Populated when this item is returned via API. | Yes | |
| max_output_length | OpenAI.integer (nullable) | Yes | ||
| output | array of OpenAI.FunctionShellCallOutputContent | An array of shell call output contents | Yes | |
| type | enum | The type of the shell call output. Always shell_call_output.Possible values: shell_call_output |
Yes |
OpenAI.ConversationItemFunctionToolCallOutputResource
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| call_id | string | The unique ID of the function tool call generated by the model. | Yes | |
| id | string | The unique ID of the function tool call output. Populated when this item is returned via API. |
No | |
| output | string or array of OpenAI.FunctionAndCustomToolCallOutput | The output from the function call generated by your code. Can be a string or an list of output content. |
Yes | |
| status | enum | The status of the item. One of in_progress, completed, orincomplete. Populated when items are returned via API.Possible values: in_progress, completed, incomplete |
No | |
| type | enum | The type of the function tool call output. Always function_call_output.Possible values: function_call_output |
Yes |
OpenAI.ConversationItemFunctionToolCallResource
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| arguments | string | A JSON string of the arguments to pass to the function. | Yes | |
| call_id | string | The unique ID of the function tool call generated by the model. | Yes | |
| id | string | The unique ID of the function tool call. | No | |
| name | string | The name of the function to run. | Yes | |
| status | enum | The status of the item. One of in_progress, completed, orincomplete. Populated when items are returned via API.Possible values: in_progress, completed, incomplete |
No | |
| type | enum | The type of the function tool call. Always function_call.Possible values: function_call |
Yes |
OpenAI.ConversationItemImageGenToolCall
An image generation request made by the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| id | string | The unique ID of the image generation call. | Yes | |
| result | string (nullable) | Yes | ||
| status | enum | The status of the image generation call. Possible values: in_progress, completed, generating, failed |
Yes | |
| type | enum | The type of the image generation call. Always image_generation_call.Possible values: image_generation_call |
Yes |
OpenAI.ConversationItemList
A list of Conversation items.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | array of OpenAI.ConversationItem | A list of conversation items. | Yes | |
| first_id | string | The ID of the first item in the list. | Yes | |
| has_more | boolean | Whether there are more items available. | Yes | |
| last_id | string | The ID of the last item in the list. | Yes | |
| object | enum | The type of object returned, must be list.Possible values: list |
Yes |
OpenAI.ConversationItemLocalShellToolCall
A tool call to run a command on the local shell.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| action | OpenAI.LocalShellExecAction | Execute a shell command on the server. | Yes | |
| call_id | string | The unique ID of the local shell tool call generated by the model. | Yes | |
| id | string | The unique ID of the local shell call. | Yes | |
| status | enum | The status of the local shell call. Possible values: in_progress, completed, incomplete |
Yes | |
| type | enum | The type of the local shell call. Always local_shell_call.Possible values: local_shell_call |
Yes |
OpenAI.ConversationItemLocalShellToolCallOutput
The output of a local shell tool call.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| id | string | The unique ID of the local shell tool call generated by the model. | Yes | |
| output | string | A JSON string of the output of the local shell tool call. | Yes | |
| status | enum | Possible values: in_progress, completed, incomplete |
No | |
| type | enum | The type of the local shell tool call output. Always local_shell_call_output.Possible values: local_shell_call_output |
Yes |
OpenAI.ConversationItemMcpApprovalRequest
A request for human approval of a tool invocation.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| arguments | string | A JSON string of arguments for the tool. | Yes | |
| id | string | The unique ID of the approval request. | Yes | |
| name | string | The name of the tool to run. | Yes | |
| server_label | string | The label of the MCP server making the request. | Yes | |
| type | enum | The type of the item. Always mcp_approval_request.Possible values: mcp_approval_request |
Yes |
OpenAI.ConversationItemMcpApprovalResponseResource
A response to an MCP approval request.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| approval_request_id | string | The ID of the approval request being answered. | Yes | |
| approve | boolean | Whether the request was approved. | Yes | |
| id | string | The unique ID of the approval response | Yes | |
| reason | string (nullable) | No | ||
| type | enum | The type of the item. Always mcp_approval_response.Possible values: mcp_approval_response |
Yes |
OpenAI.ConversationItemMcpListTools
A list of tools available on an MCP server.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| error | string (nullable) | No | ||
| id | string | The unique ID of the list. | Yes | |
| server_label | string | The label of the MCP server. | Yes | |
| tools | array of OpenAI.MCPListToolsTool | The tools available on the server. | Yes | |
| type | enum | The type of the item. Always mcp_list_tools.Possible values: mcp_list_tools |
Yes |
OpenAI.ConversationItemMcpToolCall
An invocation of a tool on an MCP server.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| approval_request_id | string (nullable) | No | ||
| arguments | string | A JSON string of the arguments passed to the tool. | Yes | |
| error | string (nullable) | No | ||
| id | string | The unique ID of the tool call. | Yes | |
| name | string | The name of the tool that was run. | Yes | |
| output | string (nullable) | No | ||
| server_label | string | The label of the MCP server running the tool. | Yes | |
| status | OpenAI.MCPToolCallStatus | No | ||
| type | enum | The type of the item. Always mcp_call.Possible values: mcp_call |
Yes |
OpenAI.ConversationItemMessage
A message to or from the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | array of OpenAI.MessageContent | The content of the message | Yes | |
| id | string | The unique ID of the message. | Yes | |
| role | OpenAI.MessageRole | Yes | ||
| status | OpenAI.MessageStatus | Yes | ||
| type | enum | The type of the message. Always set to message.Possible values: message |
Yes |
OpenAI.ConversationItemReasoningItem
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.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | array of OpenAI.ReasoningTextContent | Reasoning text content. | No | |
| encrypted_content | string (nullable) | No | ||
| id | string | The unique identifier of the reasoning content. | Yes | |
| status | enum | The status of the item. One of in_progress, completed, orincomplete. Populated when items are returned via API.Possible values: in_progress, completed, incomplete |
No | |
| summary | array of OpenAI.Summary | Reasoning summary content. | Yes | |
| type | enum | The type of the object. Always reasoning.Possible values: reasoning |
Yes |
OpenAI.ConversationItemType
| Property | Value |
|---|---|
| Type | string |
| Values | messagefunction_callfunction_call_outputfile_search_callweb_search_callimage_generation_callcomputer_callcomputer_call_outputreasoningcode_interpreter_calllocal_shell_calllocal_shell_call_outputshell_callshell_call_outputapply_patch_callapply_patch_call_outputmcp_list_toolsmcp_approval_requestmcp_approval_responsemcp_callcustom_tool_callcustom_tool_call_output |
OpenAI.ConversationItemWebSearchToolCall
The results of a web search tool call. See the web search guide for more information.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| action | OpenAI.WebSearchActionSearch or OpenAI.WebSearchActionOpenPage or OpenAI.WebSearchActionFind | An object describing the specific action taken in this web search call. Includes details on how the model used the web (search, open_page, find). |
Yes | |
| id | string | The unique ID of the web search tool call. | Yes | |
| status | enum | The status of the web search tool call. Possible values: in_progress, searching, completed, failed |
Yes | |
| type | enum | The type of the web search tool call. Always web_search_call.Possible values: web_search_call |
Yes |
OpenAI.ConversationParam
The conversation that this response belongs to. Items from this conversation are prepended to input_items for this response request.
Input items and output items from this response are automatically added to this conversation after this response completes.
Type: string or OpenAI.ConversationParam-2
The conversation that this response belongs to. Items from this conversation are prepended to input_items for this response request.
Input items and output items from this response are automatically added to this conversation after this response completes.
OpenAI.ConversationParam-2
The conversation that this response belongs to.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| id | string | The unique ID of the conversation. | Yes |
OpenAI.ConversationReference
The conversation that this response belonged to. Input items and output items from this response were automatically added to this conversation.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| id | string | The unique ID of the conversation that this response was associated with. | Yes |
OpenAI.ConversationResource
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| created_at | integer | The time at which the conversation was created, measured in seconds since the Unix epoch. | Yes | |
| id | string | The unique ID of the conversation. | Yes | |
| metadata | OpenAI.Metadata | 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. |
Yes | |
| object | enum | The object type, which is always conversation.Possible values: conversation |
Yes |
OpenAI.CreateChatCompletionRequestResponseFormat
An object specifying the format that the model must output.
Setting to { "type": "json_schema", "json_schema": {...} } enables
Structured Outputs which ensures the model will match your supplied JSON
schema. Learn more in the Structured Outputs
guide.
Setting to { "type": "json_object" } enables the older JSON mode, which
ensures the message the model generates is valid JSON. Using json_schema
is preferred for models that support it.
Discriminator for OpenAI.CreateChatCompletionRequestResponseFormat
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
text |
OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText |
json_object |
OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | OpenAI.CreateChatCompletionRequestResponseFormatType | Yes |
OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject
JSON object response format. An older method of generating JSON responses.
Using json_schema is recommended for models that support it. Note that the
model will not generate JSON without a system or user message instructing it
to do so.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | The type of response format being defined. Always json_object.Possible values: json_object |
Yes |
OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText
Default response format. Used to generate text responses.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | The type of response format being defined. Always text.Possible values: text |
Yes |
OpenAI.CreateChatCompletionRequestResponseFormatType
| Property | Value |
|---|---|
| Type | string |
| Values | textjson_schemajson_object |
OpenAI.CreateConversationBody
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| items | array of OpenAI.InputItem | No | ||
| metadata | OpenAI.Metadata (nullable) | 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. |
No |
OpenAI.CreateEvalCompletionsRunDataSource
A CompletionsRunDataSource object describing a model sampling configuration.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| input_messages | OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate or OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference | Used when sampling from a model. Dictates the structure of the messages passed into the model. Can either be a reference to a prebuilt trajectory (ie, item.input_trajectory), or a template with variable references to the item namespace. |
No | |
| model | string | The name of the model to use for generating completions (e.g. "o3-mini"). | No | |
| sampling_params | OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams | No | ||
| source | OpenAI.EvalJsonlFileContentSource or OpenAI.EvalJsonlFileIdSource or OpenAI.EvalStoredCompletionsSource | Determines what populates the item namespace in this run's data source. |
Yes | |
| type | enum | The type of run data source. Always completions.Possible values: completions |
Yes |
OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item_reference | string | Yes | ||
| type | enum | Possible values: item_reference |
Yes |
OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| template | array of OpenAI.EasyInputMessage or OpenAI.EvalItem | Yes | ||
| type | enum | Possible values: template |
Yes |
OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| max_completion_tokens | OpenAI.integer | No | ||
| reasoning_effort | OpenAI.ReasoningEffort | Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducingreasoning effort can result in faster responses and fewer tokens used on reasoning in a response. - 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.- 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. |
No | |
| response_format | OpenAI.ResponseFormatText or OpenAI.ResponseFormatJsonSchema or OpenAI.ResponseFormatJsonObject | No | ||
| seed | OpenAI.integer | No | 42 | |
| temperature | OpenAI.numeric | No | 1 | |
| tools | array of OpenAI.ChatCompletionTool | No | ||
| top_p | OpenAI.numeric | No | 1 |
OpenAI.CreateEvalCustomDataSourceConfig
A CustomDataSourceConfig object that defines the schema for the data source used for the evaluation runs. This schema is used to define the shape of the data that will be:
- Used to define your testing criteria and
- What data is required when creating a run
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| include_sample_schema | boolean | Whether the eval should expect you to populate the sample namespace (ie, by generating responses off of your data source) | No | |
| item_schema | object | The json schema for each row in the data source. | Yes | |
| type | enum | The type of data source. Always custom.Possible values: custom |
Yes |
OpenAI.CreateEvalJsonlRunDataSource
A JsonlRunDataSource object with that specifies a JSONL file that matches the eval
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| source | OpenAI.EvalJsonlFileContentSource or OpenAI.EvalJsonlFileIdSource | Determines what populates the item namespace in the data source. |
Yes | |
| type | enum | The type of data source. Always jsonl.Possible values: jsonl |
Yes |
OpenAI.CreateEvalLogsDataSourceConfig
A data source config which specifies the metadata property of your logs query.
This is usually metadata like usecase=chatbot or prompt-version=v2, etc.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| metadata | object | Metadata filters for the logs data source. | No | |
| type | enum | The type of data source. Always logs.Possible values: logs |
Yes |
OpenAI.CreateEvalResponsesRunDataSource
A ResponsesRunDataSource object describing a model sampling configuration.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| input_messages | OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate or OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference | Used when sampling from a model. Dictates the structure of the messages passed into the model. Can either be a reference to a prebuilt trajectory (ie, item.input_trajectory), or a template with variable references to the item namespace. |
No | |
| model | string | The name of the model to use for generating completions (e.g. "o3-mini"). | No | |
| sampling_params | OpenAI.CreateEvalResponsesRunDataSourceSamplingParams | No | ||
| source | OpenAI.EvalJsonlFileContentSource or OpenAI.EvalJsonlFileIdSource or OpenAI.EvalResponsesSource | Determines what populates the item namespace in this run's data source. |
Yes | |
| type | enum | The type of run data source. Always responses.Possible values: responses |
Yes |
OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item_reference | string | Yes | ||
| type | enum | Possible values: item_reference |
Yes |
OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| template | array of object or OpenAI.EvalItem | Yes | ||
| type | enum | Possible values: template |
Yes |
OpenAI.CreateEvalResponsesRunDataSourceSamplingParams
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| max_completion_tokens | OpenAI.integer | No | ||
| reasoning_effort | OpenAI.ReasoningEffort | Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducingreasoning effort can result in faster responses and fewer tokens used on reasoning in a response. - 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.- 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. |
No | |
| seed | OpenAI.integer | No | 42 | |
| temperature | OpenAI.numeric | No | 1 | |
| text | OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText | No | ||
| tools | array of OpenAI.Tool | No | ||
| top_p | OpenAI.numeric | No | 1 |
OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| format | OpenAI.TextResponseFormatConfiguration | An object specifying the format that the model must output. Configuring { "type": "json_schema" } enables Structured Outputs,which ensures the model will match your supplied JSON schema. Learn more in the The default format is { "type": "text" } with no additional options.*Not recommended for gpt-4o and newer models:** Setting to { "type": "json_object" } enables the older JSON mode, whichensures the message the model generates is valid JSON. Using json_schemais preferred for models that support it. |
No |
OpenAI.CreateEvalStoredCompletionsDataSourceConfig
Deprecated in favor of LogsDataSourceConfig.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| metadata | object | Metadata filters for the stored completions data source. | No | |
| type | enum | The type of data source. Always stored_completions.Possible values: stored_completions |
Yes |
OpenAI.CreateFineTuningJobRequest
Valid models:
babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| hyperparameters | OpenAI.CreateFineTuningJobRequestHyperparameters | No | ||
| └─ batch_size | string or OpenAI.integer | No | auto | |
| └─ learning_rate_multiplier | string or OpenAI.numeric | No | ||
| └─ n_epochs | string or OpenAI.integer | No | auto | |
| integrations | array of OpenAI.CreateFineTuningJobRequestIntegrations | A list of integrations to enable for your fine-tuning job. | No | |
| metadata | OpenAI.Metadata (nullable) | 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. |
No | |
| method | OpenAI.FineTuneMethod | The method used for fine-tuning. | No | |
| model | string (see valid models below) | The name of the model to fine-tune. You can select one of the supported models. |
Yes | |
| seed | OpenAI.integer (nullable) | No | ||
| suffix | string (nullable) | 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.Constraints: minLength: 1, maxLength: 64 |
No | |
| training_file | string | The ID of an uploaded file that contains training data. See upload file for how to upload a file. Your dataset must be formatted as a JSONL file. Additionally, you must upload your file with the purpose fine-tune.The contents of the file should differ depending on if the model uses the chat, completions format, or if the fine-tuning method uses the preference format. See the fine-tuning guide for more details. |
Yes | |
| validation_file | string (nullable) | The ID of an uploaded file that contains validation data. If you provide this file, the data is used to generate validation metrics periodically during fine-tuning. These metrics can be viewed in the fine-tuning results file. The same data should not be present in both train and validation files. Your dataset must be formatted as a JSONL file. You must upload your file with the purpose fine-tune.See the fine-tuning guide for more details. |
No |
OpenAI.CreateFineTuningJobRequestHyperparameters
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| batch_size | string or OpenAI.integer | No | ||
| learning_rate_multiplier | string or OpenAI.numeric | No | ||
| n_epochs | string or OpenAI.integer | No |
OpenAI.CreateFineTuningJobRequestIntegrations
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | Possible values: wandb |
Yes | |
| wandb | OpenAI.CreateFineTuningJobRequestIntegrationsWandb | Yes |
OpenAI.CreateFineTuningJobRequestIntegrationsWandb
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| entity | string (nullable) | No | ||
| name | string (nullable) | No | ||
| project | string | Yes | ||
| tags | array of string | No |
OpenAI.CreateResponseStreamingResponse
Type: OpenAI.ResponseAudioDeltaEvent or OpenAI.ResponseAudioTranscriptDeltaEvent or OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent or OpenAI.ResponseCodeInterpreterCallInProgressEvent or OpenAI.ResponseCodeInterpreterCallInterpretingEvent or OpenAI.ResponseContentPartAddedEvent or OpenAI.ResponseCreatedEvent or OpenAI.ResponseErrorEvent or OpenAI.ResponseFileSearchCallInProgressEvent or OpenAI.ResponseFileSearchCallSearchingEvent or OpenAI.ResponseFunctionCallArgumentsDeltaEvent or OpenAI.ResponseInProgressEvent or OpenAI.ResponseFailedEvent or OpenAI.ResponseIncompleteEvent or OpenAI.ResponseOutputItemAddedEvent or OpenAI.ResponseReasoningSummaryPartAddedEvent or OpenAI.ResponseReasoningSummaryTextDeltaEvent or OpenAI.ResponseReasoningTextDeltaEvent or OpenAI.ResponseRefusalDeltaEvent or OpenAI.ResponseTextDeltaEvent or OpenAI.ResponseWebSearchCallInProgressEvent or OpenAI.ResponseWebSearchCallSearchingEvent or OpenAI.ResponseImageGenCallGeneratingEvent or OpenAI.ResponseImageGenCallInProgressEvent or OpenAI.ResponseImageGenCallPartialImageEvent or OpenAI.ResponseMCPCallArgumentsDeltaEvent or OpenAI.ResponseMCPCallFailedEvent or OpenAI.ResponseMCPCallInProgressEvent or OpenAI.ResponseMCPListToolsFailedEvent or OpenAI.ResponseMCPListToolsInProgressEvent or OpenAI.ResponseOutputTextAnnotationAddedEvent or OpenAI.ResponseQueuedEvent or OpenAI.ResponseCustomToolCallInputDeltaEvent or OpenAI.ResponseAudioDoneEvent or OpenAI.ResponseAudioTranscriptDoneEvent or OpenAI.ResponseCodeInterpreterCallCodeDoneEvent or OpenAI.ResponseCodeInterpreterCallCompletedEvent or OpenAI.ResponseCompletedEvent or OpenAI.ResponseContentPartDoneEvent or OpenAI.ResponseFileSearchCallCompletedEvent or OpenAI.ResponseFunctionCallArgumentsDoneEvent or OpenAI.ResponseOutputItemDoneEvent or OpenAI.ResponseReasoningSummaryPartDoneEvent or OpenAI.ResponseReasoningSummaryTextDoneEvent or OpenAI.ResponseReasoningTextDoneEvent or OpenAI.ResponseRefusalDoneEvent or OpenAI.ResponseTextDoneEvent or OpenAI.ResponseWebSearchCallCompletedEvent or OpenAI.ResponseImageGenCallCompletedEvent or OpenAI.ResponseMCPCallArgumentsDoneEvent or OpenAI.ResponseMCPCallCompletedEvent or OpenAI.ResponseMCPListToolsCompletedEvent or OpenAI.ResponseCustomToolCallInputDoneEvent
OpenAI.CustomGrammarFormatParam
A grammar defined by the user.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| definition | string | The grammar definition. | Yes | |
| syntax | OpenAI.GrammarSyntax1 | Yes | ||
| type | enum | Grammar format. Always grammar.Possible values: grammar |
Yes |
OpenAI.CustomTextFormatParam
Unconstrained free-form text.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | Unconstrained text format. Always text.Possible values: text |
Yes |
OpenAI.CustomToolParam
A custom tool that processes input using a specified format. Learn more about custom tools
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | Optional description of the custom tool, used to provide more context. | No | |
| format | OpenAI.CustomToolParamFormat | The input format for the custom tool. Default is unconstrained text. | No | |
| └─ type | OpenAI.CustomToolParamFormatType | Yes | ||
| name | string | The name of the custom tool, used to identify it in tool calls. | Yes | |
| type | enum | The type of the custom tool. Always custom.Possible values: custom |
Yes |
OpenAI.CustomToolParamFormat
The input format for the custom tool. Default is unconstrained text.
Discriminator for OpenAI.CustomToolParamFormat
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
text |
OpenAI.CustomTextFormatParam |
grammar |
OpenAI.CustomGrammarFormatParam |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | OpenAI.CustomToolParamFormatType | Yes |
OpenAI.CustomToolParamFormatType
| Property | Value |
|---|---|
| Type | string |
| Values | textgrammar |
OpenAI.DeletedConversationResource
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| deleted | boolean | Yes | ||
| id | string | Yes | ||
| object | enum | Possible values: conversation.deleted |
Yes |
OpenAI.DetailEnum
| Property | Value |
|---|---|
| Type | string |
| Values | lowhighauto |
OpenAI.DoubleClickAction
A double click action.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | Specifies the event type. For a double click action, this property is always set to double_click.Possible values: double_click |
Yes | |
| x | OpenAI.integer | Yes | ||
| y | OpenAI.integer | Yes |
OpenAI.Drag
A drag action.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| path | array of OpenAI.DragPoint | An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg <br> [<br> { x: 100, y: 200 },<br> { x: 200, y: 300 }<br> ]<br> |
Yes | |
| type | enum | Specifies the event type. For a drag action, this property is always set to drag.Possible values: drag |
Yes |
OpenAI.DragPoint
An x/y coordinate pair, e.g. { x: 100, y: 200 }.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| x | OpenAI.integer | Yes | ||
| y | OpenAI.integer | Yes |
OpenAI.EasyInputMessage
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. Messages with the
assistant role are presumed to have been generated by the model in previous
interactions.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | string or OpenAI.InputMessageContentList | Text, image, or audio input to the model, used to generate a response. Can also contain previous assistant responses. |
Yes | |
| role | enum | The role of the message input. One of user, assistant, system, ordeveloper.Possible values: user, assistant, system, developer |
Yes | |
| status | enum | The status of item. One of in_progress, completed, orincomplete. Populated when items are returned via API.Possible values: in_progress, completed, incomplete |
No | |
| type | enum | The type of the message input. Always message.Possible values: message |
Yes |
OpenAI.Error
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| additionalInfo | object | No | ||
| code | string (nullable) | Yes | ||
| debugInfo | object | No | ||
| details | array of OpenAI.Error | No | ||
| message | string | Yes | ||
| param | string (nullable) | No | ||
| type | string | No |
OpenAI.EvalApiError
An object representing an error response from the Eval API.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| code | string | The error code. | Yes | |
| message | string | The error message. | Yes |
OpenAI.EvalGraderLabelModel
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| input | array of OpenAI.EvalItem | Yes | ||
| labels | array of string | The labels to assign to each item in the evaluation. | Yes | |
| model | string | The model to use for the evaluation. Must support structured outputs. | Yes | |
| name | string | The name of the grader. | Yes | |
| passing_labels | array of string | The labels that indicate a passing result. Must be a subset of labels. | Yes | |
| type | enum | The object type, which is always label_model.Possible values: label_model |
Yes |
OpenAI.EvalGraderPython
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| image_tag | string | The image tag to use for the python script. | No | |
| name | string | The name of the grader. | Yes | |
| pass_threshold | OpenAI.numeric | No | ||
| source | string | The source code of the python script. | Yes | |
| type | enum | The object type, which is always python.Possible values: python |
Yes |
OpenAI.EvalGraderScoreModel
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| input | array of OpenAI.EvalItem | The input messages evaluated by the grader. Supports text, output text, input image, and input audio content blocks, and may include template strings. | Yes | |
| model | string | The model to use for the evaluation. | Yes | |
| name | string | The name of the grader. | Yes | |
| pass_threshold | OpenAI.numeric | No | ||
| range | array of OpenAI.numeric | The range of the score. Defaults to [0, 1]. |
No | |
| sampling_params | OpenAI.EvalGraderScoreModelSamplingParams | No | ||
| └─ max_completions_tokens | OpenAI.integer (nullable) | No | ||
| └─ reasoning_effort | OpenAI.ReasoningEffort | Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducingreasoning effort can result in faster responses and fewer tokens used on reasoning in a response. - 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.- 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. |
No | |
| └─ seed | OpenAI.integer (nullable) | No | ||
| └─ temperature | OpenAI.numeric (nullable) | No | ||
| └─ top_p | OpenAI.numeric (nullable) | No | 1 | |
| type | enum | The object type, which is always score_model.Possible values: score_model |
Yes |
OpenAI.EvalGraderScoreModelSamplingParams
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| max_completions_tokens | OpenAI.integer (nullable) | No | ||
| reasoning_effort | OpenAI.ReasoningEffort | Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducingreasoning effort can result in faster responses and fewer tokens used on reasoning in a response. - 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.- 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. |
No | |
| seed | OpenAI.integer (nullable) | No | ||
| temperature | OpenAI.numeric (nullable) | No | ||
| top_p | OpenAI.numeric (nullable) | No | 1 |
OpenAI.EvalGraderStringCheck
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| input | string | The input text. This may include template strings. | Yes | |
| name | string | The name of the grader. | Yes | |
| operation | enum | The string check operation to perform. One of eq, ne, like, or ilike.Possible values: eq, ne, like, ilike |
Yes | |
| reference | string | The reference text. This may include template strings. | Yes | |
| type | enum | The object type, which is always string_check.Possible values: string_check |
Yes |
OpenAI.EvalGraderTextSimilarity
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| evaluation_metric | enum | The evaluation metric to use. One of cosine, fuzzy_match, bleu,gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5,or rouge_l.Possible values: cosine, fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, rouge_l |
Yes | |
| input | string | The text being graded. | Yes | |
| name | string | The name of the grader. | Yes | |
| pass_threshold | OpenAI.numeric | Yes | ||
| reference | string | The text being graded against. | Yes | |
| type | enum | The type of grader. Possible values: text_similarity |
Yes |
OpenAI.EvalItem
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. Messages with the
assistant role are presumed to have been generated by the model in previous
interactions.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | OpenAI.EvalItemContent | Inputs to the model - can contain template strings. Supports text, output text, input images, and input audio, either as a single item or an array of items. | Yes | |
| role | enum | The role of the message input. One of user, assistant, system, ordeveloper.Possible values: user, assistant, system, developer |
Yes | |
| type | enum | The type of the message input. Always message.Possible values: message |
No |
OpenAI.EvalItemContent
Inputs to the model - can contain template strings. Supports text, output text, input images, and input audio, either as a single item or an array of items.
Type: OpenAI.EvalItemContentItem or OpenAI.EvalItemContentArray
Inputs to the model - can contain template strings. Supports text, output text, input images, and input audio, either as a single item or an array of items.
OpenAI.EvalItemContentArray
A list of inputs, each of which may be either an input text, output text, input image, or input audio object.
Array of: OpenAI.EvalItemContentItem
OpenAI.EvalItemContentItem
A single content item: input text, output text, input image, or input audio.
Type: OpenAI.EvalItemContentText or OpenAI.EvalItemContentItemObject
A single content item: input text, output text, input image, or input audio.
OpenAI.EvalItemContentItemObject
A single content item: input text, output text, input image, or input audio.
Discriminator for OpenAI.EvalItemContentItemObject
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
output_text |
OpenAI.EvalItemContentOutputText |
input_image |
OpenAI.EvalItemInputImage |
input_audio |
OpenAI.InputAudio |
input_text |
OpenAI.EvalItemContentItemObjectInputTextContent |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | OpenAI.EvalItemContentItemObjectType | Yes |
OpenAI.EvalItemContentItemObjectInputTextContent
A text input to the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| text | string | The text input to the model. | Yes | |
| type | enum | The type of the input item. Always input_text.Possible values: input_text |
Yes |
OpenAI.EvalItemContentItemObjectType
| Property | Value |
|---|---|
| Type | string |
| Values | input_textoutput_textinput_imageinput_audio |
OpenAI.EvalItemContentOutputText
A text output from the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| text | string | The text output from the model. | Yes | |
| type | enum | The type of the output text. Always output_text.Possible values: output_text |
Yes |
OpenAI.EvalItemContentText
A text input to the model.
Type: string
OpenAI.EvalItemInputImage
An image input block used within EvalItem content arrays.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| detail | string | The detail level of the image to be sent to the model. One of high, low, or auto. Defaults to auto. |
No | |
| image_url | string | The URL of the image input. | Yes | |
| type | enum | The type of the image input. Always input_image.Possible values: input_image |
Yes |
OpenAI.EvalJsonlFileContentSource
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | array of OpenAI.EvalJsonlFileContentSourceContent | The content of the jsonl file. | Yes | |
| type | enum | The type of jsonl source. Always file_content.Possible values: file_content |
Yes |
OpenAI.EvalJsonlFileContentSourceContent
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item | object | Yes | ||
| sample | object | No |
OpenAI.EvalJsonlFileIdSource
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| id | string | The identifier of the file. | Yes | |
| type | enum | The type of jsonl source. Always file_id.Possible values: file_id |
Yes |
OpenAI.EvalResponsesSource
A EvalResponsesSource object describing a run data source configuration.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| created_after | OpenAI.integer (nullable) | No | ||
| created_before | OpenAI.integer (nullable) | No | ||
| instructions_search | string (nullable) | No | ||
| metadata | object (nullable) | No | ||
| model | string (nullable) | No | ||
| reasoning_effort | OpenAI.ReasoningEffort (nullable) | Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducingreasoning effort can result in faster responses and fewer tokens used on reasoning in a response. - 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.- 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. |
No | |
| temperature | OpenAI.numeric (nullable) | No | ||
| tools | array of string | No | ||
| top_p | OpenAI.numeric (nullable) | No | ||
| type | enum | The type of run data source. Always responses.Possible values: responses |
Yes | |
| users | array of string | No |
OpenAI.EvalRunOutputItemSample
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| error | OpenAI.EvalApiError | An object representing an error response from the Eval API. | Yes | |
| finish_reason | string | Yes | ||
| input | array of EvalRunOutputItemSampleInput | Yes | ||
| max_completion_tokens | OpenAI.integer | Yes | ||
| model | string | Yes | ||
| output | array of EvalRunOutputItemSampleOutput | Yes | ||
| seed | OpenAI.integer | Yes | ||
| temperature | OpenAI.numeric | Yes | ||
| top_p | OpenAI.numeric | Yes | ||
| usage | OpenAI.EvalRunOutputItemSampleUsage | Yes |
OpenAI.EvalRunOutputItemSampleUsage
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| cached_tokens | OpenAI.integer | Yes | ||
| completion_tokens | OpenAI.integer | Yes | ||
| prompt_tokens | OpenAI.integer | Yes | ||
| total_tokens | OpenAI.integer | Yes |
OpenAI.EvalRunPerModelUsage
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| cached_tokens | OpenAI.integer | Yes | ||
| completion_tokens | OpenAI.integer | Yes | ||
| invocation_count | OpenAI.integer | Yes | ||
| model_name | string | Yes | ||
| prompt_tokens | OpenAI.integer | Yes | ||
| total_tokens | OpenAI.integer | Yes |
OpenAI.EvalRunPerTestingCriteriaResults
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| failed | OpenAI.integer | Yes | ||
| passed | OpenAI.integer | Yes | ||
| testing_criteria | string | Yes |
OpenAI.EvalRunResultCounts
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| errored | OpenAI.integer | Yes | ||
| failed | OpenAI.integer | Yes | ||
| passed | OpenAI.integer | Yes | ||
| total | OpenAI.integer | Yes |
OpenAI.EvalStoredCompletionsSource
A StoredCompletionsRunDataSource configuration describing a set of filters
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| created_after | OpenAI.integer (nullable) | No | ||
| created_before | OpenAI.integer (nullable) | No | ||
| limit | OpenAI.integer (nullable) | No | ||
| metadata | OpenAI.Metadata (nullable) | 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. |
No | |
| model | string (nullable) | No | ||
| type | enum | The type of source. Always stored_completions.Possible values: stored_completions |
Yes |
OpenAI.FileCitationBody
A citation to a file.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| file_id | string | The ID of the file. | Yes | |
| filename | string | The filename of the file cited. | Yes | |
| index | OpenAI.integer | Yes | ||
| type | enum | The type of the file citation. Always file_citation.Possible values: file_citation |
Yes |
OpenAI.FilePath
A path to a file.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| file_id | string | The ID of the file. | Yes | |
| index | OpenAI.integer | Yes | ||
| type | enum | The type of the file path. Always file_path.Possible values: file_path |
Yes |
OpenAI.FileSearchTool
A tool that searches for relevant content from uploaded files.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| filters | OpenAI.Filters (nullable) | No | ||
| max_num_results | OpenAI.integer | No | ||
| ranking_options | OpenAI.RankingOptions | No | ||
| └─ hybrid_search | OpenAI.HybridSearchOptions | Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. | No | |
| └─ ranker | OpenAI.RankerVersionType | The ranker to use for the file search. | No | |
| └─ score_threshold | OpenAI.numeric | The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results. | No | |
| type | enum | The type of the file search tool. Always file_search.Possible values: file_search |
Yes | |
| vector_store_ids | array of string | The IDs of the vector stores to search. | Yes |
OpenAI.FileSearchToolCallResults
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| attributes | OpenAI.VectorStoreFileAttributes (nullable) | 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, booleans, or numbers. |
No | |
| file_id | string | No | ||
| filename | string | No | ||
| score | number | No | ||
| text | string | No |
OpenAI.Filters
Type: OpenAI.ComparisonFilter or OpenAI.CompoundFilter
OpenAI.FineTuneDPOHyperparameters
The hyperparameters used for the DPO fine-tuning job.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| batch_size | string or OpenAI.integer | Number of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance. | No | |
| beta | string or OpenAI.numeric | The beta value for the DPO method. A higher beta value will increase the weight of the penalty between the policy and reference model. | No | |
| learning_rate_multiplier | string or OpenAI.numeric | Scaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting. | No | |
| n_epochs | string or OpenAI.integer | The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset. | No |
OpenAI.FineTuneDPOMethod
Configuration for the DPO fine-tuning method.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| hyperparameters | OpenAI.FineTuneDPOHyperparameters | The hyperparameters used for the DPO fine-tuning job. | No |
OpenAI.FineTuneMethod
The method used for fine-tuning.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| dpo | OpenAI.FineTuneDPOMethod | Configuration for the DPO fine-tuning method. | No | |
| reinforcement | OpenAI.FineTuneReinforcementMethod | Configuration for the reinforcement fine-tuning method. | No | |
| supervised | OpenAI.FineTuneSupervisedMethod | Configuration for the supervised fine-tuning method. | No | |
| type | enum | The type of method. Is either supervised, dpo, or reinforcement.Possible values: supervised, dpo, reinforcement |
Yes |
OpenAI.FineTuneReinforcementHyperparameters
The hyperparameters used for the reinforcement fine-tuning job.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| batch_size | string or OpenAI.integer | Number of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance. | No | |
| compute_multiplier | string or OpenAI.numeric | Multiplier on amount of compute used for exploring search space during training. | No | |
| eval_interval | string or OpenAI.integer | The number of training steps between evaluation runs. | No | |
| eval_samples | string or OpenAI.integer | Number of evaluation samples to generate per training step. | No | |
| learning_rate_multiplier | string or OpenAI.numeric | Scaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting. | No | |
| n_epochs | string or OpenAI.integer | The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset. | No | |
| reasoning_effort | enum | Level of reasoning effort. Possible values: default, low, medium, high |
No |
OpenAI.FineTuneReinforcementMethod
Configuration for the reinforcement fine-tuning method.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| grader | OpenAI.GraderStringCheck or OpenAI.GraderTextSimilarity or OpenAI.GraderPython or OpenAI.GraderScoreModel or OpenAI.GraderMulti | The grader used for the fine-tuning job. | Yes | |
| hyperparameters | OpenAI.FineTuneReinforcementHyperparameters | The hyperparameters used for the reinforcement fine-tuning job. | No |
OpenAI.FineTuneSupervisedHyperparameters
The hyperparameters used for the fine-tuning job.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| batch_size | string or OpenAI.integer | Number of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance. | No | |
| learning_rate_multiplier | string or OpenAI.numeric | Scaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting. | No | |
| n_epochs | string or OpenAI.integer | The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset. | No |
OpenAI.FineTuneSupervisedMethod
Configuration for the supervised fine-tuning method.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| hyperparameters | OpenAI.FineTuneSupervisedHyperparameters | The hyperparameters used for the fine-tuning job. | No |
OpenAI.FineTuningIntegration
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | The type of the integration being enabled for the fine-tuning job Possible values: wandb |
Yes | |
| wandb | OpenAI.FineTuningIntegrationWandb | Yes | ||
| └─ entity | string (nullable) | No | ||
| └─ name | string (nullable) | No | ||
| └─ project | string | Yes | ||
| └─ tags | array of string | No |
OpenAI.FineTuningIntegrationWandb
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| entity | string (nullable) | No | ||
| name | string (nullable) | No | ||
| project | string | Yes | ||
| tags | array of string | No |
OpenAI.FineTuningJob
The fine_tuning.job object represents a fine-tuning job that has been created through the API.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| created_at | integer | The Unix timestamp (in seconds) for when the fine-tuning job was created. | Yes | |
| error | OpenAI.FineTuningJobError (nullable) | Yes | ||
| └─ code | string | Yes | ||
| └─ message | string | Yes | ||
| └─ param | string (nullable) | Yes | ||
| estimated_finish | integer | No | ||
| fine_tuned_model | string (nullable) | Yes | ||
| finished_at | integer | Yes | ||
| hyperparameters | OpenAI.FineTuningJobHyperparameters | Yes | ||
| └─ batch_size | string or OpenAI.integer | No | auto | |
| └─ learning_rate_multiplier | string or OpenAI.numeric | No | ||
| └─ n_epochs | string or OpenAI.integer | No | auto | |
| id | string | The object identifier, which can be referenced in the API endpoints. | Yes | |
| integrations | array of OpenAI.FineTuningIntegration | No | ||
| metadata | OpenAI.Metadata (nullable) | 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. |
No | |
| method | OpenAI.FineTuneMethod | The method used for fine-tuning. | No | |
| model | string | The base model that is being fine-tuned. | Yes | |
| object | enum | The object type, which is always "fine_tuning.job". Possible values: fine_tuning.job |
Yes | |
| organization_id | string | The organization that owns the fine-tuning job. | Yes | |
| result_files | array of string | The compiled results file ID(s) for the fine-tuning job. You can retrieve the results with the Files API. | Yes | |
| seed | OpenAI.integer | Yes | ||
| status | enum | The current status of the fine-tuning job, which can be either validating_files, queued, running, succeeded, failed, or cancelled.Possible values: validating_files, queued, running, succeeded, failed, cancelled |
Yes | |
| trained_tokens | OpenAI.integer (nullable) | Yes | ||
| training_file | string | The file ID used for training. You can retrieve the training data with the Files API. | Yes | |
| validation_file | string (nullable) | Yes |
OpenAI.FineTuningJobCheckpoint
The fine_tuning.job.checkpoint object represents a model checkpoint for a fine-tuning job that is ready to use.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| created_at | integer | The Unix timestamp (in seconds) for when the checkpoint was created. | Yes | |
| fine_tuned_model_checkpoint | string | The name of the fine-tuned checkpoint model that is created. | Yes | |
| fine_tuning_job_id | string | The name of the fine-tuning job that this checkpoint was created from. | Yes | |
| id | string | The checkpoint identifier, which can be referenced in the API endpoints. | Yes | |
| metrics | OpenAI.FineTuningJobCheckpointMetrics | Yes | ||
| └─ full_valid_loss | OpenAI.numeric | No | ||
| └─ full_valid_mean_token_accuracy | OpenAI.numeric | No | ||
| └─ step | OpenAI.numeric | No | ||
| └─ train_loss | OpenAI.numeric | No | ||
| └─ train_mean_token_accuracy | OpenAI.numeric | No | ||
| └─ valid_loss | OpenAI.numeric | No | ||
| └─ valid_mean_token_accuracy | OpenAI.numeric | No | ||
| object | enum | The object type, which is always "fine_tuning.job.checkpoint". Possible values: fine_tuning.job.checkpoint |
Yes | |
| step_number | OpenAI.integer | Yes |
OpenAI.FineTuningJobCheckpointMetrics
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| full_valid_loss | OpenAI.numeric | No | ||
| full_valid_mean_token_accuracy | OpenAI.numeric | No | ||
| step | OpenAI.numeric | No | ||
| train_loss | OpenAI.numeric | No | ||
| train_mean_token_accuracy | OpenAI.numeric | No | ||
| valid_loss | OpenAI.numeric | No | ||
| valid_mean_token_accuracy | OpenAI.numeric | No |
OpenAI.FineTuningJobError
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| code | string | Yes | ||
| message | string | Yes | ||
| param | string (nullable) | Yes |
OpenAI.FineTuningJobEvent
Fine-tuning job event object
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| created_at | integer | The Unix timestamp (in seconds) for when the fine-tuning job was created. | Yes | |
| data | OpenAI.FineTuningJobEventData | No | ||
| id | string | The object identifier. | Yes | |
| level | enum | The log level of the event. Possible values: info, warn, error |
Yes | |
| message | string | The message of the event. | Yes | |
| object | enum | The object type, which is always "fine_tuning.job.event". Possible values: fine_tuning.job.event |
Yes | |
| type | enum | The type of event. Possible values: message, metrics |
No |
OpenAI.FineTuningJobEventData
Type: object
OpenAI.FineTuningJobHyperparameters
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| batch_size | string or OpenAI.integer | No | ||
| learning_rate_multiplier | string or OpenAI.numeric | No | ||
| n_epochs | string or OpenAI.integer | No |
OpenAI.FunctionAndCustomToolCallOutput
Discriminator for OpenAI.FunctionAndCustomToolCallOutput
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
input_text |
OpenAI.FunctionAndCustomToolCallOutputInputTextContent |
input_image |
OpenAI.FunctionAndCustomToolCallOutputInputImageContent |
input_file |
OpenAI.FunctionAndCustomToolCallOutputInputFileContent |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | OpenAI.FunctionAndCustomToolCallOutputType | Yes |
OpenAI.FunctionAndCustomToolCallOutputInputFileContent
A file input to the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| file_data | string | The content of the file to be sent to the model. | No | |
| file_id | string (nullable) | No | ||
| file_url | string | The URL of the file to be sent to the model. | No | |
| filename | string | The name of the file to be sent to the model. | No | |
| type | enum | The type of the input item. Always input_file.Possible values: input_file |
Yes |
OpenAI.FunctionAndCustomToolCallOutputInputImageContent
An image input to the model. Learn about image inputs.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| detail | OpenAI.ImageDetail | Yes | ||
| file_id | string (nullable) | No | ||
| image_url | string | No | ||
| type | enum | The type of the input item. Always input_image.Possible values: input_image |
Yes |
OpenAI.FunctionAndCustomToolCallOutputInputTextContent
A text input to the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| text | string | The text input to the model. | Yes | |
| type | enum | The type of the input item. Always input_text.Possible values: input_text |
Yes |
OpenAI.FunctionAndCustomToolCallOutputType
| Property | Value |
|---|---|
| Type | string |
| Values | input_textinput_imageinput_file |
OpenAI.FunctionCallItemStatus
| Property | Value |
|---|---|
| Type | string |
| Values | in_progresscompletedincomplete |
OpenAI.FunctionObject
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | A description of what the function does, used by the model to choose when and how to call the function. | No | |
| name | string | The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. | Yes | |
| parameters | OpenAI.FunctionParameters | The parameters the functions accepts, described as a JSON Schema object. See the guide for examples, and the JSON Schema reference for documentation about the format. Omitting parameters defines a function with an empty parameter list. |
No | |
| strict | boolean (nullable) | No |
OpenAI.FunctionParameters
The parameters the functions accepts, described as a JSON Schema object. See the guide for examples, and the JSON Schema reference for documentation about the format.
Omitting parameters defines a function with an empty parameter list.
Type: object
OpenAI.FunctionShellAction
Execute a shell command.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| commands | array of string | Yes | ||
| max_output_length | OpenAI.integer (nullable) | Yes | ||
| timeout_ms | OpenAI.integer (nullable) | Yes |
OpenAI.FunctionShellActionParam
Commands and limits describing how to run the shell tool call.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| commands | array of string | Ordered shell commands for the execution environment to run. | Yes | |
| max_output_length | OpenAI.integer (nullable) | No | ||
| timeout_ms | OpenAI.integer (nullable) | No |
OpenAI.FunctionShellCallItemStatus
Status values reported for shell tool calls.
| Property | Value |
|---|---|
| Type | string |
| Values | in_progresscompletedincomplete |
OpenAI.FunctionShellCallOutputContent
The content of a shell tool call output that was emitted.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| created_by | string | The identifier of the actor that created the item. | No | |
| outcome | OpenAI.FunctionShellCallOutputOutcome | Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk. | Yes | |
| └─ type | OpenAI.FunctionShellCallOutputOutcomeType | Yes | ||
| stderr | string | The standard error output that was captured. | Yes | |
| stdout | string | The standard output that was captured. | Yes |
OpenAI.FunctionShellCallOutputContentParam
Captured stdout and stderr for a portion of a shell tool call output.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| outcome | OpenAI.FunctionShellCallOutputOutcomeParam | The exit or timeout outcome associated with this shell call. | Yes | |
| └─ type | OpenAI.FunctionShellCallOutputOutcomeParamType | Yes | ||
| stderr | string | Captured stderr output for the shell call. Constraints: maxLength: 10485760 |
Yes | |
| stdout | string | Captured stdout output for the shell call. Constraints: maxLength: 10485760 |
Yes |
OpenAI.FunctionShellCallOutputExitOutcome
Indicates that the shell commands finished and returned an exit code.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| exit_code | OpenAI.integer | Yes | ||
| type | enum | The outcome type. Always exit.Possible values: exit |
Yes |
OpenAI.FunctionShellCallOutputExitOutcomeParam
Indicates that the shell commands finished and returned an exit code.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| exit_code | OpenAI.integer | Yes | ||
| type | enum | The outcome type. Always exit.Possible values: exit |
Yes |
OpenAI.FunctionShellCallOutputOutcome
Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk.
Discriminator for OpenAI.FunctionShellCallOutputOutcome
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
timeout |
OpenAI.FunctionShellCallOutputTimeoutOutcome |
exit |
OpenAI.FunctionShellCallOutputExitOutcome |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | OpenAI.FunctionShellCallOutputOutcomeType | Yes |
OpenAI.FunctionShellCallOutputOutcomeParam
The exit or timeout outcome associated with this shell call.
Discriminator for OpenAI.FunctionShellCallOutputOutcomeParam
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
timeout |
OpenAI.FunctionShellCallOutputTimeoutOutcomeParam |
exit |
OpenAI.FunctionShellCallOutputExitOutcomeParam |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | OpenAI.FunctionShellCallOutputOutcomeParamType | Yes |
OpenAI.FunctionShellCallOutputOutcomeParamType
| Property | Value |
|---|---|
| Type | string |
| Values | timeoutexit |
OpenAI.FunctionShellCallOutputOutcomeType
| Property | Value |
|---|---|
| Type | string |
| Values | timeoutexit |
OpenAI.FunctionShellCallOutputTimeoutOutcome
Indicates that the shell call exceeded its configured time limit.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | The outcome type. Always timeout.Possible values: timeout |
Yes |
OpenAI.FunctionShellCallOutputTimeoutOutcomeParam
Indicates that the shell call exceeded its configured time limit.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | The outcome type. Always timeout.Possible values: timeout |
Yes |
OpenAI.FunctionShellToolParam
A tool that allows the model to execute shell commands.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | The type of the shell tool. Always shell.Possible values: shell |
Yes |
OpenAI.FunctionTool
Defines a function in your own code the model can choose to call.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string (nullable) | No | ||
| name | string | The name of the function to call. | Yes | |
| parameters | object (nullable) | Yes | ||
| strict | boolean (nullable) | Yes | ||
| type | enum | The type of the function tool. Always function.Possible values: function |
Yes |
OpenAI.GraderLabelModel
A LabelModelGrader object which uses a model to assign labels to each item in the evaluation.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| input | array of OpenAI.EvalItem | Yes | ||
| labels | array of string | The labels to assign to each item in the evaluation. | Yes | |
| model | string | The model to use for the evaluation. Must support structured outputs. | Yes | |
| name | string | The name of the grader. | Yes | |
| passing_labels | array of string | The labels that indicate a passing result. Must be a subset of labels. | Yes | |
| type | enum | The object type, which is always label_model.Possible values: label_model |
Yes |
OpenAI.GraderMulti
A MultiGrader object combines the output of multiple graders to produce a single score.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| calculate_output | string | A formula to calculate the output based on grader results. | Yes | |
| graders | OpenAI.GraderStringCheck or OpenAI.GraderTextSimilarity or OpenAI.GraderPython or OpenAI.GraderScoreModel or OpenAI.GraderLabelModel | Yes | ||
| name | string | The name of the grader. | Yes | |
| type | enum | The object type, which is always multi.Possible values: multi |
Yes |
OpenAI.GraderPython
A PythonGrader object that runs a python script on the input.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| image_tag | string | The image tag to use for the python script. | No | |
| name | string | The name of the grader. | Yes | |
| source | string | The source code of the python script. | Yes | |
| type | enum | The object type, which is always python.Possible values: python |
Yes |
OpenAI.GraderScoreModel
A ScoreModelGrader object that uses a model to assign a score to the input.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| input | array of OpenAI.EvalItem | The input messages evaluated by the grader. Supports text, output text, input image, and input audio content blocks, and may include template strings. | Yes | |
| model | string | The model to use for the evaluation. | Yes | |
| name | string | The name of the grader. | Yes | |
| range | array of OpenAI.numeric | The range of the score. Defaults to [0, 1]. |
No | |
| sampling_params | OpenAI.EvalGraderScoreModelSamplingParams | No | ||
| └─ max_completions_tokens | OpenAI.integer (nullable) | No | ||
| └─ reasoning_effort | OpenAI.ReasoningEffort | Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducingreasoning effort can result in faster responses and fewer tokens used on reasoning in a response. - 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.- 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. |
No | |
| └─ seed | OpenAI.integer (nullable) | No | ||
| └─ temperature | OpenAI.numeric (nullable) | No | ||
| └─ top_p | OpenAI.numeric (nullable) | No | 1 | |
| type | enum | The object type, which is always score_model.Possible values: score_model |
Yes |
OpenAI.GraderStringCheck
A StringCheckGrader object that performs a string comparison between input and reference using a specified operation.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| input | string | The input text. This may include template strings. | Yes | |
| name | string | The name of the grader. | Yes | |
| operation | enum | The string check operation to perform. One of eq, ne, like, or ilike.Possible values: eq, ne, like, ilike |
Yes | |
| reference | string | The reference text. This may include template strings. | Yes | |
| type | enum | The object type, which is always string_check.Possible values: string_check |
Yes |
OpenAI.GraderTextSimilarity
A TextSimilarityGrader object which grades text based on similarity metrics.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| evaluation_metric | enum | The evaluation metric to use. One of cosine, fuzzy_match, bleu,gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5,or rouge_l.Possible values: cosine, fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, rouge_l |
Yes | |
| input | string | The text being graded. | Yes | |
| name | string | The name of the grader. | Yes | |
| reference | string | The text being graded against. | Yes | |
| type | enum | The type of grader. Possible values: text_similarity |
Yes |
OpenAI.GrammarSyntax1
| Property | Value |
|---|---|
| Type | string |
| Values | larkregex |
OpenAI.HybridSearchOptions
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| embedding_weight | OpenAI.numeric | Yes | ||
| text_weight | OpenAI.numeric | Yes |
OpenAI.ImageDetail
| Property | Value |
|---|---|
| Type | string |
| Values | lowhighauto |
OpenAI.ImageGenTool
A tool that generates images using the GPT image models.
Valid models:
gpt-image-1
gpt-image-1-mini
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| background | enum | Background type for the generated image. One of transparent,opaque, or auto. Default: auto.Possible values: transparent, opaque, auto |
No | |
| input_fidelity | OpenAI.InputFidelity (nullable) | Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1. Unsupported for gpt-image-1-mini. Supports high and low. Defaults to low. |
No | |
| input_image_mask | OpenAI.ImageGenToolInputImageMask | No | ||
| └─ file_id | string | No | ||
| └─ image_url | string | No | ||
| model | string (see valid models below) | No | ||
| moderation | enum | Moderation level for the generated image. Default: auto.Possible values: auto, low |
No | |
| output_compression | OpenAI.integer | No | 100 | |
| output_format | enum | The output format of the generated image. One of png, webp, orjpeg. Default: png.Possible values: png, webp, jpeg |
No | |
| partial_images | OpenAI.integer | No | ||
| quality | enum | The quality of the generated image. One of low, medium, high,or auto. Default: auto.Possible values: low, medium, high, auto |
No | |
| size | enum | The size of the generated image. One of 1024x1024, 1024x1536,1536x1024, or auto. Default: auto.Possible values: 1024x1024, 1024x1536, 1536x1024, auto |
No | |
| type | enum | The type of the image generation tool. Always image_generation.Possible values: image_generation |
Yes |
OpenAI.ImageGenToolInputImageMask
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| file_id | string | No | ||
| image_url | string | No |
OpenAI.IncludeEnum
Specify additional output data to include in the model response. Currently supported values are:
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.file_search_call.results: Include the search results of the file search tool call.message.input_image.image_url: Include image urls from the input message.message.output_text.logprobs: Include logprobs with assistant messages.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 thestoreparameter is set tofalse, or when an organization is enrolled in the zero data retention program).
| Property | Value |
|---|---|
| Description | Specify additional output data to include in the model response. Currently supported values are: |
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.file_search_call.results: Include the search results of the file search tool call.message.input_image.image_url: Include image urls from the input message.message.output_text.logprobs: Include logprobs with assistant messages.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 thestoreparameter is set tofalse, or when an organization is enrolled in the zero data retention program). | | Type | string | | Values |file_search_call.resultsweb_search_call.resultsweb_search_call.action.sourcesmessage.input_image.image_urlcomputer_call_output.output.image_urlcode_interpreter_call.outputsreasoning.encrypted_contentmessage.output_text.logprobsmemory_search_call.results|
OpenAI.InputAudio
An audio input to the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| input_audio | OpenAI.InputAudioInputAudio | Yes | ||
| type | enum | The type of the input item. Always input_audio.Possible values: input_audio |
Yes |
OpenAI.InputAudioInputAudio
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | string | Yes | ||
| format | enum | Possible values: mp3, wav |
Yes |
OpenAI.InputContent
Discriminator for OpenAI.InputContent
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
input_text |
OpenAI.InputContentInputTextContent |
input_image |
OpenAI.InputContentInputImageContent |
input_file |
OpenAI.InputContentInputFileContent |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | OpenAI.InputContentType | Yes |
OpenAI.InputContentInputFileContent
A file input to the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| file_data | string | The content of the file to be sent to the model. | No | |
| file_id | string (nullable) | No | ||
| file_url | string | The URL of the file to be sent to the model. | No | |
| filename | string | The name of the file to be sent to the model. | No | |
| type | enum | The type of the input item. Always input_file.Possible values: input_file |
Yes |
OpenAI.InputContentInputImageContent
An image input to the model. Learn about image inputs.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| detail | OpenAI.ImageDetail | Yes | ||
| file_id | string (nullable) | No | ||
| image_url | string | No | ||
| type | enum | The type of the input item. Always input_image.Possible values: input_image |
Yes |
OpenAI.InputContentInputTextContent
A text input to the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| text | string | The text input to the model. | Yes | |
| type | enum | The type of the input item. Always input_text.Possible values: input_text |
Yes |
OpenAI.InputContentType
| Property | Value |
|---|---|
| Type | string |
| Values | input_textinput_imageinput_file |
OpenAI.InputFidelity
Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1. Unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.
| Property | Value |
|---|---|
| Type | string |
| Values | highlow |
OpenAI.InputFileContent
A file input to the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| file_data | string | The content of the file to be sent to the model. | No | |
| file_id | string (nullable) | No | ||
| file_url | string | The URL of the file to be sent to the model. | No | |
| filename | string | The name of the file to be sent to the model. | No | |
| type | enum | The type of the input item. Always input_file.Possible values: input_file |
Yes |
OpenAI.InputFileContentParam
A file input to the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| file_data | string (nullable) | No | ||
| file_id | string (nullable) | No | ||
| file_url | string | No | ||
| filename | string (nullable) | No | ||
| type | enum | The type of the input item. Always input_file.Possible values: input_file |
Yes |
OpenAI.InputImageContent
An image input to the model. Learn about image inputs.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| detail | OpenAI.ImageDetail | Yes | ||
| file_id | string (nullable) | No | ||
| image_url | string | No | ||
| type | enum | The type of the input item. Always input_image.Possible values: input_image |
Yes |
OpenAI.InputImageContentParamAutoParam
An image input to the model. Learn about image inputs
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| detail | OpenAI.DetailEnum (nullable) | No | ||
| file_id | string (nullable) | No | ||
| image_url | string | No | ||
| type | enum | The type of the input item. Always input_image.Possible values: input_image |
Yes |
OpenAI.InputItem
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.
Discriminator for OpenAI.InputItem
This component uses the property type to discriminate between different types:
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | OpenAI.InputItemType | Yes |
OpenAI.InputItemApplyPatchToolCallItemParam
A tool call representing a request to create, delete, or update files using diff patches.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| call_id | string | The unique ID of the apply patch tool call generated by the model. Constraints: minLength: 1, maxLength: 64 |
Yes | |
| id | string (nullable) | No | ||
| operation | OpenAI.ApplyPatchOperationParam | One of the create_file, delete_file, or update_file operations supplied to the apply_patch tool. | Yes | |
| └─ type | OpenAI.ApplyPatchOperationParamType | Yes | ||
| status | OpenAI.ApplyPatchCallStatusParam | Status values reported for apply_patch tool calls. | Yes | |
| type | enum | The type of the item. Always apply_patch_call.Possible values: apply_patch_call |
Yes |
OpenAI.InputItemApplyPatchToolCallOutputItemParam
The streamed output emitted by an apply patch tool call.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| call_id | string | The unique ID of the apply patch tool call generated by the model. Constraints: minLength: 1, maxLength: 64 |
Yes | |
| id | string (nullable) | No | ||
| output | string (nullable) | No | ||
| status | OpenAI.ApplyPatchCallOutputStatusParam | Outcome values reported for apply_patch tool call outputs. | Yes | |
| type | enum | The type of the item. Always apply_patch_call_output.Possible values: apply_patch_call_output |
Yes |
OpenAI.InputItemCodeInterpreterToolCall
A tool call to run code.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| code | string (nullable) | Yes | ||
| container_id | string | The ID of the container used to run the code. | Yes | |
| id | string | The unique ID of the code interpreter tool call. | Yes | |
| outputs | array of OpenAI.CodeInterpreterOutputLogs or OpenAI.CodeInterpreterOutputImage | Yes | ||
| status | enum | The status of the code interpreter tool call. Valid values are in_progress, completed, incomplete, interpreting, and failed.Possible values: in_progress, completed, incomplete, interpreting, failed |
Yes | |
| type | enum | The type of the code interpreter tool call. Always code_interpreter_call.Possible values: code_interpreter_call |
Yes |
OpenAI.InputItemCompactionSummaryItemParam
A compaction item generated by the v1/responses/compact API.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| encrypted_content | string | The encrypted content of the compaction summary. Constraints: maxLength: 10485760 |
Yes | |
| id | string (nullable) | No | ||
| type | enum | The type of the item. Always compaction.Possible values: compaction |
Yes |
OpenAI.InputItemComputerCallOutputItemParam
The output of a computer tool call.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| acknowledged_safety_checks | array of OpenAI.ComputerCallSafetyCheckParam | No | ||
| call_id | string | The ID of the computer tool call that produced the output. Constraints: minLength: 1, maxLength: 64 |
Yes | |
| id | string (nullable) | No | ||
| output | OpenAI.ComputerScreenshotImage | A computer screenshot image used with the computer use tool. | Yes | |
| status | OpenAI.FunctionCallItemStatus (nullable) | No | ||
| type | enum | The type of the computer tool call output. Always computer_call_output.Possible values: computer_call_output |
Yes |
OpenAI.InputItemComputerToolCall
A tool call to a computer use tool. See the computer use guide for more information.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| action | OpenAI.ComputerAction | Yes | ||
| call_id | string | An identifier used when responding to the tool call with output. | Yes | |
| id | string | The unique ID of the computer call. | Yes | |
| pending_safety_checks | array of OpenAI.ComputerCallSafetyCheckParam | The pending safety checks for the computer call. | Yes | |
| status | enum | The status of the item. One of in_progress, completed, orincomplete. Populated when items are returned via API.Possible values: in_progress, completed, incomplete |
Yes | |
| type | enum | The type of the computer call. Always computer_call.Possible values: computer_call |
Yes |
OpenAI.InputItemCustomToolCall
A call to a custom tool created by the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| call_id | string | An identifier used to map this custom tool call to a tool call output. | Yes | |
| id | string | The unique ID of the custom tool call in the OpenAI platform. | No | |
| input | string | The input for the custom tool call generated by the model. | Yes | |
| name | string | The name of the custom tool being called. | Yes | |
| type | enum | The type of the custom tool call. Always custom_tool_call.Possible values: custom_tool_call |
Yes |
OpenAI.InputItemCustomToolCallOutput
The output of a custom tool call from your code, being sent back to the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| call_id | string | The call ID, used to map this custom tool call output to a custom tool call. | Yes | |
| id | string | The unique ID of the custom tool call output in the OpenAI platform. | No | |
| output | string or array of OpenAI.FunctionAndCustomToolCallOutput | The output from the custom tool call generated by your code. Can be a string or an list of output content. |
Yes | |
| type | enum | The type of the custom tool call output. Always custom_tool_call_output.Possible values: custom_tool_call_output |
Yes |
OpenAI.InputItemFileSearchToolCall
The results of a file search tool call. See the file search guide for more information.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| id | string | The unique ID of the file search tool call. | Yes | |
| queries | array of string | The queries used to search for files. | Yes | |
| results | array of OpenAI.FileSearchToolCallResults | No | ||
| status | enum | The status of the file search tool call. One of in_progress,searching, incomplete or failed,Possible values: in_progress, searching, completed, incomplete, failed |
Yes | |
| type | enum | The type of the file search tool call. Always file_search_call.Possible values: file_search_call |
Yes |
OpenAI.InputItemFunctionCallOutputItemParam
The output of a function tool call.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| call_id | string | The unique ID of the function tool call generated by the model. Constraints: minLength: 1, maxLength: 64 |
Yes | |
| id | string (nullable) | No | ||
| output | string or array of OpenAI.InputTextContentParam or OpenAI.InputImageContentParamAutoParam or OpenAI.InputFileContentParam | Text, image, or file output of the function tool call. | Yes | |
| status | OpenAI.FunctionCallItemStatus (nullable) | No | ||
| type | enum | The type of the function tool call output. Always function_call_output.Possible values: function_call_output |
Yes |
OpenAI.InputItemFunctionShellCallItemParam
A tool representing a request to execute one or more shell commands.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| action | OpenAI.FunctionShellActionParam | Commands and limits describing how to run the shell tool call. | Yes | |
| └─ commands | array of string | Ordered shell commands for the execution environment to run. | Yes | |
| └─ max_output_length | OpenAI.integer (nullable) | No | ||
| └─ timeout_ms | OpenAI.integer (nullable) | No | ||
| call_id | string | The unique ID of the shell tool call generated by the model. Constraints: minLength: 1, maxLength: 64 |
Yes | |
| id | string (nullable) | No | ||
| status | OpenAI.FunctionShellCallItemStatus (nullable) | Status values reported for shell tool calls. | No | |
| type | enum | The type of the item. Always shell_call.Possible values: shell_call |
Yes |
OpenAI.InputItemFunctionShellCallOutputItemParam
The streamed output items emitted by a shell tool call.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| call_id | string | The unique ID of the shell tool call generated by the model. Constraints: minLength: 1, maxLength: 64 |
Yes | |
| id | string (nullable) | No | ||
| max_output_length | OpenAI.integer (nullable) | No | ||
| output | array of OpenAI.FunctionShellCallOutputContentParam | Captured chunks of stdout and stderr output, along with their associated outcomes. | Yes | |
| type | enum | The type of the item. Always shell_call_output.Possible values: shell_call_output |
Yes |
OpenAI.InputItemFunctionToolCall
A tool call to run a function. See the function calling guide for more information.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| arguments | string | A JSON string of the arguments to pass to the function. | Yes | |
| call_id | string | The unique ID of the function tool call generated by the model. | Yes | |
| id | string | The unique ID of the function tool call. | No | |
| name | string | The name of the function to run. | Yes | |
| status | enum | The status of the item. One of in_progress, completed, orincomplete. Populated when items are returned via API.Possible values: in_progress, completed, incomplete |
No | |
| type | enum | The type of the function tool call. Always function_call.Possible values: function_call |
Yes |
OpenAI.InputItemImageGenToolCall
An image generation request made by the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| id | string | The unique ID of the image generation call. | Yes | |
| result | string (nullable) | Yes | ||
| status | enum | The status of the image generation call. Possible values: in_progress, completed, generating, failed |
Yes | |
| type | enum | The type of the image generation call. Always image_generation_call.Possible values: image_generation_call |
Yes |
OpenAI.InputItemLocalShellToolCall
A tool call to run a command on the local shell.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| action | OpenAI.LocalShellExecAction | Execute a shell command on the server. | Yes | |
| call_id | string | The unique ID of the local shell tool call generated by the model. | Yes | |
| id | string | The unique ID of the local shell call. | Yes | |
| status | enum | The status of the local shell call. Possible values: in_progress, completed, incomplete |
Yes | |
| type | enum | The type of the local shell call. Always local_shell_call.Possible values: local_shell_call |
Yes |
OpenAI.InputItemLocalShellToolCallOutput
The output of a local shell tool call.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| id | string | The unique ID of the local shell tool call generated by the model. | Yes | |
| output | string | A JSON string of the output of the local shell tool call. | Yes | |
| status | enum | Possible values: in_progress, completed, incomplete |
No | |
| type | enum | The type of the local shell tool call output. Always local_shell_call_output.Possible values: local_shell_call_output |
Yes |
OpenAI.InputItemMcpApprovalRequest
A request for human approval of a tool invocation.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| arguments | string | A JSON string of arguments for the tool. | Yes | |
| id | string | The unique ID of the approval request. | Yes | |
| name | string | The name of the tool to run. | Yes | |
| server_label | string | The label of the MCP server making the request. | Yes | |
| type | enum | The type of the item. Always mcp_approval_request.Possible values: mcp_approval_request |
Yes |
OpenAI.InputItemMcpApprovalResponse
A response to an MCP approval request.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| approval_request_id | string | The ID of the approval request being answered. | Yes | |
| approve | boolean | Whether the request was approved. | Yes | |
| id | string (nullable) | No | ||
| reason | string (nullable) | No | ||
| type | enum | The type of the item. Always mcp_approval_response.Possible values: mcp_approval_response |
Yes |
OpenAI.InputItemMcpListTools
A list of tools available on an MCP server.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| error | string (nullable) | No | ||
| id | string | The unique ID of the list. | Yes | |
| server_label | string | The label of the MCP server. | Yes | |
| tools | array of OpenAI.MCPListToolsTool | The tools available on the server. | Yes | |
| type | enum | The type of the item. Always mcp_list_tools.Possible values: mcp_list_tools |
Yes |
OpenAI.InputItemMcpToolCall
An invocation of a tool on an MCP server.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| approval_request_id | string (nullable) | No | ||
| arguments | string | A JSON string of the arguments passed to the tool. | Yes | |
| error | string (nullable) | No | ||
| id | string | The unique ID of the tool call. | Yes | |
| name | string | The name of the tool that was run. | Yes | |
| output | string (nullable) | No | ||
| server_label | string | The label of the MCP server running the tool. | Yes | |
| status | OpenAI.MCPToolCallStatus | No | ||
| type | enum | The type of the item. Always mcp_call.Possible values: mcp_call |
Yes |
OpenAI.InputItemOutputMessage
An output message from the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | array of OpenAI.OutputMessageContent | The content of the output message. | Yes | |
| id | string | The unique ID of the output message. | Yes | |
| role | enum | The role of the output message. Always assistant.Possible values: assistant |
Yes | |
| status | enum | The status of the message input. One of in_progress, completed, orincomplete. Populated when input items are returned via API.Possible values: in_progress, completed, incomplete |
Yes | |
| type | enum | The type of the output message. Always message.Possible values: output_message |
Yes |
OpenAI.InputItemReasoningItem
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.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | array of OpenAI.ReasoningTextContent | Reasoning text content. | No | |
| encrypted_content | string (nullable) | No | ||
| id | string | The unique identifier of the reasoning content. | Yes | |
| status | enum | The status of the item. One of in_progress, completed, orincomplete. Populated when items are returned via API.Possible values: in_progress, completed, incomplete |
No | |
| summary | array of OpenAI.Summary | Reasoning summary content. | Yes | |
| type | enum | The type of the object. Always reasoning.Possible values: reasoning |
Yes |
OpenAI.InputItemType
| Property | Value |
|---|---|
| Type | string |
| Values | messageoutput_messagefile_search_callcomputer_callcomputer_call_outputweb_search_callfunction_callfunction_call_outputreasoningcompactionimage_generation_callcode_interpreter_calllocal_shell_calllocal_shell_call_outputshell_callshell_call_outputapply_patch_callapply_patch_call_outputmcp_list_toolsmcp_approval_requestmcp_approval_responsemcp_callcustom_tool_call_outputcustom_tool_callitem_reference |
OpenAI.InputItemWebSearchToolCall
The results of a web search tool call. See the web search guide for more information.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| action | OpenAI.WebSearchActionSearch or OpenAI.WebSearchActionOpenPage or OpenAI.WebSearchActionFind | An object describing the specific action taken in this web search call. Includes details on how the model used the web (search, open_page, find). |
Yes | |
| id | string | The unique ID of the web search tool call. | Yes | |
| status | enum | The status of the web search tool call. Possible values: in_progress, searching, completed, failed |
Yes | |
| type | enum | The type of the web search tool call. Always web_search_call.Possible values: web_search_call |
Yes |
OpenAI.InputMessage
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.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | OpenAI.InputMessageContentList | A list of one or many input items to the model, containing different content types. |
Yes | |
| role | enum | The role of the message input. One of user, system, or developer.Possible values: user, system, developer |
Yes | |
| status | enum | The status of item. One of in_progress, completed, orincomplete. Populated when items are returned via API.Possible values: in_progress, completed, incomplete |
No | |
| type | enum | The type of the message input. Always set to message.Possible values: message |
Yes |
OpenAI.InputMessageContentList
A list of one or many input items to the model, containing different content types.
Array of: OpenAI.InputContent
OpenAI.InputMessageResource
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | OpenAI.InputMessageContentList | A list of one or many input items to the model, containing different content types. |
Yes | |
| id | string | The unique ID of the message input. | Yes | |
| role | enum | The role of the message input. One of user, system, or developer.Possible values: user, system, developer |
Yes | |
| status | enum | The status of item. One of in_progress, completed, orincomplete. Populated when items are returned via API.Possible values: in_progress, completed, incomplete |
No | |
| type | enum | The type of the message input. Always set to message.Possible values: message |
Yes |
OpenAI.InputParam
Text, image, or file inputs to the model, used to generate a response. Learn more:
Type: string or array of OpenAI.InputItem
Text, image, or file inputs to the model, used to generate a response. Learn more:
OpenAI.InputTextContent
A text input to the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| text | string | The text input to the model. | Yes | |
| type | enum | The type of the input item. Always input_text.Possible values: input_text |
Yes |
OpenAI.InputTextContentParam
A text input to the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| text | string | The text input to the model. Constraints: maxLength: 10485760 |
Yes | |
| type | enum | The type of the input item. Always input_text.Possible values: input_text |
Yes |
OpenAI.Item
Content item used to generate a response.
Discriminator for OpenAI.Item
This component uses the property type to discriminate between different types:
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | OpenAI.ItemType | Yes |
OpenAI.ItemApplyPatchToolCallItemParam
A tool call representing a request to create, delete, or update files using diff patches.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| call_id | string | The unique ID of the apply patch tool call generated by the model. Constraints: minLength: 1, maxLength: 64 |
Yes | |
| id | string (nullable) | No | ||
| operation | OpenAI.ApplyPatchOperationParam | One of the create_file, delete_file, or update_file operations supplied to the apply_patch tool. | Yes | |
| └─ type | OpenAI.ApplyPatchOperationParamType | Yes | ||
| status | OpenAI.ApplyPatchCallStatusParam | Status values reported for apply_patch tool calls. | Yes | |
| type | enum | The type of the item. Always apply_patch_call.Possible values: apply_patch_call |
Yes |
OpenAI.ItemApplyPatchToolCallOutputItemParam
The streamed output emitted by an apply patch tool call.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| call_id | string | The unique ID of the apply patch tool call generated by the model. Constraints: minLength: 1, maxLength: 64 |
Yes | |
| id | string (nullable) | No | ||
| output | string (nullable) | No | ||
| status | OpenAI.ApplyPatchCallOutputStatusParam | Outcome values reported for apply_patch tool call outputs. | Yes | |
| type | enum | The type of the item. Always apply_patch_call_output.Possible values: apply_patch_call_output |
Yes |
OpenAI.ItemCodeInterpreterToolCall
A tool call to run code.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| code | string (nullable) | Yes | ||
| container_id | string | The ID of the container used to run the code. | Yes | |
| id | string | The unique ID of the code interpreter tool call. | Yes | |
| outputs | array of OpenAI.CodeInterpreterOutputLogs or OpenAI.CodeInterpreterOutputImage | Yes | ||
| status | enum | The status of the code interpreter tool call. Valid values are in_progress, completed, incomplete, interpreting, and failed.Possible values: in_progress, completed, incomplete, interpreting, failed |
Yes | |
| type | enum | The type of the code interpreter tool call. Always code_interpreter_call.Possible values: code_interpreter_call |
Yes |
OpenAI.ItemCompactionSummaryItemParam
A compaction item generated by the v1/responses/compact API.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| encrypted_content | string | The encrypted content of the compaction summary. Constraints: maxLength: 10485760 |
Yes | |
| id | string (nullable) | No | ||
| type | enum | The type of the item. Always compaction.Possible values: compaction |
Yes |
OpenAI.ItemComputerCallOutputItemParam
The output of a computer tool call.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| acknowledged_safety_checks | array of OpenAI.ComputerCallSafetyCheckParam | No | ||
| call_id | string | The ID of the computer tool call that produced the output. Constraints: minLength: 1, maxLength: 64 |
Yes | |
| id | string (nullable) | No | ||
| output | OpenAI.ComputerScreenshotImage | A computer screenshot image used with the computer use tool. | Yes | |
| status | OpenAI.FunctionCallItemStatus (nullable) | No | ||
| type | enum | The type of the computer tool call output. Always computer_call_output.Possible values: computer_call_output |
Yes |
OpenAI.ItemComputerToolCall
A tool call to a computer use tool. See the computer use guide for more information.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| action | OpenAI.ComputerAction | Yes | ||
| call_id | string | An identifier used when responding to the tool call with output. | Yes | |
| id | string | The unique ID of the computer call. | Yes | |
| pending_safety_checks | array of OpenAI.ComputerCallSafetyCheckParam | The pending safety checks for the computer call. | Yes | |
| status | enum | The status of the item. One of in_progress, completed, orincomplete. Populated when items are returned via API.Possible values: in_progress, completed, incomplete |
Yes | |
| type | enum | The type of the computer call. Always computer_call.Possible values: computer_call |
Yes |
OpenAI.ItemCustomToolCall
A call to a custom tool created by the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| call_id | string | An identifier used to map this custom tool call to a tool call output. | Yes | |
| id | string | The unique ID of the custom tool call in the OpenAI platform. | No | |
| input | string | The input for the custom tool call generated by the model. | Yes | |
| name | string | The name of the custom tool being called. | Yes | |
| type | enum | The type of the custom tool call. Always custom_tool_call.Possible values: custom_tool_call |
Yes |
OpenAI.ItemCustomToolCallOutput
The output of a custom tool call from your code, being sent back to the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| call_id | string | The call ID, used to map this custom tool call output to a custom tool call. | Yes | |
| id | string | The unique ID of the custom tool call output in the OpenAI platform. | No | |
| output | string or array of OpenAI.FunctionAndCustomToolCallOutput | The output from the custom tool call generated by your code. Can be a string or an list of output content. |
Yes | |
| type | enum | The type of the custom tool call output. Always custom_tool_call_output.Possible values: custom_tool_call_output |
Yes |
OpenAI.ItemFileSearchToolCall
The results of a file search tool call. See the file search guide for more information.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| id | string | The unique ID of the file search tool call. | Yes | |
| queries | array of string | The queries used to search for files. | Yes | |
| results | array of OpenAI.FileSearchToolCallResults | No | ||
| status | enum | The status of the file search tool call. One of in_progress,searching, incomplete or failed,Possible values: in_progress, searching, completed, incomplete, failed |
Yes | |
| type | enum | The type of the file search tool call. Always file_search_call.Possible values: file_search_call |
Yes |
OpenAI.ItemFunctionCallOutputItemParam
The output of a function tool call.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| call_id | string | The unique ID of the function tool call generated by the model. Constraints: minLength: 1, maxLength: 64 |
Yes | |
| id | string (nullable) | No | ||
| output | string or array of OpenAI.InputTextContentParam or OpenAI.InputImageContentParamAutoParam or OpenAI.InputFileContentParam | Text, image, or file output of the function tool call. | Yes | |
| status | OpenAI.FunctionCallItemStatus (nullable) | No | ||
| type | enum | The type of the function tool call output. Always function_call_output.Possible values: function_call_output |
Yes |
OpenAI.ItemFunctionShellCallItemParam
A tool representing a request to execute one or more shell commands.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| action | OpenAI.FunctionShellActionParam | Commands and limits describing how to run the shell tool call. | Yes | |
| └─ commands | array of string | Ordered shell commands for the execution environment to run. | Yes | |
| └─ max_output_length | OpenAI.integer (nullable) | No | ||
| └─ timeout_ms | OpenAI.integer (nullable) | No | ||
| call_id | string | The unique ID of the shell tool call generated by the model. Constraints: minLength: 1, maxLength: 64 |
Yes | |
| id | string (nullable) | No | ||
| status | OpenAI.FunctionShellCallItemStatus (nullable) | Status values reported for shell tool calls. | No | |
| type | enum | The type of the item. Always shell_call.Possible values: shell_call |
Yes |
OpenAI.ItemFunctionShellCallOutputItemParam
The streamed output items emitted by a shell tool call.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| call_id | string | The unique ID of the shell tool call generated by the model. Constraints: minLength: 1, maxLength: 64 |
Yes | |
| id | string (nullable) | No | ||
| max_output_length | OpenAI.integer (nullable) | No | ||
| output | array of OpenAI.FunctionShellCallOutputContentParam | Captured chunks of stdout and stderr output, along with their associated outcomes. | Yes | |
| type | enum | The type of the item. Always shell_call_output.Possible values: shell_call_output |
Yes |
OpenAI.ItemFunctionToolCall
A tool call to run a function. See the function calling guide for more information.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| arguments | string | A JSON string of the arguments to pass to the function. | Yes | |
| call_id | string | The unique ID of the function tool call generated by the model. | Yes | |
| id | string | The unique ID of the function tool call. | No | |
| name | string | The name of the function to run. | Yes | |
| status | enum | The status of the item. One of in_progress, completed, orincomplete. Populated when items are returned via API.Possible values: in_progress, completed, incomplete |
No | |
| type | enum | The type of the function tool call. Always function_call.Possible values: function_call |
Yes |
OpenAI.ItemImageGenToolCall
An image generation request made by the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| id | string | The unique ID of the image generation call. | Yes | |
| result | string (nullable) | Yes | ||
| status | enum | The status of the image generation call. Possible values: in_progress, completed, generating, failed |
Yes | |
| type | enum | The type of the image generation call. Always image_generation_call.Possible values: image_generation_call |
Yes |
OpenAI.ItemLocalShellToolCall
A tool call to run a command on the local shell.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| action | OpenAI.LocalShellExecAction | Execute a shell command on the server. | Yes | |
| call_id | string | The unique ID of the local shell tool call generated by the model. | Yes | |
| id | string | The unique ID of the local shell call. | Yes | |
| status | enum | The status of the local shell call. Possible values: in_progress, completed, incomplete |
Yes | |
| type | enum | The type of the local shell call. Always local_shell_call.Possible values: local_shell_call |
Yes |
OpenAI.ItemLocalShellToolCallOutput
The output of a local shell tool call.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| id | string | The unique ID of the local shell tool call generated by the model. | Yes | |
| output | string | A JSON string of the output of the local shell tool call. | Yes | |
| status | enum | Possible values: in_progress, completed, incomplete |
No | |
| type | enum | The type of the local shell tool call output. Always local_shell_call_output.Possible values: local_shell_call_output |
Yes |
OpenAI.ItemMcpApprovalRequest
A request for human approval of a tool invocation.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| arguments | string | A JSON string of arguments for the tool. | Yes | |
| id | string | The unique ID of the approval request. | Yes | |
| name | string | The name of the tool to run. | Yes | |
| server_label | string | The label of the MCP server making the request. | Yes | |
| type | enum | The type of the item. Always mcp_approval_request.Possible values: mcp_approval_request |
Yes |
OpenAI.ItemMcpApprovalResponse
A response to an MCP approval request.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| approval_request_id | string | The ID of the approval request being answered. | Yes | |
| approve | boolean | Whether the request was approved. | Yes | |
| id | string (nullable) | No | ||
| reason | string (nullable) | No | ||
| type | enum | The type of the item. Always mcp_approval_response.Possible values: mcp_approval_response |
Yes |
OpenAI.ItemMcpListTools
A list of tools available on an MCP server.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| error | string (nullable) | No | ||
| id | string | The unique ID of the list. | Yes | |
| server_label | string | The label of the MCP server. | Yes | |
| tools | array of OpenAI.MCPListToolsTool | The tools available on the server. | Yes | |
| type | enum | The type of the item. Always mcp_list_tools.Possible values: mcp_list_tools |
Yes |
OpenAI.ItemMcpToolCall
An invocation of a tool on an MCP server.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| approval_request_id | string (nullable) | No | ||
| arguments | string | A JSON string of the arguments passed to the tool. | Yes | |
| error | string (nullable) | No | ||
| id | string | The unique ID of the tool call. | Yes | |
| name | string | The name of the tool that was run. | Yes | |
| output | string (nullable) | No | ||
| server_label | string | The label of the MCP server running the tool. | Yes | |
| status | OpenAI.MCPToolCallStatus | No | ||
| type | enum | The type of the item. Always mcp_call.Possible values: mcp_call |
Yes |
OpenAI.ItemOutputMessage
An output message from the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | array of OpenAI.OutputMessageContent | The content of the output message. | Yes | |
| id | string | The unique ID of the output message. | Yes | |
| role | enum | The role of the output message. Always assistant.Possible values: assistant |
Yes | |
| status | enum | The status of the message input. One of in_progress, completed, orincomplete. Populated when input items are returned via API.Possible values: in_progress, completed, incomplete |
Yes | |
| type | enum | The type of the output message. Always message.Possible values: output_message |
Yes |
OpenAI.ItemReasoningItem
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.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | array of OpenAI.ReasoningTextContent | Reasoning text content. | No | |
| encrypted_content | string (nullable) | No | ||
| id | string | The unique identifier of the reasoning content. | Yes | |
| status | enum | The status of the item. One of in_progress, completed, orincomplete. Populated when items are returned via API.Possible values: in_progress, completed, incomplete |
No | |
| summary | array of OpenAI.Summary | Reasoning summary content. | Yes | |
| type | enum | The type of the object. Always reasoning.Possible values: reasoning |
Yes |
OpenAI.ItemReferenceParam
An internal identifier for an item to reference.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| id | string | The ID of the item to reference. | Yes | |
| type | enum | The type of item to reference. Always item_reference.Possible values: item_reference |
Yes |
OpenAI.ItemResource
Content item used to generate a response.
Discriminator for OpenAI.ItemResource
This component uses the property type to discriminate between different types:
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | OpenAI.ItemResourceType | Yes |
OpenAI.ItemResourceApplyPatchToolCall
A tool call that applies file diffs by creating, deleting, or updating files.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| call_id | string | The unique ID of the apply patch tool call generated by the model. | Yes | |
| created_by | string | The ID of the entity that created this tool call. | No | |
| id | string | The unique ID of the apply patch tool call. Populated when this item is returned via API. | Yes | |
| operation | OpenAI.ApplyPatchFileOperation | One of the create_file, delete_file, or update_file operations applied via apply_patch. | Yes | |
| └─ type | OpenAI.ApplyPatchFileOperationType | Yes | ||
| status | OpenAI.ApplyPatchCallStatus | Yes | ||
| type | enum | The type of the item. Always apply_patch_call.Possible values: apply_patch_call |
Yes |
OpenAI.ItemResourceApplyPatchToolCallOutput
The output emitted by an apply patch tool call.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| call_id | string | The unique ID of the apply patch tool call generated by the model. | Yes | |
| created_by | string | The ID of the entity that created this tool call output. | No | |
| id | string | The unique ID of the apply patch tool call output. Populated when this item is returned via API. | Yes | |
| output | string (nullable) | No | ||
| status | OpenAI.ApplyPatchCallOutputStatus | Yes | ||
| type | enum | The type of the item. Always apply_patch_call_output.Possible values: apply_patch_call_output |
Yes |
OpenAI.ItemResourceCodeInterpreterToolCall
A tool call to run code.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| code | string (nullable) | Yes | ||
| container_id | string | The ID of the container used to run the code. | Yes | |
| id | string | The unique ID of the code interpreter tool call. | Yes | |
| outputs | array of OpenAI.CodeInterpreterOutputLogs or OpenAI.CodeInterpreterOutputImage | Yes | ||
| status | enum | The status of the code interpreter tool call. Valid values are in_progress, completed, incomplete, interpreting, and failed.Possible values: in_progress, completed, incomplete, interpreting, failed |
Yes | |
| type | enum | The type of the code interpreter tool call. Always code_interpreter_call.Possible values: code_interpreter_call |
Yes |
OpenAI.ItemResourceComputerToolCall
A tool call to a computer use tool. See the computer use guide for more information.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| action | OpenAI.ComputerAction | Yes | ||
| call_id | string | An identifier used when responding to the tool call with output. | Yes | |
| id | string | The unique ID of the computer call. | Yes | |
| pending_safety_checks | array of OpenAI.ComputerCallSafetyCheckParam | The pending safety checks for the computer call. | Yes | |
| status | enum | The status of the item. One of in_progress, completed, orincomplete. Populated when items are returned via API.Possible values: in_progress, completed, incomplete |
Yes | |
| type | enum | The type of the computer call. Always computer_call.Possible values: computer_call |
Yes |
OpenAI.ItemResourceComputerToolCallOutputResource
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| acknowledged_safety_checks | array of OpenAI.ComputerCallSafetyCheckParam | The safety checks reported by the API that have been acknowledged by the developer. |
No | |
| call_id | string | The ID of the computer tool call that produced the output. | Yes | |
| id | string | The ID of the computer tool call output. | No | |
| output | OpenAI.ComputerScreenshotImage | A computer screenshot image used with the computer use tool. | Yes | |
| status | enum | The status of the message input. One of in_progress, completed, orincomplete. Populated when input items are returned via API.Possible values: in_progress, completed, incomplete |
No | |
| type | enum | The type of the computer tool call output. Always computer_call_output.Possible values: computer_call_output |
Yes |
OpenAI.ItemResourceFileSearchToolCall
The results of a file search tool call. See the file search guide for more information.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| id | string | The unique ID of the file search tool call. | Yes | |
| queries | array of string | The queries used to search for files. | Yes | |
| results | array of OpenAI.FileSearchToolCallResults | No | ||
| status | enum | The status of the file search tool call. One of in_progress,searching, incomplete or failed,Possible values: in_progress, searching, completed, incomplete, failed |
Yes | |
| type | enum | The type of the file search tool call. Always file_search_call.Possible values: file_search_call |
Yes |
OpenAI.ItemResourceFunctionShellCall
A tool call that executes one or more shell commands in a managed environment.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| action | OpenAI.FunctionShellAction | Execute a shell command. | Yes | |
| └─ commands | array of string | Yes | ||
| └─ max_output_length | OpenAI.integer (nullable) | Yes | ||
| └─ timeout_ms | OpenAI.integer (nullable) | Yes | ||
| call_id | string | The unique ID of the shell tool call generated by the model. | Yes | |
| created_by | string | The ID of the entity that created this tool call. | No | |
| id | string | The unique ID of the shell tool call. Populated when this item is returned via API. | Yes | |
| status | OpenAI.LocalShellCallStatus | Yes | ||
| type | enum | The type of the item. Always shell_call.Possible values: shell_call |
Yes |
OpenAI.ItemResourceFunctionShellCallOutput
The output of a shell tool call that was emitted.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| call_id | string | The unique ID of the shell tool call generated by the model. | Yes | |
| created_by | string | The identifier of the actor that created the item. | No | |
| id | string | The unique ID of the shell call output. Populated when this item is returned via API. | Yes | |
| max_output_length | OpenAI.integer (nullable) | Yes | ||
| output | array of OpenAI.FunctionShellCallOutputContent | An array of shell call output contents | Yes | |
| type | enum | The type of the shell call output. Always shell_call_output.Possible values: shell_call_output |
Yes |
OpenAI.ItemResourceFunctionToolCallOutputResource
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| call_id | string | The unique ID of the function tool call generated by the model. | Yes | |
| id | string | The unique ID of the function tool call output. Populated when this item is returned via API. |
No | |
| output | string or array of OpenAI.FunctionAndCustomToolCallOutput | The output from the function call generated by your code. Can be a string or an list of output content. |
Yes | |
| status | enum | The status of the item. One of in_progress, completed, orincomplete. Populated when items are returned via API.Possible values: in_progress, completed, incomplete |
No | |
| type | enum | The type of the function tool call output. Always function_call_output.Possible values: function_call_output |
Yes |
OpenAI.ItemResourceFunctionToolCallResource
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| arguments | string | A JSON string of the arguments to pass to the function. | Yes | |
| call_id | string | The unique ID of the function tool call generated by the model. | Yes | |
| id | string | The unique ID of the function tool call. | No | |
| name | string | The name of the function to run. | Yes | |
| status | enum | The status of the item. One of in_progress, completed, orincomplete. Populated when items are returned via API.Possible values: in_progress, completed, incomplete |
No | |
| type | enum | The type of the function tool call. Always function_call.Possible values: function_call |
Yes |
OpenAI.ItemResourceImageGenToolCall
An image generation request made by the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| id | string | The unique ID of the image generation call. | Yes | |
| result | string (nullable) | Yes | ||
| status | enum | The status of the image generation call. Possible values: in_progress, completed, generating, failed |
Yes | |
| type | enum | The type of the image generation call. Always image_generation_call.Possible values: image_generation_call |
Yes |
OpenAI.ItemResourceLocalShellToolCall
A tool call to run a command on the local shell.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| action | OpenAI.LocalShellExecAction | Execute a shell command on the server. | Yes | |
| call_id | string | The unique ID of the local shell tool call generated by the model. | Yes | |
| id | string | The unique ID of the local shell call. | Yes | |
| status | enum | The status of the local shell call. Possible values: in_progress, completed, incomplete |
Yes | |
| type | enum | The type of the local shell call. Always local_shell_call.Possible values: local_shell_call |
Yes |
OpenAI.ItemResourceLocalShellToolCallOutput
The output of a local shell tool call.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| id | string | The unique ID of the local shell tool call generated by the model. | Yes | |
| output | string | A JSON string of the output of the local shell tool call. | Yes | |
| status | enum | Possible values: in_progress, completed, incomplete |
No | |
| type | enum | The type of the local shell tool call output. Always local_shell_call_output.Possible values: local_shell_call_output |
Yes |
OpenAI.ItemResourceMcpApprovalRequest
A request for human approval of a tool invocation.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| arguments | string | A JSON string of arguments for the tool. | Yes | |
| id | string | The unique ID of the approval request. | Yes | |
| name | string | The name of the tool to run. | Yes | |
| server_label | string | The label of the MCP server making the request. | Yes | |
| type | enum | The type of the item. Always mcp_approval_request.Possible values: mcp_approval_request |
Yes |
OpenAI.ItemResourceMcpApprovalResponseResource
A response to an MCP approval request.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| approval_request_id | string | The ID of the approval request being answered. | Yes | |
| approve | boolean | Whether the request was approved. | Yes | |
| id | string | The unique ID of the approval response | Yes | |
| reason | string (nullable) | No | ||
| type | enum | The type of the item. Always mcp_approval_response.Possible values: mcp_approval_response |
Yes |
OpenAI.ItemResourceMcpListTools
A list of tools available on an MCP server.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| error | string (nullable) | No | ||
| id | string | The unique ID of the list. | Yes | |
| server_label | string | The label of the MCP server. | Yes | |
| tools | array of OpenAI.MCPListToolsTool | The tools available on the server. | Yes | |
| type | enum | The type of the item. Always mcp_list_tools.Possible values: mcp_list_tools |
Yes |
OpenAI.ItemResourceMcpToolCall
An invocation of a tool on an MCP server.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| approval_request_id | string (nullable) | No | ||
| arguments | string | A JSON string of the arguments passed to the tool. | Yes | |
| error | string (nullable) | No | ||
| id | string | The unique ID of the tool call. | Yes | |
| name | string | The name of the tool that was run. | Yes | |
| output | string (nullable) | No | ||
| server_label | string | The label of the MCP server running the tool. | Yes | |
| status | OpenAI.MCPToolCallStatus | No | ||
| type | enum | The type of the item. Always mcp_call.Possible values: mcp_call |
Yes |
OpenAI.ItemResourceOutputMessage
An output message from the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | array of OpenAI.OutputMessageContent | The content of the output message. | Yes | |
| id | string | The unique ID of the output message. | Yes | |
| role | enum | The role of the output message. Always assistant.Possible values: assistant |
Yes | |
| status | enum | The status of the message input. One of in_progress, completed, orincomplete. Populated when input items are returned via API.Possible values: in_progress, completed, incomplete |
Yes | |
| type | enum | The type of the output message. Always message.Possible values: output_message |
Yes |
OpenAI.ItemResourceType
| Property | Value |
|---|---|
| Type | string |
| Values | messageoutput_messagefile_search_callcomputer_callcomputer_call_outputweb_search_callfunction_callfunction_call_outputimage_generation_callcode_interpreter_calllocal_shell_calllocal_shell_call_outputshell_callshell_call_outputapply_patch_callapply_patch_call_outputmcp_list_toolsmcp_approval_requestmcp_approval_responsemcp_callstructured_outputsoauth_consent_requestmemory_search_callworkflow_action |
OpenAI.ItemResourceWebSearchToolCall
The results of a web search tool call. See the web search guide for more information.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| action | OpenAI.WebSearchActionSearch or OpenAI.WebSearchActionOpenPage or OpenAI.WebSearchActionFind | An object describing the specific action taken in this web search call. Includes details on how the model used the web (search, open_page, find). |
Yes | |
| id | string | The unique ID of the web search tool call. | Yes | |
| status | enum | The status of the web search tool call. Possible values: in_progress, searching, completed, failed |
Yes | |
| type | enum | The type of the web search tool call. Always web_search_call.Possible values: web_search_call |
Yes |
OpenAI.ItemType
| Property | Value |
|---|---|
| Type | string |
| Values | messageoutput_messagefile_search_callcomputer_callcomputer_call_outputweb_search_callfunction_callfunction_call_outputreasoningcompactionimage_generation_callcode_interpreter_calllocal_shell_calllocal_shell_call_outputshell_callshell_call_outputapply_patch_callapply_patch_call_outputmcp_list_toolsmcp_approval_requestmcp_approval_responsemcp_callcustom_tool_call_outputcustom_tool_callstructured_outputsoauth_consent_requestmemory_search_callworkflow_action |
OpenAI.ItemWebSearchToolCall
The results of a web search tool call. See the web search guide for more information.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| action | OpenAI.WebSearchActionSearch or OpenAI.WebSearchActionOpenPage or OpenAI.WebSearchActionFind | An object describing the specific action taken in this web search call. Includes details on how the model used the web (search, open_page, find). |
Yes | |
| id | string | The unique ID of the web search tool call. | Yes | |
| status | enum | The status of the web search tool call. Possible values: in_progress, searching, completed, failed |
Yes | |
| type | enum | The type of the web search tool call. Always web_search_call.Possible values: web_search_call |
Yes |
OpenAI.KeyPressAction
A collection of keypresses the model would like to perform.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| keys | array of string | The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. | Yes | |
| type | enum | Specifies the event type. For a keypress action, this property is always set to keypress.Possible values: keypress |
Yes |
OpenAI.ListFineTuningJobCheckpointsResponse
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | array of OpenAI.FineTuningJobCheckpoint | Yes | ||
| first_id | string (nullable) | No | ||
| has_more | boolean | Yes | ||
| last_id | string (nullable) | No | ||
| object | enum | Possible values: list |
Yes |
OpenAI.ListFineTuningJobEventsResponse
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | array of OpenAI.FineTuningJobEvent | Yes | ||
| has_more | boolean | Yes | ||
| object | enum | Possible values: list |
Yes |
OpenAI.ListPaginatedFineTuningJobsResponse
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | array of OpenAI.FineTuningJob | Yes | ||
| has_more | boolean | Yes | ||
| object | enum | Possible values: list |
Yes |
OpenAI.LocalShellCallStatus
| Property | Value |
|---|---|
| Type | string |
| Values | in_progresscompletedincomplete |
OpenAI.LocalShellExecAction
Execute a shell command on the server.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| command | array of string | The command to run. | Yes | |
| env | object | Environment variables to set for the command. | Yes | |
| timeout_ms | OpenAI.integer (nullable) | No | ||
| type | enum | The type of the local shell action. Always exec.Possible values: exec |
Yes | |
| user | string (nullable) | No | ||
| working_directory | string (nullable) | No |
OpenAI.LocalShellToolParam
A tool that allows the model to execute shell commands in a local environment.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | The type of the local shell tool. Always local_shell.Possible values: local_shell |
Yes |
OpenAI.LogProb
The log probability of a token.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| bytes | array of OpenAI.integer | Yes | ||
| logprob | OpenAI.numeric | Yes | ||
| token | string | Yes | ||
| top_logprobs | array of OpenAI.TopLogProb | Yes |
OpenAI.MCPListToolsTool
A tool available on an MCP server.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| annotations | OpenAI.MCPListToolsToolAnnotations (nullable) | No | ||
| description | string (nullable) | No | ||
| input_schema | OpenAI.MCPListToolsToolInputSchema | Yes | ||
| name | string | The name of the tool. | Yes |
OpenAI.MCPListToolsToolAnnotations
Type: object
OpenAI.MCPListToolsToolInputSchema
Type: object
OpenAI.MCPTool
Give the model access to additional tools via remote Model Context Protocol (MCP) servers. Learn more about MCP.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| allowed_tools | array of string or OpenAI.MCPToolFilter | No | ||
| authorization | string | 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. |
No | |
| connector_id | enum | Identifier for service connectors, like those available in ChatGPT. One ofserver_url or connector_id must be provided. Learn more about serviceconnectors here. 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_sharepointPossible values: connector_dropbox, connector_gmail, connector_googlecalendar, connector_googledrive, connector_microsoftteams, connector_outlookcalendar, connector_outlookemail, connector_sharepoint |
No | |
| headers | object (nullable) | No | ||
| project_connection_id | string | 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. | No | |
| require_approval | object (see valid models below) | No | ||
| server_description | string | Optional description of the MCP server, used to provide more context. | No | |
| server_label | string | A label for this MCP server, used to identify it in tool calls. | Yes | |
| server_url | string | The URL for the MCP server. One of server_url or connector_id must beprovided. |
No | |
| type | enum | The type of the MCP tool. Always mcp.Possible values: mcp |
Yes |
OpenAI.MCPToolCallStatus
| Property | Value |
|---|---|
| Type | string |
| Values | in_progresscompletedincompletecallingfailed |
OpenAI.MCPToolFilter
A filter object to specify which tools are allowed.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| read_only | boolean | Indicates whether or not a tool modifies data or is read-only. If an MCP server is annotated with readOnlyHint,it will match this filter. |
No | |
| tool_names | array of string | List of allowed tool names. | No |
OpenAI.MCPToolRequireApproval
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| always | OpenAI.MCPToolFilter | A filter object to specify which tools are allowed. | No | |
| never | OpenAI.MCPToolFilter | A filter object to specify which tools are allowed. | No |
OpenAI.MessageContent
A content part that makes up an input or output item.
Discriminator for OpenAI.MessageContent
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
text |
OpenAI.TextContent |
summary_text |
OpenAI.SummaryTextContent |
computer_screenshot |
OpenAI.ComputerScreenshotContent |
input_text |
OpenAI.MessageContentInputTextContent |
output_text |
OpenAI.MessageContentOutputTextContent |
reasoning_text |
OpenAI.MessageContentReasoningTextContent |
refusal |
OpenAI.MessageContentRefusalContent |
input_image |
OpenAI.MessageContentInputImageContent |
input_file |
OpenAI.MessageContentInputFileContent |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | OpenAI.MessageContentType | Yes |
OpenAI.MessageContentInputFileContent
A file input to the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| file_data | string | The content of the file to be sent to the model. | No | |
| file_id | string (nullable) | No | ||
| file_url | string | The URL of the file to be sent to the model. | No | |
| filename | string | The name of the file to be sent to the model. | No | |
| type | enum | The type of the input item. Always input_file.Possible values: input_file |
Yes |
OpenAI.MessageContentInputImageContent
An image input to the model. Learn about image inputs.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| detail | OpenAI.ImageDetail | Yes | ||
| file_id | string (nullable) | No | ||
| image_url | string | No | ||
| type | enum | The type of the input item. Always input_image.Possible values: input_image |
Yes |
OpenAI.MessageContentInputTextContent
A text input to the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| text | string | The text input to the model. | Yes | |
| type | enum | The type of the input item. Always input_text.Possible values: input_text |
Yes |
OpenAI.MessageContentOutputTextContent
A text output from the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| annotations | array of OpenAI.Annotation | The annotations of the text output. | Yes | |
| logprobs | array of OpenAI.LogProb | No | ||
| text | string | The text output from the model. | Yes | |
| type | enum | The type of the output text. Always output_text.Possible values: output_text |
Yes |
OpenAI.MessageContentReasoningTextContent
Reasoning text from the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| text | string | The reasoning text from the model. | Yes | |
| type | enum | The type of the reasoning text. Always reasoning_text.Possible values: reasoning_text |
Yes |
OpenAI.MessageContentRefusalContent
A refusal from the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| refusal | string | The refusal explanation from the model. | Yes | |
| type | enum | The type of the refusal. Always refusal.Possible values: refusal |
Yes |
OpenAI.MessageContentType
| Property | Value |
|---|---|
| Type | string |
| Values | input_textoutput_texttextsummary_textreasoning_textrefusalinput_imagecomputer_screenshotinput_file |
OpenAI.MessageRole
| Property | Value |
|---|---|
| Type | string |
| Values | unknownuserassistantsystemcriticdiscriminatordevelopertool |
OpenAI.MessageStatus
| Property | Value |
|---|---|
| Type | string |
| Values | in_progresscompletedincomplete |
OpenAI.Metadata
Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.
Type: object
OpenAI.ModelIdsCompaction
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 to browse and compare available models.
Type: OpenAI.ModelIdsResponses or string
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 to browse and compare available models.
OpenAI.ModelIdsResponses
| Property | Value |
|---|---|
| Type | string |
| Values | o1-proo1-pro-2025-03-19o3-proo3-pro-2025-06-10o3-deep-researcho3-deep-research-2025-06-26o4-mini-deep-researcho4-mini-deep-research-2025-06-26computer-use-previewcomputer-use-preview-2025-03-11gpt-5-codexgpt-5-progpt-5-pro-2025-10-06gpt-5.1-codex-max |
OpenAI.ModelIdsShared
Type: string or OpenAI.ChatModel
OpenAI.Move
A mouse move action.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | Specifies the event type. For a move action, this property is always set to move.Possible values: move |
Yes | |
| x | OpenAI.integer | Yes | ||
| y | OpenAI.integer | Yes |
OpenAI.OutputContent
Discriminator for OpenAI.OutputContent
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
output_text |
OpenAI.OutputContentOutputTextContent |
refusal |
OpenAI.OutputContentRefusalContent |
reasoning_text |
OpenAI.OutputContentReasoningTextContent |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | OpenAI.OutputContentType | Yes |
OpenAI.OutputContentOutputTextContent
A text output from the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| annotations | array of OpenAI.Annotation | The annotations of the text output. | Yes | |
| logprobs | array of OpenAI.LogProb | No | ||
| text | string | The text output from the model. | Yes | |
| type | enum | The type of the output text. Always output_text.Possible values: output_text |
Yes |
OpenAI.OutputContentReasoningTextContent
Reasoning text from the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| text | string | The reasoning text from the model. | Yes | |
| type | enum | The type of the reasoning text. Always reasoning_text.Possible values: reasoning_text |
Yes |
OpenAI.OutputContentRefusalContent
A refusal from the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| refusal | string | The refusal explanation from the model. | Yes | |
| type | enum | The type of the refusal. Always refusal.Possible values: refusal |
Yes |
OpenAI.OutputContentType
| Property | Value |
|---|---|
| Type | string |
| Values | output_textrefusalreasoning_text |
OpenAI.OutputItem
Discriminator for OpenAI.OutputItem
This component uses the property type to discriminate between different types:
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| agent_reference | AgentReference | No | ||
| └─ name | string | The name of the agent. Constraints: maxLength: 256 |
Yes | |
| └─ type | enum | Possible values: agent_reference |
Yes | |
| └─ version | string | The version identifier of the agent. | No | |
| response_id | string | The response on which the item is created. | No | |
| type | OpenAI.OutputItemType | Yes |
OpenAI.OutputItemApplyPatchToolCall
A tool call that applies file diffs by creating, deleting, or updating files.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| agent_reference | AgentReference | No | ||
| └─ name | string | The name of the agent. Constraints: maxLength: 256 |
Yes | |
| └─ type | enum | Possible values: agent_reference |
Yes | |
| └─ version | string | The version identifier of the agent. | No | |
| call_id | string | The unique ID of the apply patch tool call generated by the model. | Yes | |
| created_by | string | The ID of the entity that created this tool call. | No | |
| id | string | The unique ID of the apply patch tool call. Populated when this item is returned via API. | Yes | |
| operation | OpenAI.ApplyPatchFileOperation | One of the create_file, delete_file, or update_file operations applied via apply_patch. | Yes | |
| └─ type | OpenAI.ApplyPatchFileOperationType | Yes | ||
| response_id | string | The response on which the item is created. | No | |
| status | OpenAI.ApplyPatchCallStatus | Yes | ||
| type | enum | The type of the item. Always apply_patch_call.Possible values: apply_patch_call |
Yes |
OpenAI.OutputItemApplyPatchToolCallOutput
The output emitted by an apply patch tool call.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| agent_reference | AgentReference | No | ||
| └─ name | string | The name of the agent. Constraints: maxLength: 256 |
Yes | |
| └─ type | enum | Possible values: agent_reference |
Yes | |
| └─ version | string | The version identifier of the agent. | No | |
| call_id | string | The unique ID of the apply patch tool call generated by the model. | Yes | |
| created_by | string | The ID of the entity that created this tool call output. | No | |
| id | string | The unique ID of the apply patch tool call output. Populated when this item is returned via API. | Yes | |
| output | string (nullable) | No | ||
| response_id | string | The response on which the item is created. | No | |
| status | OpenAI.ApplyPatchCallOutputStatus | Yes | ||
| type | enum | The type of the item. Always apply_patch_call_output.Possible values: apply_patch_call_output |
Yes |
OpenAI.OutputItemCodeInterpreterToolCall
A tool call to run code.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| agent_reference | AgentReference | No | ||
| └─ name | string | The name of the agent. Constraints: maxLength: 256 |
Yes | |
| └─ type | enum | Possible values: agent_reference |
Yes | |
| └─ version | string | The version identifier of the agent. | No | |
| code | string (nullable) | Yes | ||
| container_id | string | The ID of the container used to run the code. | Yes | |
| id | string | The unique ID of the code interpreter tool call. | Yes | |
| outputs | array of OpenAI.CodeInterpreterOutputLogs or OpenAI.CodeInterpreterOutputImage | Yes | ||
| response_id | string | The response on which the item is created. | No | |
| status | enum | The status of the code interpreter tool call. Valid values are in_progress, completed, incomplete, interpreting, and failed.Possible values: in_progress, completed, incomplete, interpreting, failed |
Yes | |
| type | enum | The type of the code interpreter tool call. Always code_interpreter_call.Possible values: code_interpreter_call |
Yes |
OpenAI.OutputItemCompactionBody
A compaction item generated by the v1/responses/compact API.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| agent_reference | AgentReference | No | ||
| └─ name | string | The name of the agent. Constraints: maxLength: 256 |
Yes | |
| └─ type | enum | Possible values: agent_reference |
Yes | |
| └─ version | string | The version identifier of the agent. | No | |
| created_by | string | The identifier of the actor that created the item. | No | |
| encrypted_content | string | The encrypted content that was produced by compaction. | Yes | |
| id | string | The unique ID of the compaction item. | Yes | |
| response_id | string | The response on which the item is created. | No | |
| type | enum | The type of the item. Always compaction.Possible values: compaction |
Yes |
OpenAI.OutputItemComputerToolCall
A tool call to a computer use tool. See the computer use guide for more information.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| action | OpenAI.ComputerAction | Yes | ||
| agent_reference | AgentReference | No | ||
| └─ name | string | The name of the agent. Constraints: maxLength: 256 |
Yes | |
| └─ type | enum | Possible values: agent_reference |
Yes | |
| └─ version | string | The version identifier of the agent. | No | |
| call_id | string | An identifier used when responding to the tool call with output. | Yes | |
| id | string | The unique ID of the computer call. | Yes | |
| pending_safety_checks | array of OpenAI.ComputerCallSafetyCheckParam | The pending safety checks for the computer call. | Yes | |
| response_id | string | The response on which the item is created. | No | |
| status | enum | The status of the item. One of in_progress, completed, orincomplete. Populated when items are returned via API.Possible values: in_progress, completed, incomplete |
Yes | |
| type | enum | The type of the computer call. Always computer_call.Possible values: computer_call |
Yes |
OpenAI.OutputItemCustomToolCall
A call to a custom tool created by the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| agent_reference | AgentReference | No | ||
| └─ name | string | The name of the agent. Constraints: maxLength: 256 |
Yes | |
| └─ type | enum | Possible values: agent_reference |
Yes | |
| └─ version | string | The version identifier of the agent. | No | |
| call_id | string | An identifier used to map this custom tool call to a tool call output. | Yes | |
| id | string | The unique ID of the custom tool call in the OpenAI platform. | No | |
| input | string | The input for the custom tool call generated by the model. | Yes | |
| name | string | The name of the custom tool being called. | Yes | |
| response_id | string | The response on which the item is created. | No | |
| type | enum | The type of the custom tool call. Always custom_tool_call.Possible values: custom_tool_call |
Yes |
OpenAI.OutputItemFileSearchToolCall
The results of a file search tool call. See the file search guide for more information.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| agent_reference | AgentReference | No | ||
| └─ name | string | The name of the agent. Constraints: maxLength: 256 |
Yes | |
| └─ type | enum | Possible values: agent_reference |
Yes | |
| └─ version | string | The version identifier of the agent. | No | |
| id | string | The unique ID of the file search tool call. | Yes | |
| queries | array of string | The queries used to search for files. | Yes | |
| response_id | string | The response on which the item is created. | No | |
| results | array of OpenAI.FileSearchToolCallResults | No | ||
| status | enum | The status of the file search tool call. One of in_progress,searching, incomplete or failed,Possible values: in_progress, searching, completed, incomplete, failed |
Yes | |
| type | enum | The type of the file search tool call. Always file_search_call.Possible values: file_search_call |
Yes |
OpenAI.OutputItemFunctionShellCall
A tool call that executes one or more shell commands in a managed environment.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| action | OpenAI.FunctionShellAction | Execute a shell command. | Yes | |
| └─ commands | array of string | Yes | ||
| └─ max_output_length | OpenAI.integer (nullable) | Yes | ||
| └─ timeout_ms | OpenAI.integer (nullable) | Yes | ||
| agent_reference | AgentReference | No | ||
| └─ name | string | The name of the agent. Constraints: maxLength: 256 |
Yes | |
| └─ type | enum | Possible values: agent_reference |
Yes | |
| └─ version | string | The version identifier of the agent. | No | |
| call_id | string | The unique ID of the shell tool call generated by the model. | Yes | |
| created_by | string | The ID of the entity that created this tool call. | No | |
| id | string | The unique ID of the shell tool call. Populated when this item is returned via API. | Yes | |
| response_id | string | The response on which the item is created. | No | |
| status | OpenAI.LocalShellCallStatus | Yes | ||
| type | enum | The type of the item. Always shell_call.Possible values: shell_call |
Yes |
OpenAI.OutputItemFunctionShellCallOutput
The output of a shell tool call that was emitted.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| agent_reference | AgentReference | No | ||
| └─ name | string | The name of the agent. Constraints: maxLength: 256 |
Yes | |
| └─ type | enum | Possible values: agent_reference |
Yes | |
| └─ version | string | The version identifier of the agent. | No | |
| call_id | string | The unique ID of the shell tool call generated by the model. | Yes | |
| created_by | string | The identifier of the actor that created the item. | No | |
| id | string | The unique ID of the shell call output. Populated when this item is returned via API. | Yes | |
| max_output_length | OpenAI.integer (nullable) | Yes | ||
| output | array of OpenAI.FunctionShellCallOutputContent | An array of shell call output contents | Yes | |
| response_id | string | The response on which the item is created. | No | |
| type | enum | The type of the shell call output. Always shell_call_output.Possible values: shell_call_output |
Yes |
OpenAI.OutputItemFunctionToolCall
A tool call to run a function. See the function calling guide for more information.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| agent_reference | AgentReference | No | ||
| └─ name | string | The name of the agent. Constraints: maxLength: 256 |
Yes | |
| └─ type | enum | Possible values: agent_reference |
Yes | |
| └─ version | string | The version identifier of the agent. | No | |
| arguments | string | A JSON string of the arguments to pass to the function. | Yes | |
| call_id | string | The unique ID of the function tool call generated by the model. | Yes | |
| id | string | The unique ID of the function tool call. | No | |
| name | string | The name of the function to run. | Yes | |
| response_id | string | The response on which the item is created. | No | |
| status | enum | The status of the item. One of in_progress, completed, orincomplete. Populated when items are returned via API.Possible values: in_progress, completed, incomplete |
No | |
| type | enum | The type of the function tool call. Always function_call.Possible values: function_call |
Yes |
OpenAI.OutputItemImageGenToolCall
An image generation request made by the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| agent_reference | AgentReference | No | ||
| └─ name | string | The name of the agent. Constraints: maxLength: 256 |
Yes | |
| └─ type | enum | Possible values: agent_reference |
Yes | |
| └─ version | string | The version identifier of the agent. | No | |
| id | string | The unique ID of the image generation call. | Yes | |
| response_id | string | The response on which the item is created. | No | |
| result | string (nullable) | Yes | ||
| status | enum | The status of the image generation call. Possible values: in_progress, completed, generating, failed |
Yes | |
| type | enum | The type of the image generation call. Always image_generation_call.Possible values: image_generation_call |
Yes |
OpenAI.OutputItemLocalShellToolCall
A tool call to run a command on the local shell.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| action | OpenAI.LocalShellExecAction | Execute a shell command on the server. | Yes | |
| agent_reference | AgentReference | No | ||
| └─ name | string | The name of the agent. Constraints: maxLength: 256 |
Yes | |
| └─ type | enum | Possible values: agent_reference |
Yes | |
| └─ version | string | The version identifier of the agent. | No | |
| call_id | string | The unique ID of the local shell tool call generated by the model. | Yes | |
| id | string | The unique ID of the local shell call. | Yes | |
| response_id | string | The response on which the item is created. | No | |
| status | enum | The status of the local shell call. Possible values: in_progress, completed, incomplete |
Yes | |
| type | enum | The type of the local shell call. Always local_shell_call.Possible values: local_shell_call |
Yes |
OpenAI.OutputItemMcpApprovalRequest
A request for human approval of a tool invocation.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| agent_reference | AgentReference | No | ||
| └─ name | string | The name of the agent. Constraints: maxLength: 256 |
Yes | |
| └─ type | enum | Possible values: agent_reference |
Yes | |
| └─ version | string | The version identifier of the agent. | No | |
| arguments | string | A JSON string of arguments for the tool. | Yes | |
| id | string | The unique ID of the approval request. | Yes | |
| name | string | The name of the tool to run. | Yes | |
| response_id | string | The response on which the item is created. | No | |
| server_label | string | The label of the MCP server making the request. | Yes | |
| type | enum | The type of the item. Always mcp_approval_request.Possible values: mcp_approval_request |
Yes |
OpenAI.OutputItemMcpListTools
A list of tools available on an MCP server.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| agent_reference | AgentReference | No | ||
| └─ name | string | The name of the agent. Constraints: maxLength: 256 |
Yes | |
| └─ type | enum | Possible values: agent_reference |
Yes | |
| └─ version | string | The version identifier of the agent. | No | |
| error | string (nullable) | No | ||
| id | string | The unique ID of the list. | Yes | |
| response_id | string | The response on which the item is created. | No | |
| server_label | string | The label of the MCP server. | Yes | |
| tools | array of OpenAI.MCPListToolsTool | The tools available on the server. | Yes | |
| type | enum | The type of the item. Always mcp_list_tools.Possible values: mcp_list_tools |
Yes |
OpenAI.OutputItemMcpToolCall
An invocation of a tool on an MCP server.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| agent_reference | AgentReference | No | ||
| └─ name | string | The name of the agent. Constraints: maxLength: 256 |
Yes | |
| └─ type | enum | Possible values: agent_reference |
Yes | |
| └─ version | string | The version identifier of the agent. | No | |
| approval_request_id | string (nullable) | No | ||
| arguments | string | A JSON string of the arguments passed to the tool. | Yes | |
| error | string (nullable) | No | ||
| id | string | The unique ID of the tool call. | Yes | |
| name | string | The name of the tool that was run. | Yes | |
| output | string (nullable) | No | ||
| response_id | string | The response on which the item is created. | No | |
| server_label | string | The label of the MCP server running the tool. | Yes | |
| status | OpenAI.MCPToolCallStatus | No | ||
| type | enum | The type of the item. Always mcp_call.Possible values: mcp_call |
Yes |
OpenAI.OutputItemOutputMessage
An output message from the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| agent_reference | AgentReference | No | ||
| └─ name | string | The name of the agent. Constraints: maxLength: 256 |
Yes | |
| └─ type | enum | Possible values: agent_reference |
Yes | |
| └─ version | string | The version identifier of the agent. | No | |
| content | array of OpenAI.OutputMessageContent | The content of the output message. | Yes | |
| id | string | The unique ID of the output message. | Yes | |
| response_id | string | The response on which the item is created. | No | |
| role | enum | The role of the output message. Always assistant.Possible values: assistant |
Yes | |
| status | enum | The status of the message input. One of in_progress, completed, orincomplete. Populated when input items are returned via API.Possible values: in_progress, completed, incomplete |
Yes | |
| type | enum | The type of the output message. Always message.Possible values: output_message |
Yes |
OpenAI.OutputItemReasoningItem
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.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| agent_reference | AgentReference | No | ||
| └─ name | string | The name of the agent. Constraints: maxLength: 256 |
Yes | |
| └─ type | enum | Possible values: agent_reference |
Yes | |
| └─ version | string | The version identifier of the agent. | No | |
| content | array of OpenAI.ReasoningTextContent | Reasoning text content. | No | |
| encrypted_content | string (nullable) | No | ||
| id | string | The unique identifier of the reasoning content. | Yes | |
| response_id | string | The response on which the item is created. | No | |
| status | enum | The status of the item. One of in_progress, completed, orincomplete. Populated when items are returned via API.Possible values: in_progress, completed, incomplete |
No | |
| summary | array of OpenAI.Summary | Reasoning summary content. | Yes | |
| type | enum | The type of the object. Always reasoning.Possible values: reasoning |
Yes |
OpenAI.OutputItemType
| Property | Value |
|---|---|
| Type | string |
| Values | output_messagefile_search_callfunction_callweb_search_callcomputer_callreasoningcompactionimage_generation_callcode_interpreter_calllocal_shell_callshell_callshell_call_outputapply_patch_callapply_patch_call_outputmcp_callmcp_list_toolsmcp_approval_requestcustom_tool_callstructured_outputsoauth_consent_requestmemory_search_callworkflow_action |
OpenAI.OutputItemWebSearchToolCall
The results of a web search tool call. See the web search guide for more information.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| action | OpenAI.WebSearchActionSearch or OpenAI.WebSearchActionOpenPage or OpenAI.WebSearchActionFind | An object describing the specific action taken in this web search call. Includes details on how the model used the web (search, open_page, find). |
Yes | |
| agent_reference | AgentReference | No | ||
| └─ name | string | The name of the agent. Constraints: maxLength: 256 |
Yes | |
| └─ type | enum | Possible values: agent_reference |
Yes | |
| └─ version | string | The version identifier of the agent. | No | |
| id | string | The unique ID of the web search tool call. | Yes | |
| response_id | string | The response on which the item is created. | No | |
| status | enum | The status of the web search tool call. Possible values: in_progress, searching, completed, failed |
Yes | |
| type | enum | The type of the web search tool call. Always web_search_call.Possible values: web_search_call |
Yes |
OpenAI.OutputMessageContent
Discriminator for OpenAI.OutputMessageContent
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
output_text |
OpenAI.OutputMessageContentOutputTextContent |
refusal |
OpenAI.OutputMessageContentRefusalContent |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | OpenAI.OutputMessageContentType | Yes |
OpenAI.OutputMessageContentOutputTextContent
A text output from the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| annotations | array of OpenAI.Annotation | The annotations of the text output. | Yes | |
| logprobs | array of OpenAI.LogProb | No | ||
| text | string | The text output from the model. | Yes | |
| type | enum | The type of the output text. Always output_text.Possible values: output_text |
Yes |
OpenAI.OutputMessageContentRefusalContent
A refusal from the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| refusal | string | The refusal explanation from the model. | Yes | |
| type | enum | The type of the refusal. Always refusal.Possible values: refusal |
Yes |
OpenAI.OutputMessageContentType
| Property | Value |
|---|---|
| Type | string |
| Values | output_textrefusal |
OpenAI.Prompt
Reference to a prompt template and its variables. Learn more.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| id | string | The unique identifier of the prompt template to use. | Yes | |
| variables | OpenAI.ResponsePromptVariables (nullable) | Optional map of values to substitute in for variables in your prompt. The substitution values can either be strings, or other Response input types like images or files. |
No | |
| version | string (nullable) | No |
OpenAI.RankerVersionType
| Property | Value |
|---|---|
| Type | string |
| Values | autodefault-2024-11-15 |
OpenAI.RankingOptions
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| hybrid_search | OpenAI.HybridSearchOptions | No | ||
| └─ embedding_weight | OpenAI.numeric | The weight of the embedding in the reciprocal ranking fusion. | Yes | |
| └─ text_weight | OpenAI.numeric | The weight of the text in the reciprocal ranking fusion. | Yes | |
| ranker | OpenAI.RankerVersionType | No | ||
| score_threshold | OpenAI.numeric | No |
OpenAI.Reasoning
gpt-5 and o-series models only Configuration options for reasoning models.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| effort | OpenAI.ReasoningEffort | Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducingreasoning effort can result in faster responses and fewer tokens used on reasoning in a response. - 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.- 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. |
No | |
| generate_summary | enum | Possible values: auto, concise, detailed |
No | |
| summary | enum | Possible values: auto, concise, detailed |
No |
OpenAI.ReasoningEffort
Constrains effort on reasoning for
reasoning models.
Currently supported values are none, minimal, low, medium, high, and xhigh. Reducing
reasoning effort can result in faster responses and fewer tokens used
on reasoning in a response.
gpt-5.1defaults tonone, which does not perform reasoning. The supported reasoning values forgpt-5.1arenone,low,medium, andhigh. Tool calls are supported for all reasoning values in gpt-5.1.- All models before
gpt-5.1default tomediumreasoning effort, and do not supportnone. - The
gpt-5-promodel defaults to (and only supports)highreasoning effort. xhighis supported for all models aftergpt-5.1-codex-max.
| Property | Value |
|---|---|
| Type | string |
| Nullable | Yes |
| Values | noneminimallowmediumhighxhigh |
OpenAI.ReasoningTextContent
Reasoning text from the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| text | string | The reasoning text from the model. | Yes | |
| type | enum | The type of the reasoning text. Always reasoning_text.Possible values: reasoning_text |
Yes |
OpenAI.Response
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| agent_reference | AgentReference (nullable) | Yes | ||
| └─ name | string | The name of the agent. Constraints: maxLength: 256 |
Yes | |
| └─ type | enum | Possible values: agent_reference |
Yes | |
| └─ version | string | The version identifier of the agent. | No | |
| background | boolean (nullable) | No | ||
| completed_at | integer | No | ||
| conversation | OpenAI.ConversationReference (nullable) | The conversation that this response belonged to. Input items and output items from this response were automatically added to this conversation. | No | |
| └─ id | string | The unique ID of the conversation that this response was associated with. | Yes | |
| created_at | integer | Unix timestamp (in seconds) of when this Response was created. | Yes | |
| error | OpenAI.ResponseError (nullable) | An error object returned when the model fails to generate a Response. | Yes | |
| └─ code | OpenAI.ResponseErrorCode | The error code for the response. | Yes | |
| └─ message | string | A human-readable description of the error. | Yes | |
| id | string | Unique identifier for this Response. | Yes | |
| incomplete_details | OpenAI.ResponseIncompleteDetails (nullable) | Yes | ||
| └─ reason | enum | Possible values: max_output_tokens, content_filter |
No | |
| instructions | string or array of OpenAI.InputItem | Yes | ||
| max_output_tokens | OpenAI.integer (nullable) | No | ||
| max_tool_calls | OpenAI.integer (nullable) | No | ||
| metadata | OpenAI.Metadata (nullable) | 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. |
No | |
| model | string | The model deployment to use for the creation of this response. | No | |
| object | enum | The object type of this resource - always set to response.Possible values: response |
Yes | |
| output | array of OpenAI.OutputItem | An array of content items generated by the model. - The length and order of items in the output array is dependenton the model's response. - Rather than accessing the first item in the output array andassuming it's an assistant message with the content generated bythe model, you might consider using the output_text property wheresupported in SDKs. |
Yes | |
| output_text | string (nullable) | No | ||
| parallel_tool_calls | boolean | Whether to allow the model to run tool calls in parallel. | Yes | True |
| previous_response_id | string (nullable) | No | ||
| prompt | OpenAI.Prompt | Reference to a prompt template and its variables. Learn more. |
No | |
| prompt_cache_key | string | Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. Learn more. |
No | |
| prompt_cache_retention | enum | Possible values: in-memory, 24h |
No | |
| reasoning | OpenAI.Reasoning (nullable) | gpt-5 and o-series models only Configuration options for reasoning models. |
No | |
| └─ effort | OpenAI.ReasoningEffort | Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducingreasoning effort can result in faster responses and fewer tokens used on reasoning in a response. - 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.- 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. |
No | |
| └─ generate_summary | enum | Possible values: auto, concise, detailed |
No | |
| └─ summary | enum | Possible values: auto, concise, detailed |
No | |
| safety_identifier | string | 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. |
No | |
| service_tier | OpenAI.ServiceTier | 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'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to 'flex' or 'priority', 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. |
No | |
| status | enum | The status of the response generation. One of completed, failed,in_progress, cancelled, queued, or incomplete.Possible values: completed, failed, in_progress, cancelled, queued, incomplete |
No | |
| temperature | OpenAI.numeric (nullable) | No | 1 | |
| text | OpenAI.ResponseTextParam | Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more: - Text inputs and outputs - Structured Outputs |
No | |
| tool_choice | OpenAI.ToolChoiceOptions or OpenAI.ToolChoiceParam | No | ||
| tools | OpenAI.ToolsArray | An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter.We support the following categories of tools: - Built-in tools: Tools that are provided by OpenAI that extend the model's capabilities, like web search or file search. Learn more about built-in tools. - MCP Tools: Integrations with third-party systems via custom MCP servers or predefined connectors such as Google Drive and SharePoint. Learn more about MCP Tools. - Function calls (custom tools): Functions that are defined by you, enabling the model to call your own code with strongly typed arguments and outputs. Learn more about function calling. You can also use custom tools to call your own code. |
No | |
| top_logprobs | OpenAI.integer (nullable) | No | ||
| top_p | OpenAI.numeric (nullable) | No | 1 | |
| truncation | enum | Possible values: auto, disabled |
No | |
| usage | OpenAI.ResponseUsage | Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used. |
No | |
| user | string (deprecated) | 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. |
No |
OpenAI.ResponseAudioDeltaEvent
Emitted when there is a partial audio response.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| delta | string | A chunk of Base64 encoded response audio bytes. | Yes | |
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.audio.delta.Possible values: response.audio.delta |
Yes |
OpenAI.ResponseAudioDoneEvent
Emitted when the audio response is complete.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.audio.done.Possible values: response.audio.done |
Yes |
OpenAI.ResponseAudioTranscriptDeltaEvent
Emitted when there is a partial transcript of audio.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| delta | string | The partial transcript of the audio response. | Yes | |
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.audio.transcript.delta.Possible values: response.audio.transcript.delta |
Yes |
OpenAI.ResponseAudioTranscriptDoneEvent
Emitted when the full audio transcript is completed.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.audio.transcript.done.Possible values: response.audio.transcript.done |
Yes |
OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent
Emitted when a partial code snippet is streamed by the code interpreter.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| delta | string | The partial code snippet being streamed by the code interpreter. | Yes | |
| item_id | string | The unique identifier of the code interpreter tool call item. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.code_interpreter_call_code.delta.Possible values: response.code_interpreter_call_code.delta |
Yes |
OpenAI.ResponseCodeInterpreterCallCodeDoneEvent
Emitted when the code snippet is finalized by the code interpreter.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| code | string | The final code snippet output by the code interpreter. | Yes | |
| item_id | string | The unique identifier of the code interpreter tool call item. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.code_interpreter_call_code.done.Possible values: response.code_interpreter_call_code.done |
Yes |
OpenAI.ResponseCodeInterpreterCallCompletedEvent
Emitted when the code interpreter call is completed.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item_id | string | The unique identifier of the code interpreter tool call item. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.code_interpreter_call.completed.Possible values: response.code_interpreter_call.completed |
Yes |
OpenAI.ResponseCodeInterpreterCallInProgressEvent
Emitted when a code interpreter call is in progress.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item_id | string | The unique identifier of the code interpreter tool call item. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.code_interpreter_call.in_progress.Possible values: response.code_interpreter_call.in_progress |
Yes |
OpenAI.ResponseCodeInterpreterCallInterpretingEvent
Emitted when the code interpreter is actively interpreting the code snippet.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item_id | string | The unique identifier of the code interpreter tool call item. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.code_interpreter_call.interpreting.Possible values: response.code_interpreter_call.interpreting |
Yes |
OpenAI.ResponseCompletedEvent
Emitted when the model response is complete.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| response | OpenAI.Response | Yes | ||
| └─ agent_reference | AgentReference (nullable) | The agent used for this response | Yes | |
| └─ background | boolean (nullable) | No | ||
| └─ completed_at | integer (nullable) | No | ||
| └─ conversation | OpenAI.ConversationReference (nullable) | The conversation that this response belonged to. Input items and output items from this response were automatically added to this conversation. | No | |
| └─ created_at | integer | Unix timestamp (in seconds) of when this Response was created. | Yes | |
| └─ error | OpenAI.ResponseError (nullable) | An error object returned when the model fails to generate a Response. | Yes | |
| └─ id | string | Unique identifier for this Response. | Yes | |
| └─ incomplete_details | OpenAI.ResponseIncompleteDetails (nullable) | Yes | ||
| └─ instructions | string or array of OpenAI.InputItem (nullable) | Yes | ||
| └─ max_output_tokens | OpenAI.integer (nullable) | No | ||
| └─ max_tool_calls | OpenAI.integer (nullable) | No | ||
| └─ metadata | OpenAI.Metadata (nullable) | 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. |
No | |
| └─ model | string | The model deployment to use for the creation of this response. | No | |
| └─ object | enum | The object type of this resource - always set to response.Possible values: response |
Yes | |
| └─ output | array of OpenAI.OutputItem | An array of content items generated by the model. - The length and order of items in the output array is dependenton the model's response. - Rather than accessing the first item in the output array andassuming it's an assistant message with the content generated bythe model, you might consider using the output_text property wheresupported in SDKs. |
Yes | |
| └─ output_text | string (nullable) | No | ||
| └─ parallel_tool_calls | boolean | Whether to allow the model to run tool calls in parallel. | Yes | True |
| └─ previous_response_id | string (nullable) | No | ||
| └─ prompt | OpenAI.Prompt | Reference to a prompt template and its variables. Learn more. |
No | |
| └─ prompt_cache_key | string | Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. Learn more. |
No | |
| └─ prompt_cache_retention | enum | Possible values: in-memory, 24h |
No | |
| └─ reasoning | OpenAI.Reasoning (nullable) | gpt-5 and o-series models only Configuration options for reasoning models. |
No | |
| └─ safety_identifier | string | 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. |
No | |
| └─ service_tier | OpenAI.ServiceTier | 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'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to 'flex' or 'priority', 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. |
No | |
| └─ status | enum | The status of the response generation. One of completed, failed,in_progress, cancelled, queued, or incomplete.Possible values: completed, failed, in_progress, cancelled, queued, incomplete |
No | |
| └─ temperature | OpenAI.numeric (nullable) | No | 1 | |
| └─ text | OpenAI.ResponseTextParam | Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more: - Text inputs and outputs - Structured Outputs |
No | |
| └─ tool_choice | OpenAI.ToolChoiceOptions or OpenAI.ToolChoiceParam | No | ||
| └─ tools | OpenAI.ToolsArray | An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter.We support the following categories of tools: - Built-in tools: Tools that are provided by OpenAI that extend the model's capabilities, like web search or file search. Learn more about built-in tools. - MCP Tools: Integrations with third-party systems via custom MCP servers or predefined connectors such as Google Drive and SharePoint. Learn more about MCP Tools. - Function calls (custom tools): Functions that are defined by you, enabling the model to call your own code with strongly typed arguments and outputs. Learn more about function calling. You can also use custom tools to call your own code. |
No | |
| └─ top_logprobs | OpenAI.integer (nullable) | No | ||
| └─ top_p | OpenAI.numeric (nullable) | No | 1 | |
| └─ truncation | enum | Possible values: auto, disabled |
No | |
| └─ usage | OpenAI.ResponseUsage | Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used. |
No | |
| └─ user | string (deprecated) | 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. |
No | |
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.completed.Possible values: response.completed |
Yes |
OpenAI.ResponseContentPartAddedEvent
Emitted when a new content part is added.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content_index | OpenAI.integer | Yes | ||
| item_id | string | The ID of the output item that the content part was added to. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| part | OpenAI.OutputContent | Yes | ||
| └─ type | OpenAI.OutputContentType | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.content_part.added.Possible values: response.content_part.added |
Yes |
OpenAI.ResponseContentPartDoneEvent
Emitted when a content part is done.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content_index | OpenAI.integer | Yes | ||
| item_id | string | The ID of the output item that the content part was added to. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| part | OpenAI.OutputContent | Yes | ||
| └─ type | OpenAI.OutputContentType | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.content_part.done.Possible values: response.content_part.done |
Yes |
OpenAI.ResponseCreatedEvent
An event that is emitted when a response is created.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| response | OpenAI.Response | Yes | ||
| └─ agent_reference | AgentReference (nullable) | The agent used for this response | Yes | |
| └─ background | boolean (nullable) | No | ||
| └─ completed_at | integer (nullable) | No | ||
| └─ conversation | OpenAI.ConversationReference (nullable) | The conversation that this response belonged to. Input items and output items from this response were automatically added to this conversation. | No | |
| └─ created_at | integer | Unix timestamp (in seconds) of when this Response was created. | Yes | |
| └─ error | OpenAI.ResponseError (nullable) | An error object returned when the model fails to generate a Response. | Yes | |
| └─ id | string | Unique identifier for this Response. | Yes | |
| └─ incomplete_details | OpenAI.ResponseIncompleteDetails (nullable) | Yes | ||
| └─ instructions | string or array of OpenAI.InputItem (nullable) | Yes | ||
| └─ max_output_tokens | OpenAI.integer (nullable) | No | ||
| └─ max_tool_calls | OpenAI.integer (nullable) | No | ||
| └─ metadata | OpenAI.Metadata (nullable) | 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. |
No | |
| └─ model | string | The model deployment to use for the creation of this response. | No | |
| └─ object | enum | The object type of this resource - always set to response.Possible values: response |
Yes | |
| └─ output | array of OpenAI.OutputItem | An array of content items generated by the model. - The length and order of items in the output array is dependenton the model's response. - Rather than accessing the first item in the output array andassuming it's an assistant message with the content generated bythe model, you might consider using the output_text property wheresupported in SDKs. |
Yes | |
| └─ output_text | string (nullable) | No | ||
| └─ parallel_tool_calls | boolean | Whether to allow the model to run tool calls in parallel. | Yes | True |
| └─ previous_response_id | string (nullable) | No | ||
| └─ prompt | OpenAI.Prompt | Reference to a prompt template and its variables. Learn more. |
No | |
| └─ prompt_cache_key | string | Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. Learn more. |
No | |
| └─ prompt_cache_retention | enum | Possible values: in-memory, 24h |
No | |
| └─ reasoning | OpenAI.Reasoning (nullable) | gpt-5 and o-series models only Configuration options for reasoning models. |
No | |
| └─ safety_identifier | string | 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. |
No | |
| └─ service_tier | OpenAI.ServiceTier | 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'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to 'flex' or 'priority', 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. |
No | |
| └─ status | enum | The status of the response generation. One of completed, failed,in_progress, cancelled, queued, or incomplete.Possible values: completed, failed, in_progress, cancelled, queued, incomplete |
No | |
| └─ temperature | OpenAI.numeric (nullable) | No | 1 | |
| └─ text | OpenAI.ResponseTextParam | Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more: - Text inputs and outputs - Structured Outputs |
No | |
| └─ tool_choice | OpenAI.ToolChoiceOptions or OpenAI.ToolChoiceParam | No | ||
| └─ tools | OpenAI.ToolsArray | An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter.We support the following categories of tools: - Built-in tools: Tools that are provided by OpenAI that extend the model's capabilities, like web search or file search. Learn more about built-in tools. - MCP Tools: Integrations with third-party systems via custom MCP servers or predefined connectors such as Google Drive and SharePoint. Learn more about MCP Tools. - Function calls (custom tools): Functions that are defined by you, enabling the model to call your own code with strongly typed arguments and outputs. Learn more about function calling. You can also use custom tools to call your own code. |
No | |
| └─ top_logprobs | OpenAI.integer (nullable) | No | ||
| └─ top_p | OpenAI.numeric (nullable) | No | 1 | |
| └─ truncation | enum | Possible values: auto, disabled |
No | |
| └─ usage | OpenAI.ResponseUsage | Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used. |
No | |
| └─ user | string (deprecated) | 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. |
No | |
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.created.Possible values: response.created |
Yes |
OpenAI.ResponseCustomToolCallInputDeltaEvent
Event representing a delta (partial update) to the input of a custom tool call.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| delta | string | The incremental input data (delta) for the custom tool call. | Yes | |
| item_id | string | Unique identifier for the API item associated with this event. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The event type identifier. Possible values: response.custom_tool_call_input.delta |
Yes |
OpenAI.ResponseCustomToolCallInputDoneEvent
Event indicating that input for a custom tool call is complete.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| input | string | The complete input data for the custom tool call. | Yes | |
| item_id | string | Unique identifier for the API item associated with this event. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The event type identifier. Possible values: response.custom_tool_call_input.done |
Yes |
OpenAI.ResponseError
An error object returned when the model fails to generate a Response.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| code | OpenAI.ResponseErrorCode | The error code for the response. | Yes | |
| message | string | A human-readable description of the error. | Yes |
OpenAI.ResponseErrorCode
The error code for the response.
| Property | Value |
|---|---|
| Type | string |
| Values | server_errorrate_limit_exceededinvalid_promptvector_store_timeoutinvalid_imageinvalid_image_formatinvalid_base64_imageinvalid_image_urlimage_too_largeimage_too_smallimage_parse_errorimage_content_policy_violationinvalid_image_modeimage_file_too_largeunsupported_image_media_typeempty_image_filefailed_to_download_imageimage_file_not_found |
OpenAI.ResponseErrorEvent
Emitted when an error occurs.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| code | string (nullable) | Yes | ||
| message | string | The error message. | Yes | |
| param | string (nullable) | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always error.Possible values: error |
Yes |
OpenAI.ResponseFailedEvent
An event that is emitted when a response fails.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| response | OpenAI.Response | Yes | ||
| └─ agent_reference | AgentReference (nullable) | The agent used for this response | Yes | |
| └─ background | boolean (nullable) | No | ||
| └─ completed_at | integer (nullable) | No | ||
| └─ conversation | OpenAI.ConversationReference (nullable) | The conversation that this response belonged to. Input items and output items from this response were automatically added to this conversation. | No | |
| └─ created_at | integer | Unix timestamp (in seconds) of when this Response was created. | Yes | |
| └─ error | OpenAI.ResponseError (nullable) | An error object returned when the model fails to generate a Response. | Yes | |
| └─ id | string | Unique identifier for this Response. | Yes | |
| └─ incomplete_details | OpenAI.ResponseIncompleteDetails (nullable) | Yes | ||
| └─ instructions | string or array of OpenAI.InputItem (nullable) | Yes | ||
| └─ max_output_tokens | OpenAI.integer (nullable) | No | ||
| └─ max_tool_calls | OpenAI.integer (nullable) | No | ||
| └─ metadata | OpenAI.Metadata (nullable) | 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. |
No | |
| └─ model | string | The model deployment to use for the creation of this response. | No | |
| └─ object | enum | The object type of this resource - always set to response.Possible values: response |
Yes | |
| └─ output | array of OpenAI.OutputItem | An array of content items generated by the model. - The length and order of items in the output array is dependenton the model's response. - Rather than accessing the first item in the output array andassuming it's an assistant message with the content generated bythe model, you might consider using the output_text property wheresupported in SDKs. |
Yes | |
| └─ output_text | string (nullable) | No | ||
| └─ parallel_tool_calls | boolean | Whether to allow the model to run tool calls in parallel. | Yes | True |
| └─ previous_response_id | string (nullable) | No | ||
| └─ prompt | OpenAI.Prompt | Reference to a prompt template and its variables. Learn more. |
No | |
| └─ prompt_cache_key | string | Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. Learn more. |
No | |
| └─ prompt_cache_retention | enum | Possible values: in-memory, 24h |
No | |
| └─ reasoning | OpenAI.Reasoning (nullable) | gpt-5 and o-series models only Configuration options for reasoning models. |
No | |
| └─ safety_identifier | string | 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. |
No | |
| └─ service_tier | OpenAI.ServiceTier | 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'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to 'flex' or 'priority', 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. |
No | |
| └─ status | enum | The status of the response generation. One of completed, failed,in_progress, cancelled, queued, or incomplete.Possible values: completed, failed, in_progress, cancelled, queued, incomplete |
No | |
| └─ temperature | OpenAI.numeric (nullable) | No | 1 | |
| └─ text | OpenAI.ResponseTextParam | Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more: - Text inputs and outputs - Structured Outputs |
No | |
| └─ tool_choice | OpenAI.ToolChoiceOptions or OpenAI.ToolChoiceParam | No | ||
| └─ tools | OpenAI.ToolsArray | An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter.We support the following categories of tools: - Built-in tools: Tools that are provided by OpenAI that extend the model's capabilities, like web search or file search. Learn more about built-in tools. - MCP Tools: Integrations with third-party systems via custom MCP servers or predefined connectors such as Google Drive and SharePoint. Learn more about MCP Tools. - Function calls (custom tools): Functions that are defined by you, enabling the model to call your own code with strongly typed arguments and outputs. Learn more about function calling. You can also use custom tools to call your own code. |
No | |
| └─ top_logprobs | OpenAI.integer (nullable) | No | ||
| └─ top_p | OpenAI.numeric (nullable) | No | 1 | |
| └─ truncation | enum | Possible values: auto, disabled |
No | |
| └─ usage | OpenAI.ResponseUsage | Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used. |
No | |
| └─ user | string (deprecated) | 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. |
No | |
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.failed.Possible values: response.failed |
Yes |
OpenAI.ResponseFileSearchCallCompletedEvent
Emitted when a file search call is completed (results found).
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item_id | string | The ID of the output item that the file search call is initiated. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.file_search_call.completed.Possible values: response.file_search_call.completed |
Yes |
OpenAI.ResponseFileSearchCallInProgressEvent
Emitted when a file search call is initiated.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item_id | string | The ID of the output item that the file search call is initiated. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.file_search_call.in_progress.Possible values: response.file_search_call.in_progress |
Yes |
OpenAI.ResponseFileSearchCallSearchingEvent
Emitted when a file search is currently searching.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item_id | string | The ID of the output item that the file search call is initiated. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.file_search_call.searching.Possible values: response.file_search_call.searching |
Yes |
OpenAI.ResponseFormatJsonObject
JSON object response format. An older method of generating JSON responses.
Using json_schema is recommended for models that support it. Note that the
model will not generate JSON without a system or user message instructing it
to do so.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | The type of response format being defined. Always json_object.Possible values: json_object |
Yes |
OpenAI.ResponseFormatJsonSchema
JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| json_schema | OpenAI.ResponseFormatJsonSchemaJsonSchema | Yes | ||
| └─ description | string | No | ||
| └─ name | string | Yes | ||
| └─ schema | OpenAI.ResponseFormatJsonSchemaSchema | The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas here. |
No | |
| └─ strict | boolean (nullable) | No | ||
| type | enum | The type of response format being defined. Always json_schema.Possible values: json_schema |
Yes |
OpenAI.ResponseFormatJsonSchemaJsonSchema
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | No | ||
| name | string | Yes | ||
| schema | OpenAI.ResponseFormatJsonSchemaSchema | The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas here. |
No | |
| strict | boolean (nullable) | No |
OpenAI.ResponseFormatJsonSchemaSchema
The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas here.
Type: object
OpenAI.ResponseFormatText
Default response format. Used to generate text responses.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | The type of response format being defined. Always text.Possible values: text |
Yes |
OpenAI.ResponseFunctionCallArgumentsDeltaEvent
Emitted when there is a partial function-call arguments delta.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| delta | string | The function-call arguments delta that is added. | Yes | |
| item_id | string | The ID of the output item that the function-call arguments delta is added to. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.function_call_arguments.delta.Possible values: response.function_call_arguments.delta |
Yes |
OpenAI.ResponseFunctionCallArgumentsDoneEvent
Emitted when function-call arguments are finalized.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| arguments | string | The function-call arguments. | Yes | |
| item_id | string | The ID of the item. | Yes | |
| name | string | The name of the function that was called. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | Possible values: response.function_call_arguments.done |
Yes |
OpenAI.ResponseImageGenCallCompletedEvent
Emitted when an image generation tool call has completed and the final image is available.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item_id | string | The unique identifier of the image generation item being processed. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always 'response.image_generation_call.completed'. Possible values: response.image_generation_call.completed |
Yes |
OpenAI.ResponseImageGenCallGeneratingEvent
Emitted when an image generation tool call is actively generating an image (intermediate state).
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item_id | string | The unique identifier of the image generation item being processed. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always 'response.image_generation_call.generating'. Possible values: response.image_generation_call.generating |
Yes |
OpenAI.ResponseImageGenCallInProgressEvent
Emitted when an image generation tool call is in progress.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item_id | string | The unique identifier of the image generation item being processed. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always 'response.image_generation_call.in_progress'. Possible values: response.image_generation_call.in_progress |
Yes |
OpenAI.ResponseImageGenCallPartialImageEvent
Emitted when a partial image is available during image generation streaming.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item_id | string | The unique identifier of the image generation item being processed. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| partial_image_b64 | string | Base64-encoded partial image data, suitable for rendering as an image. | Yes | |
| partial_image_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always 'response.image_generation_call.partial_image'. Possible values: response.image_generation_call.partial_image |
Yes |
OpenAI.ResponseInProgressEvent
Emitted when the response is in progress.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| response | OpenAI.Response | Yes | ||
| └─ agent_reference | AgentReference (nullable) | The agent used for this response | Yes | |
| └─ background | boolean (nullable) | No | ||
| └─ completed_at | integer (nullable) | No | ||
| └─ conversation | OpenAI.ConversationReference (nullable) | The conversation that this response belonged to. Input items and output items from this response were automatically added to this conversation. | No | |
| └─ created_at | integer | Unix timestamp (in seconds) of when this Response was created. | Yes | |
| └─ error | OpenAI.ResponseError (nullable) | An error object returned when the model fails to generate a Response. | Yes | |
| └─ id | string | Unique identifier for this Response. | Yes | |
| └─ incomplete_details | OpenAI.ResponseIncompleteDetails (nullable) | Yes | ||
| └─ instructions | string or array of OpenAI.InputItem (nullable) | Yes | ||
| └─ max_output_tokens | OpenAI.integer (nullable) | No | ||
| └─ max_tool_calls | OpenAI.integer (nullable) | No | ||
| └─ metadata | OpenAI.Metadata (nullable) | 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. |
No | |
| └─ model | string | The model deployment to use for the creation of this response. | No | |
| └─ object | enum | The object type of this resource - always set to response.Possible values: response |
Yes | |
| └─ output | array of OpenAI.OutputItem | An array of content items generated by the model. - The length and order of items in the output array is dependenton the model's response. - Rather than accessing the first item in the output array andassuming it's an assistant message with the content generated bythe model, you might consider using the output_text property wheresupported in SDKs. |
Yes | |
| └─ output_text | string (nullable) | No | ||
| └─ parallel_tool_calls | boolean | Whether to allow the model to run tool calls in parallel. | Yes | True |
| └─ previous_response_id | string (nullable) | No | ||
| └─ prompt | OpenAI.Prompt | Reference to a prompt template and its variables. Learn more. |
No | |
| └─ prompt_cache_key | string | Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. Learn more. |
No | |
| └─ prompt_cache_retention | enum | Possible values: in-memory, 24h |
No | |
| └─ reasoning | OpenAI.Reasoning (nullable) | gpt-5 and o-series models only Configuration options for reasoning models. |
No | |
| └─ safety_identifier | string | 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. |
No | |
| └─ service_tier | OpenAI.ServiceTier | 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'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to 'flex' or 'priority', 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. |
No | |
| └─ status | enum | The status of the response generation. One of completed, failed,in_progress, cancelled, queued, or incomplete.Possible values: completed, failed, in_progress, cancelled, queued, incomplete |
No | |
| └─ temperature | OpenAI.numeric (nullable) | No | 1 | |
| └─ text | OpenAI.ResponseTextParam | Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more: - Text inputs and outputs - Structured Outputs |
No | |
| └─ tool_choice | OpenAI.ToolChoiceOptions or OpenAI.ToolChoiceParam | No | ||
| └─ tools | OpenAI.ToolsArray | An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter.We support the following categories of tools: - Built-in tools: Tools that are provided by OpenAI that extend the model's capabilities, like web search or file search. Learn more about built-in tools. - MCP Tools: Integrations with third-party systems via custom MCP servers or predefined connectors such as Google Drive and SharePoint. Learn more about MCP Tools. - Function calls (custom tools): Functions that are defined by you, enabling the model to call your own code with strongly typed arguments and outputs. Learn more about function calling. You can also use custom tools to call your own code. |
No | |
| └─ top_logprobs | OpenAI.integer (nullable) | No | ||
| └─ top_p | OpenAI.numeric (nullable) | No | 1 | |
| └─ truncation | enum | Possible values: auto, disabled |
No | |
| └─ usage | OpenAI.ResponseUsage | Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used. |
No | |
| └─ user | string (deprecated) | 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. |
No | |
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.in_progress.Possible values: response.in_progress |
Yes |
OpenAI.ResponseIncompleteDetails
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| reason | enum | Possible values: max_output_tokens, content_filter |
No |
OpenAI.ResponseIncompleteEvent
An event that is emitted when a response finishes as incomplete.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| response | OpenAI.Response | Yes | ||
| └─ agent_reference | AgentReference (nullable) | The agent used for this response | Yes | |
| └─ background | boolean (nullable) | No | ||
| └─ completed_at | integer (nullable) | No | ||
| └─ conversation | OpenAI.ConversationReference (nullable) | The conversation that this response belonged to. Input items and output items from this response were automatically added to this conversation. | No | |
| └─ created_at | integer | Unix timestamp (in seconds) of when this Response was created. | Yes | |
| └─ error | OpenAI.ResponseError (nullable) | An error object returned when the model fails to generate a Response. | Yes | |
| └─ id | string | Unique identifier for this Response. | Yes | |
| └─ incomplete_details | OpenAI.ResponseIncompleteDetails (nullable) | Yes | ||
| └─ instructions | string or array of OpenAI.InputItem (nullable) | Yes | ||
| └─ max_output_tokens | OpenAI.integer (nullable) | No | ||
| └─ max_tool_calls | OpenAI.integer (nullable) | No | ||
| └─ metadata | OpenAI.Metadata (nullable) | 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. |
No | |
| └─ model | string | The model deployment to use for the creation of this response. | No | |
| └─ object | enum | The object type of this resource - always set to response.Possible values: response |
Yes | |
| └─ output | array of OpenAI.OutputItem | An array of content items generated by the model. - The length and order of items in the output array is dependenton the model's response. - Rather than accessing the first item in the output array andassuming it's an assistant message with the content generated bythe model, you might consider using the output_text property wheresupported in SDKs. |
Yes | |
| └─ output_text | string (nullable) | No | ||
| └─ parallel_tool_calls | boolean | Whether to allow the model to run tool calls in parallel. | Yes | True |
| └─ previous_response_id | string (nullable) | No | ||
| └─ prompt | OpenAI.Prompt | Reference to a prompt template and its variables. Learn more. |
No | |
| └─ prompt_cache_key | string | Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. Learn more. |
No | |
| └─ prompt_cache_retention | enum | Possible values: in-memory, 24h |
No | |
| └─ reasoning | OpenAI.Reasoning (nullable) | gpt-5 and o-series models only Configuration options for reasoning models. |
No | |
| └─ safety_identifier | string | 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. |
No | |
| └─ service_tier | OpenAI.ServiceTier | 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'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to 'flex' or 'priority', 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. |
No | |
| └─ status | enum | The status of the response generation. One of completed, failed,in_progress, cancelled, queued, or incomplete.Possible values: completed, failed, in_progress, cancelled, queued, incomplete |
No | |
| └─ temperature | OpenAI.numeric (nullable) | No | 1 | |
| └─ text | OpenAI.ResponseTextParam | Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more: - Text inputs and outputs - Structured Outputs |
No | |
| └─ tool_choice | OpenAI.ToolChoiceOptions or OpenAI.ToolChoiceParam | No | ||
| └─ tools | OpenAI.ToolsArray | An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter.We support the following categories of tools: - Built-in tools: Tools that are provided by OpenAI that extend the model's capabilities, like web search or file search. Learn more about built-in tools. - MCP Tools: Integrations with third-party systems via custom MCP servers or predefined connectors such as Google Drive and SharePoint. Learn more about MCP Tools. - Function calls (custom tools): Functions that are defined by you, enabling the model to call your own code with strongly typed arguments and outputs. Learn more about function calling. You can also use custom tools to call your own code. |
No | |
| └─ top_logprobs | OpenAI.integer (nullable) | No | ||
| └─ top_p | OpenAI.numeric (nullable) | No | 1 | |
| └─ truncation | enum | Possible values: auto, disabled |
No | |
| └─ usage | OpenAI.ResponseUsage | Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used. |
No | |
| └─ user | string (deprecated) | 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. |
No | |
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.incomplete.Possible values: response.incomplete |
Yes |
OpenAI.ResponseLogProb
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) logprob values indicate greater model confidence in that token choice.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| logprob | OpenAI.numeric | Yes | ||
| token | string | A possible text token. | Yes | |
| top_logprobs | array of OpenAI.ResponseLogProbTopLogprobs | The log probability of the top 20 most likely tokens. | No |
OpenAI.ResponseLogProbTopLogprobs
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| logprob | OpenAI.numeric | No | ||
| token | string | No |
OpenAI.ResponseMCPCallArgumentsDeltaEvent
Emitted when there is a delta (partial update) to the arguments of an MCP tool call.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| delta | string | A JSON string containing the partial update to the arguments for the MCP tool call. | Yes | |
| item_id | string | The unique identifier of the MCP tool call item being processed. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always 'response.mcp_call_arguments.delta'. Possible values: response.mcp_call_arguments.delta |
Yes |
OpenAI.ResponseMCPCallArgumentsDoneEvent
Emitted when the arguments for an MCP tool call are finalized.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| arguments | string | A JSON string containing the finalized arguments for the MCP tool call. | Yes | |
| item_id | string | The unique identifier of the MCP tool call item being processed. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always 'response.mcp_call_arguments.done'. Possible values: response.mcp_call_arguments.done |
Yes |
OpenAI.ResponseMCPCallCompletedEvent
Emitted when an MCP tool call has completed successfully.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item_id | string | The ID of the MCP tool call item that completed. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always 'response.mcp_call.completed'. Possible values: response.mcp_call.completed |
Yes |
OpenAI.ResponseMCPCallFailedEvent
Emitted when an MCP tool call has failed.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item_id | string | The ID of the MCP tool call item that failed. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always 'response.mcp_call.failed'. Possible values: response.mcp_call.failed |
Yes |
OpenAI.ResponseMCPCallInProgressEvent
Emitted when an MCP tool call is in progress.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item_id | string | The unique identifier of the MCP tool call item being processed. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always 'response.mcp_call.in_progress'. Possible values: response.mcp_call.in_progress |
Yes |
OpenAI.ResponseMCPListToolsCompletedEvent
Emitted when the list of available MCP tools has been successfully retrieved.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item_id | string | The ID of the MCP tool call item that produced this output. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always 'response.mcp_list_tools.completed'. Possible values: response.mcp_list_tools.completed |
Yes |
OpenAI.ResponseMCPListToolsFailedEvent
Emitted when the attempt to list available MCP tools has failed.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item_id | string | The ID of the MCP tool call item that failed. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always 'response.mcp_list_tools.failed'. Possible values: response.mcp_list_tools.failed |
Yes |
OpenAI.ResponseMCPListToolsInProgressEvent
Emitted when the system is in the process of retrieving the list of available MCP tools.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item_id | string | The ID of the MCP tool call item that is being processed. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always 'response.mcp_list_tools.in_progress'. Possible values: response.mcp_list_tools.in_progress |
Yes |
OpenAI.ResponseOutputItemAddedEvent
Emitted when a new output item is added.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item | OpenAI.OutputItem | Yes | ||
| └─ agent_reference | AgentReference | The agent that created the item. | No | |
| └─ response_id | string | The response on which the item is created. | No | |
| └─ type | OpenAI.OutputItemType | Yes | ||
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.output_item.added.Possible values: response.output_item.added |
Yes |
OpenAI.ResponseOutputItemDoneEvent
Emitted when an output item is marked done.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item | OpenAI.OutputItem | Yes | ||
| └─ agent_reference | AgentReference | The agent that created the item. | No | |
| └─ response_id | string | The response on which the item is created. | No | |
| └─ type | OpenAI.OutputItemType | Yes | ||
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.output_item.done.Possible values: response.output_item.done |
Yes |
OpenAI.ResponseOutputTextAnnotationAddedEvent
Emitted when an annotation is added to output text content.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| annotation | OpenAI.Annotation | An annotation that applies to a span of output text. | Yes | |
| └─ type | OpenAI.AnnotationType | Yes | ||
| annotation_index | OpenAI.integer | Yes | ||
| content_index | OpenAI.integer | Yes | ||
| item_id | string | The unique identifier of the item to which the annotation is being added. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always 'response.output_text.annotation.added'. Possible values: response.output_text.annotation.added |
Yes |
OpenAI.ResponsePromptVariables
Optional map of values to substitute in for variables in your prompt. The substitution values can either be strings, or other Response input types like images or files.
Type: object
OpenAI.ResponseQueuedEvent
Emitted when a response is queued and waiting to be processed.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| response | OpenAI.Response | Yes | ||
| └─ agent_reference | AgentReference (nullable) | The agent used for this response | Yes | |
| └─ background | boolean (nullable) | No | ||
| └─ completed_at | integer (nullable) | No | ||
| └─ conversation | OpenAI.ConversationReference (nullable) | The conversation that this response belonged to. Input items and output items from this response were automatically added to this conversation. | No | |
| └─ created_at | integer | Unix timestamp (in seconds) of when this Response was created. | Yes | |
| └─ error | OpenAI.ResponseError (nullable) | An error object returned when the model fails to generate a Response. | Yes | |
| └─ id | string | Unique identifier for this Response. | Yes | |
| └─ incomplete_details | OpenAI.ResponseIncompleteDetails (nullable) | Yes | ||
| └─ instructions | string or array of OpenAI.InputItem (nullable) | Yes | ||
| └─ max_output_tokens | OpenAI.integer (nullable) | No | ||
| └─ max_tool_calls | OpenAI.integer (nullable) | No | ||
| └─ metadata | OpenAI.Metadata (nullable) | 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. |
No | |
| └─ model | string | The model deployment to use for the creation of this response. | No | |
| └─ object | enum | The object type of this resource - always set to response.Possible values: response |
Yes | |
| └─ output | array of OpenAI.OutputItem | An array of content items generated by the model. - The length and order of items in the output array is dependenton the model's response. - Rather than accessing the first item in the output array andassuming it's an assistant message with the content generated bythe model, you might consider using the output_text property wheresupported in SDKs. |
Yes | |
| └─ output_text | string (nullable) | No | ||
| └─ parallel_tool_calls | boolean | Whether to allow the model to run tool calls in parallel. | Yes | True |
| └─ previous_response_id | string (nullable) | No | ||
| └─ prompt | OpenAI.Prompt | Reference to a prompt template and its variables. Learn more. |
No | |
| └─ prompt_cache_key | string | Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. Learn more. |
No | |
| └─ prompt_cache_retention | enum | Possible values: in-memory, 24h |
No | |
| └─ reasoning | OpenAI.Reasoning (nullable) | gpt-5 and o-series models only Configuration options for reasoning models. |
No | |
| └─ safety_identifier | string | 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. |
No | |
| └─ service_tier | OpenAI.ServiceTier | 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'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to 'flex' or 'priority', 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. |
No | |
| └─ status | enum | The status of the response generation. One of completed, failed,in_progress, cancelled, queued, or incomplete.Possible values: completed, failed, in_progress, cancelled, queued, incomplete |
No | |
| └─ temperature | OpenAI.numeric (nullable) | No | 1 | |
| └─ text | OpenAI.ResponseTextParam | Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more: - Text inputs and outputs - Structured Outputs |
No | |
| └─ tool_choice | OpenAI.ToolChoiceOptions or OpenAI.ToolChoiceParam | No | ||
| └─ tools | OpenAI.ToolsArray | An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter.We support the following categories of tools: - Built-in tools: Tools that are provided by OpenAI that extend the model's capabilities, like web search or file search. Learn more about built-in tools. - MCP Tools: Integrations with third-party systems via custom MCP servers or predefined connectors such as Google Drive and SharePoint. Learn more about MCP Tools. - Function calls (custom tools): Functions that are defined by you, enabling the model to call your own code with strongly typed arguments and outputs. Learn more about function calling. You can also use custom tools to call your own code. |
No | |
| └─ top_logprobs | OpenAI.integer (nullable) | No | ||
| └─ top_p | OpenAI.numeric (nullable) | No | 1 | |
| └─ truncation | enum | Possible values: auto, disabled |
No | |
| └─ usage | OpenAI.ResponseUsage | Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used. |
No | |
| └─ user | string (deprecated) | 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. |
No | |
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always 'response.queued'. Possible values: response.queued |
Yes |
OpenAI.ResponseReasoningSummaryPartAddedEvent
Emitted when a new reasoning summary part is added.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item_id | string | The ID of the item this summary part is associated with. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| part | OpenAI.ResponseReasoningSummaryPartAddedEventPart | Yes | ||
| └─ text | string | Yes | ||
| └─ type | enum | Possible values: summary_text |
Yes | |
| sequence_number | OpenAI.integer | Yes | ||
| summary_index | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.reasoning_summary_part.added.Possible values: response.reasoning_summary_part.added |
Yes |
OpenAI.ResponseReasoningSummaryPartAddedEventPart
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| text | string | Yes | ||
| type | enum | Possible values: summary_text |
Yes |
OpenAI.ResponseReasoningSummaryPartDoneEvent
Emitted when a reasoning summary part is completed.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item_id | string | The ID of the item this summary part is associated with. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| part | OpenAI.ResponseReasoningSummaryPartDoneEventPart | Yes | ||
| └─ text | string | Yes | ||
| └─ type | enum | Possible values: summary_text |
Yes | |
| sequence_number | OpenAI.integer | Yes | ||
| summary_index | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.reasoning_summary_part.done.Possible values: response.reasoning_summary_part.done |
Yes |
OpenAI.ResponseReasoningSummaryPartDoneEventPart
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| text | string | Yes | ||
| type | enum | Possible values: summary_text |
Yes |
OpenAI.ResponseReasoningSummaryTextDeltaEvent
Emitted when a delta is added to a reasoning summary text.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| delta | string | The text delta that was added to the summary. | Yes | |
| item_id | string | The ID of the item this summary text delta is associated with. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| summary_index | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.reasoning_summary_text.delta.Possible values: response.reasoning_summary_text.delta |
Yes |
OpenAI.ResponseReasoningSummaryTextDoneEvent
Emitted when a reasoning summary text is completed.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item_id | string | The ID of the item this summary text is associated with. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| summary_index | OpenAI.integer | Yes | ||
| text | string | The full text of the completed reasoning summary. | Yes | |
| type | enum | The type of the event. Always response.reasoning_summary_text.done.Possible values: response.reasoning_summary_text.done |
Yes |
OpenAI.ResponseReasoningTextDeltaEvent
Emitted when a delta is added to a reasoning text.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content_index | OpenAI.integer | Yes | ||
| delta | string | The text delta that was added to the reasoning content. | Yes | |
| item_id | string | The ID of the item this reasoning text delta is associated with. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.reasoning_text.delta.Possible values: response.reasoning_text.delta |
Yes |
OpenAI.ResponseReasoningTextDoneEvent
Emitted when a reasoning text is completed.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content_index | OpenAI.integer | Yes | ||
| item_id | string | The ID of the item this reasoning text is associated with. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| text | string | The full text of the completed reasoning content. | Yes | |
| type | enum | The type of the event. Always response.reasoning_text.done.Possible values: response.reasoning_text.done |
Yes |
OpenAI.ResponseRefusalDeltaEvent
Emitted when there is a partial refusal text.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content_index | OpenAI.integer | Yes | ||
| delta | string | The refusal text that is added. | Yes | |
| item_id | string | The ID of the output item that the refusal text is added to. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.refusal.delta.Possible values: response.refusal.delta |
Yes |
OpenAI.ResponseRefusalDoneEvent
Emitted when refusal text is finalized.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content_index | OpenAI.integer | Yes | ||
| item_id | string | The ID of the output item that the refusal text is finalized. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| refusal | string | The refusal text that is finalized. | Yes | |
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.refusal.done.Possible values: response.refusal.done |
Yes |
OpenAI.ResponseStreamOptions
Options for streaming responses. Only set this when you set stream: true.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| include_obfuscation | boolean | When true, stream obfuscation will be enabled. Stream obfuscation adds random characters to an obfuscation field on streaming delta events tonormalize payload sizes as a mitigation to certain side-channel attacks. These obfuscation fields are included by default, but add a small amount of overhead to the data stream. You can set include_obfuscation tofalse to optimize for bandwidth if you trust the network links between your application and the OpenAI API. |
No |
OpenAI.ResponseTextDeltaEvent
Emitted when there is an additional text delta.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content_index | OpenAI.integer | Yes | ||
| delta | string | The text delta that was added. | Yes | |
| item_id | string | The ID of the output item that the text delta was added to. | Yes | |
| logprobs | array of OpenAI.ResponseLogProb | The log probabilities of the tokens in the delta. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.output_text.delta.Possible values: response.output_text.delta |
Yes |
OpenAI.ResponseTextDoneEvent
Emitted when text content is finalized.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content_index | OpenAI.integer | Yes | ||
| item_id | string | The ID of the output item that the text content is finalized. | Yes | |
| logprobs | array of OpenAI.ResponseLogProb | The log probabilities of the tokens in the delta. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| text | string | The text content that is finalized. | Yes | |
| type | enum | The type of the event. Always response.output_text.done.Possible values: response.output_text.done |
Yes |
OpenAI.ResponseTextParam
Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more:
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| format | OpenAI.TextResponseFormatConfiguration | An object specifying the format that the model must output. Configuring { "type": "json_schema" } enables Structured Outputs,which ensures the model will match your supplied JSON schema. Learn more in the The default format is { "type": "text" } with no additional options.*Not recommended for gpt-4o and newer models:** Setting to { "type": "json_object" } enables the older JSON mode, whichensures the message the model generates is valid JSON. Using json_schemais preferred for models that support it. |
No | |
| verbosity | OpenAI.Verbosity | 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. |
No |
OpenAI.ResponseUsage
Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| input_tokens | OpenAI.integer | Yes | ||
| input_tokens_details | OpenAI.ResponseUsageInputTokensDetails | Yes | ||
| └─ cached_tokens | OpenAI.integer | Yes | ||
| output_tokens | OpenAI.integer | Yes | ||
| output_tokens_details | OpenAI.ResponseUsageOutputTokensDetails | Yes | ||
| └─ reasoning_tokens | OpenAI.integer | Yes | ||
| total_tokens | OpenAI.integer | Yes |
OpenAI.ResponseUsageInputTokensDetails
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| cached_tokens | OpenAI.integer | Yes |
OpenAI.ResponseUsageOutputTokensDetails
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| reasoning_tokens | OpenAI.integer | Yes |
OpenAI.ResponseWebSearchCallCompletedEvent
Emitted when a web search call is completed.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item_id | string | Unique ID for the output item associated with the web search call. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.web_search_call.completed.Possible values: response.web_search_call.completed |
Yes |
OpenAI.ResponseWebSearchCallInProgressEvent
Emitted when a web search call is initiated.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item_id | string | Unique ID for the output item associated with the web search call. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.web_search_call.in_progress.Possible values: response.web_search_call.in_progress |
Yes |
OpenAI.ResponseWebSearchCallSearchingEvent
Emitted when a web search call is executing.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item_id | string | Unique ID for the output item associated with the web search call. | Yes | |
| output_index | OpenAI.integer | Yes | ||
| sequence_number | OpenAI.integer | Yes | ||
| type | enum | The type of the event. Always response.web_search_call.searching.Possible values: response.web_search_call.searching |
Yes |
OpenAI.Screenshot
A screenshot action.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | Specifies the event type. For a screenshot action, this property is always set to screenshot.Possible values: screenshot |
Yes |
OpenAI.Scroll
A scroll action.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| scroll_x | OpenAI.integer | Yes | ||
| scroll_y | OpenAI.integer | Yes | ||
| type | enum | Specifies the event type. For a scroll action, this property is always set to scroll.Possible values: scroll |
Yes | |
| x | OpenAI.integer | Yes | ||
| y | OpenAI.integer | Yes |
OpenAI.SearchContextSize
| Property | Value |
|---|---|
| Type | string |
| Values | lowmediumhigh |
OpenAI.ServiceTier
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'.
- If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.
- If set to 'flex' or 'priority', then the request will be processed with the corresponding service tier.
- When not set, the default behavior is 'auto'.
When the
service_tierparameter is set, the response body will include theservice_tiervalue based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.
| Property | Value |
|---|---|
| Type | string |
| Nullable | Yes |
| Values | autodefaultflexscalepriority |
OpenAI.SpecificApplyPatchParam
Forces the model to call the apply_patch tool when executing a tool call.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | The tool to call. Always apply_patch.Possible values: apply_patch |
Yes |
OpenAI.SpecificFunctionShellParam
Forces the model to call the shell tool when a tool call is required.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | The tool to call. Always shell.Possible values: shell |
Yes |
OpenAI.Summary
A summary text from the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| text | string | A summary of the reasoning output from the model so far. | Yes | |
| type | enum | The type of the object. Always summary_text.Possible values: summary_text |
Yes |
OpenAI.SummaryTextContent
A summary text from the model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| text | string | A summary of the reasoning output from the model so far. | Yes | |
| type | enum | The type of the object. Always summary_text.Possible values: summary_text |
Yes |
OpenAI.TextContent
A text content.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| text | string | Yes | ||
| type | enum | Possible values: text |
Yes |
OpenAI.TextResponseFormatConfiguration
An object specifying the format that the model must output.
Configuring { "type": "json_schema" } enables Structured Outputs,
which ensures the model will match your supplied JSON schema. Learn more in the
The default format is { "type": "text" } with no additional options.
Not recommended for gpt-4o and newer models:*
Setting to { "type": "json_object" } enables the older JSON mode, which
ensures the message the model generates is valid JSON. Using json_schema
is preferred for models that support it.
Discriminator for OpenAI.TextResponseFormatConfiguration
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
json_schema |
OpenAI.TextResponseFormatJsonSchema |
text |
OpenAI.TextResponseFormatConfigurationResponseFormatText |
json_object |
OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | OpenAI.TextResponseFormatConfigurationType | Yes |
OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject
JSON object response format. An older method of generating JSON responses.
Using json_schema is recommended for models that support it. Note that the
model will not generate JSON without a system or user message instructing it
to do so.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | The type of response format being defined. Always json_object.Possible values: json_object |
Yes |
OpenAI.TextResponseFormatConfigurationResponseFormatText
Default response format. Used to generate text responses.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | The type of response format being defined. Always text.Possible values: text |
Yes |
OpenAI.TextResponseFormatConfigurationType
| Property | Value |
|---|---|
| Type | string |
| Values | textjson_schemajson_object |
OpenAI.TextResponseFormatJsonSchema
JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | A description of what the response format is for, used by the model to determine how to respond in the format. |
No | |
| name | string | The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. |
Yes | |
| schema | OpenAI.ResponseFormatJsonSchemaSchema | The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas here. |
Yes | |
| strict | boolean (nullable) | No | ||
| type | enum | The type of response format being defined. Always json_schema.Possible values: json_schema |
Yes |
OpenAI.Tool
A tool that can be used to generate a response.
Discriminator for OpenAI.Tool
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
bing_grounding |
BingGroundingTool |
fabric_dataagent_preview |
MicrosoftFabricPreviewTool |
sharepoint_grounding_preview |
SharepointPreviewTool |
azure_ai_search |
AzureAISearchTool |
openapi |
OpenApiTool |
bing_custom_search_preview |
BingCustomSearchPreviewTool |
browser_automation_preview |
BrowserAutomationPreviewTool |
azure_function |
AzureFunctionTool |
capture_structured_outputs |
CaptureStructuredOutputsTool |
a2a_preview |
A2APreviewTool |
memory_search_preview |
MemorySearchPreviewTool |
code_interpreter |
OpenAI.CodeInterpreterTool |
function |
OpenAI.FunctionTool |
file_search |
OpenAI.FileSearchTool |
computer_use_preview |
OpenAI.ComputerUsePreviewTool |
web_search |
OpenAI.WebSearchTool |
mcp |
OpenAI.MCPTool |
image_generation |
OpenAI.ImageGenTool |
local_shell |
OpenAI.LocalShellToolParam |
shell |
OpenAI.FunctionShellToolParam |
custom |
OpenAI.CustomToolParam |
web_search_preview |
OpenAI.WebSearchPreviewTool |
apply_patch |
OpenAI.ApplyPatchToolParam |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | OpenAI.ToolType | Yes |
OpenAI.ToolChoiceAllowed
Constrains the tools available to the model to a pre-defined set.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| mode | enum | Constrains the tools available to the model to a pre-defined set.auto allows the model to pick from among the allowed tools and generate amessage. required requires the model to call one or more of the allowed tools.Possible values: auto, required |
Yes | |
| tools | array of object | 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: json<br> [<br> { "type": "function", "name": "get_weather" },<br> { "type": "mcp", "server_label": "deepwiki" },<br> { "type": "image_generation" }<br> ]<br> |
Yes | |
| type | enum | Allowed tool configuration type. Always allowed_tools.Possible values: allowed_tools |
Yes |
OpenAI.ToolChoiceCodeInterpreter
Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | Possible values: code_interpreter |
Yes |
OpenAI.ToolChoiceComputerUsePreview
Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | Possible values: computer_use_preview |
Yes |
OpenAI.ToolChoiceCustom
Use this option to force the model to call a specific custom tool.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| name | string | The name of the custom tool to call. | Yes | |
| type | enum | For custom tool calling, the type is always custom.Possible values: custom |
Yes |
OpenAI.ToolChoiceFileSearch
Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | Possible values: file_search |
Yes |
OpenAI.ToolChoiceFunction
Use this option to force the model to call a specific function.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| name | string | The name of the function to call. | Yes | |
| type | enum | For function calling, the type is always function.Possible values: function |
Yes |
OpenAI.ToolChoiceImageGeneration
Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | Possible values: image_generation |
Yes |
OpenAI.ToolChoiceMCP
Use this option to force the model to call a specific tool on a remote MCP server.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| name | string (nullable) | No | ||
| server_label | string | The label of the MCP server to use. | Yes | |
| type | enum | For MCP tools, the type is always mcp.Possible values: mcp |
Yes |
OpenAI.ToolChoiceOptions
Controls which (if any) tool is called by the model.
none means the model will not call any tool and instead generates a message.
auto means the model can pick between generating a message or calling one or
more tools.
required means the model must call one or more tools.
| Property | Value |
|---|---|
| Type | string |
| Values | noneautorequired |
OpenAI.ToolChoiceParam
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
the model can call.
Discriminator for OpenAI.ToolChoiceParam
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
allowed_tools |
OpenAI.ToolChoiceAllowed |
function |
OpenAI.ToolChoiceFunction |
mcp |
OpenAI.ToolChoiceMCP |
custom |
OpenAI.ToolChoiceCustom |
apply_patch |
OpenAI.SpecificApplyPatchParam |
shell |
OpenAI.SpecificFunctionShellParam |
file_search |
OpenAI.ToolChoiceFileSearch |
web_search_preview |
OpenAI.ToolChoiceWebSearchPreview |
computer_use_preview |
OpenAI.ToolChoiceComputerUsePreview |
web_search_preview_2025_03_11 |
OpenAI.ToolChoiceWebSearchPreview20250311 |
image_generation |
OpenAI.ToolChoiceImageGeneration |
code_interpreter |
OpenAI.ToolChoiceCodeInterpreter |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | OpenAI.ToolChoiceParamType | Yes |
OpenAI.ToolChoiceParamType
| Property | Value |
|---|---|
| Type | string |
| Values | allowed_toolsfunctionmcpcustomapply_patchshellfile_searchweb_search_previewcomputer_use_previewweb_search_preview_2025_03_11image_generationcode_interpreter |
OpenAI.ToolChoiceWebSearchPreview
Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | Possible values: web_search_preview |
Yes |
OpenAI.ToolChoiceWebSearchPreview20250311
Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | Possible values: web_search_preview_2025_03_11 |
Yes |
OpenAI.ToolType
| Property | Value |
|---|---|
| Type | string |
| Values | functionfile_searchcomputer_use_previewweb_searchmcpcode_interpreterimage_generationlocal_shellshellcustomweb_search_previewapply_patcha2a_previewbing_custom_search_previewbrowser_automation_previewfabric_dataagent_previewsharepoint_grounding_previewmemory_search_previewazure_ai_searchazure_functionbing_groundingcapture_structured_outputsopenapi |
OpenAI.ToolsArray
An array of tools the model may call while generating a response. You
can specify which tool to use by setting the tool_choice parameter.
We support the following categories of tools:
- Built-in tools: Tools that are provided by OpenAI that extend the model's capabilities, like web search or file search. Learn more about built-in tools.
- MCP Tools: Integrations with third-party systems via custom MCP servers or predefined connectors such as Google Drive and SharePoint. Learn more about MCP Tools.
- Function calls (custom tools): Functions that are defined by you, enabling the model to call your own code with strongly typed arguments and outputs. Learn more about function calling. You can also use custom tools to call your own code.
Array of: OpenAI.Tool
OpenAI.TopLogProb
The top log probability of a token.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| bytes | array of OpenAI.integer | Yes | ||
| logprob | OpenAI.numeric | Yes | ||
| token | string | Yes |
OpenAI.Type
An action to type in text.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| text | string | The text to type. | Yes | |
| type | enum | Specifies the event type. For a type action, this property is always set to type.Possible values: type |
Yes |
OpenAI.UpdateConversationBody
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| metadata | OpenAI.Metadata (nullable) | 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. |
Yes |
OpenAI.UrlCitationBody
A citation for a web resource used to generate a model response.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| end_index | OpenAI.integer | Yes | ||
| start_index | OpenAI.integer | Yes | ||
| title | string | The title of the web resource. | Yes | |
| type | enum | The type of the URL citation. Always url_citation.Possible values: url_citation |
Yes | |
| url | string | The URL of the web resource. | Yes |
OpenAI.VectorStoreFileAttributes
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, booleans, or numbers.
Type: object
OpenAI.Verbosity
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.
| Property | Value |
|---|---|
| Type | string |
| Nullable | Yes |
| Values | lowmediumhigh |
OpenAI.Wait
A wait action.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | Specifies the event type. For a wait action, this property is always set to wait.Possible values: wait |
Yes |
OpenAI.WebSearchActionFind
Action type "find": Searches for a pattern within a loaded page.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| pattern | string | The pattern or text to search for within the page. | Yes | |
| type | enum | The action type. Possible values: find_in_page |
Yes | |
| url | string | The URL of the page searched for the pattern. | Yes |
OpenAI.WebSearchActionOpenPage
Action type "open_page" - Opens a specific URL from search results.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | The action type. Possible values: open_page |
Yes | |
| url | string | The URL opened by the model. | Yes |
OpenAI.WebSearchActionSearch
Action type "search" - Performs a web search query.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| queries | array of string | The search queries. | No | |
| query | string (deprecated) | [DEPRECATED] The search query. | Yes | |
| sources | array of OpenAI.WebSearchActionSearchSources | The sources used in the search. | No | |
| type | enum | The action type. Possible values: search |
Yes |
OpenAI.WebSearchActionSearchSources
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | Possible values: url |
Yes | |
| url | string | Yes |
OpenAI.WebSearchApproximateLocation
The approximate location of the user.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| city | string (nullable) | No | ||
| country | string (nullable) | No | ||
| region | string (nullable) | No | ||
| timezone | string (nullable) | No | ||
| type | enum | The type of location approximation. Always approximate.Possible values: approximate |
No |
OpenAI.WebSearchPreviewTool
This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| search_context_size | OpenAI.SearchContextSize | No | ||
| type | enum | The type of the web search tool. One of web_search_preview or web_search_preview_2025_03_11.Possible values: web_search_preview |
Yes | |
| user_location | OpenAI.ApproximateLocation (nullable) | No | ||
| └─ city | string (nullable) | No | ||
| └─ country | string (nullable) | No | ||
| └─ region | string (nullable) | No | ||
| └─ timezone | string (nullable) | No | ||
| └─ type | enum | The type of location approximation. Always approximate.Possible values: approximate |
Yes |
OpenAI.WebSearchTool
Search the Internet for sources related to the prompt. Learn more about the web search tool.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| custom_search_configuration | WebSearchConfiguration | A web search configuration for bing custom search | No | |
| └─ instance_name | string | Name of the custom configuration instance given to config. | Yes | |
| └─ project_connection_id | string | Project connection id for grounding with bing custom search | Yes | |
| filters | OpenAI.WebSearchToolFilters (nullable) | No | ||
| └─ allowed_domains | array of string (nullable) | No | ||
| search_context_size | enum | 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.Possible values: low, medium, high |
No | |
| type | enum | The type of the web search tool. One of web_search or web_search_2025_08_26.Possible values: web_search |
Yes | |
| user_location | OpenAI.WebSearchApproximateLocation (nullable) | The approximate location of the user. | No | |
| └─ city | string (nullable) | No | ||
| └─ country | string (nullable) | No | ||
| └─ region | string (nullable) | No | ||
| └─ timezone | string (nullable) | No | ||
| └─ type | enum | The type of location approximation. Always approximate.Possible values: approximate |
No |
OpenAI.WebSearchToolFilters
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| allowed_domains | array of string | No |
OpenAI.integer
Type: integer
Format: int64
OpenAI.numeric
Type: number
Format: double
OpenApiAnonymousAuthDetails
Security details for OpenApi anonymous authentication
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | The object type, which is always 'anonymous'. Possible values: anonymous |
Yes |
OpenApiAuthDetails
authentication details for OpenApiFunctionDefinition
Discriminator for OpenApiAuthDetails
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
anonymous |
OpenApiAnonymousAuthDetails |
project_connection |
OpenApiProjectConnectionAuthDetails |
managed_identity |
OpenApiManagedAuthDetails |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | OpenApiAuthType | Authentication type for OpenApi endpoint. Allowed types are: - Anonymous (no authentication required) - Project Connection (requires project_connection_id to endpoint, as setup in AI Foundry) - Managed_Identity (requires audience for identity based auth) |
Yes |
OpenApiAuthType
Authentication type for OpenApi endpoint. Allowed types are:
- Anonymous (no authentication required)
- Project Connection (requires project_connection_id to endpoint, as setup in AI Foundry)
- Managed_Identity (requires audience for identity based auth)
| Property | Value |
|---|---|
| Description | Authentication type for OpenApi endpoint. Allowed types are: - Anonymous (no authentication required) - Project Connection (requires project_connection_id to endpoint, as setup in AI Foundry) - Managed_Identity (requires audience for identity based auth) |
| Type | string |
| Values | anonymousproject_connectionmanaged_identity |
OpenApiFunctionDefinition
The input definition information for an openapi function.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| auth | OpenApiAuthDetails | authentication details for OpenApiFunctionDefinition | Yes | |
| └─ type | OpenApiAuthType | The type of authentication, must be anonymous/project_connection/managed_identity | Yes | |
| default_params | array of string | List of OpenAPI spec parameters that will use user-provided defaults | No | |
| description | string | A description of what the function does, used by the model to choose when and how to call the function. | No | |
| functions | array of object | List of function definitions used by OpenApi tool | No | |
| name | string | The name of the function to be called. | Yes | |
| spec | object | The openapi function shape, described as a JSON Schema object. | Yes |
OpenApiManagedAuthDetails
Security details for OpenApi managed_identity authentication
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| security_scheme | OpenApiManagedSecurityScheme | Security scheme for OpenApi managed_identity authentication | Yes | |
| └─ audience | string | Authentication scope for managed_identity auth type | Yes | |
| type | enum | The object type, which is always 'managed_identity'. Possible values: managed_identity |
Yes |
OpenApiManagedSecurityScheme
Security scheme for OpenApi managed_identity authentication
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| audience | string | Authentication scope for managed_identity auth type | Yes |
OpenApiProjectConnectionAuthDetails
Security details for OpenApi project connection authentication
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| security_scheme | OpenApiProjectConnectionSecurityScheme | Security scheme for OpenApi managed_identity authentication | Yes | |
| └─ project_connection_id | string | Project connection id for Project Connection auth type | Yes | |
| type | enum | The object type, which is always 'project_connection'. Possible values: project_connection |
Yes |
OpenApiProjectConnectionSecurityScheme
Security scheme for OpenApi managed_identity authentication
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| project_connection_id | string | Project connection id for Project Connection auth type | Yes |
OpenApiTool
The input definition information for an OpenAPI tool as used to configure an agent.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| openapi | OpenApiFunctionDefinition | The input definition information for an openapi function. | Yes | |
| └─ auth | OpenApiAuthDetails | Open API authentication details | Yes | |
| └─ default_params | array of string | List of OpenAPI spec parameters that will use user-provided defaults | No | |
| └─ description | string | A description of what the function does, used by the model to choose when and how to call the function. | No | |
| └─ functions | array of object (read-only) | List of function definitions used by OpenApi tool | No | |
| └─ description | string | A description of what the function does, used by the model to choose when and how to call the function. | No | |
| └─ name | string | The name of the function to be called. | Yes | |
| └─ parameters | object | The parameters the functions accepts, described as a JSON Schema object. | Yes | |
| └─ name | string | The name of the function to be called. | Yes | |
| └─ spec | object | The openapi function shape, described as a JSON Schema object. | Yes | |
| type | enum | The object type, which is always 'openapi'. Possible values: openapi |
Yes |
PageOrder
| Property | Value |
|---|---|
| Type | string |
| Values | ascdesc |
PagedConnection
Paged collection of Connection items
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| nextLink | string | The link to the next page of items | No | |
| value | array of Connection | The Connection items on this page | Yes |
PagedDatasetVersion
Paged collection of DatasetVersion items
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| nextLink | string | The link to the next page of items | No | |
| value | array of DatasetVersion | The DatasetVersion items on this page | Yes |
PagedDeployment
Paged collection of Deployment items
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| nextLink | string | The link to the next page of items | No | |
| value | array of Deployment | The Deployment items on this page | Yes |
PagedEvaluationRule
Paged collection of EvaluationRule items
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| nextLink | string | The link to the next page of items | No | |
| value | array of EvaluationRule | The EvaluationRule items on this page | Yes |
PagedEvaluationTaxonomy
Paged collection of EvaluationTaxonomy items
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| nextLink | string | The link to the next page of items | No | |
| value | array of EvaluationTaxonomy | The EvaluationTaxonomy items on this page | Yes |
PagedEvaluatorVersion
Paged collection of EvaluatorVersion items
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| nextLink | string | The link to the next page of items | No | |
| value | array of EvaluatorVersion | The EvaluatorVersion items on this page | Yes |
PagedIndex
Paged collection of Index items
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| nextLink | string | The link to the next page of items | No | |
| value | array of Index | The Index items on this page | Yes |
PagedInsight
Paged collection of Insight items
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| nextLink | string | The link to the next page of items | No | |
| value | array of Insight | The Insight items on this page | Yes |
PagedRedTeam
Paged collection of RedTeam items
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| nextLink | string | The link to the next page of items | No | |
| value | array of RedTeam | The RedTeam items on this page | Yes |
PagedSchedule
Paged collection of Schedule items
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| nextLink | string | The link to the next page of items | No | |
| value | array of Schedule | The Schedule items on this page | Yes |
PagedScheduleRun
Paged collection of ScheduleRun items
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| nextLink | string | The link to the next page of items | No | |
| value | array of ScheduleRun | The ScheduleRun items on this page | Yes |
PendingUploadRequest
Represents a request for a pending upload.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| connectionName | string | Azure Storage Account connection name to use for generating temporary SAS token | No | |
| pendingUploadId | string | If PendingUploadId is not provided, a random GUID will be used. | No | |
| pendingUploadType | enum | BlobReference is the only supported type. Possible values: BlobReference |
Yes |
PendingUploadResponse
Represents the response for a pending upload request
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| blobReference | BlobReference | Blob reference details. | Yes | |
| └─ blobUri | string | Blob URI path for client to upload data. Example: https://blob.windows.core.net/Container/Path |
Yes | |
| └─ credential | SasCredential | Credential info to access the storage account. | Yes | |
| └─ storageAccountArmId | string | ARM ID of the storage account to use. | Yes | |
| pendingUploadId | string | ID for this upload request. | Yes | |
| pendingUploadType | enum | BlobReference is the only supported type Possible values: BlobReference |
Yes | |
| version | string | Version of asset to be created if user did not specify version when initially creating upload | No |
PromptAgentDefinition
The prompt agent definition
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| instructions | string (nullable) | A system (or developer) message inserted into the model's context. | No | |
| kind | enum | Possible values: prompt |
Yes | |
| model | string | The model deployment to use for this agent. | Yes | |
| rai_config | RaiConfig | Configuration for Responsible AI (RAI) content filtering and safety features. | No | |
| └─ rai_policy_name | string | The name of the RAI policy to apply. | Yes | |
| reasoning | OpenAI.Reasoning (nullable) | gpt-5 and o-series models only Configuration options for reasoning models. |
No | |
| └─ effort | OpenAI.ReasoningEffort | Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducingreasoning effort can result in faster responses and fewer tokens used on reasoning in a response. - 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.- 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. |
No | |
| └─ generate_summary | enum | Possible values: auto, concise, detailed |
No | |
| └─ summary | enum | Possible values: auto, concise, detailed |
No | |
| structured_inputs | object | Set of structured inputs that can participate in prompt template substitution or tool argument bindings. | No | |
| temperature | number | 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. We generally recommend altering this or top_p but not both. |
No | 1 |
| text | PromptAgentDefinitionTextOptions | Configuration options for a text response from the model. Can be plain text or structured JSON data. | No | |
| └─ format | OpenAI.TextResponseFormatConfiguration | An object specifying the format that the model must output. Configuring { "type": "json_schema" } enables Structured Outputs,which ensures the model will match your supplied JSON schema. Learn more in the The default format is { "type": "text" } with no additional options.*Not recommended for gpt-4o and newer models:** Setting to { "type": "json_object" } enables the older JSON mode, whichensures the message the model generates is valid JSON. Using json_schemais preferred for models that support it. |
No | |
| tool_choice | string or OpenAI.ToolChoiceParam | 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 the model can call. |
No | |
| tools | array of OpenAI.Tool | An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter. |
No | |
| top_p | number | An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both. |
No | 1 |
PromptAgentDefinitionTextOptions
Configuration options for a text response from the model. Can be plain text or structured JSON data.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| format | OpenAI.TextResponseFormatConfiguration | An object specifying the format that the model must output. Configuring { "type": "json_schema" } enables Structured Outputs,which ensures the model will match your supplied JSON schema. Learn more in the The default format is { "type": "text" } with no additional options.*Not recommended for gpt-4o and newer models:** Setting to { "type": "json_object" } enables the older JSON mode, whichensures the message the model generates is valid JSON. Using json_schemais preferred for models that support it. |
No |
PromptBasedEvaluatorDefinition
Prompt-based evaluator
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data_schema | object | The JSON schema (Draft 2020-12) for the evaluator's input data. This includes parameters like type, properties, required. | No | |
| init_parameters | object | The JSON schema (Draft 2020-12) for the evaluator's input parameters. This includes parameters like type, properties, required. | No | |
| metrics | object | List of output metrics produced by this evaluator | No | |
| prompt_text | string | The prompt text used for evaluation | Yes | |
| type | enum | Possible values: prompt |
Yes |
ProtocolVersionRecord
A record mapping for a single protocol and its version.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| protocol | AgentProtocol | Yes | ||
| version | string | The version string for the protocol, e.g. 'v0.1.1'. | Yes |
RaiConfig
Configuration for Responsible AI (RAI) content filtering and safety features.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| rai_policy_name | string | The name of the RAI policy to apply. | Yes |
RecurrenceSchedule
Recurrence schedule model.
Discriminator for RecurrenceSchedule
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
Hourly |
HourlyRecurrenceSchedule |
Daily |
DailyRecurrenceSchedule |
Weekly |
WeeklyRecurrenceSchedule |
Monthly |
MonthlyRecurrenceSchedule |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | RecurrenceType | Recurrence type. | Yes |
RecurrenceTrigger
Recurrence based trigger.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| endTime | string | End time for the recurrence schedule in ISO 8601 format. | No | |
| interval | integer | Interval for the recurrence schedule. | Yes | |
| schedule | RecurrenceSchedule | Recurrence schedule model. | Yes | |
| └─ type | RecurrenceType | Recurrence type for the recurrence schedule. | Yes | |
| startTime | string | Start time for the recurrence schedule in ISO 8601 format. | No | |
| timeZone | string | Time zone for the recurrence schedule. | No | UTC |
| type | enum | Type of the trigger. Possible values: Recurrence |
Yes |
RecurrenceType
Recurrence type.
| Property | Value |
|---|---|
| Description | Recurrence type. |
| Type | string |
| Values | HourlyDailyWeeklyMonthly |
RedTeam
Red team details.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| applicationScenario | string | Application scenario for the red team operation, to generate scenario specific attacks. | No | |
| attackStrategies | array of AttackStrategy | List of attack strategies or nested lists of attack strategies. | No | |
| displayName | string | Name of the red-team run. | No | |
| id | string (read-only) | Identifier of the red team run. | Yes | |
| numTurns | integer | Number of simulation rounds. | No | |
| properties | object | Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. | No | |
| riskCategories | array of RiskCategory | List of risk categories to generate attack objectives for. | No | |
| simulationOnly | boolean | Simulation-only or Simulation + Evaluation. Default false, if true the scan outputs conversation not evaluation result. | No | False |
| status | string (read-only) | Status of the red-team. It is set by service and is read-only. | No | |
| tags | object | Red team's tags. Unlike properties, tags are fully mutable. | No | |
| target | TargetConfig | Abstract class for target configuration. | Yes | |
| └─ type | string | Type of the model configuration. | Yes |
RedTeamEvalRunDataSource
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item_generation_params | ItemGenerationParams | Represents the set of parameters used to control item generation operations. | Yes | |
| └─ type | ItemGenerationParamsType | The type of item generation parameters to use. | Yes | |
| target | Target | Base class for targets with discriminator support. | Yes | |
| └─ type | string | The type of target. | Yes | |
| type | enum | The type of data source. Always azure_ai_red_team.Possible values: azure_ai_red_team |
Yes |
RedTeamItemGenerationParams
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| attack_strategies | array of AttackStrategy | The collection of attack strategies to be used. | Yes | |
| num_turns | integer | The number of turns allowed in the game. | Yes | 20 |
| type | enum | The type of item generation parameters. Possible values: red_team |
Yes |
RedTeamSeedPromptsItemGenerationParams
Represents the parameters for red team seed prompts item generation.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| attack_strategies | array of AttackStrategy | The collection of attack strategies to be used. | Yes | |
| num_turns | integer | The number of turns allowed in the game. | Yes | 20 |
| source | OpenAI.EvalJsonlFileContentSource | Yes | ||
| └─ content | array of OpenAI.EvalJsonlFileContentSourceContent | The content of the jsonl file. | Yes | |
| └─ type | enum | The type of jsonl source. Always file_content.Possible values: file_content |
Yes | |
| type | enum | The type of item generation parameters, always red_team_seed_prompts.Possible values: red_team_seed_prompts |
Yes |
RedTeamTaxonomyItemGenerationParams
Represents the parameters for red team taxonomy item generation.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| attack_strategies | array of AttackStrategy | The collection of attack strategies to be used. | Yes | |
| num_turns | integer | The number of turns allowed in the game. | Yes | 20 |
| source | OpenAI.EvalJsonlFileContentSource | Yes | ||
| └─ content | array of OpenAI.EvalJsonlFileContentSourceContent | The content of the jsonl file. | Yes | |
| └─ type | enum | The type of jsonl source. Always file_content.Possible values: file_content |
Yes | |
| type | enum | The type of item generation parameters, always red_team_taxonomy.Possible values: red_team_taxonomy |
Yes |
ResponseRetrievalItemGenerationParams
Represents the parameters for response retrieval item generation.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data_mapping | object | Mapping from source fields to response_id field, required for retrieving chat history. | Yes | |
| max_num_turns | integer | The maximum number of turns of chat history to evaluate. | Yes | |
| source | OpenAI.EvalJsonlFileContentSource or OpenAI.EvalJsonlFileIdSource | The source from which JSONL content is read. | Yes | |
| type | enum | The type of item generation parameters, always response_retrieval.Possible values: response_retrieval |
Yes |
RiskCategory
Risk category for the attack objective.
| Property | Value |
|---|---|
| Description | Risk category for the attack objective. |
| Type | string |
| Values | HateUnfairnessViolenceSexualSelfHarmProtectedMaterialCodeVulnerabilityUngroundedAttributesProhibitedActionsSensitiveDataLeakageTaskAdherence |
SASCredentials
Shared Access Signature (SAS) credential definition
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| SAS | string (read-only) | SAS token | No | |
| type | enum | The credential type Possible values: SAS |
Yes |
SampleType
The type of sample used in the analysis.
| Property | Value |
|---|---|
| Description | The type of sample used in the analysis. |
| Type | string |
| Values | EvaluationResultSample |
SasCredential
SAS Credential definition
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| sasUri | string (read-only) | SAS uri | Yes | |
| type | enum | Type of credential Possible values: SAS |
Yes |
Schedule
Schedule model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | Description of the schedule. | No | |
| displayName | string | Name of the schedule. | No | |
| enabled | boolean | Enabled status of the schedule. | Yes | |
| id | string (read-only) | Identifier of the schedule. | Yes | |
| properties | object | Schedule's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. | No | |
| provisioningStatus | ScheduleProvisioningStatus (read-only) | Schedule provisioning status. | No | |
| systemData | object (read-only) | System metadata for the resource. | Yes | |
| tags | object | Schedule's tags. Unlike properties, tags are fully mutable. | No | |
| task | ScheduleTask | Schedule task model. | Yes | |
| └─ configuration | object | Configuration for the task. | No | |
| └─ type | ScheduleTaskType | Type of the task. | Yes | |
| trigger | Trigger | Base model for Trigger of the schedule. | Yes | |
| └─ type | TriggerType | Type of the trigger. | Yes |
ScheduleProvisioningStatus
Schedule provisioning status.
| Property | Value |
|---|---|
| Description | Schedule provisioning status. |
| Type | string |
| Values | CreatingUpdatingDeletingSucceededFailed |
ScheduleRun
Schedule run model.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| error | string (read-only) | Error information for the schedule run. | No | |
| id | string (read-only) | Identifier of the schedule run. | Yes | |
| properties | object (read-only) | Properties of the schedule run. | Yes | |
| scheduleId | string | Identifier of the schedule. | Yes | |
| success | boolean (read-only) | Trigger success status of the schedule run. | Yes | |
| triggerTime | string | Trigger time of the schedule run. | No |
ScheduleTask
Schedule task model.
Discriminator for ScheduleTask
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
Evaluation |
EvaluationScheduleTask |
Insight |
InsightScheduleTask |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| configuration | object | Configuration for the task. | No | |
| type | ScheduleTaskType | Type of the task. | Yes |
ScheduleTaskType
Type of the task.
| Property | Value |
|---|---|
| Description | Type of the task. |
| Type | string |
| Values | EvaluationInsight |
SharepointGroundingToolParameters
The sharepoint grounding tool parameters.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| project_connections | array of ToolProjectConnection | The project connections attached to this tool. There can be a maximum of 1 connection resource attached to the tool. |
No |
SharepointPreviewTool
The input definition information for a sharepoint tool as used to configure an agent.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| sharepoint_grounding_preview | SharepointGroundingToolParameters | The sharepoint grounding tool parameters. | Yes | |
| └─ project_connections | array of ToolProjectConnection | The project connections attached to this tool. There can be a maximum of 1 connection resource attached to the tool. Constraints: maxItems: 1 |
No | |
| type | enum | The object type, which is always 'sharepoint_grounding_preview'. Possible values: sharepoint_grounding_preview |
Yes |
Sku
Sku information
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| capacity | integer | Sku capacity | Yes | |
| family | string | Sku family | Yes | |
| name | string | Sku name | Yes | |
| size | string | Sku size | Yes | |
| tier | string | Sku tier | Yes |
StructuredInputDefinition
An structured input that can participate in prompt template substitutions and tool argument binding.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| default_value | The default value for the input if no run-time value is provided. | No | ||
| description | string | A human-readable description of the input. | No | |
| required | boolean | Whether the input property is required when the agent is invoked. | No | False |
| schema | object | The JSON schema for the structured input (optional). | No |
StructuredOutputDefinition
A structured output that can be produced by the agent.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | A description of the output to emit. Used by the model to determine when to emit the output. | Yes | |
| name | string | The name of the structured output. | Yes | |
| schema | object | The JSON schema for the structured output. | Yes | |
| strict | boolean (nullable) | Whether to enforce strict validation. Default true. |
Yes |
StructuredOutputsOutputItem
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| agent_reference | AgentReference | No | ||
| └─ name | string | The name of the agent. Constraints: maxLength: 256 |
Yes | |
| └─ type | enum | Possible values: agent_reference |
Yes | |
| └─ version | string | The version identifier of the agent. | No | |
| output | The structured output captured during the response. | Yes | ||
| response_id | string | The response on which the item is created. | No | |
| type | enum | Possible values: structured_outputs |
Yes |
SyntheticDataGenerationPreviewEvalRunDataSource
Represents a data source for evaluation runs that evaluates based on generated synthetic data for testing purposes.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| input_messages | OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate | No | ||
| └─ template | array of object or OpenAI.EvalItem | Yes | ||
| └─ type | enum | Possible values: template |
Yes | |
| item_generation_params | SyntheticDataGenerationPreviewItemGenerationParams | Yes | ||
| └─ model_deployment_name | string | The name of the model deployment to use for generating synthetic data. | Yes | |
| └─ output_dataset_id | string (read-only) | The identifier of the output dataset where generated synthetic data is stored. The generated data is a jsonl file with columns id, query and test_description. | No | |
| └─ output_dataset_name | string | The name of the output dataset where generated synthetic data will be stored. If not provided, service generates dataset name automatically. | No | |
| └─ prompt | string | The prompt used for generating synthetic data. This is option if target is of type 'azure_ai_agent' with instructions configured in agent. | No | |
| └─ samples_count | integer | The maximum number of data samples to generate. | Yes | |
| └─ sources | array of OpenAI.EvalJsonlFileIdSource | The optional seed data content source files for data generation. | Yes | |
| └─ type | enum | The type of item generation parameters. Possible values: synthetic_data_gen_preview |
Yes | |
| target | Target | Base class for targets with discriminator support. | Yes | |
| └─ type | string | The type of target. | Yes | |
| type | enum | The type of data source, always azure_ai_synthetic_data_gen_preview.Possible values: azure_ai_synthetic_data_gen_preview |
Yes |
SyntheticDataGenerationPreviewItemGenerationParams
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| model_deployment_name | string | The name of the model deployment to use for generating synthetic data. | Yes | |
| output_dataset_id | string (read-only) | The identifier of the output dataset where generated synthetic data is stored. The generated data is a jsonl file with columns id, query and test_description. | No | |
| output_dataset_name | string | The name of the output dataset where generated synthetic data will be stored. If not provided, service generates dataset name automatically. | No | |
| prompt | string | The prompt used for generating synthetic data. This is option if target is of type 'azure_ai_agent' with instructions configured in agent. | No | |
| samples_count | integer | The maximum number of data samples to generate. | Yes | |
| sources | array of OpenAI.EvalJsonlFileIdSource | The optional seed data content source files for data generation. | Yes | |
| type | enum | The type of item generation parameters. Possible values: synthetic_data_gen_preview |
Yes |
Target
Base class for targets with discriminator support.
Discriminator for Target
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
azure_ai_model |
AzureAIModelTarget |
azure_ai_agent |
AzureAIAgentTarget |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | string | The type of target. | Yes |
TargetCompletionEvalRunDataSource
Represents a data source for target-based completion evaluation configuration.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| input_messages | OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference | No | ||
| └─ item_reference | string | Yes | ||
| └─ type | enum | Possible values: item_reference |
Yes | |
| source | OpenAI.EvalJsonlFileContentSource or OpenAI.EvalJsonlFileIdSource | The source configuration for inline or file data. | Yes | |
| target | Target | Base class for targets with discriminator support. | Yes | |
| └─ type | string | The type of target. | Yes | |
| type | enum | The type of data source, always azure_ai_target_completions.Possible values: azure_ai_target_completions |
Yes |
TargetConfig
Abstract class for target configuration.
Discriminator for TargetConfig
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
AzureOpenAIModel |
AzureOpenAIModelConfiguration |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | string | Type of the model configuration. | Yes |
TargetUpdate
Base class for targets with discriminator support.
Discriminator for TargetUpdate
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
azure_ai_model |
AzureAIModelTargetUpdate |
azure_ai_agent |
AzureAIAgentTargetUpdate |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | string | The type of target. | Yes |
TaxonomyCategory
Taxonomy category definition.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | Description of the taxonomy category. | No | |
| id | string | Unique identifier of the taxonomy category. | Yes | |
| name | string | Name of the taxonomy category. | Yes | |
| properties | object | Additional properties for the taxonomy category. | No | |
| riskCategory | RiskCategory | Risk category for the attack objective. | Yes | |
| subCategories | array of TaxonomySubCategory | List of taxonomy sub categories. | Yes |
TaxonomySubCategory
Taxonomy sub-category definition.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | Description of the taxonomy sub-category. | No | |
| enabled | boolean | List of taxonomy items under this sub-category. | Yes | |
| id | string | Unique identifier of the taxonomy sub-category. | Yes | |
| name | string | Name of the taxonomy sub-category. | Yes | |
| properties | object | Additional properties for the taxonomy sub-category. | No |
ToolDescription
Description of a tool that can be used by an agent.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | A brief description of the tool's purpose. | No | |
| name | string | The name of the tool. | No |
ToolProjectConnection
A project connection resource.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| project_connection_id | string | A project connection in a ToolProjectConnectionList attached to this tool. | Yes |
TracesPreviewEvalRunDataSource
Represents a data source for evaluation runs that operate over Agent traces stored in Application Insights.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| agent_id | string | The agent ID used to filter traces for evaluation. | No | |
| agent_name | string | The agent name used to filter traces for evaluation. | No | |
| end_time | integer | Unix timestamp (in seconds) marking the end of the trace query window. Defaults to the current time. | No | |
| ingestion_delay_seconds | integer | The delay to apply for ingestion when querying traces. | No | 300 |
| lookback_hours | integer | Lookback window (in hours) applied when retrieving traces from Application Insights. For scheduled evaluations this is inferred from the recurrence interval. |
No | 168 |
| max_traces | integer | Sampling limit applied to traces retrieved for evaluation. | No | 1000 |
| trace_ids | array of string | Collection of Agent trace identifiers that should be evaluated. | No | |
| type | enum | The type of data source, always azure_ai_traces_preview.Possible values: azure_ai_traces_preview |
Yes |
TreatmentEffectType
Treatment Effect Type.
| Property | Value |
|---|---|
| Description | Treatment Effect Type. |
| Type | string |
| Values | TooFewSamplesInconclusiveChangedImprovedDegraded |
Trigger
Base model for Trigger of the schedule.
Discriminator for Trigger
This component uses the property type to discriminate between different types:
| Type Value | Schema |
|---|---|
Cron |
CronTrigger |
Recurrence |
RecurrenceTrigger |
OneTime |
OneTimeTrigger |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | TriggerType | Type of the trigger. | Yes |
TriggerType
Type of the trigger.
| Property | Value |
|---|---|
| Description | Type of the trigger. |
| Type | string |
| Values | CronRecurrenceOneTime |
UpdateAgentFromManifestRequest
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | A human-readable description of the agent. Constraints: maxLength: 512 |
No | |
| manifest_id | string | The manifest ID to import the agent version from. | Yes | |
| metadata | object | 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. |
No | |
| parameter_values | object | The inputs to the manifest that will result in a fully materialized Agent. | Yes |
UpdateAgentRequest
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| definition | AgentDefinition | Yes | ||
| └─ kind | AgentKind | Yes | ||
| └─ rai_config | RaiConfig | Configuration for Responsible AI (RAI) content filtering and safety features. | No | |
| description | string | A human-readable description of the agent. Constraints: maxLength: 512 |
No | |
| metadata | object | 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. |
No |
UpdateEvalParametersBody
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| metadata | OpenAI.Metadata (nullable) | 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. |
No | |
| name | string | No | ||
| properties | object | Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. |
No |
UserProfileMemoryItem
A memory item specifically containing user profile information extracted from conversations, such as preferences, interests, and personal details.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | string | The content of the memory. | Yes | |
| kind | enum | The kind of the memory item. Possible values: user_profile |
Yes | |
| memory_id | string | The unique ID of the memory item. | Yes | |
| scope | string | The namespace that logically groups and isolates memories, such as a user ID. | Yes | |
| updated_at | integer | The last update time of the memory item. | Yes |
WebSearchConfiguration
A web search configuration for bing custom search
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| instance_name | string | Name of the custom configuration instance given to config. | Yes | |
| project_connection_id | string | Project connection id for grounding with bing custom search | Yes |
WeeklyRecurrenceSchedule
Weekly recurrence schedule.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| daysOfWeek | array of DayOfWeek | Days of the week for the recurrence schedule. | Yes | |
| type | enum | Weekly recurrence type. Possible values: Weekly |
Yes |
WorkflowActionOutputItem
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| action_id | string | Unique identifier for the action. | Yes | |
| agent_reference | AgentReference | No | ||
| └─ name | string | The name of the agent. Constraints: maxLength: 256 |
Yes | |
| └─ type | enum | Possible values: agent_reference |
Yes | |
| └─ version | string | The version identifier of the agent. | No | |
| kind | string | The kind of CSDL action (e.g., 'SetVariable', 'InvokeAzureAgent'). | Yes | |
| parent_action_id | string | ID of the parent action if this is a nested action. | No | |
| previous_action_id | string | ID of the previous action if this action follows another. | No | |
| response_id | string | The response on which the item is created. | No | |
| status | enum | Status of the action (e.g., 'in_progress', 'completed', 'failed', 'cancelled'). Possible values: completed, failed, in_progress, cancelled |
Yes | |
| type | enum | Possible values: workflow_action |
Yes |
WorkflowAgentDefinition
The workflow agent definition.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| kind | enum | Possible values: workflow |
Yes | |
| rai_config | RaiConfig | Configuration for Responsible AI (RAI) content filtering and safety features. | No | |
| └─ rai_policy_name | string | The name of the RAI policy to apply. | Yes | |
| workflow | string | The CSDL YAML definition of the workflow. | No |
integer
Type: integer
Format: int64