你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft Foundry

API 版本： v1

Authentication

流：隐式

授权 URL：https://login.microsoftonline.com/common/oauth2/v2.0/authorize

范围：

https://ai.azure.com/.default

Agents

代理 - 创建代理

POST {endpoint}/agents?api-version=v1

创建代理。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Foundry-Features	假	字符串可能的值：`ContainerAgents=V1Preview`、、 `HostedAgents=V1PreviewWorkflowAgents=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选
定义	AgentDefinition		是的
~~ kind	AgentKind		是的
rai_config	RaiConfig	负责任 AI （RAI）内容筛选和安全功能的配置。	否
说明	字符串	代理的可读说明。约束： maxLength：512	否
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
姓名	字符串	标识代理的唯一名称。 Name 可用于检索/更新/删除代理。 - 必须以字母数字字符开头和结尾， - 可以在中间包含连字符 - 不能超过 63 个字符。约束： maxLength：63	是的

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	AgentObject

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

代理 - 列出代理

GET {endpoint}/agents?api-version=v1

返回所有代理的列表。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
kind	查询	否	字符串可能的值：`prompt`、`hosted`、`container_app`、`workflow`	按种类过滤剂。如果未提供，则返回所有代理。
limit	查询	否	整数	要返回的对象数的限制。限制可以介于 1 和 100 之间，以及默认值为 20。
顺序	查询	否	字符串可能的值： `ascdesc`	按 `created_at` 对象的时间戳排序顺序。升序为 `asc`，降序为 `desc` 。
after	查询	否	字符串	用于分页的游标。 `after` 是一个对象 ID，用于定义你在列表中的位置。例如，如果发出列表请求并接收 100 个对象，以 obj_foo 结尾，则后续调用可以包括 after=obj_foo，以便提取列表的下一页。
before	查询	否	字符串	用于分页的游标。 `before` 是一个对象 ID，用于定义你在列表中的位置。例如，如果发出列表请求并接收 100 个对象，以 obj_foo 结尾，则后续调用可以包括 before=obj_foo，以便提取列表中的上一页内容。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	对象	请求的项列表的响应数据。

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

代理 - 获取代理

GET {endpoint}/agents/{agent_name}?api-version=v1

检索代理。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
agent_name	路径	是的	字符串	要检索的代理的名称。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	AgentObject

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

代理 - 更新代理

POST {endpoint}/agents/{agent_name}?api-version=v1

如果代理定义有任何更改，则通过添加新版本来更新代理。如果没有更改，则返回现有代理版本。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
agent_name	路径	是的	字符串	要检索的代理的名称。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Foundry-Features	假	字符串可能的值：`ContainerAgents=V1Preview`、、 `HostedAgents=V1PreviewWorkflowAgents=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选
定义	AgentDefinition		是的
~~ kind	AgentKind		是的
rai_config	RaiConfig	负责任 AI （RAI）内容筛选和安全功能的配置。	否
说明	字符串	代理的可读说明。约束： maxLength：512	否
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	AgentObject

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

代理 - 删除代理

DELETE {endpoint}/agents/{agent_name}?api-version=v1

删除代理。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
agent_name	路径	是的	字符串	要删除的代理的名称。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	DeleteAgentResponse

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

代理 - 从清单更新代理

POST {endpoint}/agents/{agent_name}/import?api-version=v1

如果代理定义有任何更改，则通过添加新版本从清单更新代理。如果没有更改，则返回现有代理版本。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
agent_name	路径	是的	字符串	要更新的代理的名称。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选
说明	字符串	代理的可读说明。约束： maxLength：512	否
manifest_id	字符串	要从中导入代理版本的清单 ID。	是的
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
parameter_values	对象	清单的输入将导致完全具体化代理。	是的

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	AgentObject

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

代理 - 创建代理版本

POST {endpoint}/agents/{agent_name}/versions?api-version=v1

创建新的代理版本。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
agent_name	路径	是的	字符串	标识代理的唯一名称。 Name 可用于检索/更新/删除代理。 - 必须以字母数字字符开头和结尾， - 可以在中间包含连字符 - 不能超过 63 个字符。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Foundry-Features	假	字符串可能的值：`ContainerAgents=V1Preview`、、 `HostedAgents=V1PreviewWorkflowAgents=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选
定义	AgentDefinition		是的
~~ kind	AgentKind		是的
rai_config	RaiConfig	负责任 AI （RAI）内容筛选和安全功能的配置。	否
说明	字符串	代理的可读说明。约束： maxLength：512	否
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	AgentVersionObject

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

代理 - 列出代理版本

GET {endpoint}/agents/{agent_name}/versions?api-version=v1

返回代理的版本列表。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
agent_name	路径	是的	字符串	要为其检索版本的代理的名称。
limit	查询	否	整数	要返回的对象数的限制。限制可以介于 1 和 100 之间，以及默认值为 20。
顺序	查询	否	字符串可能的值： `ascdesc`	按 `created_at` 对象的时间戳排序顺序。升序为 `asc`，降序为 `desc` 。
after	查询	否	字符串	用于分页的游标。 `after` 是一个对象 ID，用于定义你在列表中的位置。例如，如果发出列表请求并接收 100 个对象，以 obj_foo 结尾，则后续调用可以包括 after=obj_foo，以便提取列表的下一页。
before	查询	否	字符串	用于分页的游标。 `before` 是一个对象 ID，用于定义你在列表中的位置。例如，如果发出列表请求并接收 100 个对象，以 obj_foo 结尾，则后续调用可以包括 before=obj_foo，以便提取列表中的上一页内容。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	对象	请求的项列表的响应数据。

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

代理 - 获取代理版本

GET {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=v1

检索代理的特定版本。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
agent_name	路径	是的	字符串	要检索的代理的名称。
agent_version	路径	是的	字符串	要检索的代理的版本。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	AgentVersionObject

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

代理 - 删除代理版本

DELETE {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=v1

删除代理的特定版本。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
agent_name	路径	是的	字符串	要删除的代理的名称。
agent_version	路径	是的	字符串	要删除的代理的版本
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	DeleteAgentVersionResponse

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

代理 - 从清单创建代理版本

POST {endpoint}/agents/{agent_name}/versions:import?api-version=v1

从清单创建新的代理版本。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
agent_name	路径	是的	字符串	标识代理的唯一名称。 Name 可用于检索/更新/删除代理。 - 必须以字母数字字符开头和结尾， - 可以在中间包含连字符 - 不能超过 63 个字符。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选
说明	字符串	代理的可读说明。约束： maxLength：512	否
manifest_id	字符串	要从中导入代理版本的清单 ID。	是的
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
parameter_values	对象	清单的输入将导致完全具体化代理。	是的

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	AgentVersionObject

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

代理 - 从清单创建代理

POST {endpoint}/agents:import?api-version=v1

从清单创建代理。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选
说明	字符串	代理的可读说明。约束： maxLength：512	否
manifest_id	字符串	要从中导入代理版本的清单 ID。	是的
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
姓名	字符串	标识代理的唯一名称。 Name 可用于检索/更新/删除代理。 - 必须以字母数字字符开头和结尾， - 可以在中间包含连字符 - 不能超过 63 个字符。约束： maxLength：63	是的
parameter_values	对象	清单的输入将导致完全具体化代理。	是的

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	AgentObject

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

代理容器

代理容器 - 列出代理容器作

GET {endpoint}/agents/{agent_name}/operations?api-version=v1

列出代理的容器作。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
agent_name	路径	是的	字符串	代理的名称。
limit	查询	否	整数	要返回的对象数的限制。限制可以介于 1 和 100 之间，以及默认值为 20。
顺序	查询	否	字符串可能的值： `ascdesc`	按 `created_at` 对象的时间戳排序顺序。升序为 `asc`，降序为 `desc` 。
after	查询	否	字符串	用于分页的游标。 `after` 是一个对象 ID，用于定义你在列表中的位置。例如，如果发出列表请求并接收 100 个对象，以 obj_foo 结尾，则后续调用可以包括 after=obj_foo，以便提取列表的下一页。
before	查询	否	字符串	用于分页的游标。 `before` 是一个对象 ID，用于定义你在列表中的位置。例如，如果发出列表请求并接收 100 个对象，以 obj_foo 结尾，则后续调用可以包括 before=obj_foo，以便提取列表中的上一页内容。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Foundry-Features	假	字符串可能的值：`ContainerAgents=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	对象	请求的项列表的响应数据。

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

代理容器 - 获取代理容器作

GET {endpoint}/agents/{agent_name}/operations/{operation_id}?api-version=v1

获取代理的容器作的状态。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
agent_name	路径	是的	字符串	代理的名称。
operation_id	路径	是的	字符串	作 ID。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Foundry-Features	假	字符串可能的值：`ContainerAgents=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	AgentContainerOperationObject

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

代理容器 - 获取代理容器

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default?api-version=v1

获取特定版本的代理的容器。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
agent_name	路径	是的	字符串	代理的名称。
agent_version	路径	是的	字符串	代理的版本。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Foundry-Features	假	字符串可能的值：`ContainerAgents=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	AgentContainerObject

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

代理容器 - 列出代理版本容器作

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default/operations?api-version=v1

列出特定版本的代理的容器作。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
agent_name	路径	是的	字符串	代理的名称。
agent_version	路径	是的	字符串	代理的版本。
limit	查询	否	整数	要返回的对象数的限制。限制可以介于 1 和 100 之间，以及默认值为 20。
顺序	查询	否	字符串可能的值： `ascdesc`	按 `created_at` 对象的时间戳排序顺序。升序为 `asc`，降序为 `desc` 。
after	查询	否	字符串	用于分页的游标。 `after` 是一个对象 ID，用于定义你在列表中的位置。例如，如果发出列表请求并接收 100 个对象，以 obj_foo 结尾，则后续调用可以包括 after=obj_foo，以便提取列表的下一页。
before	查询	否	字符串	用于分页的游标。 `before` 是一个对象 ID，用于定义你在列表中的位置。例如，如果发出列表请求并接收 100 个对象，以 obj_foo 结尾，则后续调用可以包括 before=obj_foo，以便提取列表中的上一页内容。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Foundry-Features	假	字符串可能的值：`ContainerAgents=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	对象	请求的项列表的响应数据。

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

代理容器 - 删除代理容器

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:delete?api-version=v1

删除特定版本的代理的容器。如果容器不存在，作将 no-op。该作是长时间运行的作。遵循Azure REST API中长期运行作的设计指南。 https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
agent_name	路径	是的	字符串	代理的名称。
agent_version	路径	是的	字符串	代理的版本。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Foundry-Features	假	字符串可能的值：`ContainerAgents=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

Responses

状态代码： 202

说明：已接受请求进行处理，但尚未完成处理。

内容类型	类型	说明
application/json	AgentContainerOperationObject

响应标头：

Header	类型	Description
Operation-Location	字符串

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

代理容器 - 流式传输代理容器日志

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:logstream?api-version=v1

容器日志条目以文本块形式从容器流式传输。每个区块是一个UTF-8字符串，可以是纯文本日志行，也可以是JSON格式的日志条目，具体取决于流式容器日志的类型。客户端应将每个区块视为不透明文本，如有需要，根据日志需求尝试解析为 JSON。

对于系统日志，格式为 JSON，结构如下：{“TimeStamp”：“2025-12-15T16：51：33Z”，“Type”：“Normal”，“ContainerAppName”：null，“RevisionName”：null，“RevisionName”：null，“Msg”：“连接事件收集器...”，“Reason”：“StartingGettingEvents”，“EventSource”：“ContainerAppController”，“Count”：1} {“TimeStamp”：“2025-12-15T16：51：34Z”，“Type”：“Normal”，“ContainerAppName”：null，“RevisionName”：null，“ReplicaName”：null，“Msg”：“成功连接事件server“，”Reason“：”ConnectedToEventsServer“，”EventSource“：”ContainerAppController“，”Count“：1}

对于控制台日志，格式是容器的标准/标准输出（stdout/stderr）发出的纯文本。 2025-12-15T08：43：48.72656 连接容器“agent-container”......2025-12-15T08：43：48.75451 成功连接到容器：“agent-container” [修订版： 'je90fe655aa742ef9a188b9fd14d6764--7tca06b'， Replica： 'je90fe655aa742ef9a188b9fd14d6764--7tca06b-6898b9c89f-mpkjc'] 2025-12-15T08： 33：59.0671054Z 标准 F 信息： 127.0.0.1：42588 - “获取 /readiness HTTP/1.1” 200 OK 2025-12-15T08：34：29.0649033Z 标准 F 信息： 127.0.0.1：60246 - “GET /readiness HTTP/1.1” 200 OK 2025-12-15T08：34：59.0644467Z 标准 F INFO： 127.0.0.1：43994 - “GET /readiness HTTP/1.1” 200 OK

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
agent_name	路径	是的	字符串	代理的名称。
agent_version	路径	是的	字符串	代理的版本。
kind	查询	否	字符串可能的值： `consolesystem`	控制台返回容器的标准/标准/标准，系统返回容器应用的事件流。默认使用控制台
replica_name	查询	否	字符串	省略后，服务器会为控制台日志选择第一个副本。针对特定副本的必要操作。
尾巴	查询	否	整数	返回的尾随行数。强制执行到1-300。默认值为 20
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Foundry-Features	假	字符串可能的值：`ContainerAgents=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

Responses

状态代码：200

说明：请求已成功。

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

代理容器 - 启动代理容器

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:start?api-version=v1

为特定版本的代理启动容器。如果容器已在运行，则作将 no-op。该作是长时间运行的作。遵循Azure REST API中长期运行作的设计指南。 https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
agent_name	路径	是的	字符串	代理的名称。
agent_version	路径	是的	字符串	代理的版本。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Foundry-Features	假	字符串可能的值：`ContainerAgents=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选	违约
max_replicas	整数	最大副本数。默认值为 1。	否	1
min_replicas	整数	副本的最小数目。默认值为 1。	否	1

Responses

状态代码： 202

说明：已接受请求进行处理，但尚未完成处理。

内容类型	类型	说明
application/json	AgentContainerOperationObject

响应标头：

Header	类型	Description
Operation-Location	字符串

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

代理容器 - 停止代理容器

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:stop?api-version=v1

停止特定版本的代理的容器。如果容器未运行或已停止，作将 no-op。该作是长时间运行的作。遵循Azure REST API中长期运行作的设计指南。 https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
agent_name	路径	是的	字符串	代理的名称。
agent_version	路径	是的	字符串	代理的版本。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Foundry-Features	假	字符串可能的值：`ContainerAgents=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

Responses

状态代码： 202

说明：已接受请求进行处理，但尚未完成处理。

内容类型	类型	说明
application/json	AgentContainerOperationObject

响应标头：

Header	类型	Description
Operation-Location	字符串

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

代理容器 - 更新代理容器

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:update?api-version=v1

更新特定版本的代理的容器。如果容器未运行，作将 no-op。该作是长时间运行的作。遵循Azure REST API中长期运行作的设计指南。 https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
agent_name	路径	是的	字符串	代理的名称。
agent_version	路径	是的	字符串	代理的版本。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Foundry-Features	假	字符串可能的值：`ContainerAgents=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选	违约
max_replicas	整数	最大副本数。	否
min_replicas	整数	副本的最小数目。	否

Responses

状态代码： 202

说明：已接受请求进行处理，但尚未完成处理。

内容类型	类型	说明
application/json	AgentContainerOperationObject

响应标头：

Header	类型	Description
Operation-Location	字符串

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

连接

连接 - 列表

GET {endpoint}/connections?api-version=v1

在project中列出所有连接，但不填写连接凭证

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
connectionType	查询	否	字符串可能的值：`AzureOpenAI`, `AzureBlob`, `AzureStorageAccount`, `CognitiveSearch`, `CosmosDB`, `ApiKey`, `AppConfig`, `AppInsights`, `CustomKeys`, `RemoteTool_Preview`	列出此特定类型的连接
defaultConnection	查询	否	布尔	列出默认连接的连接

请求标头

姓名	必选	类型	Description
x-ms-client-request-id	假	字符串	请求的不透明、全局唯一的客户端生成的字符串标识符。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	PagedConnection

响应标头：

Header	类型	Description
x-ms-client-request-id		请求的不透明、全局唯一的客户端生成的字符串标识符。

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

连接 - 获取

GET {endpoint}/connections/{name}?api-version=v1

按名称获取连接，无需填充连接凭证

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	由用户提供的连接的友好名称。

请求标头

姓名	必选	类型	Description
x-ms-client-request-id	假	字符串	请求的不透明、全局唯一的客户端生成的字符串标识符。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	Connection

响应标头：

Header	类型	Description
x-ms-client-request-id		请求的不透明、全局唯一的客户端生成的字符串标识符。

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

连接 - 使用凭据获取

POST {endpoint}/connections/{name}/getConnectionWithCredentials?api-version=v1

按名称获取连接及其连接凭证

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	由用户提供的连接的友好名称。

请求标头

姓名	必选	类型	Description
x-ms-client-request-id	假	字符串	请求的不透明、全局唯一的客户端生成的字符串标识符。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	Connection

响应标头：

Header	类型	Description
x-ms-client-request-id		请求的不透明、全局唯一的客户端生成的字符串标识符。

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

数据集

数据集 - 列出最新

GET {endpoint}/datasets?api-version=v1

列出每个 DatasetVersion 的最新版本

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	PagedDatasetVersion

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

数据集 - 列表版本

GET {endpoint}/datasets/{name}/versions?api-version=v1

列出给定 DatasetVersion 的所有版本

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	PagedDatasetVersion

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

数据集 - 获取版本

GET {endpoint}/datasets/{name}/versions/{version}?api-version=v1

获取 DatasetVersion 的特定版本。如果 DatasetVersion 不存在，则服务将返回 404 Not Found 错误。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称
版本	路径	是的	字符串	要检索的 DatasetVersion 的特定版本 ID。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	DatasetVersion

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

数据集 - 删除版本

DELETE {endpoint}/datasets/{name}/versions/{version}?api-version=v1

删除 DatasetVersion 的特定版本。如果 DatasetVersion 已成功删除或 DatasetVersion 不存在，则服务将返回 204 No Content。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称
版本	路径	是的	字符串	要删除的 DatasetVersion 的版本。

Responses

状态代码： 204

说明：没有要为此请求发送的内容，但标头可能很有用。

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

数据集 - 创建或更新版本

PATCH {endpoint}/datasets/{name}/versions/{version}?api-version=v1

使用给定版本 ID 创建新的 DatasetVersion 或更新现有 DatasetVersion

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称
版本	路径	是的	字符串	要创建或更新的 DatasetVersion 的特定版本 ID。

请求主体

Content-Type：application/merge-patch+json

姓名	类型	Description	必选
说明	字符串	资产说明文本。	否
tags	对象	标记字典。可以添加、删除和更新标记。	否
类型	DatasetType	用于确定数据类型的枚举。	是的

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	DatasetVersion

状态代码： 201

说明：请求已成功，因此创建了一个新资源。

内容类型	类型	说明
application/json	DatasetVersion

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

数据集 - 获取凭据

POST {endpoint}/datasets/{name}/versions/{version}/credentials?api-version=v1

获取SAS凭证以access与Dataset版本关联的storage账户。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称
版本	路径	是的	字符串	要作的 DatasetVersion 的特定版本 ID。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	AssetCredentialResponse

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

数据集 - 开始等待上传版本

POST {endpoint}/datasets/{name}/versions/{version}/startPendingUpload?api-version=v1

开始特定版本的数据集的新上传或获取现有待上传的数据集。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称
版本	路径	是的	字符串	要作的 DatasetVersion 的特定版本 ID。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选
connectionName （连接名称）	字符串	Azure Storage Account connection name to using to generate temporary SAS token	否
pendingUploadId	字符串	如果未提供 PendingUploadId，则将使用随机 GUID。	否
pendingUploadType	枚举	BlobReference 是唯一支持的类型。可能的值：`BlobReference`	是的

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	PendingUploadResponse

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

部署

部署 - 列表

GET {endpoint}/deployments?api-version=v1

列出project中所有已部署的模型

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
modelPublisher	查询	否	字符串	Model publisher 用于通过
modelName	查询	否	字符串	型号名称（即publisher的具体名称）用于通过筛选模型
deploymentType	查询	否	字符串可能的值：`ModelDeployment`	筛选列表的部署类型

请求标头

姓名	必选	类型	Description
x-ms-client-request-id	假	字符串	请求的不透明、全局唯一的客户端生成的字符串标识符。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	PagedDeployment

响应标头：

Header	类型	Description
x-ms-client-request-id		请求的不透明、全局唯一的客户端生成的字符串标识符。

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

部署 - 获取

GET {endpoint}/deployments/{name}?api-version=v1

获取已部署的模型。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	部署的名称

请求标头

姓名	必选	类型	Description
x-ms-client-request-id	假	字符串	请求的不透明、全局唯一的客户端生成的字符串标识符。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	部署

响应标头：

Header	类型	Description
x-ms-client-request-id		请求的不透明、全局唯一的客户端生成的字符串标识符。

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

评估分类

评估分类 - 列表

GET {endpoint}/evaluationtaxonomies?api-version=v1

列表评估分类法

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
inputName	查询	否	字符串	按评估输入名称进行筛选。
inputType	查询	否	字符串	按分类输入类型筛选。

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`Evaluations=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	PagedEvaluationTaxonomy

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

评估分类 - get

GET {endpoint}/evaluationtaxonomies/{name}?api-version=v1

获取按名称运行的评估。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`Evaluations=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	EvaluationTaxonomy

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

评估分类 - 删除

DELETE {endpoint}/evaluationtaxonomies/{name}?api-version=v1

按名称删除评估分类。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`Evaluations=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

Responses

状态代码： 204

说明：没有要为此请求发送的内容，但标头可能很有用。

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

评估分类 - 创建

PUT {endpoint}/evaluationtaxonomies/{name}?api-version=v1

创建评估分类。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	评估分类的名称。

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`Evaluations=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选
说明	字符串	资产说明文本。	否
属性	对象	评估分类的其他属性。	否
tags	对象	标记字典。可以添加、删除和更新标记。	否
taxonomyCategories	TaxonomyCategory 数组	分类类别列表。	否
taxonomyInput	EvaluationTaxonomyInput	评估分类的输入配置。	是的
└─ 类型	EvaluationTaxonomyInputType	评估分类的输入类型。	是的

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	EvaluationTaxonomy

状态代码： 201

说明：请求已成功，因此创建了一个新资源。

内容类型	类型	说明
application/json	EvaluationTaxonomy

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

评估分类 - 更新

PATCH {endpoint}/evaluationtaxonomies/{name}?api-version=v1

更新评估分类。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	评估分类的名称。

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`Evaluations=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选
说明	字符串	资产说明文本。	否
属性	对象	评估分类的其他属性。	否
tags	对象	标记字典。可以添加、删除和更新标记。	否
taxonomyCategories	TaxonomyCategory 数组	分类类别列表。	否
taxonomyInput	EvaluationTaxonomyInputUpdate	评估分类的输入配置。	否
└─ 类型	EvaluationTaxonomyInputType	评估分类的输入类型。	是的

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	EvaluationTaxonomy

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

评估规则

评估规则 - 列表

GET {endpoint}/evaluationrules?api-version=v1

列出所有评估规则。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
actionType	查询	否	字符串可能的值： `continuousEvaluationhumanEvaluationPreview`	按评估规则的类型进行筛选。
agentName （代理名称）	查询	否	字符串	按代理名称筛选。
enabled	查询	否	布尔	按已启用状态进行筛选。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	PagedEvaluationRule

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

评估规则 - 获取

GET {endpoint}/evaluationrules/{id}?api-version=v1

获取评估规则。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
id	路径	是的	字符串	评估规则的唯一标识符。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	EvaluationRule

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

评估规则 - 删除

DELETE {endpoint}/evaluationrules/{id}?api-version=v1

删除评估规则。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
id	路径	是的	字符串	评估规则的唯一标识符。

Responses

状态代码： 204

说明：没有要为此请求发送的内容，但标头可能很有用。

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

评估规则 - 创建或更新

PUT {endpoint}/evaluationrules/{id}?api-version=v1

创建或更新评估规则。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
id	路径	是的	字符串	评估规则的唯一标识符。

请求标头

姓名	必选	类型	Description
Foundry-Features	假	字符串可能的值：`Evaluations=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选
操作	EvaluationRuleAction	评估行动模型。	是的
└─ 类型	EvaluationRuleActionType	评估作的类型。	是的
说明	字符串	评估规则的说明。	否
displayName	字符串	评估规则的显示名称。	否
enabled	布尔	指示是否启用了评估规则。默认值为 true。	是的
eventType	EvaluationRuleEventType	评估规则事件的类型。	是的
筛选器	EvaluationRuleFilter	评估筛选器模型。	否
~~ agentName	字符串	按代理名称筛选。	是的
id	string （只读）	评估规则的唯一标识符。	是的
系统数据	对象（只读）	评估规则的系统元数据。	是的

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	EvaluationRule

状态代码： 201

说明：请求已成功，因此创建了一个新资源。

内容类型	类型	说明
application/json	EvaluationRule

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

评估程序

计算器 - 列出最新版本

GET {endpoint}/evaluators?api-version=v1

列出每个评估器的最新版本

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
类型	查询	否	字符串可能的值：`builtin`、、 `customall`	按类型筛选评估器。可能的值：“all”、“custom”、“builtin”。
limit	查询	否	整数	要返回的对象数的限制。限制可以介于 1 和 100 之间，默认值为 20。

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`Evaluations=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	PagedEvaluatorVersion

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

计算器 - 列出版本

GET {endpoint}/evaluators/{name}/versions?api-version=v1

列出给定评估器的所有版本

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称
类型	查询	否	字符串可能的值：`builtin`、、 `customall`	按类型筛选评估器。可能的值：“all”、“custom”、“builtin”。
limit	查询	否	整数	要返回的对象数的限制。限制可以介于 1 和 100 之间，默认值为 20。

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`Evaluations=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	PagedEvaluatorVersion

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

计算器 - 创建版本

POST {endpoint}/evaluators/{name}/versions?api-version=v1

使用自动递增版本 ID 创建新的 EvaluatorVersion

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`Evaluations=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选
categories	EvaluatorCategory 数组	评估者的类别	是的
定义	EvaluatorDefinition	使用鉴别器的基本评估器配置	是的
data_schema	对象	评估者输入数据的 JSON 架构（草案 2020-12）。这包括类型、属性、必需等参数。	否
init_parameters	对象	评估器输入参数的 JSON 架构（草案 2020-12）。这包括类型、属性、必需等参数。	否
~~ 指标	对象	此评估器生成的输出指标列表	否
└─ 类型	EvaluatorDefinitionType	评估器定义的类型	是的
说明	字符串	资产说明文本。	否
display_name	字符串	评估器的显示名称。在AI Foundry中，很容易找到评估者。它不需要是唯一的。	否
evaluator_type	EvaluatorType	评估器的类型	是的
元数据	对象	有关评估者的元数据	否
tags	对象	标记字典。可以添加、删除和更新标记。	否

Responses

状态代码： 201

说明：请求已成功，因此创建了一个新资源。

内容类型	类型	说明
application/json	EvaluatorVersion

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

计算器 - 获取版本

GET {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

获取 EvaluatorVersion 的特定版本。如果 EvaluatorVersion 不存在，则服务将返回 404 Not Found 错误。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称
版本	路径	是的	字符串	要检索的 EvaluatorVersion 的特定版本 ID。

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`Evaluations=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	EvaluatorVersion

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

计算器 - 删除版本

DELETE {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

删除 EvaluatorVersion 的特定版本。如果 EvaluatorVersion 已成功删除或 EvaluatorVersion 不存在，则该服务将返回 204 No Content。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称
版本	路径	是的	字符串	要删除的 EvaluatorVersion 的版本。

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`Evaluations=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

Responses

状态代码： 204

说明：没有要为此请求发送的内容，但标头可能很有用。

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

计算器 - 更新版本

PATCH {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

使用给定的版本 ID 更新现有 EvaluatorVersion

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称
版本	路径	是的	字符串	要更新的 EvaluatorVersion 的版本。

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`Evaluations=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选
categories	EvaluatorCategory 数组	评估者的类别	否
说明	字符串	资产说明文本。	否
display_name	字符串	评估器的显示名称。在AI Foundry中，很容易找到评估者。它不需要是唯一的。	否
元数据	对象	有关评估者的元数据	否
tags	对象	标记字典。可以添加、删除和更新标记。	否

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	EvaluatorVersion

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

索引

索引 - 列出最新

GET {endpoint}/indexes?api-version=v1

列出每个索引的最新版本

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	PagedIndex

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

索引 - 列表版本

GET {endpoint}/indexes/{name}/versions?api-version=v1

列出给定索引的所有版本

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	PagedIndex

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

索引 - 获取版本

GET {endpoint}/indexes/{name}/versions/{version}?api-version=v1

获取索引的特定版本。如果索引不存在，则服务将返回 404 Not Found 错误。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称
版本	路径	是的	字符串	要检索的 Index 的特定版本 ID。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	索引

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

索引 - 删除版本

DELETE {endpoint}/indexes/{name}/versions/{version}?api-version=v1

删除索引的特定版本。如果索引已成功删除或索引不存在，则服务将返回 204 无内容。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称
版本	路径	是的	字符串	要删除的 Index 的版本。

Responses

状态代码： 204

说明：没有要为此请求发送的内容，但标头可能很有用。

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

索引 - 创建或更新版本

PATCH {endpoint}/indexes/{name}/versions/{version}?api-version=v1

使用给定版本 ID 创建新索引或更新现有索引

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称
版本	路径	是的	字符串	要创建或更新的索引的特定版本 ID。

请求主体

Content-Type：application/merge-patch+json

姓名	类型	Description	必选
说明	字符串	资产说明文本。	否
tags	对象	标记字典。可以添加、删除和更新标记。	否
类型	IndexType		是的

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	索引

状态代码： 201

说明：请求已成功，因此创建了一个新资源。

内容类型	类型	说明
application/json	索引

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

洞见

见解 - 生成

POST {endpoint}/insights?api-version=v1

生成见解

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`Insights=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。
可重复性 -Request-ID	假	字符串	客户端生成的唯一标识符，用于确保请求幂等性。使用相同的 ID 进行重试，以防止重复评估。
可重复性 -First-Sent	假	字符串	时间戳，指示首次启动此请求的时间。与 repeatability-request-id 结合使用以进行幂等控制。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选
displayName	字符串	见解的用户友好显示名称。	是的
id	string （只读）	见解报表的唯一标识符。	是的
元数据	InsightsMetadata （只读）	有关见解的元数据。	是的
~~ completedAt	字符串	见解完成时的时间戳。	否
~~ createdAt	字符串	创建见解时的时间戳。	是的
申请	InsightRequest	见解报告的请求。	是的
└─ 类型	InsightType	请求的类型。	是的
结果	InsightResult （只读）	洞察的结果。	否
└─ 类型	InsightType	见解结果的类型。	是的
状态	Azure。Core.Foundations.OperationState（只读）	描述允许的作状态的枚举。	是的

Responses

状态代码： 201

说明：请求已成功，因此创建了一个新资源。

内容类型	类型	说明
application/json	洞察力

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

见解 - 列表

GET {endpoint}/insights?api-version=v1

按时间倒序列出所有见解（最新的在前）。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
类型	查询	否	字符串可能的值：`EvaluationRunClusterInsight`、、 `AgentClusterInsightEvaluationComparison`	按分析类型筛选。
evalId	查询	否	字符串	按评估 ID 筛选。
runId	查询	否	字符串	按评估运行 ID 进行筛选。
agentName （代理名称）	查询	否	字符串	按代理名称筛选。
includeCoordinates	查询	否	布尔	是否在响应中包含可视化的坐标。默认值为 false。

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`Insights=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	PagedInsight

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

见解 - 获取

GET {endpoint}/insights/{id}?api-version=v1

按 ID 获取特定见解。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
id	路径	是的	字符串	见解报表的唯一标识符。
includeCoordinates	查询	否	布尔	是否在响应中包含可视化的坐标。默认值为 false。

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`Insights=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	洞察力

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

内存存储

创建内存存储

POST {endpoint}/memory_stores?api-version=v1

创建内存存储。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`MemoryStores=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选
定义	MemoryStoreDefinition	内存存储配置的基本定义。	是的
~~ kind	MemoryStoreKind	内存存储的类型。	是的
说明	字符串	内存存储的人类可读描述。约束： maxLength：512	否
元数据	对象	要与内存存储关联的任意键值元数据。	否
姓名	字符串	内存存储的名称。约束： maxLength：256	是的

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	MemoryStoreObject

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

列出内存空间

GET {endpoint}/memory_stores?api-version=v1

列出所有内存存储。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
limit	查询	否	整数	要返回的对象数的限制。限制可以介于 1 和 100 之间，以及默认值为 20。
顺序	查询	否	字符串可能的值： `ascdesc`	按 `created_at` 对象的时间戳排序顺序。升序为 `asc`，降序为 `desc` 。
after	查询	否	字符串	用于分页的游标。 `after` 是一个对象 ID，用于定义你在列表中的位置。例如，如果发出列表请求并接收 100 个对象，以 obj_foo 结尾，则后续调用可以包括 after=obj_foo，以便提取列表的下一页。
before	查询	否	字符串	用于分页的游标。 `before` 是一个对象 ID，用于定义你在列表中的位置。例如，如果发出列表请求并接收 100 个对象，以 obj_foo 结尾，则后续调用可以包括 before=obj_foo，以便提取列表中的上一页内容。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`MemoryStores=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	对象	请求的项列表的响应数据。

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

更新内存存储

POST {endpoint}/memory_stores/{name}?api-version=v1

更新内存存储。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
姓名	路径	是的	字符串	要更新的内存存储的名称。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`MemoryStores=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选	违约
说明	字符串	内存存储的人类可读描述。约束： maxLength：512	否
元数据	对象	要与内存存储关联的任意键值元数据。	否

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	MemoryStoreObject

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

获取内存存储

GET {endpoint}/memory_stores/{name}?api-version=v1

检索内存存储。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
姓名	路径	是的	字符串	要检索的内存存储的名称。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`MemoryStores=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	MemoryStoreObject

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

删除内存存储

DELETE {endpoint}/memory_stores/{name}?api-version=v1

删除内存存储。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
姓名	路径	是的	字符串	要删除的内存存储的名称。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`MemoryStores=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	DeleteMemoryStoreResponse

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

获取更新结果

GET {endpoint}/memory_stores/{name}/updates/{update_id}?api-version=v1

获取内存存储更新结果。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
姓名	路径	是的	字符串	内存存储的名称。
update_id	路径	是的	字符串	内存更新作的 ID。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`MemoryStores=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	MemoryStoreUpdateResponse

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

删除范围内存

POST {endpoint}/memory_stores/{name}:delete_scope?api-version=v1

从内存存储中删除与特定作用域关联的所有内存。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
姓名	路径	是的	字符串	内存存储的名称。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`MemoryStores=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选	违约
作用域	字符串	逻辑上对要删除的内存进行分组和隔离的命名空间，例如用户 ID。	是的

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	MemoryStoreDeleteScopeResponse

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

搜索记忆

POST {endpoint}/memory_stores/{name}:search_memories?api-version=v1

根据对话上下文从内存存储中搜索相关记忆。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
姓名	路径	是的	字符串	要搜索的内存存储的名称。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`MemoryStores=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选
items	OpenAI.InputItem 数组	要搜索相关记忆的项目。	否
options	MemorySearchOptions	内存搜索选项。	否
max_memories	整数	要返回的最大内存项数。	否
previous_search_id	字符串	上一个搜索请求的唯一 ID，从上一个作中断的地方启用增量内存搜索。	否
作用域	字符串	在逻辑上对内存进行分组和隔离的命名空间，例如用户 ID。	是的

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	MemoryStoreSearchResponse

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

更新记忆

POST {endpoint}/memory_stores/{name}:update_memories?api-version=v1

使用对话记忆更新内存存储。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
姓名	路径	是的	字符串	要更新的内存存储的名称。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`MemoryStores=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选	违约
items	OpenAI.InputItem 数组	从中提取记忆的对话项目。	否
previous_update_id	字符串	上一个更新请求的唯一 ID，从上一个作中断的位置启用增量内存更新。	否
作用域	字符串	在逻辑上对内存进行分组和隔离的命名空间，例如用户 ID。	是的
update_delay	整数	处理内存更新之前的超时时间（以秒为单位）。如果在此期间收到新的更新请求，它将取消当前请求并重置超时。设置为 0 可立即触发更新，无延迟。默认为 300（5 分钟）。	否	300

Responses

状态代码： 202

说明：已接受请求进行处理，但尚未完成处理。

内容类型	类型	说明
application/json	MemoryStoreUpdateResponse

响应标头：

Header	类型	Description
Operation-Location	字符串	用于监控作状态的位置。

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

对话

创建对话

POST {endpoint}/openai/v1/conversations

创建对话。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选	违约
items	OpenAI.InputItem 数组		否
元数据	OpenAI.Metadata （可为 null）	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	OpenAI.ConversationResource

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

列出对话

GET {endpoint}/openai/v1/conversations

返回所有对话的列表。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
limit	查询	否	整数	要返回的对象数的限制。限制可以介于 1 和 100 之间，以及默认值为 20。
顺序	查询	否	字符串可能的值： `ascdesc`	按 `created_at` 对象的时间戳排序顺序。升序为 `asc`，降序为 `desc` 。
after	查询	否	字符串	用于分页的游标。 `after` 是一个对象 ID，用于定义你在列表中的位置。例如，如果发出列表请求并接收 100 个对象，以 obj_foo 结尾，则后续调用可以包括 after=obj_foo，以便提取列表的下一页。
before	查询	否	字符串	用于分页的游标。 `before` 是一个对象 ID，用于定义你在列表中的位置。例如，如果发出列表请求并接收 100 个对象，以 obj_foo 结尾，则后续调用可以包括 before=obj_foo，以便提取列表中的上一页内容。
agent_name	查询	否	字符串	按代理名称筛选。如果提供，则仅返回与指定代理关联的项。
agent_id	查询	否	字符串	按格式 `name:version`的代理 ID 进行筛选。如果提供，则仅返回与指定代理 ID 关联的项。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	对象	请求的项列表的响应数据。

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

更新对话

POST {endpoint}/openai/v1/conversations/{conversation_id}

更新对话。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
conversation_id	路径	是的	字符串	要更新的对话的 ID。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选	违约
元数据	OpenAI.Metadata （可为 null）	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	是的

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	OpenAI.ConversationResource

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

获取对话

GET {endpoint}/openai/v1/conversations/{conversation_id}

检索对话。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
conversation_id	路径	是的	字符串	要检索的对话的 ID。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	OpenAI.ConversationResource

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

删除对话

DELETE {endpoint}/openai/v1/conversations/{conversation_id}

删除对话。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
conversation_id	路径	是的	字符串	要删除的对话的 ID。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	OpenAI.DeletedConversationResource

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

创建对话项

POST {endpoint}/openai/v1/conversations/{conversation_id}/items

使用给定 ID 在聊天中创建项。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
conversation_id	路径	是的	字符串	需要在其中创建项的会话的 ID。
包括	查询	否	数组	要包含在响应中的其他字段。有关详细信息， `include` 请参阅列出对话项的参数。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选	违约
items	OpenAI.Item 数组	要添加到对话中的项。一次最多可以添加 20 个项目。	是的

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	OpenAI.ConversationItemList

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

列出对话项

GET {endpoint}/openai/v1/conversations/{conversation_id}/items

列出具有给定 ID 的对话的所有项。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
conversation_id	路径	是的	字符串	需要列出项的会话的 ID。
limit	查询	否	整数	要返回的对象数的限制。限制可以介于 1 和 100 之间，以及默认值为 20。
顺序	查询	否	字符串可能的值： `ascdesc`	按 `created_at` 对象的时间戳排序顺序。升序为 `asc`，降序为 `desc` 。
after	查询	否	字符串	用于分页的游标。 `after` 是一个对象 ID，用于定义你在列表中的位置。例如，如果发出列表请求并接收 100 个对象，以 obj_foo 结尾，则后续调用可以包括 after=obj_foo，以便提取列表的下一页。
before	查询	否	字符串	用于分页的游标。 `before` 是一个对象 ID，用于定义你在列表中的位置。例如，如果发出列表请求并接收 100 个对象，以 obj_foo 结尾，则后续调用可以包括 before=obj_foo，以便提取列表中的上一页内容。
item_type	查询	否	字符串可能的值：、、`message`、、、 `output_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`	按项类型进行筛选。如果提供，则仅返回指定类型的项。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	对象	请求的项列表的响应数据。

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

获取对话项

GET {endpoint}/openai/v1/conversations/{conversation_id}/items/{item_id}

从与给定 ID 的对话中获取单个项。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
conversation_id	路径	是的	字符串	包含该项的会话的 ID。
item_id	路径	是的	字符串	要检索的对话项的 ID。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	OpenAI.OutputItem

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

删除对话项

DELETE {endpoint}/openai/v1/conversations/{conversation_id}/items/{item_id}

从与给定 ID 的对话中删除项。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
conversation_id	路径	是的	字符串	需要从中删除项的会话的 ID。
item_id	路径	是的	字符串	要删除的对话项的 ID。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	OpenAI.ConversationResource

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

Evals

Evals - 列表 evals

GET {endpoint}/openai/v1/evals

列出所有评估列出一个project的评估。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
after	查询	否	字符串	上一个分页请求中最后一次运行的标识符。
limit	查询	否	整数	要检索的运行数。
顺序	查询	否	字符串可能的值： `ascdesc`	按时间戳对运行的排序顺序。用于 `asc` 升序或 `desc` 降序。默认为 `asc`。
按...排序	查询	否	字符串可能的值： `created_atupdated_at`	可以通过创建时间或上次更新时间对 Evals 进行排序。用于 `created_at` 创建时间或 `updated_at` 上次更新时间。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	对象	请求的项列表的响应数据。

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

Evals - 创建 eval

POST {endpoint}/openai/v1/evals

创建评估创建可用于测试模型性能的评估的结构。评估是一组测试条件和数据源的配置，用于指示评估中使用的数据的架构。创建评估后，可以在不同的模型和模型参数上运行它。我们支持多种类型的评分程序和数据源。有关详细信息，请参阅

请求主体

“内容类型”: application/json

姓名	类型	Description	必选
数据源配置	OpenAI.CreateEvalCustomDataSourceConfig 或 OpenAI.CreateEvalLogsDataSourceConfig 或 OpenAI.CreateEvalStoredCompletionsDataSourceConfig 或 AzureAIDataSourceConfig	用于评估运行的数据源的配置。指示计算中使用的数据的架构。	是的
元数据	OpenAI.Metadata （可为 null）	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
姓名	字符串	评估的名称。	否
属性	对象	一组不可变的 16 键值对，这些键值对可以附加到对象以存储其他信息。键是最大长度为 64 个字符的字符串。值为最大长度为 512 个字符的字符串。	否
测试标准	OpenAI.EvalGraderLabelModel 或 OpenAI.EvalGraderStringCheck 或 OpenAI.EvalGraderTextSimilarity 或 OpenAI.EvalGraderPython 或 OpenAI.EvalGraderScoreModel 或 EvalGraderAzureAIEvaluator 的数组	此组中所有评估运行的评分程序列表。评分器可以使用双花括号符号引用数据源中的变量，例如 `{{item.variable_name}}`。若要引用模型的输出，请使用 `sample` 命名空间（即 `{{sample.output_text}}`）。	是的

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	Eval

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

Evals - 删除 eval

DELETE {endpoint}/openai/v1/evals/{eval_id}

删除评估删除评估。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
eval_id	路径	是的	字符串	要删除的评估的 ID。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	DeleteEvalResponse

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

Evals - 获取 eval

GET {endpoint}/openai/v1/evals/{eval_id}

获取评估获取按 ID 的评估。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
eval_id	路径	是的	字符串	要检索的评估的 ID。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	Eval

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

Evals - 更新 eval

POST {endpoint}/openai/v1/evals/{eval_id}

更新评估更新评估的某些属性。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
eval_id	路径	是的	字符串	要更新的评估的 ID。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选
元数据	OpenAI.Metadata （可为 null）	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
姓名	字符串		否
属性	对象	一组不可变的 16 键值对，这些键值对可以附加到对象以存储其他信息。键是最大长度为 64 个字符的字符串。值为最大长度为 512 个字符的字符串。	否

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	Eval

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

Evals - 列表运行

GET {endpoint}/openai/v1/evals/{eval_id}/runs

获取评估的运行列表。获取评估的运行列表。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
eval_id	路径	是的	字符串	要检索其运行的评估的 ID。
after	查询	否	字符串	上一个分页请求中最后一次运行的标识符。
limit	查询	否	整数	要检索的运行数。
顺序	查询	否	字符串可能的值： `ascdesc`	按时间戳对运行的排序顺序。用于 `asc` 升序或 `desc` 降序。默认为 `asc`。
状态	查询	否	字符串可能的值：`queued`、、`in_progresscompleted`、 `canceledfailed` 。按状态筛选运行。之`queued`一， `in_progressfailed`， `completed`，。 `canceled`

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	对象	请求的项列表的响应数据。

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

Evals - 创建 eval 运行

POST {endpoint}/openai/v1/evals/{eval_id}/runs

创建评估运行

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
eval_id	路径	是的	字符串	要为其创建运行的评估的 ID。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选
数据源	OpenAI.CreateEvalJsonlRunDataSource 或 OpenAI.CreateEvalCompletionsRunDataSource 或 OpenAI.CreateEvalResponsesRunDataSource 或 EvalRunDataSource	有关运行数据源的详细信息。	是的
元数据	OpenAI.Metadata （可为 null）	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
姓名	字符串	运行的名称。	否
属性	对象	一组不可变的 16 键值对，这些键值对可以附加到对象以存储其他信息。键是最大长度为 64 个字符的字符串。值为最大长度为 512 个字符的字符串。	否

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	EvalRun

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

Evals - 删除 eval 运行

DELETE {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

删除评估运行删除 eval 运行。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
eval_id	路径	是的	字符串	要从中删除运行的评估的 ID。
run_id	路径	是的	字符串	要删除的运行的 ID。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	DeleteEvalRunResponse

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

Evals - 获取 eval 运行

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

获取评估运行获取按 ID 运行的评估。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
eval_id	路径	是的	字符串	要检索其运行的评估的 ID。
run_id	路径	是的	字符串	要检索的运行的 ID。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	EvalRun

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

Evals - 取消 eval 运行

POST {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

取消评估运行取消正在进行的评估运行。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
eval_id	路径	是的	字符串	要取消其运行的评估的 ID。
run_id	路径	是的	字符串	要取消的运行的 ID。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	EvalRun

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

Evals - 获取 eval 运行输出项

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items

获取评估运行输出项获取评估运行的输出项的列表。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
eval_id	路径	是的	字符串
run_id	路径	是的	字符串	要检索其输出项的运行 ID。
after	查询	否	字符串	上一个分页请求中最后一次运行的标识符。
limit	查询	否	整数	要检索的运行数。
顺序	查询	否	字符串可能的值： `ascdesc`	按时间戳对运行的排序顺序。用于 `asc` 升序或 `desc` 降序。默认为 `asc`。
状态	查询	否	字符串可能的值： `failpass`	按状态筛选输出项。用于 `failed` 按失败的输出进行筛选项或 `pass` 按传递的输出项进行筛选。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	对象	请求的项列表的响应数据。

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

Evals - 获取 eval 运行输出项

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}

获取评估运行的输出项：按 ID 获取评估运行输出项。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
eval_id	路径	是的	字符串	要检索其运行的评估的 ID。
run_id	路径	是的	字符串	要检索的运行的 ID。
output_item_id	路径	是的	字符串	要检索的输出项的 ID。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	EvalRunOutputItem

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

Fine-Tuning

创建微调作业

POST {endpoint}/openai/v1/fine_tuning/jobs?api-version=v1

创建一个微调作业，开始从给定数据集创建新模型的过程。

响应包括排队作业的详细信息，包括作业状态以及完成后微调的模型的名称。

了解更多关于微调

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选	违约
超参数	OpenAI.CreateFineTuningJobRequestHyperparameters		否
batch_size	string 或 OpenAI.integer		否	汽车
学习率倍增器	string 或 OpenAI.numeric		否
n_epochs	string 或 OpenAI.integer		否	汽车
integrations	OpenAI.CreateFineTuningJobRequestIntegrations 数组	要为微调作业启用的集成列表。	否
元数据	OpenAI.Metadata （可为 null）	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
方法	OpenAI.FineTuneMethod	用于微调的方法。	否
模型	字符串（请参阅下面的有效模型）	要微调的模型的名称。可以选择其中一个支持型号。	是的
seed	OpenAI.integer （可为 null）		否
suffix	string （可为 null）	最多 64 个字符的字符串，将添加到微调模型名称中。例如，`suffix` 为“custom-model-name”，将生成类似 `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel` 这样的模型名称。约束： minLength：1，maxLength：64	否
训练文件	字符串	包含训练数据的已上传文件的 ID。请参阅上传文件，了解如何上传文件。数据集必须格式化为 JSONL 文件。此外，必须上传文件，目的是执行 `fine-tune` 操作。文件的内容应有所不同，具体取决于模型是否使用聊天、完成格式，或者微调方法是否使用首选项格式。更多详情请参见微调指南。	是的
验证文件	string （可为 null）	包含验证数据的已上传文件的 ID。如果提供此文件，则数据将在微调期间定期用于生成验证指标。这些指标可在微调结果文件中查看。训练文件和验证文件中不应存在相同的数据。数据集必须格式化为 JSONL 文件。必须上传文件，目的是执行 `fine-tune` 操作。更多详情请参见微调指南。	否

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	OpenAI.FineTuningJob

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

列出分页微调作业

GET {endpoint}/openai/v1/fine_tuning/jobs?api-version=v1

列出组织的微调作业

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
after	查询	否	字符串	上一个分页请求中最后一个作业的标识符。
limit	查询	否	整数	要检索的微调作业数。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	OpenAI.ListPaginatedFineTuningJobsResponse

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

检索微调作业

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}?api-version=v1

获取有关微调作业的信息。

了解更多关于微调

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
微调任务ID (fine_tuning_job_id)	路径	是的	字符串	微调作业的 ID。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	OpenAI.FineTuningJob

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

取消微调作业

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel?api-version=v1

立即取消微调作业。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
微调任务ID (fine_tuning_job_id)	路径	是的	字符串	要取消的微调作业的 ID。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	OpenAI.FineTuningJob

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

列出微调作业检查点

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints?api-version=v1

列出微调作业的检查点。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
微调任务ID (fine_tuning_job_id)	路径	是的	字符串	要为其获取检查点的微调作业的 ID。
after	查询	否	字符串	上一个分页请求中最后一个检查点 ID 的标识符。
limit	查询	否	整数	要检索的检查点数量。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	OpenAI.ListFineTuningJobCheckpointsResponse

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

列出优化作业事件

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events?api-version=v1

获取微调作业的精细状态更新。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
微调任务ID (fine_tuning_job_id)	路径	是的	字符串	要为其获取事件的微调作业的 ID。
after	查询	否	字符串	上一个分页请求中最后一个事件的标识符。
limit	查询	否	整数	要检索的事件数。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	OpenAI.ListFineTuningJobEventsResponse

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

暂停微调作业

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause?api-version=v1

暂停正在运行的微调作业。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
微调任务ID (fine_tuning_job_id)	路径	是的	字符串	要暂停的微调作业的 ID。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	OpenAI.FineTuningJob

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

恢复微调作业

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume?api-version=v1

恢复暂停的微调作业。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
微调任务ID (fine_tuning_job_id)	路径	是的	字符串	要恢复的微调作业的 ID。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	OpenAI.FineTuningJob

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

Responses

创建响应 - 创建响应流

POST {endpoint}/openai/v1/responses

创建模型响应。创建模型响应（流式处理响应）。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选	违约
agent_reference	AgentReference		否
└─ 名称	字符串	代理的名称。约束： maxLength：256	是的
└─ 类型	枚举	可能的值：`agent_reference`	是的
└─ 版本	字符串	代理的版本标识符。	否
后台的	布尔值（可为 null）		否
对话	OpenAI.ConversationParam （可为 null）	此响应所属的对话。此会话中的项将追加到 `input_items` 此响应请求的前面。此响应完成后，将自动将此响应中的输入项和输出项添加到此对话中。	否
包括	OpenAI.IncludeEnum 的数组		否
输入	OpenAI.InputParam	用于生成响应的模型的文本、图像或文件输入。了解详细信息： - 文本输入输出 - 图像输入 - 文件输入 - 对话状态 - 函数调用	否
instructions	string （可为 null）		否
max_output_tokens	OpenAI.integer （可为 null）		否
max_tool_calls	OpenAI.integer （可为 null）		否
元数据	OpenAI.Metadata （可为 null）	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
模型	字符串	用于创建此响应的模型部署。	否
并行工具调用	布尔值（可为 null）		否	真实
previous_response_id	string （可为 null）		否
提示	OpenAI.Prompt	对提示模板及其变量的引用。了解更多。	否
prompt_cache_key	字符串	OpenAI 用于缓存类似请求的响应，以优化缓存命中率。替换 `user` 字段。了解更多。	否
prompt_cache_retention	枚举	可能的值： `in-memory24h`	否
reasoning	OpenAI.Reasoning （可为 null）	仅 gpt-5 和 o 系列模型配置选项用于推理模型。	否
努力	OpenAI.ReasoningEffort	限制推理模型。目前支持的值为 `none`、 `minimal`、 `low`、 `mediumhighxhigh`、和。减少推理努力可能会导致更快的响应和更少的标记使用于响应中的推理。 - `gpt-5.1` 默认为 `none`不执行推理。支持的 `gpt-5.1` 推理值为 `none`、 `low`、 `medium`和 `high`。 gpt-5.1 中的所有推理值都支持工具调用。 - 在默认为`gpt-5.1`推理工作之前`medium`的所有模型，并且不支持`none`。 - 模型 `gpt-5-pro` 默认为（且仅支持） `high` 推理工作。之后的所有模型都支持 < a0/> 。	否
生成摘要	枚举	可能的值：`auto`、、 `concisedetailed`	否
~~ 摘要	枚举	可能的值：`auto`、、 `concisedetailed`	否
safety_identifier	字符串	用于帮助检测可能违反 OpenAI 使用策略的应用程序的用户的稳定标识符。 ID 应该是唯一标识每个用户的字符串。建议对其用户名或电子邮件地址进行哈希处理，以避免向我们发送任何标识信息。了解更多。	否
服务等级	OpenAI.ServiceTier	指定用于为请求提供服务的处理类型。 - 如果设置为“自动”，则请求将在 Project 设置中配置的服务层级进行处理。除非另有配置，Project 将使用“默认”。 - 如果设置为“default”，则将使用所选模型的标准定价和性能来处理请求。 - 如果设置为“flex”或“priority”，则请求将以相应的服务层级处理。 - 如果未设置，默认行为为“auto”。 `service_tier`设置参数后，响应正文将`service_tier`包含基于实际用于处理请求的处理模式的值。此响应值可能与参数中设置的值不同。	否
存储	布尔值（可为 null）		否	真实
数据流	布尔值（可为 null）		否
stream_options	OpenAI.ResponseStreamOptions （可为 null）	流式处理响应的选项。仅在设置 `stream: true` 时设置此项。	否
include_obfuscation	布尔	如果为 true，将启用流混淆。流模糊处理添加流式传输增量事件的字段的随机字符`obfuscation` 将有效负载大小规范化为缓解某些侧通道攻击。默认情况下包括这些模糊字段，但添加少量内容数据流的开销。可以将设置为`include_obfuscation` 如果信任两者之间的网络链接，则为 false 以优化带宽应用程序和 OpenAI API。	否
structured_inputs	对象	可以参与提示模板替换或工具参数绑定的响应的结构化输入。	否
温度	OpenAI.numeric （可为 null）		否	1
文本消息	OpenAI.ResponseTextParam	来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。了解详细信息： - 文本输入输出 - 结构化输出	否
tool_choice	OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceParam		否
工具	OpenAI.ToolsArray	生成响应时，模型可能会调用的工具数组。你可以通过设置 `tool_choice` 参数来指定要使用的工具。我们支持以下类别的工具： - 内置工具：OpenAI 提供的工具，用于扩展模型的功能，比如Web Search 或file search。详细了解内置工具。 - MCP 工具：通过自定义 MCP 服务器与第三方系统集成或预定义的连接器，如 Google Drive 和 SharePoint。详细了解 MCP 工具。 - 函数调用（自定义工具）：由你定义的函数，使模型能够使用强类型参数调用自己的代码和输出。详细了解函数调用。还可以使用用于调用自己的代码的自定义工具。	否
top_logprobs	OpenAI.integer （可为 null）		否
top_p	OpenAI.numeric （可为 null）		否	1
truncation	枚举	可能的值： `autodisabled`	否
用户	string （已弃用）	此字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。改用 `prompt_cache_key` 来维护缓存优化。最终用户的稳定标识符。用于通过更好地存储类似的请求来提升缓存命中率，并帮助 OpenAI 检测和防止滥用。了解更多。	否

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	OpenAI.Response
text/event-stream	OpenAI.CreateResponseStreamingResponse

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

列出响应

GET {endpoint}/openai/v1/responses

返回所有响应的列表。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
limit	查询	否	整数	要返回的对象数的限制。限制可以介于 1 和 100 之间，以及默认值为 20。
顺序	查询	否	字符串可能的值： `ascdesc`	按 `created_at` 对象的时间戳排序顺序。升序为 `asc`，降序为 `desc` 。
after	查询	否	字符串	用于分页的游标。 `after` 是一个对象 ID，用于定义你在列表中的位置。例如，如果发出列表请求并接收 100 个对象，以 obj_foo 结尾，则后续调用可以包括 after=obj_foo，以便提取列表的下一页。
before	查询	否	字符串	用于分页的游标。 `before` 是一个对象 ID，用于定义你在列表中的位置。例如，如果发出列表请求并接收 100 个对象，以 obj_foo 结尾，则后续调用可以包括 before=obj_foo，以便提取列表中的上一页内容。
agent_name	查询	否	字符串	按代理名称筛选。如果提供，则仅返回与指定代理关联的项。
agent_id	查询	否	字符串	按格式 `name:version`的代理 ID 进行筛选。如果提供，则仅返回与指定代理 ID 关联的项。
conversation_id	查询	否	字符串	按对话 ID 进行筛选。如果提供，则仅返回与指定会话关联的响应。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	对象	请求的项列表的响应数据。

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

压缩响应对话

POST {endpoint}/openai/v1/responses/compact

生成响应对话的压缩。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选
输入	OpenAI.InputItem 的字符串或数组		否
instructions	string （可为 null）		否
模型	OpenAI.ModelIdsCompaction	用于生成响应的模型 ID，例如 `gpt-5` 或 `o3`。 OpenAI 提供了各种具有不同功能、性能特性和价格点的模型。请参阅模型指南，浏览和比较可用模型。	是的
previous_response_id	string （可为 null）		否

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	OpenAI.CompactResource

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

获取响应 - 获取响应流

GET {endpoint}/openai/v1/responses/{response_id}

检索具有给定 ID 的模型响应。检索具有给定 ID（流式处理响应）的模型响应。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
response_id	路径	是的	字符串
include[]	查询	否	数组
数据流	查询	否	布尔
starting_after	查询	否	整数

请求标头

姓名	必选	类型	Description
接受	假	字符串可能的值：`text/event-stream`

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	OpenAI.Response
text/event-stream	OpenAI.CreateResponseStreamingResponse

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

删除响应

DELETE {endpoint}/openai/v1/responses/{response_id}

删除模型响应。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
response_id	路径	是的	字符串	要删除的响应的 ID。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	DeleteResponseResult

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

取消响应

POST {endpoint}/openai/v1/responses/{response_id}/cancel

取消模型响应。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
response_id	路径	是的	字符串	要取消的响应的 ID。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	OpenAI.Response

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

列出输入项

GET {endpoint}/openai/v1/responses/{response_id}/input_items

返回给定响应的输入项的列表。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
response_id	路径	是的	字符串
limit	查询	否	整数	要返回的对象数的限制。限制可以介于 1 和 100 之间，以及默认值为 20。
顺序	查询	否	字符串可能的值： `ascdesc`	按 `created_at` 对象的时间戳排序顺序。升序为 `asc`，降序为 `desc` 。
after	查询	否	字符串	用于分页的游标。 `after` 是一个对象 ID，用于定义你在列表中的位置。例如，如果发出列表请求并接收 100 个对象，以 obj_foo 结尾，则后续调用可以包括 after=obj_foo，以便提取列表的下一页。
before	查询	否	字符串	用于分页的游标。 `before` 是一个对象 ID，用于定义你在列表中的位置。例如，如果发出列表请求并接收 100 个对象，以 obj_foo 结尾，则后续调用可以包括 before=obj_foo，以便提取列表中的上一页内容。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	对象	请求的项列表的响应数据。

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

Redteams

Redteams - 列表

GET {endpoint}/redTeams/runs?api-version=v1

按名称列出 redteam。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`RedTeams=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	PagedRedTeam

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

红队 - 获取

GET {endpoint}/redTeams/runs/{name}?api-version=v1

按名称获取 redteam。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	红队运行的标识符。

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`RedTeams=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	RedTeam

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

红队 - 创建

POST {endpoint}/redTeams/runs:run?api-version=v1

创建 redteam 运行。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`RedTeams=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选	违约
applicationScenario	字符串	应用场景为红队作，生成场景特定的攻击。	否
attackStrategies	AttackStrategy 数组	攻击策略列表或攻击策略的嵌套列表。	否
displayName	字符串	红队运行的名称。	否
id	string （只读）	红队运行的标识符。	是的
numTurns	整数	模拟轮次数。	否
属性	对象	红队的属性。与标记不同，属性是仅添加属性。添加后，无法删除属性。	否
riskCategories	RiskCategory 数组	要为其生成攻击目标的风险类别列表。	否
simulationOnly	布尔	仅仿真或仿真 + 评估。默认为 false，如果为 true，则扫描输出对话而不是评估结果。	否	假
状态	string （只读）	红队的状态。它由服务设置，并且是只读的。	否
tags	对象	红队的标签。与属性不同，标记完全可变。	否
目标	TargetConfig	目标配置的抽象类。	是的
└─ 类型	字符串	模型配置的类型。	是的

Responses

状态代码： 201

说明：请求已成功，因此创建了一个新资源。

内容类型	类型	说明
application/json	RedTeam

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

附表

计划 - 列表

GET {endpoint}/schedules?api-version=v1

列出所有时间表。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
类型	查询	否	字符串可能的值： `EvaluationInsight`	按计划类型进行筛选。
enabled	查询	否	布尔	按已启用状态进行筛选。

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`Schedules=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	PagedSchedule

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

计划 - 删除

DELETE {endpoint}/schedules/{id}?api-version=v1

删除计划。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
id	路径	是的	字符串	计划的标识符。

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`Schedules=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

Responses

状态代码： 204

说明：没有要为此请求发送的内容，但标头可能很有用。

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

计划 - 获取

GET {endpoint}/schedules/{id}?api-version=v1

通过 id 获取时间表。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
id	路径	是的	字符串	计划的标识符。

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`Schedules=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	Schedule

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

计划 - 创建或更新

PUT {endpoint}/schedules/{id}?api-version=v1

创建或更新作模板。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
id	路径	是的	字符串	计划的标识符。

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`Schedules=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

请求主体

“内容类型”: application/json

姓名	类型	Description	必选
说明	字符串	计划的描述。	否
displayName	字符串	计划名称。	否
enabled	布尔	计划的已启用状态。	是的
id	string （只读）	计划的标识符。	是的
属性	对象	Schedule 的属性。与标记不同，属性是仅添加属性。添加后，无法删除属性。	否
provisioning状态	ScheduleProvisioningStatus （只读）	计划配置状态。	否
系统数据	对象（只读）	资源的系统元数据。	是的
tags	对象	Schedule 的标签。与属性不同，标记完全可变。	否
任务	ScheduleTask	计划任务模型。	是的
~~ 配置	对象	任务的配置。	否
└─ 类型	ScheduleTaskType	任务的类型。	是的
触发	Trigger	计划触发器的基本模型。	是的
└─ 类型	TriggerType	触发器的类型。	是的

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	Schedule

状态代码： 201

说明：请求已成功，因此创建了一个新资源。

内容类型	类型	说明
application/json	Schedule

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

计划 - 列表运行

GET {endpoint}/schedules/{id}/runs?api-version=v1

列出所有计划运行。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
id	路径	是的	字符串	计划的标识符。
类型	查询	否	字符串可能的值： `EvaluationInsight`	按计划类型进行筛选。
enabled	查询	否	布尔	按已启用状态进行筛选。

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`Schedules=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	PagedScheduleRun

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	Azure。Core.Foundations.ErrorResponse

响应标头：

Header	类型	Description
x-ms-error-code	字符串	指示问题所在的字符串错误代码。

计划 - 获取运行

GET {endpoint}/schedules/{schedule_id}/runs/{run_id}?api-version=v1

获取按 id 运行的计划。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串	Foundry Project 端点的形式 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。如果你在Foundry Hub里只有一个Project，或者想针对默认的Project 在中心内，使用窗体 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project”
schedule_id	路径	是的	字符串	计划的唯一标识符。
run_id	路径	是的	字符串	计划运行的唯一标识符。
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Foundry-Features	真实	字符串可能的值：`Schedules=V1Preview`	使用预览作或修改持久预览资源时所需的功能标志选择加入。

Responses

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	ScheduleRun

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	ApiErrorResponse

Components

A2APreviewTool

实现 A2A 协议的代理。

姓名	类型	Description	必选
agent_card_path	字符串	代理卡相对于的 `base_url`路径。如果未提供，则默认为 `/.well-known/agent-card.json`	否
base_url	字符串	代理的基本 URL。	否
project_connection_id	字符串	A2A服务器的project中的连接ID。该连接存储连接到 A2A 服务器所需的身份验证和其他连接详细信息。	否
类型	枚举	工具的类型。始终为 `"a2a_preview`。可能的值：`a2a_preview`	是的

AISearchIndexResource

AI 搜索索引资源。

姓名	类型	Description	必选
筛选器	字符串	搜索资源的 filter 字符串。了解更多信息请点击这里。	否
index_asset_id	字符串	为搜索资源的资产 ID 编制索引。	否
索引名称	字符串	附加到此代理的 IndexResource 中的索引的名称。	否
project_connection_id	字符串	附加到此代理的 IndexResource 中的索引连接 ID。	否
查询类型	AzureAISearchQueryType	Azure AI Search 工具可用的查询类型。	否
top_k	整数	要从搜索中检索到的文档数，并将其呈现到模型。	否

AgentClusterInsightRequest

对代理评估结果集的见解

姓名	类型	Description	必选
agentName （代理名称）	字符串	代理的标识符。	是的
modelConfiguration	InsightModelConfiguration	见解生成中使用的模型的配置。	否
~~ modelDeploymentName	字符串	要评估的模型部署。单独接受部署名称或连接名称为 `{connectionName}/<modelDeploymentName>`.	是的
类型	枚举	请求的类型。可能的值：`AgentClusterInsight`	是的

AgentClusterInsightResult

来自代理集群分析的见解。

姓名	类型	Description	必选	违约
clusterInsight	ClusterInsightResult	来自聚类分析的见解。	是的
类型	枚举	见解结果的类型。可能的值：`AgentClusterInsight`	是的

AgentContainerObject

特定代理版本的容器的详细信息。

姓名	类型	Description	必选
容器	ContainerDetails （只读）	有关容器的详细信息。	否
health_state	字符串	容器的运行状况。	是的
provisioning_error	字符串	容器的预配错误（如果有）。	否
provisioning_state	字符串	容器的预配状态。	是的
~~ 副本	ContainerReplica 数组	容器中的副本列表。	是的
~~ 状态	字符串	集装箱的状态。	是的
updated_on	字符串	容器的上次更新时间。	是的
创建时间	字符串	容器的创建时间。	是的
error_message	string （只读）	如果容器无法运行，则返回错误消息（如果有）。	否
id	string （只读）	容器的标识符。	否
max_replicas	整数	容器的最大副本数。默认值为 1。	否
min_replicas	整数	容器的最小副本数。默认值为 1。	否
对象	枚举	对象类型，始终为“agent.container”。可能的值：`agent.container`	是的
状态	AgentContainerStatus （只读）	特定代理版本的容器的状态。	是的
updated_at	字符串	容器的上次更新时间。	是的

AgentContainerOperationError

容器作的错误详细信息（如果有）。

姓名	类型	Description	必选
代码	字符串	容器作的错误代码（如果有）。	是的
消息	字符串	容器作的错误消息（如果有）。	是的
类型	字符串	容器作的错误类型（如果有）。	是的

AgentContainerOperationObject

特定版本的代理的容器作。

姓名	类型	Description	必选
agent_id	字符串	代理的 ID。	是的
agent_version_id	字符串	代理版本的 ID。	是的
容器	AgentContainerObject	特定代理版本的容器的详细信息。	否
~~ 容器	ContainerDetails （只读）	详细的容器信息。	否
created_at	string （只读）	容器的创建时间。	是的
error_message	string （只读）	如果容器无法运行，则返回错误消息（如果有）。	否
└─ 身份	string （只读）	容器的标识符。	否
max_replicas	整数	容器的最大副本数。默认值为 1。	否
min_replicas	整数	容器的最小副本数。默认值为 1。	否
~~ 对象	枚举	对象类型，始终为“agent.container”。可能的值：`agent.container`	是的
└─ 状态	AgentContainerStatus （只读）	特定代理版本的容器的状态。	是的
updated_at	string （只读）	容器的上次更新时间。	是的
错误	AgentContainerOperationError	容器作的错误详细信息（如果有）。	否
└─ 代码	字符串	容器作的错误代码（如果有）。	是的
└─ 消息	字符串	容器作的错误消息（如果有）。	是的
└─ 类型	字符串	容器作的错误类型（如果有）。	是的
id	字符串	容器作的 ID。此 ID 是整个系统的唯一标识符。	是的
状态	AgentContainerOperationStatus	特定版本的代理的容器作的状态。	是的

AgentContainerOperationStatus

特定版本的代理的容器作的状态。

资产	价值
类型	字符串
价值观	`NotStarted` `InProgress` `Succeeded` `Failed`

AgentContainerStatus

特定代理版本的容器的状态。

资产	价值
类型	字符串
价值观	`Starting` `Running` `Stopping` `Stopped` `Failed` `Deleting` `Deleted` `Updating`

AgentDefinition

AgentDefinition 的鉴别器

此组件使用属性 kind 区分不同类型的：

类型值	Schema
`prompt`	PromptAgentDefinition
`workflow`	WorkflowAgentDefinition
`hosted`	HostedAgentDefinition
`container_app`	ContainerAppAgentDefinition

姓名	类型	Description	必选
kind	AgentKind		是的
rai_config	RaiConfig	负责任 AI （RAI）内容筛选和安全功能的配置。	否
rai_policy_name	字符串	要应用的 RAI 策略的名称。	是的

AgentKind

资产	价值
类型	字符串
价值观	`prompt` `hosted` `container_app` `workflow`

AgentObject

姓名	类型	Description	必选
id	字符串	代理的唯一标识符。	是的
姓名	字符串	代理的名称。约束： maxLength：63	是的
对象	枚举	对象类型，始终为“代理”。可能的值：`agent`	是的
versions	对象	代理的最新版本。	是的
~~ 最新	AgentVersionObject		是的

AgentProtocol

资产	价值
类型	字符串
价值观	`activity_protocol` `responses`

代理参考

姓名	类型	Description	必选
姓名	字符串	代理的名称。约束： maxLength：256	是的
类型	枚举	可能的值：`agent_reference`	是的
版本	字符串	代理的版本标识符。	否

AgentTaxonomyInput

当输入类型为代理时，评估分类的输入配置。

姓名	类型	Description	必选
riskCategories	RiskCategory 数组	要评估的风险类别列表。	是的
目标	目标	具有鉴别器支持的目标的基类。	是的
└─ 类型	字符串	目标的类型。	是的
类型	枚举	评估分类的输入类型。可能的值：`agent`	是的

AgentTaxonomyInputUpdate

当输入类型为代理时，评估分类的输入配置。

姓名	类型	Description	必选
riskCategories	RiskCategory 数组	要评估的风险类别列表。	否
目标	TargetUpdate	具有鉴别器支持的目标的基类。	否
└─ 类型	字符串	目标的类型。	是的
类型	枚举	评估分类的输入类型。可能的值：`agent`	是的

AgentVersionObject

姓名	类型	Description	必选
创建时间	整数	创建代理时的 Unix 时间戳（秒）。	是的
定义	AgentDefinition		是的
说明	字符串	代理的可读说明。约束： maxLength：512	否
id	字符串	代理版本的唯一标识符。	是的
元数据	对象（可为 null）	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	是的
姓名	字符串	代理的名称。 Name 可用于检索/更新/删除代理。约束： maxLength：256	是的
对象	枚举	对象类型，始终为“agent.version”。可能的值：`agent.version`	是的
版本	字符串	代理的版本标识符。代理是不可变的，每次更新都会创建一个新版本，同时保持名称相同。	是的

AgenticIdentityPreviewCredentials

代理身份凭证定义

姓名	类型	Description	必选	违约
类型	枚举	凭据类型可能的值：`AgenticIdentityToken_Preview`	是的

ApiErrorResponse

API 故障的错误响应。

姓名	类型	Description	必选	违约
错误	OpenAI.Error		是的

ApiKeyCredentials

API Key 凭证定义

姓名	类型	Description	必选	违约
关键值	string （只读）	API 密钥	否
类型	枚举	凭据类型可能的值：`ApiKey`	是的

AssetCredentialResponse

表示对 blob 的引用以供使用

姓名	类型	Description	必选
blobReference	BlobReference	Blob 引用详细信息。	是的
~~ blobUri	字符串	用于上传数据的客户端的 Blob URI 路径。示例：`https://blob.windows.core.net/Container/Path`	是的
~~ 凭据	SasCredential	access storage 账户的凭证信息。	是的
~~ storageAccountArmId	字符串	要用的是要用的 storage 账户的 ARM ID。	是的

AssetId

已保存资产的标识符。

类型：string

AttackStrategy

攻击策略。

资产	价值
说明	攻击策略。
类型	字符串
价值观	`easy` `moderate` `difficult` `ascii_art` `ascii_smuggler` `atbash` `base64` `binary` `caesar` `character_space` `jailbreak` `ansi_attack` `character_swap` `suffix_append` `string_join` `unicode_confusable` `unicode_substitution` `diacritic` `flip` `leetspeak` `rot13` `morse` `url` `baseline` `indirect_jailbreak` `tense` `multi_turn` `crescendo`

Azure。Core.Foundations.Error

错误对象。

姓名	类型	Description	必选
代码	字符串	服务器定义的错误代码集之一。	是的
details	Azure 的阵列。Core.Foundations.Error	导致此报告错误的特定错误的详细信息数组。	否
innererror	Azure。Core.Foundations.InnerError	包含有关错误的更具体信息的对象。根据Azure REST API指南——https://aka.ms/AzureRestApiGuidelines#handling-errors。	否
└─ 代码	字符串	服务器定义的错误代码集之一。	否
~~ innererror	Azure。Core.Foundations.InnerError	内部错误。	否
消息	字符串	有关错误的可读的表示形式。	是的
目标	字符串	错误的目标。	否

Azure。核心。基础。错误响应

包含错误详细信息的响应。

姓名	类型	Description	必选
错误	Azure。Core.Foundations.Error	错误对象。	是的
└─ 代码	字符串	服务器定义的错误代码集之一。	是的
~~ 详细信息	Azure 的阵列。Core.Foundations.Error	导致此报告错误的特定错误的详细信息数组。	否
~~ innererror	Azure。Core.Foundations.InnerError	包含与当前对象有关错误的更具体信息的对象。	否
└─ 消息	字符串	有关错误的可读的表示形式。	是的
~~ 目标	字符串	错误的目标。	否

Azure。核心.基础.内部错误

包含有关错误的更具体信息的对象。根据Azure REST API指南——https://aka.ms/AzureRestApiGuidelines#handling-errors。

姓名	类型	Description	必选
代码	字符串	服务器定义的错误代码集之一。	否
innererror	Azure。Core.Foundations.InnerError	包含有关错误的更具体信息的对象。根据Azure REST API指南——https://aka.ms/AzureRestApiGuidelines#handling-errors。	否
└─ 代码	字符串	服务器定义的错误代码集之一。	否
~~ innererror	Azure。Core.Foundations.InnerError	内部错误。	否

Azure。核心。基础。作状态

描述允许的作状态的枚举。

资产	价值
说明	描述允许的作状态的枚举。
类型	字符串
价值观	`NotStarted` `Running` `Succeeded` `Failed` `Canceled`

Azure。Core.uuid

通用唯一标识符

类型：string

格式：uuid

AzureAIAgentTarget

表示指定Azure AI代理的目标。

姓名	类型	Description	必选
姓名	字符串	Azure AI 代理的唯一标识符。	是的
tool_descriptions	ToolDescription 数组	用于控制文本生成期间代理的采样行为的参数。	否
类型	枚举	目标的类型，始终 `azure_ai_agent`。可能的值：`azure_ai_agent`	是的
版本	字符串	Azure AI 代理的版本。	否

AzureAIAgentTargetUpdate

表示指定Azure AI代理的目标。

姓名	类型	Description	必选
姓名	字符串	Azure AI 代理的唯一标识符。	否
tool_descriptions	ToolDescription 数组	用于控制文本生成期间代理的采样行为的参数。	否
类型	枚举	目标的类型，始终 `azure_ai_agent`。可能的值：`azure_ai_agent`	是的
版本	字符串	Azure AI 代理的版本。	否

AzureAIDataSourceConfig

姓名	类型	Description	必选
方案	枚举	数据架构方案。可能的值：`red_team`、`responses`、`traces_preview`、`synthetic_data_gen_preview`	是的
架构	对象	运行数据源项的总体对象 JSON 架构。	是的
类型	枚举	始终为 `azure_ai_source` 的对象类型。可能的值：`azure_ai_source`	是的

AzureAIModelTarget

表示一个目标，指定一个Azure AI模型用于需要模型选择的作。

姓名	类型	Description	必选
模型	字符串	Azure AI模型的唯一标识符。	否
采样参数	ModelSamplingParams	表示一组参数，用于在文本生成过程中控制语言模型的采样行为。	否
max_completion_tokens（最大完成标记数）	整数	完成中允许的最大令牌数。	是的
~~ 种子	整数	用于可重现的随机种子。	是的
~~ 温度	数字	采样的温度参数。	是的
top_p	数字	核采样的 top-p 参数。	是的
类型	枚举	目标的类型，始终 `azure_ai_model`。可能的值：`azure_ai_model`	是的

AzureAIModelTargetUpdate

表示一个目标，指定一个Azure AI模型用于需要模型选择的作。

姓名	类型	Description	必选
模型	字符串	Azure AI模型的唯一标识符。	否
采样参数	ModelSamplingParamsUpdate	表示一组参数，用于在文本生成过程中控制语言模型的采样行为。	否
max_completion_tokens（最大完成标记数）	整数	完成中允许的最大令牌数。	否
~~ 种子	整数	用于可重现的随机种子。	否
~~ 温度	数字	采样的温度参数。	否
top_p	数字	核采样的 top-p 参数。	否
类型	枚举	目标的类型，始终 `azure_ai_model`。可能的值：`azure_ai_model`	是的

AzureAIResponsesEvalRunDataSource

表示特定于持续评估方案的评估运行的数据源。

姓名	类型	Description	必选
event_configuration_id	字符串	与此评估运行关联的事件配置名称。	是的
item_generation_params	ResponseRetrievalItemGenerationParams	表示用于生成响应检索项的参数。	是的
data_mapping	对象	从源字段映射到response_id字段，检索聊天历史记录所必需的。	是的
max_num_turns	整数	要评估的聊天历史记录的最大轮次数。	是的
└─ 来源	OpenAI.EvalJsonlFileContentSource 或 OpenAI.EvalJsonlFileIdSource	从中读取 JSONL 内容的源。	是的
└─ 类型	枚举	项生成参数的类型，始终 `response_retrieval`为。可能的值：`response_retrieval`	是的
max_runs_hourly	整数	每小时允许的最大评估运行次数。	是的
类型	枚举	数据源的类型，始终 `azure_ai_responses`为。可能的值：`azure_ai_responses`	是的

Azure人工智能搜索索引

Azure AI Search Index Definition

姓名	类型	Description	必选
id	string （只读）	资产 ID，资产的唯一标识符	否
姓名	string （只读）	资源的名称	是的
类型	枚举	索引类型可能的值：`AzureSearch`	是的
版本	string （只读）	资源的版本	是的

AzureAISearchIndexUpdate

Azure AI Search Index Definition

姓名	类型	Description	必选
说明	字符串	资产说明文本。	否
tags	对象	标记字典。可以添加、删除和更新标记。	否
类型	枚举	索引类型可能的值：`AzureSearch`	是的

AzureAISearchQueryType

Azure AI Search 工具可用的查询类型。

资产	价值
说明	Azure AI Search 工具可用的查询类型。
类型	字符串
价值观	`simple` `semantic` `vector` `vector_simple_hybrid` `vector_semantic_hybrid`

AzureAISearchTool

用于配置代理的Azure AI search工具的输入定义信息。

姓名	类型	Description	必选
azure_ai_search	AzureAISearchToolResource	`azure_ai_search` 工具使用的一组索引资源。	是的
~~ 索引	AISearchIndexResource 数组	附加到此代理的索引。最多可以有 1 个索引附加到代理的资源。约束： maxItems：1	是的
类型	枚举	对象类型，始终为“azure_ai_search”。可能的值：`azure_ai_search`	是的

AzureAISearchToolResource

azure_ai_search 工具使用的一组索引资源。

姓名	类型	Description	必选	违约
指标	AISearchIndexResource 数组	附加到此代理的索引。最多可以有 1 个索引附加到代理的资源。	是的

AzureFunctionBinding

保留 storage 队列名称和 URI 的结构。

姓名	类型	Description	必选
storage_queue	AzureFunctionStorageQueue	保留 storage 队列名称和 URI 的结构。	是的
queue_name	字符串	Azure 函数 storage 队列的名称。	是的
queue_service_endpoint	字符串	URI连接到Azure Storage队列服务，允许你作队列。	是的
类型	枚举	绑定的类型，始终为“storage_queue”。可能的值：`storage_queue`	是的

AzureFunctionDefinition

Azure函数的定义。

姓名	类型	Description	必选
函数	对象	azure函数及其参数的定义。	是的
└─ 说明	字符串	函数作用的描述，由模型用于选择何时以及如何调用函数。	否
└─ 名称	字符串	要调用的函数的名称。	是的
└─ 参数	对象	函数接受的参数，被描述为 JSON 架构对象。	是的
input_binding	AzureFunctionBinding	保留 storage 队列名称和 URI 的结构。	是的
storage_queue	AzureFunctionStorageQueue	Storage队列。	是的
└─ 类型	枚举	绑定的类型，始终为“storage_queue”。可能的值：`storage_queue`	是的
output_binding	AzureFunctionBinding	保留 storage 队列名称和 URI 的结构。	是的
storage_queue	AzureFunctionStorageQueue	Storage队列。	是的
└─ 类型	枚举	绑定的类型，始终为“storage_queue”。可能的值：`storage_queue`	是的

AzureFunctionStorageQueue

保留 storage 队列名称和 URI 的结构。

姓名	类型	Description	必选	违约
queue_name	字符串	Azure 函数 storage 队列的名称。	是的
queue_service_endpoint	字符串	URI连接到Azure Storage队列服务，允许你作队列。	是的

AzureFunctionTool

输入定义信息，用于配置 Agent 的 Azure 函数工具。

姓名	类型	Description	必选
azure_function	AzureFunctionDefinition	Azure函数的定义。	是的
~~ 函数	对象	azure函数及其参数的定义。	是的
└─ 说明	字符串	函数作用的描述，由模型用于选择何时以及如何调用函数。	否
└─ 名称	字符串	要调用的函数的名称。	是的
└─ 参数	对象	函数接受的参数，被描述为 JSON 架构对象。	是的
input_binding	AzureFunctionBinding	输入storage队列。队列storage触发器在添加消息时执行一个函数。	是的
output_binding	AzureFunctionBinding	输出storage队列。处理输入项时，该函数会将输出写入此队列。	是的
类型	枚举	对象类型，始终为“browser_automation”。可能的值：`azure_function`	是的

AzureOpenAIModelConfiguration

Azure OpenAI 模型配置. API 版本将由服务选择以查询模型。

姓名	类型	Description	必选	违约
modelDeploymentName	字符串	AOAI 模型的部署名称。示例：gpt-4o，如果在 AIServices 或基于连接（ `connection_name/deployment_name` 例如 `my-aoai-connection/gpt-4o`）。	是的
类型	枚举	可能的值：`AzureOpenAIModel`	是的

BaseCredentials

连接凭证的基类

BaseCredentials 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`ApiKey`	ApiKeyCredentials
`AAD`	EntraIDCredentials
`CustomKeys`	CustomCredential
`SAS`	SASCredentials
`None`	NoAuthenticationCredentials
`AgenticIdentityToken_Preview`	AgenticIdentityPreviewCredentials

姓名	类型	Description	必选	违约
类型	CredentialType （只读）	连接使用的凭证类型	是的

BingCustomSearchConfiguration

一个 bing 自定义搜索配置。

姓名	类型	Description	必选
计数	整数	bing api 响应中应返回的搜索结果数量	否
freshness	字符串	按特定时间范围筛选搜索结果。请参见接受值。	否
instance_name	字符串	给定用于配置的自定义配置实例的名称。	是的
市场	字符串	结果来源的市场。	否
project_connection_id	字符串	Project 连接 ID 用于 bing 搜索接地	是的
set_lang	字符串	调用 Bing API 时用于用户界面字符串的语言。	否

BingCustomSearchPreviewTool

用于配置代理的Bing自定义搜索工具的输入定义信息。

姓名	类型	Description	必选
bing_custom_search_preview	BingCustomSearchToolParameters	bing 自定义搜索工具参数。	是的
search_configurations	BingCustomSearchConfiguration 的数组	该工具关联到project connections。最多可以有 1 个连接附加到该工具的资源。约束： maxItems：1	是的
类型	枚举	对象类型，始终是“bing_custom_search_preview”。可能的值：`bing_custom_search_preview`	是的

BingCustomSearchToolParameters

bing 自定义搜索工具参数。

姓名	类型	Description	必选	违约
search_configurations	BingCustomSearchConfiguration 的数组	该工具关联到project connections。最多可以有 1 个连接附加到该工具的资源。	是的

BingGroundingSearchConfiguration

Bing 接地的搜索配置

姓名	类型	Description	必选
计数	整数	bing api 响应中应返回的搜索结果数量	否
freshness	字符串	按特定时间范围筛选搜索结果。请参见接受值。	否
市场	字符串	结果来源的市场。	否
project_connection_id	字符串	Project 连接 ID 用于 bing 搜索接地	是的
set_lang	字符串	调用 Bing API 时用于用户界面字符串的语言。	否

BingGroundingSearchToolParameters

bing接地搜索工具参数。

姓名	类型	Description	必选	违约
search_configurations	BingGroundingSearchConfiguration 的数组	附加到此工具的搜索配置。最多可以有 1 个附加到该工具的搜索配置资源。	是的

BingGroundingTool

用于配置代理的bing接地搜索工具的输入定义信息。

姓名	类型	Description	必选
bing_grounding	BingGroundingSearchToolParameters	bing接地搜索工具参数。	是的
search_configurations	BingGroundingSearchConfiguration 的数组	附加到此工具的搜索配置。最多可以有 1 个附加到该工具的搜索配置资源。约束： maxItems：1	是的
类型	枚举	对象类型，始终为“bing_grounding”。可能的值：`bing_grounding`	是的

BlobReference

Blob 引用详细信息。

姓名	类型	Description	必选
blobUri	字符串	用于上传数据的客户端的 Blob URI 路径。示例：`https://blob.windows.core.net/Container/Path`	是的
凭据	SasCredential	SAS 凭证定义	是的
~~ sasUri	string （只读）	SAS URI	是的
└─ 类型	枚举	凭证类型可能的值：`SAS`	是的
storageAccountArmId	字符串	要用的是要用的 storage 账户的 ARM ID。	是的

BrowserAutomationPreviewTool

浏览器自动化工具的输入定义信息，用于配置代理。

姓名	类型	Description	必选
browser_automation_preview	BrowserAutomationToolParameters	浏览器自动化工具的输入参数的定义。	是的
~~ 连接	BrowserAutomationToolConnectionParameters	project 连接参数与浏览器自动化工具关联。	是的
类型	枚举	对象类型，始终是“browser_automation_preview”。可能的值：`browser_automation_preview`	是的

BrowserAutomationToolConnectionParameters

定义浏览器自动化工具使用的连接的输入参数。

姓名	类型	Description	必选	违约
project_connection_id	字符串	project 连接到你 Azure Playwright 资源的 ID。	是的

BrowserAutomationToolParameters

浏览器自动化工具的输入参数的定义。

姓名	类型	Description	必选	违约
连接	BrowserAutomationToolConnectionParameters	定义浏览器自动化工具使用的连接的输入参数。	是的
project_connection_id	字符串	project 连接到你 Azure Playwright 资源的 ID。	是的

CaptureStructuredOutputsTool

用于捕获结构化输出的工具

姓名	类型	Description	必选
outputs	StructuredOutputDefinition	代理可以生成的结构化输出。	是的
└─ 说明	字符串	要发出的输出的描述。模型用于确定何时发出输出。	是的
└─ 名称	字符串	结构化输出的名称。	是的
└─ 架构	对象	结构化输出的 JSON 架构。	是的
└─ 严格	布尔值（可为 null）	是否强制执行严格验证。默认 `true`。	是的
类型	枚举	工具的类型。始终为 `capture_structured_outputs`。可能的值：`capture_structured_outputs`	是的

ChartCoordinate

分析图表的坐标。

姓名	类型	Description	必选
大小	整数	图表元素的大小。	是的
x	整数	X 轴坐标。	是的
y	整数	Y 轴坐标。	是的

ChatSummaryMemoryItem

包含从对话中提取的摘要的记忆项。

姓名	类型	Description	必选
内容	字符串	内存的内容。	是的
kind	枚举	记忆项目的种类。可能的值：`chat_summary`	是的
memory_id	字符串	内存项的唯一 ID。	是的
作用域	字符串	在逻辑上对内存进行分组和隔离的命名空间，例如用户 ID。	是的
updated_at	整数	内存项目的最后更新时间。	是的

ClusterInsightResult

来自聚类分析的见解。

姓名	类型	Description	必选
clusters	InsightCluster 数组	见解中标识的群集列表。	是的
坐标	对象	可选地将 ID 映射到 UX 用于可视化的 2D 坐标。映射键是字符串标识符（例如群集 ID 或示例 ID）值是用于在二维图表上呈现的坐标和视觉大小。除非客户端请求坐标（例如，否则省略此属性通过传递 `includeCoordinates=true` 为查询参数）。示例： `<br> {<br> "cluster-1": { "x": 12, "y": 34, "size": 8 },<br> "sample-123": { "x": 18, "y": 22, "size": 4 }<br> }<br>` 坐标仅适用于客户端可视化效果，不用于修改规范见解结果。	否
摘要	InsightSummary	误差聚类分析的摘要。	是的
~~ 方法	字符串	用于聚类的方法。	是的
~~ sampleCount	整数	分析的样本总数。	是的
~~ uniqueClusterCount	整数	唯一集群的总数。	是的
~~ uniqueSubclusterCount	整数	唯一子集群标签的总数。	是的
└─ 用法	ClusterTokenUsage	执行聚类分析时的令牌使用情况	是的

ClusterTokenUsage

集群分析的令牌使用情况

姓名	类型	Description	必选
inputTokenUsage	整数	输入令牌使用	是的
outputTokenUsage	整数	输出令牌使用	是的
totalTokenUsage	整数	令牌总使用量	是的

CodeBasedEvaluatorDefinition

使用 python 代码定义基于代码的评估器

姓名	类型	Description	必选
code_text	字符串	评估器的内联代码文本	是的
data_schema	对象	评估者输入数据的 JSON 架构（草案 2020-12）。这包括类型、属性、必需等参数。	否
init_parameters	对象	评估器输入参数的 JSON 架构（草案 2020-12）。这包括类型、属性、必需等参数。	否
指标	对象	此评估器生成的输出指标列表	否
类型	枚举	可能的值：`code`	是的

CompletionMessageToolCallChunk

消息中的工具调用详细信息。

姓名	类型	Description	必选
函数	FunctionToolCall	函数工具调用的详细信息。	否
└─ 参数	字符串	用于调用函数的参数，由模型以 JSON 格式生成。	是的
└─ 名称	字符串	要调用的函数名称。	是的
id	字符串	工具调用的 ID。	是的
类型	枚举	工具调用的类型，始终为“function”。可能的值：`function`	是的

连接

来自列表的响应和获取连接作

姓名	类型	Description	必选
凭据	BaseCredentials （只读）	连接凭证的基类	是的
└─ 类型	CredentialType （只读）	连接使用的凭据类型	是的
id	string （只读）	由服务生成的连接的唯一标识符	是的
isDefault	布尔值（只读）	是否将连接标记为其类型的默认连接	是的
元数据	对象（只读）	连接的元数据	是的
姓名	string （只读）	由用户提供的连接的友好名称。	是的
目标	string （只读）	要用于此服务的连接 URL	是的
类型	ConnectionType （只读）	连接的类型（或类别）	是的

连接类型

连接的类型（或类别）

资产	价值
说明	连接的类型（或类别）
类型	字符串
价值观	`AzureOpenAI` `AzureBlob` `AzureStorageAccount` `CognitiveSearch` `CosmosDB` `ApiKey` `AppConfig` `AppInsights` `CustomKeys` `RemoteTool_Preview`

ContainerAppAgentDefinition

容器应用代理定义。

姓名	类型	Description	必选
container_app_resource_id	字符串	托管该代理的Azure容器应用的资源ID。不可跨版本更改。	是的
container_protocol_versions	ProtocolVersionRecord 数组	代理支持容器入口通信的协议。	是的
ingress_subdomain_suffix	字符串	向代理发送入口时应用于应用子域的后缀。这可以是标签（例如，“---current”）、特定修订版（例如，“--0000001”），也可以是空的，以使用容器应用的默认终结点。	是的
kind	枚举	可能的值：`container_app`	是的
rai_config	RaiConfig	负责任 AI （RAI）内容筛选和安全功能的配置。	否
rai_policy_name	字符串	要应用的 RAI 策略的名称。	是的

ContainerDetails

有关容器的详细信息。

姓名	类型	Description	必选
health_state	字符串	容器的运行状况。	是的
provisioning_error	字符串	容器的预配错误（如果有）。	否
provisioning_state	字符串	容器的预配状态。	是的
replicas	ContainerReplica 数组	容器中的副本列表。	是的
状态	字符串	集装箱的状态。	是的
updated_on	字符串	容器的上次更新时间。	是的

ContainerLogKind

从容器中流式传输的日志类型。

资产	价值
类型	字符串
价值观	`console` `system`

ContainerReplica

有关容器副本的信息。

姓名	类型	Description	必选
container_state	字符串	副本的容器状态。	是的
姓名	字符串	副本的名称。	是的
状态	字符串	副本的状态。	是的

ContinuousEvaluationRuleAction

用于持续评估的评估规则作。

姓名	类型	Description	必选
evalId	字符串	要向其添加持续评估运行的评估 ID。	是的
maxHourlyRuns	整数	每小时允许的最大评估运行次数。	否
类型	枚举	可能的值：`continuousEvaluation`	是的

CosmosDB索引

CosmosDB 矢量存储索引定义

姓名	类型	Description	必选
id	string （只读）	资产 ID，资产的唯一标识符	否
姓名	string （只读）	资源的名称	是的
类型	枚举	索引类型可能的值：`CosmosDBNoSqlVectorStore`	是的
版本	string （只读）	资源的版本	是的

CosmosDBIndexUpdate

CosmosDB 矢量存储索引定义

姓名	类型	Description	必选
说明	字符串	资产说明文本。	否
tags	对象	标记字典。可以添加、删除和更新标记。	否
类型	枚举	索引类型可能的值：`CosmosDBNoSqlVectorStore`	是的

CreateAgentFromManifestRequest

姓名	类型	Description	必选
说明	字符串	代理的可读说明。约束： maxLength：512	否
manifest_id	字符串	要从中导入代理版本的清单 ID。	是的
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
姓名	字符串	标识代理的唯一名称。 Name 可用于检索/更新/删除代理。 - 必须以字母数字字符开头和结尾， - 可以在中间包含连字符 - 不能超过 63 个字符。约束： maxLength：63	是的
parameter_values	对象	清单的输入将导致完全具体化代理。	是的

CreateAgentRequest

姓名	类型	Description	必选
定义	AgentDefinition		是的
~~ kind	AgentKind		是的
rai_config	RaiConfig	负责任 AI （RAI）内容筛选和安全功能的配置。	否
说明	字符串	代理的可读说明。约束： maxLength：512	否
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
姓名	字符串	标识代理的唯一名称。 Name 可用于检索/更新/删除代理。 - 必须以字母数字字符开头和结尾， - 可以在中间包含连字符 - 不能超过 63 个字符。约束： maxLength：63	是的

CreateAgentVersionFromManifestRequest

姓名	类型	Description	必选
说明	字符串	代理的可读说明。约束： maxLength：512	否
manifest_id	字符串	要从中导入代理版本的清单 ID。	是的
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
parameter_values	对象	清单的输入将导致完全具体化代理。	是的

CreateAgentVersionRequest

姓名	类型	Description	必选
定义	AgentDefinition		是的
~~ kind	AgentKind		是的
rai_config	RaiConfig	负责任 AI （RAI）内容筛选和安全功能的配置。	否
说明	字符串	代理的可读说明。约束： maxLength：512	否
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否

创建评估请求

姓名	类型	Description	必选
数据源配置	OpenAI.CreateEvalCustomDataSourceConfig 或 OpenAI.CreateEvalLogsDataSourceConfig 或 OpenAI.CreateEvalStoredCompletionsDataSourceConfig 或 AzureAIDataSourceConfig	用于评估运行的数据源的配置。指示计算中使用的数据的架构。	是的
元数据	OpenAI.Metadata （可为 null）	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
姓名	字符串	评估的名称。	否
属性	对象	一组不可变的 16 键值对，这些键值对可以附加到对象以存储其他信息。键是最大长度为 64 个字符的字符串。值为最大长度为 512 个字符的字符串。	否
测试标准	OpenAI.EvalGraderLabelModel 或 OpenAI.EvalGraderStringCheck 或 OpenAI.EvalGraderTextSimilarity 或 OpenAI.EvalGraderPython 或 OpenAI.EvalGraderScoreModel 或 EvalGraderAzureAIEvaluator 的数组	此组中所有评估运行的评分程序列表。评分器可以使用双花括号符号引用数据源中的变量，例如 `{{item.variable_name}}`。若要引用模型的输出，请使用 `sample` 命名空间（即 `{{sample.output_text}}`）。	是的

创建评估运行请求

姓名	类型	Description	必选
数据源	OpenAI.CreateEvalJsonlRunDataSource 或 OpenAI.CreateEvalCompletionsRunDataSource 或 OpenAI.CreateEvalResponsesRunDataSource 或 EvalRunDataSource	有关运行数据源的详细信息。	是的
元数据	OpenAI.Metadata （可为 null）	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
姓名	字符串	运行的名称。	否
属性	对象	一组不可变的 16 键值对，这些键值对可以附加到对象以存储其他信息。键是最大长度为 64 个字符的字符串。值为最大长度为 512 个字符的字符串。	否

CredentialType

连接使用的凭证类型

资产	价值
说明	连接使用的凭证类型
类型	字符串
价值观	`ApiKey` `AAD` `SAS` `CustomKeys` `None` `AgenticIdentityToken_Preview`

CronTrigger

基于 Cron 的触发器。

姓名	类型	Description	必选	违约
endTime	字符串	ISO 8601 格式的 cron 计划的结束时间。	否
表达式	字符串	Cron 表达式，用于定义计划频率。	是的
startTime	字符串	ISO 8601 格式的 cron 计划的开始时间。	否
timeZone	字符串	cron 计划的时区。	否	UTC
类型	枚举	可能的值：`Cron`	是的

CustomCredential

自定义凭证定义

姓名	类型	Description	必选	违约
类型	枚举	凭据类型可能的值：`CustomKeys`	是的

此对象还接受类型为：string 的其他属性

DailyRecurrenceSchedule

每日重复计划。

姓名	类型	Description	必选	违约
小时	整数数组	定期计划的小时数。	是的
类型	枚举	每日重复类型。可能的值：`Daily`	是的

DataSourceConfig

具有歧视性支持的运行数据源的基类。

DataSourceConfig 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema

姓名	类型	Description	必选	违约
架构	对象	运行数据源项的总体对象 JSON 架构。	是的
类型	字符串	数据源类型鉴别器。	是的

DatasetType

用于确定数据类型的枚举。

资产	价值
说明	用于确定数据类型的枚举。
类型	字符串
价值观	`uri_file` `uri_folder`

DatasetVersion

DatasetVersion 定义

DatasetVersion 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`uri_file`	FileDatasetVersion
`uri_folder`	FolderDatasetVersion

姓名	类型	Description	必选
connectionName （连接名称）	字符串	Azure Storage 账户连接名称。如果在创建 Dataset 之前未调用 startPendingUploadVersion，则为必需	否
dataUri	字符串	数据的 URI（示例）约束： minLength：1，模式： `[a-zA-Z0-9_]`	是的
id	string （只读）	资产 ID，资产的唯一标识符	否
isReference	布尔值（只读）	表示数据集是否包含对storage的引用，还是数据集本身管理storage。如果为 true，则删除数据集版本时不会删除基础数据	否
姓名	string （只读）	资源的名称	是的
类型	DatasetType	用于确定数据类型的枚举。	是的
版本	string （只读）	资源的版本	是的

DatasetVersionUpdate

DatasetVersion 定义

DatasetVersionUpdate 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`uri_file`	FileDatasetVersionUpdate
`uri_folder`	FolderDatasetVersionUpdate

姓名	类型	Description	必选
说明	字符串	资产说明文本。	否
tags	对象	标记字典。可以添加、删除和更新标记。	否
类型	DatasetType	用于确定数据类型的枚举。	是的

星期几

重复计划的一周中的几天。

资产	价值
说明	重复计划的一周中的几天。
类型	字符串
价值观	`Sunday` `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday`

DeleteAgentResponse

已删除的代理对象

姓名	类型	Description	必选
已删除	布尔	代理是否已成功删除。	是的
姓名	字符串	代理的名称。	是的
对象	枚举	对象类型。始终为“agent.deleted”。可能的值：`agent.deleted`	是的

DeleteAgentVersionResponse

已删除的代理版本对象

姓名	类型	Description	必选
已删除	布尔	代理是否已成功删除。	是的
姓名	字符串	代理的名称。	是的
对象	枚举	对象类型。始终为“agent.version.deleted”。可能的值：`agent.version.deleted`	是的
版本	字符串	代理的版本标识符。	是的

DeleteEvalResponse

已删除的计算对象

姓名	类型	Description	必选
已删除	布尔	是否成功删除了 eval。	是的
eval_id	字符串	eval 的 ID。	是的
对象	枚举	对象类型。始终为“eval.deleted”。可能的值：`eval.deleted`	是的

DeleteEvalRunResponse

已删除的计算运行对象。

姓名	类型	Description	必选
已删除	布尔	是否成功删除了 eval。	否
对象	枚举	对象类型。始终为“eval.deleted”。可能的值：`eval.deleted`	否
run_id	字符串	eval 的 ID。	否

DeleteMemoryStoreResponse

姓名	类型	Description	必选
已删除	布尔	内存存储是否已成功删除。	是的
姓名	字符串	内存存储的名称。	是的
对象	枚举	对象类型。始终“memory_store.deleted”。可能的值：`memory_store.deleted`	是的

DeleteResponseResult

删除响应作的结果。

姓名	类型	Description	必选
已删除	枚举	始终返回 true 可能的值：`True`	是的
id	字符串	作 ID。	是的
对象	枚举	始终返回“response”。可能的值：`response`	是的

部署

模型部署定义

部署的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`ModelDeployment`	ModelDeployment

姓名	类型	Description	必选	违约
姓名	string （只读）	部署的名称	是的
类型	DeploymentType		是的

DeploymentType

资产	价值
类型	字符串
价值观	`ModelDeployment`

EntraIDCredentials

Entra ID 凭证定义

姓名	类型	Description	必选	违约
类型	枚举	凭据类型可能的值：`AAD`	是的

Eval

具有数据源配置和测试条件的 Eval 对象。评估表示要为 LLM 集成完成的任务。例如：

提高聊天机器人的质量
了解聊天机器人如何处理客户支持
检查 o4-mini 是否比 gpt-4o 更适合我的用例

姓名	类型	Description	必选
创建时间	整数	创建 eval 时的 Unix 时间戳（以秒为单位）。	是的
created_by	字符串	创建运行的人员的名称。	否
数据源配置	OpenAI.CreateEvalCustomDataSourceConfig 或 OpenAI.CreateEvalLogsDataSourceConfig 或 OpenAI.CreateEvalStoredCompletionsDataSourceConfig 或 AzureAIDataSourceConfig	在评估运行中使用的数据源的配置。	是的
id	字符串	评估的唯一标识符。	是的
元数据	OpenAI.Metadata （可为 null）	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	是的
modified_at	integer		否
姓名	字符串	评估的名称。	是的
对象	枚举	对象类型。可能的值：`eval`	是的
属性	对象	一组不可变的 16 键值对，这些键值对可以附加到对象以存储其他信息。键是最大长度为 64 个字符的字符串。值为最大长度为 512 个字符的字符串。	否
测试标准	OpenAI.EvalGraderLabelModel 或 OpenAI.EvalGraderStringCheck 或 OpenAI.EvalGraderTextSimilarity 或 OpenAI.EvalGraderPython 或 OpenAI.EvalGraderScoreModel 或 EvalGraderAzureAIEvaluator 的数组	测试条件列表。	是的

EvalCsvFileIdSource

表示对上传的 CSV 文件的引用，该文件用作评估数据的源。

姓名	类型	Description	必选	违约
id	字符串	上传的 CSV 文件的标识符。	是的
类型	枚举	源的类型，始终 `file_id`。可能的值：`file_id`	是的

EvalCsvRunDataSource

表示用于评估运行的 CSV 数据源。

姓名	类型	Description	必选
源	EvalCsvFileIdSource	表示对上传的 CSV 文件的引用，该文件用作评估数据的源。	是的
└─ 身份	字符串	上传的 CSV 文件的标识符。	是的
└─ 类型	枚举	源的类型，始终 `file_id`。可能的值：`file_id`	是的
类型	枚举	数据源的类型，始终 `csv`为。可能的值：`csv`	是的

EvalGraderAzureAIEvaluator

姓名	类型	Description	必选
data_mapping	对象	要用于评估的模型。必须支持结构化输出。	否
evaluator_name	字符串	计算器的名称。	是的
evaluator_version	字符串	计算器的版本。如果未指定最新版本。	否
initialization_parameters	对象	计算的初始化参数。必须支持结构化输出。	否
姓名	字符串	评分程序的名称。	是的
类型	枚举	始终为 `azure_ai_evaluator` 的对象类型。可能的值：`azure_ai_evaluator`	是的

EvalResult

评估结果。

姓名	类型	Description	必选
姓名	字符串	支票名称	是的
通过	布尔	指示检查是通过还是失败	是的
分数	数字	分数	是的
类型	字符串	检查类型	是的

EvalRun

表示评估运行的架构。

姓名	类型	Description	必选
创建时间	整数	创建评估运行时的 Unix 时间戳（以秒为单位）。	是的
created_by	字符串	创建运行的人员的名称。	否
数据源	OpenAI.CreateEvalJsonlRunDataSource 或 OpenAI.CreateEvalCompletionsRunDataSource 或 OpenAI.CreateEvalResponsesRunDataSource 或 EvalRunDataSource	有关运行数据源的信息。	是的
错误	OpenAI.EvalApiError	一个对象，表示来自 Eval API 的错误响应。	是的
eval_id	字符串	关联的评估的标识符。	是的
id	字符串	评估运行的唯一标识符。	是的
元数据	OpenAI.Metadata （可为 null）	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	是的
模型	字符串	评估的模型（如果适用）。	是的
modified_at	integer		否
姓名	字符串	评估运行的名称。	是的
对象	枚举	对象的类型。始终为“eval.run”。可能的值：`eval.run`	是的
每模型使用量	OpenAI.EvalRunPerModelUsage 的数组	评估运行期间每个模型的使用情况统计信息。	是的
per_testing_criteria_results	OpenAI.EvalRunPerTestingCriteriaResults 的数组	评估运行期间应用的每个测试条件的结果。	是的
属性	对象	一组不可变的 16 键值对，这些键值对可以附加到对象以存储其他信息。键是最大长度为 64 个字符的字符串。值为最大长度为 512 个字符的字符串。	否
report_url	字符串	UI 仪表板上呈现的评估运行报告的 URL。	是的
result_counts	OpenAI.EvalRunResultCounts		是的
└─ 发生错误	OpenAI.integer		是的
~~ 失败	OpenAI.integer		是的
└─ 通过	OpenAI.integer		是的
~~ 总计	OpenAI.integer		是的
状态	字符串	评估运行的状态。	是的

EvalRunDataSource

具有歧视性支持的运行数据源的基类。

EvalRunDataSource 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	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

姓名	类型	Description	必选	违约
类型	字符串	数据源类型鉴别器。	是的

EvalRunOutputItem

表示评估运行输出项的架构。

姓名	类型	Description	必选
创建时间	整数	创建评估运行时的 Unix 时间戳（以秒为单位）。	是的
数据源项	对象	输入数据源项的详细信息。	是的
数据源_项目_ID	OpenAI.integer		是的
eval_id	字符串	评估组的标识符。	是的
id	字符串	评估运行输出项的唯一标识符。	是的
对象	枚举	对象的类型。始终为“eval.run.output_item”。可能的值：`eval.run.output_item`	是的
results	EvalRunOutputItemResult 的数组	此输出项的分级程序结果列表。	是的
run_id	字符串	与此输出项关联的评估运行的标识符。	是的
示例	OpenAI.EvalRunOutputItemSample		是的
~~ 错误	OpenAI.EvalApiError	一个对象，表示来自 Eval API 的错误响应。	是的
finish_reason	字符串		是的
└─ 输入	EvalRunOutputItemSampleInput 的数组		是的
max_completion_tokens（最大完成标记数）	OpenAI.integer		是的
└─ 模型	字符串		是的
└─ 输出	EvalRunOutputItemSampleOutput 的数组		是的
~~ 种子	OpenAI.integer		是的
~~ 温度	OpenAI.numeric		是的
top_p	OpenAI.numeric		是的
└─ 用法	OpenAI.EvalRunOutputItemSampleUsage		是的
状态	字符串	评估运行的状态。	是的

EvalRunOutputItemResult

评估运行输出项的单个评分器结果。

姓名	类型	Description	必选
标签	字符串	与测试条件指标（例如“pass”、“fail”、“good”、“bad”）关联的标签。	否
指标	字符串	指标的名称（例如“fluency”、“f1_score”）。	否
姓名	字符串	评分程序的名称。	是的
通过	布尔	评分员是否将输出视为一个通行证。	是的
属性	对象	有关测试条件指标的其他详细信息。	否
原因	字符串	测试条件指标的原因。	否
示例	对象（可为 null）	评分者生成的可选示例或中间数据。	否
分数	OpenAI.numeric		是的
阈值	数字	用于确定此测试条件的通过/失败的阈值（如果为数值）。	否
类型	字符串	评分程序类型（例如，“string-check-grader”）。	否

此对象还接受其他属性。

EvalRunOutputItemSampleInput

评估运行中的消息。

姓名	类型	Description	必选
内容	字符串		是的
角色	字符串		是的
tool_calls	CompletionMessageToolCallChunk 数组	消息中发出的工具调用（如果有）。	是的

EvalRunOutputItemSampleOutput

评估运行中的消息。

姓名	类型	Description	必选
内容	字符串		否
角色	字符串		否
tool_calls	CompletionMessageToolCallChunk 数组	消息中发出的工具调用（如果有）。	是的

EvalRunResultCompareItem

治疗与基线的指标比较。

姓名	类型	Description	必选
deltaEstimate	数字	治疗与基线之间的估计差异。	是的
pValue	数字	治疗效果的 P 值。	是的
treatmentEffect	TreatmentEffectType	治疗效果类型。	是的
treatmentRunId	字符串	治疗运行 ID。	是的
treatmentRunSummary	EvalRunResultSummary	评估运行中指标的汇总统计信息。	是的
~~ 平均值	数字	评估运行中指标的平均值。	是的
~~ runId	字符串	评估运行 ID。	是的
~~ sampleCount	整数	评估运行中的样本数。	是的
~~ standardDeviation	数字	评估运行中指标的标准差。	是的

EvalRunResultComparison

治疗运行与基线的比较结果。

姓名	类型	Description	必选
baselineRunSummary	EvalRunResultSummary	评估运行中指标的汇总统计信息。	是的
~~ 平均值	数字	评估运行中指标的平均值。	是的
~~ runId	字符串	评估运行 ID。	是的
~~ sampleCount	整数	评估运行中的样本数。	是的
~~ standardDeviation	数字	评估运行中指标的标准差。	是的
compareItems	EvalRunResultCompareItem 的数组	每次治疗运行的比较结果列表。	是的
计算器	字符串	此测试标准的评估者名称。	是的
指标	字符串	正在评估的指标。	是的
testingCriteria	字符串	测试标准的名称。	是的

EvalRunResultSummary

评估运行中指标的汇总统计信息。

姓名	类型	Description	必选
平均	数字	评估运行中指标的平均值。	是的
runId	字符串	评估运行 ID。	是的
sampleCount	整数	评估运行中的样本数。	是的
standardDeviation	数字	评估运行中指标的标准差。	是的

EvaluationComparisonInsightRequest

评估比较请求

姓名	类型	Description	必选
baselineRunId	字符串	用于比较的基线运行 ID。	是的
evalId	字符串	评估的标识符。	是的
treatmentRunIds	字符串数组	用于比较的治疗运行 ID 列表。	是的
类型	枚举	请求的类型。可能的值：`EvaluationComparison`	是的

EvaluationComparisonInsightResult

评估比较的见解。

姓名	类型	Description	必选
比较	EvalRunResultComparison 的数组	每次治疗运行与基线的比较结果。	是的
方法	字符串	用于比较的统计方法。	是的
类型	枚举	见解结果的类型。可能的值：`EvaluationComparison`	是的

EvaluationResultSample

评估结果中的示例。

姓名	类型	Description	必选
correlationInfo	对象	有关分析样本相关性的信息。	是的
evaluationResult	EvalResult	评估结果。	是的
└─ 名称	字符串	支票名称	是的
└─ 通过	布尔	指示检查是通过还是失败	是的
~~ 分数	数字	分数	是的
└─ 类型	字符串	检查类型	是的
features	对象	有助于在 UX 中对数据进行额外过滤的功能。	是的
id	字符串	分析样本的唯一标识符。	是的
类型	枚举	评估结果样本类型可能的值：`EvaluationResultSample`	是的

评估规则

评估规则模型。

姓名	类型	Description	必选
操作	EvaluationRuleAction	评估行动模型。	是的
└─ 类型	EvaluationRuleActionType	评估作的类型。	是的
说明	字符串	评估规则的说明。	否
displayName	字符串	评估规则的显示名称。	否
enabled	布尔	指示是否启用了评估规则。默认值为 true。	是的
eventType	EvaluationRuleEventType	评估规则事件的类型。	是的
筛选器	EvaluationRuleFilter	评估筛选器模型。	否
~~ agentName	字符串	按代理名称筛选。	是的
id	string （只读）	评估规则的唯一标识符。	是的
系统数据	对象（只读）	评估规则的系统元数据。	是的

EvaluationRuleAction

评估行动模型。

EvaluationRuleAction 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`continuousEvaluation`	ContinuousEvaluationRuleAction
`humanEvaluationPreview`	HumanEvaluationPreviewRuleAction

姓名	类型	Description	必选	违约
类型	EvaluationRuleActionType	评估作的类型。	是的

EvaluationRuleActionType

评估作的类型。

资产	价值
说明	评估作的类型。
类型	字符串
价值观	`continuousEvaluation` `humanEvaluationPreview`

EvaluationRuleEventType

评估规则事件的类型。

资产	价值
说明	评估规则事件的类型。
类型	字符串
价值观	`responseCompleted` `manual`

EvaluationRuleFilter

评估筛选器模型。

姓名	类型	Description	必选	违约
agentName （代理名称）	字符串	按代理名称筛选。	是的

EvaluationRunClusterInsightRequest

对一组评估结果的见解

姓名	类型	Description	必选
evalId	字符串	见解的评估 ID。	是的
modelConfiguration	InsightModelConfiguration	见解生成中使用的模型的配置。	否
~~ modelDeploymentName	字符串	要评估的模型部署。单独接受部署名称或连接名称为 `{connectionName}/<modelDeploymentName>`.	是的
runIds	字符串数组	见解的评估运行 ID 列表。	是的
类型	枚举	见解请求的类型。可能的值：`EvaluationRunClusterInsight`	是的

EvaluationRunClusterInsightResult

来自评估运行集群分析的见解。

姓名	类型	Description	必选	违约
clusterInsight	ClusterInsightResult	来自聚类分析的见解。	是的
类型	枚举	见解结果的类型。可能的值：`EvaluationRunClusterInsight`	是的

EvaluationScheduleTask

计划的评估任务。

姓名	类型	Description	必选
配置	对象	任务的配置。	否
evalId	字符串	评估组的标识符。	是的
evalRun	对象	评估运行有效负载。	是的
类型	枚举	可能的值：`Evaluation`	是的

EvaluationTaxonomy

评估分类定义

姓名	类型	Description	必选
id	string （只读）	资产 ID，资产的唯一标识符	否
姓名	string （只读）	资源的名称	是的
属性	对象	评估分类的其他属性。	否
taxonomyCategories	TaxonomyCategory 数组	分类类别列表。	否
taxonomyInput	EvaluationTaxonomyInput	评估分类的输入配置。	是的
└─ 类型	EvaluationTaxonomyInputType	评估分类的输入类型。	是的
版本	string （只读）	资源的版本	是的

EvaluationTaxonomyCreateOrUpdate

评估分类定义

姓名	类型	Description	必选
说明	字符串	资产说明文本。	否
属性	对象	评估分类的其他属性。	否
tags	对象	标记字典。可以添加、删除和更新标记。	否
taxonomyCategories	TaxonomyCategory 数组	分类类别列表。	否
taxonomyInput	EvaluationTaxonomyInput	评估分类的输入配置。	是的
└─ 类型	EvaluationTaxonomyInputType	评估分类的输入类型。	是的

EvaluationTaxonomyInput

评估分类的输入配置。

EvaluationTaxonomyInput 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`agent`	AgentTaxonomyInput

姓名	类型	Description	必选	违约
类型	EvaluationTaxonomyInputType	评估分类输入的类型。	是的

EvaluationTaxonomyInputType

评估分类输入的类型。

资产	价值
说明	评估分类输入的类型。
类型	字符串
价值观	`agent` `policy`

EvaluationTaxonomyInputUpdate

评估分类的输入配置。

EvaluationTaxonomyInputUpdate 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`agent`	AgentTaxonomyInputUpdate

姓名	类型	Description	必选	违约
类型	EvaluationTaxonomyInputType	评估分类输入的类型。	是的

EvaluationTaxonomyUpdate

评估分类定义

姓名	类型	Description	必选
说明	字符串	资产说明文本。	否
属性	对象	评估分类的其他属性。	否
tags	对象	标记字典。可以添加、删除和更新标记。	否
taxonomyCategories	TaxonomyCategory 数组	分类类别列表。	否
taxonomyInput	EvaluationTaxonomyInputUpdate	评估分类的输入配置。	否
└─ 类型	EvaluationTaxonomyInputType	评估分类的输入类型。	是的

EvaluatorCategory

评估者的类别

资产	价值
说明	评估者的类别
类型	字符串
价值观	`quality` `safety` `agents`

EvaluatorDefinition

使用鉴别器的基本评估器配置

EvaluatorDefinition 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`code`	CodeBasedEvaluatorDefinition
`prompt`	PromptBasedEvaluatorDefinition

姓名	类型	Description	必选
data_schema	对象	评估者输入数据的 JSON 架构（草案 2020-12）。这包括类型、属性、必需等参数。	否
init_parameters	对象	评估器输入参数的 JSON 架构（草案 2020-12）。这包括类型、属性、必需等参数。	否
指标	对象	此评估器生成的输出指标列表	否
类型	EvaluatorDefinitionType	评估器定义的类型	是的

EvaluatorDefinitionType

评估器定义的类型

资产	价值
说明	评估器定义的类型
类型	字符串
价值观	`prompt` `code` `prompt_and_code` `service` `openai_graders`

EvaluatorMetric

评估器指标

姓名	类型	Description	必选
desirable_direction	EvaluatorMetricDirection	指标的方向指示值越高越好、值越低越好还是中性	否
is_primary	布尔	指示在有多个指标时此指标是否为主要指标。	否
max_value	数字	指标的最大值。如果未指定，则假定它是无界的。	否
min_value	数字	指标的最小值	否
类型	EvaluatorMetricType	评估器的类型	否

EvaluatorMetricDirection

指标的方向指示值越高越好、值越低越好还是中性

资产	价值
说明	指标的方向指示值越高越好、值越低越好还是中性
类型	字符串
价值观	`increase` `decrease` `neutral`

EvaluatorMetricType

评估器的类型

资产	价值
说明	评估器的类型
类型	字符串
价值观	`ordinal` `continuous` `boolean`

EvaluatorType

评估器的类型

资产	价值
说明	评估器的类型
类型	字符串
价值观	`builtin` `custom`

EvaluatorVersion

评估器定义

姓名	类型	Description	必选
categories	EvaluatorCategory 数组	评估者的类别	是的
创建时间	string （只读）	评估器的创建日期/时间	是的
created_by	string （只读）	评估器的创建者	是的
定义	EvaluatorDefinition	使用鉴别器的基本评估器配置	是的
data_schema	对象	评估者输入数据的 JSON 架构（草案 2020-12）。这包括类型、属性、必需等参数。	否
init_parameters	对象	评估器输入参数的 JSON 架构（草案 2020-12）。这包括类型、属性、必需等参数。	否
~~ 指标	对象	此评估器生成的输出指标列表	否
└─ 类型	EvaluatorDefinitionType	评估器定义的类型	是的
display_name	字符串	评估器的显示名称。在AI Foundry中，很容易找到评估者。它不需要是唯一的。	否
evaluator_type	EvaluatorType	评估器的类型	是的
id	string （只读）	资产 ID，资产的唯一标识符	否
元数据	对象	有关评估者的元数据	否
modified_at	string （只读）	评估员的最后修改日期/时间	是的
姓名	string （只读）	资源的名称	是的
版本	string （只读）	资源的版本	是的

EvaluatorVersionCreate

评估器定义

姓名	类型	Description	必选
categories	EvaluatorCategory 数组	评估者的类别	是的
定义	EvaluatorDefinition	使用鉴别器的基本评估器配置	是的
data_schema	对象	评估者输入数据的 JSON 架构（草案 2020-12）。这包括类型、属性、必需等参数。	否
init_parameters	对象	评估器输入参数的 JSON 架构（草案 2020-12）。这包括类型、属性、必需等参数。	否
~~ 指标	对象	此评估器生成的输出指标列表	否
└─ 类型	EvaluatorDefinitionType	评估器定义的类型	是的
说明	字符串	资产说明文本。	否
display_name	字符串	评估器的显示名称。在AI Foundry中，很容易找到评估者。它不需要是唯一的。	否
evaluator_type	EvaluatorType	评估器的类型	是的
元数据	对象	有关评估者的元数据	否
tags	对象	标记字典。可以添加、删除和更新标记。	否

EvaluatorVersionUpdate

评估器定义

姓名	类型	Description	必选
categories	EvaluatorCategory 数组	评估者的类别	否
说明	字符串	资产说明文本。	否
display_name	字符串	评估器的显示名称。在AI Foundry中，很容易找到评估者。它不需要是唯一的。	否
元数据	对象	有关评估者的元数据	否
tags	对象	标记字典。可以添加、删除和更新标记。	否

FabricDataAgentToolParameters

Fabric 数据代理工具参数。

姓名	类型	Description	必选	违约
project_connections	ToolProjectConnection 的数组	该工具关联到project connections。最多可以有 1 个连接附加到该工具的资源。	否

FileDatasetVersion

FileDatasetVersion 定义

姓名	类型	Description	必选
connectionName （连接名称）	字符串	Azure Storage 账户连接名称。如果在创建 Dataset 之前未调用 startPendingUploadVersion，则为必需	否
dataUri	字符串	数据的 URI（示例）约束： minLength：1，模式： `[a-zA-Z0-9_]`	是的
id	string （只读）	资产 ID，资产的唯一标识符	否
isReference	布尔值（只读）	表示数据集是否包含对storage的引用，还是数据集本身管理storage。如果为 true，则删除数据集版本时不会删除基础数据	否
姓名	string （只读）	资源的名称	是的
类型	枚举	数据集类型可能的值：`uri_file`	是的
版本	string （只读）	资源的版本	是的

FileDatasetVersionUpdate

FileDatasetVersion 定义

姓名	类型	Description	必选
说明	字符串	资产说明文本。	否
tags	对象	标记字典。可以添加、删除和更新标记。	否
类型	枚举	数据集类型可能的值：`uri_file`	是的

FolderDatasetVersion

FileDatasetVersion 定义

姓名	类型	Description	必选
connectionName （连接名称）	字符串	Azure Storage 账户连接名称。如果在创建 Dataset 之前未调用 startPendingUploadVersion，则为必需	否
dataUri	字符串	数据的 URI（示例）约束： minLength：1，模式： `[a-zA-Z0-9_]`	是的
id	string （只读）	资产 ID，资产的唯一标识符	否
isReference	布尔值（只读）	表示数据集是否包含对storage的引用，还是数据集本身管理storage。如果为 true，则删除数据集版本时不会删除基础数据	否
姓名	string （只读）	资源的名称	是的
类型	枚举	数据集类型可能的值：`uri_folder`	是的
版本	string （只读）	资源的版本	是的

FolderDatasetVersionUpdate

FileDatasetVersion 定义

姓名	类型	Description	必选
说明	字符串	资产说明文本。	否
tags	对象	标记字典。可以添加、删除和更新标记。	否
类型	枚举	数据集类型可能的值：`uri_folder`	是的

FunctionToolCall

函数工具调用的详细信息。

姓名	类型	Description	必选	违约
arguments	字符串	用于调用函数的参数，由模型以 JSON 格式生成。	是的
姓名	字符串	要调用的函数名称。	是的

HostedAgentDefinition

托管代理定义。

姓名	类型	Description	必选
container_protocol_versions	ProtocolVersionRecord 数组	代理支持容器入口通信的协议。	是的
中央处理器	字符串	托管代理的 CPU 配置。	是的
environment_variables	对象	要在托管代理容器中设置的环境变量。	否
图像	字符串	代理的映像 ID，适用于基于映像的托管代理。	否
kind	枚举	可能的值：`hosted`	是的
内存	字符串	托管代理的内存配置。	是的
rai_config	RaiConfig	负责任 AI （RAI）内容筛选和安全功能的配置。	否
rai_policy_name	字符串	要应用的 RAI 策略的名称。	是的
工具	OpenAI.Tool 数组	托管代理的模型在生成响应时可能调用的一系列工具。你可以通过设置 `tool_choice` 参数来指定要使用的工具。	否

HourlyRecurrenceSchedule

每小时重复计划。

姓名	类型	Description	必选	违约
类型	枚举	可能的值：`Hourly`	是的

HumanEvaluationPreviewRuleAction

用于人工评估的评估规则作。

姓名	类型	Description	必选	违约
模板ID	AssetId	已保存资产的标识符。	是的
类型	枚举	可能的值：`humanEvaluationPreview`	是的

Index

索引资源定义

索引的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`AzureSearch`	AzureAISearchIndex
`ManagedAzureSearch`	ManagedAzureAISearchIndex
`CosmosDBNoSqlVectorStore`	CosmosDBIndex

姓名	类型	Description	必选
id	string （只读）	资产 ID，资产的唯一标识符	否
姓名	string （只读）	资源的名称	是的
类型	IndexType		是的
版本	string （只读）	资源的版本	是的

IndexType

资产	价值
类型	字符串
价值观	`AzureSearch` `CosmosDBNoSqlVectorStore` `ManagedAzureSearch`

IndexUpdate

索引资源定义

IndexUpdate 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`AzureSearch`	AzureAISearchIndexUpdate
`ManagedAzureSearch`	ManagedAzureAISearchIndexUpdate
`CosmosDBNoSqlVectorStore`	CosmosDBIndexUpdate

姓名	类型	Description	必选
说明	字符串	资产说明文本。	否
tags	对象	标记字典。可以添加、删除和更新标记。	否
类型	IndexType		是的

洞察力

集群见解的响应正文。

姓名	类型	Description	必选
displayName	字符串	见解的用户友好显示名称。	是的
id	string （只读）	见解报表的唯一标识符。	是的
元数据	InsightsMetadata （只读）	有关见解的元数据。	是的
~~ completedAt	字符串	见解完成时的时间戳。	否
~~ createdAt	字符串	创建见解时的时间戳。	是的
申请	InsightRequest	见解报告的请求。	是的
└─ 类型	InsightType	请求的类型。	是的
结果	InsightResult （只读）	洞察的结果。	否
└─ 类型	InsightType	见解结果的类型。	是的
状态	Azure。Core.Foundations.OperationState（只读）	描述允许的作状态的枚举。	是的

InsightCluster

分析样本集群。

姓名	类型	Description	必选
说明	字符串	分析聚类的描述。	是的
id	字符串	分析聚类的 ID。	是的
标签	字符串	集群的标签	是的
样品	InsightSample 数组	属于此群集的样本列表。如果样本是子聚类的一部分，则为空。	否
subClusters	InsightCluster 数组	此集群中的子集群列表。如果不存在子集群，则为空。	否
建议	字符串	对集群的建议	是的
suggestionTitle	字符串	集群建议的标题	是的
weight	整数	分析聚类的权重。这表示聚类中的样本数。	是的

InsightModelConfiguration

见解生成中使用的模型的配置。

姓名	类型	Description	必选	违约
modelDeploymentName	字符串	要评估的模型部署。单独接受部署名称或连接名称为 `{connectionName}/<modelDeploymentName>`.	是的

InsightRequest

见解报告的请求。

InsightRequest 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`EvaluationRunClusterInsight`	EvaluationRunClusterInsightRequest
`AgentClusterInsight`	AgentClusterInsightRequest
`EvaluationComparison`	EvaluationComparisonInsightRequest

姓名	类型	Description	必选	违约
类型	InsightType	见解的请求。	是的

InsightResult

洞察的结果。

InsightResult 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`EvaluationComparison`	EvaluationComparisonInsightResult
`EvaluationRunClusterInsight`	EvaluationRunClusterInsightResult
`AgentClusterInsight`	AgentClusterInsightResult

姓名	类型	Description	必选	违约
类型	InsightType	见解的请求。	是的

InsightSample

分析中的样本。

InsightSample 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`EvaluationResultSample`	EvaluationResultSample

姓名	类型	Description	必选
correlationInfo	对象	有关分析样本相关性的信息。	是的
features	对象	有助于在 UX 中对数据进行额外过滤的功能。	是的
id	字符串	分析样本的唯一标识符。	是的
类型	SampleType	分析中使用的样品类型。	是的

InsightScheduleTask

计划的见解任务。

姓名	类型	Description	必选
配置	对象	任务的配置。	否
见解	洞察力	集群见解的响应正文。	是的
~~ displayName	字符串	见解的用户友好显示名称。	是的
└─ 身份	string （只读）	见解报表的唯一标识符。	是的
└─ 元数据	InsightsMetadata （只读）	有关见解报告的元数据。	是的
~~ 请求	InsightRequest	请求进行见解分析。	是的
~~ 结果	InsightResult （只读）	见解报告的结果。	否
~~ 状态	Azure。Core.Foundations.OperationState（只读）	见解的当前状态。	是的
类型	枚举	可能的值：`Insight`	是的

InsightSummary

误差聚类分析的摘要。

姓名	类型	Description	必选
方法	字符串	用于聚类的方法。	是的
sampleCount	整数	分析的样本总数。	是的
uniqueClusterCount	整数	唯一集群的总数。	是的
uniqueSubclusterCount	整数	唯一子集群标签的总数。	是的
使用情况	ClusterTokenUsage	集群分析的令牌使用情况	是的
~~ inputTokenUsage	整数	输入令牌使用	是的
~~ outputTokenUsage	整数	输出令牌使用	是的
~~ totalTokenUsage	整数	令牌总使用量	是的

InsightType

见解的请求。

资产	价值
说明	见解的请求。
类型	字符串
价值观	`EvaluationRunClusterInsight` `AgentClusterInsight` `EvaluationComparison`

InsightsMetadata

有关见解的元数据。

姓名	类型	Description	必选	违约
completedAt	字符串	见解完成时的时间戳。	否
createdAt	字符串	创建见解时的时间戳。	是的

ItemGenerationParams

表示用于控制项生成作的参数集。

ItemGenerationParams 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`red_team`	RedTeamItemGenerationParams
`red_team_seed_prompts`	RedTeamSeedPromptsItemGenerationParams
`red_team_taxonomy`	RedTeamTaxonomyItemGenerationParams
`response_retrieval`	ResponseRetrievalItemGenerationParams

姓名	类型	Description	必选	违约
类型	ItemGenerationParamsType	用于生成红色团队项的参数类型。	是的

ItemGenerationParamsType

用于生成红色团队项的参数类型。

资产	价值
说明	用于生成红色团队项的参数类型。
类型	字符串
价值观	`red_team` `response_retrieval` `red_team_seed_prompts` `red_team_taxonomy` `synthetic_data_gen_preview`

ManagedAzureAISearchIndex

Managed Azure AI Search Index Definition

姓名	类型	Description	必选
id	string （只读）	资产 ID，资产的唯一标识符	否
姓名	string （只读）	资源的名称	是的
类型	枚举	索引类型可能的值：`ManagedAzureSearch`	是的
版本	string （只读）	资源的版本	是的

ManagedAzureAISearchIndexUpdate

Managed Azure AI Search Index Definition

姓名	类型	Description	必选
说明	字符串	资产说明文本。	否
tags	对象	标记字典。可以添加、删除和更新标记。	否
类型	枚举	索引类型可能的值：`ManagedAzureSearch`	是的

MemoryItem

存储在内存存储中的单个内存项，包含内容和元数据。

MemoryItem 的鉴别器

此组件使用属性 kind 区分不同类型的：

类型值	Schema
`user_profile`	UserProfileMemoryItem
`chat_summary`	ChatSummaryMemoryItem

姓名	类型	Description	必选
内容	字符串	内存的内容。	是的
kind	MemoryItemKind	记忆项种类。	是的
memory_id	字符串	内存项的唯一 ID。	是的
作用域	字符串	在逻辑上对内存进行分组和隔离的命名空间，例如用户 ID。	是的
updated_at	整数	内存项目的最后更新时间。	是的

MemoryItemKind

记忆项种类。

资产	价值
说明	记忆项种类。
类型	字符串
价值观	`user_profile` `chat_summary`

MemoryOperation

表示对内存项执行的单个内存作（创建、更新或删除）。

姓名	类型	Description	必选
kind	MemoryOperationKind	内存作类型。	是的
memory_item	MemoryItem	存储在内存存储中的单个内存项，包含内容和元数据。	是的
└─ 内容	字符串	内存的内容。	是的
~~ kind	MemoryItemKind	记忆项目的种类。	是的
memory_id	字符串	内存项的唯一 ID。	是的
~~ 范围	字符串	在逻辑上对内存进行分组和隔离的命名空间，例如用户 ID。	是的
updated_at	整数	内存项目的最后更新时间。	是的

MemoryOperationKind

内存作类型。

资产	价值
说明	内存作类型。
类型	字符串
价值观	`create` `update` `delete`

MemorySearchItem

从内存搜索中检索到的内存项。

姓名	类型	Description	必选
memory_item	MemoryItem	存储在内存存储中的单个内存项，包含内容和元数据。	是的
└─ 内容	字符串	内存的内容。	是的
~~ kind	MemoryItemKind	记忆项目的种类。	是的
memory_id	字符串	内存项的唯一 ID。	是的
~~ 范围	字符串	在逻辑上对内存进行分组和隔离的命名空间，例如用户 ID。	是的
updated_at	整数	内存项目的最后更新时间。	是的

MemorySearchOptions

内存搜索选项。

姓名	类型	Description	必选	违约
max_memories	整数	要返回的最大内存项数。	否

MemorySearchPreviewTool

将记忆集成到代理中的工具。

姓名	类型	Description	必选	违约
memory_store_name	字符串	要使用的内存存储的名称。	是的
作用域	字符串	用于对内存进行分组和隔离的命名空间，例如用户 ID。限制可以检索或更新的记忆。使用特殊变量 `{{$userId}}` 将内存范围限定为当前登录的用户。	是的
search_options	MemorySearchOptions	内存搜索选项。	否
max_memories	整数	要返回的最大内存项数。	否
类型	枚举	工具的类型。始终为 `memory_search_preview`。可能的值：`memory_search_preview`	是的
update_delay	整数	不活动后更新内存之前的等待时间（秒）。默认值为 300。	否	300

MemorySearchToolCallItemParam

姓名	类型	Description	必选	违约
results	MemorySearchItem 数组	从内存搜索返回的结果。	否
类型	枚举	可能的值：`memory_search_call`	是的

MemorySearchToolCallItemResource

姓名	类型	Description	必选
agent_reference	AgentReference		否
└─ 名称	字符串	代理的名称。约束： maxLength：256	是的
└─ 类型	枚举	可能的值：`agent_reference`	是的
└─ 版本	字符串	代理的版本标识符。	否
response_id	字符串	创建项的响应。	否
results	MemorySearchItem 数组	从内存搜索返回的结果。	否
状态	枚举	内存搜索工具调用的状态。 `in_progress`、 `searching`、`completed`、`incomplete`或`failed` 可能的值：`in_progress`、、`searchingcompleted`、`incomplete`、`failed`	是的
类型	枚举	可能的值：`memory_search_call`	是的

MemoryStoreDefaultDefinition

默认内存存储实现。

姓名	类型	Description	必选	违约
chat_model	字符串	用于内存处理的聊天完成模型部署的名称或标识符。	是的
embedding_model	字符串	用于内存处理的嵌入模型部署的名称或标识符。	是的
kind	枚举	内存存储的类型。可能的值：`default`	是的
options	MemoryStoreDefaultOptions	默认内存存储配置。	否
chat_summary_enabled	布尔	是否启用聊天摘要提取和storage。默认值为 true。	是的	真实
user_profile_details	字符串	要提取和存储的特定类别或类型的用户配置文件信息。	否
user_profile_enabled	布尔	是否启用用户配置文件提取和storage。默认值为 true。	是的	真实

MemoryStoreDefaultOptions

默认内存存储配置。

姓名	类型	Description	必选	违约
chat_summary_enabled	布尔	是否启用聊天摘要提取和storage。默认值为 true。	是的	真实
user_profile_details	字符串	要提取和存储的特定类别或类型的用户配置文件信息。	否
user_profile_enabled	布尔	是否启用用户配置文件提取和storage。默认值为 true。	是的	真实

MemoryStoreDefinition

内存存储配置的基本定义。

MemoryStoreDefinition 的鉴别器

此组件使用属性 kind 区分不同类型的：

类型值	Schema
`default`	MemoryStoreDefaultDefinition

姓名	类型	Description	必选	违约
kind	MemoryStoreKind	要使用的内存存储实现的类型。	是的

MemoryStoreDeleteScopeResponse

从作用域中删除内存的响应。

姓名	类型	Description	必选
已删除	布尔	删除作是否成功。	是的
姓名	字符串	内存存储的名称。	是的
对象	枚举	对象类型。始终“memory_store.scope.deleted”。可能的值：`memory_store.scope.deleted`	是的
作用域	字符串	删除内存的范围。	是的

MemoryStoreKind

要使用的内存存储实现的类型。

资产	价值
说明	要使用的内存存储实现的类型。
类型	字符串
价值观	`default`

MemoryStoreObject

可以存储和检索用户记忆的内存存储。

姓名	类型	Description	必选
创建时间	整数	创建内存存储时的 Unix 时间戳（秒）。	是的
定义	MemoryStoreDefinition	内存存储配置的基本定义。	是的
~~ kind	MemoryStoreKind	内存存储的类型。	是的
说明	字符串	内存存储的人类可读描述。约束： maxLength：512	否
id	字符串	内存存储的唯一标识符。	是的
元数据	对象	要与内存存储关联的任意键值元数据。	否
姓名	字符串	内存存储的名称。约束： maxLength：256	是的
对象	枚举	对象类型，始终为“memory_store”。可能的值：`memory_store`	是的
updated_at	整数	上次更新内存存储时的 Unix 时间戳（秒）。	是的

MemoryStoreOperationUsage

内存存储作的使用情况统计信息。

姓名	类型	Description	必选
embedding_tokens	整数	嵌入令牌的数量。	是的
input_tokens	OpenAI.integer		是的
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		是的
cached_tokens	OpenAI.integer		是的
output_tokens	OpenAI.integer		是的
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		是的
reasoning_tokens	OpenAI.integer		是的
total_tokens	OpenAI.integer		是的

MemoryStoreSearchResponse

内存搜索响应。

姓名	类型	Description	必选
记忆	MemorySearchItem 数组	在搜索作期间找到的相关内存项目。	是的
search_id	字符串	此搜索请求的唯一 ID。在后续请求中previous_search_id使用此值来执行增量搜索。	是的
使用情况	MemoryStoreOperationUsage	内存存储作的使用情况统计信息。	是的
embedding_tokens	整数	嵌入令牌的数量。	是的
input_tokens	OpenAI.integer	输入令牌数。	是的
输入令牌详情	OpenAI.ResponseUsageInputTokensDetails	输入令牌的明细。	是的
输出标记 (output_tokens)	OpenAI.integer	输出标记数。	是的
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	输出令牌的明细。	是的
total_tokens	OpenAI.integer	使用的令牌总数。	是的

MemoryStoreUpdateCompletedResult

内存更新结果。

姓名	类型	Description	必选
memory_operations	MemoryOperation 数组	更新期间执行的各个内存作的列表。	是的
使用情况	MemoryStoreOperationUsage	内存存储作的使用情况统计信息。	是的
embedding_tokens	整数	嵌入令牌的数量。	是的
input_tokens	OpenAI.integer	输入令牌数。	是的
输入令牌详情	OpenAI.ResponseUsageInputTokensDetails	输入令牌的明细。	是的
输出标记 (output_tokens)	OpenAI.integer	输出标记数。	是的
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	输出令牌的明细。	是的
total_tokens	OpenAI.integer	使用的令牌总数。	是的

MemoryStoreUpdateResponse

提供内存存储更新作的状态。

姓名	类型	Description	必选
错误	OpenAI.Error		否
~~ additionalInfo	对象		否
└─ 代码	string （可为 null）		是的
~~ debugInfo	对象		否
~~ 详细信息	OpenAI.Error 数组		否
└─ 消息	字符串		是的
└─ 参数	string （可为 null）		否
└─ 类型	字符串		否
结果	MemoryStoreUpdateCompletedResult	内存更新结果。	否
memory_operations	MemoryOperation 数组	更新期间执行的各个内存作的列表。	是的
└─ 用法	MemoryStoreOperationUsage	与内存更新作关联的使用情况统计信息。	是的
状态	MemoryStoreUpdateStatus	内存存储更新作的状态。	是的
superseded_by	字符串	当状态为“已取代”时，作被取代的update_id。	否
update_id	字符串	此更新请求的唯一 ID。在后续请求中previous_update_id使用此值来执行增量更新。	是的

MemoryStoreUpdateStatus

内存存储更新作的状态。

资产	价值
类型	字符串
价值观	`queued` `in_progress` `completed` `failed` `superseded`

MicrosoftFabricPreviewTool

用于配置代理的 Microsoft Fabric 工具的输入定义信息。

姓名	类型	Description	必选
fabric_dataagent_preview	FabricDataAgentToolParameters	Fabric 数据代理工具参数。	是的
project_connections	ToolProjectConnection 的数组	该工具关联到project connections。最多可以有 1 个连接附加到该工具的资源。约束： maxItems：1	否
类型	枚举	对象类型，始终是“fabric_dataagent_preview”。可能的值：`fabric_dataagent_preview`	是的

ModelDeployment

模型部署定义

姓名	类型	Description	必选
capabilities	对象（只读）	已部署模型的功能	是的
connectionName （连接名称）	string （只读）	部署来自的连接的名称	否
modelName	string （只读）	Publisher 特定型号名称	是的
modelPublisher	string （只读）	已部署模型的publisher名称	是的
modelVersion	string （只读）	Publisher 特定版本的已部署模型	是的
姓名	string （只读）	部署的名称	是的
sku	Sku （只读）	Sku 信息	是的
~~ 容量	整数	Sku 容量	是的
~~ 系列	字符串	Sku 家族	是的
└─ 名称	字符串	Sku 名称	是的
~~ 大小	字符串	Sku 大小	是的
~~ 层	字符串	Sku 层	是的
类型	枚举	部署的类型可能的值：`ModelDeployment`	是的

ModelSamplingParams

表示一组参数，用于在文本生成过程中控制语言模型的采样行为。

姓名	类型	Description	必选
max_completion_tokens	整数	完成中允许的最大令牌数。	是的
seed	整数	用于可重现的随机种子。	是的
温度	数字	采样的温度参数。	是的
top_p	数字	核采样的 top-p 参数。	是的

ModelSamplingParamsUpdate

表示一组参数，用于在文本生成过程中控制语言模型的采样行为。

姓名	类型	Description	必选
max_completion_tokens	整数	完成中允许的最大令牌数。	否
seed	整数	用于可重现的随机种子。	否
温度	数字	采样的温度参数。	否
top_p	数字	核采样的 top-p 参数。	否

MonthlyRecurrenceSchedule

每月定期计划。

姓名	类型	Description	必选	违约
daysOfMonth	整数数组	定期计划的月份中的天数。	是的
类型	枚举	每月重复类型。可能的值：`Monthly`	是的

NoAuthenticationCredentials

不需要身份验证的凭据

姓名	类型	Description	必选	违约
类型	枚举	凭据类型可能的值：`None`	是的

OAuthConsentRequestOutputItem

从服务请求用户执行 OAuth 同意。

姓名	类型	Description	必选
agent_reference	AgentReference		否
└─ 名称	字符串	代理的名称。约束： maxLength：256	是的
└─ 类型	枚举	可能的值：`agent_reference`	是的
└─ 版本	字符串	代理的版本标识符。	否
consent_link	字符串	用户可用于执行 OAuth 同意的链接。	是的
id	字符串		是的
response_id	字符串	创建项的响应。	否
服务器标签	字符串	OAuth 同意请求的服务器标签。	是的
类型	枚举	可能的值：`oauth_consent_request`	是的

OneTimeTrigger

一次性触发器。

姓名	类型	Description	必选	违约
timeZone	字符串	一次性触发器的时区。	否	UTC
triggerAt	字符串	ISO 8601 格式的一次性触发器的日期和时间。	是的
类型	枚举	可能的值：`OneTime`	是的

OpenAI.Annotation

应用于输出文本范围的批注。

OpenAI.Annotation 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`file_citation`	OpenAI.FileCitationBody
`url_citation`	OpenAI.UrlCitationBody
`container_file_citation`	OpenAI.ContainerFileCitationBody
`file_path`	OpenAI.FilePath

姓名	类型	Description	必选	违约
类型	OpenAI.AnnotationType		是的

OpenAI.AnnotationType

资产	价值
类型	字符串
价值观	`file_citation` `url_citation` `container_file_citation` `file_path`

OpenAI.ApplyPatchCallOutputStatus

资产	价值
类型	字符串
价值观	`completed` `failed`

OpenAI.ApplyPatchCallOutputStatusParam

apply_patch工具调用输出的结果值报告。

资产	价值
类型	字符串
价值观	`completed` `failed`

OpenAI.ApplyPatchCallStatus

资产	价值
类型	字符串
价值观	`in_progress` `completed`

OpenAI.ApplyPatchCallStatusParam

apply_patch工具调用时报告的状态值。

资产	价值
类型	字符串
价值观	`in_progress` `completed`

OpenAI.ApplyPatchCreateFileOperation

说明如何通过 apply_patch 工具创建文件。

姓名	类型	Description	必选
差异	字符串	要应用的差异。	是的
路径	字符串	要创建的文件的路径。	是的
类型	枚举	使用提供的差异创建新文件。可能的值：`create_file`	是的

OpenAI.ApplyPatchCreateFileOperationParam

通过apply_patch工具创建新文件的说明。

姓名	类型	Description	必选
差异	字符串	创建文件时应用统一差异内容。约束： maxLength：10485760	是的
路径	字符串	相对于工作区根创建的文件路径。约束： minLength：1	是的
类型	枚举	作类型。始终为 `create_file`。可能的值：`create_file`	是的

OpenAI.ApplyPatchDeleteFileOperation

说明如何通过apply_patch工具删除文件。

姓名	类型	Description	必选	违约
路径	字符串	要删除的文件的路径。	是的
类型	枚举	删除指定的文件。可能的值：`delete_file`	是的

OpenAI.ApplyPatchDeleteFileOperationParam

通过apply_patch工具删除现有文件的说明。

姓名	类型	Description	必选	违约
路径	字符串	相对于工作区根节点，文件要删除的路径。约束： minLength：1	是的
类型	枚举	作类型。始终为 `delete_file`。可能的值：`delete_file`	是的

OpenAI.ApplyPatchFileOperation

通过apply_patch应用的create_file、delete_file或update_file作之一。

OpenAI.ApplyPatchFileOperation 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`create_file`	OpenAI.ApplyPatchCreateFileOperation
`delete_file`	OpenAI.ApplyPatchDeleteFileOperation
`update_file`	OpenAI.ApplyPatchUpdateFileOperation

姓名	类型	Description	必选	违约
类型	OpenAI.ApplyPatchFileOperationType		是的

OpenAI.ApplyPatchFileOperationType

资产	价值
类型	字符串
价值观	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchOperationParam

apply_patch工具中提供create_file、delete_file或update_file作之一。

OpenAI.ApplyPatchOperationParam 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`create_file`	OpenAI.ApplyPatchCreateFileOperationParam
`delete_file`	OpenAI.ApplyPatchDeleteFileOperationParam
`update_file`	OpenAI.ApplyPatchUpdateFileOperationParam

姓名	类型	Description	必选	违约
类型	OpenAI.ApplyPatchOperationParamType		是的

OpenAI.ApplyPatchOperationParamType

资产	价值
类型	字符串
价值观	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchToolParam

允许助手使用统一差异创建、删除或更新文件。

姓名	类型	Description	必选	违约
类型	枚举	工具的类型。始终为 `apply_patch`。可能的值：`apply_patch`	是的

OpenAI.ApplyPatchUpdateFileOperation

说明如何通过 apply_patch 工具更新文件。

姓名	类型	Description	必选
差异	字符串	要应用的差异。	是的
路径	字符串	要更新的文件的路径。	是的
类型	枚举	使用提供的差异更新现有文件。可能的值：`update_file`	是的

OpenAI.ApplyPatchUpdateFileOperationParam

通过apply_patch工具更新现有文件的说明。

姓名	类型	Description	必选
差异	字符串	统一的差异内容应用到现有文件上。约束： maxLength：10485760	是的
路径	字符串	文件相对于工作区根节点更新的路径。约束： minLength：1	是的
类型	枚举	作类型。始终为 `update_file`。可能的值：`update_file`	是的

OpenAI.ApproximateLocation

姓名	类型	Description	必选
城市	string （可为 null）		否
国家	string （可为 null）		否
区域	string （可为 null）		否
timezone	string （可为 null）		否
类型	枚举	位置近似的类型。始终为 `approximate`。可能的值：`approximate`	是的

OpenAI 聊天完成工具

可用于生成响应的函数工具。

姓名	类型	Description	必选	违约
函数	OpenAI.FunctionObject		是的
类型	枚举	工具的类型。目前仅支持 `function`。可能的值：`function`	是的

OpenAI.ChatModel

资产价值

类型字符串

价值观 gpt-5.2
gpt-5.2-2025-12-11
gpt-5.2-chat-latest
gpt-5.2-pro
gpt-5.2-pro-2025-12-11
gpt-5.1
gpt-5.1-2025-11-13
gpt-5.1-codex
gpt-5.1-mini
gpt-5.1-chat-latest
gpt-5
gpt-5-mini
gpt-5-nano
gpt-5-2025-08-07
gpt-5-mini-2025-08-07
gpt-5-nano-2025-08-07
gpt-5-chat-latest
gpt-4.1
gpt-4.1-mini
gpt-4.1-nano
gpt-4.1-2025-04-14
gpt-4.1-mini-2025-04-14
gpt-4.1-nano-2025-04-14
o4-mini
o4-mini-2025-04-16
o3
o3-2025-04-16
o3-mini
o3-mini-2025-01-31
o1
o1-2024-12-17
o1-preview
o1-preview-2024-09-12
o1-mini
o1-mini-2024-09-12
gpt-4o
gpt-4o-2024-11-20
gpt-4o-2024-08-06
gpt-4o-2024-05-13
gpt-4o-audio-preview
gpt-4o-audio-preview-2024-10-01
gpt-4o-audio-preview-2024-12-17
gpt-4o-audio-preview-2025-06-03
gpt-4o-mini-audio-preview
gpt-4o-mini-audio-preview-2024-12-17
gpt-4o-search-preview
gpt-4o-mini-search-preview
gpt-4o-search-preview-2025-03-11
gpt-4o-mini-search-preview-2025-03-11
chatgpt-4o-latest
codex-mini-latest
gpt-4o-mini
gpt-4o-mini-2024-07-18
gpt-4-turbo
gpt-4-turbo-2024-04-09
gpt-4-0125-preview
gpt-4-turbo-preview
gpt-4-1106-preview
gpt-4-vision-preview
gpt-4
gpt-4-0314
gpt-4-0613
gpt-4-32k
gpt-4-32k-0314
gpt-4-32k-0613
gpt-3.5-turbo
gpt-3.5-turbo-16k
gpt-3.5-turbo-0301
gpt-3.5-turbo-0613
gpt-3.5-turbo-1106
gpt-3.5-turbo-0125
gpt-3.5-turbo-16k-0613

OpenAI.ClickButtonType

资产	价值
类型	字符串
价值观	`left` `right` `wheel` `back` `forward`

OpenAI.ClickParam

单击操作。

姓名	类型	Description	必选
button	OpenAI.ClickButtonType		是的
类型	枚举	指定事件类型。对于点击动作，该性质总是 `click`为。可能的值：`click`	是的
x	OpenAI.integer		是的
y	OpenAI.integer		是的

OpenAI.CodeInterpreterContainerAuto

代码解释器容器的配置。（可选）指定要运行代码的文件 ID。

姓名	类型	Description	必选
file_ids	字符串数组	可提供给代码使用的已上传文件的一个可选列表。	否
内存限制	OpenAI.ContainerMemoryLimit （可为 null）		否
类型	枚举	始终为 `auto`。可能的值：`auto`	是的

OpenAI.CodeInterpreterOutputImage

代码解释器的图像输出。

姓名	类型	Description	必选	违约
类型	枚举	输出的类型。始终为 `image`。可能的值：`image`	是的
url	字符串	代码解释器的图像输出的 URL。	是的

OpenAI.CodeInterpreterOutputLogs

代码解释器输出的日志。

姓名	类型	Description	必选	违约
日志	字符串	代码解释器输出的日志。	是的
类型	枚举	输出的类型。始终为 `logs`。可能的值：`logs`	是的

OpenAI.CodeInterpreterTool

运行 Python 代码以帮助生成对提示的响应的工具。

姓名	类型	Description	必选	违约
容器	string 或 OpenAI.CodeInterpreterContainerAuto	代码解释器容器。可以是容器 ID 或对象指定上传的文件 ID 供代码使用，以及可选 `memory_limit` 设置。如果未提供，该服务将假定为自动。	否
类型	枚举	代码解释器工具的类型。始终为 `code_interpreter`。可能的值：`code_interpreter`	是的

OpenAI.CompactResource

姓名	类型	Description	必选
创建时间	整数	创建压缩对话时的 Unix 时间戳（以秒为单位）。	是的
id	字符串	压缩响应的唯一标识符。	是的
对象	枚举	对象类型。始终为 `response.compaction`。可能的值：`response.compaction`	是的
输出	OpenAI.OutputItem 数组	输出项的压缩列表。这是所有用户消息的列表，后跟单个压缩项。	是的
使用情况	OpenAI.ResponseUsage	表示令牌使用情况详细信息，包括输入令牌、输出令牌、输出令牌的细分以及所使用的令牌总数。	是的
input_tokens	OpenAI.integer	输入令牌数。	是的
输入令牌详情	OpenAI.ResponseUsageInputTokensDetails	输入令牌的明细。	是的
输出标记 (output_tokens)	OpenAI.integer	输出标记数。	是的
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	输出令牌的明细。	是的
total_tokens	OpenAI.integer	使用的令牌总数。	是的

OpenAI.CompactResponseMethodPublicBody

姓名	类型	Description	必选
输入	OpenAI.InputItem 的字符串或数组		否
instructions	string （可为 null）		否
模型	OpenAI.ModelIdsCompaction	用于生成响应的模型 ID，例如 `gpt-5` 或 `o3`。 OpenAI 提供了各种具有不同功能、性能特性和价格点的模型。请参阅模型指南，浏览和比较可用模型。	是的
previous_response_id	string （可为 null）		否

OpenAI.ComparisonFilter（比较过滤器）

用于使用定义的比较操作来比较指定属性键与给定值的筛选器。

姓名	类型	Description	必选
关键值	字符串	要与值进行比较的键。	是的
类型	枚举	指定比较算符：`eq`，， `ne`， `gtgtelt`， `lte`， `in`，。 `nin` - `eq`：等于 - `ne`：不等于 - `gt`：大于 - `gte`：大于或等于 - `lt`：小于 - `lte`：小于或等于 - `in`：in - `nin`：不在可能的值：`eq`、、`ne`、`gtgte`、`lt`、`lte`	是的
value	string 或 OpenAI.numeric 或 boolean 或 array of OpenAI.ComparisonFilterValueItems	要与属性键进行比较的值;支持字符串、数字或布尔类型。	是的

OpenAI.ComparisonFilterValueItems

类型：字符串或 OpenAI.numeric

OpenAI.复合过滤器

使用 and 或 or. 合并多个筛选器。

姓名	类型	Description	必选	违约
filters	OpenAI.ComparisonFilter 或对象的数组	要组合的筛选器数组。项可以是 `ComparisonFilter` 或 `CompoundFilter`。	是的
类型	枚举	操作类型：`and` 或 `or`。可能的值： `andor`	是的

OpenAI.ComputerAction

OpenAI.ComputerAction 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`click`	OpenAI.ClickParam
`double_click`	OpenAI.DoubleClickAction
`drag`	OpenAI.Drag
`keypress`	OpenAI.KeyPressAction
`move`	OpenAI.Move
`screenshot`	OpenAI.屏幕截图
`scroll`	OpenAI.Scroll
`type`	OpenAI.Type
`wait`	OpenAI.Wait

姓名	类型	Description	必选	违约
类型	OpenAI.ComputerActionType		是的

OpenAI.ComputerActionType

资产	价值
类型	字符串
价值观	`click` `double_click` `drag` `keypress` `move` `screenshot` `scroll` `type` `wait`

OpenAI.ComputerCallSafetyCheckParam

计算机调用的挂起安全检查。

姓名	类型	Description	必选
代码	string （可为 null）		否
id	字符串	挂起的安全检查的 ID。	是的
消息	string （可为 null）		否

OpenAI.ComputerEnvironment

资产	价值
类型	字符串
价值观	`windows` `mac` `linux` `ubuntu` `browser`

OpenAI.ComputerScreenshotContent

计算机的屏幕截图。

姓名	类型	Description	必选
file_id	string （可为 null）		是的
image_url	字符串		是的
类型	枚举	指定事件类型。对于计算机屏幕截图，此属性始终设置为 `computer_screenshot`。可能的值：`computer_screenshot`	是的

OpenAI.ComputerScreenshotImage

与计算机使用工具一起使用的计算机屏幕截图图像。

姓名	类型	Description	必选
file_id	字符串	包含屏幕截图的上传文件的标识符。	否
image_url	字符串	屏幕截图图像的 URL。	否
类型	枚举	指定事件类型。对于计算机屏幕截图，此属性为始终设置为 `computer_screenshot`。可能的值：`computer_screenshot`	是的

OpenAI.ComputerUsePreviewTool

控制虚拟计算机的工具。

姓名	类型	Description	必选
显示高度	OpenAI.integer		是的
显示宽度	OpenAI.integer		是的
环境	OpenAI.ComputerEnvironment		是的
类型	枚举	计算机使用工具的类型。始终为 `computer_use_preview`。可能的值：`computer_use_preview`	是的

OpenAI.ContainerFileCitationBody

用于生成模型响应的容器文件引用。

姓名	类型	Description	必选
container_id	字符串	容器文件的ID。	是的
end_index	OpenAI.integer		是的
file_id	字符串	文件的 ID。	是的
filename	字符串	引用的容器文件文件名。	是的
start_index	OpenAI.integer		是的
类型	枚举	容器文件引用的类型。始终为 `container_file_citation`。可能的值：`container_file_citation`	是的

OpenAI.ContainerMemoryLimit

资产	价值
类型	字符串
价值观	`1g` `4g` `16g` `64g`

OpenAI.ConversationItem

对话中的单个项。可能的类型集与 outputResponse 对象的类型相同。

OpenAI.ConversationItem 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`message`	OpenAI.ConversationItemMessage
`function_call`	OpenAI.ConversationItemFunctionToolCallResource
`function_call_output`	OpenAI.ConversationItemFunctionToolCallOutputResource
`file_search_call`	OpenAI.ConversationItemFileSearchToolCall
`web_search_call`	OpenAI.ConversationItemWebSearchToolCall
`image_generation_call`	OpenAI.ConversationItemImageGenToolCall
`computer_call`	OpenAI.ConversationItemComputerToolCall
`computer_call_output`	OpenAI.ConversationItemComputerToolCallOutputResource
`reasoning`	OpenAI.ConversationItemReasoningItem
`code_interpreter_call`	OpenAI.ConversationItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.ConversationItemLocalShellToolCall
`local_shell_call_output`	OpenAI.ConversationItemLocalShellToolCallOutput
`shell_call`	OpenAI.ConversationItemFunctionShellCall
`shell_call_output`	OpenAI.ConversationItemFunctionShellCallOutput
`apply_patch_call`	OpenAI.ConversationItemApplyPatchToolCall
`apply_patch_call_output`	OpenAI.ConversationItemApplyPatchToolCallOutput
`mcp_list_tools`	OpenAI.ConversationItemMcpListTools
`mcp_approval_request`	OpenAI.ConversationItemMcpApprovalRequest
`mcp_approval_response`	OpenAI.ConversationItemMcpApprovalResponseResource
`mcp_call`	OpenAI.ConversationItemMcpToolCall
`custom_tool_call`	OpenAI.ConversationItemCustomToolCall
`custom_tool_call_output`	OpenAI.ConversationItemCustomToolCallOutput

姓名	类型	Description	必选	违约
类型	OpenAI.ConversationItemType		是的

OpenAI.ConversationItemApplyPatchToolCall

通过创建、删除或更新文件来应用文件差异的工具调用。

姓名	类型	Description	必选
call_id	字符串	模型生成的应用补丁工具调用的唯一ID。	是的
created_by	字符串	创建此工具调用的实体的 ID。	否
id	字符串	应用修补工具调用的唯一 ID。通过 API 返回此项时进行填充。	是的
操作	OpenAI.ApplyPatchFileOperation	通过apply_patch应用的create_file、delete_file或update_file作之一。	是的
└─ 类型	OpenAI.ApplyPatchFileOperationType		是的
状态	OpenAI.ApplyPatchCallStatus		是的
类型	枚举	项类型。始终为 `apply_patch_call`。可能的值：`apply_patch_call`	是的

OpenAI.ConversationItemApplyPatchToolCallOutput

应用修补工具调用发出的输出。

姓名	类型	Description	必选
call_id	字符串	模型生成的应用补丁工具调用的唯一ID。	是的
created_by	字符串	创建此工具的实体的 ID 调用输出。	否
id	字符串	应用修补工具调用输出的唯一 ID。通过 API 返回此项时进行填充。	是的
输出	string （可为 null）		否
状态	OpenAI.ApplyPatchCallOutputStatus		是的
类型	枚举	项类型。始终为 `apply_patch_call_output`。可能的值：`apply_patch_call_output`	是的

OpenAI.ConversationItemCodeInterpreterToolCall

用于运行代码的工具调用。

姓名	类型	Description	必选
代码	string （可为 null）		是的
container_id	字符串	用于运行代码的容器的 ID。	是的
id	字符串	代码解释器工具调用的唯一 ID。	是的
outputs	OpenAI.CodeInterpreterOutputLogs 或 OpenAI.CodeInterpreterOutputImage 的数组		是的
状态	枚举	代码解释器工具调用的状态。有效值为 `in_progress`、`completed`、`incomplete`、`interpreting` 和 `failed`。可能的值：`in_progress`、、`completedincomplete`、`interpreting`、`failed`	是的
类型	枚举	代码解释器工具调用的类型。始终为 `code_interpreter_call`。可能的值：`code_interpreter_call`	是的

OpenAI.ConversationItemComputerToolCall

对计算机使用工具的工具调用。更多信息请参见计算机使用指南。

姓名	类型	Description	必选
操作	OpenAI.ComputerAction		是的
call_id	字符串	用输出来响应工具调用时使用的标识符。	是的
id	字符串	计算机调用的唯一 ID。	是的
pending_safety_checks	OpenAI.ComputerCallSafetyCheckParam 的数组	计算机调用的挂起安全检查。	是的
状态	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	是的
类型	枚举	计算机调用的类型。始终为 `computer_call`。可能的值：`computer_call`	是的

OpenAI.ConversationItemComputerToolCallOutputResource

姓名	类型	Description	必选
acknowledged_safety_checks	OpenAI.ComputerCallSafetyCheckParam 的数组	API 报告的安全检查，这些检查的确认者为开发人员。	否
call_id	字符串	生成输出的计算机工具调用的 ID。	是的
id	字符串	计算机工具调用输出的 ID。	否
输出	OpenAI.ComputerScreenshotImage	与计算机使用工具一起使用的计算机屏幕截图图像。	是的
状态	枚举	消息输入的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回输入项时填充。可能的值：`in_progress`、、 `completedincomplete`	否
类型	枚举	计算机工具调用结果的类型。始终为 `computer_call_output`。可能的值：`computer_call_output`	是的

OpenAI.ConversationItemCustomToolCall

调用模型创建的自定义工具。

姓名	类型	Description	必选
call_id	字符串	用于将该自定义工具调用映射到工具调用输出的标识符。	是的
id	字符串	OpenAI平台自定义工具调用的唯一ID。	否
输入	字符串	模型生成的自定义工具调用输入。	是的
姓名	字符串	要调用的自定义工具的名称。	是的
类型	枚举	自定义工具调用的类型。始终为 `custom_tool_call`。可能的值：`custom_tool_call`	是的

OpenAI.ConversationItemCustomToolCallOutput

你代码中自定义工具调用的输出会被反馈到模型。

姓名	类型	Description	必选
call_id	字符串	调用 ID，用于将该自定义工具调用输出映射到自定义工具调用。	是的
id	字符串	OpenAI 平台自定义工具调用输出的唯一 ID。	否
输出	OpenAI.FunctionAndCustomToolCallOutput 的字符串或数组	你的代码生成的自定义工具调用输出。可以是字符串，也可以是输出内容的列表。	是的
类型	枚举	自定义工具调用输出的类型。始终为 `custom_tool_call_output`。可能的值：`custom_tool_call_output`	是的

OpenAI.ConversationItemFileSearchToolCall

文件搜索工具调用的结果。更多信息请参见文件搜索指南。

姓名	类型	Description	必选
id	字符串	文件搜索工具调用的唯一 ID。	是的
查询	字符串数组	用于搜索文件的查询。	是的
results	OpenAI.FileSearchToolCallResults 的数组		否
状态	枚举	文件搜索工具调用的状态。 `in_progress`、 `searching`、`incomplete`或`failed` 可能的值：`in_progress`、、`searchingcompleted`、`incomplete`、`failed`	是的
类型	枚举	文件搜索工具调用的类型。始终为 `file_search_call`。可能的值：`file_search_call`	是的

OpenAI.ConversationItemFunctionShellCall

在托管环境中执行一个或多个 shell 命令的工具调用。

姓名	类型	Description	必选
操作	OpenAI.FunctionShellAction	执行 shell 命令。	是的
~~ 命令	字符串数组		是的
max_output_length	OpenAI.integer （可为 null）		是的
timeout_ms	OpenAI.integer （可为 null）		是的
call_id	字符串	模型生成的shell工具调用的唯一ID。	是的
created_by	字符串	创建此工具调用的实体的 ID。	否
id	字符串	shell 工具调用的唯一 ID。通过 API 返回此项时进行填充。	是的
状态	OpenAI.LocalShellCallStatus		是的
类型	枚举	项类型。始终为 `shell_call`。可能的值：`shell_call`	是的

OpenAI.ConversationItemFunctionShellCallOutput

发出的 shell 工具调用的输出。

姓名	类型	Description	必选
call_id	字符串	模型生成的shell工具调用的唯一ID。	是的
created_by	字符串	创建项的执行组件的标识符。	否
id	字符串	shell 调用输出的唯一 ID。通过 API 返回此项时进行填充。	是的
max_output_length	OpenAI.integer （可为 null）		是的
输出	OpenAI.FunctionShellCallOutputContent 的数组	shell 调用输出内容的数组	是的
类型	枚举	shell 调用输出的类型。始终为 `shell_call_output`。可能的值：`shell_call_output`	是的

OpenAI.ConversationItemFunctionToolCallOutputResource

姓名	类型	Description	必选
call_id	字符串	模型生成的函数工具调用的唯一 ID。	是的
id	字符串	函数工具调用输出的唯一 ID。在此项时填充通过 API 返回。	否
输出	OpenAI.FunctionAndCustomToolCallOutput 的字符串或数组	代码生成的函数调用的输出。可以是字符串，也可以是输出内容的列表。	是的
状态	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	否
类型	枚举	函数工具调用输出的类型。始终为 `function_call_output`。可能的值：`function_call_output`	是的

OpenAI.ConversationItemFunctionToolCallResource

姓名	类型	Description	必选
arguments	字符串	要传递给函数的参数的 JSON 字符串。	是的
call_id	字符串	模型生成的函数工具调用的唯一 ID。	是的
id	字符串	函数工具调用的唯一 ID。	否
姓名	字符串	要运行的函数的名称。	是的
状态	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	否
类型	枚举	函数工具调用的类型。始终为 `function_call`。可能的值：`function_call`	是的

OpenAI.ConversationItemImageGenToolCall

模型发出的图像生成请求。

姓名	类型	Description	必选
id	字符串	图像生成调用的唯一ID。	是的
结果	string （可为 null）		是的
状态	枚举	图像生成通话状态。可能的值：`in_progress`、`completed`、`generating`、`failed`	是的
类型	枚举	图像生成调用的类型。始终为 `image_generation_call`。可能的值：`image_generation_call`	是的

OpenAI.ConversationItemList

对话项的列表。

姓名	类型	Description	必选
数据	OpenAI.ConversationItem 数组	对话项的列表。	是的
first_id	字符串	列表中第一项的 ID。	是的
has_more	布尔	是否有更多可用项。	是的
last_id	字符串	列表中最后一项的 ID。	是的
对象	枚举	返回的对象的类型必须是 `list`。可能的值：`list`	是的

OpenAI.ConversationItemLocalShellToolCall

用于在本地 shell 上运行命令的工具调用。

姓名	类型	Description	必选
操作	OpenAI.LocalShellExecAction	在服务器上执行 shell 命令。	是的
call_id	字符串	模型生成的本地 shell 工具调用的唯一 ID。	是的
id	字符串	本地壳调用的唯一ID。	是的
状态	枚举	本地空壳呼叫状态。可能的值：`in_progress`、、 `completedincomplete`	是的
类型	枚举	本地 shell 调用的类型。始终为 `local_shell_call`。可能的值：`local_shell_call`	是的

OpenAI.ConversationItemLocalShellToolCallOutput

本地 shell 工具调用的输出。

姓名	类型	Description	必选
id	字符串	模型生成的本地 shell 工具调用的唯一 ID。	是的
输出	字符串	本地 shell 工具调用输出的 JSON 字符串。	是的
状态	枚举	可能的值：`in_progress`、、 `completedincomplete`	否
类型	枚举	本地壳工具调用输出的类型。始终为 `local_shell_call_output`。可能的值：`local_shell_call_output`	是的

OpenAI.ConversationItemMcpApprovalRequest

请求人工批准工具调用。

姓名	类型	Description	必选
arguments	字符串	工具的参数的 JSON 字符串。	是的
id	字符串	批准请求的唯一ID。	是的
姓名	字符串	要运行的工具的名称。	是的
服务器标签	字符串	发出请求的 MCP 服务器的标签。	是的
类型	枚举	项类型。始终为 `mcp_approval_request`。可能的值：`mcp_approval_request`	是的

OpenAI.ConversationItemMcpApprovalResponseResource

对 MCP 审批请求的响应。

姓名	类型	Description	必选
approval_request_id	字符串	正在应答的审批请求的 ID。	是的
批准	布尔	请求是否已获得批准。	是的
id	字符串	审批响应的唯一 ID	是的
原因	string （可为 null）		否
类型	枚举	项类型。始终为 `mcp_approval_response`。可能的值：`mcp_approval_response`	是的

OpenAI.ConversationItemMcpListTools

MCP 服务器上可用的工具列表。

姓名	类型	Description	必选
错误	string （可为 null）		否
id	字符串	名单的唯一ID。	是的
服务器标签	字符串	MCP 服务器的标签。	是的
工具	OpenAI.MCPListToolsToolsTool 的数组	服务器上可用的工具。	是的
类型	枚举	项类型。始终为 `mcp_list_tools`。可能的值：`mcp_list_tools`	是的

OpenAI.ConversationItemMcpToolCall

在 MCP 服务器上调用工具。

姓名	类型	Description	必选
approval_request_id	string （可为 null）		否
arguments	字符串	传递给工具的参数的 JSON 字符串。	是的
错误	string （可为 null）		否
id	字符串	工具调用的唯一ID。	是的
姓名	字符串	运行的工具的名称。	是的
输出	string （可为 null）		否
服务器标签	字符串	运行该工具的 MCP 服务器的标签。	是的
状态	OpenAI.MCPToolCallStatus		否
类型	枚举	项类型。始终为 `mcp_call`。可能的值：`mcp_call`	是的

OpenAI.ConversationItemMessage

向模型或从模型发送消息。

姓名	类型	Description	必选
内容	OpenAI.MessageContent 数组	消息的内容	是的
id	字符串	消息的唯一 ID。	是的
角色	OpenAI.MessageRole		是的
状态	OpenAI.MessageStatus		是的
类型	枚举	消息的类型。始终将其设置为 `message`。可能的值：`message`	是的

OpenAI.ConversationItemReasoningItem

描述推理模型在生成响应时使用的想法链。如果你手动作管理上下文，务必将这些项包含在后续对话的中。

姓名	类型	Description	必选
内容	OpenAI.ReasoningTextContent 数组	推理文本内容。	否
encrypted_content	string （可为 null）		否
id	字符串	推理内容的唯一标识符。	是的
状态	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	否
摘要	OpenAI.Summary 数组	推理摘要内容。	是的
类型	枚举	对象的类型。始终为 `reasoning`。可能的值：`reasoning`	是的

OpenAI.ConversationItemType

资产价值

类型字符串

价值观 message
function_call
function_call_output
file_search_call
web_search_call
image_generation_call
computer_call
computer_call_output
reasoning
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
custom_tool_call_output

OpenAI.ConversationItemWebSearchToolCall

Web 搜索工具调用的结果。更多信息请参见web搜索指南。

姓名	类型	Description	必选
操作	OpenAI.WebSearchActionSearch 或 OpenAI.WebSearchActionOpenPage 或 OpenAI.WebSearchActionFind	描述在此 Web 搜索调用中执行的特定作的对象。包括有关模型如何使用 Web（搜索、open_page、查找）的详细信息。	是的
id	字符串	网络搜索工具的唯一ID呼叫。	是的
状态	枚举	Web 搜索工具调用的状态。可能的值：`in_progress`、`searching`、`completed`、`failed`	是的
类型	枚举	网络搜索工具调用的类型。始终为 `web_search_call`。可能的值：`web_search_call`	是的

OpenAI.ConversationParam

此响应所属的对话。此会话中的项将追加到 input_items 此响应请求的前面。此响应完成后，将自动将此响应中的输入项和输出项添加到此对话中。

类型：字符串或 OpenAI.ConversationParam-2

此响应所属的对话。此会话中的项将追加到 input_items 此响应请求的前面。此响应完成后，将自动将此响应中的输入项和输出项添加到此对话中。

OpenAI.ConversationParam-2

此响应所属的对话。

姓名	类型	Description	必选	违约
id	字符串	对话的唯一 ID。	是的

OpenAI.ConversationReference

此响应所属的对话。此响应中的输入项和输出项会自动添加到此对话。

姓名	类型	Description	必选	违约
id	字符串	与此响应关联的会话的唯一 ID。	是的

OpenAI.ConversationResource

姓名	类型	Description	必选
创建时间	整数	创建聊天的时间，以秒为单位，以 Unix 纪元以来的秒为单位。	是的
id	字符串	对话的唯一 ID。	是的
元数据	OpenAI.Metadata	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	是的
对象	枚举	始终为 `conversation` 的对象类型。可能的值：`conversation`	是的

OpenAI.CreateChatCompletionRequestResponseFormat

一个对象，指定模型必须输出的格式。 { "type": "json_schema", "json_schema": {...} }设置为启用结构化输出，可确保模型与提供的 JSON 架构匹配。了解更多内容请参阅结构化输出指南。 { "type": "json_object" }设置为启用较旧的 JSON 模式，这可确保模型生成的消息是有效的 JSON。对于支持它的模型，首选使用 json_schema 。

OpenAI.CreateChatCompletionRequestResponseFormat 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`text`	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText
`json_object`	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

姓名	类型	Description	必选	违约
类型	OpenAI.CreateChatCompletionRequestResponseFormatType		是的

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

JSON 对象响应格式。生成 JSON 响应的较旧方法。建议对支持它的模型使用 json_schema 。请注意，模型不会在没有系统或用户消息指示的情况下生成 to do JSON。

姓名	类型	Description	必选	违约
类型	枚举	要定义的响应格式的类型。始终为 `json_object`。可能的值：`json_object`	是的

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText

默认响应格式。用于生成文本响应。

姓名	类型	Description	必选	违约
类型	枚举	要定义的响应格式的类型。始终为 `text`。可能的值：`text`	是的

OpenAI.CreateChatCompletionRequestResponseFormatType

资产	价值
类型	字符串
价值观	`text` `json_schema` `json_object`

OpenAI.CreateConversationBody

姓名	类型	Description	必选	违约
items	OpenAI.InputItem 数组		否
元数据	OpenAI.Metadata （可为 null）	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否

OpenAI.CreateEvalCompletionsRunDataSource

描述模型采样配置的 CompletionsRunDataSource 对象。

姓名	类型	Description	必选
输入消息	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate 或 OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference	从模型采样时使用。指示传递到模型的消息的结构。可以是对预生成轨迹（即）的引用， `item.input_trajectory`也可以是具有对命名空间的变量引用的 `item` 模板。	否
模型	字符串	用于生成补全的模型的名称（例如“o3-mini”）。	否
采样参数	OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams		否
源	OpenAI.EvalJsonlFileContentSource 或 OpenAI.EvalJsonlFileIdSource 或 OpenAI.EvalStoredCompletionsSource	确定在此运行的数据源中填充 `item` 命名空间的内容。	是的
类型	枚举	运行数据源的类型。始终为 `completions`。可能的值：`completions`	是的

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference

姓名	类型	Description	必选	违约
item_reference	字符串		是的
类型	枚举	可能的值：`item_reference`	是的

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate

姓名	类型	Description	必选	违约
模板	OpenAI.EasyInputMessage 或 OpenAI.EvalItem 数组		是的
类型	枚举	可能的值：`template`	是的

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

姓名	类型	Description	必选	违约
max_completion_tokens	OpenAI.integer		否
推理努力	OpenAI.ReasoningEffort	限制推理模型。目前支持的值为 `none`、 `minimal`、 `low`、 `mediumhighxhigh`、和。减少推理努力可能会导致更快的响应和更少的标记使用于响应中的推理。 - `gpt-5.1` 默认为 `none`不执行推理。支持的 `gpt-5.1` 推理值为 `none`、 `low`、 `medium`和 `high`。 gpt-5.1 中的所有推理值都支持工具调用。 - 在默认为`gpt-5.1`推理工作之前`medium`的所有模型，并且不支持`none`。 - 模型 `gpt-5-pro` 默认为（且仅支持） `high` 推理工作。之后的所有模型都支持 < a0/> 。	否
响应格式	OpenAI.ResponseFormatText 或 OpenAI.ResponseFormatJsonSchema 或 OpenAI.ResponseFormatJsonObject		否
seed	OpenAI.integer		否	42
温度	OpenAI.numeric		否	1
工具	OpenAI.ChatCompletionTool 的数组		否
top_p	OpenAI.numeric		否	1

OpenAI.CreateEvalCustomDataSourceConfig

一个 CustomDataSourceConfig 对象，用于定义用于评估运行的数据源的架构。此架构用于定义将要处理的数据的结构：

用于定义测试条件和
创建运行时需要哪些数据

姓名	类型	Description	必选
include_sample_schema	布尔	评估是否应期望由你填充示例命名空间（即通过从数据源生成响应）	否
item_schema	对象	数据源中每一行的 json 架构。	是的
类型	枚举	数据源的类型。始终为 `custom`。可能的值：`custom`	是的

OpenAI.CreateEvalJsonlRunDataSource

一个 JsonlRunDataSource 对象，该对象指定与 eval 匹配的 JSONL 文件

姓名	类型	Description	必选	违约
源	OpenAI.EvalJsonlFileContentSource 或 OpenAI.EvalJsonlFileIdSource	确定在数据源中填充 `item` 命名空间的内容。	是的
类型	枚举	数据源的类型。始终为 `jsonl`。可能的值：`jsonl`	是的

OpenAI.CreateEvalLogsDataSourceConfig

数据源配置，指定日志查询的元数据属性。这通常是类似 usecase=chatbot 或 prompt-version=v2等的元数据。

姓名	类型	Description	必选	违约
元数据	对象	日志数据源的元数据筛选器。	否
类型	枚举	数据源的类型。始终为 `logs`。可能的值：`logs`	是的

OpenAI.CreateEvalResponsesRunDataSource

描述模型采样配置的 ResponsesRunDataSource 对象。

姓名	类型	Description	必选
输入消息	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate 或 OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference	从模型采样时使用。指示传递到模型的消息的结构。可以是对预生成轨迹（即）的引用， `item.input_trajectory`也可以是具有对命名空间的变量引用的 `item` 模板。	否
模型	字符串	用于生成补全的模型的名称（例如“o3-mini”）。	否
采样参数	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		否
源	OpenAI.EvalJsonlFileContentSource 或 OpenAI.EvalJsonlFileIdSource 或 OpenAI.EvalResponsesSource	确定在此运行的数据源中填充 `item` 命名空间的内容。	是的
类型	枚举	运行数据源的类型。始终为 `responses`。可能的值：`responses`	是的

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference

姓名	类型	Description	必选	违约
item_reference	字符串		是的
类型	枚举	可能的值：`item_reference`	是的

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate

姓名	类型	Description	必选	违约
模板	对象或 OpenAI.EvalItem 数组		是的
类型	枚举	可能的值：`template`	是的

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

姓名	类型	Description	必选	违约
max_completion_tokens	OpenAI.integer		否
推理努力	OpenAI.ReasoningEffort	限制推理模型。目前支持的值为 `none`、 `minimal`、 `low`、 `mediumhighxhigh`、和。减少推理努力可能会导致更快的响应和更少的标记使用于响应中的推理。 - `gpt-5.1` 默认为 `none`不执行推理。支持的 `gpt-5.1` 推理值为 `none`、 `low`、 `medium`和 `high`。 gpt-5.1 中的所有推理值都支持工具调用。 - 在默认为`gpt-5.1`推理工作之前`medium`的所有模型，并且不支持`none`。 - 模型 `gpt-5-pro` 默认为（且仅支持） `high` 推理工作。之后的所有模型都支持 < a0/> 。	否
seed	OpenAI.integer		否	42
温度	OpenAI.numeric		否	1
文本消息	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		否
工具	OpenAI.Tool 数组		否
top_p	OpenAI.numeric		否	1

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

姓名	类型	Description	必选	违约
格式	OpenAI.TextResponseFormatConfiguration	一个对象，指定模型必须输出的格式。配置 `{ "type": "json_schema" }` 会启用结构化输出，这可确保模型与提供的 JSON 架构匹配。若要了解详细信息，请查看默认格式 `{ "type": "text" }` 没有其他选项。不建议用于 gpt-4o 和较新的模型：* 设置 `{ "type": "json_object" }` 可启用旧版 JSON 模式，确保模型生成的消息是有效的 JSON。使用 `json_schema` 对于支持该功能的模型而言，这是优先选择。	否

OpenAI.CreateEvalStoredCompletionsDataSourceConfig

已弃用，改用 LogsDataSourceConfig。

姓名	类型	Description	必选	违约
元数据	对象	存储的补全数据源的元数据筛选器。	否
类型	枚举	数据源的类型。始终为 `stored_completions`。可能的值：`stored_completions`	是的

OpenAI.CreateFineTuningJobRequest

有效模型：

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini

姓名	类型	Description	必选	违约
超参数	OpenAI.CreateFineTuningJobRequestHyperparameters		否
batch_size	string 或 OpenAI.integer		否	汽车
学习率倍增器	string 或 OpenAI.numeric		否
n_epochs	string 或 OpenAI.integer		否	汽车
integrations	OpenAI.CreateFineTuningJobRequestIntegrations 数组	要为微调作业启用的集成列表。	否
元数据	OpenAI.Metadata （可为 null）	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
方法	OpenAI.FineTuneMethod	用于微调的方法。	否
模型	字符串（请参阅下面的有效模型）	要微调的模型的名称。可以选择其中一个支持型号。	是的
seed	OpenAI.integer （可为 null）		否
suffix	string （可为 null）	最多 64 个字符的字符串，将添加到微调模型名称中。例如，`suffix` 为“custom-model-name”，将生成类似 `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel` 这样的模型名称。约束： minLength：1，maxLength：64	否
训练文件	字符串	包含训练数据的已上传文件的 ID。请参阅上传文件，了解如何上传文件。数据集必须格式化为 JSONL 文件。此外，必须上传文件，目的是执行 `fine-tune` 操作。文件的内容应有所不同，具体取决于模型是否使用聊天、完成格式，或者微调方法是否使用首选项格式。更多详情请参见微调指南。	是的
验证文件	string （可为 null）	包含验证数据的已上传文件的 ID。如果提供此文件，则数据将在微调期间定期用于生成验证指标。这些指标可在微调结果文件中查看。训练文件和验证文件中不应存在相同的数据。数据集必须格式化为 JSONL 文件。必须上传文件，目的是执行 `fine-tune` 操作。更多详情请参见微调指南。	否

OpenAI.CreateFineTuningJobRequestHyperparameters

姓名	类型	必选
批处理大小	string 或 OpenAI.integer	否
学习率乘数 (learning_rate_multiplier)	string 或 OpenAI.numeric	否
n_epochs	string 或 OpenAI.integer	否

OpenAI.CreateFineTuningJobRequestIntegrations

姓名	类型	Description	必选	违约
类型	枚举	可能的值：`wandb`	是的
wandb	OpenAI.CreateFineTuningJobRequestIntegrationsWandb		是的

OpenAI.CreateFineTuningJobRequestIntegrationsWandb

姓名	类型	必选
实体	string （可为 null）	否
姓名	string （可为 null）	否
project	字符串	是的
tags	字符串数组	否

OpenAI.CreateResponseStreamingResponse

OpenAI.CustomGrammarFormatParam

由用户定义的语法。

姓名	类型	Description	必选
定义	字符串	语法定义。	是的
syntax	OpenAI.GrammarSyntax1		是的
类型	枚举	语法格式。始终为 `grammar`。可能的值：`grammar`	是的

OpenAI.CustomTextFormatParam

不受限制的自由形式文本。

姓名	类型	Description	必选	违约
类型	枚举	不受限制的文本格式。始终为 `text`。可能的值：`text`	是的

OpenAI.CustomToolParam

一个自定义工具，使用指定格式处理输入。了解更多关于custom tools

姓名	类型	Description	必选
说明	字符串	可选的自定义工具描述，用于提供更多上下文。	否
格式	OpenAI.CustomToolParamFormat	自定义工具的输入格式。默认是无约束文本。	否
└─ 类型	OpenAI.CustomToolParamFormatType		是的
姓名	字符串	自定义工具的名称，用于工具调用中的标识。	是的
类型	枚举	自定义工具的类型。始终为 `custom`。可能的值：`custom`	是的

OpenAI.CustomToolParamFormat

自定义工具的输入格式。默认是无约束文本。

OpenAI.CustomToolParamFormat 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`text`	OpenAI.CustomTextFormatParam
`grammar`	OpenAI.CustomGrammarFormatParam

姓名	类型	Description	必选	违约
类型	OpenAI.CustomToolParamFormatType		是的

OpenAI.CustomToolParamFormatType

资产	价值
类型	字符串
价值观	`text` `grammar`

OpenAI.DeletedConversationResource

姓名	类型	Description	必选
已删除	布尔		是的
id	字符串		是的
对象	枚举	可能的值：`conversation.deleted`	是的

OpenAI.DetailEnum

资产	价值
类型	字符串
价值观	`low` `high` `auto`

OpenAI.DoubleClickAction

双击操作。

姓名	类型	Description	必选
类型	枚举	指定事件类型。对于双击操作，此属性始终设置为 `double_click`。可能的值：`double_click`	是的
x	OpenAI.integer		是的
y	OpenAI.integer		是的

OpenAI.Drag

拖动操作。

姓名	类型	Description	必选	违约
路径	OpenAI.DragPoint 数组	表示拖动作路径的坐标数组。坐标将显示为数组对象，例如 `<br> [<br> { x: 100, y: 200 },<br> { x: 200, y: 300 }<br> ]<br>`	是的
类型	枚举	指定事件类型。对于拖动操作，此属性为始终设置为 `drag`。可能的值：`drag`	是的

OpenAI.DragPoint

x/y 坐标对，例如 { x: 100, y: 200 }

姓名	类型	Description	必选	违约
x	OpenAI.integer		是的
y	OpenAI.integer		是的

OpenAI.EasyInputMessage

模型的消息输入，具有指示以下层次结构的说明的角色。使用 developer 或 system 角色提供的说明优先于角色 user 提供的说明。假定具有 assistant 角色的消息是由模型在以前的交互中生成的。

姓名	类型	Description	必选
内容	string 或 OpenAI.InputMessageContentList	对模型的文本、图像或音频输入，用于生成响应。还可以包含以前的助手回复。	是的
角色	枚举	消息输入的角色。 `user`、`assistant`、`system`之一或 `developer`。可能的值：`user`、`assistant`、`system`、`developer`	是的
状态	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	否
类型	枚举	消息输入的类型。始终为 `message`。可能的值：`message`	是的

OpenAI.Error

姓名	类型	必选
附加信息	对象	否
代码	string （可为 null）	是的
调试信息	对象	否
details	OpenAI.Error 数组	否
消息	字符串	是的
param	string （可为 null）	否
类型	字符串	否

OpenAI.EvalApiError

一个对象，表示来自 Eval API 的错误响应。

姓名	类型	Description	必选	违约
代码	字符串	错误代码。	是的
消息	字符串	错误消息。	是的

OpenAI.EvalGraderLabelModel

姓名	类型	Description	必选
输入	OpenAI.EvalItem 的数组		是的
labels	字符串数组	要分配给评估中每个项的标签。	是的
模型	字符串	要用于评估的模型。必须支持结构化输出。	是的
姓名	字符串	评分程序的名称。	是的
passing_labels	字符串数组	指示通过结果的标签。必须是标签的子集。	是的
类型	枚举	始终为 `label_model` 的对象类型。可能的值：`label_model`	是的

OpenAI.EvalGraderPython

姓名	类型	Description	必选
image_tag	字符串	要用于 python 脚本的图像标记。	否
姓名	字符串	评分程序的名称。	是的
通过阈值	OpenAI.numeric		否
源	字符串	python 脚本的源代码。	是的
类型	枚举	始终为 `python` 的对象类型。可能的值：`python`	是的

OpenAI.EvalGraderScoreModel

姓名	类型	Description	必选	违约
输入	OpenAI.EvalItem 的数组	评分器评估的输入消息。支持文本、输出文本、输入图像和输入音频内容块，并可能包括模板字符串。	是的
模型	字符串	要用于评估的模型。	是的
姓名	字符串	评分程序的名称。	是的
通过阈值	OpenAI.numeric		否
范围	OpenAI.numeric 数组	分数的范围。默认为 `[0, 1]`。	否
采样参数	OpenAI.EvalGraderScoreModelSamplingParams		否
max_completions_tokens	OpenAI.integer （可为 null）		否
推理努力	OpenAI.ReasoningEffort	限制推理模型。目前支持的值为 `none`、 `minimal`、 `low`、 `mediumhighxhigh`、和。减少推理努力可能会导致更快的响应和更少的标记使用于响应中的推理。 - `gpt-5.1` 默认为 `none`不执行推理。支持的 `gpt-5.1` 推理值为 `none`、 `low`、 `medium`和 `high`。 gpt-5.1 中的所有推理值都支持工具调用。 - 在默认为`gpt-5.1`推理工作之前`medium`的所有模型，并且不支持`none`。 - 模型 `gpt-5-pro` 默认为（且仅支持） `high` 推理工作。之后的所有模型都支持 < a0/> 。	否
~~ 种子	OpenAI.integer （可为 null）		否
~~ 温度	OpenAI.numeric （可为 null）		否
top_p	OpenAI.numeric （可为 null）		否	1
类型	枚举	始终为 `score_model` 的对象类型。可能的值：`score_model`	是的

OpenAI.EvalGraderScoreModelSamplingParams

姓名	类型	Description	必选	违约
max_completions_tokens	OpenAI.integer （可为 null）		否
推理努力	OpenAI.ReasoningEffort	限制推理模型。目前支持的值为 `none`、 `minimal`、 `low`、 `mediumhighxhigh`、和。减少推理努力可能会导致更快的响应和更少的标记使用于响应中的推理。 - `gpt-5.1` 默认为 `none`不执行推理。支持的 `gpt-5.1` 推理值为 `none`、 `low`、 `medium`和 `high`。 gpt-5.1 中的所有推理值都支持工具调用。 - 在默认为`gpt-5.1`推理工作之前`medium`的所有模型，并且不支持`none`。 - 模型 `gpt-5-pro` 默认为（且仅支持） `high` 推理工作。之后的所有模型都支持 < a0/> 。	否
seed	OpenAI.integer （可为 null）		否
温度	OpenAI.numeric （可为 null）		否
top_p	OpenAI.numeric （可为 null）		否	1

OpenAI.EvalGraderStringCheck

姓名	类型	Description	必选
输入	字符串	输入文本。这可能包括模板字符串。	是的
姓名	字符串	评分程序的名称。	是的
操作	枚举	要执行的字符串检查操作。 `eq`、`ne`、`like` 或 `ilike` 之一。可能的值：`eq`、`ne`、`like`、`ilike`	是的
引用	字符串	引用文本。这可能包括模板字符串。	是的
类型	枚举	始终为 `string_check` 的对象类型。可能的值：`string_check`	是的

OpenAI.EvalGraderTextSimilarity

姓名	类型	Description	必选
评估指标	枚举	要使用的评估指标。 `cosine`、`fuzzy_match`、`bleu` 之一， `gleu`、、`meteorrouge_1`、`rouge_2`、`rouge_3`、`rouge_4`、、 `rouge_5` 或 `rouge_l`。可能的值：`cosine`、、、`fuzzy_match`、`bleu`、、 `gleumeteorrouge_1rouge_2rouge_3rouge_4rouge_5rouge_l`	是的
输入	字符串	正在评分的文本。	是的
姓名	字符串	评分程序的名称。	是的
通过阈值	OpenAI.numeric		是的
引用	字符串	作为评分参照的文本。	是的
类型	枚举	评分程序的类型。可能的值：`text_similarity`	是的

OpenAI.EvalItem

姓名	类型	Description	必选
内容	OpenAI.EvalItemContent	模型的输入 - 可以包含模板字符串。支持将文本、输出文本、输入图像和输入音频作为单个项或项数组。	是的
角色	枚举	消息输入的角色。 `user`、`assistant`、`system`之一或 `developer`。可能的值：`user`、`assistant`、`system`、`developer`	是的
类型	枚举	消息输入的类型。始终为 `message`。可能的值：`message`	否

OpenAI.EvalItemContent

模型的输入 - 可以包含模板字符串。支持将文本、输出文本、输入图像和输入音频作为单个项或项数组。

类型： OpenAI.EvalItemContentItem 或 OpenAI.EvalItemContentArray

模型的输入 - 可以包含模板字符串。支持将文本、输出文本、输入图像和输入音频作为单个项或项数组。

OpenAI.EvalItemContentArray

输入列表，每个输入可以是输入文本、输出文本、输入图像或输入音频对象。

数组： OpenAI.EvalItemContentItem

OpenAI.EvalItemContentItem

单个内容项：输入文本、输出文本、输入图像或输入音频。

类型： OpenAI.EvalItemContentText 或 OpenAI.EvalItemContentItemObject

单个内容项：输入文本、输出文本、输入图像或输入音频。

OpenAI.EvalItemContentItemObject

单个内容项：输入文本、输出文本、输入图像或输入音频。

OpenAI.EvalItemContentItemObject 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`output_text`	OpenAI.EvalItemContentOutputText
`input_image`	OpenAI.EvalItemInputImage
`input_audio`	OpenAI.InputAudio
`input_text`	OpenAI.EvalItemContentItemObjectInputTextContent

姓名	类型	Description	必选	违约
类型	OpenAI.EvalItemContentItemObjectType		是的

OpenAI.EvalItemContentItemObjectInputTextContent

模型的文本输入。

姓名	类型	Description	必选	违约
文本消息	字符串	模型的文本输入。	是的
类型	枚举	输入项的类型。始终为 `input_text`。可能的值：`input_text`	是的

OpenAI.EvalItemContentItemObjectType

资产	价值
类型	字符串
价值观	`input_text` `output_text` `input_image` `input_audio`

OpenAI.EvalItemContentOutputText

模型的文本输出。

姓名	类型	Description	必选	违约
文本消息	字符串	模型的文本输出。	是的
类型	枚举	输出文本的类型。始终为 `output_text`。可能的值：`output_text`	是的

OpenAI.EvalItemContentText

模型的文本输入。

类型：string

OpenAI.EvalItemInputImage

在 EvalItem 内容数组中使用的图像输入块。

姓名	类型	Description	必选
detail	字符串	要发送到模型的图像的细节级别。 `high`、`low` 或 `auto` 之一。默认为 `auto`。	否
image_url	字符串	图像输入的 URL。	是的
类型	枚举	图像输入的类型。始终为 `input_image`。可能的值：`input_image`	是的

OpenAI.EvalJsonlFileContentSource

姓名	类型	Description	必选	违约
内容	OpenAI.EvalJsonlFileContentSourceContent 数组	jsonl 文件的内容。	是的
类型	枚举	jsonl 源的类型。始终为 `file_content`。可能的值：`file_content`	是的

OpenAI.EvalJsonlFileContentSourceContent

姓名	类型	Description	必选	违约
项	对象		是的
示例	对象		否

OpenAI.EvalJsonlFileIdSource

姓名	类型	Description	必选	违约
id	字符串	文件的标识符。	是的
类型	枚举	jsonl 源的类型。始终为 `file_id`。可能的值：`file_id`	是的

OpenAI.EvalResponsesSource

描述运行数据源配置的 EvalResponsesSource 对象。

姓名	类型	Description	必选
created_after	OpenAI.integer （可为 null）		否
created_before	OpenAI.integer （可为 null）		否
instructions_search	string （可为 null）		否
元数据	对象（可为 null）		否
模型	string （可为 null）		否
推理努力	OpenAI.ReasoningEffort （可为 null）	限制推理模型。目前支持的值为 `none`、 `minimal`、 `low`、 `mediumhighxhigh`、和。减少推理努力可能会导致更快的响应和更少的标记使用于响应中的推理。 - `gpt-5.1` 默认为 `none`不执行推理。支持的 `gpt-5.1` 推理值为 `none`、 `low`、 `medium`和 `high`。 gpt-5.1 中的所有推理值都支持工具调用。 - 在默认为`gpt-5.1`推理工作之前`medium`的所有模型，并且不支持`none`。 - 模型 `gpt-5-pro` 默认为（且仅支持） `high` 推理工作。之后的所有模型都支持 < a0/> 。	否
温度	OpenAI.numeric （可为 null）		否
工具	字符串数组		否
top_p	OpenAI.numeric （可为 null）		否
类型	枚举	运行数据源的类型。始终为 `responses`。可能的值：`responses`	是的
users	字符串数组		否

OpenAI.EvalRunOutputItemSample

姓名	类型	Description	必选
错误	OpenAI.EvalApiError	一个对象，表示来自 Eval API 的错误响应。	是的
finish_reason	字符串		是的
输入	EvalRunOutputItemSampleInput 的数组		是的
max_completion_tokens	OpenAI.integer		是的
模型	字符串		是的
输出	EvalRunOutputItemSampleOutput 的数组		是的
seed	OpenAI.integer		是的
温度	OpenAI.numeric		是的
top_p	OpenAI.numeric		是的
使用情况	OpenAI.EvalRunOutputItemSampleUsage		是的

OpenAI.EvalRunOutputItemSampleUsage

姓名	类型	必选
cached_tokens	OpenAI.integer	是的
completion_tokens	OpenAI.integer	是的
prompt_tokens	OpenAI.integer	是的
total_tokens	OpenAI.integer	是的

OpenAI.EvalRunPerModelUsage

姓名	类型	必选
cached_tokens	OpenAI.integer	是的
completion_tokens	OpenAI.integer	是的
invocation_count	OpenAI.integer	是的
model_name	字符串	是的
prompt_tokens	OpenAI.integer	是的
total_tokens	OpenAI.integer	是的

OpenAI.EvalRunPerTestingCriteriaResults

姓名	类型	必选
“失败”	OpenAI.integer	是的
通过	OpenAI.integer	是的
测试标准	字符串	是的

OpenAI.EvalRunResultCounts

姓名	类型	必选
errored	OpenAI.integer	是的
“失败”	OpenAI.integer	是的
通过	OpenAI.integer	是的
总	OpenAI.integer	是的

OpenAI.EvalStoredCompletionsSource

描述一组筛选器的 StoredCompletionsRunDataSource 配置

姓名	类型	Description	必选
created_after	OpenAI.integer （可为 null）		否
created_before	OpenAI.integer （可为 null）		否
limit	OpenAI.integer （可为 null）		否
元数据	OpenAI.Metadata （可为 null）	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
模型	string （可为 null）		否
类型	枚举	源的类型。始终为 `stored_completions`。可能的值：`stored_completions`	是的

OpenAI.FileCitationBody

文件的引文。

姓名	类型	Description	必选
file_id	字符串	文件的 ID。	是的
filename	字符串	所引用文件的文件名。	是的
索引	OpenAI.integer		是的
类型	枚举	文件引文的类型。始终为 `file_citation`。可能的值：`file_citation`	是的

OpenAI.FilePath

文件路径。

姓名	类型	Description	必选
file_id	字符串	文件的 ID。	是的
索引	OpenAI.integer		是的
类型	枚举	文件路径的类型。始终为 `file_path`。可能的值：`file_path`	是的

OpenAI.FileSearchTool

一个工具，用于搜索已上传文件中的相关内容。

姓名	类型	Description	必选
filters	OpenAI.Filters （可为 null）		否
max_num_results（最大结果数）	OpenAI.integer		否
排名选项	OpenAI.RankingOptions		否
hybrid_search	OpenAI.HybridSearchOptions	控制互惠秩融合在启用混合搜索时，语义嵌入匹配与稀疏关键词匹配之间的权重。	否
~~ 排名器	OpenAI.RankerVersionType	用于文件搜索的排序算法。	否
分数阈值	OpenAI.numeric	文件搜索的分数阈值，介于 0 和 1 之间。接近 1 的数字将尝试仅返回最相关的结果，但可能会返回更少的结果。	否
类型	枚举	文件搜索工具的类型。始终为 `file_search`。可能的值：`file_search`	是的
vector_store_ids	字符串数组	要搜索的矢量存储的 ID。	是的

OpenAI.FileSearchToolCallResults

姓名	类型	Description	必选
attributes	OpenAI.VectorStoreFileAttributes （可为 null）	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是字符串最大长度为 64 个字符。值为长度最大 512 个字符、布尔值或数字的字符串。	否
file_id	字符串		否
filename	字符串		否
分数	数字		否
文本消息	字符串		否

OpenAI.Filters

类型： OpenAI.ComparisonFilter 或 OpenAI.CompoundFilter

OpenAI.FineTuneDPOHyperparameters

用于 DPO 微调作业的超参数。

姓名	类型	Description	必选
批处理大小	string 或 OpenAI.integer	每个批次中的示例数。较大的批大小意味着模型参数的更新频率较低，但差异较低。	否
beta 版本	string 或 OpenAI.numeric	DPO 方法的 beta 值。较高的 beta 值会增加策略和引用模型之间的惩罚权重。	否
学习率乘数 (learning_rate_multiplier)	string 或 OpenAI.numeric	学习速率的缩放系数。较小的学习率可以用于避免过度拟合。	否
n_epochs	string 或 OpenAI.integer	要为其训练模型的纪元数。纪元是指通过训练数据集的一个完整周期。	否

OpenAI.FineTuneDPOMethod

DPO 微调方法的配置。

姓名	类型	Description	必选	违约
超参数	OpenAI.FineTuneDPOHyperparameters	用于 DPO 微调作业的超参数。	否

OpenAI.FineTuneMethod

用于微调的方法。

姓名	类型	Description	必选
dpo	OpenAI.FineTuneDPOMethod	DPO 微调方法的配置。	否
增强式	OpenAI.FineTuneReinforcementMethod	强化微调方法的配置。	否
监督	OpenAI.FineTuneSupervisedMethod	监督式微调方法的配置。	否
类型	枚举	方法的类型。为 `supervised`、`dpo` 或 `reinforcement`。可能的值：`supervised`、、 `dporeinforcement`	是的

OpenAI.FineTuneReinforcementHyperparameters

用于强化微调作业的超参数。

姓名	类型	Description	必选
批处理大小	string 或 OpenAI.integer	每个批次中的示例数。较大的批大小意味着模型参数的更新频率较低，但差异较低。	否
compute_multiplier	string 或 OpenAI.numeric	在训练期间用于浏览搜索空间的计算量的乘数。	否
eval_interval	string 或 OpenAI.integer	评估运行之间的训练步骤数。	否
eval_samples	string 或 OpenAI.integer	每个训练步骤要生成的评估示例数。	否
学习率乘数 (learning_rate_multiplier)	string 或 OpenAI.numeric	学习速率的缩放系数。较小的学习率可以用于避免过度拟合。	否
n_epochs	string 或 OpenAI.integer	要为其训练模型的纪元数。纪元是指通过训练数据集的一个完整周期。	否
推理努力	枚举	推理工作级别。可能的值：`default`、`low`、`medium`、`high`	否

OpenAI.FineTuneReinforcementMethod

强化微调方法的配置。

姓名	类型	Description	必选	违约
评分器	OpenAI.GraderStringCheck 或 OpenAI.GraderTextSimilarity 或 OpenAI.GraderPython 或 OpenAI.GraderScoreModel 或 OpenAI.GraderMulti	用于微调作业的分级程序。	是的
超参数	OpenAI.FineTuneReinforcementHyperparameters	用于强化微调作业的超参数。	否

OpenAI.FineTuneSupervisedHyperparameters

用于微调作业的超参数。

姓名	类型	Description	必选
批处理大小	string 或 OpenAI.integer	每个批次中的示例数。较大的批大小意味着模型参数的更新频率较低，但差异较低。	否
学习率乘数 (learning_rate_multiplier)	string 或 OpenAI.numeric	学习速率的缩放系数。较小的学习率可以用于避免过度拟合。	否
n_epochs	string 或 OpenAI.integer	要为其训练模型的纪元数。纪元是指通过训练数据集的一个完整周期。	否

OpenAI.FineTuneSupervisedMethod

监督式微调方法的配置。

姓名	类型	Description	必选	违约
超参数	OpenAI.FineTuneSupervisedHyperparameters	用于微调作业的超参数。	否

OpenAI.FineTuningIntegration

姓名	类型	Description	必选
类型	枚举	为微调作业启用的集成的类型可能的值：`wandb`	是的
wandb	OpenAI.FineTuningIntegrationWandb		是的
└─ 实体	string （可为 null）		否
└─ 名称	string （可为 null）		否
└─ project	字符串		是的
└─ 标记	字符串数组		否

OpenAI.FineTuningIntegrationWandb

姓名	类型	必选
实体	string （可为 null）	否
姓名	string （可为 null）	否
project	字符串	是的
tags	字符串数组	否

OpenAI.FineTuningJob

fine_tuning.job 对象表示通过 API 创建的微调作业。

姓名	类型	Description	必选	违约
创建时间	整数	创建微调作业时的 Unix 时间戳（以秒为单位）。	是的
错误	OpenAI.FineTuningJobError （可为 null）		是的
└─ 代码	字符串		是的
└─ 消息	字符串		是的
└─ 参数	string （可为 null）		是的
预计完成	整数		否
fine_tuned_model	string （可为 null）		是的
完成于	整数		是的
超参数	OpenAI.FineTuningJobHyperparameters		是的
batch_size	string 或 OpenAI.integer		否	汽车
学习率倍增器	string 或 OpenAI.numeric		否
n_epochs	string 或 OpenAI.integer		否	汽车
id	字符串	可在 API 终结点中引用的对象标识符。	是的
integrations	OpenAI.FineTuningIntegration 的数组		否
元数据	OpenAI.Metadata （可为 null）	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
方法	OpenAI.FineTuneMethod	用于微调的方法。	否
模型	字符串	正在微调的基础模型。	是的
对象	枚举	对象类型，始终为“fine_tuning.job”。可能的值：`fine_tuning.job`	是的
organization_id	字符串	拥有微调作业的组织。	是的
result_files	字符串数组	微调作业的已编译结果文件 ID。可以使用文件 API 检索结果。	是的
seed	OpenAI.integer		是的
状态	枚举	微调作业的当前状态，可以是 `validating_files`、`queued`、`running`、`succeeded`、`failed` 或 `cancelled`。可能的值：`validating_files`、、`queued`、`runningsucceeded`、`failed`、`cancelled`	是的
trained_tokens	OpenAI.integer （可为 null）		是的
训练文件	字符串	用于训练的文件 ID。可以使用文件 API 检索训练数据。	是的
验证文件	string （可为 null）		是的

OpenAI.FineTuningJobCheckpoint

fine_tuning.job.checkpoint 对象表示可供使用的微调作业的模型检查点。

姓名	类型	Description	必选
创建时间	整数	创建检查点时的 Unix 时间戳（以秒为单位）。	是的
调整好的模型检查点	字符串	创建的微调检查点模型的名称。	是的
微调任务ID (fine_tuning_job_id)	字符串	从中创建此检查点的微调作业的名称。	是的
id	字符串	可在 API 终结点中引用的检查点标识符。	是的
指标	OpenAI.FineTuningJobCheckpointMetrics		是的
full_valid_loss	OpenAI.numeric		否
full_valid_mean_token_accuracy（完整验证平均标记准确率）	OpenAI.numeric		否
└─ 步骤	OpenAI.numeric		否
训练损失	OpenAI.numeric		否
训练平均标记准确率	OpenAI.numeric		否
验证损失	OpenAI.numeric		否
验证平均标记准确率	OpenAI.numeric		否
对象	枚举	对象类型，始终为“fine_tuning.job.checkpoint”。可能的值：`fine_tuning.job.checkpoint`	是的
步骤编号	OpenAI.integer		是的

OpenAI.FineTuningJobCheckpointMetrics

姓名	类型	必选
full_valid_loss	OpenAI.numeric	否
full_valid_mean_token_accuracy	OpenAI.numeric	否
单步执行	OpenAI.numeric	否
train_loss	OpenAI.numeric	否
train_mean_token_accuracy	OpenAI.numeric	否
valid_loss	OpenAI.numeric	否
valid_mean_token_accuracy	OpenAI.numeric	否

OpenAI.FineTuningJobError

姓名	类型	必选
代码	字符串	是的
消息	字符串	是的
param	string （可为 null）	是的

OpenAI.FineTuningJobEvent

微调作业事件对象

姓名	类型	Description	必选
创建时间	整数	创建微调作业时的 Unix 时间戳（以秒为单位）。	是的
数据	OpenAI.FineTuningJobEventData		否
id	字符串	对象标识符。	是的
水平仪	枚举	事件的日志级别。可能的值：`info`、、 `warnerror`	是的
消息	字符串	事件的消息。	是的
对象	枚举	对象类型，始终为“fine_tuning.job.event”。可能的值：`fine_tuning.job.event`	是的
类型	枚举	事件类型。可能的值： `messagemetrics`	否

OpenAI.FineTuningJobEventData

类型：对象

OpenAI.FineTuningJobHyperparameters

姓名	类型	必选
批处理大小	string 或 OpenAI.integer	否
学习率乘数 (learning_rate_multiplier)	string 或 OpenAI.numeric	否
n_epochs	string 或 OpenAI.integer	否

OpenAI.FunctionAndCustomToolCallOutput

OpenAI.FunctionAndCustomToolCallOutput 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`input_text`	OpenAI.FunctionAndCustomToolCallOutputInputTextContent
`input_image`	OpenAI.FunctionAndCustomToolCallOutputInputImageContent
`input_file`	OpenAI.FunctionAndCustomToolCallOutputInputFileContent

姓名	类型	Description	必选	违约
类型	OpenAI.FunctionAndCustomToolCallOutputType		是的

OpenAI.FunctionAndCustomToolCallOutputInputFileContent

模型的文件输入。

姓名	类型	Description	必选
file_data	字符串	要发送到模型的文件的内容。	否
file_id	string （可为 null）		否
file_url	字符串	要发送给模型的文件URL。	否
filename	字符串	要发送到模型的文件的名称。	否
类型	枚举	输入项的类型。始终为 `input_file`。可能的值：`input_file`	是的

OpenAI.FunctionAndCustomToolCallOutputInputImageContent

输入到模型中的图像了解图像输入。

姓名	类型	Description	必选
detail	OpenAI.ImageDetail		是的
file_id	string （可为 null）		否
image_url	字符串		否
类型	枚举	输入项的类型。始终为 `input_image`。可能的值：`input_image`	是的

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

模型的文本输入。

姓名	类型	Description	必选	违约
文本消息	字符串	模型的文本输入。	是的
类型	枚举	输入项的类型。始终为 `input_text`。可能的值：`input_text`	是的

OpenAI.FunctionAndCustomToolCallOutputType

资产	价值
类型	字符串
价值观	`input_text` `input_image` `input_file`

OpenAI.FunctionCallItemStatus

资产	价值
类型	字符串
价值观	`in_progress` `completed` `incomplete`

OpenAI.FunctionObject

姓名	类型	Description	必选
说明	字符串	函数作用的描述，由模型用于选择何时以及如何调用函数。	否
姓名	字符串	要调用的函数的名称。必须是 a-z、A-z、0-9，或包含下划线和短划线，最大长度为 64。	是的
参数	OpenAI.FunctionParameters	函数接受的参数，被描述为 JSON 架构对象。关于格式的文档请参见 guide 以及 JSON Schema 参考。省略 `parameters` 会定义具有空参数列表的函数。	否
strict	布尔值（可为 null）		否

OpenAI.FunctionParameters

函数接受的参数，被描述为 JSON 架构对象。关于格式的文档请参见 guide 以及 JSON Schema 参考。省略 parameters 会定义具有空参数列表的函数。

类型：对象

OpenAI.FunctionShellAction

执行 shell 命令。

姓名	类型	必选
commands	字符串数组	是的
max_output_length	OpenAI.integer （可为 null）	是的
timeout_ms	OpenAI.integer （可为 null）	是的

OpenAI.FunctionShellActionParam

描述如何运行shell工具调用的命令和限制。

姓名	类型	Description	必选
commands	字符串数组	命令执行环境运行的 shell 命令。	是的
max_output_length	OpenAI.integer （可为 null）		否
timeout_ms	OpenAI.integer （可为 null）		否

OpenAI.FunctionShellCallItemStatus

shell工具调用时报告的状态值。

资产	价值
类型	字符串
价值观	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellCallOutputContent

发出 shell 工具调用输出的内容。

姓名	类型	Description	必选
created_by	字符串	创建项的执行组件的标识符。	否
结果	OpenAI.FunctionShellCallOutputOutcome	表示退出结果（带有退出代码）或 shell 调用输出区块的超时结果。	是的
└─ 类型	OpenAI.FunctionShellCallOutputOutcomeType		是的
stderr	字符串	捕获的标准错误输出。	是的
stdout	字符串	捕获的标准输出。	是的

OpenAI.FunctionShellCallOutputContentParam

捕获了 shell 工具调用输出的一部分 stdout 和 stderr。

姓名	类型	Description	必选
结果	OpenAI.FunctionShellCallOutputOutcomeParam	与此shell调用相关的退出或超时结果。	是的
└─ 类型	OpenAI.FunctionShellCallOutputOutcomeParamType		是的
stderr	字符串	捕获了 shell 调用的 stderr 输出。约束： maxLength：10485760	是的
stdout	字符串	捕获了 shell 调用的标准输出。约束： maxLength：10485760	是的

OpenAI.FunctionShellCallOutputExitOutcome

表示shell命令已完成并返回退出代码。

姓名	类型	Description	必选	违约
exit_code	OpenAI.integer		是的
类型	枚举	结果类型。始终为 `exit`。可能的值：`exit`	是的

OpenAI.FunctionShellCallOutputExitOutcomeParam

表示shell命令已完成并返回退出代码。

姓名	类型	Description	必选	违约
exit_code	OpenAI.integer		是的
类型	枚举	结果类型。始终为 `exit`。可能的值：`exit`	是的

OpenAI.FunctionShellCallOutputOutcome

表示退出结果（带有退出代码）或 shell 调用输出区块的超时结果。

OpenAI.FunctionShellCallOutputOutcome 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutOutcome
`exit`	OpenAI.FunctionShellCallOutputExitOutcome

姓名	类型	Description	必选	违约
类型	OpenAI.FunctionShellCallOutputOutcomeType		是的

OpenAI.FunctionShellCallOutputOutcomeParam

与此shell调用相关的退出或超时结果。

OpenAI.FunctionShellCallOutputOutcomeParam 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutOutcomeParam
`exit`	OpenAI.FunctionShellCallOutputExitOutcomeParam

姓名	类型	Description	必选	违约
类型	OpenAI.FunctionShellCallOutputOutcomeParamType		是的

OpenAI.FunctionShellCallOutputOutcomeParamType

资产	价值
类型	字符串
价值观	`timeout` `exit`

OpenAI.FunctionShellCallOutputOutcomeType

资产	价值
类型	字符串
价值观	`timeout` `exit`

OpenAI.FunctionShellCallOutputTimeoutOutcome

表示壳调用已超过其配置的时间限制。

姓名	类型	Description	必选	违约
类型	枚举	结果类型。始终为 `timeout`。可能的值：`timeout`	是的

OpenAI.FunctionShellCallOutputTimeoutOutcomeParam

表示壳调用已超过其配置的时间限制。

姓名	类型	Description	必选	违约
类型	枚举	结果类型。始终为 `timeout`。可能的值：`timeout`	是的

OpenAI.FunctionShellToolParam

一个允许模型执行shell命令的工具。

姓名	类型	Description	必选	违约
类型	枚举	壳体工具的类型。始终为 `shell`。可能的值：`shell`	是的

OpenAI.FunctionTool

在自己的代码中定义模型可以选择调用的函数。

姓名	类型	Description	必选
说明	string （可为 null）		否
姓名	字符串	要调用的函数名称。	是的
参数	对象（可为 null）		是的
strict	布尔值（可为 null）		是的
类型	枚举	函数工具的类型。始终为 `function`。可能的值：`function`	是的

OpenAI.GraderLabelModel

一个 LabelModelGrader 对象，该对象使用模型将标签分配给评估中的每个项。

姓名	类型	Description	必选
输入	OpenAI.EvalItem 的数组		是的
labels	字符串数组	要分配给评估中每个项的标签。	是的
模型	字符串	要用于评估的模型。必须支持结构化输出。	是的
姓名	字符串	评分程序的名称。	是的
passing_labels	字符串数组	指示通过结果的标签。必须是标签的子集。	是的
类型	枚举	始终为 `label_model` 的对象类型。可能的值：`label_model`	是的

OpenAI.GraderMulti

多评分器对象将多评分器的输出相组合来生成一个分数。

姓名	类型	Description	必选
calculate_output	字符串	一个公式，用于根据评分器结果计算输出。	是的
评分器	OpenAI.GraderStringCheck 或 OpenAI.GraderTextSimilarity 或 OpenAI.GraderPython 或 OpenAI.GraderScoreModel 或 OpenAI.GraderLabelModel		是的
姓名	字符串	评分程序的名称。	是的
类型	枚举	始终为 `multi` 的对象类型。可能的值：`multi`	是的

OpenAI.GraderPython

在输入上运行 python 脚本的 PythonGrader 对象。

姓名	类型	Description	必选
image_tag	字符串	要用于 python 脚本的图像标记。	否
姓名	字符串	评分程序的名称。	是的
源	字符串	python 脚本的源代码。	是的
类型	枚举	始终为 `python` 的对象类型。可能的值：`python`	是的

OpenAI.GraderScoreModel

一个 ScoreModelGrader 对象，该对象使用模型将分数分配给输入。

姓名	类型	Description	必选	违约
输入	OpenAI.EvalItem 的数组	评分器评估的输入消息。支持文本、输出文本、输入图像和输入音频内容块，并可能包括模板字符串。	是的
模型	字符串	要用于评估的模型。	是的
姓名	字符串	评分程序的名称。	是的
范围	OpenAI.numeric 数组	分数的范围。默认为 `[0, 1]`。	否
采样参数	OpenAI.EvalGraderScoreModelSamplingParams		否
max_completions_tokens	OpenAI.integer （可为 null）		否
推理努力	OpenAI.ReasoningEffort	限制推理模型。目前支持的值为 `none`、 `minimal`、 `low`、 `mediumhighxhigh`、和。减少推理努力可能会导致更快的响应和更少的标记使用于响应中的推理。 - `gpt-5.1` 默认为 `none`不执行推理。支持的 `gpt-5.1` 推理值为 `none`、 `low`、 `medium`和 `high`。 gpt-5.1 中的所有推理值都支持工具调用。 - 在默认为`gpt-5.1`推理工作之前`medium`的所有模型，并且不支持`none`。 - 模型 `gpt-5-pro` 默认为（且仅支持） `high` 推理工作。之后的所有模型都支持 < a0/> 。	否
~~ 种子	OpenAI.integer （可为 null）		否
~~ 温度	OpenAI.numeric （可为 null）		否
top_p	OpenAI.numeric （可为 null）		否	1
类型	枚举	始终为 `score_model` 的对象类型。可能的值：`score_model`	是的

OpenAI.GraderStringCheck

一个 StringCheckGrader 对象，该对象使用指定的操作在输入和参考之间执行字符串比较。

姓名	类型	Description	必选
输入	字符串	输入文本。这可能包括模板字符串。	是的
姓名	字符串	评分程序的名称。	是的
操作	枚举	要执行的字符串检查操作。 `eq`、`ne`、`like` 或 `ilike` 之一。可能的值：`eq`、`ne`、`like`、`ilike`	是的
引用	字符串	引用文本。这可能包括模板字符串。	是的
类型	枚举	始终为 `string_check` 的对象类型。可能的值：`string_check`	是的

OpenAI.GraderTextSimilarity

TextSimilarityGrader 对象，该对象基于相似性指标对文本进行评分。

姓名	类型	Description	必选
评估指标	枚举	要使用的评估指标。 `cosine`、`fuzzy_match`、`bleu` 之一， `gleu`、、`meteorrouge_1`、`rouge_2`、`rouge_3`、`rouge_4`、、 `rouge_5` 或 `rouge_l`。可能的值：`cosine`、、、`fuzzy_match`、`bleu`、、 `gleumeteorrouge_1rouge_2rouge_3rouge_4rouge_5rouge_l`	是的
输入	字符串	正在评分的文本。	是的
姓名	字符串	评分程序的名称。	是的
引用	字符串	作为评分参照的文本。	是的
类型	枚举	评分程序的类型。可能的值：`text_similarity`	是的

OpenAI.GrammarSyntax1

资产	价值
类型	字符串
价值观	`lark` `regex`

OpenAI.HybridSearchOptions

姓名	类型	Description	必选	违约
embedding_weight	OpenAI.numeric		是的
text_weight	OpenAI.numeric		是的

OpenAI.ImageDetail

资产	价值
类型	字符串
价值观	`low` `high` `auto`

OpenAI.ImageGenTool

一个利用GPT图像模型生成图像的工具。

有效模型：

gpt-image-1
gpt-image-1-mini

姓名	类型	Description	必选	违约
后台的	枚举	生成的图像的背景类型。 `transparent`、 `opaque` 或 `auto` 中的一项。默认值：`auto`。可能的值：`transparent`、、 `opaqueauto`	否
输入保真度	OpenAI.InputFidelity （可为 null）	控制模型在匹配输入图像的样式和特征（尤其是面部特征）方面将付出多少努力。此参数仅支持 `gpt-image-1`。 `gpt-image-1-mini` 不支持此设置。支持 `high` 和 `low`。默认为 `low`。	否
输入图像掩码	OpenAI.ImageGenToolInputImageMask		否
file_id	字符串		否
image_url	字符串		否
模型	字符串（请参阅下面的有效模型）		否
moderation	枚举	生成图像的审核级别。默认值：`auto`。可能的值： `autolow`	否
输出压缩	OpenAI.integer		否	100
输出格式	枚举	生成的图像的输出格式。以下之一：`png`、`webp` 或 `jpeg`。默认值：`png`。可能的值：`png`、、 `webpjpeg`	否
部分图像	OpenAI.integer		否
quality	枚举	生成的图像的质量。 `low`、`medium`、`high` 之一，或 `auto`。默认值：`auto`。可能的值：`low`、`medium`、`high`、`auto`	否
大小	枚举	生成的映像的大小。以下之一：`1024x1024`、`1024x1536`、 `1536x1024` 或 `auto` 中的一项。默认值：`auto`。可能的值：`1024x1024`、`1024x1536`、`1536x1024`、`auto`	否
类型	枚举	图像生成工具的类型。始终为 `image_generation`。可能的值：`image_generation`	是的

OpenAI.ImageGenToolInputImageMask

姓名	类型	Description	必选	违约
file_id	字符串		否
image_url	字符串		否

OpenAI.IncludeEnum

指定要包含在模型响应中的其他输出数据。当前支持的值包括：

web_search_call.action.sources：包括 Web 搜索工具调用的源。
code_interpreter_call.outputs：在代码解释器工具调用项中包含 python 代码执行的输出。
computer_call_output.output.image_url：包括计算机调用输出中的图像 URL。
file_search_call.results：包括通过调用文件搜索工具而获得的搜索结果。
message.input_image.image_url：包括输入消息中的图像 URL。
message.output_text.logprobs：包括含协助消息的 logprob。
reasoning.encrypted_content：在推理项输出中包含推理令牌的加密版本。这样，当无状态使用响应 API 时（如将store参数设置为false，或组织在零数据保留计划中注册时），多轮次对话中可以使用推理内容。

资产	价值
说明	指定要包含在模型响应中的其他输出数据。当前支持的值包括：

web_search_call.action.sources：包括 Web 搜索工具调用的源。
code_interpreter_call.outputs：在代码解释器工具调用项中包含 python 代码执行的输出。
computer_call_output.output.image_url：包括计算机调用输出中的图像 URL。
file_search_call.results：包括通过调用文件搜索工具而获得的搜索结果。
message.input_image.image_url：包括输入消息中的图像 URL。
message.output_text.logprobs：包括含协助消息的 logprob。
reasoning.encrypted_content：在推理项输出中包含推理令牌的加密版本。这样，当无状态使用响应 API 时（如将store参数设置为false，或组织在零数据保留计划中注册时），多轮次对话中可以使用推理内容。 | | 类型 |string | | 值 | file_search_call.results
web_search_call.results
web_search_call.action.sources
message.input_image.image_url
computer_call_output.output.image_url
code_interpreter_call.outputs
reasoning.encrypted_content
message.output_text.logprobs
memory_search_call.results |

OpenAI.InputAudio

模型的音频输入。

姓名	类型	Description	必选	违约
input_audio	OpenAI.InputAudioInputAudio		是的
类型	枚举	输入项的类型。始终为 `input_audio`。可能的值：`input_audio`	是的

OpenAI.InputAudioInputAudio

姓名	类型	Description	必选	违约
数据	字符串		是的
格式	枚举	可能的值： `mp3wav`	是的

OpenAI.InputContent

OpenAI.InputContent 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`input_text`	OpenAI.InputContentInputTextContent
`input_image`	OpenAI.InputContentInputImageContent
`input_file`	OpenAI.InputContentInputFileContent

姓名	类型	Description	必选	违约
类型	OpenAI.InputContentType		是的

OpenAI.InputContentInputFileContent

模型的文件输入。

姓名	类型	Description	必选
file_data	字符串	要发送到模型的文件的内容。	否
file_id	string （可为 null）		否
file_url	字符串	要发送给模型的文件URL。	否
filename	字符串	要发送到模型的文件的名称。	否
类型	枚举	输入项的类型。始终为 `input_file`。可能的值：`input_file`	是的

OpenAI.InputContentInputImageContent

输入到模型中的图像了解图像输入。

姓名	类型	Description	必选
detail	OpenAI.ImageDetail		是的
file_id	string （可为 null）		否
image_url	字符串		否
类型	枚举	输入项的类型。始终为 `input_image`。可能的值：`input_image`	是的

OpenAI.InputContentInputTextContent

模型的文本输入。

姓名	类型	Description	必选	违约
文本消息	字符串	模型的文本输入。	是的
类型	枚举	输入项的类型。始终为 `input_text`。可能的值：`input_text`	是的

OpenAI.InputContentType

资产	价值
类型	字符串
价值观	`input_text` `input_image` `input_file`

OpenAI.InputFidelity

控制模型在匹配输入图像的样式和特征（尤其是面部特征）方面将付出多少努力。此参数仅支持 gpt-image-1。 gpt-image-1-mini 不支持此设置。支持 high 和 low。默认为 low。

资产	价值
类型	字符串
价值观	`high` `low`

OpenAI.InputFileContent

模型的文件输入。

姓名	类型	Description	必选
file_data	字符串	要发送到模型的文件的内容。	否
file_id	string （可为 null）		否
file_url	字符串	要发送给模型的文件URL。	否
filename	字符串	要发送到模型的文件的名称。	否
类型	枚举	输入项的类型。始终为 `input_file`。可能的值：`input_file`	是的

OpenAI.InputFileContentParam

模型的文件输入。

姓名	类型	Description	必选
file_data	string （可为 null）		否
file_id	string （可为 null）		否
file_url	字符串		否
filename	string （可为 null）		否
类型	枚举	输入项的类型。始终为 `input_file`。可能的值：`input_file`	是的

OpenAI.InputImageContent

输入到模型中的图像了解图像输入。

姓名	类型	Description	必选
detail	OpenAI.ImageDetail		是的
file_id	string （可为 null）		否
image_url	字符串		否
类型	枚举	输入项的类型。始终为 `input_image`。可能的值：`input_image`	是的

OpenAI.InputImageContentParamAutoParam

输入到模型中的图像了解图像输入

姓名	类型	Description	必选
detail	OpenAI.DetailEnum （可为 null）		否
file_id	string （可为 null）		否
image_url	字符串		否
类型	枚举	输入项的类型。始终为 `input_image`。可能的值：`input_image`	是的

OpenAI.InputItem

表示由模型生成的响应的上下文的一部分的项。可以包含文本、图像和音频输入，以及以前的助理响应和工具调用输出。

OpenAI.InputItem 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`message`	OpenAI.EasyInputMessage
`item_reference`	OpenAI.ItemReferenceParam
`output_message`	OpenAI.InputItemOutputMessage
`file_search_call`	OpenAI.InputItemFileSearchToolCall
`computer_call`	OpenAI.InputItemComputerToolCall
`computer_call_output`	OpenAI.InputItemComputerCallOutputItemParam
`web_search_call`	OpenAI.InputItemWebSearchToolCall
`function_call`	OpenAI.InputItemFunctionToolCall
`function_call_output`	OpenAI.InputItemFunctionCallOutputItemParam
`reasoning`	OpenAI.InputItemReasoningItem
`compaction`	OpenAI.InputItemCompactionSummaryItemParam
`image_generation_call`	OpenAI.InputItemImageGenToolCall
`code_interpreter_call`	OpenAI.InputItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.InputItemLocalShellToolCall
`local_shell_call_output`	OpenAI.InputItemLocalShellToolCallOutput
`shell_call`	OpenAI.InputItemFunctionShellCallItemParam
`shell_call_output`	OpenAI.InputItemFunctionShellCallOutputItemParam
`apply_patch_call`	OpenAI.InputItemApplyPatchToolCallItemParam
`apply_patch_call_output`	OpenAI.InputItemApplyPatchToolCallOutputItemParam
`mcp_list_tools`	OpenAI.InputItemMcpListTools
`mcp_approval_request`	OpenAI.InputItemMcpApprovalRequest
`mcp_approval_response`	OpenAI.InputItemMcpApprovalResponse
`mcp_call`	OpenAI.InputItemMcpToolCall
`custom_tool_call_output`	OpenAI.InputItemCustomToolCallOutput
`custom_tool_call`	OpenAI.InputItemCustomToolCall

姓名	类型	Description	必选	违约
类型	OpenAI.InputItemType		是的

OpenAI.InputItemApplyPatchToolCallItemParam

一个工具调用，表示请求创建、删除或更新使用diff补丁的文件。

姓名	类型	Description	必选
call_id	字符串	模型生成的应用补丁工具调用的唯一ID。约束： minLength：1，maxLength：64	是的
id	string （可为 null）		否
操作	OpenAI.ApplyPatchOperationParam	apply_patch工具中提供create_file、delete_file或update_file作之一。	是的
└─ 类型	OpenAI.ApplyPatchOperationParamType		是的
状态	OpenAI.ApplyPatchCallStatusParam	apply_patch工具调用时报告的状态值。	是的
类型	枚举	项类型。始终为 `apply_patch_call`。可能的值：`apply_patch_call`	是的

OpenAI.InputItemApplyPatchToolCallOutputItemParam

应用补丁工具调用所输出的流式输出。

姓名	类型	Description	必选
call_id	字符串	模型生成的应用补丁工具调用的唯一ID。约束： minLength：1，maxLength：64	是的
id	string （可为 null）		否
输出	string （可为 null）		否
状态	OpenAI.ApplyPatchCallOutputStatusParam	apply_patch工具调用输出的结果值报告。	是的
类型	枚举	项类型。始终为 `apply_patch_call_output`。可能的值：`apply_patch_call_output`	是的

OpenAI.InputItemCodeInterpreterToolCall

用于运行代码的工具调用。

姓名	类型	Description	必选
代码	string （可为 null）		是的
container_id	字符串	用于运行代码的容器的 ID。	是的
id	字符串	代码解释器工具调用的唯一 ID。	是的
outputs	OpenAI.CodeInterpreterOutputLogs 或 OpenAI.CodeInterpreterOutputImage 的数组		是的
状态	枚举	代码解释器工具调用的状态。有效值为 `in_progress`、`completed`、`incomplete`、`interpreting` 和 `failed`。可能的值：`in_progress`、、`completedincomplete`、`interpreting`、`failed`	是的
类型	枚举	代码解释器工具调用的类型。始终为 `code_interpreter_call`。可能的值：`code_interpreter_call`	是的

OpenAI.InputItemCompactionSummaryItemParam

API生成v1/responses/compact的压缩项。

姓名	类型	Description	必选
encrypted_content	字符串	压缩摘要的加密内容。约束： maxLength：10485760	是的
id	string （可为 null）		否
类型	枚举	项类型。始终为 `compaction`。可能的值：`compaction`	是的

OpenAI.InputItemComputerCallOutputItemParam

计算机工具调用的输出。

姓名	类型	Description	必选
acknowledged_safety_checks	OpenAI.ComputerCallSafetyCheckParam 的数组		否
call_id	字符串	生成输出的计算机工具调用的 ID。约束： minLength：1，maxLength：64	是的
id	string （可为 null）		否
输出	OpenAI.ComputerScreenshotImage	与计算机使用工具一起使用的计算机屏幕截图图像。	是的
状态	OpenAI.FunctionCallItemStatus （可为 null）		否
类型	枚举	计算机工具调用结果的类型。始终为 `computer_call_output`。可能的值：`computer_call_output`	是的

OpenAI.InputItemComputerToolCall

对计算机使用工具的工具调用。更多信息请参见计算机使用指南。

姓名	类型	Description	必选
操作	OpenAI.ComputerAction		是的
call_id	字符串	用输出来响应工具调用时使用的标识符。	是的
id	字符串	计算机调用的唯一 ID。	是的
pending_safety_checks	OpenAI.ComputerCallSafetyCheckParam 的数组	计算机调用的挂起安全检查。	是的
状态	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	是的
类型	枚举	计算机调用的类型。始终为 `computer_call`。可能的值：`computer_call`	是的

OpenAI.InputItemCustomToolCall

调用模型创建的自定义工具。

姓名	类型	Description	必选
call_id	字符串	用于将该自定义工具调用映射到工具调用输出的标识符。	是的
id	字符串	OpenAI平台自定义工具调用的唯一ID。	否
输入	字符串	模型生成的自定义工具调用输入。	是的
姓名	字符串	要调用的自定义工具的名称。	是的
类型	枚举	自定义工具调用的类型。始终为 `custom_tool_call`。可能的值：`custom_tool_call`	是的

OpenAI.InputItemCustomToolCallOutput

你代码中自定义工具调用的输出会被反馈到模型。

姓名	类型	Description	必选
call_id	字符串	调用 ID，用于将该自定义工具调用输出映射到自定义工具调用。	是的
id	字符串	OpenAI 平台自定义工具调用输出的唯一 ID。	否
输出	OpenAI.FunctionAndCustomToolCallOutput 的字符串或数组	你的代码生成的自定义工具调用输出。可以是字符串，也可以是输出内容的列表。	是的
类型	枚举	自定义工具调用输出的类型。始终为 `custom_tool_call_output`。可能的值：`custom_tool_call_output`	是的

OpenAI.InputItemFileSearchToolCall

文件搜索工具调用的结果。更多信息请参见文件搜索指南。

姓名	类型	Description	必选
id	字符串	文件搜索工具调用的唯一 ID。	是的
查询	字符串数组	用于搜索文件的查询。	是的
results	OpenAI.FileSearchToolCallResults 的数组		否
状态	枚举	文件搜索工具调用的状态。 `in_progress`、 `searching`、`incomplete`或`failed` 可能的值：`in_progress`、、`searchingcompleted`、`incomplete`、`failed`	是的
类型	枚举	文件搜索工具调用的类型。始终为 `file_search_call`。可能的值：`file_search_call`	是的

OpenAI.InputItemFunctionCallOutputItemParam

函数工具调用的输出。

姓名	类型	Description	必选
call_id	字符串	模型生成的函数工具调用的唯一 ID。约束： minLength：1，maxLength：64	是的
id	string （可为 null）		否
输出	OpenAI.InputTextContentParam 或 OpenAI.InputImageContentParamAutoParam 或 OpenAI.InputFileContentParam 的字符串或数组	函数工具调用的文本、图像或文件输出。	是的
状态	OpenAI.FunctionCallItemStatus （可为 null）		否
类型	枚举	函数工具调用输出的类型。始终为 `function_call_output`。可能的值：`function_call_output`	是的

OpenAI.InputItemFunctionShellCallItemParam

一个表示执行一个或多个shell命令请求的工具。

姓名	类型	Description	必选
操作	OpenAI.FunctionShellActionParam	描述如何运行shell工具调用的命令和限制。	是的
~~ 命令	字符串数组	命令执行环境运行的 shell 命令。	是的
max_output_length	OpenAI.integer （可为 null）		否
timeout_ms	OpenAI.integer （可为 null）		否
call_id	字符串	模型生成的shell工具调用的唯一ID。约束： minLength：1，maxLength：64	是的
id	string （可为 null）		否
状态	OpenAI.FunctionShellCallItemStatus （可为 null）	shell工具调用时报告的状态值。	否
类型	枚举	项类型。始终为 `shell_call`。可能的值：`shell_call`	是的

OpenAI.InputItemFunctionShellCallOutputItemParam

由shell工具调用发出的流式输出项。

姓名	类型	Description	必选
call_id	字符串	模型生成的shell工具调用的唯一ID。约束： minLength：1，maxLength：64	是的
id	string （可为 null）		否
max_output_length	OpenAI.integer （可为 null）		否
输出	OpenAI.FunctionShellCallOutputContentParam 的数组	捕获的stdout和stderr输出块及其相关结果。	是的
类型	枚举	项类型。始终为 `shell_call_output`。可能的值：`shell_call_output`	是的

OpenAI.InputItemFunctionToolCall

用于运行函数的工具调用。更多信息请参见函数调用指南。

姓名	类型	Description	必选
arguments	字符串	要传递给函数的参数的 JSON 字符串。	是的
call_id	字符串	模型生成的函数工具调用的唯一 ID。	是的
id	字符串	函数工具调用的唯一 ID。	否
姓名	字符串	要运行的函数的名称。	是的
状态	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	否
类型	枚举	函数工具调用的类型。始终为 `function_call`。可能的值：`function_call`	是的

OpenAI.InputItemImageGenToolCall

模型发出的图像生成请求。

姓名	类型	Description	必选
id	字符串	图像生成调用的唯一ID。	是的
结果	string （可为 null）		是的
状态	枚举	图像生成通话状态。可能的值：`in_progress`、`completed`、`generating`、`failed`	是的
类型	枚举	图像生成调用的类型。始终为 `image_generation_call`。可能的值：`image_generation_call`	是的

OpenAI.InputItemLocalShellToolCall

用于在本地 shell 上运行命令的工具调用。

姓名	类型	Description	必选
操作	OpenAI.LocalShellExecAction	在服务器上执行 shell 命令。	是的
call_id	字符串	模型生成的本地 shell 工具调用的唯一 ID。	是的
id	字符串	本地壳调用的唯一ID。	是的
状态	枚举	本地空壳呼叫状态。可能的值：`in_progress`、、 `completedincomplete`	是的
类型	枚举	本地 shell 调用的类型。始终为 `local_shell_call`。可能的值：`local_shell_call`	是的

OpenAI.InputItemLocalShellToolCallOutput

本地 shell 工具调用的输出。

姓名	类型	Description	必选
id	字符串	模型生成的本地 shell 工具调用的唯一 ID。	是的
输出	字符串	本地 shell 工具调用输出的 JSON 字符串。	是的
状态	枚举	可能的值：`in_progress`、、 `completedincomplete`	否
类型	枚举	本地壳工具调用输出的类型。始终为 `local_shell_call_output`。可能的值：`local_shell_call_output`	是的

OpenAI.InputItemMcpApprovalRequest

请求人工批准工具调用。

姓名	类型	Description	必选
arguments	字符串	工具的参数的 JSON 字符串。	是的
id	字符串	批准请求的唯一ID。	是的
姓名	字符串	要运行的工具的名称。	是的
服务器标签	字符串	发出请求的 MCP 服务器的标签。	是的
类型	枚举	项类型。始终为 `mcp_approval_request`。可能的值：`mcp_approval_request`	是的

OpenAI.InputItemMcpApprovalResponse

对 MCP 审批请求的响应。

姓名	类型	Description	必选
approval_request_id	字符串	正在应答的审批请求的 ID。	是的
批准	布尔	请求是否已获得批准。	是的
id	string （可为 null）		否
原因	string （可为 null）		否
类型	枚举	项类型。始终为 `mcp_approval_response`。可能的值：`mcp_approval_response`	是的

OpenAI.InputItemMcpListTools

MCP 服务器上可用的工具列表。

姓名	类型	Description	必选
错误	string （可为 null）		否
id	字符串	名单的唯一ID。	是的
服务器标签	字符串	MCP 服务器的标签。	是的
工具	OpenAI.MCPListToolsToolsTool 的数组	服务器上可用的工具。	是的
类型	枚举	项类型。始终为 `mcp_list_tools`。可能的值：`mcp_list_tools`	是的

OpenAI.InputItemMcpToolCall

在 MCP 服务器上调用工具。

姓名	类型	Description	必选
approval_request_id	string （可为 null）		否
arguments	字符串	传递给工具的参数的 JSON 字符串。	是的
错误	string （可为 null）		否
id	字符串	工具调用的唯一ID。	是的
姓名	字符串	运行的工具的名称。	是的
输出	string （可为 null）		否
服务器标签	字符串	运行该工具的 MCP 服务器的标签。	是的
状态	OpenAI.MCPToolCallStatus		否
类型	枚举	项类型。始终为 `mcp_call`。可能的值：`mcp_call`	是的

OpenAI.InputItemOutputMessage

模型的输出消息。

姓名	类型	Description	必选
内容	OpenAI.OutputMessageContent 的数组	输出消息的内容。	是的
id	字符串	输出消息的唯一 ID。	是的
角色	枚举	输出消息的作用。始终为 `assistant`。可能的值：`assistant`	是的
状态	枚举	消息输入的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回输入项时填充。可能的值：`in_progress`、、 `completedincomplete`	是的
类型	枚举	输出消息的类型。始终为 `message`。可能的值：`output_message`	是的

OpenAI.InputItemReasoningItem

描述推理模型在生成响应时使用的想法链。如果你手动作管理上下文，务必将这些项包含在后续对话的中。

姓名	类型	Description	必选
内容	OpenAI.ReasoningTextContent 数组	推理文本内容。	否
encrypted_content	string （可为 null）		否
id	字符串	推理内容的唯一标识符。	是的
状态	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	否
摘要	OpenAI.Summary 数组	推理摘要内容。	是的
类型	枚举	对象的类型。始终为 `reasoning`。可能的值：`reasoning`	是的

OpenAI.InputItemType

资产价值

类型字符串

价值观 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
item_reference

OpenAI.InputItemWebSearchToolCall

Web 搜索工具调用的结果。更多信息请参见web搜索指南。

姓名	类型	Description	必选
操作	OpenAI.WebSearchActionSearch 或 OpenAI.WebSearchActionOpenPage 或 OpenAI.WebSearchActionFind	描述在此 Web 搜索调用中执行的特定作的对象。包括有关模型如何使用 Web（搜索、open_page、查找）的详细信息。	是的
id	字符串	网络搜索工具的唯一ID呼叫。	是的
状态	枚举	Web 搜索工具调用的状态。可能的值：`in_progress`、`searching`、`completed`、`failed`	是的
类型	枚举	网络搜索工具调用的类型。始终为 `web_search_call`。可能的值：`web_search_call`	是的

OpenAI.InputMessage

模型的消息输入，具有指示以下层次结构的说明的角色。使用 developer 或 system 角色提供的说明优先于角色 user 提供的说明。

姓名	类型	Description	必选
内容	OpenAI.InputMessageContentList	模型包含一个或多个输入项的列表，其中包含不同的内容 types.	是的
角色	枚举	消息输入的角色。 `user`、`system` 或 `developer` 之一。可能的值：`user`、、 `systemdeveloper`	是的
状态	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	否
类型	枚举	消息输入的类型。始终将其设置为 `message`。可能的值：`message`	是的

OpenAI.InputMessageContentList

模型中包含一个或多个输入项的列表，其中包含不同的内容类型。

数组： OpenAI.InputContent

OpenAI.InputMessageResource

姓名	类型	Description	必选
内容	OpenAI.InputMessageContentList	模型包含一个或多个输入项的列表，其中包含不同的内容 types.	是的
id	字符串	消息输入的唯一 ID。	是的
角色	枚举	消息输入的角色。 `user`、`system` 或 `developer` 之一。可能的值：`user`、、 `systemdeveloper`	是的
状态	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	否
类型	枚举	消息输入的类型。始终将其设置为 `message`。可能的值：`message`	是的

OpenAI.InputParam

用于生成响应的模型的文本、图像或文件输入。了解详细信息：

类型：OpenAI.InputItem 的字符串或数组

用于生成响应的模型的文本、图像或文件输入。了解详细信息：

OpenAI.InputTextContent

模型的文本输入。

姓名	类型	Description	必选	违约
文本消息	字符串	模型的文本输入。	是的
类型	枚举	输入项的类型。始终为 `input_text`。可能的值：`input_text`	是的

OpenAI.InputTextContentParam

模型的文本输入。

姓名	类型	Description	必选	违约
文本消息	字符串	模型的文本输入。约束： maxLength：10485760	是的
类型	枚举	输入项的类型。始终为 `input_text`。可能的值：`input_text`	是的

OpenAI.Item

用于生成响应的内容项。

OpenAI.Item 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`memory_search_call`	MemorySearchToolCallItemParam
`message`	OpenAI.InputMessage
`output_message`	OpenAI.ItemOutputMessage
`file_search_call`	OpenAI.ItemFileSearchToolCall
`computer_call`	OpenAI.ItemComputerToolCall
`computer_call_output`	OpenAI.ItemComputerCallOutputItemParam
`web_search_call`	OpenAI.ItemWebSearchToolCall
`function_call`	OpenAI.ItemFunctionToolCall
`function_call_output`	OpenAI.ItemFunctionCallOutputItemParam
`reasoning`	OpenAI.ItemReasoningItem
`compaction`	OpenAI.ItemCompactionSummaryItemParam
`image_generation_call`	OpenAI.ItemImageGenToolCall
`code_interpreter_call`	OpenAI.ItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.ItemLocalShellToolCall
`local_shell_call_output`	OpenAI.ItemLocalShellToolCallOutput
`shell_call`	OpenAI.ItemFunctionShellCallItemParam
`shell_call_output`	OpenAI.ItemFunctionShellCallOutputItemParam
`apply_patch_call`	OpenAI.ItemApplyPatchToolCallItemParam
`apply_patch_call_output`	OpenAI.ItemApplyPatchToolCallOutputItemParam
`mcp_list_tools`	OpenAI.ItemMcpListTools
`mcp_approval_request`	OpenAI.ItemMcpApprovalRequest
`mcp_approval_response`	OpenAI.ItemMcpApprovalResponse
`mcp_call`	OpenAI.ItemMcpToolCall
`custom_tool_call_output`	OpenAI.ItemCustomToolCallOutput
`custom_tool_call`	OpenAI.ItemCustomToolCall

姓名	类型	Description	必选	违约
类型	OpenAI.ItemType		是的

OpenAI.ItemApplyPatchToolCallItemParam

一个工具调用，表示请求创建、删除或更新使用diff补丁的文件。

姓名	类型	Description	必选
call_id	字符串	模型生成的应用补丁工具调用的唯一ID。约束： minLength：1，maxLength：64	是的
id	string （可为 null）		否
操作	OpenAI.ApplyPatchOperationParam	apply_patch工具中提供create_file、delete_file或update_file作之一。	是的
└─ 类型	OpenAI.ApplyPatchOperationParamType		是的
状态	OpenAI.ApplyPatchCallStatusParam	apply_patch工具调用时报告的状态值。	是的
类型	枚举	项类型。始终为 `apply_patch_call`。可能的值：`apply_patch_call`	是的

OpenAI.ItemApplyPatchToolCallOutputItemParam

应用补丁工具调用所输出的流式输出。

姓名	类型	Description	必选
call_id	字符串	模型生成的应用补丁工具调用的唯一ID。约束： minLength：1，maxLength：64	是的
id	string （可为 null）		否
输出	string （可为 null）		否
状态	OpenAI.ApplyPatchCallOutputStatusParam	apply_patch工具调用输出的结果值报告。	是的
类型	枚举	项类型。始终为 `apply_patch_call_output`。可能的值：`apply_patch_call_output`	是的

OpenAI.ItemCodeInterpreterToolCall

用于运行代码的工具调用。

姓名	类型	Description	必选
代码	string （可为 null）		是的
container_id	字符串	用于运行代码的容器的 ID。	是的
id	字符串	代码解释器工具调用的唯一 ID。	是的
outputs	OpenAI.CodeInterpreterOutputLogs 或 OpenAI.CodeInterpreterOutputImage 的数组		是的
状态	枚举	代码解释器工具调用的状态。有效值为 `in_progress`、`completed`、`incomplete`、`interpreting` 和 `failed`。可能的值：`in_progress`、、`completedincomplete`、`interpreting`、`failed`	是的
类型	枚举	代码解释器工具调用的类型。始终为 `code_interpreter_call`。可能的值：`code_interpreter_call`	是的

OpenAI.ItemCompactionSummaryItemParam

API生成v1/responses/compact的压缩项。

姓名	类型	Description	必选
encrypted_content	字符串	压缩摘要的加密内容。约束： maxLength：10485760	是的
id	string （可为 null）		否
类型	枚举	项类型。始终为 `compaction`。可能的值：`compaction`	是的

OpenAI.ItemComputerCallOutputItemParam

计算机工具调用的输出。

姓名	类型	Description	必选
acknowledged_safety_checks	OpenAI.ComputerCallSafetyCheckParam 的数组		否
call_id	字符串	生成输出的计算机工具调用的 ID。约束： minLength：1，maxLength：64	是的
id	string （可为 null）		否
输出	OpenAI.ComputerScreenshotImage	与计算机使用工具一起使用的计算机屏幕截图图像。	是的
状态	OpenAI.FunctionCallItemStatus （可为 null）		否
类型	枚举	计算机工具调用结果的类型。始终为 `computer_call_output`。可能的值：`computer_call_output`	是的

OpenAI.ItemComputerToolCall

对计算机使用工具的工具调用。更多信息请参见计算机使用指南。

姓名	类型	Description	必选
操作	OpenAI.ComputerAction		是的
call_id	字符串	用输出来响应工具调用时使用的标识符。	是的
id	字符串	计算机调用的唯一 ID。	是的
pending_safety_checks	OpenAI.ComputerCallSafetyCheckParam 的数组	计算机调用的挂起安全检查。	是的
状态	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	是的
类型	枚举	计算机调用的类型。始终为 `computer_call`。可能的值：`computer_call`	是的

OpenAI.ItemCustomToolCall

调用模型创建的自定义工具。

姓名	类型	Description	必选
call_id	字符串	用于将该自定义工具调用映射到工具调用输出的标识符。	是的
id	字符串	OpenAI平台自定义工具调用的唯一ID。	否
输入	字符串	模型生成的自定义工具调用输入。	是的
姓名	字符串	要调用的自定义工具的名称。	是的
类型	枚举	自定义工具调用的类型。始终为 `custom_tool_call`。可能的值：`custom_tool_call`	是的

OpenAI.ItemCustomToolCallOutput

你代码中自定义工具调用的输出会被反馈到模型。

姓名	类型	Description	必选
call_id	字符串	调用 ID，用于将该自定义工具调用输出映射到自定义工具调用。	是的
id	字符串	OpenAI 平台自定义工具调用输出的唯一 ID。	否
输出	OpenAI.FunctionAndCustomToolCallOutput 的字符串或数组	你的代码生成的自定义工具调用输出。可以是字符串，也可以是输出内容的列表。	是的
类型	枚举	自定义工具调用输出的类型。始终为 `custom_tool_call_output`。可能的值：`custom_tool_call_output`	是的

OpenAI.ItemFileSearchToolCall

文件搜索工具调用的结果。更多信息请参见文件搜索指南。

姓名	类型	Description	必选
id	字符串	文件搜索工具调用的唯一 ID。	是的
查询	字符串数组	用于搜索文件的查询。	是的
results	OpenAI.FileSearchToolCallResults 的数组		否
状态	枚举	文件搜索工具调用的状态。 `in_progress`、 `searching`、`incomplete`或`failed` 可能的值：`in_progress`、、`searchingcompleted`、`incomplete`、`failed`	是的
类型	枚举	文件搜索工具调用的类型。始终为 `file_search_call`。可能的值：`file_search_call`	是的

OpenAI.ItemFunctionCallOutputItemParam

函数工具调用的输出。

姓名	类型	Description	必选
call_id	字符串	模型生成的函数工具调用的唯一 ID。约束： minLength：1，maxLength：64	是的
id	string （可为 null）		否
输出	OpenAI.InputTextContentParam 或 OpenAI.InputImageContentParamAutoParam 或 OpenAI.InputFileContentParam 的字符串或数组	函数工具调用的文本、图像或文件输出。	是的
状态	OpenAI.FunctionCallItemStatus （可为 null）		否
类型	枚举	函数工具调用输出的类型。始终为 `function_call_output`。可能的值：`function_call_output`	是的

OpenAI.ItemFunctionShellCallItemParam

一个表示执行一个或多个shell命令请求的工具。

姓名	类型	Description	必选
操作	OpenAI.FunctionShellActionParam	描述如何运行shell工具调用的命令和限制。	是的
~~ 命令	字符串数组	命令执行环境运行的 shell 命令。	是的
max_output_length	OpenAI.integer （可为 null）		否
timeout_ms	OpenAI.integer （可为 null）		否
call_id	字符串	模型生成的shell工具调用的唯一ID。约束： minLength：1，maxLength：64	是的
id	string （可为 null）		否
状态	OpenAI.FunctionShellCallItemStatus （可为 null）	shell工具调用时报告的状态值。	否
类型	枚举	项类型。始终为 `shell_call`。可能的值：`shell_call`	是的

OpenAI.ItemFunctionShellCallOutputItemParam

由shell工具调用发出的流式输出项。

姓名	类型	Description	必选
call_id	字符串	模型生成的shell工具调用的唯一ID。约束： minLength：1，maxLength：64	是的
id	string （可为 null）		否
max_output_length	OpenAI.integer （可为 null）		否
输出	OpenAI.FunctionShellCallOutputContentParam 的数组	捕获的stdout和stderr输出块及其相关结果。	是的
类型	枚举	项类型。始终为 `shell_call_output`。可能的值：`shell_call_output`	是的

OpenAI.ItemFunctionToolCall

用于运行函数的工具调用。更多信息请参见函数调用指南。

姓名	类型	Description	必选
arguments	字符串	要传递给函数的参数的 JSON 字符串。	是的
call_id	字符串	模型生成的函数工具调用的唯一 ID。	是的
id	字符串	函数工具调用的唯一 ID。	否
姓名	字符串	要运行的函数的名称。	是的
状态	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	否
类型	枚举	函数工具调用的类型。始终为 `function_call`。可能的值：`function_call`	是的

OpenAI.ItemImageGenToolCall

模型发出的图像生成请求。

姓名	类型	Description	必选
id	字符串	图像生成调用的唯一ID。	是的
结果	string （可为 null）		是的
状态	枚举	图像生成通话状态。可能的值：`in_progress`、`completed`、`generating`、`failed`	是的
类型	枚举	图像生成调用的类型。始终为 `image_generation_call`。可能的值：`image_generation_call`	是的

OpenAI.ItemLocalShellToolCall

用于在本地 shell 上运行命令的工具调用。

姓名	类型	Description	必选
操作	OpenAI.LocalShellExecAction	在服务器上执行 shell 命令。	是的
call_id	字符串	模型生成的本地 shell 工具调用的唯一 ID。	是的
id	字符串	本地壳调用的唯一ID。	是的
状态	枚举	本地空壳呼叫状态。可能的值：`in_progress`、、 `completedincomplete`	是的
类型	枚举	本地 shell 调用的类型。始终为 `local_shell_call`。可能的值：`local_shell_call`	是的

OpenAI.ItemLocalShellToolCallOutput

本地 shell 工具调用的输出。

姓名	类型	Description	必选
id	字符串	模型生成的本地 shell 工具调用的唯一 ID。	是的
输出	字符串	本地 shell 工具调用输出的 JSON 字符串。	是的
状态	枚举	可能的值：`in_progress`、、 `completedincomplete`	否
类型	枚举	本地壳工具调用输出的类型。始终为 `local_shell_call_output`。可能的值：`local_shell_call_output`	是的

OpenAI.ItemMcpApprovalRequest

请求人工批准工具调用。

姓名	类型	Description	必选
arguments	字符串	工具的参数的 JSON 字符串。	是的
id	字符串	批准请求的唯一ID。	是的
姓名	字符串	要运行的工具的名称。	是的
服务器标签	字符串	发出请求的 MCP 服务器的标签。	是的
类型	枚举	项类型。始终为 `mcp_approval_request`。可能的值：`mcp_approval_request`	是的

OpenAI.ItemMcpApprovalResponse

对 MCP 审批请求的响应。

姓名	类型	Description	必选
approval_request_id	字符串	正在应答的审批请求的 ID。	是的
批准	布尔	请求是否已获得批准。	是的
id	string （可为 null）		否
原因	string （可为 null）		否
类型	枚举	项类型。始终为 `mcp_approval_response`。可能的值：`mcp_approval_response`	是的

OpenAI.ItemMcpListTools

MCP 服务器上可用的工具列表。

姓名	类型	Description	必选
错误	string （可为 null）		否
id	字符串	名单的唯一ID。	是的
服务器标签	字符串	MCP 服务器的标签。	是的
工具	OpenAI.MCPListToolsToolsTool 的数组	服务器上可用的工具。	是的
类型	枚举	项类型。始终为 `mcp_list_tools`。可能的值：`mcp_list_tools`	是的

OpenAI.ItemMcpToolCall

在 MCP 服务器上调用工具。

姓名	类型	Description	必选
approval_request_id	string （可为 null）		否
arguments	字符串	传递给工具的参数的 JSON 字符串。	是的
错误	string （可为 null）		否
id	字符串	工具调用的唯一ID。	是的
姓名	字符串	运行的工具的名称。	是的
输出	string （可为 null）		否
服务器标签	字符串	运行该工具的 MCP 服务器的标签。	是的
状态	OpenAI.MCPToolCallStatus		否
类型	枚举	项类型。始终为 `mcp_call`。可能的值：`mcp_call`	是的

OpenAI.ItemOutputMessage

模型的输出消息。

姓名	类型	Description	必选
内容	OpenAI.OutputMessageContent 的数组	输出消息的内容。	是的
id	字符串	输出消息的唯一 ID。	是的
角色	枚举	输出消息的作用。始终为 `assistant`。可能的值：`assistant`	是的
状态	枚举	消息输入的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回输入项时填充。可能的值：`in_progress`、、 `completedincomplete`	是的
类型	枚举	输出消息的类型。始终为 `message`。可能的值：`output_message`	是的

OpenAI.ItemReasoningItem

描述推理模型在生成响应时使用的想法链。如果你手动作管理上下文，务必将这些项包含在后续对话的中。

姓名	类型	Description	必选
内容	OpenAI.ReasoningTextContent 数组	推理文本内容。	否
encrypted_content	string （可为 null）		否
id	字符串	推理内容的唯一标识符。	是的
状态	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	否
摘要	OpenAI.Summary 数组	推理摘要内容。	是的
类型	枚举	对象的类型。始终为 `reasoning`。可能的值：`reasoning`	是的

OpenAI.ItemReferenceParam

要引用的项的内部标识符。

姓名	类型	Description	必选	违约
id	字符串	要引用的项的 ID。	是的
类型	枚举	要引用的项的类型。始终为 `item_reference`。可能的值：`item_reference`	是的

OpenAI.ItemResource

用于生成响应的内容项。

OpenAI.ItemResource 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`message`	OpenAI.InputMessageResource
`output_message`	OpenAI.ItemResourceOutputMessage
`file_search_call`	OpenAI.ItemResourceFileSearchToolCall
`computer_call`	OpenAI.ItemResourceComputerToolCall
`computer_call_output`	OpenAI.ItemResourceComputerToolCallOutputResource
`web_search_call`	OpenAI.ItemResourceWebSearchToolCall
`function_call`	OpenAI.ItemResourceFunctionToolCallResource
`function_call_output`	OpenAI.ItemResourceFunctionToolCallOutputResource
`image_generation_call`	OpenAI.ItemResourceImageGenToolCall
`code_interpreter_call`	OpenAI.ItemResourceCodeInterpreterToolCall
`local_shell_call`	OpenAI.ItemResourceLocalShellToolCall
`local_shell_call_output`	OpenAI.ItemResourceLocalShellToolCallOutput
`shell_call`	OpenAI.ItemResourceFunctionShellCall
`shell_call_output`	OpenAI.ItemResourceFunctionShellCallOutput
`apply_patch_call`	OpenAI.ItemResourceApplyPatchToolCall
`apply_patch_call_output`	OpenAI.ItemResourceApplyPatchToolCallOutput
`mcp_list_tools`	OpenAI.ItemResourceMcpListTools
`mcp_approval_request`	OpenAI.ItemResourceMcpApprovalRequest
`mcp_approval_response`	OpenAI.ItemResourceMcpApprovalResponseResource
`mcp_call`	OpenAI.ItemResourceMcpToolCall

姓名	类型	Description	必选	违约
类型	OpenAI.ItemResourceType		是的

OpenAI.ItemResourceApplyPatchToolCall

通过创建、删除或更新文件来应用文件差异的工具调用。

姓名	类型	Description	必选
call_id	字符串	模型生成的应用补丁工具调用的唯一ID。	是的
created_by	字符串	创建此工具调用的实体的 ID。	否
id	字符串	应用修补工具调用的唯一 ID。通过 API 返回此项时进行填充。	是的
操作	OpenAI.ApplyPatchFileOperation	通过apply_patch应用的create_file、delete_file或update_file作之一。	是的
└─ 类型	OpenAI.ApplyPatchFileOperationType		是的
状态	OpenAI.ApplyPatchCallStatus		是的
类型	枚举	项类型。始终为 `apply_patch_call`。可能的值：`apply_patch_call`	是的

OpenAI.ItemResourceApplyPatchToolCallOutput

应用修补工具调用发出的输出。

姓名	类型	Description	必选
call_id	字符串	模型生成的应用补丁工具调用的唯一ID。	是的
created_by	字符串	创建此工具的实体的 ID 调用输出。	否
id	字符串	应用修补工具调用输出的唯一 ID。通过 API 返回此项时进行填充。	是的
输出	string （可为 null）		否
状态	OpenAI.ApplyPatchCallOutputStatus		是的
类型	枚举	项类型。始终为 `apply_patch_call_output`。可能的值：`apply_patch_call_output`	是的

OpenAI.ItemResourceCodeInterpreterToolCall

用于运行代码的工具调用。

姓名	类型	Description	必选
代码	string （可为 null）		是的
container_id	字符串	用于运行代码的容器的 ID。	是的
id	字符串	代码解释器工具调用的唯一 ID。	是的
outputs	OpenAI.CodeInterpreterOutputLogs 或 OpenAI.CodeInterpreterOutputImage 的数组		是的
状态	枚举	代码解释器工具调用的状态。有效值为 `in_progress`、`completed`、`incomplete`、`interpreting` 和 `failed`。可能的值：`in_progress`、、`completedincomplete`、`interpreting`、`failed`	是的
类型	枚举	代码解释器工具调用的类型。始终为 `code_interpreter_call`。可能的值：`code_interpreter_call`	是的

OpenAI.ItemResourceComputerToolCall

对计算机使用工具的工具调用。更多信息请参见计算机使用指南。

姓名	类型	Description	必选
操作	OpenAI.ComputerAction		是的
call_id	字符串	用输出来响应工具调用时使用的标识符。	是的
id	字符串	计算机调用的唯一 ID。	是的
pending_safety_checks	OpenAI.ComputerCallSafetyCheckParam 的数组	计算机调用的挂起安全检查。	是的
状态	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	是的
类型	枚举	计算机调用的类型。始终为 `computer_call`。可能的值：`computer_call`	是的

OpenAI.ItemResourceComputerToolCallOutputResource

姓名	类型	Description	必选
acknowledged_safety_checks	OpenAI.ComputerCallSafetyCheckParam 的数组	API 报告的安全检查，这些检查的确认者为开发人员。	否
call_id	字符串	生成输出的计算机工具调用的 ID。	是的
id	字符串	计算机工具调用输出的 ID。	否
输出	OpenAI.ComputerScreenshotImage	与计算机使用工具一起使用的计算机屏幕截图图像。	是的
状态	枚举	消息输入的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回输入项时填充。可能的值：`in_progress`、、 `completedincomplete`	否
类型	枚举	计算机工具调用结果的类型。始终为 `computer_call_output`。可能的值：`computer_call_output`	是的

OpenAI.ItemResourceFileSearchToolCall

文件搜索工具调用的结果。更多信息请参见文件搜索指南。

姓名	类型	Description	必选
id	字符串	文件搜索工具调用的唯一 ID。	是的
查询	字符串数组	用于搜索文件的查询。	是的
results	OpenAI.FileSearchToolCallResults 的数组		否
状态	枚举	文件搜索工具调用的状态。 `in_progress`、 `searching`、`incomplete`或`failed` 可能的值：`in_progress`、、`searchingcompleted`、`incomplete`、`failed`	是的
类型	枚举	文件搜索工具调用的类型。始终为 `file_search_call`。可能的值：`file_search_call`	是的

OpenAI.ItemResourceFunctionShellCall

在托管环境中执行一个或多个 shell 命令的工具调用。

姓名	类型	Description	必选
操作	OpenAI.FunctionShellAction	执行 shell 命令。	是的
~~ 命令	字符串数组		是的
max_output_length	OpenAI.integer （可为 null）		是的
timeout_ms	OpenAI.integer （可为 null）		是的
call_id	字符串	模型生成的shell工具调用的唯一ID。	是的
created_by	字符串	创建此工具调用的实体的 ID。	否
id	字符串	shell 工具调用的唯一 ID。通过 API 返回此项时进行填充。	是的
状态	OpenAI.LocalShellCallStatus		是的
类型	枚举	项类型。始终为 `shell_call`。可能的值：`shell_call`	是的

OpenAI.ItemResourceFunctionShellCallOutput

发出的 shell 工具调用的输出。

姓名	类型	Description	必选
call_id	字符串	模型生成的shell工具调用的唯一ID。	是的
created_by	字符串	创建项的执行组件的标识符。	否
id	字符串	shell 调用输出的唯一 ID。通过 API 返回此项时进行填充。	是的
max_output_length	OpenAI.integer （可为 null）		是的
输出	OpenAI.FunctionShellCallOutputContent 的数组	shell 调用输出内容的数组	是的
类型	枚举	shell 调用输出的类型。始终为 `shell_call_output`。可能的值：`shell_call_output`	是的

OpenAI.ItemResourceFunctionToolCallOutputResource

姓名	类型	Description	必选
call_id	字符串	模型生成的函数工具调用的唯一 ID。	是的
id	字符串	函数工具调用输出的唯一 ID。在此项时填充通过 API 返回。	否
输出	OpenAI.FunctionAndCustomToolCallOutput 的字符串或数组	代码生成的函数调用的输出。可以是字符串，也可以是输出内容的列表。	是的
状态	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	否
类型	枚举	函数工具调用输出的类型。始终为 `function_call_output`。可能的值：`function_call_output`	是的

OpenAI.ItemResourceFunctionToolCallResource

姓名	类型	Description	必选
arguments	字符串	要传递给函数的参数的 JSON 字符串。	是的
call_id	字符串	模型生成的函数工具调用的唯一 ID。	是的
id	字符串	函数工具调用的唯一 ID。	否
姓名	字符串	要运行的函数的名称。	是的
状态	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	否
类型	枚举	函数工具调用的类型。始终为 `function_call`。可能的值：`function_call`	是的

OpenAI.ItemResourceImageGenToolCall

模型发出的图像生成请求。

姓名	类型	Description	必选
id	字符串	图像生成调用的唯一ID。	是的
结果	string （可为 null）		是的
状态	枚举	图像生成通话状态。可能的值：`in_progress`、`completed`、`generating`、`failed`	是的
类型	枚举	图像生成调用的类型。始终为 `image_generation_call`。可能的值：`image_generation_call`	是的

OpenAI.ItemResourceLocalShellToolCall

用于在本地 shell 上运行命令的工具调用。

姓名	类型	Description	必选
操作	OpenAI.LocalShellExecAction	在服务器上执行 shell 命令。	是的
call_id	字符串	模型生成的本地 shell 工具调用的唯一 ID。	是的
id	字符串	本地壳调用的唯一ID。	是的
状态	枚举	本地空壳呼叫状态。可能的值：`in_progress`、、 `completedincomplete`	是的
类型	枚举	本地 shell 调用的类型。始终为 `local_shell_call`。可能的值：`local_shell_call`	是的

OpenAI.ItemResourceLocalShellToolCallOutput

本地 shell 工具调用的输出。

姓名	类型	Description	必选
id	字符串	模型生成的本地 shell 工具调用的唯一 ID。	是的
输出	字符串	本地 shell 工具调用输出的 JSON 字符串。	是的
状态	枚举	可能的值：`in_progress`、、 `completedincomplete`	否
类型	枚举	本地壳工具调用输出的类型。始终为 `local_shell_call_output`。可能的值：`local_shell_call_output`	是的

OpenAI.ItemResourceMcpApprovalRequest

请求人工批准工具调用。

姓名	类型	Description	必选
arguments	字符串	工具的参数的 JSON 字符串。	是的
id	字符串	批准请求的唯一ID。	是的
姓名	字符串	要运行的工具的名称。	是的
服务器标签	字符串	发出请求的 MCP 服务器的标签。	是的
类型	枚举	项类型。始终为 `mcp_approval_request`。可能的值：`mcp_approval_request`	是的

OpenAI.ItemResourceMcpApprovalResponseResource

对 MCP 审批请求的响应。

姓名	类型	Description	必选
approval_request_id	字符串	正在应答的审批请求的 ID。	是的
批准	布尔	请求是否已获得批准。	是的
id	字符串	审批响应的唯一 ID	是的
原因	string （可为 null）		否
类型	枚举	项类型。始终为 `mcp_approval_response`。可能的值：`mcp_approval_response`	是的

OpenAI.ItemResourceMcpListTools

MCP 服务器上可用的工具列表。

姓名	类型	Description	必选
错误	string （可为 null）		否
id	字符串	名单的唯一ID。	是的
服务器标签	字符串	MCP 服务器的标签。	是的
工具	OpenAI.MCPListToolsToolsTool 的数组	服务器上可用的工具。	是的
类型	枚举	项类型。始终为 `mcp_list_tools`。可能的值：`mcp_list_tools`	是的

OpenAI.ItemResourceMcpToolCall

在 MCP 服务器上调用工具。

姓名	类型	Description	必选
approval_request_id	string （可为 null）		否
arguments	字符串	传递给工具的参数的 JSON 字符串。	是的
错误	string （可为 null）		否
id	字符串	工具调用的唯一ID。	是的
姓名	字符串	运行的工具的名称。	是的
输出	string （可为 null）		否
服务器标签	字符串	运行该工具的 MCP 服务器的标签。	是的
状态	OpenAI.MCPToolCallStatus		否
类型	枚举	项类型。始终为 `mcp_call`。可能的值：`mcp_call`	是的

OpenAI.ItemResourceOutputMessage

模型的输出消息。

姓名	类型	Description	必选
内容	OpenAI.OutputMessageContent 的数组	输出消息的内容。	是的
id	字符串	输出消息的唯一 ID。	是的
角色	枚举	输出消息的作用。始终为 `assistant`。可能的值：`assistant`	是的
状态	枚举	消息输入的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回输入项时填充。可能的值：`in_progress`、、 `completedincomplete`	是的
类型	枚举	输出消息的类型。始终为 `message`。可能的值：`output_message`	是的

OpenAI.ItemResourceType

资产价值

类型字符串

价值观 message
output_message
file_search_call
computer_call
computer_call_output
web_search_call
function_call
function_call_output
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
structured_outputs
oauth_consent_request
memory_search_call
workflow_action

OpenAI.ItemResourceWebSearchToolCall

Web 搜索工具调用的结果。更多信息请参见web搜索指南。

姓名	类型	Description	必选
操作	OpenAI.WebSearchActionSearch 或 OpenAI.WebSearchActionOpenPage 或 OpenAI.WebSearchActionFind	描述在此 Web 搜索调用中执行的特定作的对象。包括有关模型如何使用 Web（搜索、open_page、查找）的详细信息。	是的
id	字符串	网络搜索工具的唯一ID呼叫。	是的
状态	枚举	Web 搜索工具调用的状态。可能的值：`in_progress`、`searching`、`completed`、`failed`	是的
类型	枚举	网络搜索工具调用的类型。始终为 `web_search_call`。可能的值：`web_search_call`	是的

OpenAI.ItemType

资产价值

类型字符串

OpenAI.ItemWebSearchToolCall

Web 搜索工具调用的结果。更多信息请参见web搜索指南。

姓名	类型	Description	必选
操作	OpenAI.WebSearchActionSearch 或 OpenAI.WebSearchActionOpenPage 或 OpenAI.WebSearchActionFind	描述在此 Web 搜索调用中执行的特定作的对象。包括有关模型如何使用 Web（搜索、open_page、查找）的详细信息。	是的
id	字符串	网络搜索工具的唯一ID呼叫。	是的
状态	枚举	Web 搜索工具调用的状态。可能的值：`in_progress`、`searching`、`completed`、`failed`	是的
类型	枚举	网络搜索工具调用的类型。始终为 `web_search_call`。可能的值：`web_search_call`	是的

OpenAI.KeyPressAction

模型要执行的按键集合。

姓名	类型	Description	必选	违约
钥匙	字符串数组	模型请求按下的键的组合。这是一个字符串数组，每个字符串表示一个键。	是的
类型	枚举	指定事件类型。对于按键操作，此属性始终设置为 `keypress`。可能的值：`keypress`	是的

OpenAI.ListFineTuningJobCheckpointsResponse

姓名	类型	Description	必选
数据	OpenAI.FineTuningJobCheckpoint 数组		是的
first_id	string （可为 null）		否
has_more	布尔		是的
last_id	string （可为 null）		否
对象	枚举	可能的值：`list`	是的

OpenAI.ListFineTuningJobEventsResponse

姓名	类型	Description	必选
数据	OpenAI.FineTuningJobEvent 数组		是的
has_more	布尔		是的
对象	枚举	可能的值：`list`	是的

OpenAI.ListPaginatedFineTuningJobsResponse

姓名	类型	Description	必选
数据	OpenAI.FineTuningJob 数组		是的
has_more	布尔		是的
对象	枚举	可能的值：`list`	是的

OpenAI.LocalShellCallStatus

资产	价值
类型	字符串
价值观	`in_progress` `completed` `incomplete`

OpenAI.LocalShellExecAction

在服务器上执行 shell 命令。

姓名	类型	Description	必选
指令	字符串数组	要运行的命令。	是的
env	对象	要为命令设置的环境变量。	是的
timeout_ms	OpenAI.integer （可为 null）		否
类型	枚举	本地 shell 操作的类型。始终为 `exec`。可能的值：`exec`	是的
用户	string （可为 null）		否
working_directory	string （可为 null）		否

OpenAI.LocalShellToolParam

允许模型在本地环境中执行 shell 命令的工具。

姓名	类型	Description	必选	违约
类型	枚举	本地 shell 工具的类型。始终为 `local_shell`。可能的值：`local_shell`	是的

OpenAI.LogProb

令牌的对数概率。

姓名	类型	必选
字节	OpenAI.integer 数组	是的
logprob	OpenAI.numeric	是的
代币	字符串	是的
top_logprobs	OpenAI.TopLogProb 数组	是的

OpenAI.MCPListToolsTool

MCP 服务器上可用的工具。

姓名	类型	Description	必选
注释	OpenAI.MCPListToolsToolAnnotations （可为 null）		否
说明	string （可为 null）		否
input_schema	OpenAI.MCPListToolsToolInputSchema		是的
姓名	字符串	工具的名称。	是的

OpenAI.MCPListToolsToolAnnotations

类型：对象

OpenAI.MCPListToolsToolInputSchema

类型：对象

OpenAI.MCPTool

通过远程模型上下文协议（MCP）服务器，赋予模型对额外工具的access权限。了解更多关于MCP的信息。

姓名	类型	Description	必选
允许的工具	字符串或 OpenAI.MCPToolFilter 数组		否
授权	字符串	一个可以与远程MCP服务器一起使用的OAuth access令牌，或者使用自定义 MCP 服务器 URL 或服务连接器。应用程序必须处理 OAuth 授权流，并在此处提供令牌。	否
connector_id	枚举	服务连接器的标识符，比如ChatGPT中的连接器。其中一个 `server_url` 或 `connector_id` 必须提供。详细了解服务连接器here。目前支持 `connector_id` 的数值有： -Dropbox： `connector_dropbox` -Gmail： `connector_gmail` - Google 日历： `connector_googlecalendar` - Google Drive： `connector_googledrive` - Microsoft Teams：`connector_microsoftteams` - Outlook 日历： `connector_outlookcalendar` - Outlook 电子邮件： `connector_outlookemail` -Sharepoint： `connector_sharepoint` 可能的值：`connector_dropbox`、、、`connector_gmailconnector_googlecalendar`、`connector_googledriveconnector_microsoftteams`、`connector_outlookcalendar`、、 `connector_outlookemailconnector_sharepoint`	否
标题	对象（可为 null）		否
project_connection_id	字符串	project 中 MCP 服务器的连接 ID。该连接存储连接到 MCP 服务器所需的身份验证和其他连接详细信息。	否
需要审批	对象（请参阅下面的有效模型）		否
server_description	字符串	可选的MCP服务器描述，用于提供更多上下文。	否
服务器标签	字符串	此 MCP 服务器的标签，用于在工具调用中标识它。	是的
server_url（服务器网址）	字符串	MCP 服务器的 URL。其中一个 `server_url` 或 `connector_id` 必须是提供。	否
类型	枚举	MCP 工具的类型。始终为 `mcp`。可能的值：`mcp`	是的

OpenAI.MCPToolCallStatus

资产	价值
类型	字符串
价值观	`in_progress` `completed` `incomplete` `calling` `failed`

OpenAI.MCPToolFilter

一个过滤器对象，用于指定允许使用哪些工具。

姓名	类型	Description	必选	违约
read_only	布尔	表示工具是否修改数据或只读。如果 MCP 服务器使用，进行批`readOnlyHint`注它将与此筛选器匹配。	否
tool_names	字符串数组	允许的工具名称列表。	否

OpenAI.MCPToolRequireApproval

姓名	类型	Description	必选	违约
始终	OpenAI.MCPToolFilter	一个过滤器对象，用于指定允许使用哪些工具。	否
never	OpenAI.MCPToolFilter	一个过滤器对象，用于指定允许使用哪些工具。	否

OpenAI.MessageContent

构成输入或输出项的内容部件。

OpenAI.MessageContent 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	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

姓名	类型	Description	必选	违约
类型	OpenAI.MessageContentType		是的

OpenAI.MessageContentInputFileContent

模型的文件输入。

姓名	类型	Description	必选
file_data	字符串	要发送到模型的文件的内容。	否
file_id	string （可为 null）		否
file_url	字符串	要发送给模型的文件URL。	否
filename	字符串	要发送到模型的文件的名称。	否
类型	枚举	输入项的类型。始终为 `input_file`。可能的值：`input_file`	是的

OpenAI.MessageContentInputImageContent

输入到模型中的图像了解图像输入。

姓名	类型	Description	必选
detail	OpenAI.ImageDetail		是的
file_id	string （可为 null）		否
image_url	字符串		否
类型	枚举	输入项的类型。始终为 `input_image`。可能的值：`input_image`	是的

OpenAI.MessageContentInputTextContent

模型的文本输入。

姓名	类型	Description	必选	违约
文本消息	字符串	模型的文本输入。	是的
类型	枚举	输入项的类型。始终为 `input_text`。可能的值：`input_text`	是的

OpenAI.MessageContentOutputTextContent

模型的文本输出。

姓名	类型	Description	必选
注释	OpenAI.Annotation 数组	文本输出的注释。	是的
logprobs	OpenAI.LogProb 数组		否
文本消息	字符串	模型的文本输出。	是的
类型	枚举	输出文本的类型。始终为 `output_text`。可能的值：`output_text`	是的

OpenAI.MessageContentReasoningTextContent

模型中的推理文本。

姓名	类型	Description	必选	违约
文本消息	字符串	模型中的推理文本。	是的
类型	枚举	推理文本的类型。始终为 `reasoning_text`。可能的值：`reasoning_text`	是的

OpenAI.MessageContentRefusalContent

模型的拒绝。

姓名	类型	Description	必选	违约
拒绝	字符串	模型的拒绝的解释。	是的
类型	枚举	拒绝的类型。始终为 `refusal`。可能的值：`refusal`	是的

OpenAI.MessageContentType

资产	价值
类型	字符串
价值观	`input_text` `output_text` `text` `summary_text` `reasoning_text` `refusal` `input_image` `computer_screenshot` `input_file`

OpenAI.MessageRole

资产	价值
类型	字符串
价值观	`unknown` `user` `assistant` `system` `critic` `discriminator` `developer` `tool`

OpenAI.MessageStatus

资产	价值
类型	字符串
价值观	`in_progress` `completed` `incomplete`

OpenAI.Metadata

按 16 个成组的可附加到对象的键值对。这可用于以结构化格式存储有关对象的其他信息，以及通过 API 或仪表板查询对象。键是最大长度为 64 个字符的字符串。值为最大长度为 512 个字符的字符串。

类型：对象

OpenAI.ModelIdsCompaction

用于生成响应的模型 ID，例如 gpt-5 或 o3。 OpenAI 提供了各种具有不同功能、性能特性和价格点的模型。请参阅模型指南，浏览和比较可用模型。

类型： OpenAI.ModelIdsResponses 或字符串

用于生成响应的模型 ID，例如 gpt-5 或 o3。 OpenAI 提供了各种具有不同功能、性能特性和价格点的模型。请参阅模型指南，浏览和比较可用模型。

OpenAI.ModelIdsResponses

资产	价值
类型	字符串
价值观	`o1-pro` `o1-pro-2025-03-19` `o3-pro` `o3-pro-2025-06-10` `o3-deep-research` `o3-deep-research-2025-06-26` `o4-mini-deep-research` `o4-mini-deep-research-2025-06-26` `computer-use-preview` `computer-use-preview-2025-03-11` `gpt-5-codex` `gpt-5-pro` `gpt-5-pro-2025-10-06` `gpt-5.1-codex-max`

OpenAI.ModelIdsShared

类型：字符串或 OpenAI.ChatModel

OpenAI.Move

鼠标移动操作。

姓名	类型	Description	必选
类型	枚举	指定事件类型。对于移动操作，此属性始终设置为 `move`。可能的值：`move`	是的
x	OpenAI.integer		是的
y	OpenAI.integer		是的

OpenAI.OutputContent

OpenAI.OutputContent 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`output_text`	OpenAI.OutputContentOutputTextContent
`refusal`	OpenAI.OutputContentRefusalContent
`reasoning_text`	OpenAI.OutputContentReasoningTextContent

姓名	类型	Description	必选	违约
类型	OpenAI.OutputContentType		是的

OpenAI.OutputContentOutputTextContent

模型的文本输出。

姓名	类型	Description	必选
注释	OpenAI.Annotation 数组	文本输出的注释。	是的
logprobs	OpenAI.LogProb 数组		否
文本消息	字符串	模型的文本输出。	是的
类型	枚举	输出文本的类型。始终为 `output_text`。可能的值：`output_text`	是的

OpenAI.OutputContentReasoningTextContent

模型中的推理文本。

姓名	类型	Description	必选	违约
文本消息	字符串	模型中的推理文本。	是的
类型	枚举	推理文本的类型。始终为 `reasoning_text`。可能的值：`reasoning_text`	是的

OpenAI.OutputContentRefusalContent

模型的拒绝。

姓名	类型	Description	必选	违约
拒绝	字符串	模型的拒绝的解释。	是的
类型	枚举	拒绝的类型。始终为 `refusal`。可能的值：`refusal`	是的

OpenAI.OutputContentType

资产	价值
类型	字符串
价值观	`output_text` `refusal` `reasoning_text`

OpenAI.OutputItem

OpenAI.OutputItem 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`structured_outputs`	StructuredOutputsOutputItem
`workflow_action`	WorkflowActionOutputItem
`oauth_consent_request`	OAuthConsentRequestOutputItem
`memory_search_call`	MemorySearchToolCallItemResource
`output_message`	OpenAI.OutputItemOutputMessage
`file_search_call`	OpenAI.OutputItemFileSearchToolCall
`function_call`	OpenAI.OutputItemFunctionToolCall
`web_search_call`	OpenAI.OutputItemWebSearchToolCall
`computer_call`	OpenAI.OutputItemComputerToolCall
`reasoning`	OpenAI.OutputItemReasoningItem
`compaction`	OpenAI.OutputItemCompactionBody
`image_generation_call`	OpenAI.OutputItemImageGenToolCall
`code_interpreter_call`	OpenAI.OutputItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.OutputItemLocalShellToolCall
`shell_call`	OpenAI.OutputItemFunctionShellCall
`shell_call_output`	OpenAI.OutputItemFunctionShellCallOutput
`apply_patch_call`	OpenAI.OutputItemApplyPatchToolCall
`apply_patch_call_output`	OpenAI.OutputItemApplyPatchToolCallOutput
`mcp_call`	OpenAI.OutputItemMcpToolCall
`mcp_list_tools`	OpenAI.OutputItemMcpListTools
`mcp_approval_request`	OpenAI.OutputItemMcpApprovalRequest
`custom_tool_call`	OpenAI.OutputItemCustomToolCall

姓名	类型	Description	必选
agent_reference	AgentReference		否
└─ 名称	字符串	代理的名称。约束： maxLength：256	是的
└─ 类型	枚举	可能的值：`agent_reference`	是的
└─ 版本	字符串	代理的版本标识符。	否
response_id	字符串	创建项的响应。	否
类型	OpenAI.OutputItemType		是的

OpenAI.OutputItemApplyPatchToolCall

通过创建、删除或更新文件来应用文件差异的工具调用。

姓名	类型	Description	必选
agent_reference	AgentReference		否
└─ 名称	字符串	代理的名称。约束： maxLength：256	是的
└─ 类型	枚举	可能的值：`agent_reference`	是的
└─ 版本	字符串	代理的版本标识符。	否
call_id	字符串	模型生成的应用补丁工具调用的唯一ID。	是的
created_by	字符串	创建此工具调用的实体的 ID。	否
id	字符串	应用修补工具调用的唯一 ID。通过 API 返回此项时进行填充。	是的
操作	OpenAI.ApplyPatchFileOperation	通过apply_patch应用的create_file、delete_file或update_file作之一。	是的
└─ 类型	OpenAI.ApplyPatchFileOperationType		是的
response_id	字符串	创建项的响应。	否
状态	OpenAI.ApplyPatchCallStatus		是的
类型	枚举	项类型。始终为 `apply_patch_call`。可能的值：`apply_patch_call`	是的

OpenAI.OutputItemApplyPatchToolCallOutput

应用修补工具调用发出的输出。

姓名	类型	Description	必选
agent_reference	AgentReference		否
└─ 名称	字符串	代理的名称。约束： maxLength：256	是的
└─ 类型	枚举	可能的值：`agent_reference`	是的
└─ 版本	字符串	代理的版本标识符。	否
call_id	字符串	模型生成的应用补丁工具调用的唯一ID。	是的
created_by	字符串	创建此工具的实体的 ID 调用输出。	否
id	字符串	应用修补工具调用输出的唯一 ID。通过 API 返回此项时进行填充。	是的
输出	string （可为 null）		否
response_id	字符串	创建项的响应。	否
状态	OpenAI.ApplyPatchCallOutputStatus		是的
类型	枚举	项类型。始终为 `apply_patch_call_output`。可能的值：`apply_patch_call_output`	是的

OpenAI.OutputItemCodeInterpreterToolCall

用于运行代码的工具调用。

姓名	类型	Description	必选
agent_reference	AgentReference		否
└─ 名称	字符串	代理的名称。约束： maxLength：256	是的
└─ 类型	枚举	可能的值：`agent_reference`	是的
└─ 版本	字符串	代理的版本标识符。	否
代码	string （可为 null）		是的
container_id	字符串	用于运行代码的容器的 ID。	是的
id	字符串	代码解释器工具调用的唯一 ID。	是的
outputs	OpenAI.CodeInterpreterOutputLogs 或 OpenAI.CodeInterpreterOutputImage 的数组		是的
response_id	字符串	创建项的响应。	否
状态	枚举	代码解释器工具调用的状态。有效值为 `in_progress`、`completed`、`incomplete`、`interpreting` 和 `failed`。可能的值：`in_progress`、、`completedincomplete`、`interpreting`、`failed`	是的
类型	枚举	代码解释器工具调用的类型。始终为 `code_interpreter_call`。可能的值：`code_interpreter_call`	是的

OpenAI.OutputItemCompactionBody

API生成v1/responses/compact的压缩项。

姓名	类型	Description	必选
agent_reference	AgentReference		否
└─ 名称	字符串	代理的名称。约束： maxLength：256	是的
└─ 类型	枚举	可能的值：`agent_reference`	是的
└─ 版本	字符串	代理的版本标识符。	否
created_by	字符串	创建项的执行组件的标识符。	否
encrypted_content	字符串	压缩生成的加密内容。	是的
id	字符串	压缩项目的唯一ID。	是的
response_id	字符串	创建项的响应。	否
类型	枚举	项类型。始终为 `compaction`。可能的值：`compaction`	是的

OpenAI.OutputItemComputerToolCall

对计算机使用工具的工具调用。更多信息请参见计算机使用指南。

姓名	类型	Description	必选
操作	OpenAI.ComputerAction		是的
agent_reference	AgentReference		否
└─ 名称	字符串	代理的名称。约束： maxLength：256	是的
└─ 类型	枚举	可能的值：`agent_reference`	是的
└─ 版本	字符串	代理的版本标识符。	否
call_id	字符串	用输出来响应工具调用时使用的标识符。	是的
id	字符串	计算机调用的唯一 ID。	是的
pending_safety_checks	OpenAI.ComputerCallSafetyCheckParam 的数组	计算机调用的挂起安全检查。	是的
response_id	字符串	创建项的响应。	否
状态	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	是的
类型	枚举	计算机调用的类型。始终为 `computer_call`。可能的值：`computer_call`	是的

OpenAI.OutputItemCustomToolCall

调用模型创建的自定义工具。

姓名	类型	Description	必选
agent_reference	AgentReference		否
└─ 名称	字符串	代理的名称。约束： maxLength：256	是的
└─ 类型	枚举	可能的值：`agent_reference`	是的
└─ 版本	字符串	代理的版本标识符。	否
call_id	字符串	用于将该自定义工具调用映射到工具调用输出的标识符。	是的
id	字符串	OpenAI平台自定义工具调用的唯一ID。	否
输入	字符串	模型生成的自定义工具调用输入。	是的
姓名	字符串	要调用的自定义工具的名称。	是的
response_id	字符串	创建项的响应。	否
类型	枚举	自定义工具调用的类型。始终为 `custom_tool_call`。可能的值：`custom_tool_call`	是的

OpenAI.OutputItemFileSearchToolCall

文件搜索工具调用的结果。更多信息请参见文件搜索指南。

姓名	类型	Description	必选
agent_reference	AgentReference		否
└─ 名称	字符串	代理的名称。约束： maxLength：256	是的
└─ 类型	枚举	可能的值：`agent_reference`	是的
└─ 版本	字符串	代理的版本标识符。	否
id	字符串	文件搜索工具调用的唯一 ID。	是的
查询	字符串数组	用于搜索文件的查询。	是的
response_id	字符串	创建项的响应。	否
results	OpenAI.FileSearchToolCallResults 的数组		否
状态	枚举	文件搜索工具调用的状态。 `in_progress`、 `searching`、`incomplete`或`failed` 可能的值：`in_progress`、、`searchingcompleted`、`incomplete`、`failed`	是的
类型	枚举	文件搜索工具调用的类型。始终为 `file_search_call`。可能的值：`file_search_call`	是的

OpenAI.OutputItemFunctionShellCall

在托管环境中执行一个或多个 shell 命令的工具调用。

姓名	类型	Description	必选
操作	OpenAI.FunctionShellAction	执行 shell 命令。	是的
~~ 命令	字符串数组		是的
max_output_length	OpenAI.integer （可为 null）		是的
timeout_ms	OpenAI.integer （可为 null）		是的
agent_reference	AgentReference		否
└─ 名称	字符串	代理的名称。约束： maxLength：256	是的
└─ 类型	枚举	可能的值：`agent_reference`	是的
└─ 版本	字符串	代理的版本标识符。	否
call_id	字符串	模型生成的shell工具调用的唯一ID。	是的
created_by	字符串	创建此工具调用的实体的 ID。	否
id	字符串	shell 工具调用的唯一 ID。通过 API 返回此项时进行填充。	是的
response_id	字符串	创建项的响应。	否
状态	OpenAI.LocalShellCallStatus		是的
类型	枚举	项类型。始终为 `shell_call`。可能的值：`shell_call`	是的

OpenAI.OutputItemFunctionShellCallOutput

发出的 shell 工具调用的输出。

姓名	类型	Description	必选
agent_reference	AgentReference		否
└─ 名称	字符串	代理的名称。约束： maxLength：256	是的
└─ 类型	枚举	可能的值：`agent_reference`	是的
└─ 版本	字符串	代理的版本标识符。	否
call_id	字符串	模型生成的shell工具调用的唯一ID。	是的
created_by	字符串	创建项的执行组件的标识符。	否
id	字符串	shell 调用输出的唯一 ID。通过 API 返回此项时进行填充。	是的
max_output_length	OpenAI.integer （可为 null）		是的
输出	OpenAI.FunctionShellCallOutputContent 的数组	shell 调用输出内容的数组	是的
response_id	字符串	创建项的响应。	否
类型	枚举	shell 调用输出的类型。始终为 `shell_call_output`。可能的值：`shell_call_output`	是的

OpenAI.OutputItemFunctionToolCall

用于运行函数的工具调用。更多信息请参见函数调用指南。

姓名	类型	Description	必选
agent_reference	AgentReference		否
└─ 名称	字符串	代理的名称。约束： maxLength：256	是的
└─ 类型	枚举	可能的值：`agent_reference`	是的
└─ 版本	字符串	代理的版本标识符。	否
arguments	字符串	要传递给函数的参数的 JSON 字符串。	是的
call_id	字符串	模型生成的函数工具调用的唯一 ID。	是的
id	字符串	函数工具调用的唯一 ID。	否
姓名	字符串	要运行的函数的名称。	是的
response_id	字符串	创建项的响应。	否
状态	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	否
类型	枚举	函数工具调用的类型。始终为 `function_call`。可能的值：`function_call`	是的

OpenAI.OutputItemImageGenToolCall

模型发出的图像生成请求。

姓名	类型	Description	必选
agent_reference	AgentReference		否
└─ 名称	字符串	代理的名称。约束： maxLength：256	是的
└─ 类型	枚举	可能的值：`agent_reference`	是的
└─ 版本	字符串	代理的版本标识符。	否
id	字符串	图像生成调用的唯一ID。	是的
response_id	字符串	创建项的响应。	否
结果	string （可为 null）		是的
状态	枚举	图像生成通话状态。可能的值：`in_progress`、`completed`、`generating`、`failed`	是的
类型	枚举	图像生成调用的类型。始终为 `image_generation_call`。可能的值：`image_generation_call`	是的

OpenAI.OutputItemLocalShellToolCall

用于在本地 shell 上运行命令的工具调用。

姓名	类型	Description	必选
操作	OpenAI.LocalShellExecAction	在服务器上执行 shell 命令。	是的
agent_reference	AgentReference		否
└─ 名称	字符串	代理的名称。约束： maxLength：256	是的
└─ 类型	枚举	可能的值：`agent_reference`	是的
└─ 版本	字符串	代理的版本标识符。	否
call_id	字符串	模型生成的本地 shell 工具调用的唯一 ID。	是的
id	字符串	本地壳调用的唯一ID。	是的
response_id	字符串	创建项的响应。	否
状态	枚举	本地空壳呼叫状态。可能的值：`in_progress`、、 `completedincomplete`	是的
类型	枚举	本地 shell 调用的类型。始终为 `local_shell_call`。可能的值：`local_shell_call`	是的

OpenAI.OutputItemMcpApprovalRequest

请求人工批准工具调用。

姓名	类型	Description	必选
agent_reference	AgentReference		否
└─ 名称	字符串	代理的名称。约束： maxLength：256	是的
└─ 类型	枚举	可能的值：`agent_reference`	是的
└─ 版本	字符串	代理的版本标识符。	否
arguments	字符串	工具的参数的 JSON 字符串。	是的
id	字符串	批准请求的唯一ID。	是的
姓名	字符串	要运行的工具的名称。	是的
response_id	字符串	创建项的响应。	否
服务器标签	字符串	发出请求的 MCP 服务器的标签。	是的
类型	枚举	项类型。始终为 `mcp_approval_request`。可能的值：`mcp_approval_request`	是的

OpenAI.OutputItemMcpListTools

MCP 服务器上可用的工具列表。

姓名	类型	Description	必选
agent_reference	AgentReference		否
└─ 名称	字符串	代理的名称。约束： maxLength：256	是的
└─ 类型	枚举	可能的值：`agent_reference`	是的
└─ 版本	字符串	代理的版本标识符。	否
错误	string （可为 null）		否
id	字符串	名单的唯一ID。	是的
response_id	字符串	创建项的响应。	否
服务器标签	字符串	MCP 服务器的标签。	是的
工具	OpenAI.MCPListToolsToolsTool 的数组	服务器上可用的工具。	是的
类型	枚举	项类型。始终为 `mcp_list_tools`。可能的值：`mcp_list_tools`	是的

OpenAI.OutputItemMcpToolCall

在 MCP 服务器上调用工具。

姓名	类型	Description	必选
agent_reference	AgentReference		否
└─ 名称	字符串	代理的名称。约束： maxLength：256	是的
└─ 类型	枚举	可能的值：`agent_reference`	是的
└─ 版本	字符串	代理的版本标识符。	否
approval_request_id	string （可为 null）		否
arguments	字符串	传递给工具的参数的 JSON 字符串。	是的
错误	string （可为 null）		否
id	字符串	工具调用的唯一ID。	是的
姓名	字符串	运行的工具的名称。	是的
输出	string （可为 null）		否
response_id	字符串	创建项的响应。	否
服务器标签	字符串	运行该工具的 MCP 服务器的标签。	是的
状态	OpenAI.MCPToolCallStatus		否
类型	枚举	项类型。始终为 `mcp_call`。可能的值：`mcp_call`	是的

OpenAI.OutputItemOutputMessage

模型的输出消息。

姓名	类型	Description	必选
agent_reference	AgentReference		否
└─ 名称	字符串	代理的名称。约束： maxLength：256	是的
└─ 类型	枚举	可能的值：`agent_reference`	是的
└─ 版本	字符串	代理的版本标识符。	否
内容	OpenAI.OutputMessageContent 的数组	输出消息的内容。	是的
id	字符串	输出消息的唯一 ID。	是的
response_id	字符串	创建项的响应。	否
角色	枚举	输出消息的作用。始终为 `assistant`。可能的值：`assistant`	是的
状态	枚举	消息输入的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回输入项时填充。可能的值：`in_progress`、、 `completedincomplete`	是的
类型	枚举	输出消息的类型。始终为 `message`。可能的值：`output_message`	是的

OpenAI.OutputItemReasoningItem

描述推理模型在生成响应时使用的想法链。如果你手动作管理上下文，务必将这些项包含在后续对话的中。

姓名	类型	Description	必选
agent_reference	AgentReference		否
└─ 名称	字符串	代理的名称。约束： maxLength：256	是的
└─ 类型	枚举	可能的值：`agent_reference`	是的
└─ 版本	字符串	代理的版本标识符。	否
内容	OpenAI.ReasoningTextContent 数组	推理文本内容。	否
encrypted_content	string （可为 null）		否
id	字符串	推理内容的唯一标识符。	是的
response_id	字符串	创建项的响应。	否
状态	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	否
摘要	OpenAI.Summary 数组	推理摘要内容。	是的
类型	枚举	对象的类型。始终为 `reasoning`。可能的值：`reasoning`	是的

OpenAI.OutputItemType

资产价值

类型字符串

价值观 output_message
file_search_call
function_call
web_search_call
computer_call
reasoning
compaction
image_generation_call
code_interpreter_call
local_shell_call
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_call
mcp_list_tools
mcp_approval_request
custom_tool_call
structured_outputs
oauth_consent_request
memory_search_call
workflow_action

OpenAI.OutputItemWebSearchToolCall

Web 搜索工具调用的结果。更多信息请参见web搜索指南。

姓名	类型	Description	必选
操作	OpenAI.WebSearchActionSearch 或 OpenAI.WebSearchActionOpenPage 或 OpenAI.WebSearchActionFind	描述在此 Web 搜索调用中执行的特定作的对象。包括有关模型如何使用 Web（搜索、open_page、查找）的详细信息。	是的
agent_reference	AgentReference		否
└─ 名称	字符串	代理的名称。约束： maxLength：256	是的
└─ 类型	枚举	可能的值：`agent_reference`	是的
└─ 版本	字符串	代理的版本标识符。	否
id	字符串	网络搜索工具的唯一ID呼叫。	是的
response_id	字符串	创建项的响应。	否
状态	枚举	Web 搜索工具调用的状态。可能的值：`in_progress`、`searching`、`completed`、`failed`	是的
类型	枚举	网络搜索工具调用的类型。始终为 `web_search_call`。可能的值：`web_search_call`	是的

OpenAI.OutputMessageContent

OpenAI.OutputMessageContent 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`output_text`	OpenAI.OutputMessageContentOutputTextContent
`refusal`	OpenAI.OutputMessageContentRefusalContent

姓名	类型	Description	必选	违约
类型	OpenAI.OutputMessageContentType		是的

OpenAI.OutputMessageContentOutputTextContent

模型的文本输出。

姓名	类型	Description	必选
注释	OpenAI.Annotation 数组	文本输出的注释。	是的
logprobs	OpenAI.LogProb 数组		否
文本消息	字符串	模型的文本输出。	是的
类型	枚举	输出文本的类型。始终为 `output_text`。可能的值：`output_text`	是的

OpenAI.OutputMessageContentRefusalContent

模型的拒绝。

姓名	类型	Description	必选	违约
拒绝	字符串	模型的拒绝的解释。	是的
类型	枚举	拒绝的类型。始终为 `refusal`。可能的值：`refusal`	是的

OpenAI.OutputMessageContentType

资产	价值
类型	字符串
价值观	`output_text` `refusal`

OpenAI.Prompt

对提示模板及其变量的引用。了解更多。

姓名	类型	Description	必选
id	字符串	要使用的提示模板的唯一标识符。	是的
变量	OpenAI.ResponsePromptVariables （可为 null）	可选的值映射，用于替换提示中的变量。替换值可以是字符串，也可以是其他响应输入类型，如图像或文件。	否
版本	string （可为 null）		否

OpenAI.RankerVersionType

资产	价值
类型	字符串
价值观	`auto` `default-2024-11-15`

OpenAI.RankingOptions

姓名	类型	Description	必选
hybrid_search	OpenAI.HybridSearchOptions		否
embedding_weight	OpenAI.numeric	嵌入在倒易秩融合中的权重。	是的
text_weight	OpenAI.numeric	文本权重在互惠排名融合中。	是的
排名程序	OpenAI.RankerVersionType		否
分数阈值	OpenAI.numeric		否

OpenAI.Reasoning

仅限GPT-5和O系列车型 推理模型的配置选项。

姓名	类型	Description	必选
工作量	OpenAI.ReasoningEffort	限制推理模型。目前支持的值为 `none`、 `minimal`、 `low`、 `mediumhighxhigh`、和。减少推理努力可能会导致更快的响应和更少的标记使用于响应中的推理。 - `gpt-5.1` 默认为 `none`不执行推理。支持的 `gpt-5.1` 推理值为 `none`、 `low`、 `medium`和 `high`。 gpt-5.1 中的所有推理值都支持工具调用。 - 在默认为`gpt-5.1`推理工作之前`medium`的所有模型，并且不支持`none`。 - 模型 `gpt-5-pro` 默认为（且仅支持） `high` 推理工作。之后的所有模型都支持 < a0/> 。	否
generate_summary	枚举	可能的值：`auto`、、 `concisedetailed`	否
摘要	枚举	可能的值：`auto`、、 `concisedetailed`	否

OpenAI.ReasoningEffort

限制推理模型的推理力度。目前支持的值为 none、 minimal、 low、 mediumhighxhigh、和。减少推理工作量可以加快回复速度，减少回复中用于推理的标记。

gpt-5.1 默认为 none，不进行推理。支持的 gpt-5.1 推理值为 none、 low、 medium和 high。 gpt-5.1 中的所有推理值都支持工具调用。
所有模型之前 gpt-5.1 默认采用 medium 推理努力，且不支持 none。
该 gpt-5-pro 模型默认（且仅支持） high 推理努力。
xhigh 支持所有之后 gpt-5.1-codex-max的型号。

资产	价值
类型	字符串
空	是的
价值观	`none` `minimal` `low` `medium` `high` `xhigh`

OpenAI.ReasoningTextContent

模型中的推理文本。

姓名	类型	Description	必选	违约
文本消息	字符串	模型中的推理文本。	是的
类型	枚举	推理文本的类型。始终为 `reasoning_text`。可能的值：`reasoning_text`	是的

OpenAI.Response

姓名	类型	Description	必选	违约
agent_reference	AgentReference （可为 null）		是的
└─ 名称	字符串	代理的名称。约束： maxLength：256	是的
└─ 类型	枚举	可能的值：`agent_reference`	是的
└─ 版本	字符串	代理的版本标识符。	否
后台的	布尔值（可为 null）		否
完成时间	整数		否
对话	OpenAI.ConversationReference （可为 null）	此响应所属的对话。此响应中的输入项和输出项会自动添加到此对话。	否
└─ 身份	字符串	与此响应关联的会话的唯一 ID。	是的
创建时间	整数	创建此响应时的 Unix 时间戳（以秒为单位）。	是的
错误	OpenAI.ResponseError （可为 null）	当模型无法生成响应时返回的错误对象。	是的
└─ 代码	OpenAI.ResponseErrorCode	响应的错误代码。	是的
└─ 消息	字符串	可读的错误说明。	是的
id	字符串	此响应的唯一标识符。	是的
incomplete_details	OpenAI.ResponseIncompleteDetails （可为 null）		是的
~~ 原因	枚举	可能的值： `max_output_tokenscontent_filter`	否
instructions	OpenAI.InputItem 的字符串或数组		是的
max_output_tokens	OpenAI.integer （可为 null）		否
max_tool_calls	OpenAI.integer （可为 null）		否
元数据	OpenAI.Metadata （可为 null）	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
模型	字符串	用于创建此响应的模型部署。	否
对象	枚举	此资源的对象类型 - 始终设置为 `response`。可能的值：`response`	是的
输出	OpenAI.OutputItem 数组	模型生成的内容项数组。 - 数组中 `output` 项的长度和顺序取决于于模型的响应。 - 与其访问 `output` 数组中的第一项并假设它是包含模型生成内容的 `assistant` 消息，可以考虑在 SDK 中支持的位置使用 `output_text` 属性。	是的
output_text	string （可为 null）		否
并行工具调用	布尔	是否允许模型并行运行工具调用。	是的	真实
previous_response_id	string （可为 null）		否
提示	OpenAI.Prompt	对提示模板及其变量的引用。了解更多。	否
prompt_cache_key	字符串	OpenAI 用于缓存类似请求的响应，以优化缓存命中率。替换 `user` 字段。了解更多。	否
prompt_cache_retention	枚举	可能的值： `in-memory24h`	否
reasoning	OpenAI.Reasoning （可为 null）	仅 gpt-5 和 o 系列模型配置选项用于推理模型。	否
努力	OpenAI.ReasoningEffort	限制推理模型。目前支持的值为 `none`、 `minimal`、 `low`、 `mediumhighxhigh`、和。减少推理努力可能会导致更快的响应和更少的标记使用于响应中的推理。 - `gpt-5.1` 默认为 `none`不执行推理。支持的 `gpt-5.1` 推理值为 `none`、 `low`、 `medium`和 `high`。 gpt-5.1 中的所有推理值都支持工具调用。 - 在默认为`gpt-5.1`推理工作之前`medium`的所有模型，并且不支持`none`。 - 模型 `gpt-5-pro` 默认为（且仅支持） `high` 推理工作。之后的所有模型都支持 < a0/> 。	否
生成摘要	枚举	可能的值：`auto`、、 `concisedetailed`	否
~~ 摘要	枚举	可能的值：`auto`、、 `concisedetailed`	否
safety_identifier	字符串	用于帮助检测可能违反 OpenAI 使用策略的应用程序的用户的稳定标识符。 ID 应该是唯一标识每个用户的字符串。建议对其用户名或电子邮件地址进行哈希处理，以避免向我们发送任何标识信息。了解更多。	否
服务等级	OpenAI.ServiceTier	指定用于为请求提供服务的处理类型。 - 如果设置为“自动”，则请求将在 Project 设置中配置的服务层级进行处理。除非另有配置，Project 将使用“默认”。 - 如果设置为“default”，则将使用所选模型的标准定价和性能来处理请求。 - 如果设置为“flex”或“priority”，则请求将以相应的服务层级处理。 - 如果未设置，默认行为为“auto”。 `service_tier`设置参数后，响应正文将`service_tier`包含基于实际用于处理请求的处理模式的值。此响应值可能与参数中设置的值不同。	否
状态	枚举	响应生成的状态。以下之一：`completed`、`failed`、 `in_progress`、`cancelled`、`queued` 或 `incomplete`。可能的值：`completed`、、`failed`、`in_progresscancelled`、`queued`、`incomplete`	否
温度	OpenAI.numeric （可为 null）		否	1
文本消息	OpenAI.ResponseTextParam	来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。了解详细信息： - 文本输入输出 - 结构化输出	否
tool_choice	OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceParam		否
工具	OpenAI.ToolsArray	生成响应时，模型可能会调用的工具数组。你可以通过设置 `tool_choice` 参数来指定要使用的工具。我们支持以下类别的工具： - 内置工具：OpenAI 提供的工具，用于扩展模型的功能，比如Web Search 或file search。详细了解内置工具。 - MCP 工具：通过自定义 MCP 服务器与第三方系统集成或预定义的连接器，如 Google Drive 和 SharePoint。详细了解 MCP 工具。 - 函数调用（自定义工具）：由你定义的函数，使模型能够使用强类型参数调用自己的代码和输出。详细了解函数调用。还可以使用用于调用自己的代码的自定义工具。	否
top_logprobs	OpenAI.integer （可为 null）		否
top_p	OpenAI.numeric （可为 null）		否	1
truncation	枚举	可能的值： `autodisabled`	否
使用情况	OpenAI.ResponseUsage	表示令牌使用情况详细信息，包括输入令牌、输出令牌、输出令牌的细分以及所使用的令牌总数。	否
用户	string （已弃用）	此字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。改用 `prompt_cache_key` 来维护缓存优化。最终用户的稳定标识符。用于通过更好地存储类似的请求来提升缓存命中率，并帮助 OpenAI 检测和防止滥用。了解更多。	否

OpenAI.ResponseAudioDeltaEvent

当有部分音频响应时发出。

姓名	类型	Description	必选
三角洲	字符串	Base64 编码的音频字节块。	是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.audio.delta`。可能的值：`response.audio.delta`	是的

OpenAI.ResponseAudioDoneEvent

当音频响应完成时发出。

姓名	类型	Description	必选	违约
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.audio.done`。可能的值：`response.audio.done`	是的

OpenAI.ResponseAudioTranscriptDeltaEvent

当有音频的部分转录时发出。

姓名	类型	Description	必选
三角洲	字符串	音频响应的部分转录。	是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.audio.transcript.delta`。可能的值：`response.audio.transcript.delta`	是的

OpenAI.ResponseAudioTranscriptDoneEvent

完成全部音频转录时发出。

姓名	类型	Description	必选	违约
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.audio.transcript.done`。可能的值：`response.audio.transcript.done`	是的

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

由代码解释器流式传输部分代码片段时发出。

姓名	类型	Description	必选
三角洲	字符串	代码解释器正在流式传输的部分代码片段。	是的
item_id	字符串	代码解释器工具调用项的唯一标识符。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.code_interpreter_call_code.delta`。可能的值：`response.code_interpreter_call_code.delta`	是的

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

当代码片段由代码解释器完成时发出。

姓名	类型	Description	必选
代码	字符串	代码解释器输出的最终代码片段。	是的
item_id	字符串	代码解释器工具调用项的唯一标识符。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.code_interpreter_call_code.done`。可能的值：`response.code_interpreter_call_code.done`	是的

OpenAI.ResponseCodeInterpreterCallCompletedEvent

在代码解释器调用完成时发出。

姓名	类型	Description	必选
item_id	字符串	代码解释器工具调用项的唯一标识符。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.code_interpreter_call.completed`。可能的值：`response.code_interpreter_call.completed`	是的

OpenAI.ResponseCodeInterpreterCallInProgressEvent

代码解释器调用正在进行时发出。

姓名	类型	Description	必选
item_id	字符串	代码解释器工具调用项的唯一标识符。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.code_interpreter_call.in_progress`。可能的值：`response.code_interpreter_call.in_progress`	是的

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

当代码解释器主动解释代码片段时发出。

姓名	类型	Description	必选
item_id	字符串	代码解释器工具调用项的唯一标识符。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.code_interpreter_call.interpreting`。可能的值：`response.code_interpreter_call.interpreting`	是的

OpenAI.ResponseCompletedEvent

模型响应完成时发出。

姓名	类型	Description	必选	违约
response	OpenAI.Response		是的
agent_reference	AgentReference （可为 null）	用于此响应的代理	是的
~~ 背景	布尔值（可为 null）		否
completed_at	integer （可为 null）		否
~~ 对话	OpenAI.ConversationReference （可为 null）	此响应所属的对话。此响应中的输入项和输出项会自动添加到此对话。	否
created_at	整数	创建此响应时的 Unix 时间戳（以秒为单位）。	是的
~~ 错误	OpenAI.ResponseError （可为 null）	当模型无法生成响应时返回的错误对象。	是的
└─ 身份	字符串	此响应的唯一标识符。	是的
不完整的详细信息	OpenAI.ResponseIncompleteDetails （可为 null）		是的
└─ 说明	OpenAI.InputItem 的字符串或数组（可为 null）		是的
max_output_tokens（最大输出标记数）	OpenAI.integer （可为 null）		否
max_tool_calls	OpenAI.integer （可为 null）		否
└─ 元数据	OpenAI.Metadata （可为 null）	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
└─ 模型	字符串	用于创建此响应的模型部署。	否
~~ 对象	枚举	此资源的对象类型 - 始终设置为 `response`。可能的值：`response`	是的
└─ 输出	OpenAI.OutputItem 数组	模型生成的内容项数组。 - 数组中 `output` 项的长度和顺序取决于于模型的响应。 - 与其访问 `output` 数组中的第一项并假设它是包含模型生成内容的 `assistant` 消息，可以考虑在 SDK 中支持的位置使用 `output_text` 属性。	是的
输出文本	string （可为 null）		否
并行工具调用	布尔	是否允许模型并行运行工具调用。	是的	真实
previous_response_id	string （可为 null）		否
└─ 提示	OpenAI.Prompt	对提示模板及其变量的引用。了解更多。	否
prompt_cache_key	字符串	OpenAI 用于缓存类似请求的响应，以优化缓存命中率。替换 `user` 字段。了解更多。	否
prompt_cache_retention	枚举	可能的值： `in-memory24h`	否
└─推理	OpenAI.Reasoning （可为 null）	仅 gpt-5 和 o 系列模型配置选项用于推理模型。	否
safety_identifier	字符串	用于帮助检测可能违反 OpenAI 使用策略的应用程序的用户的稳定标识符。 ID 应该是唯一标识每个用户的字符串。建议对其用户名或电子邮件地址进行哈希处理，以避免向我们发送任何标识信息。了解更多。	否
service_tier	OpenAI.ServiceTier	指定用于为请求提供服务的处理类型。 - 如果设置为“自动”，则请求将在 Project 设置中配置的服务层级进行处理。除非另有配置，Project 将使用“默认”。 - 如果设置为“default”，则将使用所选模型的标准定价和性能来处理请求。 - 如果设置为“flex”或“priority”，则请求将以相应的服务层级处理。 - 如果未设置，默认行为为“auto”。 `service_tier`设置参数后，响应正文将`service_tier`包含基于实际用于处理请求的处理模式的值。此响应值可能与参数中设置的值不同。	否
└─ 状态	枚举	响应生成的状态。以下之一：`completed`、`failed`、 `in_progress`、`cancelled`、`queued` 或 `incomplete`。可能的值：`completed`、、`failed`、`in_progresscancelled`、`queued`、`incomplete`	否
~~ 温度	OpenAI.numeric （可为 null）		否	1
└─ 文本	OpenAI.ResponseTextParam	来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。了解详细信息： - 文本输入输出 - 结构化输出	否
工具选择	OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceParam		否
└─ 工具	OpenAI.ToolsArray	生成响应时，模型可能会调用的工具数组。你可以通过设置 `tool_choice` 参数来指定要使用的工具。我们支持以下类别的工具： - 内置工具：OpenAI 提供的工具，用于扩展模型的功能，比如Web Search 或file search。详细了解内置工具。 - MCP 工具：通过自定义 MCP 服务器与第三方系统集成或预定义的连接器，如 Google Drive 和 SharePoint。详细了解 MCP 工具。 - 函数调用（自定义工具）：由你定义的函数，使模型能够使用强类型参数调用自己的代码和输出。详细了解函数调用。还可以使用用于调用自己的代码的自定义工具。	否
top_logprobs	OpenAI.integer （可为 null）		否
top_p	OpenAI.numeric （可为 null）		否	1
└─ 截断	枚举	可能的值： `autodisabled`	否
└─ 用法	OpenAI.ResponseUsage	表示令牌使用情况详细信息，包括输入令牌、输出令牌、输出令牌的细分以及所使用的令牌总数。	否
└─ 用户	string （已弃用）	此字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。改用 `prompt_cache_key` 来维护缓存优化。最终用户的稳定标识符。用于通过更好地存储类似的请求来提升缓存命中率，并帮助 OpenAI 检测和防止滥用。了解更多。	否
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.completed`。可能的值：`response.completed`	是的

OpenAI.ResponseContentPartAddedEvent

添加新内容部分时发出。

姓名	类型	Description	必选
content_index	OpenAI.integer		是的
item_id	字符串	将内容部分添加到的输出项的 ID。	是的
output_index	OpenAI.integer		是的
部件	OpenAI.OutputContent		是的
└─ 类型	OpenAI.OutputContentType		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.content_part.added`。可能的值：`response.content_part.added`	是的

OpenAI.ResponseContentPartDoneEvent

完成内容部分时发出。

姓名	类型	Description	必选
content_index	OpenAI.integer		是的
item_id	字符串	将内容部分添加到的输出项的 ID。	是的
output_index	OpenAI.integer		是的
部件	OpenAI.OutputContent		是的
└─ 类型	OpenAI.OutputContentType		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.content_part.done`。可能的值：`response.content_part.done`	是的

OpenAI.ResponseCreatedEvent

创建响应时发出的事件。

姓名	类型	Description	必选	违约
response	OpenAI.Response		是的
agent_reference	AgentReference （可为 null）	用于此响应的代理	是的
~~ 背景	布尔值（可为 null）		否
completed_at	integer （可为 null）		否
~~ 对话	OpenAI.ConversationReference （可为 null）	此响应所属的对话。此响应中的输入项和输出项会自动添加到此对话。	否
created_at	整数	创建此响应时的 Unix 时间戳（以秒为单位）。	是的
~~ 错误	OpenAI.ResponseError （可为 null）	当模型无法生成响应时返回的错误对象。	是的
└─ 身份	字符串	此响应的唯一标识符。	是的
不完整的详细信息	OpenAI.ResponseIncompleteDetails （可为 null）		是的
└─ 说明	OpenAI.InputItem 的字符串或数组（可为 null）		是的
max_output_tokens（最大输出标记数）	OpenAI.integer （可为 null）		否
max_tool_calls	OpenAI.integer （可为 null）		否
└─ 元数据	OpenAI.Metadata （可为 null）	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
└─ 模型	字符串	用于创建此响应的模型部署。	否
~~ 对象	枚举	此资源的对象类型 - 始终设置为 `response`。可能的值：`response`	是的
└─ 输出	OpenAI.OutputItem 数组	模型生成的内容项数组。 - 数组中 `output` 项的长度和顺序取决于于模型的响应。 - 与其访问 `output` 数组中的第一项并假设它是包含模型生成内容的 `assistant` 消息，可以考虑在 SDK 中支持的位置使用 `output_text` 属性。	是的
输出文本	string （可为 null）		否
并行工具调用	布尔	是否允许模型并行运行工具调用。	是的	真实
previous_response_id	string （可为 null）		否
└─ 提示	OpenAI.Prompt	对提示模板及其变量的引用。了解更多。	否
prompt_cache_key	字符串	OpenAI 用于缓存类似请求的响应，以优化缓存命中率。替换 `user` 字段。了解更多。	否
prompt_cache_retention	枚举	可能的值： `in-memory24h`	否
└─推理	OpenAI.Reasoning （可为 null）	仅 gpt-5 和 o 系列模型配置选项用于推理模型。	否
safety_identifier	字符串	用于帮助检测可能违反 OpenAI 使用策略的应用程序的用户的稳定标识符。 ID 应该是唯一标识每个用户的字符串。建议对其用户名或电子邮件地址进行哈希处理，以避免向我们发送任何标识信息。了解更多。	否
service_tier	OpenAI.ServiceTier	指定用于为请求提供服务的处理类型。 - 如果设置为“自动”，则请求将在 Project 设置中配置的服务层级进行处理。除非另有配置，Project 将使用“默认”。 - 如果设置为“default”，则将使用所选模型的标准定价和性能来处理请求。 - 如果设置为“flex”或“priority”，则请求将以相应的服务层级处理。 - 如果未设置，默认行为为“auto”。 `service_tier`设置参数后，响应正文将`service_tier`包含基于实际用于处理请求的处理模式的值。此响应值可能与参数中设置的值不同。	否
└─ 状态	枚举	响应生成的状态。以下之一：`completed`、`failed`、 `in_progress`、`cancelled`、`queued` 或 `incomplete`。可能的值：`completed`、、`failed`、`in_progresscancelled`、`queued`、`incomplete`	否
~~ 温度	OpenAI.numeric （可为 null）		否	1
└─ 文本	OpenAI.ResponseTextParam	来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。了解详细信息： - 文本输入输出 - 结构化输出	否
工具选择	OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceParam		否
└─ 工具	OpenAI.ToolsArray	生成响应时，模型可能会调用的工具数组。你可以通过设置 `tool_choice` 参数来指定要使用的工具。我们支持以下类别的工具： - 内置工具：OpenAI 提供的工具，用于扩展模型的功能，比如Web Search 或file search。详细了解内置工具。 - MCP 工具：通过自定义 MCP 服务器与第三方系统集成或预定义的连接器，如 Google Drive 和 SharePoint。详细了解 MCP 工具。 - 函数调用（自定义工具）：由你定义的函数，使模型能够使用强类型参数调用自己的代码和输出。详细了解函数调用。还可以使用用于调用自己的代码的自定义工具。	否
top_logprobs	OpenAI.integer （可为 null）		否
top_p	OpenAI.numeric （可为 null）		否	1
└─ 截断	枚举	可能的值： `autodisabled`	否
└─ 用法	OpenAI.ResponseUsage	表示令牌使用情况详细信息，包括输入令牌、输出令牌、输出令牌的细分以及所使用的令牌总数。	否
└─ 用户	string （已弃用）	此字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。改用 `prompt_cache_key` 来维护缓存优化。最终用户的稳定标识符。用于通过更好地存储类似的请求来提升缓存命中率，并帮助 OpenAI 检测和防止滥用。了解更多。	否
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.created`。可能的值：`response.created`	是的

OpenAI.ResponseCustomToolCallInputDeltaEvent

表示自定义工具调用输入的增量（部分更新）的事件。

姓名	类型	Description	必选
三角洲	字符串	自定义工具调用的增量输入数据（增量）。	是的
item_id	字符串	与此事件关联的 API 项的唯一标识符。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型标识符。可能的值：`response.custom_tool_call_input.delta`	是的

OpenAI.ResponseCustomToolCallInputDoneEvent

指示自定义工具调用的输入已完成的事件。

姓名	类型	Description	必选
输入	字符串	自定义工具调用的完整输入数据。	是的
item_id	字符串	与此事件关联的 API 项的唯一标识符。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型标识符。可能的值：`response.custom_tool_call_input.done`	是的

OpenAI.ResponseError

当模型无法生成响应时返回的错误对象。

姓名	类型	Description	必选	违约
代码	OpenAI.ResponseErrorCode	响应的错误代码。	是的
消息	字符串	可读的错误说明。	是的

OpenAI.ResponseErrorCode

响应的错误代码。

资产	价值
类型	字符串
价值观	`server_error` `rate_limit_exceeded` `invalid_prompt` `vector_store_timeout` `invalid_image` `invalid_image_format` `invalid_base64_image` `invalid_image_url` `image_too_large` `image_too_small` `image_parse_error` `image_content_policy_violation` `invalid_image_mode` `image_file_too_large` `unsupported_image_media_type` `empty_image_file` `failed_to_download_image` `image_file_not_found`

OpenAI.ResponseErrorEvent

在发生错误时发出。

姓名	类型	Description	必选
代码	string （可为 null）		是的
消息	字符串	错误消息。	是的
param	string （可为 null）		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `error`。可能的值：`error`	是的

OpenAI.ResponseFailedEvent

响应失败时发出的事件。

姓名	类型	Description	必选	违约
response	OpenAI.Response		是的
agent_reference	AgentReference （可为 null）	用于此响应的代理	是的
~~ 背景	布尔值（可为 null）		否
completed_at	integer （可为 null）		否
~~ 对话	OpenAI.ConversationReference （可为 null）	此响应所属的对话。此响应中的输入项和输出项会自动添加到此对话。	否
created_at	整数	创建此响应时的 Unix 时间戳（以秒为单位）。	是的
~~ 错误	OpenAI.ResponseError （可为 null）	当模型无法生成响应时返回的错误对象。	是的
└─ 身份	字符串	此响应的唯一标识符。	是的
不完整的详细信息	OpenAI.ResponseIncompleteDetails （可为 null）		是的
└─ 说明	OpenAI.InputItem 的字符串或数组（可为 null）		是的
max_output_tokens（最大输出标记数）	OpenAI.integer （可为 null）		否
max_tool_calls	OpenAI.integer （可为 null）		否
└─ 元数据	OpenAI.Metadata （可为 null）	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
└─ 模型	字符串	用于创建此响应的模型部署。	否
~~ 对象	枚举	此资源的对象类型 - 始终设置为 `response`。可能的值：`response`	是的
└─ 输出	OpenAI.OutputItem 数组	模型生成的内容项数组。 - 数组中 `output` 项的长度和顺序取决于于模型的响应。 - 与其访问 `output` 数组中的第一项并假设它是包含模型生成内容的 `assistant` 消息，可以考虑在 SDK 中支持的位置使用 `output_text` 属性。	是的
输出文本	string （可为 null）		否
并行工具调用	布尔	是否允许模型并行运行工具调用。	是的	真实
previous_response_id	string （可为 null）		否
└─ 提示	OpenAI.Prompt	对提示模板及其变量的引用。了解更多。	否
prompt_cache_key	字符串	OpenAI 用于缓存类似请求的响应，以优化缓存命中率。替换 `user` 字段。了解更多。	否
prompt_cache_retention	枚举	可能的值： `in-memory24h`	否
└─推理	OpenAI.Reasoning （可为 null）	仅 gpt-5 和 o 系列模型配置选项用于推理模型。	否
safety_identifier	字符串	用于帮助检测可能违反 OpenAI 使用策略的应用程序的用户的稳定标识符。 ID 应该是唯一标识每个用户的字符串。建议对其用户名或电子邮件地址进行哈希处理，以避免向我们发送任何标识信息。了解更多。	否
service_tier	OpenAI.ServiceTier	指定用于为请求提供服务的处理类型。 - 如果设置为“自动”，则请求将在 Project 设置中配置的服务层级进行处理。除非另有配置，Project 将使用“默认”。 - 如果设置为“default”，则将使用所选模型的标准定价和性能来处理请求。 - 如果设置为“flex”或“priority”，则请求将以相应的服务层级处理。 - 如果未设置，默认行为为“auto”。 `service_tier`设置参数后，响应正文将`service_tier`包含基于实际用于处理请求的处理模式的值。此响应值可能与参数中设置的值不同。	否
└─ 状态	枚举	响应生成的状态。以下之一：`completed`、`failed`、 `in_progress`、`cancelled`、`queued` 或 `incomplete`。可能的值：`completed`、、`failed`、`in_progresscancelled`、`queued`、`incomplete`	否
~~ 温度	OpenAI.numeric （可为 null）		否	1
└─ 文本	OpenAI.ResponseTextParam	来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。了解详细信息： - 文本输入输出 - 结构化输出	否
工具选择	OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceParam		否
└─ 工具	OpenAI.ToolsArray	生成响应时，模型可能会调用的工具数组。你可以通过设置 `tool_choice` 参数来指定要使用的工具。我们支持以下类别的工具： - 内置工具：OpenAI 提供的工具，用于扩展模型的功能，比如Web Search 或file search。详细了解内置工具。 - MCP 工具：通过自定义 MCP 服务器与第三方系统集成或预定义的连接器，如 Google Drive 和 SharePoint。详细了解 MCP 工具。 - 函数调用（自定义工具）：由你定义的函数，使模型能够使用强类型参数调用自己的代码和输出。详细了解函数调用。还可以使用用于调用自己的代码的自定义工具。	否
top_logprobs	OpenAI.integer （可为 null）		否
top_p	OpenAI.numeric （可为 null）		否	1
└─ 截断	枚举	可能的值： `autodisabled`	否
└─ 用法	OpenAI.ResponseUsage	表示令牌使用情况详细信息，包括输入令牌、输出令牌、输出令牌的细分以及所使用的令牌总数。	否
└─ 用户	string （已弃用）	此字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。改用 `prompt_cache_key` 来维护缓存优化。最终用户的稳定标识符。用于通过更好地存储类似的请求来提升缓存命中率，并帮助 OpenAI 检测和防止滥用。了解更多。	否
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.failed`。可能的值：`response.failed`	是的

OpenAI.ResponseFileSearchCallCompletedEvent

在文件搜索调用完成时发出（找到结果）。

姓名	类型	Description	必选
item_id	字符串	启动文件搜索调用的输出项的 ID。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.file_search_call.completed`。可能的值：`response.file_search_call.completed`	是的

OpenAI.ResponseFileSearchCallInProgressEvent

在启动文件搜索调用时发出。

姓名	类型	Description	必选
item_id	字符串	启动文件搜索调用的输出项的 ID。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.file_search_call.in_progress`。可能的值：`response.file_search_call.in_progress`	是的

OpenAI.ResponseFileSearchCallSearchingEvent

当文件搜索当前正在搜索时发出。

姓名	类型	Description	必选
item_id	字符串	启动文件搜索调用的输出项的 ID。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.file_search_call.searching`。可能的值：`response.file_search_call.searching`	是的

OpenAI.ResponseFormatJsonObject

姓名	类型	Description	必选	违约
类型	枚举	要定义的响应格式的类型。始终为 `json_object`。可能的值：`json_object`	是的

OpenAI.ResponseFormatJsonSchema

JSON 架构响应格式。用于生成结构化 JSON 响应。了解更多关于结构化输出。

姓名	类型	Description	必选
json_schema	OpenAI.ResponseFormatJsonSchemaJsonSchema		是的
└─ 说明	字符串		否
└─ 名称	字符串		是的
└─ 架构	OpenAI.ResponseFormatJsonSchemaSchema	响应格式的架构，描述为 JSON 架构对象。了解如何在此处生成 JSON 架构。	否
└─ 严格	布尔值（可为 null）		否
类型	枚举	要定义的响应格式的类型。始终为 `json_schema`。可能的值：`json_schema`	是的

OpenAI.ResponseFormatJsonSchemaJsonSchema

姓名	类型	Description	必选
说明	字符串		否
姓名	字符串		是的
架构	OpenAI.ResponseFormatJsonSchemaSchema	响应格式的架构，描述为 JSON 架构对象。了解如何在此处生成 JSON 架构。	否
strict	布尔值（可为 null）		否

OpenAI.ResponseFormatJsonSchemaSchema

响应格式的架构，描述为 JSON 架构对象。了解如何在此处生成 JSON 架构。

类型：对象

OpenAI.ResponseFormatText

默认响应格式。用于生成文本响应。

姓名	类型	Description	必选	违约
类型	枚举	要定义的响应格式的类型。始终为 `text`。可能的值：`text`	是的

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

当存在部分函数调用参数增量时发出。

姓名	类型	Description	必选
三角洲	字符串	添加的函数调用参数增量。	是的
item_id	字符串	函数调用参数增量添加到的输出项的 ID。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.function_call_arguments.delta`。可能的值：`response.function_call_arguments.delta`	是的

OpenAI.ResponseFunctionCallArgumentsDoneEvent

在函数调用参数完成时发出。

姓名	类型	Description	必选
arguments	字符串	函数调用参数。	是的
item_id	字符串	项的 ID。	是的
姓名	字符串	调用的函数的名称。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	可能的值：`response.function_call_arguments.done`	是的

OpenAI.ResponseImageGenCallCompletedEvent

当映像生成工具调用完成并且最终映像可用时发出。

姓名	类型	Description	必选
item_id	字符串	正在处理的图像生成项的唯一标识符。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为“response.image_generation_call.completed”。可能的值：`response.image_generation_call.completed`	是的

OpenAI.ResponseImageGenCallGeneratingEvent

当映像生成工具调用正在主动生成映像（中间状态）时发出。

姓名	类型	Description	必选
item_id	字符串	正在处理的图像生成项的唯一标识符。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为“response.image_generation_call.generating”。可能的值：`response.image_generation_call.generating`	是的

OpenAI.ResponseImageGenCallInProgressEvent

映像生成工具调用正在进行时发出。

姓名	类型	Description	必选
item_id	字符串	正在处理的图像生成项的唯一标识符。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为“response.image_generation_call.generating”。可能的值：`response.image_generation_call.in_progress`	是的

OpenAI.ResponseImageGenCallPartialImageEvent

当部分图像在图像生成流式处理期间可用时发出。

姓名	类型	Description	必选
item_id	字符串	正在处理的图像生成项的唯一标识符。	是的
output_index	OpenAI.integer		是的
partial_image_b64	字符串	Base64 编码的部分图像数据，适合作为图像呈现。	是的
partial_image_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为“response.image_generation_call.partial_image”。可能的值：`response.image_generation_call.partial_image`	是的

OpenAI.ResponseInProgressEvent

响应正在进行时发出。

姓名	类型	Description	必选	违约
response	OpenAI.Response		是的
agent_reference	AgentReference （可为 null）	用于此响应的代理	是的
~~ 背景	布尔值（可为 null）		否
completed_at	integer （可为 null）		否
~~ 对话	OpenAI.ConversationReference （可为 null）	此响应所属的对话。此响应中的输入项和输出项会自动添加到此对话。	否
created_at	整数	创建此响应时的 Unix 时间戳（以秒为单位）。	是的
~~ 错误	OpenAI.ResponseError （可为 null）	当模型无法生成响应时返回的错误对象。	是的
└─ 身份	字符串	此响应的唯一标识符。	是的
不完整的详细信息	OpenAI.ResponseIncompleteDetails （可为 null）		是的
└─ 说明	OpenAI.InputItem 的字符串或数组（可为 null）		是的
max_output_tokens（最大输出标记数）	OpenAI.integer （可为 null）		否
max_tool_calls	OpenAI.integer （可为 null）		否
└─ 元数据	OpenAI.Metadata （可为 null）	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
└─ 模型	字符串	用于创建此响应的模型部署。	否
~~ 对象	枚举	此资源的对象类型 - 始终设置为 `response`。可能的值：`response`	是的
└─ 输出	OpenAI.OutputItem 数组	模型生成的内容项数组。 - 数组中 `output` 项的长度和顺序取决于于模型的响应。 - 与其访问 `output` 数组中的第一项并假设它是包含模型生成内容的 `assistant` 消息，可以考虑在 SDK 中支持的位置使用 `output_text` 属性。	是的
输出文本	string （可为 null）		否
并行工具调用	布尔	是否允许模型并行运行工具调用。	是的	真实
previous_response_id	string （可为 null）		否
└─ 提示	OpenAI.Prompt	对提示模板及其变量的引用。了解更多。	否
prompt_cache_key	字符串	OpenAI 用于缓存类似请求的响应，以优化缓存命中率。替换 `user` 字段。了解更多。	否
prompt_cache_retention	枚举	可能的值： `in-memory24h`	否
└─推理	OpenAI.Reasoning （可为 null）	仅 gpt-5 和 o 系列模型配置选项用于推理模型。	否
safety_identifier	字符串	用于帮助检测可能违反 OpenAI 使用策略的应用程序的用户的稳定标识符。 ID 应该是唯一标识每个用户的字符串。建议对其用户名或电子邮件地址进行哈希处理，以避免向我们发送任何标识信息。了解更多。	否
service_tier	OpenAI.ServiceTier	指定用于为请求提供服务的处理类型。 - 如果设置为“自动”，则请求将在 Project 设置中配置的服务层级进行处理。除非另有配置，Project 将使用“默认”。 - 如果设置为“default”，则将使用所选模型的标准定价和性能来处理请求。 - 如果设置为“flex”或“priority”，则请求将以相应的服务层级处理。 - 如果未设置，默认行为为“auto”。 `service_tier`设置参数后，响应正文将`service_tier`包含基于实际用于处理请求的处理模式的值。此响应值可能与参数中设置的值不同。	否
└─ 状态	枚举	响应生成的状态。以下之一：`completed`、`failed`、 `in_progress`、`cancelled`、`queued` 或 `incomplete`。可能的值：`completed`、、`failed`、`in_progresscancelled`、`queued`、`incomplete`	否
~~ 温度	OpenAI.numeric （可为 null）		否	1
└─ 文本	OpenAI.ResponseTextParam	来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。了解详细信息： - 文本输入输出 - 结构化输出	否
工具选择	OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceParam		否
└─ 工具	OpenAI.ToolsArray	生成响应时，模型可能会调用的工具数组。你可以通过设置 `tool_choice` 参数来指定要使用的工具。我们支持以下类别的工具： - 内置工具：OpenAI 提供的工具，用于扩展模型的功能，比如Web Search 或file search。详细了解内置工具。 - MCP 工具：通过自定义 MCP 服务器与第三方系统集成或预定义的连接器，如 Google Drive 和 SharePoint。详细了解 MCP 工具。 - 函数调用（自定义工具）：由你定义的函数，使模型能够使用强类型参数调用自己的代码和输出。详细了解函数调用。还可以使用用于调用自己的代码的自定义工具。	否
top_logprobs	OpenAI.integer （可为 null）		否
top_p	OpenAI.numeric （可为 null）		否	1
└─ 截断	枚举	可能的值： `autodisabled`	否
└─ 用法	OpenAI.ResponseUsage	表示令牌使用情况详细信息，包括输入令牌、输出令牌、输出令牌的细分以及所使用的令牌总数。	否
└─ 用户	string （已弃用）	此字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。改用 `prompt_cache_key` 来维护缓存优化。最终用户的稳定标识符。用于通过更好地存储类似的请求来提升缓存命中率，并帮助 OpenAI 检测和防止滥用。了解更多。	否
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.in_progress`。可能的值：`response.in_progress`	是的

OpenAI.ResponseIncompleteDetails

姓名	类型	Description	必选	违约
原因	枚举	可能的值： `max_output_tokenscontent_filter`	否

OpenAI.ResponseIncompleteEvent

响应以不完整状态结束时发出的事件。

姓名	类型	Description	必选	违约
response	OpenAI.Response		是的
agent_reference	AgentReference （可为 null）	用于此响应的代理	是的
~~ 背景	布尔值（可为 null）		否
completed_at	integer （可为 null）		否
~~ 对话	OpenAI.ConversationReference （可为 null）	此响应所属的对话。此响应中的输入项和输出项会自动添加到此对话。	否
created_at	整数	创建此响应时的 Unix 时间戳（以秒为单位）。	是的
~~ 错误	OpenAI.ResponseError （可为 null）	当模型无法生成响应时返回的错误对象。	是的
└─ 身份	字符串	此响应的唯一标识符。	是的
不完整的详细信息	OpenAI.ResponseIncompleteDetails （可为 null）		是的
└─ 说明	OpenAI.InputItem 的字符串或数组（可为 null）		是的
max_output_tokens（最大输出标记数）	OpenAI.integer （可为 null）		否
max_tool_calls	OpenAI.integer （可为 null）		否
└─ 元数据	OpenAI.Metadata （可为 null）	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
└─ 模型	字符串	用于创建此响应的模型部署。	否
~~ 对象	枚举	此资源的对象类型 - 始终设置为 `response`。可能的值：`response`	是的
└─ 输出	OpenAI.OutputItem 数组	模型生成的内容项数组。 - 数组中 `output` 项的长度和顺序取决于于模型的响应。 - 与其访问 `output` 数组中的第一项并假设它是包含模型生成内容的 `assistant` 消息，可以考虑在 SDK 中支持的位置使用 `output_text` 属性。	是的
输出文本	string （可为 null）		否
并行工具调用	布尔	是否允许模型并行运行工具调用。	是的	真实
previous_response_id	string （可为 null）		否
└─ 提示	OpenAI.Prompt	对提示模板及其变量的引用。了解更多。	否
prompt_cache_key	字符串	OpenAI 用于缓存类似请求的响应，以优化缓存命中率。替换 `user` 字段。了解更多。	否
prompt_cache_retention	枚举	可能的值： `in-memory24h`	否
└─推理	OpenAI.Reasoning （可为 null）	仅 gpt-5 和 o 系列模型配置选项用于推理模型。	否
safety_identifier	字符串	用于帮助检测可能违反 OpenAI 使用策略的应用程序的用户的稳定标识符。 ID 应该是唯一标识每个用户的字符串。建议对其用户名或电子邮件地址进行哈希处理，以避免向我们发送任何标识信息。了解更多。	否
service_tier	OpenAI.ServiceTier	指定用于为请求提供服务的处理类型。 - 如果设置为“自动”，则请求将在 Project 设置中配置的服务层级进行处理。除非另有配置，Project 将使用“默认”。 - 如果设置为“default”，则将使用所选模型的标准定价和性能来处理请求。 - 如果设置为“flex”或“priority”，则请求将以相应的服务层级处理。 - 如果未设置，默认行为为“auto”。 `service_tier`设置参数后，响应正文将`service_tier`包含基于实际用于处理请求的处理模式的值。此响应值可能与参数中设置的值不同。	否
└─ 状态	枚举	响应生成的状态。以下之一：`completed`、`failed`、 `in_progress`、`cancelled`、`queued` 或 `incomplete`。可能的值：`completed`、、`failed`、`in_progresscancelled`、`queued`、`incomplete`	否
~~ 温度	OpenAI.numeric （可为 null）		否	1
└─ 文本	OpenAI.ResponseTextParam	来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。了解详细信息： - 文本输入输出 - 结构化输出	否
工具选择	OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceParam		否
└─ 工具	OpenAI.ToolsArray	生成响应时，模型可能会调用的工具数组。你可以通过设置 `tool_choice` 参数来指定要使用的工具。我们支持以下类别的工具： - 内置工具：OpenAI 提供的工具，用于扩展模型的功能，比如Web Search 或file search。详细了解内置工具。 - MCP 工具：通过自定义 MCP 服务器与第三方系统集成或预定义的连接器，如 Google Drive 和 SharePoint。详细了解 MCP 工具。 - 函数调用（自定义工具）：由你定义的函数，使模型能够使用强类型参数调用自己的代码和输出。详细了解函数调用。还可以使用用于调用自己的代码的自定义工具。	否
top_logprobs	OpenAI.integer （可为 null）		否
top_p	OpenAI.numeric （可为 null）		否	1
└─ 截断	枚举	可能的值： `autodisabled`	否
└─ 用法	OpenAI.ResponseUsage	表示令牌使用情况详细信息，包括输入令牌、输出令牌、输出令牌的细分以及所使用的令牌总数。	否
└─ 用户	string （已弃用）	此字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。改用 `prompt_cache_key` 来维护缓存优化。最终用户的稳定标识符。用于通过更好地存储类似的请求来提升缓存命中率，并帮助 OpenAI 检测和防止滥用。了解更多。	否
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.incomplete`。可能的值：`response.incomplete`	是的

OpenAI.ResponseLogProb

logprob 是模型分配给在序列中给定位置生成特定标记的对数概率。小于负数（较高）的 logprob 值表示该令牌选择的模型置信度更高。

姓名	类型	Description	必选
logprob	OpenAI.numeric		是的
代币	字符串	可能的文本令牌。	是的
top_logprobs	OpenAI.ResponseLogProbTopLogprobs 的数组	前 20 个最有可能标记的对数概率。	否

OpenAI.ResponseLogProbTopLogprobs

姓名	类型	Description	必选	违约
logprob	OpenAI.numeric		否
代币	字符串		否

OpenAI.ResponseMCPCallArgumentsDeltaEvent

当 MCP 工具调用的参数存在增量（部分更新）时发出。

姓名	类型	Description	必选
三角洲	字符串	包含 MCP 工具调用参数的部分更新的 JSON 字符串。	是的
item_id	字符串	正在处理的 MCP 工具调用项的唯一标识符。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为“response.mcp_call_arguments.delta”。可能的值：`response.mcp_call_arguments.delta`	是的

OpenAI.ResponseMCPCallArgumentsDoneEvent

在完成 MCP 工具调用的参数时发出。

姓名	类型	Description	必选
arguments	字符串	包含 MCP 工具调用的最终参数的 JSON 字符串。	是的
item_id	字符串	正在处理的 MCP 工具调用项的唯一标识符。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为“response.mcp_call_arguments.done”。可能的值：`response.mcp_call_arguments.done`	是的

OpenAI.ResponseMCPCallCompletedEvent

MCP 工具调用成功完成时发出。

姓名	类型	Description	必选
item_id	字符串	已完成的 MCP 工具调用项的 ID。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为“response.mcp_call.completed”。可能的值：`response.mcp_call.completed`	是的

OpenAI.ResponseMCPCallFailedEvent

MCP 工具调用失败时发出。

姓名	类型	Description	必选
item_id	字符串	失败的 MCP 工具调用项的 ID。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为“response.mcp_call.failed”。可能的值：`response.mcp_call.failed`	是的

OpenAI.ResponseMCPCallInProgressEvent

当 MCP 工具调用正在进行时发出。

姓名	类型	Description	必选
item_id	字符串	正在处理的 MCP 工具调用项的唯一标识符。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为“response.mcp_call.in_progress”。可能的值：`response.mcp_call.in_progress`	是的

OpenAI.ResponseMCPListToolsCompletedEvent

成功检索可用 MCP 工具列表时发出。

姓名	类型	Description	必选
item_id	字符串	生成此输出的 MCP 工具调用项的 ID。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为“response.mcp_list_tools.completed”。可能的值：`response.mcp_list_tools.completed`	是的

OpenAI.ResponseMCPListToolsFailedEvent

尝试列出可用 MCP 工具失败时发出。

姓名	类型	Description	必选
item_id	字符串	失败的 MCP 工具调用项的 ID。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为“response.mcp_list_tools.failed”。可能的值：`response.mcp_list_tools.failed`	是的

OpenAI.ResponseMCPListToolsInProgressEvent

当系统正在检索可用 MCP 工具列表时发出。

姓名	类型	Description	必选
item_id	字符串	正在处理的 MCP 工具调用项的 ID。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为“response.mcp_list_tools.in_progress”。可能的值：`response.mcp_list_tools.in_progress`	是的

OpenAI.ResponseOutputItemAddedEvent

添加新的输出项时发出。

姓名	类型	Description	必选
项	OpenAI.OutputItem		是的
agent_reference	AgentReference	创建项的代理。	否
response_id	字符串	创建项的响应。	否
└─ 类型	OpenAI.OutputItemType		是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.output_item.added`。可能的值：`response.output_item.added`	是的

OpenAI.ResponseOutputItemDoneEvent

当输出项标记为已完成时发出。

姓名	类型	Description	必选
项	OpenAI.OutputItem		是的
agent_reference	AgentReference	创建项的代理。	否
response_id	字符串	创建项的响应。	否
└─ 类型	OpenAI.OutputItemType		是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.output_item.done`。可能的值：`response.output_item.done`	是的

OpenAI.ResponseOutputTextAnnotationAddedEvent

向输出文本内容添加批注时发出。

姓名	类型	Description	必选
注释	OpenAI.Annotation	应用于输出文本范围的批注。	是的
└─ 类型	OpenAI.AnnotationType		是的
annotation_index	OpenAI.integer		是的
content_index	OpenAI.integer		是的
item_id	字符串	要向其添加批注的项的唯一标识符。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为“response.output_text.annotation.added”。可能的值：`response.output_text.annotation.added`	是的

OpenAI.ResponsePromptVariables

可选项：用于替换提示词中变量的键值映射。替换值可以是字符串，也可以是图像或文件等其他响应输入类型。

类型：对象

OpenAI.ResponseQueuedEvent

当响应排队并等待处理时发出。

姓名	类型	Description	必选	违约
response	OpenAI.Response		是的
agent_reference	AgentReference （可为 null）	用于此响应的代理	是的
~~ 背景	布尔值（可为 null）		否
completed_at	integer （可为 null）		否
~~ 对话	OpenAI.ConversationReference （可为 null）	此响应所属的对话。此响应中的输入项和输出项会自动添加到此对话。	否
created_at	整数	创建此响应时的 Unix 时间戳（以秒为单位）。	是的
~~ 错误	OpenAI.ResponseError （可为 null）	当模型无法生成响应时返回的错误对象。	是的
└─ 身份	字符串	此响应的唯一标识符。	是的
不完整的详细信息	OpenAI.ResponseIncompleteDetails （可为 null）		是的
└─ 说明	OpenAI.InputItem 的字符串或数组（可为 null）		是的
max_output_tokens（最大输出标记数）	OpenAI.integer （可为 null）		否
max_tool_calls	OpenAI.integer （可为 null）		否
└─ 元数据	OpenAI.Metadata （可为 null）	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
└─ 模型	字符串	用于创建此响应的模型部署。	否
~~ 对象	枚举	此资源的对象类型 - 始终设置为 `response`。可能的值：`response`	是的
└─ 输出	OpenAI.OutputItem 数组	模型生成的内容项数组。 - 数组中 `output` 项的长度和顺序取决于于模型的响应。 - 与其访问 `output` 数组中的第一项并假设它是包含模型生成内容的 `assistant` 消息，可以考虑在 SDK 中支持的位置使用 `output_text` 属性。	是的
输出文本	string （可为 null）		否
并行工具调用	布尔	是否允许模型并行运行工具调用。	是的	真实
previous_response_id	string （可为 null）		否
└─ 提示	OpenAI.Prompt	对提示模板及其变量的引用。了解更多。	否
prompt_cache_key	字符串	OpenAI 用于缓存类似请求的响应，以优化缓存命中率。替换 `user` 字段。了解更多。	否
prompt_cache_retention	枚举	可能的值： `in-memory24h`	否
└─推理	OpenAI.Reasoning （可为 null）	仅 gpt-5 和 o 系列模型配置选项用于推理模型。	否
safety_identifier	字符串	用于帮助检测可能违反 OpenAI 使用策略的应用程序的用户的稳定标识符。 ID 应该是唯一标识每个用户的字符串。建议对其用户名或电子邮件地址进行哈希处理，以避免向我们发送任何标识信息。了解更多。	否
service_tier	OpenAI.ServiceTier	指定用于为请求提供服务的处理类型。 - 如果设置为“自动”，则请求将在 Project 设置中配置的服务层级进行处理。除非另有配置，Project 将使用“默认”。 - 如果设置为“default”，则将使用所选模型的标准定价和性能来处理请求。 - 如果设置为“flex”或“priority”，则请求将以相应的服务层级处理。 - 如果未设置，默认行为为“auto”。 `service_tier`设置参数后，响应正文将`service_tier`包含基于实际用于处理请求的处理模式的值。此响应值可能与参数中设置的值不同。	否
└─ 状态	枚举	响应生成的状态。以下之一：`completed`、`failed`、 `in_progress`、`cancelled`、`queued` 或 `incomplete`。可能的值：`completed`、、`failed`、`in_progresscancelled`、`queued`、`incomplete`	否
~~ 温度	OpenAI.numeric （可为 null）		否	1
└─ 文本	OpenAI.ResponseTextParam	来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。了解详细信息： - 文本输入输出 - 结构化输出	否
工具选择	OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceParam		否
└─ 工具	OpenAI.ToolsArray	生成响应时，模型可能会调用的工具数组。你可以通过设置 `tool_choice` 参数来指定要使用的工具。我们支持以下类别的工具： - 内置工具：OpenAI 提供的工具，用于扩展模型的功能，比如Web Search 或file search。详细了解内置工具。 - MCP 工具：通过自定义 MCP 服务器与第三方系统集成或预定义的连接器，如 Google Drive 和 SharePoint。详细了解 MCP 工具。 - 函数调用（自定义工具）：由你定义的函数，使模型能够使用强类型参数调用自己的代码和输出。详细了解函数调用。还可以使用用于调用自己的代码的自定义工具。	否
top_logprobs	OpenAI.integer （可为 null）		否
top_p	OpenAI.numeric （可为 null）		否	1
└─ 截断	枚举	可能的值： `autodisabled`	否
└─ 用法	OpenAI.ResponseUsage	表示令牌使用情况详细信息，包括输入令牌、输出令牌、输出令牌的细分以及所使用的令牌总数。	否
└─ 用户	string （已弃用）	此字段正在被替换为 `safety_identifier` 和 `prompt_cache_key`。改用 `prompt_cache_key` 来维护缓存优化。最终用户的稳定标识符。用于通过更好地存储类似的请求来提升缓存命中率，并帮助 OpenAI 检测和防止滥用。了解更多。	否
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为“response.queued”。可能的值：`response.queued`	是的

OpenAI.ResponseReasoningSummaryPartAddedEvent

添加新的推理摘要部分时发出。

姓名	类型	Description	必选
item_id	字符串	此摘要部分关联的项的 ID。	是的
output_index	OpenAI.integer		是的
部件	OpenAI.ResponseReasoningSummaryPartAddedEventPart		是的
└─ 文本	字符串		是的
└─ 类型	枚举	可能的值：`summary_text`	是的
sequence_number	OpenAI.integer		是的
summary_index	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.reasoning_summary_part.added`。可能的值：`response.reasoning_summary_part.added`	是的

OpenAI.ResponseReasoningSummaryPartAddedEventPart

姓名	类型	Description	必选	违约
文本消息	字符串		是的
类型	枚举	可能的值：`summary_text`	是的

OpenAI.ResponseReasoningSummaryPartDoneEvent

完成推理摘要部分时发出。

姓名	类型	Description	必选
item_id	字符串	此摘要部分关联的项的 ID。	是的
output_index	OpenAI.integer		是的
部件	OpenAI.ResponseReasoningSummaryPartDoneEventPart		是的
└─ 文本	字符串		是的
└─ 类型	枚举	可能的值：`summary_text`	是的
sequence_number	OpenAI.integer		是的
summary_index	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.reasoning_summary_part.done`。可能的值：`response.reasoning_summary_part.done`	是的

OpenAI.ResponseReasoningSummaryPartDoneEventPart

姓名	类型	Description	必选	违约
文本消息	字符串		是的
类型	枚举	可能的值：`summary_text`	是的

OpenAI.ResponseReasoningSummaryTextDeltaEvent

将增量添加到推理摘要文本时发出。

姓名	类型	Description	必选
三角洲	字符串	添加到摘要的文本增量。	是的
item_id	字符串	此摘要文本增量关联的项的 ID。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
summary_index	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.reasoning_summary_text.delta`。可能的值：`response.reasoning_summary_text.delta`	是的

OpenAI.ResponseReasoningSummaryTextDoneEvent

完成推理摘要文本时发出。

姓名	类型	Description	必选
item_id	字符串	此摘要文本关联的项的 ID。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
summary_index	OpenAI.integer		是的
文本消息	字符串	已完成推理摘要的全文。	是的
类型	枚举	事件类型。始终为 `response.reasoning_summary_text.done`。可能的值：`response.reasoning_summary_text.done`	是的

OpenAI.ResponseReasoningTextDeltaEvent

将增量添加到推理文本时发出。

姓名	类型	Description	必选
content_index	OpenAI.integer		是的
三角洲	字符串	添加到推理内容的文本增量。	是的
item_id	字符串	与此推理文本增量关联的项的 ID。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.reasoning_text.delta`。可能的值：`response.reasoning_text.delta`	是的

OpenAI.ResponseReasoningTextDoneEvent

在推理文本完成时发出。

姓名	类型	Description	必选
content_index	OpenAI.integer		是的
item_id	字符串	与此推理文本关联的项的 ID。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
文本消息	字符串	已完成推理内容的全文。	是的
类型	枚举	事件类型。始终为 `response.reasoning_text.done`。可能的值：`response.reasoning_text.done`	是的

OpenAI.ResponseRefusalDeltaEvent

当存在部分拒绝文本时发出。

姓名	类型	Description	必选
content_index	OpenAI.integer		是的
三角洲	字符串	添加的拒绝文本。	是的
item_id	字符串	拒绝文本添加到的输出项的 ID。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.refusal.delta`。可能的值：`response.refusal.delta`	是的

OpenAI.ResponseRefusalDoneEvent

在拒绝文本完成时发出。

姓名	类型	Description	必选
content_index	OpenAI.integer		是的
item_id	字符串	已完成拒绝文本的输出项的 ID。	是的
output_index	OpenAI.integer		是的
拒绝	字符串	最终完成的拒绝文本。	是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.refusal.done`。可能的值：`response.refusal.done`	是的

OpenAI.ResponseStreamOptions

流式处理响应的选项。仅在设置 stream: true 时设置此项。

姓名	类型	Description	必选	违约
include_obfuscation	布尔	如果为 true，将启用流混淆。流模糊处理添加流式传输增量事件的字段的随机字符`obfuscation` 将有效负载大小规范化为缓解某些侧通道攻击。默认情况下包括这些模糊字段，但添加少量内容数据流的开销。可以将设置为`include_obfuscation` 如果信任两者之间的网络链接，则为 false 以优化带宽应用程序和 OpenAI API。	否

OpenAI.ResponseTextDeltaEvent

当有额外的文本增量时发出。

姓名	类型	Description	必选
content_index	OpenAI.integer		是的
三角洲	字符串	添加的文本增量。	是的
item_id	字符串	文本增量添加到的输出项的 ID。	是的
logprobs	OpenAI.ResponseLogProb 的数组	增量中标记的对数概率。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.output_text.delta`。可能的值：`response.output_text.delta`	是的

OpenAI.ResponseTextDoneEvent

在完成文本内容时发出。

姓名	类型	Description	必选
content_index	OpenAI.integer		是的
item_id	字符串	已完成文本内容的输出项的 ID。	是的
logprobs	OpenAI.ResponseLogProb 的数组	增量中标记的对数概率。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
文本消息	字符串	最终完成的文本内容。	是的
类型	枚举	事件类型。始终为 `response.output_text.done`。可能的值：`response.output_text.done`	是的

OpenAI.ResponseTextParam

来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。了解详细信息：

姓名	类型	Description	必选	违约
格式	OpenAI.TextResponseFormatConfiguration	一个对象，指定模型必须输出的格式。配置 `{ "type": "json_schema" }` 会启用结构化输出，这可确保模型与提供的 JSON 架构匹配。若要了解详细信息，请查看默认格式 `{ "type": "text" }` 没有其他选项。不建议用于 gpt-4o 和较新的模型：* 设置 `{ "type": "json_object" }` 可启用旧版 JSON 模式，确保模型生成的消息是有效的 JSON。使用 `json_schema` 对于支持该功能的模型而言，这是优先选择。	否
详细程度	OpenAI.Verbosity	限制模型回答的冗长程度。较低的值将导致更简洁的响应，而较高的值将导致更详细的响应。当前支持的值为 `low`、`medium` 和 `high`。	否

OpenAI.ResponseUsage

表示令牌使用情况详细信息，包括输入令牌、输出令牌、输出令牌细分以及所使用的令牌总数。

姓名	类型	必选
input_tokens	OpenAI.integer	是的
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails	是的
cached_tokens	OpenAI.integer	是的
output_tokens	OpenAI.integer	是的
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	是的
reasoning_tokens	OpenAI.integer	是的
total_tokens	OpenAI.integer	是的

OpenAI.ResponseUsageInputTokensDetails

姓名	类型	Description	必选	违约
cached_tokens	OpenAI.integer		是的

OpenAI.ResponseUsageOutputTokensDetails

姓名	类型	Description	必选	违约
推理标记	OpenAI.integer		是的

OpenAI.ResponseWebSearchCallCompletedEvent

在 Web 搜索调用完成时发出。

姓名	类型	Description	必选
item_id	字符串	与 Web 搜索调用关联的输出项的唯一 ID。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.web_search_call.completed`。可能的值：`response.web_search_call.completed`	是的

OpenAI.ResponseWebSearchCallInProgressEvent

启动 Web 搜索调用时发出。

姓名	类型	Description	必选
item_id	字符串	与 Web 搜索调用关联的输出项的唯一 ID。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.web_search_call.in_progress`。可能的值：`response.web_search_call.in_progress`	是的

OpenAI.ResponseWebSearchCallSearchingEvent

执行 Web 搜索调用时发出。

姓名	类型	Description	必选
item_id	字符串	与 Web 搜索调用关联的输出项的唯一 ID。	是的
output_index	OpenAI.integer		是的
sequence_number	OpenAI.integer		是的
类型	枚举	事件类型。始终为 `response.web_search_call.searching`。可能的值：`response.web_search_call.searching`	是的

OpenAI.屏幕截图

屏幕截图操作。

姓名	类型	Description	必选	违约
类型	枚举	指定事件类型。对于屏幕截图操作，此属性为始终设置为 `screenshot`。可能的值：`screenshot`	是的

OpenAI.Scroll

滚动操作。

姓名	类型	Description	必选
scroll_x	OpenAI.integer		是的
scroll_y	OpenAI.integer		是的
类型	枚举	指定事件类型。对于滚动操作，此属性为始终设置为 `scroll`。可能的值：`scroll`	是的
x	OpenAI.integer		是的
y	OpenAI.integer		是的

OpenAI.SearchContextSize

资产	价值
类型	字符串
价值观	`low` `medium` `high`

OpenAI.ServiceTier

指定用于为请求提供服务的处理类型。

如果设置为“自动”，那么请求会在Project设置中配置的服务层级中被处理。除非另有配置，Project 将使用“默认”。
如果设置为“default”，则将使用所选模型的标准定价和性能来处理请求。
如果设置为“flex”或“priority”，则请求将以相应的服务层级处理。
如果未设置，默认行为为“auto”。 service_tier设置参数后，响应正文将service_tier包含基于实际用于处理请求的处理模式的值。此响应值可能与参数中设置的值不同。

资产	价值
类型	字符串
空	是的
价值观	`auto` `default` `flex` `scale` `priority`

OpenAI.SpecificApplyPatchParam

强制模型在执行工具调用时调用apply_patch工具。

姓名	类型	Description	必选	违约
类型	枚举	要调用的工具。始终为 `apply_patch`。可能的值：`apply_patch`	是的

OpenAI.SpecificFunctionShellParam

强制模型在需要工具调用时调用 shell 工具。

姓名	类型	Description	必选	违约
类型	枚举	要调用的工具。始终为 `shell`。可能的值：`shell`	是的

OpenAI.Summary

模型的摘要文本。

姓名	类型	Description	必选	违约
文本消息	字符串	目前模型推理输出的总结。	是的
类型	枚举	对象的类型。始终为 `summary_text`。可能的值：`summary_text`	是的

OpenAI.SummaryTextContent

模型的摘要文本。

姓名	类型	Description	必选	违约
文本消息	字符串	目前模型推理输出的总结。	是的
类型	枚举	对象的类型。始终为 `summary_text`。可能的值：`summary_text`	是的

OpenAI.TextContent

文本内容。

姓名	类型	Description	必选	违约
文本消息	字符串		是的
类型	枚举	可能的值：`text`	是的

OpenAI.TextResponseFormatConfiguration

一个对象，指定模型必须输出的格式。配置 { "type": "json_schema" } 启用结构化输出，这可确保模型与提供的 JSON 架构匹配。若要了解详细信息，请查看

默认格式 { "type": "text" } 没有其他选项。 不推荐用于GPT-4o及新型号：* 设置启用 { "type": "json_object" } 旧版JSON模式，确保模型生成的消息是有效的JSON。对于支持它的模型，首选使用 json_schema 。

OpenAI.TextResponseFormatConfiguration 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`json_schema`	OpenAI.TextResponseFormatJsonSchema
`text`	OpenAI.TextResponseFormatConfigurationResponseFormatText
`json_object`	OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

姓名	类型	Description	必选	违约
类型	OpenAI.TextResponseFormatConfigurationType		是的

OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

姓名	类型	Description	必选	违约
类型	枚举	要定义的响应格式的类型。始终为 `json_object`。可能的值：`json_object`	是的

OpenAI.TextResponseFormatConfigurationResponseFormatText

默认响应格式。用于生成文本响应。

姓名	类型	Description	必选	违约
类型	枚举	要定义的响应格式的类型。始终为 `text`。可能的值：`text`	是的

OpenAI.TextResponseFormatConfigurationType

资产	价值
类型	字符串
价值观	`text` `json_schema` `json_object`

OpenAI.TextResponseFormatJsonSchema

JSON 架构响应格式。用于生成结构化 JSON 响应。了解更多关于结构化输出。

姓名	类型	Description	必选
说明	字符串	响应格式用途的描述，供模型确定如何按该格式响应。	否
姓名	字符串	响应格式的名称。必须为 a-z、A-Z、0-9 或包含下划线和短划线，最大长度为 64。	是的
架构	OpenAI.ResponseFormatJsonSchemaSchema	响应格式的架构，描述为 JSON 架构对象。了解如何在此处生成 JSON 架构。	是的
strict	布尔值（可为 null）		否
类型	枚举	要定义的响应格式的类型。始终为 `json_schema`。可能的值：`json_schema`	是的

OpenAI.Tool

可用于生成响应的工具。

OpenAI.Tool 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	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

姓名	类型	Description	必选	违约
类型	OpenAI.ToolType		是的

OpenAI.ToolChoiceAllowed

将模型可用的工具限制为预定义集。

姓名	类型	Description	必选
mode	枚举	将模型可用的工具限制为预定义集。 `auto` 允许模型从允许的工具中进行选择并生成。 `required` 要求模型调用一个或多个允许的工具。可能的值： `autorequired`	是的
工具	对象的数组	应允许模型调用的工具定义列表。对于响应 API，工具定义列表可能如下所示： `json<br> [<br> { "type": "function", "name": "get_weather" },<br> { "type": "mcp", "server_label": "deepwiki" },<br> { "type": "image_generation" }<br> ]<br>`	是的
类型	枚举	允许的工具配置类型。始终为 `allowed_tools`。可能的值：`allowed_tools`	是的

OpenAI.ToolChoiceCodeInterpreter

指示模型应使用内置工具生成响应。了解更多关于内置工具。

姓名	类型	Description	必选	违约
类型	枚举	可能的值：`code_interpreter`	是的

OpenAI.ToolChoiceComputerUsePreview

指示模型应使用内置工具生成响应。了解更多关于内置工具。

姓名	类型	Description	必选	违约
类型	枚举	可能的值：`computer_use_preview`	是的

OpenAI.ToolChoiceCustom

使用此选项强制模型调用特定的自定义工具。

姓名	类型	Description	必选	违约
姓名	字符串	要调用的自定义工具的名称。	是的
类型	枚举	对于自定义工具调用，类型始终 `custom`为。可能的值：`custom`	是的

OpenAI.ToolChoiceFileSearch

指示模型应使用内置工具生成响应。了解更多关于内置工具。

姓名	类型	Description	必选	违约
类型	枚举	可能的值：`file_search`	是的

OpenAI.ToolChoiceFunction

使用此选项强制模型调用特定函数。

姓名	类型	Description	必选	违约
姓名	字符串	要调用的函数名称。	是的
类型	枚举	对于函数调用，类型始终为`function`。可能的值：`function`	是的

OpenAI.ToolChoiceImageGeneration

指示模型应使用内置工具生成响应。了解更多关于内置工具。

姓名	类型	Description	必选	违约
类型	枚举	可能的值：`image_generation`	是的

OpenAI.ToolChoiceMCP

使用此选项可强制模型调用远程 MCP 服务器上的特定工具。

姓名	类型	Description	必选
姓名	string （可为 null）		否
服务器标签	字符串	要使用的 MCP 服务器的标签。	是的
类型	枚举	对于 MCP 工具，类型始终为 `mcp`。可能的值：`mcp`	是的

OpenAI.ToolChoiceOptions

控制模型调用哪些工具（如有）。 none 表示模型不会调用任何工具，而是生成消息。 auto 表示模型可以在生成消息和调用一个或多个工具之间进行选择。 required 表示模型必须调用一个或多个工具。

资产	价值
类型	字符串
价值观	`none` `auto` `required`

OpenAI.ToolChoiceParam

模型在生成响应时应如何选择要使用的工具（或工具）。请参阅参数 tools ，了解如何指定模型可以调用的工具。

OpenAI.ToolChoiceParam 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	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

姓名	类型	Description	必选	违约
类型	OpenAI.ToolChoiceParamType		是的

OpenAI.ToolChoiceParamType

资产	价值
类型	字符串
价值观	`allowed_tools` `function` `mcp` `custom` `apply_patch` `shell` `file_search` `web_search_preview` `computer_use_preview` `web_search_preview_2025_03_11` `image_generation` `code_interpreter`

OpenAI.ToolChoiceWebSearchPreview

指示模型应使用内置工具生成响应。了解更多关于内置工具。

姓名	类型	Description	必选	违约
类型	枚举	可能的值：`web_search_preview`	是的

OpenAI.ToolChoiceWebSearchPreview20250311

指示模型应使用内置工具生成响应。了解更多关于内置工具。

姓名	类型	Description	必选	违约
类型	枚举	可能的值：`web_search_preview_2025_03_11`	是的

OpenAI.ToolType

资产价值

类型字符串

价值观 function
file_search
computer_use_preview
web_search
mcp
code_interpreter
image_generation
local_shell
shell
custom
web_search_preview
apply_patch
a2a_preview
bing_custom_search_preview
browser_automation_preview
fabric_dataagent_preview
sharepoint_grounding_preview
memory_search_preview
azure_ai_search
azure_function
bing_grounding
capture_structured_outputs
openapi

OpenAI.ToolsArray

生成响应时，模型可能会调用的工具数组。可以通过设置 tool_choice 参数来指定要使用的工具。我们支持以下类别的工具：

内置工具：OpenAI提供的扩展模型功能的工具，如web search或file search。了解更多关于内置工具。
MCP 工具：通过自定义 MCP 服务器或预定义连接器（如 Google Drive 和 SharePoint）与第三方系统集成。了解更多关于MCP工具的信息。
函数调用（自定义工具）：由你定义的函数，使模型能够使用强类型参数和输出调用自己的代码。了解更多关于函数调用。还可以使用自定义工具调用自己的代码。

数组： OpenAI.Tool

OpenAI.TopLogProb

令牌的最高对数概率。

姓名	类型	必选
字节	OpenAI.integer 数组	是的
logprob	OpenAI.numeric	是的
代币	字符串	是的

OpenAI.Type

键入文本的操作。

姓名	类型	Description	必选	违约
文本消息	字符串	要键入的文本。	是的
类型	枚举	指定事件类型。对于键入操作，此属性为始终设置为 `type`。可能的值：`type`	是的

OpenAI.UpdateConversationBody

姓名	类型	Description	必选	违约
元数据	OpenAI.Metadata （可为 null）	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	是的

OpenAI.UrlCitationBody

用于生成模型响应的 Web 资源的引文。

姓名	类型	Description	必选
end_index	OpenAI.integer		是的
start_index	OpenAI.integer		是的
title	字符串	Web 资源的标题。	是的
类型	枚举	URL 引文的类型。始终为 `url_citation`。可能的值：`url_citation`	是的
url	字符串	Web 资源的 URL。	是的

OpenAI.VectorStoreFileAttributes

按 16 个成组的可附加到对象的键值对。这可用于以结构化格式存储有关对象的其他信息，以及通过 API 或仪表板查询对象。键是最大长度为 64 个字符的字符串。值为最大长度为 512 个字符、布尔值或数字的字符串。

类型：对象

OpenAI.Verbosity

限制模型回答的冗长程度。较低的数值会带来更简洁的回答，而更高的数值则会带来更冗长的回答。当前支持的值为 low、medium 和 high。

资产	价值
类型	字符串
空	是的
价值观	`low` `medium` `high`

OpenAI.Wait

等待操作。

姓名	类型	Description	必选	违约
类型	枚举	指定事件类型。对于等待操作，此属性为始终设置为 `wait`。可能的值：`wait`	是的

OpenAI.WebSearchActionFind

操作类型“find”：在加载的页面中搜索模式。

姓名	类型	Description	必选
模式	字符串	要在页面内搜索的模式或文本。	是的
类型	枚举	操作类型。可能的值：`find_in_page`	是的
url	字符串	用于搜索模式的页面的 URL。	是的

OpenAI.WebSearchActionOpenPage

操作类型“open_page”：打开搜索结果中的特定 URL。

姓名	类型	Description	必选	违约
类型	枚举	操作类型。可能的值：`open_page`	是的
url	字符串	模型打开的 URL。	是的

OpenAI.WebSearchActionSearch

操作类型“search”：执行 Web 搜索查询。

姓名	类型	Description	必选
查询	字符串数组	搜索查询。	否
查询	string （已弃用）	[已弃用]搜索查询。	是的
来源	OpenAI.WebSearchActionSearchSources 的数组	搜索中使用的来源。	否
类型	枚举	操作类型。可能的值：`search`	是的

OpenAI.WebSearchActionSearchSources

姓名	类型	Description	必选	违约
类型	枚举	可能的值：`url`	是的
url	字符串		是的

OpenAI.WebSearchApproximateLocation

用户的大致位置。

姓名	类型	Description	必选
城市	string （可为 null）		否
国家	string （可为 null）		否
区域	string （可为 null）		否
timezone	string （可为 null）		否
类型	枚举	位置近似的类型。始终为 `approximate`。可能的值：`approximate`	否

OpenAI.WebSearchPreviewTool

该工具会在网上搜索相关结果以供回复。了解更多关于web搜索工具的信息。

姓名	类型	Description	必选
搜索上下文大小	OpenAI.SearchContextSize		否
类型	枚举	Web 搜索工具的类型。 `web_search_preview` 或 `web_search_preview_2025_03_11` 中的一项。可能的值：`web_search_preview`	是的
用户位置	OpenAI.ApproximateLocation （可为 null）		否
~~ 城市	string （可为 null）		否
国家/地区	string （可为 null）		否
~~ 区域	string （可为 null）		否
~~ 时区	string （可为 null）		否
└─ 类型	枚举	位置近似的类型。始终为 `approximate`。可能的值：`approximate`	是的

OpenAI.WebSearchTool

在网上搜索与该提示相关的资料。了解更多关于web搜索工具的信息。

姓名	类型	Description	必选
custom_search_configuration	WebSearchConfiguration	bing自定义搜索的网页搜索配置	否
instance_name	字符串	给定用于配置的自定义配置实例的名称。	是的
project_connection_id	字符串	Project 连接 ID 用于接地，使用 bing 自定义搜索	是的
filters	OpenAI.WebSearchToolFilters （可为 null）		否
allowed_domains	字符串数组（可为 null）		否
搜索上下文大小	枚举	用于搜索的上下文窗口空间量的高级指南。 `low`、`medium` 或 `high` 之一。 `medium` 是默认值。可能的值：`low`、、 `mediumhigh`	否
类型	枚举	Web 搜索工具的类型。 `web_search` 或 `web_search_2025_08_26` 中的一项。可能的值：`web_search`	是的
用户位置	OpenAI.WebSearchApproximateLocation （可为 null）	用户的大致位置。	否
~~ 城市	string （可为 null）		否
国家/地区	string （可为 null）		否
~~ 区域	string （可为 null）		否
~~ 时区	string （可为 null）		否
└─ 类型	枚举	位置近似的类型。始终为 `approximate`。可能的值：`approximate`	否

OpenAI.WebSearchToolFilters

姓名	类型	Description	必选	违约
allowed_domains	字符串数组		否

OpenAI.integer

类型：整数

格式：int64

OpenAI.numeric

类型：数字

格式：double

OpenApiAnonymousAuthDetails

OpenApi 匿名身份验证的安全详细信息

姓名	类型	Description	必选	违约
类型	枚举	对象类型，始终为“anonymous”。可能的值：`anonymous`	是的

OpenApiAuthDetails

OpenApiFunctionDefinition 的身份验证详细信息

OpenApiAuthDetails 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`anonymous`	OpenApiAnonymousAuthDetails
`project_connection`	OpenApiProjectConnectionAuthDetails
`managed_identity`	OpenApiManagedAuthDetails

姓名	类型	Description	必选	违约
类型	OpenApiAuthType	OpenApi 终端节点的身份验证类型。允许的类型是： - 匿名（无需身份验证） - Project 连接（需要project_connection_id端点，需在 AI Foundry 中设置） - Managed_Identity（需要受众进行基于标识的身份验证）	是的

OpenApiAuthType

OpenApi 终端节点的身份验证类型。允许的类型是：

匿名（无需身份验证）
Project 连接（需要project_connection_id端点，按照 AI Foundry 的设置）
Managed_Identity （需要受众进行基于身份的身份验证）

资产	价值
说明	OpenApi 终端节点的身份验证类型。允许的类型是： - 匿名（无需身份验证） - Project 连接（需要project_connection_id端点，需在 AI Foundry 中设置） - Managed_Identity（需要受众进行基于标识的身份验证）
类型	字符串
价值观	`anonymous` `project_connection` `managed_identity`

OpenApiFunctionDefinition

openapi 函数的输入定义信息。

姓名	类型	Description	必选
auth	OpenApiAuthDetails	OpenApiFunctionDefinition 的身份验证详细信息	是的
└─ 类型	OpenApiAuthType	身份验证类型必须为匿名/project_connection/managed_identity	是的
default_params	字符串数组	将使用用户提供的默认值的 OpenAPI 规范参数列表	否
说明	字符串	函数作用的描述，由模型用于选择何时以及如何调用函数。	否
functions	对象的数组	OpenApi 工具使用的函数定义列表	否
姓名	字符串	要调用的函数的名称。	是的
spec	对象	openapi 函数形状，描述为 JSON 架构对象。	是的

OpenApiManagedAuthDetails

OpenApi managed_identity身份验证的安全详细信息

姓名	类型	Description	必选
security_scheme	OpenApiManagedSecurityScheme	OpenApi managed_identity身份验证的安全方案	是的
~~ 访问群体	字符串	managed_identity身份验证类型的身份验证范围	是的
类型	枚举	对象类型，始终为“managed_identity”。可能的值：`managed_identity`	是的

OpenApiManagedSecurityScheme

OpenApi managed_identity身份验证的安全方案

姓名	类型	Description	必选	违约
audience	字符串	managed_identity身份验证类型的身份验证范围	是的

OpenApiProjectConnectionAuthDetails

OpenApi project 连接认证的安全细节

姓名	类型	Description	必选
security_scheme	OpenApiProjectConnectionSecurityScheme	OpenApi managed_identity身份验证的安全方案	是的
project_connection_id	字符串	Project 连接 ID 用于 Project 连接认证类型	是的
类型	枚举	对象类型，始终为“project_connection”。可能的值：`project_connection`	是的

OpenApiProjectConnectionSecurityScheme

OpenApi managed_identity身份验证的安全方案

姓名	类型	Description	必选	违约
project_connection_id	字符串	Project 连接 ID 用于 Project 连接认证类型	是的

OpenApiTool

用于配置代理的 OpenAPI 工具的输入定义信息。

姓名	类型	Description	必选
openapi	OpenApiFunctionDefinition	openapi 函数的输入定义信息。	是的
~~ 身份验证	OpenApiAuthDetails	打开 API 身份验证详细信息	是的
default_params	字符串数组	将使用用户提供的默认值的 OpenAPI 规范参数列表	否
└─ 说明	字符串	函数作用的描述，由模型用于选择何时以及如何调用函数。	否
~~ 函数	对象数组（只读）	OpenApi 工具使用的函数定义列表	否
└─ 说明	字符串	函数作用的描述，由模型用于选择何时以及如何调用函数。	否
└─ 名称	字符串	要调用的函数的名称。	是的
└─ 参数	对象	函数接受的参数，被描述为 JSON 架构对象。	是的
└─ 名称	字符串	要调用的函数的名称。	是的
~~ 规范	对象	openapi 函数形状，描述为 JSON 架构对象。	是的
类型	枚举	对象类型，始终为“openapi”。可能的值：`openapi`	是的

PageOrder

资产	价值
类型	字符串
价值观	`asc` `desc`

PagedConnection

Connection 项的分页集合

姓名	类型	Description	必选	违约
nextLink	字符串	指向下一页项的链接	否
value	Connection 数组	此页面上的 Connection 项目	是的

PagedDatasetVersion

DatasetVersion 项的分页集合

姓名	类型	Description	必选	违约
nextLink	字符串	指向下一页项的链接	否
value	DatasetVersion 数组	此页上的 DatasetVersion 项	是的

PagedDeployment

Deployment 项的分页集合

姓名	类型	Description	必选	违约
nextLink	字符串	指向下一页项的链接	否
value	部署数组	此页上的“部署”项	是的

PagedEvaluationRule

EvaluationRule 项的分页集合

姓名	类型	Description	必选	违约
nextLink	字符串	指向下一页项的链接	否
value	EvaluationRule 数组	此页上的 EvaluationRule 项	是的

PagedEvaluationTaxonomy

EvaluationTaxonomy 项的分页集合

姓名	类型	Description	必选	违约
nextLink	字符串	指向下一页项的链接	否
value	EvaluationTaxonomy 数组	此页上的 EvaluationTaxonomy 项	是的

PagedEvaluatorVersion

EvaluatorVersion 项的分页集合

姓名	类型	Description	必选	违约
nextLink	字符串	指向下一页项的链接	否
value	EvaluatorVersion 数组	此页上的 EvaluatorVersion 项	是的

PagedIndex

索引项的分页集合

姓名	类型	Description	必选	违约
nextLink	字符串	指向下一页项的链接	否
value	索引数组	此页上的索引项	是的

PagedInsight

Insight 项的分页集合

姓名	类型	Description	必选	违约
nextLink	字符串	指向下一页项的链接	否
value	Insight 数组	此页上的“见解”项	是的

PagedRedTeam

RedTeam 项的分页集合

姓名	类型	Description	必选	违约
nextLink	字符串	指向下一页项的链接	否
value	RedTeam 数组	此页面上的 RedTeam 项目	是的

PagedSchedule

计划项的分页集合

姓名	类型	Description	必选	违约
nextLink	字符串	指向下一页项的链接	否
value	Schedule 数组	此页上的“计划”项	是的

PagedScheduleRun

ScheduleRun 项的分页集合

姓名	类型	Description	必选	违约
nextLink	字符串	指向下一页项的链接	否
value	ScheduleRun 数组	此页面上的 ScheduleRun 项	是的

PendingUploadRequest

表示对待上载的请求。

姓名	类型	Description	必选
connectionName （连接名称）	字符串	Azure Storage Account connection name to using to generate temporary SAS token	否
pendingUploadId	字符串	如果未提供 PendingUploadId，则将使用随机 GUID。	否
pendingUploadType	枚举	BlobReference 是唯一支持的类型。可能的值：`BlobReference`	是的

PendingUploadResponse

表示待处理上传请求的响应

姓名	类型	Description	必选
blobReference	BlobReference	Blob 引用详细信息。	是的
~~ blobUri	字符串	用于上传数据的客户端的 Blob URI 路径。示例：`https://blob.windows.core.net/Container/Path`	是的
~~ 凭据	SasCredential	access storage 账户的凭证信息。	是的
~~ storageAccountArmId	字符串	要用的是要用的 storage 账户的 ARM ID。	是的
pendingUploadId	字符串	此上传请求的 ID。	是的
pendingUploadType	枚举	BlobReference 是唯一支持的类型可能的值：`BlobReference`	是的
版本	字符串	如果用户在最初创建上传时未指定版本，则要创建的资产版本	否

PromptAgentDefinition

提示代理定义

姓名	类型	Description	必选	违约
instructions	string （可为 null）	插入到模型上下文中的系统（或开发人员）消息。	否
kind	枚举	可能的值：`prompt`	是的
模型	字符串	要用于此代理的模型部署。	是的
rai_config	RaiConfig	负责任 AI （RAI）内容筛选和安全功能的配置。	否
rai_policy_name	字符串	要应用的 RAI 策略的名称。	是的
reasoning	OpenAI.Reasoning （可为 null）	仅 gpt-5 和 o 系列模型配置选项用于推理模型。	否
努力	OpenAI.ReasoningEffort	限制推理模型。目前支持的值为 `none`、 `minimal`、 `low`、 `mediumhighxhigh`、和。减少推理努力可能会导致更快的响应和更少的标记使用于响应中的推理。 - `gpt-5.1` 默认为 `none`不执行推理。支持的 `gpt-5.1` 推理值为 `none`、 `low`、 `medium`和 `high`。 gpt-5.1 中的所有推理值都支持工具调用。 - 在默认为`gpt-5.1`推理工作之前`medium`的所有模型，并且不支持`none`。 - 模型 `gpt-5-pro` 默认为（且仅支持） `high` 推理工作。之后的所有模型都支持 < a0/> 。	否
生成摘要	枚举	可能的值：`auto`、、 `concisedetailed`	否
~~ 摘要	枚举	可能的值：`auto`、、 `concisedetailed`	否
structured_inputs	对象	可以参与提示模板替换或工具参数绑定的结构化输入集。	否
温度	数字	要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性我们通常建议更改此设置或 `top_p`，但不要同时更改两者。	否	1
文本消息	PromptAgentDefinitionTextOptions	来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。	否
└─ 格式	OpenAI.TextResponseFormatConfiguration	一个对象，指定模型必须输出的格式。配置 `{ "type": "json_schema" }` 会启用结构化输出，这可确保模型与提供的 JSON 架构匹配。若要了解详细信息，请查看默认格式 `{ "type": "text" }` 没有其他选项。不建议用于 gpt-4o 和较新的模型：* 设置 `{ "type": "json_object" }` 可启用旧版 JSON 模式，确保模型生成的消息是有效的 JSON。使用 `json_schema` 对于支持该功能的模型而言，这是优先选择。	否
tool_choice	string 或 OpenAI.ToolChoiceParam	模型在生成响应时应如何选择要使用的工具（或工具）。请参阅参数 `tools` ，了解如何指定模型可以调用的工具。	否
工具	OpenAI.Tool 数组	生成响应时，模型可能会调用的工具数组。你可以通过设置 `tool_choice` 参数来指定要使用的工具。	否
top_p	数字	使用温度进行采样的替代方法，称为核采样，其中，模型考虑具有 top_p 概率质量的令牌的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。我们通常建议更改此设置或 `temperature`，但不要同时更改两者。	否	1

PromptAgentDefinitionTextOptions

来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。

姓名	类型	Description	必选	违约
格式	OpenAI.TextResponseFormatConfiguration	一个对象，指定模型必须输出的格式。配置 `{ "type": "json_schema" }` 会启用结构化输出，这可确保模型与提供的 JSON 架构匹配。若要了解详细信息，请查看默认格式 `{ "type": "text" }` 没有其他选项。不建议用于 gpt-4o 和较新的模型：* 设置 `{ "type": "json_object" }` 可启用旧版 JSON 模式，确保模型生成的消息是有效的 JSON。使用 `json_schema` 对于支持该功能的模型而言，这是优先选择。	否

PromptBasedEvaluatorDefinition

基于提示的评估器

姓名	类型	Description	必选
data_schema	对象	评估者输入数据的 JSON 架构（草案 2020-12）。这包括类型、属性、必需等参数。	否
init_parameters	对象	评估器输入参数的 JSON 架构（草案 2020-12）。这包括类型、属性、必需等参数。	否
指标	对象	此评估器生成的输出指标列表	否
prompt_text	字符串	用于评估的提示文本	是的
类型	枚举	可能的值：`prompt`	是的

ProtocolVersionRecord

单个协议及其版本的记录映射。

姓名	类型	Description	必选	违约
协议	AgentProtocol		是的
版本	字符串	协议的版本字符串，例如“v0.1.1”。	是的

RaiConfig

负责任 AI （RAI）内容筛选和安全功能的配置。

姓名	类型	Description	必选	违约
rai_policy_name	字符串	要应用的 RAI 策略的名称。	是的

RecurrenceSchedule

定期计划模型。

RecurrenceSchedule 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`Hourly`	HourlyRecurrenceSchedule
`Daily`	DailyRecurrenceSchedule
`Weekly`	WeeklyRecurrenceSchedule
`Monthly`	MonthlyRecurrenceSchedule

姓名	类型	Description	必选	违约
类型	RecurrenceType	重复类型。	是的

RecurrenceTrigger

基于重复的触发器。

姓名	类型	Description	必选	违约
endTime	字符串	ISO 8601 格式的定期计划的结束时间。	否
间隔	整数	定期计划的时间间隔。	是的
时间表	RecurrenceSchedule	定期计划模型。	是的
└─ 类型	RecurrenceType	定期计划的重复类型。	是的
startTime	字符串	ISO 8601 格式的定期计划的开始时间。	否
timeZone	字符串	定期计划的时区。	否	UTC
类型	枚举	触发器的类型。可能的值：`Recurrence`	是的

RecurrenceType

重复类型。

资产	价值
说明	重复类型。
类型	字符串
价值观	`Hourly` `Daily` `Weekly` `Monthly`

RedTeam

红队详情。

姓名	类型	Description	必选	违约
applicationScenario	字符串	应用场景为红队作，生成场景特定的攻击。	否
attackStrategies	AttackStrategy 数组	攻击策略列表或攻击策略的嵌套列表。	否
displayName	字符串	红队运行的名称。	否
id	string （只读）	红队运行的标识符。	是的
numTurns	整数	模拟轮次数。	否
属性	对象	红队的属性。与标记不同，属性是仅添加属性。添加后，无法删除属性。	否
riskCategories	RiskCategory 数组	要为其生成攻击目标的风险类别列表。	否
simulationOnly	布尔	仅仿真或仿真 + 评估。默认为 false，如果为 true，则扫描输出对话而不是评估结果。	否	假
状态	string （只读）	红队的状态。它由服务设置，并且是只读的。	否
tags	对象	红队的标签。与属性不同，标记完全可变。	否
目标	TargetConfig	目标配置的抽象类。	是的
└─ 类型	字符串	模型配置的类型。	是的

RedTeamEvalRunDataSource

姓名	类型	Description	必选
item_generation_params	ItemGenerationParams	表示用于控制项生成作的参数集。	是的
└─ 类型	ItemGenerationParamsType	要使用的项生成参数的类型。	是的
目标	目标	具有鉴别器支持的目标的基类。	是的
└─ 类型	字符串	目标的类型。	是的
类型	枚举	数据源的类型。始终为 `azure_ai_red_team`。可能的值：`azure_ai_red_team`	是的

RedTeamItemGenerationParams

姓名	类型	Description	必选	违约
attack_strategies	AttackStrategy 数组	要使用的攻击策略的集合。	是的
num_turns	整数	游戏中允许的轮次数。	是的	20
类型	枚举	项生成参数的类型。可能的值：`red_team`	是的

RedTeamSeedPromptsItemGenerationParams

表示红色团队种子提示项生成的参数。

姓名	类型	Description	必选	违约
attack_strategies	AttackStrategy 数组	要使用的攻击策略的集合。	是的
num_turns	整数	游戏中允许的轮次数。	是的	20
源	OpenAI.EvalJsonlFileContentSource		是的
└─ 内容	OpenAI.EvalJsonlFileContentSourceContent 数组	jsonl 文件的内容。	是的
└─ 类型	枚举	jsonl 源的类型。始终为 `file_content`。可能的值：`file_content`	是的
类型	枚举	项生成参数的类型，始终 `red_team_seed_prompts`为。可能的值：`red_team_seed_prompts`	是的

RedTeamTaxonomyItemGenerationParams

表示用于生成红色团队分类项的参数。

姓名	类型	Description	必选	违约
attack_strategies	AttackStrategy 数组	要使用的攻击策略的集合。	是的
num_turns	整数	游戏中允许的轮次数。	是的	20
源	OpenAI.EvalJsonlFileContentSource		是的
└─ 内容	OpenAI.EvalJsonlFileContentSourceContent 数组	jsonl 文件的内容。	是的
└─ 类型	枚举	jsonl 源的类型。始终为 `file_content`。可能的值：`file_content`	是的
类型	枚举	项生成参数的类型，始终 `red_team_taxonomy`为。可能的值：`red_team_taxonomy`	是的

ResponseRetrievalItemGenerationParams

表示用于生成响应检索项的参数。

姓名	类型	Description	必选
data_mapping	对象	从源字段映射到response_id字段，检索聊天历史记录所必需的。	是的
max_num_turns	整数	要评估的聊天历史记录的最大轮次数。	是的
源	OpenAI.EvalJsonlFileContentSource 或 OpenAI.EvalJsonlFileIdSource	从中读取 JSONL 内容的源。	是的
类型	枚举	项生成参数的类型，始终 `response_retrieval`为。可能的值：`response_retrieval`	是的

RiskCategory

攻击目标的风险类别。

资产	价值
说明	攻击目标的风险类别。
类型	字符串
价值观	`HateUnfairness` `Violence` `Sexual` `SelfHarm` `ProtectedMaterial` `CodeVulnerability` `UngroundedAttributes` `ProhibitedActions` `SensitiveDataLeakage` `TaskAdherence`

SASCredentials

共享Access签名（SAS）凭证定义

姓名	类型	Description	必选	违约
SAS	string （只读）	SAS 令牌	否
类型	枚举	凭据类型可能的值：`SAS`	是的

SampleType

分析中使用的样品类型。

资产	价值
说明	分析中使用的样品类型。
类型	字符串
价值观	`EvaluationResultSample`

SasCredential 证书

SAS 凭证定义

姓名	类型	Description	必选	违约
sasUri	string （只读）	SAS URI	是的
类型	枚举	凭证类型可能的值：`SAS`	是的

时间表

计划模型。

姓名	类型	Description	必选
说明	字符串	计划的描述。	否
displayName	字符串	计划名称。	否
enabled	布尔	计划的已启用状态。	是的
id	string （只读）	计划的标识符。	是的
属性	对象	Schedule 的属性。与标记不同，属性是仅添加属性。添加后，无法删除属性。	否
provisioning状态	ScheduleProvisioningStatus （只读）	计划配置状态。	否
系统数据	对象（只读）	资源的系统元数据。	是的
tags	对象	Schedule 的标签。与属性不同，标记完全可变。	否
任务	ScheduleTask	计划任务模型。	是的
~~ 配置	对象	任务的配置。	否
└─ 类型	ScheduleTaskType	任务的类型。	是的
触发	Trigger	计划触发器的基本模型。	是的
└─ 类型	TriggerType	触发器的类型。	是的

ScheduleProvisioningStatus

计划配置状态。

资产	价值
说明	计划配置状态。
类型	字符串
价值观	`Creating` `Updating` `Deleting` `Succeeded` `Failed`

ScheduleRun

计划运行模型。

姓名	类型	Description	必选
错误	string （只读）	计划运行的错误信息。	否
id	string （只读）	计划运行的标识符。	是的
属性	对象（只读）	计划运行的属性。	是的
scheduleId	字符串	计划的标识符。	是的
success	布尔值（只读）	触发计划运行的成功状态。	是的
triggerTime	字符串	计划运行的触发时间。	否

ScheduleTask

计划任务模型。

ScheduleTask 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`Evaluation`	EvaluationScheduleTask
`Insight`	InsightScheduleTask

姓名	类型	Description	必选	违约
配置	对象	任务的配置。	否
类型	ScheduleTaskType	任务的类型。	是的

ScheduleTaskType

任务的类型。

资产	价值
说明	任务的类型。
类型	字符串
价值观	`Evaluation` `Insight`

SharepointGroundingToolParameters

SharePoint 接地工具参数。

姓名	类型	Description	必选	违约
project_connections	ToolProjectConnection 的数组	该工具关联到project connections。最多可以有 1 个连接附加到该工具的资源。	否

SharepointPreviewTool

用于配置代理的 sharepoint 工具的输入定义信息。

姓名	类型	Description	必选
sharepoint_grounding_preview	SharepointGroundingToolParameters	SharePoint 接地工具参数。	是的
project_connections	ToolProjectConnection 的数组	该工具关联到project connections。最多可以有 1 个连接附加到该工具的资源。约束： maxItems：1	否
类型	枚举	对象类型，始终是“sharepoint_grounding_preview”。可能的值：`sharepoint_grounding_preview`	是的

Sku

Sku 信息

姓名	类型	Description	必选
产能	整数	Sku 容量	是的
family	字符串	Sku 家族	是的
姓名	字符串	Sku 名称	是的
大小	字符串	Sku 大小	是的
分层	字符串	Sku 层	是的

StructuredInputDefinition

可以参与提示模板替换和工具参数绑定的结构化输入。

姓名	类型	Description	必选	违约
default_value		如果未提供运行时值，则输入的默认值。	否
说明	字符串	输入的人类可读描述。	否
（必需）	布尔	调用代理时是否需要输入属性。	否	假
架构	对象	结构化输入的 JSON 架构（可选）。	否

StructuredOutputDefinition

代理可以生成的结构化输出。

姓名	类型	Description	必选
说明	字符串	要发出的输出的描述。模型用于确定何时发出输出。	是的
姓名	字符串	结构化输出的名称。	是的
架构	对象	结构化输出的 JSON 架构。	是的
strict	布尔值（可为 null）	是否强制执行严格验证。默认 `true`。	是的

StructuredOutputsOutputItem

姓名	类型	Description	必选
agent_reference	AgentReference		否
└─ 名称	字符串	代理的名称。约束： maxLength：256	是的
└─ 类型	枚举	可能的值：`agent_reference`	是的
└─ 版本	字符串	代理的版本标识符。	否
输出		响应期间捕获的结构化输出。	是的
response_id	字符串	创建项的响应。	否
类型	枚举	可能的值：`structured_outputs`	是的

SyntheticDataGenerationPreviewEvalRunDataSource

表示评估运行的数据源，该数据源根据生成的综合数据进行评估，以便进行测试。

姓名	类型	Description	必选
输入消息	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate		否
~~ 模板	对象或 OpenAI.EvalItem 数组		是的
└─ 类型	枚举	可能的值：`template`	是的
item_generation_params	SyntheticDataGenerationPreviewItemGenerationParams		是的
model_deployment_name	字符串	用于生成综合数据的模型部署的名称。	是的
output_dataset_id	string （只读）	存储生成的综合数据的输出数据集的标识符。生成的数据是一个 jsonl 文件，其中包含列 ID、查询和test_description。	否
output_dataset_name	字符串	将存储生成的合成数据的输出数据集的名称。如果未提供，服务会自动生成数据集名称。	否
└─ 提示	字符串	用于生成综合数据的提示。如果目标的类型为“azure_ai_agent”，并在代理中配置了说明，则此选项。	否
samples_count	整数	要生成的最大数据样本数。	是的
~~ 源	OpenAI.EvalJsonlFileIdSource 的数组	用于生成数据的可选种子数据内容源文件。	是的
└─ 类型	枚举	项生成参数的类型。可能的值：`synthetic_data_gen_preview`	是的
目标	目标	具有鉴别器支持的目标的基类。	是的
└─ 类型	字符串	目标的类型。	是的
类型	枚举	数据源的类型，始终 `azure_ai_synthetic_data_gen_preview`为。可能的值：`azure_ai_synthetic_data_gen_preview`	是的

SyntheticDataGenerationPreviewItemGenerationParams

姓名	类型	Description	必选
model_deployment_name	字符串	用于生成综合数据的模型部署的名称。	是的
output_dataset_id	string （只读）	存储生成的综合数据的输出数据集的标识符。生成的数据是一个 jsonl 文件，其中包含列 ID、查询和test_description。	否
output_dataset_name	字符串	将存储生成的合成数据的输出数据集的名称。如果未提供，服务会自动生成数据集名称。	否
提示	字符串	用于生成综合数据的提示。如果目标的类型为“azure_ai_agent”，并在代理中配置了说明，则此选项。	否
samples_count	整数	要生成的最大数据样本数。	是的
来源	OpenAI.EvalJsonlFileIdSource 的数组	用于生成数据的可选种子数据内容源文件。	是的
类型	枚举	项生成参数的类型。可能的值：`synthetic_data_gen_preview`	是的

目标

具有鉴别器支持的目标的基类。

目标鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`azure_ai_model`	AzureAIModelTarget
`azure_ai_agent`	AzureAIAgentTarget

姓名	类型	Description	必选	违约
类型	字符串	目标的类型。	是的

TargetCompletionEvalRunDataSource

表示基于目标的完成评估配置的数据源。

姓名	类型	Description	必选
输入消息	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference		否
item_reference	字符串		是的
└─ 类型	枚举	可能的值：`item_reference`	是的
源	OpenAI.EvalJsonlFileContentSource 或 OpenAI.EvalJsonlFileIdSource	内联或文件数据的源配置。	是的
目标	目标	具有鉴别器支持的目标的基类。	是的
└─ 类型	字符串	目标的类型。	是的
类型	枚举	数据源的类型，始终 `azure_ai_target_completions`为。可能的值：`azure_ai_target_completions`	是的

TargetConfig

目标配置的抽象类。

TargetConfig 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`AzureOpenAIModel`	AzureOpenAIModelConfiguration

姓名	类型	Description	必选	违约
类型	字符串	模型配置的类型。	是的

TargetUpdate

具有鉴别器支持的目标的基类。

TargetUpdate 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`azure_ai_model`	AzureAIModelTargetUpdate
`azure_ai_agent`	AzureAIAgentTargetUpdate

姓名	类型	Description	必选	违约
类型	字符串	目标的类型。	是的

TaxonomyCategory

分类类别定义。

姓名	类型	Description	必选
说明	字符串	分类类别的描述。	否
id	字符串	分类类别的唯一标识符。	是的
姓名	字符串	分类类别的名称。	是的
属性	对象	分类类别的其他属性。	否
riskCategory	RiskCategory	攻击目标的风险类别。	是的
subCategories	TaxonomySubCategory 数组	分类学子类别列表。	是的

TaxonomySubCategory

分类学子类别定义。

姓名	类型	Description	必选
说明	字符串	分类学子类别的描述。	否
enabled	布尔	此子类别下的分类项列表。	是的
id	字符串	分类子类别的唯一标识符。	是的
姓名	字符串	分类子类别的名称。	是的
属性	对象	分类子类别的其他属性。	否

ToolDescription

代理可以使用的工具的描述。

姓名	类型	Description	必选	违约
说明	字符串	该工具用途的简要说明。	否
姓名	字符串	工具的名称。	否

ToolProjectConnection

一个project连接资源。

姓名	类型	Description	必选	违约
project_connection_id	字符串	该工具附着的 ToolProjectConnectionList 中的 project 连接。	是的

TracesPreviewEvalRunDataSource

表示用于对 Application Insights 中存储的代理跟踪运行的计算运行的数据源。

姓名	类型	Description	必选	违约
agent_id	字符串	用于筛选跟踪以供评估的代理 ID。	否
agent_name	字符串	用于筛选用于评估的跟踪的代理名称。	否
end_time	整数	标记跟踪查询窗口末尾的 Unix 时间戳（以秒为单位）。默认为当前时间。	否
ingestion_delay_seconds	整数	查询跟踪时要应用的引入延迟。	否	300
lookback_hours	整数	从 Application Insights 检索跟踪时应用的回溯窗口（以小时为单位）。对于计划的评估，这是从重复间隔推断的。	否	168
max_traces	整数	应用于为评估检索的跟踪的采样限制。	否	1000
trace_ids	字符串数组	应评估的代理跟踪标识符的集合。	否
类型	枚举	数据源的类型，始终 `azure_ai_traces_preview`为。可能的值：`azure_ai_traces_preview`	是的

TreatmentEffectType

治疗效果类型。

资产	价值
说明	治疗效果类型。
类型	字符串
价值观	`TooFewSamples` `Inconclusive` `Changed` `Improved` `Degraded`

Trigger

计划触发器的基本模型。

触发器的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	Schema
`Cron`	CronTrigger 的
`Recurrence`	RecurrenceTrigger 触发器
`OneTime`	OneTimeTrigger

姓名	类型	Description	必选	违约
类型	TriggerType	触发器的类型。	是的

触发类型

触发器的类型。

资产	价值
说明	触发器的类型。
类型	字符串
价值观	`Cron` `Recurrence` `OneTime`

UpdateAgentFromManifestRequest

姓名	类型	Description	必选
说明	字符串	代理的可读说明。约束： maxLength：512	否
manifest_id	字符串	要从中导入代理版本的清单 ID。	是的
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
parameter_values	对象	清单的输入将导致完全具体化代理。	是的

UpdateAgentRequest

姓名	类型	Description	必选
定义	AgentDefinition		是的
~~ kind	AgentKind		是的
rai_config	RaiConfig	负责任 AI （RAI）内容筛选和安全功能的配置。	否
说明	字符串	代理的可读说明。约束： maxLength：512	否
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否

UpdateEvalParametersBody

姓名	类型	Description	必选
元数据	OpenAI.Metadata （可为 null）	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
姓名	字符串		否
属性	对象	一组不可变的 16 键值对，这些键值对可以附加到对象以存储其他信息。键是最大长度为 64 个字符的字符串。值为最大长度为 512 个字符的字符串。	否

UserProfileMemoryItem

专门包含从对话中提取的用户个人资料信息的记忆项，例如偏好、兴趣和个人详细信息。

姓名	类型	Description	必选
内容	字符串	内存的内容。	是的
kind	枚举	记忆项目的种类。可能的值：`user_profile`	是的
memory_id	字符串	内存项的唯一 ID。	是的
作用域	字符串	在逻辑上对内存进行分组和隔离的命名空间，例如用户 ID。	是的
updated_at	整数	内存项目的最后更新时间。	是的

WebSearchConfiguration

bing自定义搜索的网页搜索配置

姓名	类型	Description	必选	违约
instance_name	字符串	给定用于配置的自定义配置实例的名称。	是的
project_connection_id	字符串	Project 连接 ID 用于接地，使用 bing 自定义搜索	是的

WeeklyRecurrenceSchedule

每周重复计划。

姓名	类型	Description	必选	违约
daysOfWeek	DayOfWeek 数组	重复计划的一周中的几天。	是的
类型	枚举	每周重复类型。可能的值：`Weekly`	是的

WorkflowActionOutputItem

姓名	类型	Description	必选
action_id	字符串	作的唯一标识符。	是的
agent_reference	AgentReference		否
└─ 名称	字符串	代理的名称。约束： maxLength：256	是的
└─ 类型	枚举	可能的值：`agent_reference`	是的
└─ 版本	字符串	代理的版本标识符。	否
kind	字符串	CSDL作的类型（例如“SetVariable”、“InvokeAzureAgent”）。	是的
parent_action_id	字符串	如果这是嵌套作，则为父作的 ID。	否
previous_action_id	字符串	如果此作遵循另一个作，则为上一作的 ID。	否
response_id	字符串	创建项的响应。	否
状态	枚举	作的状态（例如“in_progress”、“completed”、“failed”、“cancelled”）。可能的值：`completed`、`failed`、`in_progress`、`cancelled`	是的
类型	枚举	可能的值：`workflow_action`	是的

WorkflowAgentDefinition

工作流代理定义。

姓名	类型	Description	必选
kind	枚举	可能的值：`workflow`	是的
rai_config	RaiConfig	负责任 AI （RAI）内容筛选和安全功能的配置。	否
rai_policy_name	字符串	要应用的 RAI 策略的名称。	是的
工作流	字符串	工作流的 CSDL YAML 定义。	否

整数

类型：整数

格式：int64

Last updated on 2026-03-10