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

Microsoft Foundry 项目 REST 参考

API 版本：2025-11-15-preview

代理 - 创建代理

POST {endpoint}/agents?api-version=2025-11-15-preview

创建代理。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

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

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

代理 - 列出代理

GET {endpoint}/agents?api-version=2025-11-15-preview

返回所有代理的列表。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
kind	查询	否		按种类过滤剂。如果未提供，则返回所有代理。
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，以便提取列表中的上一页内容。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

代理 - 获取代理

GET {endpoint}/agents/{agent_name}?api-version=2025-11-15-preview

检索代理。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
agent_name	路径	是的	字符串	要检索的代理的名称。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

代理 - 更新代理

POST {endpoint}/agents/{agent_name}?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
agent_name	路径	是的	字符串	要检索的代理的名称。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

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

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

代理 - 删除代理

DELETE {endpoint}/agents/{agent_name}?api-version=2025-11-15-preview

删除代理。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
agent_name	路径	是的	字符串	要删除的代理的名称。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

代理 - 从清单更新代理

POST {endpoint}/agents/{agent_name}/import?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
agent_name	路径	是的	字符串	要更新的代理的名称。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

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

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

代理 - 列出代理容器作

GET {endpoint}/agents/{agent_name}/operations?api-version=2025-11-15-preview

列出代理的容器作。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
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，以便提取列表中的上一页内容。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

代理 - 获取代理容器作

GET {endpoint}/agents/{agent_name}/operations/{operation_id}?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
agent_name	路径	是的	字符串	代理的名称。
operation_id	路径	是的	字符串	作 ID。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

代理 - 创建代理版本

POST {endpoint}/agents/{agent_name}/versions?api-version=2025-11-15-preview

创建新的代理版本。

URI 参数

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

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

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

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

代理 - 列出代理版本

GET {endpoint}/agents/{agent_name}/versions?api-version=2025-11-15-preview

返回代理的版本列表。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
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，以便提取列表中的上一页内容。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

代理 - 获取代理版本

GET {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=2025-11-15-preview

检索代理的特定版本。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
agent_name	路径	是的	字符串	要检索的代理的名称。
agent_version	路径	是的	字符串	要检索的代理的版本。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

代理 - 删除代理版本

DELETE {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=2025-11-15-preview

删除代理的特定版本。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
agent_name	路径	是的	字符串	要删除的代理的名称。
agent_version	路径	是的	字符串	要删除的代理的版本

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

代理 - 获取代理容器

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
agent_name	路径	是的	字符串	代理的名称。
agent_version	路径	是的	字符串	代理的版本。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

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

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default/operations?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
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，以便提取列表中的上一页内容。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

代理 - 删除代理容器

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:delete?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
agent_name	路径	是的	字符串	代理的名称。
agent_version	路径	是的	字符串	代理的版本。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码： 202

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

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

状态代码：默认值

说明：意外的错误响应。

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

代理 - 启动代理容器

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:start?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
agent_name	路径	是的	字符串	代理的名称。
agent_version	路径	是的	字符串	代理的版本。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

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

Responses

状态代码： 202

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

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

状态代码：默认值

说明：意外的错误响应。

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

代理 - 停止代理容器

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:stop?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
agent_name	路径	是的	字符串	代理的名称。
agent_version	路径	是的	字符串	代理的版本。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码： 202

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

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

状态代码：默认值

说明：意外的错误响应。

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

代理 - 更新代理容器

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:update?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
agent_name	路径	是的	字符串	代理的名称。
agent_version	路径	是的	字符串	代理的版本。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

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

Responses

状态代码： 202

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

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

状态代码：默认值

说明：意外的错误响应。

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

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

POST {endpoint}/agents/{agent_name}/versions:import?api-version=2025-11-15-preview

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

URI 参数

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

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

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

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

代理 - 从清单创建代理

POST {endpoint}/agents:import?api-version=2025-11-15-preview

从清单创建代理。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

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

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

连接 - 列表

GET {endpoint}/connections?api-version=2025-11-15-preview

列出项目中的所有连接，而不填充连接凭证

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
connectionType	查询	否		列出此特定类型的连接
defaultConnection	查询	否	布尔	列出默认连接的连接
x-ms-client-request-id	标头	否		请求的不透明、全局唯一的客户端生成的字符串标识符。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

连接 - 获取

GET {endpoint}/connections/{name}?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	由用户提供的连接的友好名称。
x-ms-client-request-id	标头	否		请求的不透明、全局唯一的客户端生成的字符串标识符。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

连接 - 使用凭据获取

POST {endpoint}/connections/{name}/getConnectionWithCredentials?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	由用户提供的连接的友好名称。
x-ms-client-request-id	标头	否		请求的不透明、全局唯一的客户端生成的字符串标识符。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

数据集 - 列出最新

GET {endpoint}/datasets?api-version=2025-11-15-preview

列出每个 DatasetVersion 的最新版本

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

数据集 - 列表版本

GET {endpoint}/datasets/{name}/versions?api-version=2025-11-15-preview

列出给定 DatasetVersion 的所有版本

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

数据集 - 获取版本

GET {endpoint}/datasets/{name}/versions/{version}?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称
版本	路径	是的	字符串	要检索的 DatasetVersion 的特定版本 ID。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

数据集 - 删除版本

DELETE {endpoint}/datasets/{name}/versions/{version}?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称
版本	路径	是的	字符串	要删除的 DatasetVersion 的版本。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码： 204

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

状态代码：默认值

说明：意外的错误响应。

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

数据集 - 创建或更新版本

PATCH {endpoint}/datasets/{name}/versions/{version}?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称
版本	路径	是的	字符串	要创建或更新的 DatasetVersion 的特定版本 ID。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

Content-Type：application/merge-patch+json

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

Responses

状态代码：200

说明：请求已成功。

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

状态代码： 201

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

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

状态代码：默认值

说明：意外的错误响应。

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

数据集 - 获取凭据

POST {endpoint}/datasets/{name}/versions/{version}/credentials?api-version=2025-11-15-preview

获取 SAS 凭据以访问与数据集版本关联的存储帐户。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称
版本	路径	是的	字符串	要作的 DatasetVersion 的特定版本 ID。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

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

POST {endpoint}/datasets/{name}/versions/{version}/startPendingUpload?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称
版本	路径	是的	字符串	要作的 DatasetVersion 的特定版本 ID。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

姓名	类型	Description	必选
connectionName （连接名称）	字符串	用于生成临时 SAS 令牌的 Azure 存储帐户连接名称	否
pendingUploadId	字符串	如果未提供 PendingUploadId，则将使用随机 GUID。	否
pendingUploadType	枚举	BlobReference 是唯一支持的类型。可能的值：`BlobReference`	是的

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

部署 - 列表

GET {endpoint}/deployments?api-version=2025-11-15-preview

列出项目中所有已部署的模型

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
modelPublisher	查询	否	字符串	用于筛选模型的模型发布者
modelName	查询	否	字符串	模型名称（发布者特定名称），用于筛选模型
deploymentType	查询	否		筛选列表的部署类型
x-ms-client-request-id	标头	否		请求的不透明、全局唯一的客户端生成的字符串标识符。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

部署 - 获取

GET {endpoint}/deployments/{name}?api-version=2025-11-15-preview

获取已部署的模型。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	部署的名称
x-ms-client-request-id	标头	否		请求的不透明、全局唯一的客户端生成的字符串标识符。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

评估规则 - 列表

GET {endpoint}/evaluationrules?api-version=2025-11-15-preview

列出所有评估规则。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
actionType	查询	否		按评估规则的类型进行筛选。
agentName （代理名称）	查询	否	字符串	按代理名称筛选。
enabled	查询	否	布尔	按已启用状态进行筛选。
x-ms-client-request-id	标头	否		请求的不透明、全局唯一的客户端生成的字符串标识符。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

评估规则 - 获取

GET {endpoint}/evaluationrules/{id}?api-version=2025-11-15-preview

获取评估规则。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
id	路径	是的	字符串	评估规则的唯一标识符。
x-ms-client-request-id	标头	否		请求的不透明、全局唯一的客户端生成的字符串标识符。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

评估规则 - 删除

DELETE {endpoint}/evaluationrules/{id}?api-version=2025-11-15-preview

删除评估规则。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
id	路径	是的	字符串	评估规则的唯一标识符。
x-ms-client-request-id	标头	否		请求的不透明、全局唯一的客户端生成的字符串标识符。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码： 204

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

状态代码：默认值

说明：意外的错误响应。

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

评估规则 - 创建或更新

PUT {endpoint}/evaluationrules/{id}?api-version=2025-11-15-preview

创建或更新评估规则。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
id	路径	是的	字符串	评估规则的唯一标识符。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

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

Responses

状态代码：200

说明：请求已成功。

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

状态代码： 201

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

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

状态代码：默认值

说明：意外的错误响应。

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

评估分类 - 列表

GET {endpoint}/evaluationtaxonomies?api-version=2025-11-15-preview

列表评估分类法

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
inputName	查询	否	字符串	按评估输入名称进行筛选。
inputType	查询	否	字符串	按分类输入类型筛选。
x-ms-client-request-id	标头	否		请求的不透明、全局唯一的客户端生成的字符串标识符。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

评估分类 - get

GET {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview

获取按名称运行的评估。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称
x-ms-client-request-id	标头	否		请求的不透明、全局唯一的客户端生成的字符串标识符。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

评估分类 - 删除

DELETE {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview

按名称删除评估分类。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称
x-ms-client-request-id	标头	否		请求的不透明、全局唯一的客户端生成的字符串标识符。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码： 204

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

状态代码：默认值

说明：意外的错误响应。

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

评估分类 - 创建

PUT {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview

创建评估分类。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	评估分类的名称。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

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

Responses

状态代码：200

说明：请求已成功。

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

状态代码： 201

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

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

状态代码：默认值

说明：意外的错误响应。

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

评估分类 - 更新

PATCH {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview

更新评估分类。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	评估分类的名称。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

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

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

计算器 - 列出最新版本

GET {endpoint}/evaluators?api-version=2025-11-15-preview

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

URI 参数

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

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

计算器 - 列出版本

GET {endpoint}/evaluators/{name}/versions?api-version=2025-11-15-preview

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

URI 参数

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

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

计算器 - 创建版本

POST {endpoint}/evaluators/{name}/versions?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

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

Responses

状态代码： 201

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

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

状态代码：默认值

说明：意外的错误响应。

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

计算器 - 获取版本

GET {endpoint}/evaluators/{name}/versions/{version}?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称
版本	路径	是的	字符串	要检索的 EvaluatorVersion 的特定版本 ID。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

计算器 - 删除版本

DELETE {endpoint}/evaluators/{name}/versions/{version}?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称
版本	路径	是的	字符串	要删除的 EvaluatorVersion 的版本。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码： 204

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

状态代码：默认值

说明：意外的错误响应。

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

计算器 - 更新版本

PATCH {endpoint}/evaluators/{name}/versions/{version}?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称
版本	路径	是的	字符串	要更新的 EvaluatorVersion 的版本。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

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

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

索引 - 列出最新

GET {endpoint}/indexes?api-version=2025-11-15-preview

列出每个索引的最新版本

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

索引 - 列表版本

GET {endpoint}/indexes/{name}/versions?api-version=2025-11-15-preview

列出给定索引的所有版本

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

索引 - 获取版本

GET {endpoint}/indexes/{name}/versions/{version}?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称
版本	路径	是的	字符串	要检索的 Index 的特定版本 ID。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

索引 - 删除版本

DELETE {endpoint}/indexes/{name}/versions/{version}?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	资源的名称
版本	路径	是的	字符串	要删除的 Index 的版本。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码： 204

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

状态代码：默认值

说明：意外的错误响应。

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

索引 - 创建或更新版本

PATCH {endpoint}/indexes/{name}/versions/{version}?api-version=2025-11-15-preview

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

URI 参数

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

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

Content-Type：application/merge-patch+json

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

Responses

状态代码：200

说明：请求已成功。

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

状态代码： 201

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

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

状态代码：默认值

说明：意外的错误响应。

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

见解 - 生成

POST {endpoint}/insights?api-version=2025-11-15-preview

生成见解

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
可重复性 -Request-ID	标头	否	字符串	客户端生成的唯一标识符，用于确保请求幂等性。使用相同的 ID 进行重试，以防止重复评估。
可重复性 -First-Sent	标头	否	字符串	时间戳，指示首次启动此请求的时间。与 repeatability-request-id 结合使用以进行幂等控制。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

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

Responses

状态代码： 201

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

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

状态代码：默认值

说明：意外的错误响应。

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

见解 - 列表

GET {endpoint}/insights?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
类型	查询	否		按分析类型筛选。
evalId	查询	否	字符串	按评估 ID 筛选。
runId	查询	否	字符串	按评估运行 ID 进行筛选。
agentName （代理名称）	查询	否	字符串	按代理名称筛选。
includeCoordinates	查询	否	布尔	是否在响应中包含可视化的坐标。默认值为 false。
x-ms-client-request-id	标头	否		请求的不透明、全局唯一的客户端生成的字符串标识符。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

见解 - 获取

GET {endpoint}/insights/{id}?api-version=2025-11-15-preview

按 ID 获取特定见解。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
id	路径	是的	字符串	见解报表的唯一标识符。
includeCoordinates	查询	否	布尔	是否在响应中包含可视化的坐标。默认值为 false。
x-ms-client-request-id	标头	否		请求的不透明、全局唯一的客户端生成的字符串标识符。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

创建内存存储

POST {endpoint}/memory_stores?api-version=2025-11-15-preview

创建内存存储。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

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

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

列出内存空间

GET {endpoint}/memory_stores?api-version=2025-11-15-preview

列出所有内存存储。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
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，以便提取列表中的上一页内容。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

更新内存存储

POST {endpoint}/memory_stores/{name}?api-version=2025-11-15-preview

更新内存存储。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	要更新的内存存储的名称。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

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

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

获取内存存储

GET {endpoint}/memory_stores/{name}?api-version=2025-11-15-preview

检索内存存储。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	要检索的内存存储的名称。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

删除内存存储

DELETE {endpoint}/memory_stores/{name}?api-version=2025-11-15-preview

删除内存存储。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	要删除的内存存储的名称。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

获取更新结果

GET {endpoint}/memory_stores/{name}/updates/{update_id}?api-version=2025-11-15-preview

获取内存存储更新结果。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	内存存储的名称。
update_id	路径	是的	字符串	内存更新作的 ID。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

删除范围内存

POST {endpoint}/memory_stores/{name}:delete_scope?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	内存存储的名称。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

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

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

搜索记忆

POST {endpoint}/memory_stores/{name}:search_memories?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	要搜索的内存存储的名称。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

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

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

更新记忆

POST {endpoint}/memory_stores/{name}:update_memories?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	要更新的内存存储的名称。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

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

Responses

状态代码： 202

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

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

状态代码：默认值

说明：意外的错误响应。

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

创建对话

POST {endpoint}/openai/conversations?api-version=2025-11-15-preview

创建对话。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

姓名	类型	Description	必选	违约
items	数组	要包含对话上下文的初始项。一次最多可以添加 20 个项目。	否
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

列出对话

GET {endpoint}/openai/conversations?api-version=2025-11-15-preview

返回所有对话的列表。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
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 关联的项。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

更新对话

POST {endpoint}/openai/conversations/{conversation_id}?api-version=2025-11-15-preview

更新对话。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
conversation_id	路径	是的	字符串	要更新的对话的 ID。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

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

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

获取对话

GET {endpoint}/openai/conversations/{conversation_id}?api-version=2025-11-15-preview

检索对话。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
conversation_id	路径	是的	字符串	要检索的对话的 ID。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

删除对话

DELETE {endpoint}/openai/conversations/{conversation_id}?api-version=2025-11-15-preview

删除对话。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
conversation_id	路径	是的	字符串	要删除的对话的 ID。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

创建对话项

POST {endpoint}/openai/conversations/{conversation_id}/items?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
conversation_id	路径	是的	字符串	需要在其中创建项的会话的 ID。
包括	查询	否	数组	要包含在响应中的其他字段。有关详细信息， `include` 请参阅列出对话项的参数。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

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

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

列出对话项

GET {endpoint}/openai/conversations/{conversation_id}/items?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
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	查询	否		按项类型进行筛选。如果提供，则仅返回指定类型的项。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

获取对话项

GET {endpoint}/openai/conversations/{conversation_id}/items/{item_id}?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
conversation_id	路径	是的	字符串	包含该项的会话的 ID。
item_id	路径	是的	字符串	要检索的对话项的 ID。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

删除对话项

DELETE {endpoint}/openai/conversations/{conversation_id}/items/{item_id}?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
conversation_id	路径	是的	字符串	需要从中删除项的会话的 ID。
item_id	路径	是的	字符串	要删除的对话项的 ID。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

OpenAI evals - list evals

GET {endpoint}/openai/evals?api-version=2025-11-15-preview

列出项目的所有评估列表评估。

URI 参数

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

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

OpenAI evals - 创建 eval

POST {endpoint}/openai/evals?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

姓名	类型	Description	必选
数据源配置	对象	一个 CustomDataSourceConfig 对象，用于定义用于评估运行的数据源的架构。此架构用于定义将要处理的数据的结构： - 用于定义测试条件和 - 创建运行时需要哪些数据	是的
包含示例架构	布尔	评估是否应期望由你填充示例命名空间（即通过从数据源生成响应）	否
条目模式	对象	数据源中每一行的 json 架构。	否
└─ 元数据	对象	存储的补全数据源的元数据筛选器。	否
~~ 方案	枚举	数据架构方案。可能的值：`red_team`、、 `responsestraces`	否
└─ 类型	枚举	始终为 `label_model` 的对象类型。可能的值：`azure_ai_source`	否
元数据	OpenAI.Metadata	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
姓名	字符串	评估的名称。	否
属性	对象	一组不可变的 16 键值对，这些键值对可以附加到对象以存储其他信息。键是最大长度为 64 个字符的字符串。值为最大长度为 512 个字符的字符串。	否
测试标准	数组	此组中所有评估运行的评分程序列表。评分器可以使用双花括号符号引用数据源中的变量，例如 `{{item.variable_name}}`。若要引用模型的输出，请使用 `sample` 命名空间（即 `{{sample.output_text}}`）。	是的

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

OpenAI evals - 删除 eval

DELETE {endpoint}/openai/evals/{eval_id}?api-version=2025-11-15-preview

删除评估删除评估。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
eval_id	路径	是的	字符串	要删除的评估的 ID。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

OpenAI evals - 获取 eval

GET {endpoint}/openai/evals/{eval_id}?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
eval_id	路径	是的	字符串	要检索的评估的 ID。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

OpenAI evals - 更新 eval

POST {endpoint}/openai/evals/{eval_id}?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
eval_id	路径	是的	字符串	要更新的评估的 ID。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

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

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

OpenAI evals - 列表运行

GET {endpoint}/openai/evals/{eval_id}/runs?api-version=2025-11-15-preview

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

URI 参数

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

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

OpenAI evals - 创建 eval 运行

POST {endpoint}/openai/evals/{eval_id}/runs?api-version=2025-11-15-preview

创建评估运行

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
eval_id	路径	是的	字符串	要为其创建运行的评估的 ID。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

姓名	类型	Description	必选
数据源	对象	一个 JsonlRunDataSource 对象，该对象指定与 eval 匹配的 JSONL 文件	是的
输入消息	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate 或 OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference	从模型采样时使用。指示传递到模型的消息的结构。可以是对预生成轨迹（即）的引用， `item.input_trajectory`也可以是具有对命名空间的变量引用的 `item` 模板。	否
item_generation_params	RedTeamItemGenerationParams	项生成的参数。	否
└─ 模型	字符串	用于生成补全的模型的名称（例如“o3-mini”）。	否
采样参数 (sampling_params)	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		否
└─ 来源	OpenAI.EvalJsonlFileContentSource 或 OpenAI.EvalJsonlFileIdSource 或 OpenAI.EvalResponsesSource	确定在此运行的数据源中填充 `item` 命名空间的内容。	否
~~ 目标	目标	评估的目标配置。	否
└─ 类型	字符串	数据源类型鉴别器。	否
元数据	OpenAI.Metadata	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
姓名	字符串	运行的名称。	否
属性	对象	一组不可变的 16 键值对，这些键值对可以附加到对象以存储其他信息。键是最大长度为 64 个字符的字符串。值为最大长度为 512 个字符的字符串。	否

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

OpenAI evals - 删除 eval 运行

DELETE {endpoint}/openai/evals/{eval_id}/runs/{run_id}?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
eval_id	路径	是的	字符串	要从中删除运行的评估的 ID。
run_id	路径	是的	字符串	要删除的运行的 ID。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

OpenAI evals - 获取 eval 运行

GET {endpoint}/openai/evals/{eval_id}/runs/{run_id}?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
eval_id	路径	是的	字符串	要检索其运行的评估的 ID。
run_id	路径	是的	字符串	要检索的运行的 ID。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

OpenAI evals - 取消 eval 运行

POST {endpoint}/openai/evals/{eval_id}/runs/{run_id}?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
eval_id	路径	是的	字符串	要取消其运行的评估的 ID。
run_id	路径	是的	字符串	要取消的运行的 ID。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

OpenAI evals - 获取 eval 运行输出项

GET {endpoint}/openai/evals/{eval_id}/runs/{run_id}/output_items?api-version=2025-11-15-preview

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

URI 参数

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

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

OpenAI evals - 获取 eval 运行输出项

GET {endpoint}/openai/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
eval_id	路径	是的	字符串	要检索其运行的评估的 ID。
run_id	路径	是的	字符串	要检索的运行的 ID。
output_item_id	路径	是的	字符串	要检索的输出项的 ID。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

创建微调作业

POST {endpoint}/openai/fine-tuning/jobs?api-version=2025-11-15-preview

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

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

详细了解微调

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

姓名	类型	Description	必选	违约
超参数	对象	用于微调作业的超参数。此值现已被弃用，请改用 `method` 参数，并在 `method` 参数下传递。	否
batch_size	枚举	可能的值：`auto`	否
学习率倍增器	枚举	可能的值：`auto`	否
n_epochs	枚举	可能的值：`auto`	否
integrations	数组	要为微调作业启用的集成列表。	否
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
方法	OpenAI.FineTuneMethod	用于微调的方法。	否
模型	字符串（请参阅下面的有效模型）	要微调的模型的名称。可以选择其中一个支持的模型。	是的
seed	整数	种子控制作业的可重现性。传入相同的种子和作业参数应会产生相同的结果，但在极少数情况下可能会有差异。如果未指定种子，则会为你生成一个种子。	否
suffix	字符串	最多 64 个字符的字符串，将添加到微调模型名称中。例如，`suffix` 为“custom-model-name”，将生成类似 `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel` 这样的模型名称。	否	None
训练文件	字符串	包含训练数据的已上传文件的 ID。数据集必须格式化为 JSONL 文件。此外，必须上传文件，目的是执行 `fine-tune` 操作。文件的内容应根据模型是使用聊天格式、补全格式，还是微调方法使用偏好格式而有所不同。有关更多详细信息，请参阅微调指南。	是的
验证文件	字符串	包含验证数据的已上传文件的 ID。如果提供此文件，则数据将在微调期间定期用于生成验证指标。这些指标可在微调结果文件中查看。训练文件和验证文件中不应存在相同的数据。数据集必须格式化为 JSONL 文件。必须上传文件，目的是执行 `fine-tune` 操作。有关更多详细信息，请参阅微调指南。	否

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

列出分页微调作业

GET {endpoint}/openai/fine-tuning/jobs?api-version=2025-11-15-preview

列出组织的微调作业

URI 参数

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

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

检索微调作业

GET {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}?api-version=2025-11-15-preview

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

详细了解微调

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
微调任务ID (fine_tuning_job_id)	路径	是的	字符串	微调作业的 ID。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

取消微调作业

POST {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/cancel?api-version=2025-11-15-preview

立即取消微调作业。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
微调任务ID (fine_tuning_job_id)	路径	是的	字符串	要取消的微调作业的 ID。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

列出微调作业检查点

GET {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/checkpoints?api-version=2025-11-15-preview

列出微调作业的检查点。

URI 参数

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

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

列出优化作业事件

GET {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/events?api-version=2025-11-15-preview

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

URI 参数

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

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

暂停微调作业

POST {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/pause?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
微调任务ID (fine_tuning_job_id)	路径	是的	字符串	要暂停的微调作业的 ID。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

恢复微调作业

POST {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/resume?api-version=2025-11-15-preview

恢复暂停的微调作业。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
微调任务ID (fine_tuning_job_id)	路径	是的	字符串	要恢复的微调作业的 ID。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

创建响应 - 创建响应流

POST {endpoint}/openai/responses?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	否	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

姓名	类型	Description	必选	违约
代理	AgentReference	用于生成响应的代理。	否
后台的	布尔	是否在后台运行模型响应。详细了解后台响应。	否	假
对话	字符串或对象		否
包括	数组	指定要包含在模型响应中的其他输出数据。现在支持的值包括： - `code_interpreter_call.outputs`：在代码解释器工具调用项中包含 python 代码执行的输出。 - `computer_call_output.output.image_url`：包括计算机调用输出中的图像 URL。 - `file_search_call.results`：包括文件搜索工具的搜索结果。 - `message.input_image.image_url`：包括输入消息中的图像链接。 - `message.output_text.logprobs`：包括含协助消息的 logprob。 - `reasoning.encrypted_content`：包括推理的加密版本推理项目输出中的令牌。这样就可以在无状态使用响应 API 时，在多轮次对话中使用推理项（例如当参数 `store` 设置为 `false`，或当组织在零数据保留计划中注册时）。	否
输入	字符串或数组	用于生成响应的模型的文本、图像或文件输入。了解详细信息： - 文本输入和输出 - 图像输入 - 文件输入 - 管理聊天状态 - 函数调用	否
instructions	字符串	插入到模型上下文中的系统（或开发人员）消息。当与 `previous_response_id` 一起使用时，先前的响应的指令不会传递到下一个响应。这使得它变得简单在新的响应中交换系统（或开发人员）消息。	否
max_output_tokens	整数	可为响应生成的令牌数上限，包括可见输出令牌和推理令牌。	否
max_tool_calls	整数	响应中可以处理的内置工具的最大调用次数。此最大调用次数适用于所有内置工具调用，而非单个工具的调用。模型对任何工具的后续调用尝试都将被忽略。	否
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
模型	字符串	用于创建此响应的模型部署。	否
并行工具调用	布尔	是否允许模型并行运行工具调用。	否	真实
previous_response_id	字符串	对模型的上一个响应的唯一 ID。用它创建多轮对话。详细了解管理聊天状态。	否
提示	OpenAI.Prompt	对提示模板及其变量的引用。了解详细信息。	否
reasoning	OpenAI.Reasoning	仅适用于 O 系列模型推理模型的配置选项。	否
服务等级	OpenAI.ServiceTier	注意：service_tier不适用于 Azure OpenAI。	否
存储	布尔	是否存储生成的模型响应，以便以后通过某种方式检索应用程序接口。	否	真实
数据流	布尔	如果设置为 true，模型响应数据将流式传输到客户端因为这是使用服务器发送事件生成的。以了解详细信息。	否	假
structured_inputs	对象	可以参与提示模板替换或工具参数绑定的响应的结构化输入。	否
温度	数字	要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性我们通常建议更改此设置或 `top_p`，但不要同时更改两者。	否	1
文本消息	对象	来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。请参阅文本输入和输出和结构化输出	否
└─ 格式	OpenAI.ResponseTextFormatConfiguration		否
tool_choice	OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceObject	模型在生成时应如何选择要使用的工具（或工具）响应。 `tools`请参阅参数，了解如何指定哪些工具模型可以调用。	否
工具	数组	生成响应时，模型可能会调用的工具数组。你可以通过设置 `tool_choice` 参数来指定要使用的工具。可以提供模型的两类工具包括： - 内置工具：OpenAI 提供的工具，用于扩展模型的功能，如文件搜索。 - 函数调用（自定义工具）：由你定义的函数，使模型能够调用自己的代码。	否
top_logprobs	整数	一个介于 0 和 20 之间的整数，指定在每个标记位置最有可能返回的的标记数，每个都有关联的对数概率。	否
top_p	数字	使用温度进行采样的替代方法，称为核采样，其中，模型考虑具有 top_p 概率质量的令牌的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。我们通常建议更改此设置或 `temperature`，但不要同时更改两者。	否	1
truncation	枚举	要用于模型响应的截断策略。 - `auto`：如果此响应和以前的响应上下文超过模型的上下文窗口大小，模型将截断响应以适应上下文窗口，方法是在对话中删除输入项。 - `disabled`（默认值）：如果模型响应将超过上下文窗口模型的大小，请求将失败并出现 400 错误。可能的值： `autodisabled`	否
用户	字符串	详细了解安全最佳做法。	否

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

列出响应

GET {endpoint}/openai/responses?api-version=2025-11-15-preview

返回所有响应的列表。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
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 进行筛选。如果提供，则仅返回与指定会话关联的响应。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

获取响应 - 获取响应流

GET {endpoint}/openai/responses/{response_id}?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	否	字符串	用于此作的 API 版本。
response_id	路径	是的	字符串
include[]	查询	否	数组
数据流	查询	否	布尔
starting_after	查询	否	整数
接受	标头	否	字符串可能的值：`text/event-stream`

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

删除响应

DELETE {endpoint}/openai/responses/{response_id}?api-version=2025-11-15-preview

删除模型响应。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
response_id	路径	是的	字符串	要删除的响应的 ID。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

取消响应

POST {endpoint}/openai/responses/{response_id}/cancel?api-version=2025-11-15-preview

取消模型响应。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
response_id	路径	是的	字符串	要取消的响应的 ID。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

列出输入项

GET {endpoint}/openai/responses/{response_id}/input_items?api-version=2025-11-15-preview

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

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
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，以便提取列表中的上一页内容。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

Redteams - 列表

GET {endpoint}/redTeams/runs?api-version=2025-11-15-preview

按名称列出 redteam。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
x-ms-client-request-id	标头	否		请求的不透明、全局唯一的客户端生成的字符串标识符。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

红队 - 获取

GET {endpoint}/redTeams/runs/{name}?api-version=2025-11-15-preview

按名称获取 redteam。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
姓名	路径	是的	字符串	红队运行的标识符。
x-ms-client-request-id	标头	否		请求的不透明、全局唯一的客户端生成的字符串标识符。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

红队 - 创建

POST {endpoint}/redTeams/runs:run?api-version=2025-11-15-preview

创建 redteam 运行。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

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

Responses

状态代码： 201

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

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

状态代码：默认值

说明：意外的错误响应。

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

计划 - 列表

GET {endpoint}/schedules?api-version=2025-11-15-preview

列出所有时间表。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
x-ms-client-request-id	标头	否		请求的不透明、全局唯一的客户端生成的字符串标识符。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

计划 - 删除

DELETE {endpoint}/schedules/{id}?api-version=2025-11-15-preview

删除计划。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
id	路径	是的	字符串	计划的标识符。
x-ms-client-request-id	标头	否		请求的不透明、全局唯一的客户端生成的字符串标识符。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码： 204

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

状态代码：默认值

说明：意外的错误响应。

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

计划 - 获取

GET {endpoint}/schedules/{id}?api-version=2025-11-15-preview

通过 id 获取时间表。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
id	路径	是的	字符串	计划的标识符。
x-ms-client-request-id	标头	否		请求的不透明、全局唯一的客户端生成的字符串标识符。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

计划 - 创建或更新

PUT {endpoint}/schedules/{id}?api-version=2025-11-15-preview

按 id 创建或更新计划。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
id	路径	是的	字符串	计划的标识符。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

请求主体

“内容类型”: application/json

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

Responses

状态代码：200

说明：请求已成功。

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

状态代码： 201

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

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

状态代码：默认值

说明：意外的错误响应。

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

计划 - 列表运行

GET {endpoint}/schedules/{id}/runs?api-version=2025-11-15-preview

列出所有计划运行。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
id	路径	是的	字符串	计划的标识符。
x-ms-client-request-id	标头	否		请求的不透明、全局唯一的客户端生成的字符串标识符。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

计划 - 获取运行

GET {endpoint}/schedules/{scheduleId}/runs/{runId}?api-version=2025-11-15-preview

获取按 id 运行的计划。

URI 参数

姓名	In	必选	类型	Description
终结点	路径	是的	字符串 url	Foundry Project 终结点的窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}`。如果 Foundry Hub 中只有一个项目，或者要以中心中的默认项目为目标，请使用窗体 `https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project`
API版本 (api-version)	查询	是的	字符串	用于此作的 API 版本。
scheduleId	路径	是的	字符串	计划的标识符。
runId	路径	是的	字符串	计划运行的标识符。

请求标头

姓名	必选	类型	Description
Authorization	真实	字符串	例：`Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://ai.azure.com/` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://ai.azure.com/.default`

Responses

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

Components

A2ATool

实现 A2A 协议的代理。

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

AISearchIndexResource

AI 搜索索引资源。

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

AgentClusterInsightResult

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

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

AgentClusterInsightsRequest

对代理评估结果集的见解

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

AgentContainerObject

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

姓名	类型	Description	必选
创建时间	字符串	容器的创建时间。	是的
error_message	字符串	如果容器无法运行，则返回错误消息（如果有）。	否
max_replicas	整数	容器的最大副本数。默认值为 1。	否
min_replicas	整数	容器的最小副本数。默认值为 1。	否
对象	枚举	对象类型，始终为“agent.container”。可能的值：`agent.container`	是的
状态	对象	特定代理版本的容器的状态。	是的
updated_at	字符串	容器的上次更新时间。	是的

AgentContainerOperationError

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

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

AgentContainerOperationObject

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

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

AgentContainerOperationStatus

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

资产	价值
说明	特定版本的代理的容器作的状态。
类型	字符串
价值观	`NotStarted` `InProgress` `Succeeded` `Failed`

AgentContainerStatus

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

资产	价值
说明	特定代理版本的容器的状态。
类型	字符串
价值观	`Starting` `Running` `Stopping` `Stopped` `Failed` `Deleting` `Deleted` `Updating`

AgentDefinition

AgentDefinition 的鉴别器

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

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

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

AgentId

姓名	类型	Description	必选
姓名	字符串	代理的名称。	是的
类型	枚举	可能的值：`agent_id`	是的
版本	字符串	代理的版本标识符。	是的

AgentKind

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

AgentObject

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

AgentProtocol

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

代理参考

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

AgentTaxonomyInput

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

姓名	类型	Description	必选
riskCategories	数组	要评估的风险类别列表。	是的
目标	对象	表示指定 Azure AI 代理的目标。	是的
└─ 名称	字符串	Azure AI 代理的唯一标识符。	否
tool_descriptions	数组	用于控制文本生成期间代理的采样行为的参数。	否
└─ 类型	枚举	目标的类型，始终 `azure_ai_agent`。可能的值：`azure_ai_agent`	否
└─ 版本	字符串	Azure AI 代理的版本。	否
类型	枚举	评估分类的输入类型。可能的值：`agent`	是的

AgentTaxonomyInputUpdate

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

姓名	类型	Description	必选
riskCategories	数组	要评估的风险类别列表。	否
目标	对象	表示指定 Azure AI 代理的目标。	否
└─ 名称	字符串	Azure AI 代理的唯一标识符。	否
tool_descriptions	数组	用于控制文本生成期间代理的采样行为的参数。	否
└─ 类型	枚举	目标的类型，始终 `azure_ai_agent`。可能的值：`azure_ai_agent`	否
└─ 版本	字符串	Azure AI 代理的版本。	否
类型	枚举	评估分类的输入类型。可能的值：`agent`	否

AgentVersionObject

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

AgenticIdentityCredentials

代理身份凭证定义

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

ApiErrorResponse

API 故障的错误响应。

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

ApiKeyCredentials

API Key 凭证定义

姓名	类型	Description	必选	违约
关键值	字符串	API 密钥	否
类型	枚举	凭据类型可能的值：`ApiKey`	是的

AssetCredentialResponse

表示对 blob 的引用以供使用

姓名	类型	Description	必选
blobReference	对象	Blob 引用详细信息。	是的
~~ blobUri	字符串	用于上传数据的客户端的 Blob URI 路径。示例： `https://blob.windows.core.net/Container/Path`	否
~~ 凭据	SasCredential	用于访问存储帐户的凭据信息。	否
~~ storageAccountArmId	字符串	要使用的存储帐户的 ARM ID。	否

AssetId

已保存资产的标识符。

类型：string

AttackStrategy

攻击策略。

资产	价值
说明	攻击策略。
类型	字符串
价值观	`easy` `moderate` `difficult` `ascii_art` `ascii_smuggler` `atbash` `base64` `binary` `caesar` `character_space` `jailbreak` `ansii_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	数组	导致此报告错误的特定错误的详细信息数组。	否
innererror	对象	包含有关错误的更具体信息的对象。根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。	否
└─ 代码	字符串	服务器定义的错误代码集之一。	否
~~ innererror	Azure.Core.Foundations.InnerError	内部错误。	否
消息	字符串	有关错误的可读的表示形式。	是的
目标	字符串	错误的目标。	否

Azure.Core.Foundations.ErrorResponse

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

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

Azure.Core.Foundations.InnerError

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

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

Azure.Core.Foundations.OperationState

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

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

Azure.Core.uuid

通用唯一标识符

类型：string

格式：uuid

AzureAIAgentTarget

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

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

AzureAIAgentTargetUpdate

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

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

AzureAIAssistantTarget

表示指定 Azure AI 助手（代理 V1）终结点的目标，包括其 ID。

姓名	类型	Description	必选
id	字符串	Azure AI 助手的唯一标识符。	否
tool_descriptions	数组	助手可用的工具的说明。	是的
类型	枚举	目标的类型，始终 `azure_ai_assistant`。可能的值：`azure_ai_assistant`	是的

AzureAIAssistantTargetUpdate

表示指定 Azure AI 助手（代理 V1）终结点的目标，包括其 ID。

姓名	类型	Description	必选
id	字符串	Azure AI 助手的唯一标识符。	否
tool_descriptions	数组	助手可用的工具的说明。	否
类型	枚举	目标的类型，始终 `azure_ai_assistant`。可能的值：`azure_ai_assistant`	否

AzureAIEvaluator

用于铸造评估程序的 Azure AI 计算器定义。

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

AzureAIModelTarget

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

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

AzureAIModelTargetUpdate

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

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

AzureAIRedTeam

姓名	类型	Description	必选
item_generation_params	对象	表示用于生成红色团队项的参数。	是的
attack_strategies	数组	要使用的攻击策略的集合。	否
num_turns	整数	游戏中允许的轮次数。	否
└─ 类型	枚举	项生成参数的类型，始终 `red_team`为。可能的值：`red_team`	否
目标	对象	具有鉴别器支持的目标的基类。	是的
└─ 类型	字符串	目标的类型。	否
类型	枚举	数据源的类型。始终为 `azure_ai_red_team`。可能的值：`azure_ai_red_team`	是的

AzureAIResponses

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

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

AzureAISearchAgentTool

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

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

Azure人工智能搜索索引

Azure AI 搜索索引定义

姓名	类型	Description	必选	违约
类型	枚举	索引类型可能的值：`AzureSearch`	是的

AzureAISearchIndexUpdate

Azure AI 搜索索引定义

姓名	类型	Description	必选	违约
类型	枚举	索引类型可能的值：`AzureSearch`	是的

AzureAISearchQueryType

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

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

AzureAISearchToolResource

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

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

AzureAISource

姓名	类型	Description	必选	违约
方案	枚举	数据架构方案。可能的值：`red_team`、、 `responsestraces`	是的
类型	枚举	始终为 `label_model` 的对象类型。可能的值：`azure_ai_source`	是的

AzureFunctionAgentTool

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

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

AzureFunctionBinding

用于保留存储队列名称和 URI 的结构。

姓名	类型	Description	必选
storage_queue	对象	用于保留存储队列名称和 URI 的结构。	是的
queue_name	字符串	Azure 函数存储队列的名称。	否
queue_service_endpoint	字符串	Azure 存储队列服务的 URI，允许你作队列。	否
类型	枚举	绑定的类型，始终为“storage_queue”。可能的值：`storage_queue`	是的

AzureFunctionDefinition

Azure 函数的定义。

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

AzureFunctionStorageQueue

用于保留存储队列名称和 URI 的结构。

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

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`	AgenticIdentityCredentials

姓名	类型	Description	必选	违约
类型	对象	连接使用的凭证类型	是的

BingCustomSearchAgentTool

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

姓名	类型	Description	必选
bing_custom_search_preview	对象	必应自定义搜索工具参数。	是的
search_configurations	数组	附加到此工具的项目连接。最多可以有 1 个连接附加到该工具的资源。	否
类型	枚举	对象类型，始终为“bing_custom_search”。可能的值：`bing_custom_search_preview`	是的

BingCustomSearchConfiguration

必应自定义搜索配置。

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

BingCustomSearchToolParameters

必应自定义搜索工具参数。

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

BingGroundingAgentTool

用于配置代理的必应地面搜索工具的输入定义信息。

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

BingGroundingSearchConfiguration

搜索 Bing Grounding 的配置

姓名	类型	Description	必选
计数	整数	要在 bing api 响应中返回的搜索结果数	否
freshness	字符串	按特定时间范围筛选搜索结果。在此处查看可接受的值。	否
市场	字符串	结果来源的市场。	否
project_connection_id	字符串	使用必应搜索接地的项目连接 ID	是的
set_lang	字符串	调用 Bing API 时用于用户界面字符串的语言。	否

BingGroundingSearchToolParameters

bing 接地搜索工具参数。

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

BlobReference

Blob 引用详细信息。

姓名	类型	Description	必选
blobUri	字符串	用于上传数据的客户端的 Blob URI 路径。示例： `https://blob.windows.core.net/Container/Path`	是的
凭据	对象	SAS 凭证定义	是的
~~ sasUri	字符串	SAS URI	否
└─ 类型	枚举	凭证类型可能的值：`SAS`	否
storageAccountArmId	字符串	要使用的存储帐户的 ARM ID。	是的

BrowserAutomationAgentTool

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

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

BrowserAutomationToolConnectionParameters

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

姓名	类型	Description	必选	违约
project_connection_id	字符串	与 Azure Playwright 资源的项目连接的 ID。	是的

BrowserAutomationToolParameters

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

姓名	类型	Description	必选	违约
连接	对象	定义浏览器自动化工具使用的连接的输入参数。	是的
project_connection_id	字符串	与 Azure Playwright 资源的项目连接的 ID。	否

CaptureStructuredOutputsTool

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

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

ChartCoordinate

分析图表的坐标。

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

ChatSummaryMemoryItem

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

姓名	类型	Description	必选	违约
kind	枚举	记忆项目的种类。可能的值：`chat_summary`	是的

ClusterInsightResult

来自聚类分析的见解。

姓名	类型	Description	必选
clusters	数组	见解中标识的群集列表。	是的
坐标	对象	可选地将 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>` 坐标仅适用于客户端可视化效果，不用于修改规范见解结果。	否
摘要	对象	误差聚类分析的摘要。	是的
~~ 方法	字符串	用于聚类的方法。	否
~~ sampleCount	整数	分析的样本总数。	否
~~ uniqueClusterCount	整数	唯一集群的总数。	否
~~ uniqueSubclusterCount	整数	唯一子集群标签的总数。	否
└─ 用法	ClusterTokenUsage	执行聚类分析时的令牌使用情况	否

ClusterTokenUsage

集群分析的令牌使用情况

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

CodeBasedEvaluatorDefinition

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

姓名	类型	Description	必选	违约
code_text	字符串	评估器的内联代码文本	是的
类型	枚举	可能的值：`code`	是的

连接

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

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

连接类型

连接的类型（或类别）

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

ContainerAppAgentDefinition

容器应用代理定义。

姓名	类型	Description	必选
container_app_resource_id	字符串	托管此代理的 Azure 容器应用的资源 ID。不可跨版本更改。	是的
container_protocol_versions	数组	代理支持容器入口通信的协议。	是的
ingress_subdomain_suffix	字符串	向代理发送入口时应用于应用子域的后缀。这可以是标签（例如，“---current”）、特定修订版（例如，“--0000001”），也可以是空的，以使用容器应用的默认终结点。	是的
kind	枚举	可能的值：`container_app`	是的

ContinuousEvalItemGenerationParams

表示连续评估项生成的参数。

姓名	类型	Description	必选
data_mapping	对象	从源字段映射到response_id字段，检索聊天历史记录所必需的。	是的
max_num_turns	整数	要评估的聊天历史记录的最大轮次数。	是的
源	对象		是的
└─ 内容	数组	jsonl 文件的内容。	否
└─ 身份	字符串	文件的标识符。	否
└─ 类型	枚举	jsonl 源的类型。始终为 `file_id`。可能的值：`file_id`	否
类型	枚举	项生成参数的类型，始终 `ResponseRetrieval`为。可能的值：`response_retrieval`	是的

ContinuousEvaluationRuleAction

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

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

CosmosDB索引

CosmosDB 矢量存储索引定义

姓名	类型	Description	必选	违约
类型	枚举	索引类型可能的值：`CosmosDBNoSqlVectorStore`	是的

CosmosDBIndexUpdate

CosmosDB 矢量存储索引定义

姓名	类型	Description	必选	违约
类型	枚举	索引类型可能的值：`CosmosDBNoSqlVectorStore`	是的

CreateAgentFromManifestRequest

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

CreateAgentRequest

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

CreateAgentVersionFromManifestRequest

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

CreateAgentVersionRequest

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

创建评估请求

姓名	类型	Description	必选
数据源配置	对象	一个 CustomDataSourceConfig 对象，用于定义用于评估运行的数据源的架构。此架构用于定义将要处理的数据的结构： - 用于定义测试条件和 - 创建运行时需要哪些数据	是的
包含示例架构	布尔	评估是否应期望由你填充示例命名空间（即通过从数据源生成响应）	否
条目模式	对象	数据源中每一行的 json 架构。	否
└─ 元数据	对象	存储的补全数据源的元数据筛选器。	否
~~ 方案	枚举	数据架构方案。可能的值：`red_team`、、 `responsestraces`	否
└─ 类型	枚举	始终为 `label_model` 的对象类型。可能的值：`azure_ai_source`	否
元数据	OpenAI.Metadata	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
姓名	字符串	评估的名称。	否
属性	对象	一组不可变的 16 键值对，这些键值对可以附加到对象以存储其他信息。键是最大长度为 64 个字符的字符串。值为最大长度为 512 个字符的字符串。	否
测试标准	数组	此组中所有评估运行的评分程序列表。评分器可以使用双花括号符号引用数据源中的变量，例如 `{{item.variable_name}}`。若要引用模型的输出，请使用 `sample` 命名空间（即 `{{sample.output_text}}`）。	是的

创建评估运行请求

姓名	类型	Description	必选
数据源	对象	一个 JsonlRunDataSource 对象，该对象指定与 eval 匹配的 JSONL 文件	是的
输入消息	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate 或 OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference	从模型采样时使用。指示传递到模型的消息的结构。可以是对预生成轨迹（即）的引用， `item.input_trajectory`也可以是具有对命名空间的变量引用的 `item` 模板。	否
item_generation_params	RedTeamItemGenerationParams	项生成的参数。	否
└─ 模型	字符串	用于生成补全的模型的名称（例如“o3-mini”）。	否
采样参数 (sampling_params)	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		否
└─ 来源	OpenAI.EvalJsonlFileContentSource 或 OpenAI.EvalJsonlFileIdSource 或 OpenAI.EvalResponsesSource	确定在此运行的数据源中填充 `item` 命名空间的内容。	否
~~ 目标	目标	评估的目标配置。	否
└─ 类型	字符串	数据源类型鉴别器。	否
元数据	OpenAI.Metadata	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
姓名	字符串	运行的名称。	否
属性	对象	一组不可变的 16 键值对，这些键值对可以附加到对象以存储其他信息。键是最大长度为 64 个字符的字符串。值为最大长度为 512 个字符的字符串。	否

CreatedBy

姓名	类型	Description	必选
代理	对象		否
└─ 名称	字符串	代理的名称。	否
└─ 类型	枚举	可能的值：`agent_id`	否
└─ 版本	字符串	代理的版本标识符。	否
response_id	字符串	创建项的响应。	否

CredentialType

连接使用的凭证类型

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

CronTrigger

基于 Cron 的触发器。

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

CustomCredential

自定义凭证定义

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

DailyRecurrenceSchedule

每日重复计划。

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

DatasetType

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

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

DatasetVersion

DatasetVersion 定义

DatasetVersion 的鉴别器

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

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

姓名	类型	Description	必选
connectionName （连接名称）	字符串	Azure 存储帐户连接名称。如果在创建 Dataset 之前未调用 startPendingUploadVersion，则为必需	否
dataUri	字符串	数据的 URI（示例）	是的
id	字符串	资产 ID，资产的唯一标识符	否
isReference	布尔	指示数据集是保存对存储的引用，还是数据集管理存储本身。如果为 true，则删除数据集版本时不会删除基础数据	否
姓名	字符串	资源的名称	是的
类型	对象	用于确定数据类型的枚举。	是的
版本	字符串	资源的版本	是的

DatasetVersionUpdate

DatasetVersion 定义

DatasetVersionUpdate 的鉴别器

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

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

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

星期几

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

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

DeleteAgentResponse

已删除的代理对象

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

DeleteAgentVersionResponse

已删除的代理版本对象

姓名	类型	Description	必选
已删除	布尔	代理是否已成功删除。	是的
姓名	字符串	代理的名称。	是的
对象	枚举	对象类型。始终为“agent.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	必选	违约
姓名	字符串	部署的名称	是的
类型	对象		是的

DeploymentType

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

EntraIDCredentials

Entra ID 凭证定义

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

Eval

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

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

姓名	类型	Description	必选
创建时间	对象		是的
created_by	字符串	创建运行的人员的名称。	否
数据源配置	对象	一个 CustomDataSourceConfig 对象，用于定义用于评估运行的数据源的架构。此架构用于定义将要处理的数据的结构： - 用于定义测试条件和 - 创建运行时需要哪些数据	是的
包含示例架构	布尔	评估是否应期望由你填充示例命名空间（即通过从数据源生成响应）	否
条目模式	对象	数据源中每一行的 json 架构。	否
└─ 元数据	对象	存储的补全数据源的元数据筛选器。	否
~~ 方案	枚举	数据架构方案。可能的值：`red_team`、、 `responsestraces`	否
└─ 类型	枚举	始终为 `label_model` 的对象类型。可能的值：`azure_ai_source`	否
id	字符串	评估的唯一标识符。	是的
元数据	OpenAI.Metadata	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	是的
modified_at	对象		否
姓名	字符串	评估的名称。	是的
对象	枚举	对象类型。可能的值：`eval`	是的
属性	对象	一组不可变的 16 键值对，这些键值对可以附加到对象以存储其他信息。键是最大长度为 64 个字符的字符串。值为最大长度为 512 个字符的字符串。	否
测试标准	数组	测试条件列表。	是的

EvalCompareReport

评估比较的见解。

姓名	类型	Description	必选
比较	数组	每次治疗运行与基线的比较结果。	是的
方法	字符串	用于比较的统计方法。	是的
类型	枚举	见解结果的类型。可能的值：`EvaluationComparison`	是的

EvalResult

评估结果。

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

EvalRun

表示评估运行的架构。

姓名	类型	Description	必选
创建时间	对象		是的
created_by	字符串	创建运行的人员的名称。	否
数据源	对象	一个 JsonlRunDataSource 对象，该对象指定与 eval 匹配的 JSONL 文件	是的
输入消息	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate 或 OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference	从模型采样时使用。指示传递到模型的消息的结构。可以是对预生成轨迹（即）的引用， `item.input_trajectory`也可以是具有对命名空间的变量引用的 `item` 模板。	否
item_generation_params	RedTeamItemGenerationParams	项生成的参数。	否
└─ 模型	字符串	用于生成补全的模型的名称（例如“o3-mini”）。	否
采样参数 (sampling_params)	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		否
└─ 来源	OpenAI.EvalJsonlFileContentSource 或 OpenAI.EvalJsonlFileIdSource 或 OpenAI.EvalResponsesSource	确定在此运行的数据源中填充 `item` 命名空间的内容。	否
~~ 目标	目标	评估的目标配置。	否
└─ 类型	字符串	数据源类型鉴别器。	否
错误	OpenAI.EvalApiError	一个对象，表示来自 Eval API 的错误响应。	是的
eval_id	字符串	关联的评估的标识符。	是的
id	字符串	评估运行的唯一标识符。	是的
元数据	OpenAI.Metadata	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	是的
模型	字符串	评估的模型（如果适用）。	是的
modified_at	对象		否
姓名	字符串	评估运行的名称。	是的
对象	枚举	对象的类型。始终为“eval.run”。可能的值：`eval.run`	是的
每模型使用量	数组	评估运行期间每个模型的使用情况统计信息。	是的
per_testing_criteria_results	数组	评估运行期间应用的每个测试条件的结果。	是的
属性	对象	一组不可变的 16 键值对，这些键值对可以附加到对象以存储其他信息。键是最大长度为 64 个字符的字符串。值为最大长度为 512 个字符的字符串。	否
report_url	字符串	UI 仪表板上呈现的评估运行报告的 URL。	是的
result_counts	对象		是的
└─ 发生错误	OpenAI.integer		否
~~ 失败	OpenAI.integer		否
└─ 通过	OpenAI.integer		否
~~ 总计	OpenAI.integer		否
状态	字符串	评估运行的状态。	是的

EvalRunDataSource

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

EvalRunDataSource 的鉴别器

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

类型值	Schema
`azure_ai_traces`	TracesEvalRunDataSource
`azure_ai_responses`	AzureAIResponses
`azure_ai_target_completions`	TargetCompletions

姓名	类型	Description	必选	违约
类型	字符串	数据源类型鉴别器。	是的

EvalRunOutputItem

表示评估运行输出项的架构。

姓名	类型	Description	必选
创建时间	对象		是的
数据源项	对象	输入数据源项的详细信息。	是的
数据源_项目_ID	对象		是的
eval_id	字符串	评估组的标识符。	是的
id	字符串	评估运行输出项的唯一标识符。	是的
对象	枚举	对象的类型。始终为“eval.run.output_item”。可能的值：`eval.run.output_item`	是的
results	数组	此输出项的分级程序结果列表。	是的
run_id	字符串	与此输出项关联的评估运行的标识符。	是的
示例	对象		是的
~~ 错误	OpenAI.EvalApiError	一个对象，表示来自 Eval API 的错误响应。	否
finish_reason	字符串		否
└─ 输入	数组		否
max_completion_tokens（最大完成标记数）	OpenAI.integer		否
└─ 模型	字符串		否
└─ 输出	数组		否
~~ 种子	OpenAI.integer		否
~~ 温度	OpenAI.numeric		否
top_p	OpenAI.numeric		否
└─ 用法	OpenAI.EvalRunOutputItemSampleUsage		否
状态	字符串	评估运行的状态。	是的

EvalRunOutputItemResult

评估运行输出项的单个评分器结果。

姓名	类型	Description	必选
标签	字符串	与测试条件指标（例如“pass”、“fail”、“good”、“bad”）关联的标签。	否
指标	字符串	指标的名称（例如“fluency”、“f1_score”）。	否
姓名	字符串	评分程序的名称。	是的
通过	布尔	评分员是否将输出视为一个通行证。	是的
属性	对象	有关测试条件指标的其他详细信息。	否
原因	字符串	测试条件指标的原因。	否
示例	对象	评分者生成的可选示例或中间数据。	否
分数	对象		是的
阈值	数字	用于确定此测试条件的通过/失败的阈值（如果为数值）。	否
类型	字符串	评分程序类型（例如，“string-check-grader”）。	否

EvalRunResultCompareItem

治疗与基线的指标比较。

姓名	类型	Description	必选
deltaEstimate	数字	治疗与基线之间的估计差异。	是的
pValue	数字	治疗效果的 P 值。	是的
treatmentEffect	对象	治疗效果类型。	是的
treatmentRunId	字符串	治疗运行 ID。	是的
treatmentRunSummary	对象	评估运行中指标的汇总统计信息。	是的
~~ 平均值	数字	评估运行中指标的平均值。	否
~~ runId	字符串	评估运行 ID。	否
~~ sampleCount	整数	评估运行中的样本数。	否
~~ standardDeviation	数字	评估运行中指标的标准差。	否

EvalRunResultComparison

治疗运行与基线的比较结果。

姓名	类型	Description	必选
baselineRunSummary	对象	评估运行中指标的汇总统计信息。	是的
~~ 平均值	数字	评估运行中指标的平均值。	否
~~ runId	字符串	评估运行 ID。	否
~~ sampleCount	整数	评估运行中的样本数。	否
~~ standardDeviation	数字	评估运行中指标的标准差。	否
compareItems	数组	每次治疗运行的比较结果列表。	是的
计算器	字符串	此测试标准的评估者名称。	是的
指标	字符串	正在评估的指标。	是的
testingCriteria	字符串	测试标准的名称。	是的

EvalRunResultSummary

评估运行中指标的汇总统计信息。

姓名	类型	Description	必选
平均	数字	评估运行中指标的平均值。	是的
runId	字符串	评估运行 ID。	是的
sampleCount	整数	评估运行中的样本数。	是的
standardDeviation	数字	评估运行中指标的标准差。	是的

EvaluationComparisonRequest

评估比较请求

姓名	类型	Description	必选
baselineRunId	字符串	用于比较的基线运行 ID。	是的
evalId	字符串	评估的标识符。	是的
treatmentRunIds	数组	用于比较的治疗运行 ID 列表。	是的
类型	枚举	请求的类型。可能的值：`EvaluationComparison`	是的

EvaluationResultSample

评估结果中的示例。

姓名	类型	Description	必选
evaluationResult	对象	评估结果。	是的
└─ 名称	字符串	支票名称	否
└─ 通过	布尔	指示检查是通过还是失败	否
~~ 分数	数字	分数	否
└─ 类型	字符串	检查类型	否
类型	枚举	评估结果样本类型可能的值：`EvaluationResultSample`	是的

评估规则

评估规则模型。

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

EvaluationRuleAction

评估行动模型。

EvaluationRuleAction 的鉴别器

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

类型值	Schema
`continuousEvaluation`	ContinuousEvaluationRuleAction
`humanEvaluation`	HumanEvaluationRuleAction

姓名	类型	Description	必选	违约
类型	对象	评估作的类型。	是的

EvaluationRuleActionType

评估作的类型。

资产	价值
说明	评估作的类型。
类型	字符串
价值观	`continuousEvaluation` `humanEvaluation`

EvaluationRuleEventType

评估规则事件的类型。

资产	价值
说明	评估规则事件的类型。
类型	字符串
价值观	`responseCompleted` `manual`

EvaluationRuleFilter

评估筛选器模型。

姓名	类型	Description	必选	违约
agentName （代理名称）	字符串	按代理名称筛选。	是的

EvaluationRunClusterInsightResult

来自评估运行集群分析的见解。

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

EvaluationRunClusterInsightsRequest

对一组评估结果的见解

姓名	类型	Description	必选
evalId	字符串	见解的评估 ID。	是的
modelConfiguration	对象	见解生成中使用的模型的配置。	否
~~ modelDeploymentName	字符串	要评估的模型部署。单独接受部署名称或连接名称为 `{connectionName}/<modelDeploymentName>`.	否
runIds	数组	见解的评估运行 ID 列表。	是的
类型	枚举	见解请求的类型。可能的值：`EvaluationRunClusterInsight`	是的

EvaluationScheduleTask

计划的评估任务。

姓名	类型	Description	必选
evalId	字符串	评估组的标识符。	是的
evalRun	对象	评估运行有效负载。	是的
类型	枚举	可能的值：`Evaluation`	是的

EvaluationTaxonomy

评估分类定义

姓名	类型	Description	必选
id	字符串	资产 ID，资产的唯一标识符	否
姓名	字符串	资源的名称	是的
属性	对象	评估分类的其他属性。	否
taxonomyCategories	数组	分类类别列表。	否
taxonomyInput	对象	评估分类的输入配置。	是的
└─ 类型	EvaluationTaxonomyInputType	评估分类的输入类型。	否
版本	字符串	资源的版本	是的

EvaluationTaxonomyCreateOrUpdate

评估分类定义

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

EvaluationTaxonomyInput

评估分类的输入配置。

EvaluationTaxonomyInput 的鉴别器

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

类型值	Schema
`agent`	AgentTaxonomyInput

姓名	类型	Description	必选	违约
类型	对象	评估分类输入的类型。	是的

EvaluationTaxonomyInputType

评估分类输入的类型。

资产	价值
说明	评估分类输入的类型。
类型	字符串
价值观	`agent` `policy`

EvaluationTaxonomyInputUpdate

评估分类的输入配置。

EvaluationTaxonomyInputUpdate 的鉴别器

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

类型值	Schema
`agent`	AgentTaxonomyInputUpdate

姓名	类型	Description	必选	违约
类型	对象	评估分类输入的类型。	是的

EvaluationTaxonomyUpdate

评估分类定义

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

评估器定义的类型

资产	价值
说明	评估器定义的类型
类型	字符串
价值观	`prompt` `code` `prompt_and_code` `service` `openai_graders`

EvaluatorMetric

评估器指标

姓名	类型	Description	必选
desirable_direction	对象	指标的方向指示值越高越好、值越低越好还是中性	否
is_primary	布尔	指示在有多个指标时此指标是否为主要指标。	否
max_value	数字	指标的最大值。如果未指定，则假定它是无界的。	否
min_value	数字	指标的最小值	否
类型	对象	评估器的类型	否

EvaluatorMetricDirection

指标的方向指示值越高越好、值越低越好还是中性

资产	价值
说明	指标的方向指示值越高越好、值越低越好还是中性
类型	字符串
价值观	`increase` `decrease` `neutral`

EvaluatorMetricType

评估器的类型

资产	价值
说明	评估器的类型
类型	字符串
价值观	`ordinal` `continuous` `boolean`

EvaluatorType

评估器的类型

资产	价值
说明	评估器的类型
类型	字符串
价值观	`builtin` `custom`

EvaluatorVersion

评估器定义

姓名	类型	Description	必选
categories	数组	评估者的类别	是的
创建时间	整数	评估器的创建日期/时间	是的
created_by	字符串	评估器的创建者	是的
定义	对象	使用鉴别器的基本评估器配置	是的
data_schema		评估者输入数据的 JSON 架构（草案 2020-12）。这包括类型、属性、必需等参数。	否
init_parameters		评估器输入参数的 JSON 架构（草案 2020-12）。这包括类型、属性、必需等参数。	否
~~ 指标	对象	此评估器生成的输出指标列表	否
└─ 类型	EvaluatorDefinitionType	评估器定义的类型	否
display_name	字符串	评估器的显示名称。这有助于在 Foundry 中轻松查找计算器。它不需要是唯一的。	否
evaluator_type	对象	评估器的类型	是的
id	字符串	资产 ID，资产的唯一标识符	否
元数据	对象	有关评估者的元数据	否
modified_at	整数	评估员的最后修改日期/时间	是的
姓名	字符串	资源的名称	是的
版本	字符串	资源的版本	是的

EvaluatorVersionCreate

评估器定义

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

EvaluatorVersionUpdate

评估器定义

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

FabricDataAgentToolParameters

Fabric 数据代理工具参数。

姓名	类型	Description	必选	违约
project_connections	数组	附加到此工具的项目连接。最多可以有 1 个连接附加到该工具的资源。	否

FileDatasetVersion

FileDatasetVersion 定义

姓名	类型	Description	必选	违约
类型	枚举	数据集类型可能的值：`uri_file`	是的

FileDatasetVersionUpdate

FileDatasetVersion 定义

姓名	类型	Description	必选	违约
类型	枚举	数据集类型可能的值：`uri_file`	是的

FolderDatasetVersion

FileDatasetVersion 定义

姓名	类型	Description	必选	违约
类型	枚举	数据集类型可能的值：`uri_folder`	是的

FolderDatasetVersionUpdate

FileDatasetVersion 定义

姓名	类型	Description	必选	违约
类型	枚举	数据集类型可能的值：`uri_folder`	是的

HostedAgentDefinition

托管代理定义。

HostedAgentDefinition 的鉴别器

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

类型值	Schema
`hosted`	ImageBasedHostedAgentDefinition

姓名	类型	Description	必选
container_protocol_versions	数组	代理支持容器入口通信的协议。	是的
中央处理器	字符串	托管代理的 CPU 配置。	是的
environment_variables	对象	要在托管代理容器中设置的环境变量。	否
kind	枚举	可能的值：`hosted`	是的
内存	字符串	托管代理的内存配置。	是的
工具	数组	托管代理的模型在生成响应时可能调用的一系列工具。你可以通过设置 `tool_choice` 参数来指定要使用的工具。	否

HourlyRecurrenceSchedule

每小时重复计划。

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

HumanEvaluationRuleAction

用于人工评估的评估规则作。

姓名	类型	Description	必选	违约
模板ID	对象	已保存资产的标识符。	是的
类型	枚举	可能的值：`humanEvaluation`	是的

ImageBasedHostedAgentDefinition

托管代理的基于映像的部署定义。

姓名	类型	Description	必选	违约
图像	字符串	托管代理的映像。	是的
kind	枚举	可能的值：`hosted`	是的

Index

索引资源定义

索引的鉴别器

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

类型值	Schema
`AzureSearch`	AzureAISearchIndex
`ManagedAzureSearch`	ManagedAzureAISearchIndex
`CosmosDBNoSqlVectorStore`	CosmosDBIndex

姓名	类型	Description	必选
id	字符串	资产 ID，资产的唯一标识符	否
姓名	字符串	资源的名称	是的
类型	对象		是的
版本	字符串	资源的版本	是的

IndexType

资产	价值
类型	字符串
价值观	`AzureSearch` `CosmosDBNoSqlVectorStore` `ManagedAzureSearch`

IndexUpdate

索引资源定义

IndexUpdate 的鉴别器

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

类型值	Schema
`AzureSearch`	AzureAISearchIndexUpdate
`ManagedAzureSearch`	ManagedAzureAISearchIndexUpdate
`CosmosDBNoSqlVectorStore`	CosmosDBIndexUpdate

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

洞察力

集群见解的响应正文。

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

InsightCluster

分析样本集群。

姓名	类型	Description	必选
说明	字符串	分析聚类的描述。	是的
id	字符串	分析聚类的 ID。	是的
标签	字符串	集群的标签	是的
样品	数组	属于此群集的样本列表。如果样本是子聚类的一部分，则为空。	否
subClusters	数组	此集群中的子集群列表。如果不存在子集群，则为空。	否
建议	字符串	对集群的建议	是的
suggestionTitle	字符串	集群建议的标题	是的
weight	整数	分析聚类的权重。这表示聚类中的样本数。	是的

InsightModelConfiguration

见解生成中使用的模型的配置。

姓名	类型	Description	必选	违约
modelDeploymentName	字符串	要评估的模型部署。单独接受部署名称或连接名称为 `{connectionName}/<modelDeploymentName>`.	是的

InsightRequest

见解报告的请求。

InsightRequest 的鉴别器

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

类型值	Schema
`EvaluationRunClusterInsight`	EvaluationRunClusterInsightsRequest
`AgentClusterInsight`	AgentClusterInsightsRequest
`EvaluationComparison`	EvaluationComparisonRequest

姓名	类型	Description	必选	违约
类型	对象	见解的请求。	是的

InsightResult

洞察的结果。

InsightResult 的鉴别器

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

类型值	Schema
`EvaluationComparison`	EvalCompareReport
`EvaluationRunClusterInsight`	EvaluationRunClusterInsightResult
`AgentClusterInsight`	AgentClusterInsightResult

姓名	类型	Description	必选	违约
类型	对象	见解的请求。	是的

InsightSample

分析中的样本。

InsightSample 的鉴别器

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

类型值	Schema
`EvaluationResultSample`	EvaluationResultSample

姓名	类型	Description	必选
correlationInfo	对象	有关分析样本相关性的信息。	是的
features	对象	有助于在 UX 中对数据进行额外过滤的功能。	是的
id	字符串	分析样本的唯一标识符。	是的
类型	对象	分析中使用的样品类型。	是的

InsightScheduleTask

计划的见解任务。

姓名	类型	Description	必选
见解	对象	集群见解的响应正文。	是的
~~ displayName	字符串	见解的用户友好显示名称。	否
└─ 身份	字符串	见解报表的唯一标识符。	否
└─ 元数据	InsightsMetadata	有关见解报告的元数据。	否
~~ 请求	InsightRequest	请求进行见解分析。	否
~~ 结果	InsightResult	见解报告的结果。	否
~~ 状态	Azure.Core.Foundations.OperationState	见解的当前状态。	否
类型	枚举	可能的值：`Insight`	是的

InsightSummary

误差聚类分析的摘要。

姓名	类型	Description	必选
方法	字符串	用于聚类的方法。	是的
sampleCount	整数	分析的样本总数。	是的
uniqueClusterCount	整数	唯一集群的总数。	是的
uniqueSubclusterCount	整数	唯一子集群标签的总数。	是的
使用情况	对象	集群分析的令牌使用情况	是的
~~ inputTokenUsage	整数	输入令牌使用	否
~~ outputTokenUsage	整数	输出令牌使用	否
~~ totalTokenUsage	整数	令牌总使用量	否

InsightType

见解的请求。

资产	价值
类型	字符串
价值观	`EvaluationRunClusterInsight` `AgentClusterInsight` `EvaluationComparison`

InsightsMetadata

有关见解的元数据。

姓名	类型	Description	必选	违约
completedAt	字符串	见解完成时的时间戳。	否
createdAt	字符串	创建见解时的时间戳。	是的

ItemGenerationParams

表示用于控制项生成作的参数集。

ItemGenerationParams 的鉴别器

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

类型值	Schema

姓名	类型	Description	必选	违约
类型	字符串	要使用的项生成参数的类型。	是的

ManagedAzureAISearchIndex

托管 Azure AI 搜索索引定义

姓名	类型	Description	必选	违约
类型	枚举	索引类型可能的值：`ManagedAzureSearch`	是的

ManagedAzureAISearchIndexUpdate

托管 Azure AI 搜索索引定义

姓名	类型	Description	必选	违约
类型	枚举	索引类型可能的值：`ManagedAzureSearch`	是的

MemoryItem

存储在内存存储中的单个内存项，包含内容和元数据。

MemoryItem 的鉴别器

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

类型值	Schema
`user_profile`	UserProfileMemoryItem
`chat_summary`	ChatSummaryMemoryItem

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

MemoryItemKind

记忆项种类。

资产	价值
说明	记忆项种类。
类型	字符串
价值观	`user_profile` `chat_summary`

MemoryOperation

表示对内存项执行的单个内存作（创建、更新或删除）。

姓名	类型	Description	必选
kind	对象	内存作类型。	是的
memory_item	对象	存储在内存存储中的单个内存项，包含内容和元数据。	是的
└─ 内容	字符串	内存的内容。	否
~~ kind	MemoryItemKind	记忆项目的种类。	否
memory_id	字符串	内存项的唯一 ID。	否
~~ 范围	字符串	在逻辑上对内存进行分组和隔离的命名空间，例如用户 ID。	否
updated_at	整数	内存项目的最后更新时间。	否

MemoryOperationKind

内存作类型。

资产	价值
说明	内存作类型。
类型	字符串
价值观	`create` `update` `delete`

MemorySearchItem

从内存搜索中检索到的内存项。

姓名	类型	Description	必选
memory_item	对象	存储在内存存储中的单个内存项，包含内容和元数据。	是的
└─ 内容	字符串	内存的内容。	否
~~ kind	MemoryItemKind	记忆项目的种类。	否
memory_id	字符串	内存项的唯一 ID。	否
~~ 范围	字符串	在逻辑上对内存进行分组和隔离的命名空间，例如用户 ID。	否
updated_at	整数	内存项目的最后更新时间。	否

MemorySearchOptions

内存搜索选项。

姓名	类型	Description	必选	违约
max_memories	整数	要返回的最大内存项数。	否

MemorySearchTool

将记忆集成到代理中的工具。

姓名	类型	Description	必选	违约
memory_store_name	字符串	要使用的内存存储的名称。	是的
作用域	字符串	用于对内存进行分组和隔离的命名空间，例如用户 ID。限制可以检索或更新的记忆。使用特殊变量 `{{$userId}}` 将内存范围限定为当前登录的用户。	是的
search_options	对象	内存搜索选项。	否
max_memories	整数	要返回的最大内存项数。	否
类型	枚举	工具的类型。始终为 `memory_search`。可能的值：`memory_search`	是的
update_delay	整数	不活动后更新内存之前的等待时间（秒）。默认值为 300。	否	300

MemorySearchToolCallItemParam

姓名	类型	Description	必选	违约
results	数组	从内存搜索返回的结果。	否
类型	枚举	可能的值：`memory_search_call`	是的

MemorySearchToolCallItemResource

姓名	类型	Description	必选
results	数组	从内存搜索返回的结果。	否
状态	枚举	内存搜索工具调用的状态。 `in_progress`、 `searching`、`completed`、`incomplete`或`failed` 可能的值：`in_progress`、、`searchingcompleted`、`incomplete`、`failed`	是的
类型	枚举	可能的值：`memory_search_call`	是的

MemoryStoreDefaultDefinition

默认内存存储实现。

姓名	类型	Description	必选	违约
chat_model	字符串	用于内存处理的聊天完成模型部署的名称或标识符。	是的
embedding_model	字符串	用于内存处理的嵌入模型部署的名称或标识符。	是的
kind	枚举	内存存储的类型。可能的值：`default`	是的
options	对象	默认内存存储配置。	否
chat_summary_enabled	布尔	是否启用聊天摘要提取和存储。默认值为 true。	否	真实
user_profile_details	字符串	要提取和存储的特定类别或类型的用户配置文件信息。	否
user_profile_enabled	布尔	是否启用用户配置文件提取和存储。默认值为 true。	否	真实

MemoryStoreDefaultOptions

默认内存存储配置。

姓名	类型	Description	必选	违约
chat_summary_enabled	布尔	是否启用聊天摘要提取和存储。默认值为 true。	是的	真实
user_profile_details	字符串	要提取和存储的特定类别或类型的用户配置文件信息。	否
user_profile_enabled	布尔	是否启用用户配置文件提取和存储。默认值为 true。	是的	真实

MemoryStoreDefinition

内存存储配置的基本定义。

MemoryStoreDefinition 的鉴别器

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

类型值	Schema
`default`	MemoryStoreDefaultDefinition

姓名	类型	Description	必选	违约
kind	对象	要使用的内存存储实现的类型。	是的

MemoryStoreDeleteScopeResponse

从作用域中删除内存的响应。

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

MemoryStoreKind

要使用的内存存储实现的类型。

资产	价值
说明	要使用的内存存储实现的类型。
类型	字符串
价值观	`default`

MemoryStoreObject

可以存储和检索用户记忆的内存存储。

姓名	类型	Description	必选
创建时间	整数	创建内存存储时的 Unix 时间戳（秒）。	是的
定义	对象	内存存储配置的基本定义。	是的
~~ kind	MemoryStoreKind	内存存储的类型。	否
说明	字符串	内存存储的人类可读描述。	否
id	字符串	内存存储的唯一标识符。	是的
元数据	对象	要与内存存储关联的任意键值元数据。	否
姓名	字符串	内存存储的名称。	是的
对象	枚举	对象类型，始终为“memory_store”。可能的值：`memory_store`	是的
updated_at	整数	上次更新内存存储时的 Unix 时间戳（秒）。	是的

MemoryStoreOperationUsage

内存存储作的使用情况统计信息。

姓名	类型	Description	必选
embedding_tokens	整数	嵌入令牌的数量。	是的
input_tokens	整数	输入令牌数。	是的
input_tokens_details	对象	输入令牌的明细。	是的
cached_tokens	整数	从缓存中检索的令牌数。有关提示缓存的详细信息。	否
output_tokens	整数	输出标记数。	是的
output_tokens_details	对象	输出令牌的明细。	是的
reasoning_tokens	整数	推理令牌的数量。	否
total_tokens	整数	使用的令牌总数。	是的

MemoryStoreSearchResponse

内存搜索响应。

姓名	类型	Description	必选
记忆	数组	在搜索作期间找到的相关内存项目。	是的
search_id	字符串	此搜索请求的唯一 ID。在后续请求中previous_search_id使用此值来执行增量搜索。	是的
使用情况	对象	内存存储作的使用情况统计信息。	是的
embedding_tokens	整数	嵌入令牌的数量。	否
input_tokens	整数	输入令牌数。	否
输入令牌详情	对象	输入令牌的明细。	否
cached_tokens	整数	从缓存中检索的令牌数。有关提示缓存的详细信息。	否
输出标记 (output_tokens)	整数	输出标记数。	否
output_tokens_details	对象	输出令牌的明细。	否
reasoning_tokens	整数	推理令牌的数量。	否
total_tokens	整数	使用的令牌总数。	否

MemoryStoreUpdateCompletedResult

内存更新结果。

姓名	类型	Description	必选
memory_operations	数组	更新期间执行的各个内存作的列表。	是的
使用情况	对象	内存存储作的使用情况统计信息。	是的
embedding_tokens	整数	嵌入令牌的数量。	否
input_tokens	整数	输入令牌数。	否
输入令牌详情	对象	输入令牌的明细。	否
cached_tokens	整数	从缓存中检索的令牌数。有关提示缓存的详细信息。	否
输出标记 (output_tokens)	整数	输出标记数。	否
output_tokens_details	对象	输出令牌的明细。	否
reasoning_tokens	整数	推理令牌的数量。	否
total_tokens	整数	使用的令牌总数。	否

MemoryStoreUpdateResponse

提供内存存储更新作的状态。

姓名	类型	Description	必选
错误	对象		否
~~ additionalInfo	对象		否
└─ 代码	字符串		否
~~ debugInfo	对象		否
~~ 详细信息	数组		否
└─ 消息	字符串		否
└─ 参数	字符串		否
└─ 类型	字符串		否
结果	对象	内存更新结果。	否
memory_operations	数组	更新期间执行的各个内存作的列表。	否
└─ 用法	MemoryStoreOperationUsage	与内存更新作关联的使用情况统计信息。	否
状态	对象	内存存储更新作的状态。	是的
superseded_by	字符串	当状态为“已取代”时，作被取代的update_id。	否
update_id	字符串	此更新请求的唯一 ID。在后续请求中previous_update_id使用此值来执行增量更新。	是的

MemoryStoreUpdateStatus

内存存储更新作的状态。

资产	价值
说明	内存存储更新作的状态。
类型	字符串
价值观	`queued` `in_progress` `completed` `failed` `superseded`

MicrosoftFabricAgentTool

用于配置代理的 Microsoft Fabric 工具的输入定义信息。

姓名	类型	Description	必选
fabric_dataagent_preview	对象	Fabric 数据代理工具参数。	是的
project_connections	数组	附加到此工具的项目连接。最多可以有 1 个连接附加到该工具的资源。	否
类型	枚举	对象类型，始终为“fabric_dataagent”。可能的值：`fabric_dataagent_preview`	是的

ModelDeployment

模型部署定义

姓名	类型	Description	必选
capabilities	对象	已部署模型的功能	是的
connectionName （连接名称）	字符串	部署来自的连接的名称	否
modelName	字符串	已部署模型的发布者特定名称	是的
modelPublisher	字符串	已部署模型的发布者的名称	是的
modelVersion	字符串	已部署模型的发布者特定版本	是的
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`	是的

OAuthConsentRequestItemResource

从服务请求用户执行 OAuth 同意。

姓名	类型	Description	必选
consent_link	字符串	用户可用于执行 OAuth 同意的链接。	是的
id	字符串		是的
服务器标签	字符串	OAuth 同意请求的服务器标签。	是的
类型	枚举	可能的值：`oauth_consent_request`	是的

OneTimeTrigger

一次性触发器。

姓名	类型	Description	必选	违约
timeZone	字符串	一次性触发器的时区。	否	UTC
triggerAt	字符串	ISO 8601 格式的一次性触发器的日期和时间。	是的
类型	枚举	可能的值：`OneTime`	是的

OpenAI.Annotation

OpenAI.Annotation 的鉴别器

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

类型值	Schema
`file_citation`	OpenAI.AnnotationFileCitation
`url_citation`	OpenAI.AnnotationUrlCitation
`file_path`	OpenAI.AnnotationFilePath

姓名	类型	Description	必选	违约
类型	OpenAI.AnnotationType		是的

OpenAI.AnnotationFileCitation

文件的引文。

姓名	类型	Description	必选
file_id	字符串	文件的 ID。	是的
filename	字符串	所引用文件的文件名。	是的
索引	整数	文件列表中的文件的索引。	是的
类型	枚举	文件引文的类型。始终为 `file_citation`。可能的值：`file_citation`	是的

OpenAI.AnnotationFilePath

文件路径。

姓名	类型	Description	必选
file_id	字符串	文件的 ID。	是的
索引	整数	文件列表中的文件的索引。	是的
类型	枚举	文件路径的类型。始终为 `file_path`。可能的值：`file_path`	是的

OpenAI.AnnotationType

资产	价值
类型	字符串
价值观	`file_citation` `url_citation` `file_path` `container_file_citation`

OpenAI.AnnotationUrlCitation

用于生成模型响应的 Web 资源的引文。

姓名	类型	Description	必选
end_index	整数	消息中 URL 引文的最后一个字符的索引。	是的
start_index	整数	消息中 URL 引文的第一个字符的索引。	是的
title	字符串	Web 资源的标题。	是的
类型	枚举	URL 引文的类型。始终为 `url_citation`。可能的值：`url_citation`	是的
url	字符串	Web 资源的 URL。	是的

OpenAI.ApproximateLocation

姓名	类型	Description	必选
城市	字符串		否
国家	字符串		否
区域	字符串		否
timezone	字符串		否
类型	枚举	可能的值：`approximate`	是的

OpenAI 聊天完成工具

可用于生成响应的函数工具。

姓名	类型	Description	必选	违约
函数	OpenAI.FunctionObject		是的
类型	枚举	工具的类型。目前仅支持 `function`。可能的值：`function`	是的

OpenAI.CodeInterpreterOutput

OpenAI.CodeInterpreterOutput 的鉴别器

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

类型值	Schema
`image`	OpenAI.CodeInterpreterOutputImage
`logs`	OpenAI.CodeInterpreterOutputLogs

姓名	类型	Description	必选	违约
类型	OpenAI.CodeInterpreterOutputType		是的

OpenAI.CodeInterpreterOutputImage

代码解释器的图像输出。

姓名	类型	Description	必选	违约
类型	枚举	输出的类型。始终为“image”。可能的值：`image`	是的
url	字符串	代码解释器的图像输出的 URL。	是的

OpenAI.CodeInterpreterOutputLogs

代码解释器输出的日志。

姓名	类型	Description	必选	违约
日志	字符串	代码解释器输出的日志。	是的
类型	枚举	输出的类型。始终为“logs”。可能的值：`logs`	是的

OpenAI.CodeInterpreterOutputType

资产	价值
类型	字符串
价值观	`logs` `image`

OpenAI.CodeInterpreterTool

运行 Python 代码以帮助生成对提示的响应的工具。

姓名	类型	Description	必选
容器	对象	代码解释器容器的配置。（可选）指定 ID 要运行代码的文件的该项。	是的
file_ids	数组	可提供给代码使用的已上传文件的一个可选列表。	否
└─ 类型	枚举	始终为 `auto`。可能的值：`auto`	否
类型	枚举	代码解释器工具的类型。始终为 `code_interpreter`。可能的值：`code_interpreter`	是的

OpenAI.CodeInterpreterToolAuto

代码解释器容器的配置。（可选）指定要运行代码的文件 ID。

姓名	类型	Description	必选	违约
file_ids	数组	可提供给代码使用的已上传文件的一个可选列表。	否
类型	枚举	始终为 `auto`。可能的值：`auto`	是的

OpenAI.CodeInterpreterToolCallItemParam

用于运行代码的工具调用。

姓名	类型	Description	必选
代码	字符串	要运行的代码；如果不可用，则为 null。	是的
container_id	字符串	用于运行代码的容器的 ID。	是的
outputs	数组	由代码解释器生成的输出，例如日志或图像。如果没有可用的输出，则可以为 null。	是的
类型	枚举	可能的值：`code_interpreter_call`	是的

OpenAI.CodeInterpreterToolCallItemResource

用于运行代码的工具调用。

姓名	类型	Description	必选
代码	字符串	要运行的代码；如果不可用，则为 null。	是的
container_id	字符串	用于运行代码的容器的 ID。	是的
outputs	数组	由代码解释器生成的输出，例如日志或图像。如果没有可用的输出，则可以为 null。	是的
状态	枚举	可能的值：`in_progress`、、`completedincomplete`、`interpreting`、`failed`	是的
类型	枚举	可能的值：`code_interpreter_call`	是的

OpenAI.ComparisonFilter（比较过滤器）

用于使用定义的比较操作来比较指定属性键与给定值的筛选器。

姓名	类型	Description	必选
关键值	字符串	要与值进行比较的键。	是的
类型	枚举	指定比较运算符： `eq` （equal）、 `ne` （不相等）、 `gt` （大于）、 `gte` （大于或等于）、（小于）、 `ltlte` （小于或等于）。可能的值：`eq`、、`ne`、`gtgte`、`lt`、`lte`	是的
value	字符串或数字或布尔值		是的

OpenAI.复合过滤器

使用 and 或 or. 合并多个筛选器。

姓名	类型	Description	必选	违约
filters	数组	要组合的筛选器数组。项可以是 `ComparisonFilter` 或 `CompoundFilter`。	是的
类型	枚举	操作类型：`and` 或 `or`。可能的值： `andor`	是的

OpenAI.ComputerAction

OpenAI.ComputerAction 的鉴别器

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

类型值	Schema
`click`	OpenAI.ComputerActionClick
`double_click`	OpenAI.ComputerActionDoubleClick
`drag`	OpenAI.ComputerActionDrag
`move`	OpenAI.ComputerActionMove
`screenshot`	OpenAI.ComputerActionScreenshot
`scroll`	OpenAI.ComputerActionScroll
`type`	OpenAI.ComputerActionTypeKeys
`wait`	OpenAI.ComputerActionWait
`keypress`	OpenAI.ComputerActionKeyPress

姓名	类型	Description	必选	违约
类型	OpenAI.ComputerActionType		是的

OpenAI.ComputerActionClick

单击操作。

姓名	类型	Description	必选
button	枚举	指示单击期间按下了哪个鼠标按钮。 `left`、`right`、`wheel`、`back` 或 `forward` 中的一个。可能的值：`left`、、`rightwheel`、`back`、`forward`	是的
类型	枚举	指定事件类型。对于单击操作，此属性为始终设置为 `click`。可能的值：`click`	是的
x	整数	单击位置的 x 坐标。	是的
y	整数	发生单击的位置的 y 坐标。	是的

OpenAI.ComputerActionDoubleClick

双击操作。

姓名	类型	Description	必选
类型	枚举	指定事件类型。对于双击操作，此属性为始终设置为 `double_click`。可能的值：`double_click`	是的
x	整数	双击发生时的 x 坐标。	是的
y	整数	发生双击的 y 坐标。	是的

OpenAI.ComputerActionDrag

拖动操作。

姓名	类型	Description	必选	违约
路径	数组	表示拖动作路径的坐标数组。坐标将显示为数组对象，例如 `<br>[<br> { x: 100, y: 200 },<br> { x: 200, y: 300 }<br>]<br>`	是的
类型	枚举	指定事件类型。对于拖动操作，此属性为始终设置为 `drag`。可能的值：`drag`	是的

OpenAI.ComputerActionKeyPress

模型要执行的按键集合。

姓名	类型	Description	必选	违约
钥匙	数组	模型请求按下的键的组合。这是一字符串数组，每个字符串表示一个键。	是的
类型	枚举	指定事件类型。对于按键操作，此属性为始终设置为 `keypress`。可能的值：`keypress`	是的

OpenAI.ComputerActionMove

鼠标移动操作。

姓名	类型	Description	必选
类型	枚举	指定事件类型。对于移动操作，此属性始终设置为 `move`。可能的值：`move`	是的
x	整数	要移动到的 X 坐标。	是的
y	整数	要移动到的 Y 坐标。	是的

OpenAI.ComputerActionScreenshot

屏幕截图操作。

姓名	类型	Description	必选	违约
类型	枚举	指定事件类型。对于屏幕截图操作，此属性为始终设置为 `screenshot`。可能的值：`screenshot`	是的

OpenAI.ComputerActionScroll

滚动操作。

姓名	类型	Description	必选
scroll_x	整数	水平滚动距离。	是的
scroll_y	整数	垂直滚动距离。	是的
类型	枚举	指定事件类型。对于滚动操作，此属性为始终设置为 `scroll`。可能的值：`scroll`	是的
x	整数	发生滚动的 X 坐标。	是的
y	整数	发生滚动的 Y 坐标。	是的

OpenAI.ComputerActionType

资产	价值
类型	字符串
价值观	`screenshot` `click` `double_click` `scroll` `type` `wait` `keypress` `drag` `move`

OpenAI.ComputerActionTypeKeys

键入文本的操作。

姓名	类型	Description	必选	违约
文本消息	字符串	要键入的文本。	是的
类型	枚举	指定事件类型。对于键入操作，此属性为始终设置为 `type`。可能的值：`type`	是的

OpenAI.ComputerActionWait

等待操作。

姓名	类型	Description	必选	违约
类型	枚举	指定事件类型。对于等待操作，此属性为始终设置为 `wait`。可能的值：`wait`	是的

OpenAI.ComputerToolCallItemParam

对计算机使用工具的工具调用。有关更多信息，请参阅计算机使用指南。

姓名	类型	Description	必选
操作	OpenAI.ComputerAction		是的
call_id	字符串	用输出来响应工具调用时使用的标识符。	是的
pending_safety_checks	数组	计算机调用的挂起安全检查。	是的
类型	枚举	可能的值：`computer_call`	是的

OpenAI.ComputerToolCallItemResource

对计算机使用工具的工具调用。有关更多信息，请参阅计算机使用指南。

姓名	类型	Description	必选
操作	OpenAI.ComputerAction		是的
call_id	字符串	用输出来响应工具调用时使用的标识符。	是的
pending_safety_checks	数组	计算机调用的挂起安全检查。	是的
状态	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	是的
类型	枚举	可能的值：`computer_call`	是的

OpenAI.ComputerToolCallOutputItemOutput

OpenAI.ComputerToolCallOutputItemOutput 的鉴别器

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

类型值	Schema
`computer_screenshot`	OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

姓名	类型	Description	必选	违约
类型	OpenAI.ComputerToolCallOutputItemOutputType	与计算机使用工具一起使用的计算机屏幕截图图像。	是的

OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

姓名	类型	Description	必选
file_id	字符串		否
image_url	字符串		否
类型	枚举	可能的值：`computer_screenshot`	是的

OpenAI.ComputerToolCallOutputItemOutputType

与计算机使用工具一起使用的计算机屏幕截图图像。

资产	价值
说明	与计算机使用工具一起使用的计算机屏幕截图图像。
类型	字符串
价值观	`computer_screenshot`

OpenAI.ComputerToolCallOutputItemParam

计算机工具调用的输出。

姓名	类型	Description	必选
acknowledged_safety_checks	数组	API 报告的安全检查，这些检查的确认者为开发人员。	否
call_id	字符串	生成输出的计算机工具调用的 ID。	是的
输出	OpenAI.ComputerToolCallOutputItemOutput		是的
类型	枚举	可能的值：`computer_call_output`	是的

OpenAI.ComputerToolCallOutputItemResource

计算机工具调用的输出。

姓名	类型	Description	必选
acknowledged_safety_checks	数组	API 报告的安全检查，这些检查的确认者为开发人员。	否
call_id	字符串	生成输出的计算机工具调用的 ID。	是的
输出	OpenAI.ComputerToolCallOutputItemOutput		是的
状态	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	是的
类型	枚举	可能的值：`computer_call_output`	是的

OpenAI.ComputerToolCallSafetyCheck

计算机调用的挂起安全检查。

姓名	类型	Description	必选
代码	字符串	挂起的安全检查的类型。	是的
id	字符串	挂起的安全检查的 ID。	是的
消息	字符串	有关挂起的安全检查的详细信息。	是的

OpenAI.ComputerUsePreviewTool

控制虚拟计算机的工具。

姓名	类型	Description	必选
显示高度	整数	计算机显示的高度。	是的
显示宽度	整数	计算机的显示宽度。	是的
环境	枚举	要控制的计算机环境的类型。可能的值：`windows`、、`maclinux`、`ubuntu`、`browser`	是的
类型	枚举	计算机使用工具的类型。始终为 `computer_use_preview`。可能的值：`computer_use_preview`	是的

OpenAI.ConversationItemList

姓名	类型	Description	必选
数据	数组		是的
first_id	字符串		是的
has_more	布尔		是的
last_id	字符串		是的
对象	枚举	可能的值：`list`	是的

OpenAI.ConversationResource

姓名	类型	Description	必选
创建时间	整数		是的
id	字符串	对话的唯一 ID。	是的
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	是的
对象	枚举	对象类型，始终为“conversation”。可能的值：`conversation`	是的

OpenAI.Coordinate

x/y 坐标对，例如 { x: 100, y: 200 }

姓名	类型	Description	必选	违约
x	整数	X 坐标。	是的
y	整数	Y 坐标。	是的

OpenAI.CreateConversationRequest

创建对话

姓名	类型	Description	必选	违约
items	数组	要包含对话上下文的初始项。一次最多可以添加 20 个项目。	否
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否

OpenAI.CreateEvalCompletionsRunDataSource

描述模型采样配置的 CompletionsRunDataSource 对象。

姓名	类型	Description	必选
输入消息	对象		否
item_reference	字符串		否
~~ 模板	数组		否
└─ 类型	枚举	可能的值：`item_reference`	否
模型	字符串	用于生成补全的模型的名称（例如“o3-mini”）。	否
采样参数	OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams		否
源	对象		是的
└─ 内容	数组	jsonl 文件的内容。	否
创建后	OpenAI.integer		否
创建_在之前	OpenAI.integer		否
└─ 身份	字符串	文件的标识符。	否
└─ 限制	OpenAI.integer		否
└─ 元数据	OpenAI.Metadata	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
└─ 模型	字符串		否
└─ 类型	枚举	源的类型。始终为 `stored_completions`。可能的值：`stored_completions`	否
类型	枚举	运行数据源的类型。始终为 `completions`。可能的值：`completions`	是的

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference

姓名	类型	Description	必选	违约
item_reference	字符串		是的
类型	枚举	可能的值：`item_reference`	是的

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate

姓名	类型	Description	必选	违约
模板	数组		是的
类型	枚举	可能的值：`template`	是的

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

姓名	类型	Description	必选	违约
max_completion_tokens	OpenAI.integer		否
推理努力	OpenAI.ReasoningEffort	限制推理模型的推理力度。当前支持的值为 none、minimal、low、medium 和 high。减少推理工作量可以加快回复速度，减少回复中用于推理的标记。 gpt-5.1 默认为 none，不执行推理。 gpt-5.1 支持的推理值为无、低、中和高。 gpt-5.1 中的所有推理值都支持工具调用。 gpt-5.1 之前的所有模型默认为中等推理工作量，并且不支持 none。 gpt-5-pro 模型默认为（仅支持）高推理工作量。	否
响应格式	对象	默认响应格式。用于生成文本响应。	否
JSON模式	对象	结构化输出配置选项，包括 JSON 架构。	否
└─ 说明	字符串	响应格式用途的描述，供模型确定如何按该格式响应。	否
└─ 名称	字符串	响应格式的名称。必须为 a-z、A-Z、0-9 或包含下划线和短划线，最大长度为 64。	否
└─ 架构	对象		否
└─ 严格	布尔	是否在生成输出时启用严格的架构遵循。如果设置为 true，则模型将始终遵循定义的确切架构在 `schema` 字段中。以下情况时仅支持 JSON 架构的子集： `strict` 是 `true`。若要了解详细信息，请阅读结构化输出指南。	否	假
└─ 类型	枚举	要定义的响应格式的类型。始终为 `json_object`。可能的值：`json_object`	否
seed	对象		否
温度	对象		否
工具	数组		否
top_p	对象		否

OpenAI.CreateEvalCustomDataSourceConfig

一个 CustomDataSourceConfig 对象，用于定义用于评估运行的数据源的架构。此架构用于定义将要处理的数据的结构：

用于定义测试条件和
创建运行时需要哪些数据

姓名	类型	Description	必选
include_sample_schema	布尔	评估是否应期望由你填充示例命名空间（即通过从数据源生成响应）	否
item_schema	对象	数据源中每一行的 json 架构。	是的
类型	枚举	数据源的类型。始终为 `custom`。可能的值：`custom`	是的

OpenAI.CreateEvalJsonlRunDataSource

一个 JsonlRunDataSource 对象，该对象指定与 eval 匹配的 JSONL 文件

姓名	类型	Description	必选
源	对象		是的
└─ 内容	数组	jsonl 文件的内容。	否
└─ 身份	字符串	文件的标识符。	否
└─ 类型	枚举	jsonl 源的类型。始终为 `file_id`。可能的值：`file_id`	否
类型	枚举	数据源的类型。始终为 `jsonl`。可能的值：`jsonl`	是的

OpenAI.CreateEvalLogsDataSourceConfig

数据源配置，指定日志查询的元数据属性。这通常是类似 usecase=chatbot 或 prompt-version=v2等的元数据。

姓名	类型	Description	必选	违约
元数据	对象	日志数据源的元数据筛选器。	否
类型	枚举	数据源的类型。始终为 `logs`。可能的值：`logs`	是的

OpenAI.CreateEvalResponsesRunDataSource

描述模型采样配置的 ResponsesRunDataSource 对象。

姓名	类型	Description	必选
输入消息	对象		否
item_reference	字符串		否
~~ 模板	数组		否
└─ 类型	枚举	可能的值：`item_reference`	否
模型	字符串	用于生成补全的模型的名称（例如“o3-mini”）。	否
采样参数	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		否
源	对象		是的
└─ 内容	数组	jsonl 文件的内容。	否
创建后	OpenAI.integer		否
创建_在之前	OpenAI.integer		否
└─ 身份	字符串	文件的标识符。	否
指令搜索	字符串		否
└─ 元数据	对象		否
└─ 模型	字符串		否
推理努力	OpenAI.ReasoningEffort	限制推理模型的推理力度。当前支持的值为 none、minimal、low、medium 和 high。减少推理工作量可以加快回复速度，减少回复中用于推理的标记。 gpt-5.1 默认为 none，不执行推理。 gpt-5.1 支持的推理值为无、低、中和高。 gpt-5.1 中的所有推理值都支持工具调用。 gpt-5.1 之前的所有模型默认为中等推理工作量，并且不支持 none。 gpt-5-pro 模型默认为（仅支持）高推理工作量。	否
~~ 温度	OpenAI.numeric		否
└─ 工具	数组		否
top_p	OpenAI.numeric		否
└─ 类型	枚举	运行数据源的类型。始终为 `responses`。可能的值：`responses`	否
└─ 用户	数组		否
类型	枚举	运行数据源的类型。始终为 `responses`。可能的值：`responses`	是的

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference

姓名	类型	Description	必选	违约
item_reference	字符串		是的
类型	枚举	可能的值：`item_reference`	是的

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate

姓名	类型	Description	必选	违约
模板	数组		是的
类型	枚举	可能的值：`template`	是的

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

姓名	类型	Description	必选
max_completion_tokens	OpenAI.integer		否
推理努力	OpenAI.ReasoningEffort	限制推理模型的推理力度。当前支持的值为 none、minimal、low、medium 和 high。减少推理工作量可以加快回复速度，减少回复中用于推理的标记。 gpt-5.1 默认为 none，不执行推理。 gpt-5.1 支持的推理值为无、低、中和高。 gpt-5.1 中的所有推理值都支持工具调用。 gpt-5.1 之前的所有模型默认为中等推理工作量，并且不支持 none。 gpt-5-pro 模型默认为（仅支持）高推理工作量。	否
seed	对象		否
温度	对象		否
文本消息	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		否
工具	数组		否
top_p	对象		否

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	必选	违约
超参数	对象	用于微调作业的超参数。此值现已被弃用，请改用 `method` 参数，并在 `method` 参数下传递。	否
batch_size	枚举	可能的值：`auto`	否
学习率倍增器	枚举	可能的值：`auto`	否
n_epochs	枚举	可能的值：`auto`	否
integrations	数组	要为微调作业启用的集成列表。	否
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
方法	OpenAI.FineTuneMethod	用于微调的方法。	否
模型	字符串（请参阅下面的有效模型）	要微调的模型的名称。可以选择其中一个支持的模型。	是的
seed	整数	种子控制作业的可重现性。传入相同的种子和作业参数应会产生相同的结果，但在极少数情况下可能会有差异。如果未指定种子，则会为你生成一个种子。	否
suffix	字符串	最多 64 个字符的字符串，将添加到微调模型名称中。例如，`suffix` 为“custom-model-name”，将生成类似 `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel` 这样的模型名称。	否	None
训练文件	字符串	包含训练数据的已上传文件的 ID。数据集必须格式化为 JSONL 文件。此外，必须上传文件，目的是执行 `fine-tune` 操作。文件的内容应根据模型是使用聊天格式、补全格式，还是微调方法使用偏好格式而有所不同。有关更多详细信息，请参阅微调指南。	是的
验证文件	字符串	包含验证数据的已上传文件的 ID。如果提供此文件，则数据将在微调期间定期用于生成验证指标。这些指标可在微调结果文件中查看。训练文件和验证文件中不应存在相同的数据。数据集必须格式化为 JSONL 文件。必须上传文件，目的是执行 `fine-tune` 操作。有关更多详细信息，请参阅微调指南。	否

OpenAI.CreateFineTuningJobRequestIntegration

OpenAI.CreateFineTuningJobRequestIntegration 的鉴别器

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

类型值	Schema
`wandb`	OpenAI.CreateFineTuningJobRequestWandbIntegration

姓名	类型	Description	必选	违约
类型	字符串（请参阅下面的有效模型）		是的

OpenAI.CreateFineTuningJobRequestWandbIntegration

姓名	类型	Description	必选
类型	枚举	可能的值：`wandb`	是的
wandb	对象		是的
└─ 实体	字符串		否
└─ 名称	字符串		否
└─ 项目	字符串		否
└─ 标记	数组		否

OpenAI.CreateResponse

姓名	类型	Description	必选	违约
代理	对象		否
└─ 名称	字符串	代理的名称。	否
└─ 类型	枚举	可能的值：`agent_reference`	否
└─ 版本	字符串	代理的版本标识符。	否
后台的	布尔	是否在后台运行模型响应。详细了解后台响应。	否	假
对话	对象		否
└─ 身份	字符串		否
包括	数组	指定要包含在模型响应中的其他输出数据。现在支持的值包括： - `code_interpreter_call.outputs`：在代码解释器工具调用项中包含 python 代码执行的输出。 - `computer_call_output.output.image_url`：包括计算机调用输出中的图像 URL。 - `file_search_call.results`：包括文件搜索工具的搜索结果。 - `message.input_image.image_url`：包括输入消息中的图像链接。 - `message.output_text.logprobs`：包括含协助消息的 logprob。 - `reasoning.encrypted_content`：包括推理的加密版本推理项目输出中的令牌。这样就可以在无状态使用响应 API 时，在多轮次对话中使用推理项（例如当参数 `store` 设置为 `false`，或当组织在零数据保留计划中注册时）。	否
输入	字符串或数组		否
instructions	字符串	插入到模型上下文中的系统（或开发人员）消息。当与 `previous_response_id` 一起使用时，先前的响应的指令不会传递到下一个响应。这使得它变得简单在新的响应中交换系统（或开发人员）消息。	否
max_output_tokens	整数	可为响应生成的令牌数上限，包括可见输出令牌和推理令牌。	否
max_tool_calls	整数	响应中可以处理的内置工具的最大调用次数。此最大调用次数适用于所有内置工具调用，而非单个工具的调用。模型对任何工具的后续调用尝试都将被忽略。	否
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
模型	字符串	用于创建此响应的模型部署。	否
并行工具调用	布尔	是否允许模型并行运行工具调用。	否	真实
previous_response_id	字符串	对模型的上一个响应的唯一 ID。用它创建多轮对话。详细了解管理聊天状态。	否
提示	对象	对提示模板及其变量的引用。了解详细信息。	否
└─ 身份	字符串	要使用的提示模板的唯一标识符。	否
~~ 变量	OpenAI.ResponsePromptVariables	可选的值映射，用于替换提示中的变量。替换值可以是字符串，也可以是其他响应输入类型，如图像或文件。	否
└─ 版本	字符串	提示模板的可选版本。	否
reasoning	对象	仅适用于 O 系列模型推理模型的配置选项。	否
努力	OpenAI.ReasoningEffort	限制推理模型的推理力度。当前支持的值为 none、minimal、low、medium 和 high。减少推理工作量可以加快回复速度，减少回复中用于推理的标记。 gpt-5.1 默认为 none，不执行推理。 gpt-5.1 支持的推理值为无、低、中和高。 gpt-5.1 中的所有推理值都支持工具调用。 gpt-5.1 之前的所有模型默认为中等推理工作量，并且不支持 none。 gpt-5-pro 模型默认为（仅支持）高推理工作量。	否
生成摘要	枚举	已弃用：请改用`summary`。模型执行的推理摘要。这对于调试和了解模型的推理过程非常有用。 `auto`、`concise` 或 `detailed` 之一。可能的值：`auto`、、 `concisedetailed`	否
~~ 摘要	枚举	模型执行的推理摘要。这可以是可用于调试和了解模型的推理过程。 `auto`、`concise` 或 `detailed` 之一。可能的值：`auto`、、 `concisedetailed`	否
服务等级	对象	指定用于为请求提供服务的处理类型。 * 如果设置为“auto”，则将使用服务层处理请求在 Project 设置中配置。除非另有配置，否则项目将使用“default”。 * 如果设置为“default”，则将使用标准处理请求所选模型的定价和性能。 * 如果设置为“flex” 或“priority”，则请求将与相应的服务一起处理层。请联系销售人员了解有关优先级处理的详细信息。 * 如果未设置，默认行为为“auto”。 `service_tier`设置参数后，响应正文将包含`service_tier` 基于实际用于处理请求的处理模式的值。此响应值可能与参数中设置的值不同。	否
存储	布尔	是否存储生成的模型响应，以便以后通过某种方式检索应用程序接口。	否	真实
数据流	布尔	如果设置为 true，模型响应数据将流式传输到客户端因为这是使用服务器发送事件生成的。以了解详细信息。	否	假
structured_inputs	对象	可以参与提示模板替换或工具参数绑定的响应的结构化输入。	否
温度	数字	要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性我们通常建议更改此设置或 `top_p`，但不要同时更改两者。	否	1
文本消息	对象	来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。请参阅文本输入和输出和结构化输出	否
└─ 格式	OpenAI.ResponseTextFormatConfiguration		否
tool_choice	对象	控制模型调用哪些工具（如有）。 `none` 表示模型不会调用任何工具，而是生成消息。 `auto` 表示模型可以在生成消息或调用一个消息之间进行选择更多工具。 `required` 表示模型必须调用一个或多个工具。	否
└─ 类型	OpenAI.ToolChoiceObjectType	指示模型应使用内置工具生成响应。详细了解内置工具。	否
工具	数组	生成响应时，模型可能会调用的工具数组。你可以通过设置 `tool_choice` 参数来指定要使用的工具。可以提供模型的两类工具包括： - 内置工具：OpenAI 提供的工具，用于扩展模型的功能，如文件搜索。 - 函数调用（自定义工具）：由你定义的函数，使模型能够调用自己的代码。	否
top_logprobs	整数	一个介于 0 和 20 之间的整数，指定在每个标记位置最有可能返回的的标记数，每个都有关联的对数概率。	否
top_p	数字	使用温度进行采样的替代方法，称为核采样，其中，模型考虑具有 top_p 概率质量的令牌的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。我们通常建议更改此设置或 `temperature`，但不要同时更改两者。	否	1
truncation	枚举	要用于模型响应的截断策略。 - `auto`：如果此响应和以前的响应上下文超过模型的上下文窗口大小，模型将截断响应以适应上下文窗口，方法是在对话中删除输入项。 - `disabled`（默认值）：如果模型响应将超过上下文窗口模型的大小，请求将失败并出现 400 错误。可能的值： `autodisabled`	否
用户	字符串	详细了解安全最佳做法。	否

OpenAI.DeletedConversationResource

姓名	类型	Description	必选
已删除	布尔		是的
id	字符串		是的
对象	枚举	可能的值：`conversation.deleted`	是的

OpenAI.EasyInputMessage

姓名	类型	Description	必选	违约
内容	字符串或数组		是的
角色	字符串		是的

OpenAI.Error

姓名	类型	必选
附加信息	对象	否
代码	字符串	是的
调试信息	对象	否
details	数组	否
消息	字符串	是的
param	字符串	是的
类型	字符串	是的

OpenAI.EvalApiError

一个对象，表示来自 Eval API 的错误响应。

姓名	类型	Description	必选	违约
代码	字符串	错误代码。	是的
消息	字符串	错误消息。	是的

OpenAI.EvalGraderLabelModel

姓名	类型	Description	必选
输入	数组		是的
labels	数组	要分配给评估中每个项的标签。	是的
模型	字符串	要用于评估的模型。必须支持结构化输出。	是的
姓名	字符串	评分程序的名称。	是的
passing_labels	数组	指示通过结果的标签。必须是标签的子集。	是的
类型	枚举	始终为 `label_model` 的对象类型。可能的值：`label_model`	是的

OpenAI.EvalGraderPython

姓名	类型	Description	必选
image_tag	字符串	要用于 python 脚本的图像标记。	否
姓名	字符串	评分程序的名称。	是的
通过阈值	对象		否
源	字符串	python 脚本的源代码。	是的
类型	枚举	始终为 `python` 的对象类型。可能的值：`python`	是的

OpenAI.EvalGraderScoreModel

姓名	类型	Description	必选
输入	数组	输入文本。这可能包括模板字符串。	是的
模型	字符串	要用于评估的模型。	是的
姓名	字符串	评分程序的名称。	是的
通过阈值	对象		否
范围	数组	分数的范围。默认为 `[0, 1]`。	否
采样参数	对象		否
max_completions_tokens	OpenAI.integer		否
推理努力	OpenAI.ReasoningEffort	限制推理模型的推理力度。当前支持的值为 none、minimal、low、medium 和 high。减少推理工作量可以加快回复速度，减少回复中用于推理的标记。 gpt-5.1 默认为 none，不执行推理。 gpt-5.1 支持的推理值为无、低、中和高。 gpt-5.1 中的所有推理值都支持工具调用。 gpt-5.1 之前的所有模型默认为中等推理工作量，并且不支持 none。 gpt-5-pro 模型默认为（仅支持）高推理工作量。	否
~~ 种子	OpenAI.integer		否
~~ 温度	OpenAI.numeric		否
top_p	OpenAI.numeric		否
类型	枚举	始终为 `score_model` 的对象类型。可能的值：`score_model`	是的

OpenAI.EvalGraderScoreModelSamplingParams

姓名	类型	Description	必选
max_completions_tokens	对象		否
推理努力	OpenAI.ReasoningEffort	限制推理模型的推理力度。当前支持的值为 none、minimal、low、medium 和 high。减少推理工作量可以加快回复速度，减少回复中用于推理的标记。 gpt-5.1 默认为 none，不执行推理。 gpt-5.1 支持的推理值为无、低、中和高。 gpt-5.1 中的所有推理值都支持工具调用。 gpt-5.1 之前的所有模型默认为中等推理工作量，并且不支持 none。 gpt-5-pro 模型默认为（仅支持）高推理工作量。	否
seed	对象		否
温度	对象		否
top_p	对象		否

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`	是的
输入	字符串	正在评分的文本。	是的
姓名	字符串	评分程序的名称。	是的
通过阈值	对象		是的
引用	字符串	作为评分参照的文本。	是的
类型	枚举	评分程序的类型。可能的值：`text_similarity`	是的

OpenAI.EvalItem

模型的消息输入，具有指示以下层次结构的说明的角色。使用 developer 或 system 角色提供的说明优先于角色 user 提供的说明。假定具有 assistant 角色的消息是由模型在以前的交互中生成的。

姓名	类型	Description	必选
内容	对象	模型的文本输入。	是的
└─ 数据	字符串	Base64 编码的音频数据。	否
└─ 详细信息	字符串		否
└─ 格式	枚举	音频数据的格式。当前支持的格式包括 `mp3` 和 `wav`。可能的值： `mp3wav`	否
image_url	字符串		否
└─ 文本	字符串		否
└─ 类型	枚举	输入项的类型。始终为 `input_audio`。可能的值：`input_audio`	否
角色	枚举	消息输入的角色。 `user`、`assistant`、`system`之一或 `developer`。可能的值：`user`、`assistant`、`system`、`developer`	是的
类型	枚举	消息输入的类型。始终为 `message`。可能的值：`message`	否

OpenAI.EvalItemContentInputImage

姓名	类型	Description	必选
detail	字符串		否
image_url	字符串		是的
类型	枚举	可能的值：`input_image`	是的

OpenAI.EvalItemContentOutputText

姓名	类型	Description	必选	违约
文本消息	字符串		是的
类型	枚举	可能的值：`output_text`	是的

OpenAI.EvalJsonlFileContentSource

姓名	类型	Description	必选	违约
内容	数组	jsonl 文件的内容。	是的
类型	枚举	jsonl 源的类型。始终为 `file_content`。可能的值：`file_content`	是的

OpenAI.EvalJsonlFileContentSourceContent

姓名	类型	Description	必选	违约
项	对象		是的
示例	对象		否

OpenAI.EvalJsonlFileIdSource

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

OpenAI.EvalResponsesSource

描述运行数据源配置的 EvalResponsesSource 对象。

姓名	类型	Description	必选
created_after	对象		否
created_before	对象		否
instructions_search	字符串		否
元数据	对象		否
模型	字符串		否
推理努力	对象	限制推理模型的推理力度。当前支持的值为 none、minimal、low、medium 和 high。减少推理工作量可以加快回复速度，减少回复中用于推理的标记。 gpt-5.1 默认为 none，不执行推理。 gpt-5.1 支持的推理值为无、低、中和高。 gpt-5.1 中的所有推理值都支持工具调用。 gpt-5.1 之前的所有模型默认为中等推理工作量，并且不支持 none。 gpt-5-pro 模型默认为（仅支持）高推理工作量。	否
温度	对象		否
工具	数组		否
top_p	对象		否
类型	枚举	运行数据源的类型。始终为 `responses`。可能的值：`responses`	是的
users	数组		否

OpenAI.EvalRunOutputItemSample

姓名	类型	Description	必选
错误	OpenAI.EvalApiError	一个对象，表示来自 Eval API 的错误响应。	是的
finish_reason	字符串		是的
输入	数组		是的
max_completion_tokens	OpenAI.integer		是的
模型	字符串		是的
输出	数组		是的
seed	OpenAI.integer		是的
温度	OpenAI.numeric		是的
top_p	OpenAI.numeric		是的
使用情况	OpenAI.EvalRunOutputItemSampleUsage		是的

OpenAI.EvalRunOutputItemSampleInput

姓名	类型	Description	必选	违约
内容	字符串		是的
角色	字符串		是的

OpenAI.EvalRunOutputItemSampleOutput

姓名	类型	Description	必选	违约
内容	字符串		否
角色	字符串		否

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	对象		否
created_before	对象		否
limit	对象		否
元数据	OpenAI.Metadata	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
模型	字符串		否
类型	枚举	源的类型。始终为 `stored_completions`。可能的值：`stored_completions`	是的

OpenAI.FileSearchTool

一个工具，用于搜索已上传文件中的相关内容。

姓名	类型	Description	必选
filters	对象		否
max_num_results（最大结果数）	整数	要返回的最大结果数。此数字应介于 1 和 50 之间（含）。	否
排名选项	对象		否
~~ 排名器	枚举	用于文件搜索的排序算法。可能的值： `autodefault-2024-11-15`	否
分数阈值	数字	文件搜索的分数阈值，介于 0 和 1 之间。接近 1 的数字将尝试仅返回最相关的结果，但可能会返回更少的结果。	否
类型	枚举	文件搜索工具的类型。始终为 `file_search`。可能的值：`file_search`	是的
vector_store_ids	数组	要搜索的矢量存储的 ID。	是的

OpenAI.FileSearchToolCallItemParam

文件搜索工具调用的结果。有关详细信息，请参阅文件搜索指南。

姓名	类型	Description	必选
查询	数组	用于搜索文件的查询。	是的
results	数组	文件搜索工具调用的结果。	否
类型	枚举	可能的值：`file_search_call`	是的

OpenAI.FileSearchToolCallItemResource

文件搜索工具调用的结果。有关详细信息，请参阅文件搜索指南。

姓名	类型	Description	必选
查询	数组	用于搜索文件的查询。	是的
results	数组	文件搜索工具调用的结果。	否
状态	枚举	文件搜索工具调用的状态。 `in_progress`、 `searching`、`incomplete`或`failed` 可能的值：`in_progress`、、`searchingcompleted`、`incomplete`、`failed`	是的
类型	枚举	可能的值：`file_search_call`	是的

OpenAI.Filters

姓名	类型	Description	必选
filters	数组	要组合的筛选器数组。项可以是 `ComparisonFilter` 或 `CompoundFilter`。	是的
关键值	字符串	要与值进行比较的键。	是的
类型	枚举	操作类型：`and` 或 `or`。可能的值： `andor`	是的
value	字符串或数字或布尔值	要与属性键进行比较的值;支持字符串、数字或布尔类型。	是的

OpenAI.FineTuneDPOHyperparameters

用于 DPO 微调作业的超参数。

姓名	类型	Description	必选
批处理大小	枚举	可能的值：`auto`	否
beta 版本	枚举	可能的值：`auto`	否
学习率乘数 (learning_rate_multiplier)	枚举	可能的值：`auto`	否
n_epochs	枚举	可能的值：`auto`	否

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	必选
批处理大小	枚举	可能的值：`auto`	否
compute_multiplier	枚举	可能的值：`auto`	否
eval_interval	枚举	可能的值：`auto`	否
eval_samples	枚举	可能的值：`auto`	否
学习率乘数 (learning_rate_multiplier)	枚举	可能的值：`auto`	否
n_epochs	枚举	可能的值：`auto`	否
推理努力	枚举	推理工作级别。可能的值：`default`、`low`、`medium`、`high`	否

OpenAI.FineTuneReinforcementMethod

强化微调方法的配置。

姓名	类型	Description	必选
评分器	对象	一个 StringCheckGrader 对象，该对象使用指定的操作在输入和参考之间执行字符串比较。	是的
calculate_output	字符串	一个公式，用于根据评分器结果计算输出。	否
评估指标	枚举	要使用的评估指标。 `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.GraderStringCheck 或 OpenAI.GraderTextSimilarity 或 OpenAI.GraderPython 或 OpenAI.GraderScoreModel 或 OpenAI.GraderLabelModel	一个 StringCheckGrader 对象，该对象使用指定的操作在输入和参考之间执行字符串比较。	否
图像标签 (image_tag)	字符串	要用于 python 脚本的图像标记。	否
└─ 输入	数组	输入文本。这可能包括模板字符串。	否
└─ 模型	字符串	要用于评估的模型。	否
└─ 名称	字符串	评分程序的名称。	否
操作	枚举	要执行的字符串检查操作。 `eq`、`ne`、`like` 或 `ilike` 之一。可能的值：`eq`、`ne`、`like`、`ilike`	否
~~ 范围	数组	分数的范围。默认为 `[0, 1]`。	否
└─ 参考	字符串	作为评分参照的文本。	否
采样参数 (sampling_params)	OpenAI.EvalGraderScoreModelSamplingParams	模型的采样参数。	否
└─ 来源	字符串	python 脚本的源代码。	否
└─ 类型	枚举	始终为 `multi` 的对象类型。可能的值：`multi`	否
超参数	OpenAI.FineTuneReinforcementHyperparameters	用于强化微调作业的超参数。	否

OpenAI.FineTuneSupervisedHyperparameters

用于微调作业的超参数。

姓名	类型	Description	必选
批处理大小	枚举	可能的值：`auto`	否
学习率乘数 (learning_rate_multiplier)	枚举	可能的值：`auto`	否
n_epochs	枚举	可能的值：`auto`	否

OpenAI.FineTuneSupervisedMethod

监督式微调方法的配置。

姓名	类型	Description	必选	违约
超参数	OpenAI.FineTuneSupervisedHyperparameters	用于微调作业的超参数。	否

OpenAI.FineTuningIntegration

OpenAI.FineTuningIntegration 的鉴别器

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

类型值	Schema
`wandb`	OpenAI.FineTuningIntegrationWandb

姓名	类型	Description	必选	违约
类型	字符串（请参阅下面的有效模型）		是的

OpenAI.FineTuningIntegrationWandb

姓名	类型	Description	必选
类型	枚举	为微调作业启用的集成的类型可能的值：`wandb`	是的
wandb	对象	与权重和偏差集成的设置。此参数指定了用于接收指标的项目。或者，可以为运行设置一个明确的显示名称，为运行添加标签，并设置与运行相关联的默认实体（团队、用户名等）。	是的
└─ 实体	字符串	要用于运行的实体。这样，你可以设置与本次运行关联的 WandB 用户的团队或用户名。如果未设置，则使用已注册 WandB API 密钥的默认实体。	否
└─ 名称	字符串	要为运行设置的显示名称。如果未设置，我们将使用作业 ID 作为名称。	否
└─ 项目	字符串	将在其下创建新运行的项目名称。	否
└─ 标记	数组	要附加到新创建的运行的标记列表。这些标记将直接传递到 WandB。 Some 标记由 OpenAI 生成：“openai/finetune”、“openai/{base-model}”、“openai/{ftjob-abcdef}”。	否

OpenAI.FineTuningJob

fine_tuning.job 对象表示通过 API 创建的微调作业。

姓名	类型	Description	必选
创建时间	整数	创建微调作业时的 Unix 时间戳（以秒为单位）。	是的
错误	对象	对于 `failed` 的微调作业，这将包含失败原因的详细信息。	是的
└─ 代码	字符串	计算机可读的错误代码。	否
└─ 消息	字符串	用户可读的错误消息。	否
└─ 参数	字符串	无效的参数，通常为 `training_file` 或 `validation_file`。如果失败原因与特定参与无关，则此字段将为 null。	否
预计完成	整数	估计微调作业完成时的 Unix 时间戳（以秒为单位）。如果微调作业未运行，则该值将为 null。	否
fine_tuned_model	字符串	正在创建的微调模型的名称。如果微调作业仍在运行，则该值将为 null。	是的
完成于	整数	微调作业完成时的 Unix 时间戳（以秒为单位）。如果微调作业仍在运行，则该值将为 null。	是的
超参数	对象	用于微调作业的超参数。此值仅在运行 `supervised` 作业时返回。	是的
batch_size	枚举	可能的值：`auto`	否
学习率倍增器	枚举	可能的值：`auto`	否
n_epochs	枚举	可能的值：`auto`	否
id	字符串	可在 API 终结点中引用的对象标识符。	是的
integrations	数组	要为此微调作业启用的集成列表。	否
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	是的
方法	OpenAI.FineTuneMethod	用于微调的方法。	否
模型	字符串	正在微调的基础模型。	是的
对象	枚举	对象类型，始终为“fine_tuning.job”。可能的值：`fine_tuning.job`	是的
organization_id	字符串	拥有微调作业的组织。	是的
result_files	数组	微调作业的已编译结果文件 ID。可以使用文件 API 检索结果。	是的
seed	整数	用于微调作业的种子。	是的
状态	枚举	微调作业的当前状态，可以是 `validating_files`、`queued`、`running`、`succeeded`、`failed` 或 `cancelled`。可能的值：`validating_files`、、`queued`、`runningsucceeded`、`failed`、`cancelled`	是的
trained_tokens	整数	此微调作业处理的可计费令牌总数。如果微调作业仍在运行，则该值将为 null。	是的
训练文件	字符串	用于训练的文件 ID。可以使用文件 API 检索训练数据。	是的
user_provided_suffix	字符串	在作业创建请求中指定的、应用于该作业的描述性后缀。	否
验证文件	字符串	用于验证的文件 ID。可以使用文件 API 检索验证结果。	是的

OpenAI.FineTuningJobCheckpoint

fine_tuning.job.checkpoint 对象表示可供使用的微调作业的模型检查点。

姓名	类型	Description	必选
创建时间	整数	创建检查点时的 Unix 时间戳（以秒为单位）。	是的
调整好的模型检查点	字符串	创建的微调检查点模型的名称。	是的
微调任务ID (fine_tuning_job_id)	字符串	从中创建此检查点的微调作业的名称。	是的
id	字符串	可在 API 终结点中引用的检查点标识符。	是的
指标	对象	执行微调作业过程中对应步骤的指标数据。	是的
full_valid_loss	数字		否
full_valid_mean_token_accuracy（完整验证平均标记准确率）	数字		否
└─ 步骤	数字		否
训练损失	数字		否
训练平均标记准确率	数字		否
验证损失	数字		否
验证平均标记准确率	数字		否
对象	枚举	对象类型，始终为“fine_tuning.job.checkpoint”。可能的值：`fine_tuning.job.checkpoint`	是的
步骤编号	整数	创建检查点的步骤编号。	是的

OpenAI.FineTuningJobEvent

微调作业事件对象

姓名	类型	Description	必选
创建时间	整数	创建微调作业时的 Unix 时间戳（以秒为单位）。	是的
数据		与事件关联的数据。	否
id	字符串	对象标识符。	是的
水平仪	枚举	事件的日志级别。可能的值：`info`、、 `warnerror`	是的
消息	字符串	事件的消息。	是的
对象	枚举	对象类型，始终为“fine_tuning.job.event”。可能的值：`fine_tuning.job.event`	是的
类型	枚举	事件类型。可能的值： `messagemetrics`	否

OpenAI.FunctionObject

姓名	类型	Description	必选	违约
说明	字符串	函数作用的描述，由模型用于选择何时以及如何调用函数。	否
姓名	字符串	要调用的函数的名称。必须是 a-z、A-z、0-9，或包含下划线和短划线，最大长度为 64。	是的
参数		函数接受的参数，被描述为 JSON 架构对象。请参阅指南查看示例，参阅 JSON 架构参考查看有关格式的文档。省略 `parameters` 会定义具有空参数列表的函数。	否
strict	布尔	生成函数调用时是否启用严格的架构遵循。如果设置为 true，则模型将遵循 `parameters` 字段中定义的确切架构。当 `strict` 为 `true` 时仅支持 JSON 架构的子集。在中了解有关结构化输出的详细信息	否	假

OpenAI.FunctionTool

在自己的代码中定义模型可以选择调用的函数。

姓名	类型	Description	必选
说明	字符串	函数的说明。该模型用于判断是否调用函数。	否
姓名	字符串	要调用的函数名称。	是的
参数		描述函数参数的 JSON 架构对象。	是的
strict	布尔	是否强制实施严格的参数验证。默认 `true`。	是的
类型	枚举	函数工具的类型。始终为 `function`。可能的值：`function`	是的

OpenAI.FunctionToolCallItemParam

用于运行函数的工具调用。有关详细信息，请参阅函数调用指南。

姓名	类型	Description	必选
arguments	字符串	要传递给函数的参数的 JSON 字符串。	是的
call_id	字符串	模型生成的函数工具调用的唯一 ID。	是的
姓名	字符串	要运行的函数的名称。	是的
类型	枚举	可能的值：`function_call`	是的

OpenAI.FunctionToolCallItemResource

用于运行函数的工具调用。有关详细信息，请参阅函数调用指南。

姓名	类型	Description	必选
arguments	字符串	要传递给函数的参数的 JSON 字符串。	是的
call_id	字符串	模型生成的函数工具调用的唯一 ID。	是的
姓名	字符串	要运行的函数的名称。	是的
状态	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	是的
类型	枚举	可能的值：`function_call`	是的

OpenAI.FunctionToolCallOutputItemParam

函数工具调用的输出。

姓名	类型	Description	必选
call_id	字符串	模型生成的函数工具调用的唯一 ID。	是的
输出	字符串	函数工具调用输出的 JSON 字符串。	是的
类型	枚举	可能的值：`function_call_output`	是的

OpenAI.FunctionToolCallOutputItemResource

函数工具调用的输出。

姓名	类型	Description	必选
call_id	字符串	模型生成的函数工具调用的唯一 ID。	是的
输出	字符串	函数工具调用输出的 JSON 字符串。	是的
状态	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	是的
类型	枚举	可能的值：`function_call_output`	是的

OpenAI.GraderLabelModel

一个 LabelModelGrader 对象，该对象使用模型将标签分配给评估中的每个项。

姓名	类型	Description	必选
输入	数组		是的
labels	数组	要分配给评估中每个项的标签。	是的
模型	字符串	要用于评估的模型。必须支持结构化输出。	是的
姓名	字符串	评分程序的名称。	是的
passing_labels	数组	指示通过结果的标签。必须是标签的子集。	是的
类型	枚举	始终为 `label_model` 的对象类型。可能的值：`label_model`	是的

OpenAI.GraderMulti

多评分器对象将多评分器的输出相组合来生成一个分数。

姓名	类型	Description	必选
calculate_output	字符串	一个公式，用于根据评分器结果计算输出。	是的
评分器	对象	一个 StringCheckGrader 对象，该对象使用指定的操作在输入和参考之间执行字符串比较。	是的
评估指标	枚举	要使用的评估指标。 `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`	否
图像标签 (image_tag)	字符串	要用于 python 脚本的图像标记。	否
└─ 输入	数组		否
~~ 标签	数组	要分配给评估中每个项的标签。	否
└─ 模型	字符串	要用于评估的模型。必须支持结构化输出。	否
└─ 名称	字符串	评分程序的名称。	否
操作	枚举	要执行的字符串检查操作。 `eq`、`ne`、`like` 或 `ilike` 之一。可能的值：`eq`、`ne`、`like`、`ilike`	否
passing_labels	数组	指示通过结果的标签。必须是标签的子集。	否
~~ 范围	数组	分数的范围。默认为 `[0, 1]`。	否
└─ 参考	字符串	作为评分参照的文本。	否
采样参数 (sampling_params)	OpenAI.EvalGraderScoreModelSamplingParams	模型的采样参数。	否
└─ 来源	字符串	python 脚本的源代码。	否
└─ 类型	枚举	始终为 `label_model` 的对象类型。可能的值：`label_model`	否
姓名	字符串	评分程序的名称。	是的
类型	枚举	始终为 `multi` 的对象类型。可能的值：`multi`	是的

OpenAI.GraderPython

在输入上运行 python 脚本的 PythonGrader 对象。

姓名	类型	Description	必选
image_tag	字符串	要用于 python 脚本的图像标记。	否
姓名	字符串	评分程序的名称。	是的
源	字符串	python 脚本的源代码。	是的
类型	枚举	始终为 `python` 的对象类型。可能的值：`python`	是的

OpenAI.GraderScoreModel

一个 ScoreModelGrader 对象，该对象使用模型将分数分配给输入。

姓名	类型	Description	必选
输入	数组	输入文本。这可能包括模板字符串。	是的
模型	字符串	要用于评估的模型。	是的
姓名	字符串	评分程序的名称。	是的
范围	数组	分数的范围。默认为 `[0, 1]`。	否
采样参数	对象		否
max_completions_tokens	OpenAI.integer		否
推理努力	OpenAI.ReasoningEffort	限制推理模型的推理力度。当前支持的值为 none、minimal、low、medium 和 high。减少推理工作量可以加快回复速度，减少回复中用于推理的标记。 gpt-5.1 默认为 none，不执行推理。 gpt-5.1 支持的推理值为无、低、中和高。 gpt-5.1 中的所有推理值都支持工具调用。 gpt-5.1 之前的所有模型默认为中等推理工作量，并且不支持 none。 gpt-5-pro 模型默认为（仅支持）高推理工作量。	否
~~ 种子	OpenAI.integer		否
~~ 温度	OpenAI.numeric		否
top_p	OpenAI.numeric		否
类型	枚举	始终为 `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.ImageGenTool

使用类似 gpt-image-1模型生成图像的工具。

姓名	类型	Description	必选	违约
后台的	枚举	生成的图像的背景类型。 `transparent`、 `opaque` 或 `auto` 中的一项。默认值：`auto`。可能的值：`transparent`、、 `opaqueauto`	否
输入图像掩码	对象	用于修复的可选掩码。包含 `image_url` （字符串，可选）和 `file_id` （字符串，可选）。	否
file_id	字符串	掩码图像的文件 ID。	否
image_url	字符串	Base64 编码的掩码图像。	否
模型	枚举	要使用的图像生成模型。默认值：`gpt-image-1`。可能的值：`gpt-image-1`	否
moderation	枚举	生成图像的审核级别。默认值：`auto`。可能的值： `autolow`	否
输出压缩	整数	输出图像的压缩级别。默认值：100。	否	100
输出格式	枚举	生成的图像的输出格式。以下之一：`png`、`webp` 或 `jpeg`。默认值：`png`。可能的值：`png`、、 `webpjpeg`	否
部分图像	整数	在流式处理模式中可以生成的部分图像数量，从 0（默认值）到 3。	否	0
quality	枚举	生成的图像的质量。 `low`、`medium`、`high` 之一，或 `auto`。默认值：`auto`。可能的值：`low`、`medium`、`high`、`auto`	否
大小	枚举	生成的映像的大小。以下之一：`1024x1024`、`1024x1536`、 `1536x1024` 或 `auto` 中的一项。默认值：`auto`。可能的值：`1024x1024`、`1024x1536`、`1536x1024`、`auto`	否
类型	枚举	图像生成工具的类型。始终为 `image_generation`。可能的值：`image_generation`	是的

OpenAI.ImageGenToolCallItemParam

模型发出的图像生成请求。

姓名	类型	Description	必选	违约
结果	字符串	以 base64 编码生成的图像。	是的
类型	枚举	可能的值：`image_generation_call`	是的

OpenAI.ImageGenToolCallItemResource

模型发出的图像生成请求。

姓名	类型	Description	必选
结果	字符串	以 base64 编码生成的图像。	是的
状态	枚举	可能的值：`in_progress`、`completed`、`generating`、`failed`	是的
类型	枚举	可能的值：`image_generation_call`	是的

OpenAI.Includable

指定要包含在模型响应中的其他输出数据。当前支持的值包括：

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，或组织在零数据保留计划中注册时），多轮次对话中可以使用推理内容。

资产	价值
说明	指定要包含在模型响应中的其他输出数据。现在支持的值包括： - `code_interpreter_call.outputs`：在代码解释器工具调用项中包含 python 代码执行的输出。 - `computer_call_output.output.image_url`：包括计算机调用输出中的图像 URL。 - `file_search_call.results`：包括文件搜索工具的搜索结果。 - `message.input_image.image_url`：包括输入消息中的图像链接。 - `message.output_text.logprobs`：包括含协助消息的 logprob。 - `reasoning.encrypted_content`：包括推理的加密版本推理项目输出中的令牌。这样就可以在无状态使用响应 API 时，在多轮次对话中使用推理项（例如当参数 `store` 设置为 `false`，或当组织在零数据保留计划中注册时）。
类型	字符串
价值观	`code_interpreter_call.outputs` `computer_call_output.output.image_url` `file_search_call.results` `message.input_image.image_url` `message.output_text.logprobs` `reasoning.encrypted_content` `web_search_call.results` `web_search_call.action.sources` `memory_search_call.results`

OpenAI.ItemContent

OpenAI.ItemContent 的鉴别器

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

类型值	Schema
`input_audio`	OpenAI.ItemContentInputAudio
`output_audio`	OpenAI.ItemContentOutputAudio
`refusal`	OpenAI.ItemContentRefusal
`input_text`	OpenAI.ItemContentInputText
`input_image`	OpenAI.ItemContentInputImage
`input_file`	OpenAI.ItemContentInputFile
`output_text`	OpenAI.ItemContentOutputText

姓名	类型	Description	必选	违约
类型	OpenAI.ItemContentType	多模态输入和输出内容。	是的

OpenAI.ItemContentInputAudio

模型的音频输入。

姓名	类型	Description	必选
数据	字符串	Base64 编码的音频数据。	是的
格式	枚举	音频数据的格式。当前支持的格式包括 `mp3` 和 `wav`。可能的值： `mp3wav`	是的
类型	枚举	输入项的类型。始终为 `input_audio`。可能的值：`input_audio`	是的

OpenAI.ItemContentInputFile

模型的文件输入。

姓名	类型	Description	必选
file_data	字符串	要发送到模型的文件的内容。	否
file_id	字符串	要发送到模型的文件的 ID。	否
filename	字符串	要发送到模型的文件的名称。	否
类型	枚举	输入项的类型。始终为 `input_file`。可能的值：`input_file`	是的

OpenAI.ItemContentInputImage

输入到模型中的图像了解图像输入。

姓名	类型	Description	必选
detail	枚举	要发送到模型的图像的细节级别。 `high`、`low` 或 `auto` 之一。默认为 `auto`。可能的值：`low`、、 `highauto`	否
file_id	字符串	要发送到模型的文件的 ID。	否
image_url	字符串	图像的 URL 要发送到模型。数据 URL 中的完全限定 URL 或 base64 编码图像。	否
类型	枚举	输入项的类型。始终为 `input_image`。可能的值：`input_image`	是的

OpenAI.ItemContentInputText

模型的文本输入。

姓名	类型	Description	必选	违约
文本消息	字符串	模型的文本输入。	是的
类型	枚举	输入项的类型。始终为 `input_text`。可能的值：`input_text`	是的

OpenAI.ItemContentOutputAudio

模型的音频输出。

姓名	类型	Description	必选
数据	字符串	来自模型的 Base64 编码音频数据。	是的
脚本	字符串	来自模型的音频数据转录。	是的
类型	枚举	输出音频的类型。始终为 `output_audio`。可能的值：`output_audio`	是的

OpenAI.ItemContentOutputText

模型的文本输出。

姓名	类型	Description	必选
注释	数组	文本输出的注释。	是的
logprobs	数组		否
文本消息	字符串	模型的文本输出。	是的
类型	枚举	输出文本的类型。始终为 `output_text`。可能的值：`output_text`	是的

OpenAI.ItemContentRefusal

模型的拒绝。

姓名	类型	Description	必选	违约
拒绝	字符串	模型中的详细说明。	是的
类型	枚举	拒绝的类型。始终为 `refusal`。可能的值：`refusal`	是的

OpenAI.ItemContentType

多模态输入和输出内容。

资产	价值
说明	多模态输入和输出内容。
类型	字符串
价值观	`input_text` `input_audio` `input_image` `input_file` `output_text` `output_audio` `refusal`

OpenAI.ItemParam

用于生成响应的内容项。

OpenAI.ItemParam 的鉴别器

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

类型值	Schema
`message`	OpenAI.ResponsesMessageItemParam
`function_call_output`	OpenAI.FunctionToolCallOutputItemParam
`file_search_call`	OpenAI.FileSearchToolCallItemParam
`computer_call`	OpenAI.ComputerToolCallItemParam
`computer_call_output`	OpenAI.ComputerToolCallOutputItemParam
`web_search_call`	OpenAI.WebSearchToolCallItemParam
`function_call`	OpenAI.FunctionToolCallItemParam
`reasoning`	OpenAI.ReasoningItemParam
`item_reference`	OpenAI.ItemReferenceItemParam
`image_generation_call`	OpenAI.ImageGenToolCallItemParam
`code_interpreter_call`	OpenAI.CodeInterpreterToolCallItemParam
`local_shell_call`	OpenAI.LocalShellToolCallItemParam
`local_shell_call_output`	OpenAI.LocalShellToolCallOutputItemParam
`mcp_list_tools`	OpenAI.MCPListToolsItemParam
`mcp_approval_request`	OpenAI.MCPApprovalRequestItemParam
`mcp_approval_response`	OpenAI.MCPApprovalResponseItemParam
`mcp_call`	OpenAI.MCPCallItemParam
`memory_search_call`	MemorySearchToolCallItemParam

姓名	类型	Description	必选	违约
类型	OpenAI.ItemType		是的

OpenAI.ItemReferenceItemParam

要引用的项的内部标识符。

姓名	类型	Description	必选	违约
id	字符串	要引用的以前生成的响应项的服务发起的 ID。	是的
类型	枚举	可能的值：`item_reference`	是的

OpenAI.ItemResource

用于生成响应的内容项。

OpenAI.ItemResource 的鉴别器

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

类型值	Schema
`structured_outputs`	StructuredOutputsItemResource
`workflow_action`	WorkflowActionOutputItemResource
`oauth_consent_request`	OAuthConsentRequestItemResource
`message`	OpenAI.ResponsesMessageItemResource
`computer_call_output`	OpenAI.ComputerToolCallOutputItemResource
`function_call`	OpenAI.FunctionToolCallItemResource
`function_call_output`	OpenAI.FunctionToolCallOutputItemResource
`mcp_approval_response`	OpenAI.MCPApprovalResponseItemResource
`file_search_call`	OpenAI.FileSearchToolCallItemResource
`computer_call`	OpenAI.ComputerToolCallItemResource
`web_search_call`	OpenAI.WebSearchToolCallItemResource
`reasoning`	OpenAI.ReasoningItemResource
`image_generation_call`	OpenAI.ImageGenToolCallItemResource
`code_interpreter_call`	OpenAI.CodeInterpreterToolCallItemResource
`local_shell_call`	OpenAI.LocalShellToolCallItemResource
`local_shell_call_output`	OpenAI.LocalShellToolCallOutputItemResource
`mcp_list_tools`	OpenAI.MCPListToolsItemResource
`mcp_approval_request`	OpenAI.MCPApprovalRequestItemResource
`mcp_call`	OpenAI.MCPCallItemResource
`memory_search_call`	MemorySearchToolCallItemResource

姓名	类型	Description	必选
created_by	对象		否
~~ 代理	AgentId	创建项的代理。	否
response_id	字符串	创建项的响应。	否
id	字符串		是的
类型	OpenAI.ItemType		是的

OpenAI.ItemType

资产价值

类型字符串

价值观 message
file_search_call
function_call
function_call_output
computer_call
computer_call_output
web_search_call
reasoning
item_reference
image_generation_call
code_interpreter_call
local_shell_call
local_shell_call_output
mcp_list_tools
mcp_approval_request
mcp_approval_response
mcp_call
structured_outputs
workflow_action
memory_search_call
oauth_consent_request

OpenAI.ListFineTuningJobCheckpointsResponse

姓名	类型	Description	必选
数据	数组		是的
first_id	字符串		否
has_more	布尔		是的
last_id	字符串		否
对象	枚举	可能的值：`list`	是的

OpenAI.ListFineTuningJobEventsResponse

姓名	类型	Description	必选
数据	数组		是的
has_more	布尔		是的
对象	枚举	可能的值：`list`	是的

OpenAI.ListPaginatedFineTuningJobsResponse

姓名	类型	Description	必选
数据	数组		是的
has_more	布尔		是的
对象	枚举	可能的值：`list`	是的

OpenAI.LocalShellExecAction

在服务器上执行 shell 命令。

姓名	类型	Description	必选
指令	数组	要运行的命令。	是的
env	对象	要为命令设置的环境变量。	是的
timeout_ms	整数	命令的可选超时（以毫秒为单位）。	否
类型	枚举	本地 shell 操作的类型。始终为 `exec`。可能的值：`exec`	是的
用户	字符串	可选项：指定以哪个用户身份运行该命令。	否
working_directory	字符串	可选项：指定运行该命令的工作目录。	否

OpenAI.LocalShellTool

允许模型在本地环境中执行 shell 命令的工具。

姓名	类型	Description	必选	违约
类型	枚举	本地 shell 工具的类型。始终为 `local_shell`。可能的值：`local_shell`	是的

OpenAI.LocalShellToolCallItemParam

用于在本地 shell 上运行命令的工具调用。

姓名	类型	Description	必选
操作	OpenAI.LocalShellExecAction	在服务器上执行 shell 命令。	是的
call_id	字符串	模型生成的本地 shell 工具调用的唯一 ID。	是的
类型	枚举	可能的值：`local_shell_call`	是的

OpenAI.LocalShellToolCallItemResource

用于在本地 shell 上运行命令的工具调用。

姓名	类型	Description	必选
操作	OpenAI.LocalShellExecAction	在服务器上执行 shell 命令。	是的
call_id	字符串	模型生成的本地 shell 工具调用的唯一 ID。	是的
状态	枚举	可能的值：`in_progress`、、 `completedincomplete`	是的
类型	枚举	可能的值：`local_shell_call`	是的

OpenAI.LocalShellToolCallOutputItemParam

本地 shell 工具调用的输出。

姓名	类型	Description	必选	违约
输出	字符串	本地 shell 工具调用输出的 JSON 字符串。	是的
类型	枚举	可能的值：`local_shell_call_output`	是的

OpenAI.LocalShellToolCallOutputItemResource

本地 shell 工具调用的输出。

姓名	类型	Description	必选
输出	字符串	本地 shell 工具调用输出的 JSON 字符串。	是的
状态	枚举	可能的值：`in_progress`、、 `completedincomplete`	是的
类型	枚举	可能的值：`local_shell_call_output`	是的

OpenAI.Location

OpenAI.Location 的鉴别器

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

类型值	Schema
`approximate`	OpenAI.ApproximateLocation

姓名	类型	Description	必选	违约
类型	OpenAI.LocationType		是的

OpenAI.LocationType

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

OpenAI.LogProb

令牌的对数概率。

姓名	类型	必选
字节	数组	是的
logprob	数字	是的
代币	字符串	是的
top_logprobs	数组	是的

OpenAI.MCPApprovalRequestItemParam

请求人工批准工具调用。

姓名	类型	Description	必选
arguments	字符串	工具的参数的 JSON 字符串。	是的
姓名	字符串	要运行的工具的名称。	是的
服务器标签	字符串	发出请求的 MCP 服务器的标签。	是的
类型	枚举	可能的值：`mcp_approval_request`	是的

OpenAI.MCPApprovalRequestItemResource

请求人工批准工具调用。

姓名	类型	Description	必选
arguments	字符串	工具的参数的 JSON 字符串。	是的
姓名	字符串	要运行的工具的名称。	是的
服务器标签	字符串	发出请求的 MCP 服务器的标签。	是的
类型	枚举	可能的值：`mcp_approval_request`	是的

OpenAI.MCPApprovalResponseItemParam

对 MCP 审批请求的响应。

姓名	类型	Description	必选
approval_request_id	字符串	正在应答的审批请求的 ID。	是的
批准	布尔	请求是否已获得批准。	是的
原因	字符串	决定的可选原因。	否
类型	枚举	可能的值：`mcp_approval_response`	是的

OpenAI.MCPApprovalResponseItemResource

对 MCP 审批请求的响应。

姓名	类型	Description	必选
approval_request_id	字符串	正在应答的审批请求的 ID。	是的
批准	布尔	请求是否已获得批准。	是的
原因	字符串	决定的可选原因。	否
类型	枚举	可能的值：`mcp_approval_response`	是的

OpenAI.MCPCallItemParam

在 MCP 服务器上调用工具。

姓名	类型	Description	必选
arguments	字符串	传递给工具的参数的 JSON 字符串。	是的
错误	字符串	工具调用中的错误（如果有）。	否
姓名	字符串	运行的工具的名称。	是的
输出	字符串	工具调用的输出。	否
服务器标签	字符串	运行该工具的 MCP 服务器的标签。	是的
类型	枚举	可能的值：`mcp_call`	是的

OpenAI.MCPCallItemResource

在 MCP 服务器上调用工具。

姓名	类型	Description	必选
arguments	字符串	传递给工具的参数的 JSON 字符串。	是的
错误	字符串	工具调用中的错误（如果有）。	否
姓名	字符串	运行的工具的名称。	是的
输出	字符串	工具调用的输出。	否
服务器标签	字符串	运行该工具的 MCP 服务器的标签。	是的
类型	枚举	可能的值：`mcp_call`	是的

OpenAI.MCPListToolsItemParam

MCP 服务器上可用的工具列表。

姓名	类型	Description	必选
错误	字符串	如果服务器无法列出工具，则显示错误消息。	否
服务器标签	字符串	MCP 服务器的标签。	是的
工具	数组	服务器上可用的工具。	是的
类型	枚举	可能的值：`mcp_list_tools`	是的

OpenAI.MCPListToolsItemResource

MCP 服务器上可用的工具列表。

姓名	类型	Description	必选
错误	字符串	如果服务器无法列出工具，则显示错误消息。	否
服务器标签	字符串	MCP 服务器的标签。	是的
工具	数组	服务器上可用的工具。	是的
类型	枚举	可能的值：`mcp_list_tools`	是的

OpenAI.MCPListToolsTool

MCP 服务器上可用的工具。

姓名	类型	Description	必选
注释		有关该工具的其他注释。	否
说明	字符串	工具的说明。	否
input_schema		描述工具输入的 JSON 架构。	是的
姓名	字符串	工具的名称。	是的

OpenAI.MCPTool

通过远程模型上下文协议（MCP）服务器向模型授予对其他工具的访问权限。了解有关 MCP 的更多信息。

姓名	类型	Description	必选
允许的工具	对象		否
tool_names	数组	允许的工具名称列表。	否
标题	对象	要发送到 MCP 服务器的可选 HTTP 标头。用于身份验证或其他目的。	否
project_connection_id	字符串	MCP 服务器项目中的连接 ID。该连接存储连接到 MCP 服务器所需的身份验证和其他连接详细信息。	否
需要审批	对象（请参阅下面的有效模型）	指定哪些 MCP 服务器工具需要批准。	否
服务器标签	字符串	此 MCP 服务器的标签，用于在工具调用中标识它。	是的
server_url（服务器网址）	字符串	MCP 服务器的 URL。	是的
类型	枚举	MCP 工具的类型。始终为 `mcp`。可能的值：`mcp`	是的

OpenAI.Metadata

按 16 个成组的可附加到对象的键值对。这可用于以结构化格式存储有关对象的其他信息，以及通过 API 或仪表板查询对象。

键是最大长度为 64 个字符的字符串。值为最大长度为 512 个字符的字符串。

类型：对象

OpenAI.Prompt

对提示模板及其变量的引用。了解详细信息。

姓名	类型	Description	必选
id	字符串	要使用的提示模板的唯一标识符。	是的
变量	对象	可选的值映射，用于替换提示中的变量。替换值可以是字符串，也可以是其他响应输入类型，如图像或文件。	否
版本	字符串	提示模板的可选版本。	否

OpenAI.RankingOptions

姓名	类型	Description	必选	违约
排名程序	枚举	用于文件搜索的排序算法。可能的值： `autodefault-2024-11-15`	否
分数阈值	数字	文件搜索的分数阈值，介于 0 和 1 之间。接近 1 的数字将尝试仅返回最相关的结果，但可能会返回更少的结果。	否

OpenAI.Reasoning

仅适用于 O 系列模型

推理模型的配置选项。

姓名	类型	Description	必选
工作量	对象	限制推理模型的推理力度。当前支持的值为 none、minimal、low、medium 和 high。减少推理工作量可以加快回复速度，减少回复中用于推理的标记。 gpt-5.1 默认为 none，不执行推理。 gpt-5.1 支持的推理值为无、低、中和高。 gpt-5.1 中的所有推理值都支持工具调用。 gpt-5.1 之前的所有模型默认为中等推理工作量，并且不支持 none。 gpt-5-pro 模型默认为（仅支持）高推理工作量。	否
generate_summary	枚举	已弃用：请改用`summary`。模型执行的推理摘要。这对于调试和了解模型的推理过程非常有用。 `auto`、`concise` 或 `detailed` 之一。可能的值：`auto`、、 `concisedetailed`	否
摘要	枚举	模型执行的推理摘要。这可以是可用于调试和了解模型的推理过程。 `auto`、`concise` 或 `detailed` 之一。可能的值：`auto`、、 `concisedetailed`	否

OpenAI.ReasoningEffort

限制推理模型的推理力度。

当前支持的值为 none、minimal、low、medium 和 high。

减少推理工作量可以加快回复速度，减少回复中用于推理的标记。

gpt-5.1 默认为 none，不执行推理。 gpt-5.1 支持的推理值为无、低、中和高。 gpt-5.1 中的所有推理值都支持工具调用。

gpt-5.1 之前的所有模型默认为中等推理工作量，并且不支持 none。

gpt-5-pro 模型默认为（仅支持）高推理工作量。

资产	价值
说明	限制推理模型的推理力度。当前支持的值为 none、minimal、low、medium 和 high。减少推理工作量可以加快回复速度，减少回复中用于推理的标记。 gpt-5.1 默认为 none，不执行推理。 gpt-5.1 支持的推理值为无、低、中和高。 gpt-5.1 中的所有推理值都支持工具调用。 gpt-5.1 之前的所有模型默认为中等推理工作量，并且不支持 none。 gpt-5-pro 模型默认为（仅支持）高推理工作量。
类型	字符串
价值观	`none` `minimal` `low` `medium` `high`

OpenAI.ReasoningItemParam

描述推理模型在生成响应时使用的想法链。如果要手动input，请务必将这些项目包含在 to Responses API 中，以便后续对话。

姓名	类型	Description	必选
encrypted_content	字符串	推理项的加密内容 - 在在 `reasoning.encrypted_content` 参数中使用 `include` 生成响应时填充。	否
摘要	数组	推理文本内容。	是的
类型	枚举	可能的值：`reasoning`	是的

OpenAI.ReasoningItemResource

描述推理模型在生成响应时使用的想法链。如果要手动input，请务必将这些项目包含在 to Responses API 中，以便后续对话。

姓名	类型	Description	必选
encrypted_content	字符串	推理项的加密内容 - 在在 `reasoning.encrypted_content` 参数中使用 `include` 生成响应时填充。	否
摘要	数组	推理文本内容。	是的
类型	枚举	可能的值：`reasoning`	是的

OpenAI.ReasoningItemSummaryPart

OpenAI.ReasoningItemSummaryPart 的鉴别器

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

类型值	Schema
`summary_text`	OpenAI.ReasoningItemSummaryTextPart

姓名	类型	Description	必选	违约
类型	OpenAI.ReasoningItemSummaryPartType		是的

OpenAI.ReasoningItemSummaryPartType

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

OpenAI.ReasoningItemSummaryTextPart

姓名	类型	Description	必选	违约
文本消息	字符串		是的
类型	枚举	可能的值：`summary_text`	是的

OpenAI.Response

姓名	类型	Description	必选	违约
代理	对象		否
└─ 名称	字符串	代理的名称。	否
└─ 类型	枚举	可能的值：`agent_id`	否
└─ 版本	字符串	代理的版本标识符。	否
后台的	布尔	是否在后台运行模型响应。详细了解后台响应。	否	假
对话	对象		是的
└─ 身份	字符串		否
创建时间	整数	创建此响应时的 Unix 时间戳（以秒为单位）。	是的
错误	对象	当模型无法生成响应时返回的错误对象。	是的
└─ 代码	OpenAI.ResponseErrorCode	响应的错误代码。	否
└─ 消息	字符串	可读的错误说明。	否
id	字符串	此响应的唯一标识符。	是的
incomplete_details	对象	有关响应不完整的原因的详细信息。	是的
~~ 原因	枚举	响应不够详尽的原因。可能的值： `max_output_tokenscontent_filter`	否
instructions	字符串或数组		是的
max_output_tokens	整数	可为响应生成的令牌数上限，包括可见输出令牌和推理令牌。	否
max_tool_calls	整数	响应中可以处理的内置工具的最大调用次数。此最大调用次数适用于所有内置工具调用，而非单个工具的调用。模型对任何工具的后续调用尝试都将被忽略。	否
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	是的
模型	字符串	用于创建此响应的模型部署。	否
对象	枚举	此资源的对象类型 - 始终设置为 `response`。可能的值：`response`	是的
输出	数组	模型生成的内容项数组。 - 数组中 `output` 项的长度和顺序取决于于模型的响应。 - 与其访问 `output` 数组中的第一项并假设它是包含模型生成内容的 `assistant` 消息，可以考虑在 SDK 中支持的位置使用 `output_text` 属性。	是的
output_text	字符串	仅限 SDK 的便利属性，其中包含来自 `output_text` 数组中的所有 `output` 项聚合的文本输出（如果有）。 Python 和 JavaScript SDK 中受支持。	否
并行工具调用	布尔	是否允许模型并行运行工具调用。	是的	真实
previous_response_id	字符串	对模型的上一个响应的唯一 ID。用它创建多轮对话。详细了解管理聊天状态。	否
提示	对象	对提示模板及其变量的引用。了解详细信息。	否
└─ 身份	字符串	要使用的提示模板的唯一标识符。	否
~~ 变量	OpenAI.ResponsePromptVariables	可选的值映射，用于替换提示中的变量。替换值可以是字符串，也可以是其他响应输入类型，如图像或文件。	否
└─ 版本	字符串	提示模板的可选版本。	否
reasoning	对象	仅适用于 O 系列模型推理模型的配置选项。	否
努力	OpenAI.ReasoningEffort	限制推理模型的推理力度。当前支持的值为 none、minimal、low、medium 和 high。减少推理工作量可以加快回复速度，减少回复中用于推理的标记。 gpt-5.1 默认为 none，不执行推理。 gpt-5.1 支持的推理值为无、低、中和高。 gpt-5.1 中的所有推理值都支持工具调用。 gpt-5.1 之前的所有模型默认为中等推理工作量，并且不支持 none。 gpt-5-pro 模型默认为（仅支持）高推理工作量。	否
生成摘要	枚举	已弃用：请改用`summary`。模型执行的推理摘要。这对于调试和了解模型的推理过程非常有用。 `auto`、`concise` 或 `detailed` 之一。可能的值：`auto`、、 `concisedetailed`	否
~~ 摘要	枚举	模型执行的推理摘要。这可以是可用于调试和了解模型的推理过程。 `auto`、`concise` 或 `detailed` 之一。可能的值：`auto`、、 `concisedetailed`	否
服务等级	对象	指定用于为请求提供服务的处理类型。 * 如果设置为“auto”，则将使用服务层处理请求在 Project 设置中配置。除非另有配置，否则项目将使用“default”。 * 如果设置为“default”，则将使用标准处理请求所选模型的定价和性能。 * 如果设置为“flex” 或“priority”，则请求将与相应的服务一起处理层。请联系销售人员了解有关优先级处理的详细信息。 * 如果未设置，默认行为为“auto”。 `service_tier`设置参数后，响应正文将包含`service_tier` 基于实际用于处理请求的处理模式的值。此响应值可能与参数中设置的值不同。	否
状态	枚举	响应生成的状态。以下之一：`completed`、`failed`、 `in_progress`、`cancelled`、`queued` 或 `incomplete`。可能的值：`completed`、、`failed`、`in_progresscancelled`、`queued`、`incomplete`	否
structured_inputs	对象	可以参与提示模板替换或工具参数绑定的响应的结构化输入。	否
温度	数字	要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性我们通常建议更改此设置或 `top_p`，但不要同时更改两者。	是的
文本消息	对象	来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。请参阅文本输入和输出和结构化输出	否
└─ 格式	OpenAI.ResponseTextFormatConfiguration		否
tool_choice	对象	控制模型调用哪些工具（如有）。 `none` 表示模型不会调用任何工具，而是生成消息。 `auto` 表示模型可以在生成消息或调用一个消息之间进行选择更多工具。 `required` 表示模型必须调用一个或多个工具。	否
└─ 类型	OpenAI.ToolChoiceObjectType	指示模型应使用内置工具生成响应。详细了解内置工具。	否
工具	数组	生成响应时，模型可能会调用的工具数组。你可以通过设置 `tool_choice` 参数来指定要使用的工具。可以提供模型的两类工具包括： * 内置工具：OpenAI 提供的工具，用于扩展模型的功能，如 Web 搜索或文件搜索。详细了解内置工具。 * 函数调用（自定义工具）：由你定义的函数，使模型能够调用自己的代码。详细了解函数调用。	否
top_logprobs	整数	一个介于 0 和 20 之间的整数，指定在每个标记位置最有可能返回的的标记数，每个都有关联的对数概率。	否
top_p	数字	使用温度进行采样的替代方法，称为核采样，其中，模型考虑具有 top_p 概率质量的令牌的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。我们通常建议更改此设置或 `temperature`，但不要同时更改两者。	是的
truncation	枚举	要用于模型响应的截断策略。 - `auto`：如果此响应和以前的响应上下文超过模型的上下文窗口大小，模型将截断响应以适应上下文窗口，方法是在对话中删除输入项。 - `disabled`（默认值）：如果模型响应将超过上下文窗口模型的大小，请求将失败并出现 400 错误。可能的值： `autodisabled`	否
使用情况	OpenAI.ResponseUsage	表示令牌使用情况详细信息，包括输入令牌、输出令牌、输出令牌的细分以及所使用的令牌总数。	否
用户	字符串	详细了解安全最佳做法。	是的

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

由代码解释器流式传输部分代码片段时发出。

姓名	类型	Description	必选
三角洲	字符串	代码解释器正在流式传输的部分代码片段。	是的
item_id	字符串	代码解释器工具调用项的唯一标识符。	是的
output_index	整数	响应中正在流式传输代码的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.code_interpreter_call_code.delta`。可能的值：`response.code_interpreter_call_code.delta`	是的

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

当代码片段由代码解释器完成时发出。

姓名	类型	Description	必选
代码	字符串	代码解释器输出的最终代码片段。	是的
item_id	字符串	代码解释器工具调用项的唯一标识符。	是的
output_index	整数	代码已最终确定的响应中的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.code_interpreter_call_code.done`。可能的值：`response.code_interpreter_call_code.done`	是的

OpenAI.ResponseCodeInterpreterCallCompletedEvent

在代码解释器调用完成时发出。

姓名	类型	Description	必选
item_id	字符串	代码解释器工具调用项的唯一标识符。	是的
output_index	整数	代码解释器调用已完成的响应中的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.code_interpreter_call.completed`。可能的值：`response.code_interpreter_call.completed`	是的

OpenAI.ResponseCodeInterpreterCallInProgressEvent

代码解释器调用正在进行时发出。

姓名	类型	Description	必选
item_id	字符串	代码解释器工具调用项的唯一标识符。	是的
output_index	整数	代码解释器正在调用的响应中的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.code_interpreter_call.in_progress`。可能的值：`response.code_interpreter_call.in_progress`	是的

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

当代码解释器主动解释代码片段时发出。

姓名	类型	Description	必选
item_id	字符串	代码解释器工具调用项的唯一标识符。	是的
output_index	整数	代码解释器正在解释代码的响应中的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.code_interpreter_call.interpreting`。可能的值：`response.code_interpreter_call.interpreting`	是的

OpenAI.ResponseCompletedEvent

模型响应完成时发出。

姓名	类型	Description	必选	违约
response	对象		是的
~~ 代理	AgentId	用于此响应的代理	否
~~ 背景	布尔	是否在后台运行模型响应。详细了解后台响应。	否	假
~~ 对话	对象		否
└─ 身份	字符串		否
created_at	整数	创建此响应时的 Unix 时间戳（以秒为单位）。	否
~~ 错误	OpenAI.ResponseError	当模型无法生成响应时返回的错误对象。	否
└─ 身份	字符串	此响应的唯一标识符。	否
不完整的详细信息	对象	有关响应不完整的原因的详细信息。	否
~~ 原因	枚举	响应不够详尽的原因。可能的值： `max_output_tokenscontent_filter`	否
└─ 说明	字符串或数组	插入到模型上下文中的系统（或开发人员）消息。当与 `previous_response_id` 一起使用时，先前的响应的指令不会传递到下一个响应。这使得它变得简单在新的响应中交换系统（或开发人员）消息。	否
max_output_tokens（最大输出标记数）	整数	可为响应生成的令牌数上限，包括可见输出令牌和推理令牌。	否
max_tool_calls	整数	响应中可以处理的内置工具的最大调用次数。此最大调用次数适用于所有内置工具调用，而非单个工具的调用。模型对任何工具的后续调用尝试都将被忽略。	否
└─ 元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
└─ 模型	字符串	用于创建此响应的模型部署。	否
~~ 对象	枚举	此资源的对象类型 - 始终设置为 `response`。可能的值：`response`	否
└─ 输出	数组	模型生成的内容项数组。 - 数组中 `output` 项的长度和顺序取决于于模型的响应。 - 与其访问 `output` 数组中的第一项并假设它是包含模型生成内容的 `assistant` 消息，可以考虑在 SDK 中支持的位置使用 `output_text` 属性。	否
输出文本	字符串	仅限 SDK 的便利属性，其中包含来自 `output_text` 数组中的所有 `output` 项聚合的文本输出（如果有）。 Python 和 JavaScript SDK 中受支持。	否
并行工具调用	布尔	是否允许模型并行运行工具调用。	否	真实
previous_response_id	字符串	对模型的上一个响应的唯一 ID。用它创建多轮对话。详细了解管理聊天状态。	否
└─ 提示	OpenAI.Prompt	对提示模板及其变量的引用。了解详细信息。	否
└─推理	OpenAI.Reasoning	仅适用于 O 系列模型推理模型的配置选项。	否
service_tier	OpenAI.ServiceTier	注意：service_tier不适用于 Azure OpenAI。	否
└─ 状态	枚举	响应生成的状态。以下之一：`completed`、`failed`、 `in_progress`、`cancelled`、`queued` 或 `incomplete`。可能的值：`completed`、、`failed`、`in_progresscancelled`、`queued`、`incomplete`	否
structured_inputs	对象	可以参与提示模板替换或工具参数绑定的响应的结构化输入。	否
~~ 温度	数字	要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性我们通常建议更改此设置或 `top_p`，但不要同时更改两者。	否
└─ 文本	对象	来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。请参阅文本输入和输出和结构化输出	否
└─ 格式	OpenAI.ResponseTextFormatConfiguration		否
工具选择	OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceObject	模型在生成时应如何选择要使用的工具（或工具）响应。 `tools`请参阅参数，了解如何指定哪些工具模型可以调用。	否
└─ 工具	数组	生成响应时，模型可能会调用的工具数组。你可以通过设置 `tool_choice` 参数来指定要使用的工具。可以提供模型的两类工具包括： * 内置工具：OpenAI 提供的工具，用于扩展模型的功能，如 Web 搜索或文件搜索。详细了解内置工具。 * 函数调用（自定义工具）：由你定义的函数，使模型能够调用自己的代码。详细了解函数调用。	否
top_logprobs	整数	一个介于 0 和 20 之间的整数，指定在每个标记位置最有可能返回的的标记数，每个都有关联的对数概率。	否
top_p	数字	使用温度进行采样的替代方法，称为核采样，其中，模型考虑具有 top_p 概率质量的令牌的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。我们通常建议更改此设置或 `temperature`，但不要同时更改两者。	否
└─ 截断	枚举	要用于模型响应的截断策略。 - `auto`：如果此响应和以前的响应上下文超过模型的上下文窗口大小，模型将截断响应以适应上下文窗口，方法是在对话中删除输入项。 - `disabled`（默认值）：如果模型响应将超过上下文窗口模型的大小，请求将失败并出现 400 错误。可能的值： `autodisabled`	否
└─ 用法	OpenAI.ResponseUsage	表示令牌使用情况详细信息，包括输入令牌、输出令牌、输出令牌的细分以及所使用的令牌总数。	否
└─ 用户	字符串	详细了解安全最佳做法。	否
类型	枚举	事件类型。始终为 `response.completed`。可能的值：`response.completed`	是的

OpenAI.ResponseContentPartAddedEvent

添加新内容部分时发出。

姓名	类型	Description	必选
content_index	整数	已添加的内容部分的索引。	是的
item_id	字符串	将内容部分添加到的输出项的 ID。	是的
output_index	整数	将内容部分添加到的输出项的索引。	是的
部件	对象		是的
└─ 类型	OpenAI.ItemContentType	多模态输入和输出内容。	否
类型	枚举	事件类型。始终为 `response.content_part.added`。可能的值：`response.content_part.added`	是的

OpenAI.ResponseContentPartDoneEvent

完成内容部分时发出。

姓名	类型	Description	必选
content_index	整数	完成的内容部分的索引。	是的
item_id	字符串	将内容部分添加到的输出项的 ID。	是的
output_index	整数	将内容部分添加到的输出项的索引。	是的
部件	对象		是的
└─ 类型	OpenAI.ItemContentType	多模态输入和输出内容。	否
类型	枚举	事件类型。始终为 `response.content_part.done`。可能的值：`response.content_part.done`	是的

OpenAI.ResponseCreatedEvent

创建响应时发出的事件。

姓名	类型	Description	必选	违约
response	对象		是的
~~ 代理	AgentId	用于此响应的代理	否
~~ 背景	布尔	是否在后台运行模型响应。详细了解后台响应。	否	假
~~ 对话	对象		否
└─ 身份	字符串		否
created_at	整数	创建此响应时的 Unix 时间戳（以秒为单位）。	否
~~ 错误	OpenAI.ResponseError	当模型无法生成响应时返回的错误对象。	否
└─ 身份	字符串	此响应的唯一标识符。	否
不完整的详细信息	对象	有关响应不完整的原因的详细信息。	否
~~ 原因	枚举	响应不够详尽的原因。可能的值： `max_output_tokenscontent_filter`	否
└─ 说明	字符串或数组	插入到模型上下文中的系统（或开发人员）消息。当与 `previous_response_id` 一起使用时，先前的响应的指令不会传递到下一个响应。这使得它变得简单在新的响应中交换系统（或开发人员）消息。	否
max_output_tokens（最大输出标记数）	整数	可为响应生成的令牌数上限，包括可见输出令牌和推理令牌。	否
max_tool_calls	整数	响应中可以处理的内置工具的最大调用次数。此最大调用次数适用于所有内置工具调用，而非单个工具的调用。模型对任何工具的后续调用尝试都将被忽略。	否
└─ 元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
└─ 模型	字符串	用于创建此响应的模型部署。	否
~~ 对象	枚举	此资源的对象类型 - 始终设置为 `response`。可能的值：`response`	否
└─ 输出	数组	模型生成的内容项数组。 - 数组中 `output` 项的长度和顺序取决于于模型的响应。 - 与其访问 `output` 数组中的第一项并假设它是包含模型生成内容的 `assistant` 消息，可以考虑在 SDK 中支持的位置使用 `output_text` 属性。	否
输出文本	字符串	仅限 SDK 的便利属性，其中包含来自 `output_text` 数组中的所有 `output` 项聚合的文本输出（如果有）。 Python 和 JavaScript SDK 中受支持。	否
并行工具调用	布尔	是否允许模型并行运行工具调用。	否	真实
previous_response_id	字符串	对模型的上一个响应的唯一 ID。用它创建多轮对话。详细了解管理聊天状态。	否
└─ 提示	OpenAI.Prompt	对提示模板及其变量的引用。了解详细信息。	否
└─推理	OpenAI.Reasoning	仅适用于 O 系列模型推理模型的配置选项。	否
service_tier	OpenAI.ServiceTier	注意：service_tier不适用于 Azure OpenAI。	否
└─ 状态	枚举	响应生成的状态。以下之一：`completed`、`failed`、 `in_progress`、`cancelled`、`queued` 或 `incomplete`。可能的值：`completed`、、`failed`、`in_progresscancelled`、`queued`、`incomplete`	否
structured_inputs	对象	可以参与提示模板替换或工具参数绑定的响应的结构化输入。	否
~~ 温度	数字	要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性我们通常建议更改此设置或 `top_p`，但不要同时更改两者。	否
└─ 文本	对象	来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。请参阅文本输入和输出和结构化输出	否
└─ 格式	OpenAI.ResponseTextFormatConfiguration		否
工具选择	OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceObject	模型在生成时应如何选择要使用的工具（或工具）响应。 `tools`请参阅参数，了解如何指定哪些工具模型可以调用。	否
└─ 工具	数组	生成响应时，模型可能会调用的工具数组。你可以通过设置 `tool_choice` 参数来指定要使用的工具。可以提供模型的两类工具包括： * 内置工具：OpenAI 提供的工具，用于扩展模型的功能，如 Web 搜索或文件搜索。详细了解内置工具。 * 函数调用（自定义工具）：由你定义的函数，使模型能够调用自己的代码。详细了解函数调用。	否
top_logprobs	整数	一个介于 0 和 20 之间的整数，指定在每个标记位置最有可能返回的的标记数，每个都有关联的对数概率。	否
top_p	数字	使用温度进行采样的替代方法，称为核采样，其中，模型考虑具有 top_p 概率质量的令牌的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。我们通常建议更改此设置或 `temperature`，但不要同时更改两者。	否
└─ 截断	枚举	要用于模型响应的截断策略。 - `auto`：如果此响应和以前的响应上下文超过模型的上下文窗口大小，模型将截断响应以适应上下文窗口，方法是在对话中删除输入项。 - `disabled`（默认值）：如果模型响应将超过上下文窗口模型的大小，请求将失败并出现 400 错误。可能的值： `autodisabled`	否
└─ 用法	OpenAI.ResponseUsage	表示令牌使用情况详细信息，包括输入令牌、输出令牌、输出令牌的细分以及所使用的令牌总数。	否
└─ 用户	字符串	详细了解安全最佳做法。	否
类型	枚举	事件类型。始终为 `response.created`。可能的值：`response.created`	是的

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	必选
代码	字符串	错误代码。	是的
消息	字符串	错误消息。	是的
param	字符串	错误参数。	是的
类型	枚举	事件类型。始终为 `error`。可能的值：`error`	是的

OpenAI.ResponseFailedEvent

响应失败时发出的事件。

姓名	类型	Description	必选	违约
response	对象		是的
~~ 代理	AgentId	用于此响应的代理	否
~~ 背景	布尔	是否在后台运行模型响应。详细了解后台响应。	否	假
~~ 对话	对象		否
└─ 身份	字符串		否
created_at	整数	创建此响应时的 Unix 时间戳（以秒为单位）。	否
~~ 错误	OpenAI.ResponseError	当模型无法生成响应时返回的错误对象。	否
└─ 身份	字符串	此响应的唯一标识符。	否
不完整的详细信息	对象	有关响应不完整的原因的详细信息。	否
~~ 原因	枚举	响应不够详尽的原因。可能的值： `max_output_tokenscontent_filter`	否
└─ 说明	字符串或数组	插入到模型上下文中的系统（或开发人员）消息。当与 `previous_response_id` 一起使用时，先前的响应的指令不会传递到下一个响应。这使得它变得简单在新的响应中交换系统（或开发人员）消息。	否
max_output_tokens（最大输出标记数）	整数	可为响应生成的令牌数上限，包括可见输出令牌和推理令牌。	否
max_tool_calls	整数	响应中可以处理的内置工具的最大调用次数。此最大调用次数适用于所有内置工具调用，而非单个工具的调用。模型对任何工具的后续调用尝试都将被忽略。	否
└─ 元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
└─ 模型	字符串	用于创建此响应的模型部署。	否
~~ 对象	枚举	此资源的对象类型 - 始终设置为 `response`。可能的值：`response`	否
└─ 输出	数组	模型生成的内容项数组。 - 数组中 `output` 项的长度和顺序取决于于模型的响应。 - 与其访问 `output` 数组中的第一项并假设它是包含模型生成内容的 `assistant` 消息，可以考虑在 SDK 中支持的位置使用 `output_text` 属性。	否
输出文本	字符串	仅限 SDK 的便利属性，其中包含来自 `output_text` 数组中的所有 `output` 项聚合的文本输出（如果有）。 Python 和 JavaScript SDK 中受支持。	否
并行工具调用	布尔	是否允许模型并行运行工具调用。	否	真实
previous_response_id	字符串	对模型的上一个响应的唯一 ID。用它创建多轮对话。详细了解管理聊天状态。	否
└─ 提示	OpenAI.Prompt	对提示模板及其变量的引用。了解详细信息。	否
└─推理	OpenAI.Reasoning	仅适用于 O 系列模型推理模型的配置选项。	否
service_tier	OpenAI.ServiceTier	注意：service_tier不适用于 Azure OpenAI。	否
└─ 状态	枚举	响应生成的状态。以下之一：`completed`、`failed`、 `in_progress`、`cancelled`、`queued` 或 `incomplete`。可能的值：`completed`、、`failed`、`in_progresscancelled`、`queued`、`incomplete`	否
structured_inputs	对象	可以参与提示模板替换或工具参数绑定的响应的结构化输入。	否
~~ 温度	数字	要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性我们通常建议更改此设置或 `top_p`，但不要同时更改两者。	否
└─ 文本	对象	来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。请参阅文本输入和输出和结构化输出	否
└─ 格式	OpenAI.ResponseTextFormatConfiguration		否
工具选择	OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceObject	模型在生成时应如何选择要使用的工具（或工具）响应。 `tools`请参阅参数，了解如何指定哪些工具模型可以调用。	否
└─ 工具	数组	生成响应时，模型可能会调用的工具数组。你可以通过设置 `tool_choice` 参数来指定要使用的工具。可以提供模型的两类工具包括： * 内置工具：OpenAI 提供的工具，用于扩展模型的功能，如 Web 搜索或文件搜索。详细了解内置工具。 * 函数调用（自定义工具）：由你定义的函数，使模型能够调用自己的代码。详细了解函数调用。	否
top_logprobs	整数	一个介于 0 和 20 之间的整数，指定在每个标记位置最有可能返回的的标记数，每个都有关联的对数概率。	否
top_p	数字	使用温度进行采样的替代方法，称为核采样，其中，模型考虑具有 top_p 概率质量的令牌的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。我们通常建议更改此设置或 `temperature`，但不要同时更改两者。	否
└─ 截断	枚举	要用于模型响应的截断策略。 - `auto`：如果此响应和以前的响应上下文超过模型的上下文窗口大小，模型将截断响应以适应上下文窗口，方法是在对话中删除输入项。 - `disabled`（默认值）：如果模型响应将超过上下文窗口模型的大小，请求将失败并出现 400 错误。可能的值： `autodisabled`	否
└─ 用法	OpenAI.ResponseUsage	表示令牌使用情况详细信息，包括输入令牌、输出令牌、输出令牌的细分以及所使用的令牌总数。	否
└─ 用户	字符串	详细了解安全最佳做法。	否
类型	枚举	事件类型。始终为 `response.failed`。可能的值：`response.failed`	是的

OpenAI.ResponseFileSearchCallCompletedEvent

在文件搜索调用完成时发出（找到结果）。

姓名	类型	Description	必选
item_id	字符串	启动文件搜索调用的输出项的 ID。	是的
output_index	整数	启动文件搜索调用的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.file_search_call.completed`。可能的值：`response.file_search_call.completed`	是的

OpenAI.ResponseFileSearchCallInProgressEvent

在启动文件搜索调用时发出。

姓名	类型	Description	必选
item_id	字符串	启动文件搜索调用的输出项的 ID。	是的
output_index	整数	启动文件搜索调用的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.file_search_call.in_progress`。可能的值：`response.file_search_call.in_progress`	是的

OpenAI.ResponseFileSearchCallSearchingEvent

当文件搜索当前正在搜索时发出。

姓名	类型	Description	必选
item_id	字符串	启动文件搜索调用的输出项的 ID。	是的
output_index	整数	文件搜索调用正在搜索的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.file_search_call.searching`。可能的值：`response.file_search_call.searching`	是的

OpenAI.ResponseFormat

OpenAI.ResponseFormat 的鉴别器

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

类型值	Schema
`json_object`	OpenAI.ResponseFormatJsonObject
`json_schema`	OpenAI.ResponseFormatJsonSchema

姓名	类型	Description	必选	违约
类型	枚举	可能的值：`text`、、 `json_objectjson_schema`	是的

OpenAI.ResponseFormatJsonObject

JSON 对象响应格式。生成 JSON 响应的较旧方法。建议对支持它的模型使用 json_schema 。请注意，除非有系统或用户消息指示，模型不会生成 JSON。

姓名	类型	Description	必选	违约
类型	枚举	要定义的响应格式的类型。始终为 `json_object`。可能的值：`json_object`	是的

OpenAI.ResponseFormatJsonSchema

响应格式的架构，描述为 JSON 架构对象。了解如何在此处生成 JSON 架构。JSON 架构响应格式。用于生成结构化 JSON 响应。详细了解结构化输出。

姓名	类型	Description	必选	违约
json_schema	对象	结构化输出配置选项，包括 JSON 架构。	是的
└─ 说明	字符串	响应格式用途的描述，供模型确定如何按该格式响应。	否
└─ 名称	字符串	响应格式的名称。必须为 a-z、A-Z、0-9 或包含下划线和短划线，最大长度为 64。	否
└─ 架构	对象		否
└─ 严格	布尔	是否在生成输出时启用严格的架构遵循。如果设置为 true，则模型将始终遵循定义的确切架构在 `schema` 字段中。以下情况时仅支持 JSON 架构的子集： `strict` 是 `true`。若要了解详细信息，请阅读结构化输出指南。	否	假
类型	枚举	要定义的响应格式的类型。始终为 `json_schema`。可能的值：`json_schema`	是的

OpenAI.ResponseFormatText

默认响应格式。用于生成文本响应。

姓名	类型	Description	必选	违约
类型	枚举	要定义的响应格式的类型。始终为 `text`。可能的值：`text`	是的

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

当存在部分函数调用参数增量时发出。

姓名	类型	Description	必选
三角洲	字符串	添加的函数调用参数增量。	是的
item_id	字符串	函数调用参数增量添加到的输出项的 ID。	是的
output_index	整数	函数调用参数增量添加到的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.function_call_arguments.delta`。可能的值：`response.function_call_arguments.delta`	是的

OpenAI.ResponseFunctionCallArgumentsDoneEvent

在函数调用参数完成时发出。

姓名	类型	Description	必选
arguments	字符串	函数调用参数。	是的
item_id	字符串	项的 ID。	是的
output_index	整数	输出项的索引。	是的
类型	枚举	可能的值：`response.function_call_arguments.done`	是的

OpenAI.ResponseImageGenCallCompletedEvent

当映像生成工具调用完成并且最终映像可用时发出。

姓名	类型	Description	必选
item_id	字符串	正在处理的图像生成项的唯一标识符。	是的
output_index	整数	响应的输出数组中输出项的索引。	是的
类型	枚举	事件类型。始终为“response.image_generation_call.completed”。可能的值：`response.image_generation_call.completed`	是的

OpenAI.ResponseImageGenCallGeneratingEvent

当映像生成工具调用正在主动生成映像（中间状态）时发出。

姓名	类型	Description	必选
item_id	字符串	正在处理的图像生成项的唯一标识符。	是的
output_index	整数	响应的输出数组中输出项的索引。	是的
类型	枚举	事件类型。始终为“response.image_generation_call.generating”。可能的值：`response.image_generation_call.generating`	是的

OpenAI.ResponseImageGenCallInProgressEvent

映像生成工具调用正在进行时发出。

姓名	类型	Description	必选
item_id	字符串	正在处理的图像生成项的唯一标识符。	是的
output_index	整数	响应的输出数组中输出项的索引。	是的
类型	枚举	事件类型。始终为“response.image_generation_call.generating”。可能的值：`response.image_generation_call.in_progress`	是的

OpenAI.ResponseImageGenCallPartialImageEvent

当部分图像在图像生成流式处理期间可用时发出。

姓名	类型	Description	必选
item_id	字符串	正在处理的图像生成项的唯一标识符。	是的
output_index	整数	响应的输出数组中输出项的索引。	是的
partial_image_b64	字符串	Base64 编码的部分图像数据，适合作为图像呈现。	是的
partial_image_index	整数	部分映像的基于 0 的索引（后端基于 1，但用户基于 0）。	是的
类型	枚举	事件类型。始终为“response.image_generation_call.partial_image”。可能的值：`response.image_generation_call.partial_image`	是的

OpenAI.ResponseInProgressEvent

响应正在进行时发出。

姓名	类型	Description	必选	违约
response	对象		是的
~~ 代理	AgentId	用于此响应的代理	否
~~ 背景	布尔	是否在后台运行模型响应。详细了解后台响应。	否	假
~~ 对话	对象		否
└─ 身份	字符串		否
created_at	整数	创建此响应时的 Unix 时间戳（以秒为单位）。	否
~~ 错误	OpenAI.ResponseError	当模型无法生成响应时返回的错误对象。	否
└─ 身份	字符串	此响应的唯一标识符。	否
不完整的详细信息	对象	有关响应不完整的原因的详细信息。	否
~~ 原因	枚举	响应不够详尽的原因。可能的值： `max_output_tokenscontent_filter`	否
└─ 说明	字符串或数组	插入到模型上下文中的系统（或开发人员）消息。当与 `previous_response_id` 一起使用时，先前的响应的指令不会传递到下一个响应。这使得它变得简单在新的响应中交换系统（或开发人员）消息。	否
max_output_tokens（最大输出标记数）	整数	可为响应生成的令牌数上限，包括可见输出令牌和推理令牌。	否
max_tool_calls	整数	响应中可以处理的内置工具的最大调用次数。此最大调用次数适用于所有内置工具调用，而非单个工具的调用。模型对任何工具的后续调用尝试都将被忽略。	否
└─ 元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
└─ 模型	字符串	用于创建此响应的模型部署。	否
~~ 对象	枚举	此资源的对象类型 - 始终设置为 `response`。可能的值：`response`	否
└─ 输出	数组	模型生成的内容项数组。 - 数组中 `output` 项的长度和顺序取决于于模型的响应。 - 与其访问 `output` 数组中的第一项并假设它是包含模型生成内容的 `assistant` 消息，可以考虑在 SDK 中支持的位置使用 `output_text` 属性。	否
输出文本	字符串	仅限 SDK 的便利属性，其中包含来自 `output_text` 数组中的所有 `output` 项聚合的文本输出（如果有）。 Python 和 JavaScript SDK 中受支持。	否
并行工具调用	布尔	是否允许模型并行运行工具调用。	否	真实
previous_response_id	字符串	对模型的上一个响应的唯一 ID。用它创建多轮对话。详细了解管理聊天状态。	否
└─ 提示	OpenAI.Prompt	对提示模板及其变量的引用。了解详细信息。	否
└─推理	OpenAI.Reasoning	仅适用于 O 系列模型推理模型的配置选项。	否
service_tier	OpenAI.ServiceTier	注意：service_tier不适用于 Azure OpenAI。	否
└─ 状态	枚举	响应生成的状态。以下之一：`completed`、`failed`、 `in_progress`、`cancelled`、`queued` 或 `incomplete`。可能的值：`completed`、、`failed`、`in_progresscancelled`、`queued`、`incomplete`	否
structured_inputs	对象	可以参与提示模板替换或工具参数绑定的响应的结构化输入。	否
~~ 温度	数字	要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性我们通常建议更改此设置或 `top_p`，但不要同时更改两者。	否
└─ 文本	对象	来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。请参阅文本输入和输出和结构化输出	否
└─ 格式	OpenAI.ResponseTextFormatConfiguration		否
工具选择	OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceObject	模型在生成时应如何选择要使用的工具（或工具）响应。 `tools`请参阅参数，了解如何指定哪些工具模型可以调用。	否
└─ 工具	数组	生成响应时，模型可能会调用的工具数组。你可以通过设置 `tool_choice` 参数来指定要使用的工具。可以提供模型的两类工具包括： * 内置工具：OpenAI 提供的工具，用于扩展模型的功能，如 Web 搜索或文件搜索。详细了解内置工具。 * 函数调用（自定义工具）：由你定义的函数，使模型能够调用自己的代码。详细了解函数调用。	否
top_logprobs	整数	一个介于 0 和 20 之间的整数，指定在每个标记位置最有可能返回的的标记数，每个都有关联的对数概率。	否
top_p	数字	使用温度进行采样的替代方法，称为核采样，其中，模型考虑具有 top_p 概率质量的令牌的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。我们通常建议更改此设置或 `temperature`，但不要同时更改两者。	否
└─ 截断	枚举	要用于模型响应的截断策略。 - `auto`：如果此响应和以前的响应上下文超过模型的上下文窗口大小，模型将截断响应以适应上下文窗口，方法是在对话中删除输入项。 - `disabled`（默认值）：如果模型响应将超过上下文窗口模型的大小，请求将失败并出现 400 错误。可能的值： `autodisabled`	否
└─ 用法	OpenAI.ResponseUsage	表示令牌使用情况详细信息，包括输入令牌、输出令牌、输出令牌的细分以及所使用的令牌总数。	否
└─ 用户	字符串	详细了解安全最佳做法。	否
类型	枚举	事件类型。始终为 `response.in_progress`。可能的值：`response.in_progress`	是的

OpenAI.ResponseIncompleteEvent

响应以不完整状态结束时发出的事件。

姓名	类型	Description	必选	违约
response	对象		是的
~~ 代理	AgentId	用于此响应的代理	否
~~ 背景	布尔	是否在后台运行模型响应。详细了解后台响应。	否	假
~~ 对话	对象		否
└─ 身份	字符串		否
created_at	整数	创建此响应时的 Unix 时间戳（以秒为单位）。	否
~~ 错误	OpenAI.ResponseError	当模型无法生成响应时返回的错误对象。	否
└─ 身份	字符串	此响应的唯一标识符。	否
不完整的详细信息	对象	有关响应不完整的原因的详细信息。	否
~~ 原因	枚举	响应不够详尽的原因。可能的值： `max_output_tokenscontent_filter`	否
└─ 说明	字符串或数组	插入到模型上下文中的系统（或开发人员）消息。当与 `previous_response_id` 一起使用时，先前的响应的指令不会传递到下一个响应。这使得它变得简单在新的响应中交换系统（或开发人员）消息。	否
max_output_tokens（最大输出标记数）	整数	可为响应生成的令牌数上限，包括可见输出令牌和推理令牌。	否
max_tool_calls	整数	响应中可以处理的内置工具的最大调用次数。此最大调用次数适用于所有内置工具调用，而非单个工具的调用。模型对任何工具的后续调用尝试都将被忽略。	否
└─ 元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
└─ 模型	字符串	用于创建此响应的模型部署。	否
~~ 对象	枚举	此资源的对象类型 - 始终设置为 `response`。可能的值：`response`	否
└─ 输出	数组	模型生成的内容项数组。 - 数组中 `output` 项的长度和顺序取决于于模型的响应。 - 与其访问 `output` 数组中的第一项并假设它是包含模型生成内容的 `assistant` 消息，可以考虑在 SDK 中支持的位置使用 `output_text` 属性。	否
输出文本	字符串	仅限 SDK 的便利属性，其中包含来自 `output_text` 数组中的所有 `output` 项聚合的文本输出（如果有）。 Python 和 JavaScript SDK 中受支持。	否
并行工具调用	布尔	是否允许模型并行运行工具调用。	否	真实
previous_response_id	字符串	对模型的上一个响应的唯一 ID。用它创建多轮对话。详细了解管理聊天状态。	否
└─ 提示	OpenAI.Prompt	对提示模板及其变量的引用。了解详细信息。	否
└─推理	OpenAI.Reasoning	仅适用于 O 系列模型推理模型的配置选项。	否
service_tier	OpenAI.ServiceTier	注意：service_tier不适用于 Azure OpenAI。	否
└─ 状态	枚举	响应生成的状态。以下之一：`completed`、`failed`、 `in_progress`、`cancelled`、`queued` 或 `incomplete`。可能的值：`completed`、、`failed`、`in_progresscancelled`、`queued`、`incomplete`	否
structured_inputs	对象	可以参与提示模板替换或工具参数绑定的响应的结构化输入。	否
~~ 温度	数字	要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性我们通常建议更改此设置或 `top_p`，但不要同时更改两者。	否
└─ 文本	对象	来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。请参阅文本输入和输出和结构化输出	否
└─ 格式	OpenAI.ResponseTextFormatConfiguration		否
工具选择	OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceObject	模型在生成时应如何选择要使用的工具（或工具）响应。 `tools`请参阅参数，了解如何指定哪些工具模型可以调用。	否
└─ 工具	数组	生成响应时，模型可能会调用的工具数组。你可以通过设置 `tool_choice` 参数来指定要使用的工具。可以提供模型的两类工具包括： * 内置工具：OpenAI 提供的工具，用于扩展模型的功能，如 Web 搜索或文件搜索。详细了解内置工具。 * 函数调用（自定义工具）：由你定义的函数，使模型能够调用自己的代码。详细了解函数调用。	否
top_logprobs	整数	一个介于 0 和 20 之间的整数，指定在每个标记位置最有可能返回的的标记数，每个都有关联的对数概率。	否
top_p	数字	使用温度进行采样的替代方法，称为核采样，其中，模型考虑具有 top_p 概率质量的令牌的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。我们通常建议更改此设置或 `temperature`，但不要同时更改两者。	否
└─ 截断	枚举	要用于模型响应的截断策略。 - `auto`：如果此响应和以前的响应上下文超过模型的上下文窗口大小，模型将截断响应以适应上下文窗口，方法是在对话中删除输入项。 - `disabled`（默认值）：如果模型响应将超过上下文窗口模型的大小，请求将失败并出现 400 错误。可能的值： `autodisabled`	否
└─ 用法	OpenAI.ResponseUsage	表示令牌使用情况详细信息，包括输入令牌、输出令牌、输出令牌的细分以及所使用的令牌总数。	否
└─ 用户	字符串	详细了解安全最佳做法。	否
类型	枚举	事件类型。始终为 `response.incomplete`。可能的值：`response.incomplete`	是的

OpenAI.ResponseMCPCallArgumentsDeltaEvent

当 MCP 工具调用的参数存在增量（部分更新）时发出。

姓名	类型	Description	必选
三角洲		MCP 工具调用参数的部分更新。	是的
item_id	字符串	正在处理的 MCP 工具调用项的唯一标识符。	是的
output_index	整数	响应的输出数组中输出项的索引。	是的
类型	枚举	事件类型。始终为“response.mcp_call.arguments_delta”。可能的值：`response.mcp_call.arguments_delta`	是的

OpenAI.ResponseMCPCallArgumentsDoneEvent

在完成 MCP 工具调用的参数时发出。

姓名	类型	Description	必选
arguments		MCP 工具调用的最终参数。	是的
item_id	字符串	正在处理的 MCP 工具调用项的唯一标识符。	是的
output_index	整数	响应的输出数组中输出项的索引。	是的
类型	枚举	事件类型。始终为“response.mcp_call.arguments_done”。可能的值：`response.mcp_call.arguments_done`	是的

OpenAI.ResponseMCPCallCompletedEvent

MCP 工具调用成功完成时发出。

姓名	类型	Description	必选	违约
类型	枚举	事件类型。始终为“response.mcp_call.completed”。可能的值：`response.mcp_call.completed`	是的

OpenAI.ResponseMCPCallFailedEvent

MCP 工具调用失败时发出。

姓名	类型	Description	必选	违约
类型	枚举	事件类型。始终为“response.mcp_call.failed”。可能的值：`response.mcp_call.failed`	是的

OpenAI.ResponseMCPCallInProgressEvent

当 MCP 工具调用正在进行时发出。

姓名	类型	Description	必选
item_id	字符串	正在处理的 MCP 工具调用项的唯一标识符。	是的
output_index	整数	响应的输出数组中输出项的索引。	是的
类型	枚举	事件类型。始终为“response.mcp_call.in_progress”。可能的值：`response.mcp_call.in_progress`	是的

OpenAI.ResponseMCPListToolsCompletedEvent

成功检索可用 MCP 工具列表时发出。

姓名	类型	Description	必选	违约
类型	枚举	事件类型。始终为“response.mcp_list_tools.completed”。可能的值：`response.mcp_list_tools.completed`	是的

OpenAI.ResponseMCPListToolsFailedEvent

尝试列出可用 MCP 工具失败时发出。

姓名	类型	Description	必选	违约
类型	枚举	事件类型。始终为“response.mcp_list_tools.failed”。可能的值：`response.mcp_list_tools.failed`	是的

OpenAI.ResponseMCPListToolsInProgressEvent

当系统正在检索可用 MCP 工具列表时发出。

姓名	类型	Description	必选	违约
类型	枚举	事件类型。始终为“response.mcp_list_tools.in_progress”。可能的值：`response.mcp_list_tools.in_progress`	是的

OpenAI.ResponseOutputItemAddedEvent

添加新的输出项时发出。

姓名	类型	Description	必选
项	对象	用于生成响应的内容项。	是的
created_by	创建者	有关项目创建者的信息	否
└─ 身份	字符串		否
└─ 类型	OpenAI.ItemType		否
output_index	整数	已添加的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.output_item.added`。可能的值：`response.output_item.added`	是的

OpenAI.ResponseOutputItemDoneEvent

当输出项标记为已完成时发出。

姓名	类型	Description	必选
项	对象	用于生成响应的内容项。	是的
created_by	创建者	有关项目创建者的信息	否
└─ 身份	字符串		否
└─ 类型	OpenAI.ItemType		否
output_index	整数	标记为已完成的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.output_item.done`。可能的值：`response.output_item.done`	是的

OpenAI.ResponsePromptVariables

可选项：用于替换提示词中变量的键值映射。替换值可以是字符串，也可以是图像或文件等其他响应输入类型。

类型：对象

OpenAI.ResponseQueuedEvent

当响应排队并等待处理时发出。

姓名	类型	Description	必选	违约
response	对象		是的
~~ 代理	AgentId	用于此响应的代理	否
~~ 背景	布尔	是否在后台运行模型响应。详细了解后台响应。	否	假
~~ 对话	对象		否
└─ 身份	字符串		否
created_at	整数	创建此响应时的 Unix 时间戳（以秒为单位）。	否
~~ 错误	OpenAI.ResponseError	当模型无法生成响应时返回的错误对象。	否
└─ 身份	字符串	此响应的唯一标识符。	否
不完整的详细信息	对象	有关响应不完整的原因的详细信息。	否
~~ 原因	枚举	响应不够详尽的原因。可能的值： `max_output_tokenscontent_filter`	否
└─ 说明	字符串或数组	插入到模型上下文中的系统（或开发人员）消息。当与 `previous_response_id` 一起使用时，先前的响应的指令不会传递到下一个响应。这使得它变得简单在新的响应中交换系统（或开发人员）消息。	否
max_output_tokens（最大输出标记数）	整数	可为响应生成的令牌数上限，包括可见输出令牌和推理令牌。	否
max_tool_calls	整数	响应中可以处理的内置工具的最大调用次数。此最大调用次数适用于所有内置工具调用，而非单个工具的调用。模型对任何工具的后续调用尝试都将被忽略。	否
└─ 元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
└─ 模型	字符串	用于创建此响应的模型部署。	否
~~ 对象	枚举	此资源的对象类型 - 始终设置为 `response`。可能的值：`response`	否
└─ 输出	数组	模型生成的内容项数组。 - 数组中 `output` 项的长度和顺序取决于于模型的响应。 - 与其访问 `output` 数组中的第一项并假设它是包含模型生成内容的 `assistant` 消息，可以考虑在 SDK 中支持的位置使用 `output_text` 属性。	否
输出文本	字符串	仅限 SDK 的便利属性，其中包含来自 `output_text` 数组中的所有 `output` 项聚合的文本输出（如果有）。 Python 和 JavaScript SDK 中受支持。	否
并行工具调用	布尔	是否允许模型并行运行工具调用。	否	真实
previous_response_id	字符串	对模型的上一个响应的唯一 ID。用它创建多轮对话。详细了解管理聊天状态。	否
└─ 提示	OpenAI.Prompt	对提示模板及其变量的引用。了解详细信息。	否
└─推理	OpenAI.Reasoning	仅适用于 O 系列模型推理模型的配置选项。	否
service_tier	OpenAI.ServiceTier	注意：service_tier不适用于 Azure OpenAI。	否
└─ 状态	枚举	响应生成的状态。以下之一：`completed`、`failed`、 `in_progress`、`cancelled`、`queued` 或 `incomplete`。可能的值：`completed`、、`failed`、`in_progresscancelled`、`queued`、`incomplete`	否
structured_inputs	对象	可以参与提示模板替换或工具参数绑定的响应的结构化输入。	否
~~ 温度	数字	要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性我们通常建议更改此设置或 `top_p`，但不要同时更改两者。	否
└─ 文本	对象	来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。请参阅文本输入和输出和结构化输出	否
└─ 格式	OpenAI.ResponseTextFormatConfiguration		否
工具选择	OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceObject	模型在生成时应如何选择要使用的工具（或工具）响应。 `tools`请参阅参数，了解如何指定哪些工具模型可以调用。	否
└─ 工具	数组	生成响应时，模型可能会调用的工具数组。你可以通过设置 `tool_choice` 参数来指定要使用的工具。可以提供模型的两类工具包括： * 内置工具：OpenAI 提供的工具，用于扩展模型的功能，如 Web 搜索或文件搜索。详细了解内置工具。 * 函数调用（自定义工具）：由你定义的函数，使模型能够调用自己的代码。详细了解函数调用。	否
top_logprobs	整数	一个介于 0 和 20 之间的整数，指定在每个标记位置最有可能返回的的标记数，每个都有关联的对数概率。	否
top_p	数字	使用温度进行采样的替代方法，称为核采样，其中，模型考虑具有 top_p 概率质量的令牌的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。我们通常建议更改此设置或 `temperature`，但不要同时更改两者。	否
└─ 截断	枚举	要用于模型响应的截断策略。 - `auto`：如果此响应和以前的响应上下文超过模型的上下文窗口大小，模型将截断响应以适应上下文窗口，方法是在对话中删除输入项。 - `disabled`（默认值）：如果模型响应将超过上下文窗口模型的大小，请求将失败并出现 400 错误。可能的值： `autodisabled`	否
└─ 用法	OpenAI.ResponseUsage	表示令牌使用情况详细信息，包括输入令牌、输出令牌、输出令牌的细分以及所使用的令牌总数。	否
└─ 用户	字符串	详细了解安全最佳做法。	否
类型	枚举	事件类型。始终为“response.queued”。可能的值：`response.queued`	是的

OpenAI.ResponseReasoningDeltaEvent

当推理内容存在增量（部分更新）时发出。

姓名	类型	Description	必选
content_index	整数	输出项中推理内容部件的索引。	是的
三角洲		对推理内容的部分更新。	是的
item_id	字符串	正在更新推理的项目的唯一标识符。	是的
output_index	整数	响应的输出数组中输出项的索引。	是的
类型	枚举	事件类型。始终为“response.reasoning.delta”。可能的值：`response.reasoning.delta`	是的

OpenAI.ResponseReasoningDoneEvent

当项的推理内容完成时发出。

姓名	类型	Description	必选
content_index	整数	输出项中推理内容部件的索引。	是的
item_id	字符串	完成推理的项的唯一标识符。	是的
output_index	整数	响应的输出数组中输出项的索引。	是的
文本消息	字符串	最终的推理文本。	是的
类型	枚举	事件类型。始终为“response.reasoning.done”。可能的值：`response.reasoning.done`	是的

OpenAI.ResponseReasoningSummaryDeltaEvent

当推理摘要内容存在增量（部分更新）时发出。

姓名	类型	Description	必选
三角洲		对推理摘要内容的部分更新。	是的
item_id	字符串	正在更新推理摘要的项目的唯一标识符。	是的
output_index	整数	响应的输出数组中输出项的索引。	是的
summary_index	整数	输出项中概要部分的索引。	是的
类型	枚举	事件类型。始终为“response.reasoning_summary.delta”。可能的值：`response.reasoning_summary.delta`	是的

OpenAI.ResponseReasoningSummaryDoneEvent

当项目的推理摘要内容被最终确定时发出。

姓名	类型	Description	必选
item_id	字符串	完成推理摘要的项的唯一标识符。	是的
output_index	整数	响应的输出数组中输出项的索引。	是的
summary_index	整数	输出项中概要部分的索引。	是的
文本消息	字符串	最终的推理摘要文本。	是的
类型	枚举	事件类型。始终为“response.reasoning_summary.done”。可能的值：`response.reasoning_summary.done`	是的

OpenAI.ResponseReasoningSummaryPartAddedEvent

添加新的推理摘要部分时发出。

姓名	类型	Description	必选
item_id	字符串	此摘要部分关联的项的 ID。	是的
output_index	整数	此摘要部分关联的输出项的索引。	是的
部件	对象		是的
└─ 类型	OpenAI.ReasoningItemSummaryPartType		否
summary_index	整数	推理摘要中摘要部分的索引。	是的
类型	枚举	事件类型。始终为 `response.reasoning_summary_part.added`。可能的值：`response.reasoning_summary_part.added`	是的

OpenAI.ResponseReasoningSummaryPartDoneEvent

完成推理摘要部分时发出。

姓名	类型	Description	必选
item_id	字符串	此摘要部分关联的项的 ID。	是的
output_index	整数	此摘要部分关联的输出项的索引。	是的
部件	对象		是的
└─ 类型	OpenAI.ReasoningItemSummaryPartType		否
summary_index	整数	推理摘要中摘要部分的索引。	是的
类型	枚举	事件类型。始终为 `response.reasoning_summary_part.done`。可能的值：`response.reasoning_summary_part.done`	是的

OpenAI.ResponseReasoningSummaryTextDeltaEvent

将增量添加到推理摘要文本时发出。

姓名	类型	Description	必选
三角洲	字符串	添加到摘要的文本增量。	是的
item_id	字符串	此摘要文本增量关联的项的 ID。	是的
output_index	整数	此摘要文本增量关联的输出项的索引。	是的
summary_index	整数	推理摘要中摘要部分的索引。	是的
类型	枚举	事件类型。始终为 `response.reasoning_summary_text.delta`。可能的值：`response.reasoning_summary_text.delta`	是的

OpenAI.ResponseReasoningSummaryTextDoneEvent

完成推理摘要文本时发出。

姓名	类型	Description	必选
item_id	字符串	此摘要文本关联的项的 ID。	是的
output_index	整数	与此摘要文本关联的输出项的索引。	是的
summary_index	整数	推理摘要中摘要部分的索引。	是的
文本消息	字符串	已完成推理摘要的全文。	是的
类型	枚举	事件类型。始终为 `response.reasoning_summary_text.done`。可能的值：`response.reasoning_summary_text.done`	是的

OpenAI.ResponseRefusalDeltaEvent

当存在部分拒绝文本时发出。

姓名	类型	Description	必选
content_index	整数	拒绝文本添加到的内容部分的索引。	是的
三角洲	字符串	添加的拒绝文本。	是的
item_id	字符串	拒绝文本添加到的输出项的 ID。	是的
output_index	整数	拒绝文本添加到的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.refusal.delta`。可能的值：`response.refusal.delta`	是的

OpenAI.ResponseRefusalDoneEvent

在拒绝文本完成时发出。

姓名	类型	Description	必选
content_index	整数	已完成拒绝文本的内容部分的索引。	是的
item_id	字符串	已完成拒绝文本的输出项的 ID。	是的
output_index	整数	已完成拒绝文本的输出项的索引。	是的
拒绝	字符串	最终完成的拒绝文本。	是的
类型	枚举	事件类型。始终为 `response.refusal.done`。可能的值：`response.refusal.done`	是的

OpenAI.ResponseStreamEvent

OpenAI.ResponseStreamEvent 的鉴别器

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

类型值	Schema
`response.completed`	OpenAI.ResponseCompletedEvent
`response.content_part.added`	OpenAI.ResponseContentPartAddedEvent
`response.content_part.done`	OpenAI.ResponseContentPartDoneEvent
`response.created`	OpenAI.ResponseCreatedEvent
`error`	OpenAI.ResponseErrorEvent
`response.file_search_call.completed`	OpenAI.ResponseFileSearchCallCompletedEvent
`response.file_search_call.in_progress`	OpenAI.ResponseFileSearchCallInProgressEvent
`response.file_search_call.searching`	OpenAI.ResponseFileSearchCallSearchingEvent
`response.function_call_arguments.delta`	OpenAI.ResponseFunctionCallArgumentsDeltaEvent
`response.function_call_arguments.done`	OpenAI.ResponseFunctionCallArgumentsDoneEvent
`response.in_progress`	OpenAI.ResponseInProgressEvent
`response.failed`	OpenAI.ResponseFailedEvent
`response.incomplete`	OpenAI.ResponseIncompleteEvent
`response.output_item.added`	OpenAI.ResponseOutputItemAddedEvent
`response.output_item.done`	OpenAI.ResponseOutputItemDoneEvent
`response.refusal.delta`	OpenAI.ResponseRefusalDeltaEvent
`response.refusal.done`	OpenAI.ResponseRefusalDoneEvent
`response.output_text.delta`	OpenAI.ResponseTextDeltaEvent
`response.output_text.done`	OpenAI.ResponseTextDoneEvent
`response.reasoning_summary_part.added`	OpenAI.ResponseReasoningSummaryPartAddedEvent
`response.reasoning_summary_part.done`	OpenAI.ResponseReasoningSummaryPartDoneEvent
`response.reasoning_summary_text.delta`	OpenAI.ResponseReasoningSummaryTextDeltaEvent
`response.reasoning_summary_text.done`	OpenAI.ResponseReasoningSummaryTextDoneEvent
`response.web_search_call.completed`	OpenAI.ResponseWebSearchCallCompletedEvent
`response.web_search_call.in_progress`	OpenAI.ResponseWebSearchCallInProgressEvent
`response.web_search_call.searching`	OpenAI.ResponseWebSearchCallSearchingEvent
`response.image_generation_call.completed`	OpenAI.ResponseImageGenCallCompletedEvent
`response.image_generation_call.generating`	OpenAI.ResponseImageGenCallGeneratingEvent
`response.image_generation_call.in_progress`	OpenAI.ResponseImageGenCallInProgressEvent
`response.image_generation_call.partial_image`	OpenAI.ResponseImageGenCallPartialImageEvent
`response.mcp_call.arguments_delta`	OpenAI.ResponseMCPCallArgumentsDeltaEvent
`response.mcp_call.arguments_done`	OpenAI.ResponseMCPCallArgumentsDoneEvent
`response.mcp_call.completed`	OpenAI.ResponseMCPCallCompletedEvent
`response.mcp_call.failed`	OpenAI.ResponseMCPCallFailedEvent
`response.mcp_call.in_progress`	OpenAI.ResponseMCPCallInProgressEvent
`response.mcp_list_tools.completed`	OpenAI.ResponseMCPListToolsCompletedEvent
`response.mcp_list_tools.failed`	OpenAI.ResponseMCPListToolsFailedEvent
`response.mcp_list_tools.in_progress`	OpenAI.ResponseMCPListToolsInProgressEvent
`response.queued`	OpenAI.ResponseQueuedEvent
`response.reasoning.delta`	OpenAI.ResponseReasoningDeltaEvent
`response.reasoning.done`	OpenAI.ResponseReasoningDoneEvent
`response.reasoning_summary.delta`	OpenAI.ResponseReasoningSummaryDeltaEvent
`response.reasoning_summary.done`	OpenAI.ResponseReasoningSummaryDoneEvent
`response.code_interpreter_call_code.delta`	OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent
`response.code_interpreter_call_code.done`	OpenAI.ResponseCodeInterpreterCallCodeDoneEvent
`response.code_interpreter_call.completed`	OpenAI.ResponseCodeInterpreterCallCompletedEvent
`response.code_interpreter_call.in_progress`	OpenAI.ResponseCodeInterpreterCallInProgressEvent
`response.code_interpreter_call.interpreting`	OpenAI.ResponseCodeInterpreterCallInterpretingEvent

姓名	类型	Description	必选	违约
sequence_number	整数	此事件的序列号。	是的
类型	OpenAI.ResponseStreamEventType		是的

OpenAI.ResponseStreamEventType

资产价值

类型字符串

价值观 response.audio.delta
response.audio.done
response.audio_transcript.delta
response.audio_transcript.done
response.code_interpreter_call_code.delta
response.code_interpreter_call_code.done
response.code_interpreter_call.completed
response.code_interpreter_call.in_progress
response.code_interpreter_call.interpreting
response.completed
response.content_part.added
response.content_part.done
response.created
error
response.file_search_call.completed
response.file_search_call.in_progress
response.file_search_call.searching
response.function_call_arguments.delta
response.function_call_arguments.done
response.in_progress
response.failed
response.incomplete
response.output_item.added
response.output_item.done
response.refusal.delta
response.refusal.done
response.output_text.annotation.added
response.output_text.delta
response.output_text.done
response.reasoning_summary_part.added
response.reasoning_summary_part.done
response.reasoning_summary_text.delta
response.reasoning_summary_text.done
response.web_search_call.completed
response.web_search_call.in_progress
response.web_search_call.searching
response.image_generation_call.completed
response.image_generation_call.generating
response.image_generation_call.in_progress
response.image_generation_call.partial_image
response.mcp_call.arguments_delta
response.mcp_call.arguments_done
response.mcp_call.completed
response.mcp_call.failed
response.mcp_call.in_progress
response.mcp_list_tools.completed
response.mcp_list_tools.failed
response.mcp_list_tools.in_progress
response.queued
response.reasoning.delta
response.reasoning.done
response.reasoning_summary.delta
response.reasoning_summary.done

OpenAI.ResponseTextDeltaEvent

当有额外的文本增量时发出。

姓名	类型	Description	必选
content_index	整数	文本增量添加到的内容部分的索引。	是的
三角洲	字符串	添加的文本增量。	是的
item_id	字符串	文本增量添加到的输出项的 ID。	是的
output_index	整数	文本增量添加到的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.output_text.delta`。可能的值：`response.output_text.delta`	是的

OpenAI.ResponseTextDoneEvent

在完成文本内容时发出。

姓名	类型	Description	必选
content_index	整数	已完成文本内容的内容部分的索引。	是的
item_id	字符串	已完成文本内容的输出项的 ID。	是的
output_index	整数	已完成文本内容的输出项的索引。	是的
文本消息	字符串	最终完成的文本内容。	是的
类型	枚举	事件类型。始终为 `response.output_text.done`。可能的值：`response.output_text.done`	是的

OpenAI.响应文本格式配置

OpenAI.ResponseTextFormatConfiguration 的鉴别器

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

类型值	Schema
`text`	OpenAI响应文本格式配置文本
`json_object`	OpenAI.ResponseTextFormatConfigurationJsonObject
`json_schema`	OpenAI.ResponseTextFormatConfigurationJsonSchema

姓名	类型	Description	必选	违约
类型	OpenAI.ResponseTextFormatConfigurationType	一个对象，指定模型必须输出的格式。配置 `{ "type": "json_schema" }` 会启用结构化输出，这可确保模型与提供的 JSON 架构匹配。若要了解详细信息，请查看默认格式 `{ "type": "text" }` 没有其他选项。不建议用于 gpt-4o 和较新的模型：设置 `{ "type": "json_object" }` 可启用旧版 JSON 模式，确保模型生成的消息是有效的 JSON。使用 `json_schema` 对于支持该功能的模型而言，这是优先选择。	是的

OpenAI.ResponseTextFormatConfigurationJsonObject

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

OpenAI响应文本格式配置JSON架构

JSON 架构响应格式。用于生成结构化 JSON 响应。详细了解结构化输出。

姓名	类型	Description	必选	违约
说明	字符串	响应格式用途的描述，供模型确定如何按该格式响应。	否
姓名	字符串	响应格式的名称。必须为 a-z、A-Z、0-9 或包含下划线和短划线，最大长度为 64。	是的
架构	对象		是的
strict	布尔	是否在生成输出时启用严格的架构遵循。如果设置为 true，则模型将始终遵循定义的确切架构在 `schema` 字段中。以下情况时仅支持 JSON 架构的子集： `strict` 是 `true`。若要了解详细信息，请阅读结构化输出指南。	否	假
类型	枚举	要定义的响应格式的类型。始终为 `json_schema`。可能的值：`json_schema`	是的

OpenAI.ResponseTextFormatConfigurationText

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

OpenAI 响应文本格式配置类型 (OpenAI.ResponseTextFormatConfigurationType)

一个对象，指定模型必须输出的格式。

配置 { "type": "json_schema" } 启用结构化输出，这可确保模型与提供的 JSON 架构匹配。若要了解详细信息，请查看

默认格式 { "type": "text" } 没有其他选项。

不建议用于 gpt-4o 和较新的模型：

{ "type": "json_object" }设置为启用较旧的 JSON 模式，这可确保模型生成的消息是有效的 JSON。对于支持它的模型，首选使用 json_schema 。

资产	价值
说明	一个对象，指定模型必须输出的格式。

配置 { "type": "json_schema" } 启用结构化输出，这可确保模型与提供的 JSON 架构匹配。若要了解详细信息，请查看

默认格式 { "type": "text" } 没有其他选项。

不建议用于 gpt-4o 和较新的模型：

{ "type": "json_object" }设置为启用较旧的 JSON 模式，这可确保模型生成的消息是有效的 JSON。对于支持它的模型，首选使用 json_schema 。 | | 类型 |string | | 值 | text
json_schema
json_object |

OpenAI.ResponseUsage

表示令牌使用情况详细信息，包括输入令牌、输出令牌、输出令牌细分以及所使用的令牌总数。

姓名	类型	Description	必选
input_tokens	整数	输入令牌数。	是的
input_tokens_details	对象	输入令牌的明细。	是的
cached_tokens	整数	从缓存中检索的令牌数。有关提示缓存的详细信息。	否
output_tokens	整数	输出标记数。	是的
output_tokens_details	对象	输出令牌的明细。	是的
reasoning_tokens	整数	推理令牌的数量。	否
total_tokens	整数	使用的令牌总数。	是的

OpenAI.ResponseWebSearchCallCompletedEvent

注意：web_search尚未通过 Azure OpenAI 提供。

姓名	类型	Description	必选
item_id	字符串	与 Web 搜索调用关联的输出项的唯一 ID。	是的
output_index	整数	Web 搜索调用关联的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.web_search_call.completed`。可能的值：`response.web_search_call.completed`	是的

OpenAI.ResponseWebSearchCallInProgressEvent

注意：web_search尚未通过 Azure OpenAI 提供。

姓名	类型	Description	必选
item_id	字符串	与 Web 搜索调用关联的输出项的唯一 ID。	是的
output_index	整数	Web 搜索调用关联的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.web_search_call.in_progress`。可能的值：`response.web_search_call.in_progress`	是的

OpenAI.ResponseWebSearchCallSearchingEvent

注意：web_search尚未通过 Azure OpenAI 提供。

姓名	类型	Description	必选
item_id	字符串	与 Web 搜索调用关联的输出项的唯一 ID。	是的
output_index	整数	Web 搜索调用关联的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.web_search_call.searching`。可能的值：`response.web_search_call.searching`	是的

OpenAI.ResponsesAssistantMessageItemParam

具有 assistant 角色的消息参数项。

姓名	类型	Description	必选	违约
内容	字符串或数组		是的
角色	枚举	消息的角色，始终为 `assistant`。可能的值：`assistant`	是的

OpenAI.ResponsesAssistantMessageItemResource

具有 assistant 角色的消息资源项。

姓名	类型	Description	必选	违约
内容	数组	与消息关联的内容。	是的
角色	枚举	消息的角色，始终为 `assistant`。可能的值：`assistant`	是的

OpenAI.ResponsesDeveloperMessageItemParam

具有 developer 角色的消息参数项。

姓名	类型	Description	必选	违约
内容	字符串或数组		是的
角色	枚举	消息的角色，始终为 `developer`。可能的值：`developer`	是的

OpenAI.ResponsesDeveloperMessageItemResource

具有 developer 角色的消息资源项。

姓名	类型	Description	必选	违约
内容	数组	与消息关联的内容。	是的
角色	枚举	消息的角色，始终为 `developer`。可能的值：`developer`	是的

OpenAI.ResponsesMessageItemParam

响应消息项，表示作为客户端请求参数提供的角色和内容。

OpenAI.ResponsesMessageItemParam 的鉴别器

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

类型值	Schema
`user`	OpenAI.ResponsesUserMessageItemParam
`system`	OpenAI.ResponsesSystemMessageItemParam
`developer`	OpenAI.ResponsesDeveloperMessageItemParam
`assistant`	OpenAI.ResponsesAssistantMessageItemParam

姓名	类型	Description	必选	违约
角色	对象	响应消息项中有效角色的集合。	是的
类型	枚举	响应项的类型，始终为“message”。可能的值：`message`	是的

OpenAI.ResponsesMessageItemResource

响应消息资源项，表示服务响应中提供的角色和内容。

OpenAI.ResponsesMessageItemResource 的鉴别器

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

类型值	Schema
`user`	OpenAI.ResponsesUserMessageItemResource
`system`	OpenAI.ResponsesSystemMessageItemResource
`developer`	OpenAI.ResponsesDeveloperMessageItemResource
`assistant`	OpenAI.ResponsesAssistantMessageItemResource

姓名	类型	Description	必选
角色	对象	响应消息项中有效角色的集合。	是的
状态	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	是的
类型	枚举	响应项的类型，始终为“message”。可能的值：`message`	是的

OpenAI.ResponsesMessageRole

响应消息项中有效角色的集合。

资产	价值
说明	响应消息项中有效角色的集合。
类型	字符串
价值观	`system` `developer` `user` `assistant`

OpenAI.ResponsesSystemMessageItemParam

具有 system 角色的消息参数项。

姓名	类型	Description	必选	违约
内容	字符串或数组		是的
角色	枚举	消息的角色，始终为 `system`。可能的值：`system`	是的

OpenAI.ResponsesSystemMessageItemResource

具有 system 角色的消息资源项。

姓名	类型	Description	必选	违约
内容	数组	与消息关联的内容。	是的
角色	枚举	消息的角色，始终为 `system`。可能的值：`system`	是的

OpenAI.ResponsesUserMessageItemParam

具有 user 角色的消息参数项。

姓名	类型	Description	必选	违约
内容	字符串或数组		是的
角色	枚举	消息的角色，始终为 `user`。可能的值：`user`	是的

OpenAI.ResponsesUserMessageItemResource

具有 user 角色的消息资源项。

姓名	类型	Description	必选	违约
内容	数组	与消息关联的内容。	是的
角色	枚举	消息的角色，始终为 `user`。可能的值：`user`	是的

OpenAI.ServiceTier

指定用于为请求提供服务的处理类型。

如果设置为“auto”，则将使用项目设置中配置的服务层处理请求。除非另有配置，否则项目将使用“default”。
如果设置为“default”，则将使用所选模型的标准定价和性能来处理请求。
如果设置为“flex”或“priority”，则将使用相应的服务层处理请求。请联系销售人员了解有关优先级处理的详细信息。
如果未设置，默认行为为“auto”。

service_tier设置参数后，响应正文将service_tier包含基于实际用于处理请求的处理模式的值。此响应值可能与参数中设置的值不同。

资产	价值
说明	指定用于为请求提供服务的处理类型。 * 如果设置为“auto”，则将使用服务层处理请求在 Project 设置中配置。除非另有配置，否则项目将使用“default”。 * 如果设置为“default”，则将使用标准处理请求所选模型的定价和性能。 * 如果设置为“flex” 或“priority”，则请求将与相应的服务一起处理层。请联系销售人员了解有关优先级处理的详细信息。 * 如果未设置，默认行为为“auto”。 `service_tier`设置参数后，响应正文将包含`service_tier` 基于实际用于处理请求的处理模式的值。此响应值可能与参数中设置的值不同。
类型	字符串
价值观	`auto` `default` `flex` `scale` `priority`

OpenAI.TextResponseFormatConfiguration

一个对象，指定模型必须输出的格式。

配置 { "type": "json_schema" } 启用结构化输出，这可确保模型与提供的 JSON 架构匹配。若要了解详细信息，请查看

默认格式 { "type": "text" } 没有其他选项。

不建议用于 gpt-4o 和较新的模型：*

{ "type": "json_object" }设置为启用较旧的 JSON 模式，这可确保模型生成的消息是有效的 JSON。对于支持它的模型，首选使用 json_schema 。

OpenAI.TextResponseFormatConfiguration 的鉴别器

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

类型值	Schema

姓名	类型	Description	必选	违约
类型	字符串		是的

OpenAI.Tool

OpenAI.Tool 的鉴别器

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

类型值	Schema
`function`	OpenAI.FunctionTool
`file_search`	OpenAI.FileSearchTool
`computer_use_preview`	OpenAI.ComputerUsePreviewTool
`web_search_preview`	OpenAI.WebSearchPreviewTool
`code_interpreter`	OpenAI.CodeInterpreterTool
`image_generation`	OpenAI.ImageGenTool
`local_shell`	OpenAI.LocalShellTool
`mcp`	OpenAI.MCPTool
`bing_grounding`	BingGroundingAgentTool
`fabric_dataagent_preview`	MicrosoftFabricAgentTool
`sharepoint_grounding_preview`	SharepointAgentTool
`azure_ai_search`	AzureAISearchAgentTool
`openapi`	OpenApiAgentTool
`bing_custom_search_preview`	BingCustomSearchAgentTool
`browser_automation_preview`	BrowserAutomationAgentTool
`azure_function`	AzureFunctionAgentTool
`capture_structured_outputs`	CaptureStructuredOutputsTool
`a2a_preview`	A2ATool
`memory_search`	MemorySearchTool

姓名	类型	Description	必选	违约
类型	OpenAI.ToolType	可用于生成响应的工具。	是的

OpenAI.ToolChoiceObject

OpenAI.ToolChoiceObject 的鉴别器

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

类型值	Schema
`file_search`	OpenAI.ToolChoiceObjectFileSearch
`computer_use_preview`	OpenAI.ToolChoiceObjectComputer
`web_search_preview`	OpenAI.ToolChoiceObjectWebSearch
`image_generation`	OpenAI.ToolChoiceObjectImageGen
`code_interpreter`	OpenAI.ToolChoiceObjectCodeInterpreter
`function`	OpenAI.ToolChoiceObjectFunction
`mcp`	OpenAI.ToolChoiceObjectMCP

姓名	类型	Description	必选	违约
类型	OpenAI.ToolChoiceObjectType	指示模型应使用内置工具生成响应。详细了解内置工具。	是的

OpenAI.ToolChoiceObjectCodeInterpreter

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

OpenAI.ToolChoiceObjectComputer

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

OpenAI.ToolChoiceObjectFileSearch

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

OpenAI.ToolChoiceObjectFunction

使用此选项强制模型调用特定函数。

姓名	类型	Description	必选	违约
姓名	字符串	要调用的函数名称。	是的
类型	枚举	对于函数调用，类型始终为`function`。可能的值：`function`	是的

OpenAI.ToolChoiceObjectImageGen

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

OpenAI.ToolChoiceObjectMCP

使用此选项可强制模型调用远程 MCP 服务器上的特定工具。

姓名	类型	Description	必选
姓名	字符串	要在服务器上调用的工具的名称。	否
服务器标签	字符串	要使用的 MCP 服务器的标签。	是的
类型	枚举	对于 MCP 工具，类型始终为 `mcp`。可能的值：`mcp`	是的

OpenAI.ToolChoiceObjectType

指示模型应使用内置工具生成响应。详细了解内置工具。

资产	价值
说明	指示模型应使用内置工具生成响应。
详细了解内置工具。
类型	字符串
价值观	`file_search` `function` `computer_use_preview` `web_search_preview` `image_generation` `code_interpreter` `mcp`

OpenAI.ToolChoiceObjectWebSearch

注意：web_search尚未通过 Azure OpenAI 提供。

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

OpenAI.ToolChoiceOptions

控制模型调用哪些工具（如有）。

none 表示模型不会调用任何工具，而是生成消息。

auto 表示模型可以在生成消息和调用一个或多个工具之间进行选择。

required 表示模型必须调用一个或多个工具。

资产	价值
说明	控制模型调用哪些工具（如有）。 `none` 表示模型不会调用任何工具，而是生成消息。 `auto` 表示模型可以在生成消息或调用一个消息之间进行选择更多工具。 `required` 表示模型必须调用一个或多个工具。
类型	字符串
价值观	`none` `auto` `required`

OpenAI.ToolType

可用于生成响应的工具。

资产	价值
说明	可用于生成响应的工具。
类型	字符串
价值观	`file_search` `function` `computer_use_preview` `web_search_preview` `mcp` `code_interpreter` `image_generation` `local_shell` `bing_grounding` `browser_automation_preview` `fabric_dataagent_preview` `sharepoint_grounding_preview` `azure_ai_search` `openapi` `bing_custom_search_preview` `capture_structured_outputs` `a2a_preview` `azure_function` `memory_search`

OpenAI.TopLogProb

令牌的最高对数概率。

姓名	类型	必选
字节	数组	是的
logprob	数字	是的
代币	字符串	是的

OpenAI.UpdateConversationRequest

更新对话

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

OpenAI.VectorStoreFileAttributes

按 16 个成组的可附加到对象的键值对。这可用于以结构化格式存储有关对象的其他信息，以及通过 API 或仪表板查询对象。键是最大长度为 64 个字符的字符串。值为最大长度为 512 个字符、布尔值或数字的字符串。

类型：对象

OpenAI.WebSearchAction

OpenAI.WebSearchAction 的鉴别器

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

类型值	Schema
`find`	OpenAI.WebSearchActionFind
`open_page`	OpenAI.WebSearchActionOpenPage
`search`	OpenAI.WebSearchActionSearch

姓名	类型	Description	必选	违约
类型	OpenAI.WebSearchActionType		是的

OpenAI.WebSearchActionFind

操作类型“find”：在加载的页面中搜索模式。

姓名	类型	Description	必选
模式	字符串	要在页面内搜索的模式或文本。	是的
类型	枚举	操作类型。可能的值：`find`	是的
url	字符串	用于搜索模式的页面的 URL。	是的

OpenAI.WebSearchActionOpenPage

操作类型“open_page”：打开搜索结果中的特定 URL。

姓名	类型	Description	必选	违约
类型	枚举	操作类型。可能的值：`open_page`	是的
url	字符串	模型打开的 URL。	是的

OpenAI.WebSearchActionSearch

操作类型“search”：执行 Web 搜索查询。

姓名	类型	Description	必选
查询	字符串	搜索查询。	是的
来源	数组	搜索中使用的来源。	否
类型	枚举	操作类型。可能的值：`search`	是的

OpenAI.WebSearchActionSearchSources

姓名	类型	Description	必选	违约
类型	枚举	可能的值：`url`	是的
url	字符串		是的

OpenAI.WebSearchActionType

资产	价值
类型	字符串
价值观	`search` `open_page` `find`

OpenAI.WebSearchPreviewTool

注意：web_search尚未通过 Azure OpenAI 提供。

姓名	类型	Description	必选
搜索上下文大小	枚举	用于搜索的上下文窗口空间量的高级指南。 `low`、`medium` 或 `high` 之一。 `medium` 是默认值。可能的值：`low`、、 `mediumhigh`	否
类型	枚举	Web 搜索工具的类型。 `web_search_preview` 或 `web_search_preview_2025_03_11` 中的一项。可能的值：`web_search_preview`	是的
用户位置	对象		否
└─ 类型	OpenAI.LocationType		否

OpenAI.WebSearchToolCallItemParam

Web 搜索工具调用的结果。有关更多信息，请参阅网络搜索指南。

姓名	类型	Description	必选
操作	对象		是的
└─ 类型	OpenAI.WebSearchActionType		否
类型	枚举	可能的值：`web_search_call`	是的

OpenAI.WebSearchToolCallItemResource

Web 搜索工具调用的结果。有关更多信息，请参阅网络搜索指南。

姓名	类型	Description	必选
操作	对象		是的
└─ 类型	OpenAI.WebSearchActionType		否
状态	枚举	Web 搜索工具调用的状态。可能的值：`in_progress`、`searching`、`completed`、`failed`	是的
类型	枚举	可能的值：`web_search_call`	是的

OpenAI.integer

类型：整数

格式：int64

OpenAI.numeric

类型：数字

格式：double

OpenApiAgentTool

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

姓名	类型	Description	必选
openapi	对象	openapi 函数的输入定义信息。	是的
~~ 身份验证	OpenApiAuthDetails	打开 API 身份验证详细信息	否
default_params	数组	将使用用户提供的默认值的 OpenAPI 规范参数列表	否
└─ 说明	字符串	函数作用的描述，由模型用于选择何时以及如何调用函数。	否
~~ 函数	数组	OpenApi 工具使用的函数定义列表	否
└─ 名称	字符串	要调用的函数的名称。	否
~~ 规范		openapi 函数形状，描述为 JSON 架构对象。	否
类型	枚举	对象类型，始终为“openapi”。可能的值：`openapi`	是的

OpenApiAnonymousAuthDetails

OpenApi 匿名身份验证的安全详细信息

姓名	类型	Description	必选	违约
类型	枚举	对象类型，始终为“anonymous”。可能的值：`anonymous`	是的

OpenApiAuthDetails

OpenApiFunctionDefinition 的身份验证详细信息

OpenApiAuthDetails 的鉴别器

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

类型值	Schema
`anonymous`	OpenApiAnonymousAuthDetails
`project_connection`	OpenApiProjectConnectionAuthDetails
`managed_identity`	OpenApiManagedAuthDetails

姓名	类型	Description	必选	违约
类型	对象	OpenApi 终端节点的身份验证类型。允许的类型是： - 匿名（无需身份验证） - 项目连接（需要project_connection_id终结点，如 Foundry 中的设置） - Managed_Identity（需要受众进行基于标识的身份验证）	是的

OpenApiAuthType

OpenApi 终端节点的身份验证类型。允许的类型是：

匿名（无需身份验证）
项目连接（需要project_connection_id终结点，如 Foundry 中的设置）
Managed_Identity （需要受众进行基于身份的身份验证）

资产	价值
类型	字符串
价值观	`anonymous` `project_connection` `managed_identity`

OpenApiFunctionDefinition

openapi 函数的输入定义信息。

姓名	类型	Description	必选
auth	对象	OpenApiFunctionDefinition 的身份验证详细信息	是的
└─ 类型	OpenApiAuthType	身份验证类型必须为匿名/project_connection/managed_identity	否
default_params	数组	将使用用户提供的默认值的 OpenAPI 规范参数列表	否
说明	字符串	函数作用的描述，由模型用于选择何时以及如何调用函数。	否
functions	数组	OpenApi 工具使用的函数定义列表	否
姓名	字符串	要调用的函数的名称。	是的
spec		openapi 函数形状，描述为 JSON 架构对象。	是的

OpenApiManagedAuthDetails

OpenApi managed_identity身份验证的安全详细信息

姓名	类型	Description	必选
security_scheme	对象	OpenApi managed_identity身份验证的安全方案	是的
~~ 访问群体	字符串	managed_identity身份验证类型的身份验证范围	否
类型	枚举	对象类型，始终为“managed_identity”。可能的值：`managed_identity`	是的

OpenApiManagedSecurityScheme

OpenApi managed_identity身份验证的安全方案

姓名	类型	Description	必选	违约
audience	字符串	managed_identity身份验证类型的身份验证范围	是的

OpenApiProjectConnectionAuthDetails

OpenApi 项目连接身份验证的安全详细信息

姓名	类型	Description	必选
security_scheme	对象	OpenApi managed_identity身份验证的安全方案	是的
project_connection_id	字符串	项目连接身份验证类型的项目连接 ID	否
类型	枚举	对象类型，始终为“project_connection”。可能的值：`project_connection`	是的

OpenApiProjectConnectionSecurityScheme

OpenApi managed_identity身份验证的安全方案

姓名	类型	Description	必选	违约
project_connection_id	字符串	项目连接身份验证类型的项目连接 ID	是的

PagedConnection

Connection 项的分页集合

姓名	类型	Description	必选	违约
nextLink	字符串	指向下一页项的链接	否
value	数组	此页面上的 Connection 项目	是的

PagedDatasetVersion

DatasetVersion 项的分页集合

姓名	类型	Description	必选	违约
nextLink	字符串	指向下一页项的链接	否
value	数组	此页上的 DatasetVersion 项	是的

PagedDeployment

Deployment 项的分页集合

姓名	类型	Description	必选	违约
nextLink	字符串	指向下一页项的链接	否
value	数组	此页上的“部署”项	是的

PagedEvaluationRule

EvaluationRule 项的分页集合

姓名	类型	Description	必选	违约
nextLink	字符串	指向下一页项的链接	否
value	数组	此页上的 EvaluationRule 项	是的

PagedEvaluationTaxonomy

EvaluationTaxonomy 项的分页集合

姓名	类型	Description	必选	违约
nextLink	字符串	指向下一页项的链接	否
value	数组	此页上的 EvaluationTaxonomy 项	是的

PagedEvaluatorVersion

EvaluatorVersion 项的分页集合

姓名	类型	Description	必选	违约
nextLink	字符串	指向下一页项的链接	否
value	数组	此页上的 EvaluatorVersion 项	是的

PagedIndex

索引项的分页集合

姓名	类型	Description	必选	违约
nextLink	字符串	指向下一页项的链接	否
value	数组	此页上的索引项	是的

PagedInsight

Insight 项的分页集合

姓名	类型	Description	必选	违约
nextLink	字符串	指向下一页项的链接	否
value	数组	此页上的“见解”项	是的

PagedRedTeam

RedTeam 项的分页集合

姓名	类型	Description	必选	违约
nextLink	字符串	指向下一页项的链接	否
value	数组	此页面上的 RedTeam 项目	是的

PagedSchedule

计划项的分页集合

姓名	类型	Description	必选	违约
nextLink	字符串	指向下一页项的链接	否
value	数组	此页上的“计划”项	是的

PagedScheduleRun

ScheduleRun 项的分页集合

姓名	类型	Description	必选	违约
nextLink	字符串	指向下一页项的链接	否
value	数组	此页面上的 ScheduleRun 项	是的

PendingUploadRequest

表示对待上载的请求。

姓名	类型	Description	必选
connectionName （连接名称）	字符串	用于生成临时 SAS 令牌的 Azure 存储帐户连接名称	否
pendingUploadId	字符串	如果未提供 PendingUploadId，则将使用随机 GUID。	否
pendingUploadType	枚举	BlobReference 是唯一支持的类型。可能的值：`BlobReference`	是的

PendingUploadResponse

表示待处理上传请求的响应

姓名	类型	Description	必选
blobReference	对象	Blob 引用详细信息。	是的
~~ blobUri	字符串	用于上传数据的客户端的 Blob URI 路径。示例： `https://blob.windows.core.net/Container/Path`	否
~~ 凭据	SasCredential	用于访问存储帐户的凭据信息。	否
~~ storageAccountArmId	字符串	要使用的存储帐户的 ARM ID。	否
pendingUploadId	字符串	此上传请求的 ID。	是的
pendingUploadType	枚举	BlobReference 是唯一支持的类型可能的值：`BlobReference`	是的
版本	字符串	如果用户在最初创建上传时未指定版本，则要创建的资产版本	否

PromptAgentDefinition

提示代理定义

姓名	类型	Description	必选	违约
instructions	字符串	插入到模型上下文中的系统（或开发人员）消息。	否
kind	枚举	可能的值：`prompt`	是的
模型	字符串	要用于此代理的模型部署。	是的
reasoning	对象	仅适用于 O 系列模型推理模型的配置选项。	否
努力	OpenAI.ReasoningEffort	限制推理模型的推理力度。当前支持的值为 none、minimal、low、medium 和 high。减少推理工作量可以加快回复速度，减少回复中用于推理的标记。 gpt-5.1 默认为 none，不执行推理。 gpt-5.1 支持的推理值为无、低、中和高。 gpt-5.1 中的所有推理值都支持工具调用。 gpt-5.1 之前的所有模型默认为中等推理工作量，并且不支持 none。 gpt-5-pro 模型默认为（仅支持）高推理工作量。	否
生成摘要	枚举	已弃用：请改用`summary`。模型执行的推理摘要。这对于调试和了解模型的推理过程非常有用。 `auto`、`concise` 或 `detailed` 之一。可能的值：`auto`、、 `concisedetailed`	否
~~ 摘要	枚举	模型执行的推理摘要。这可以是可用于调试和了解模型的推理过程。 `auto`、`concise` 或 `detailed` 之一。可能的值：`auto`、、 `concisedetailed`	否
structured_inputs	对象	可以参与提示模板替换或工具参数绑定的结构化输入集。	否
温度	数字	要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性我们通常建议更改此设置或 `top_p`，但不要同时更改两者。	否	1
文本消息	对象	来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。	否
└─ 格式	OpenAI.ResponseTextFormatConfiguration		否
工具	数组	生成响应时，模型可能会调用的工具数组。你可以通过设置 `tool_choice` 参数来指定要使用的工具。	否
top_p	数字	使用温度进行采样的替代方法，称为核采样，其中，模型考虑具有 top_p 概率质量的令牌的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。我们通常建议更改此设置或 `temperature`，但不要同时更改两者。	否	1

PromptBasedEvaluatorDefinition

基于提示的评估器

姓名	类型	Description	必选	违约
prompt_text	字符串	用于评估的提示文本	是的
类型	枚举	可能的值：`prompt`	是的

ProtocolVersionRecord

单个协议及其版本的记录映射。

姓名	类型	Description	必选	违约
协议	对象		是的
版本	字符串	协议的版本字符串，例如“v0.1.1”。	是的

RaiConfig

负责任 AI （RAI）内容筛选和安全功能的配置。

姓名	类型	Description	必选	违约
rai_policy_name	字符串	要应用的 RAI 策略的名称。	是的

RecurrenceSchedule

定期计划模型。

RecurrenceSchedule 的鉴别器

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

类型值	Schema
`Hourly`	HourlyRecurrenceSchedule
`Daily`	DailyRecurrenceSchedule
`Weekly`	WeeklyRecurrenceSchedule
`Monthly`	MonthlyRecurrenceSchedule

姓名	类型	Description	必选	违约
类型	对象	重复类型。	是的

RecurrenceTrigger

基于重复的触发器。

姓名	类型	Description	必选	违约
endTime	字符串	ISO 8601 格式的定期计划的结束时间。	否
间隔	整数	定期计划的时间间隔。	是的
时间表	对象	定期计划模型。	是的
└─ 类型	RecurrenceType	定期计划的重复类型。	否
startTime	字符串	ISO 8601 格式的定期计划的开始时间。	否
timeZone	字符串	定期计划的时区。	否	UTC
类型	枚举	触发器的类型。可能的值：`Recurrence`	是的

RecurrenceType

重复类型。

资产	价值
说明	重复类型。
类型	字符串
价值观	`Hourly` `Daily` `Weekly` `Monthly`

RedTeam

红队详情。

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

RedTeamItemGenerationParams

表示用于生成红色团队项的参数。

姓名	类型	Description	必选
attack_strategies	数组	要使用的攻击策略的集合。	是的
num_turns	整数	游戏中允许的轮次数。	是的
类型	枚举	项生成参数的类型，始终 `red_team`为。可能的值：`red_team`	是的

RiskCategory

攻击目标的风险类别。

资产	价值
说明	攻击目标的风险类别。
类型	字符串
价值观	`HateUnfairness` `Violence` `Sexual` `SelfHarm` `ProtectedMaterial` `CodeVulnerability` `UngroundedAttributes` `ProhibitedActions` `SensitiveDataLeakage` `TaskAdherence`

SASCredentials

共享访问签名（SAS）凭据定义

姓名	类型	Description	必选	违约
SAS	字符串	SAS 令牌	否
类型	枚举	凭据类型可能的值：`SAS`	是的

SampleType

分析中使用的样品类型。

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

SasCredential 证书

SAS 凭证定义

姓名	类型	Description	必选	违约
sasUri	字符串	SAS URI	是的
类型	枚举	凭证类型可能的值：`SAS`	是的

时间表

计划模型。

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

ScheduleProvisioningStatus

计划配置状态。

资产	价值
说明	计划配置状态。
类型	字符串
价值观	`Creating` `Updating` `Deleting` `Succeeded` `Failed`

ScheduleRun

计划运行模型。

姓名	类型	Description	必选
错误	字符串	计划运行的错误信息。	否
id	字符串	计划运行的标识符。	是的
属性	对象	计划运行的属性。	是的
scheduleId	字符串	计划的标识符。	是的
success	布尔	触发计划运行的成功状态。	是的
triggerTime	字符串	计划运行的触发时间。	否

ScheduleTask

计划任务模型。

ScheduleTask 的鉴别器

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

类型值	Schema
`Evaluation`	EvaluationScheduleTask
`Insight`	InsightScheduleTask

姓名	类型	Description	必选	违约
配置	对象	任务的配置。	否
类型	对象	任务的类型。	是的

ScheduleTaskType

任务的类型。

资产	价值
说明	任务的类型。
类型	字符串
价值观	`Evaluation` `Insight`

SeedPromptsRedTeamItemGenerationParams

表示使用种子提示生成红色团队项的参数。

姓名	类型	Description	必选
attack_strategies	数组	要使用的攻击策略的集合。	是的
num_turns	整数	游戏中允许的轮次数。	是的
源	对象		是的
└─ 内容	数组	jsonl 文件的内容。	否
└─ 身份	字符串	文件的标识符。	否
└─ 类型	枚举	jsonl 源的类型。始终为 `file_id`。可能的值：`file_id`	否
类型	枚举	项生成参数的类型，始终 `red_team`为。可能的值：`red_team_seed_prompts`	是的

SharepointAgentTool

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

姓名	类型	Description	必选
sharepoint_grounding_preview	对象	SharePoint 接地工具参数。	是的
project_connections	数组	附加到此工具的项目连接。最多可以有 1 个连接附加到该工具的资源。	否
类型	枚举	对象类型，始终为“sharepoint_grounding”。可能的值：`sharepoint_grounding_preview`	是的

SharepointGroundingToolParameters

SharePoint 接地工具参数。

姓名	类型	Description	必选	违约
project_connections	数组	附加到此工具的项目连接。最多可以有 1 个连接附加到该工具的资源。	否

Sku

Sku 信息

姓名	类型	Description	必选
产能	整数	Sku 容量	是的
family	字符串	Sku 家族	是的
姓名	字符串	Sku 名称	是的
大小	字符串	Sku 大小	是的
分层	字符串	Sku 层	是的

StructuredInputDefinition

可以参与提示模板替换和工具参数绑定的结构化输入。

姓名	类型	Description	必选	违约
default_value		如果未提供运行时值，则输入的默认值。	否
说明	字符串	输入的人类可读描述。	否
（必需）	布尔	调用代理时是否需要输入属性。	否	假
架构		结构化输入的 JSON 架构（可选）。	否

StructuredOutputDefinition

代理可以生成的结构化输出。

姓名	类型	Description	必选
说明	字符串	要发出的输出的描述。模型用于确定何时发出输出。	是的
姓名	字符串	结构化输出的名称。	是的
架构		结构化输出的 JSON 架构。	是的
strict	布尔	是否强制执行严格验证。默认 `true`。	是的

StructuredOutputsItemResource

姓名	类型	Description	必选	违约
输出		响应期间捕获的结构化输出。	是的
类型	枚举	可能的值：`structured_outputs`	是的

目标

具有鉴别器支持的目标的基类。

目标鉴别器

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

类型值	Schema
`azure_ai_model`	AzureAIModelTarget
`azure_ai_agent`	AzureAIAgentTarget
`azure_ai_assistant`	AzureAIAssistantTarget

姓名	类型	Description	必选	违约
类型	字符串	目标的类型。	是的

TargetCompletions

表示基于目标的完成评估配置的数据源。

姓名	类型	Description	必选
输入消息	对象		否
item_reference	字符串		否
└─ 类型	枚举	可能的值：`item_reference`	否
源	对象		是的
└─ 内容	数组	jsonl 文件的内容。	否
└─ 身份	字符串	文件的标识符。	否
└─ 类型	枚举	jsonl 源的类型。始终为 `file_id`。可能的值：`file_id`	否
目标	对象	具有鉴别器支持的目标的基类。	是的
└─ 类型	字符串	目标的类型。	否
类型	枚举	数据源的类型，始终 `TargetCompletions`为。可能的值：`azure_ai_target_completions`	是的

TargetConfig

目标配置的抽象类。

TargetConfig 的鉴别器

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

类型值	Schema
`AzureOpenAIModel`	AzureOpenAIModelConfiguration

姓名	类型	Description	必选	违约
类型	字符串	模型配置的类型。	是的

TargetUpdate

具有鉴别器支持的目标的基类。

TargetUpdate 的鉴别器

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

类型值	Schema
`azure_ai_model`	AzureAIModelTargetUpdate
`azure_ai_assistant`	AzureAIAssistantTargetUpdate

姓名	类型	Description	必选	违约
类型	字符串	目标的类型。	是的

TaxonomyCategory

分类类别定义。

姓名	类型	Description	必选
说明	字符串	分类类别的描述。	否
id	字符串	分类类别的唯一标识符。	是的
姓名	字符串	分类类别的名称。	是的
属性	对象	分类类别的其他属性。	否
riskCategory	对象	攻击目标的风险类别。	是的
subCategories	数组	分类学子类别列表。	是的

TaxonomyRedTeamItemGenerationParams

表示使用种子提示生成红色团队项的参数。

姓名	类型	Description	必选
attack_strategies	数组	要使用的攻击策略的集合。	是的
num_turns	整数	游戏中允许的轮次数。	是的
源	对象		是的
└─ 内容	数组	jsonl 文件的内容。	否
└─ 身份	字符串	文件的标识符。	否
└─ 类型	枚举	jsonl 源的类型。始终为 `file_id`。可能的值：`file_id`	否
类型	枚举	项生成参数的类型，始终 `red_team`为。可能的值：`red_team_taxonomy`	是的

TaxonomySubCategory

分类学子类别定义。

姓名	类型	Description	必选
说明	字符串	分类学子类别的描述。	否
enabled	布尔	此子类别下的分类项列表。	是的
id	字符串	分类子类别的唯一标识符。	是的
姓名	字符串	分类子类别的名称。	是的
属性	对象	分类子类别的其他属性。	否

ToolDescription

代理可以使用的工具的描述。

姓名	类型	Description	必选	违约
说明	字符串	该工具用途的简要说明。	否
姓名	字符串	工具的名称。	否

ToolProjectConnection

项目连接资源。

姓名	类型	Description	必选	违约
project_connection_id	字符串	附加到此工具的 ToolProjectConnectionList 中的项目连接。	是的

TracesEvalRunDataSource

表示用于对 Application Insights 中存储的代理跟踪运行的计算运行的数据源。

姓名	类型	Description	必选	违约
lookback_hours	整数	从 Application Insights 检索跟踪时应用的回溯窗口（以小时为单位）。	否	168
trace_ids	数组	应评估的代理跟踪标识符的集合。	是的
类型	枚举	数据源的类型，始终 `azure_ai_traces`为。可能的值：`azure_ai_traces`	是的

TreatmentEffectType

治疗效果类型。

资产	价值
类型	字符串
价值观	`TooFewSamples` `Inconclusive` `Changed` `Improved` `Degraded`

Trigger

计划触发器的基本模型。

触发器的鉴别器

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

类型值	Schema
`Cron`	CronTrigger 的
`Recurrence`	RecurrenceTrigger 触发器
`OneTime`	OneTimeTrigger

姓名	类型	Description	必选	违约
类型	对象	触发器的类型。	是的

触发类型

触发器的类型。

资产	价值
说明	触发器的类型。
类型	字符串
价值观	`Cron` `Recurrence` `OneTime`

UpdateAgentFromManifestRequest

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

UpdateAgentRequest

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

UpdateEvalParametersBody

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

UserProfileMemoryItem

专门包含从对话中提取的用户个人资料信息的记忆项，例如偏好、兴趣和个人详细信息。

姓名	类型	Description	必选	违约
kind	枚举	记忆项目的种类。可能的值：`user_profile`	是的

WeeklyRecurrenceSchedule

每周重复计划。

姓名	类型	Description	必选	违约
daysOfWeek	数组	重复计划的一周中的几天。	是的
类型	枚举	每周重复类型。可能的值：`Weekly`	是的

WorkflowActionOutputItemResource

姓名	类型	Description	必选
action_id	字符串	作的唯一标识符。	是的
kind	字符串	CSDL作的类型（例如“SetVariable”、“InvokeAzureAgent”）。	是的
parent_action_id	字符串	如果这是嵌套作，则为父作的 ID。	否
previous_action_id	字符串	如果此作遵循另一个作，则为上一作的 ID。	否
状态	枚举	作的状态（例如“in_progress”、“completed”、“failed”、“cancelled”）。可能的值：`completed`、`failed`、`in_progress`、`cancelled`	是的
类型	枚举	可能的值：`workflow_action`	是的

WorkflowAgentDefinition

工作流代理定义。

姓名	类型	Description	必选	违约
kind	枚举	可能的值：`workflow`	是的
工作流	字符串	工作流的 CSDL YAML 定义。	否

整数

类型：整数

格式：int64

反馈

此页面是否有帮助？

Last updated on 2026-02-28