Runs - Create Run

服务:

AI Foundry

API 版本:

v1

为代理线程创建新运行。

POST {endpoint}/threads/{threadId}/runs?api-version=v1

具有可选参数:

POST {endpoint}/threads/{threadId}/runs?api-version=v1&include[]=step_details.tool_calls[*].file_search.results[*].content

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string (uri)	项目端点，其形式为： https://.services.ai.azure.com/api/projects/
threadId	path	True	string	线程的标识符。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。
include[]	query		RunAdditionalFieldList[]	要包含在响应中的其他字段的列表。 目前唯一支持的值是 step_details.tool_calls[*].file_search.results[*].content 提取文件搜索结果内容。

请求正文

名称	必需	类型	说明
assistant_id	True	string	应运行线程的代理的 ID。
additional_instructions		string	要追加到运行指令末尾的其他说明。 这对不替代其他指令的情况下按运行修改行为很有用。
additional_messages		ThreadMessageOptions[]	在创建运行之前，将其他消息添加到线程。
instructions		string	重写的系统说明，代理应使用该指令来运行线程。
max_completion_tokens		integer (int32)	在运行过程中可能会使用的完成令牌的最大数目。 在多轮运行中，运行将尽最大可能地只使用指定的补全令牌数。 如果运行超过指定的补全令牌数，则运行将以状态 incomplete 结束。 有关详细信息，请参阅 incomplete_details。
max_prompt_tokens		integer (int32)	在运行过程中可能会使用的提示令牌的最大数目。 在多轮运行中，运行将尽最大可能地只使用指定的提示令牌数。 如果运行超过指定的提示令牌数，则运行将以状态 incomplete 结束。 有关详细信息，请参阅 incomplete_details。
metadata		object	一组最多可以附加到对象的 16 个键/值对，用于以结构化格式存储有关该对象的其他信息。 键长度可能最多为 64 个字符，值长度可能最多为 512 个字符。
model		string	代理应用于运行线程的重写模型名称。
parallel_tool_calls		boolean	如果在工具使用期间 true 函数将并行运行。
response_format		AgentsResponseFormatOption	指定模型必须输出的格式。
stream		boolean	如果为 true，则返回在运行为服务器发送事件期间发生的事件流，在运行进入附带 data: [DONE] 消息的终端状态时终止。
temperature		number (float)	要使用的采样温度，介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性
tool_choice		AgentsToolChoiceOption	控制模型是否调用了哪个工具。
tools		ToolDefinition[]: AzureAISearchToolDefinition[] AzureFunctionToolDefinition[] BingGroundingToolDefinition[] CodeInterpreterToolDefinition[] ConnectedAgentToolDefinition[] FileSearchToolDefinition[] FunctionToolDefinition[] OpenApiToolDefinition[]	代理应用于运行线程的已启用工具的重写列表。
top_p		number (float)	温度采样的替代方法，称为核采样，其中模型考虑具有 top_p 概率质量的令牌的结果。 所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。 我们通常建议更改此设置或温度，但不要同时更改这两者。
truncation_strategy		TruncationObject	在上下文窗口向前移动时用于删除消息的策略。

响应

名称	类型	说明
200 OK	ThreadRun	有关新线程运行的信息。
Other Status Codes	AgentV1Error	意外的错误响应。

安全性

OAuth2Auth

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

作用域

名称	说明
https://ai.azure.com/.default

定义

名称	说明
AgentErrorDetail	描述代理 API 返回的错误信息。
AgentV1Error	代理 API 返回的错误负载。
AISearchIndexResource	AI 搜索索引资源。
AzureAISearchQueryType	Azure AI 搜索工具的可用查询类型。
AzureAISearchToolDefinition	用于配置代理的 Azure AI 搜索工具的输入定义信息。
AzureAISearchToolResource	azure_ai_search 工具使用的一组索引资源。
AzureFunctionBinding	用于保留存储队列名称和 URI 的结构。
AzureFunctionDefinition	Azure 函数的定义。
AzureFunctionStorageQueue	用于保留存储队列名称和 URI 的结构。
AzureFunctionToolDefinition	用于配置代理的 Azure 函数工具的输入定义信息。
BingGroundingSearchConfiguration	搜索 Bing Grounding 的配置
BingGroundingSearchToolParameters	bing 接地搜索工具参数。
BingGroundingToolDefinition	用于配置代理的必应地面搜索工具的输入定义信息。
CodeInterpreterToolDefinition	用于配置代理的代码解释器工具的输入定义信息。
CodeInterpreterToolResource	code_interpreter 工具使用的一组资源。
ConnectedAgentDetails	将一个代理作为工具连接到另一个代理的信息
ConnectedAgentToolDefinition	已连接代理程序工具的输入定义信息，用于定义特定于域的子代理程序
CreateRunOptions	创建新代理线程运行时使用的详细信息。
FileSearchRankingOptions	文件搜索的排名选项。
FileSearchToolDefinition	用于配置代理的文件搜索工具的输入定义信息。
FileSearchToolDefinitionDetails	文件搜索工具的选项替代。
FileSearchToolResource	file_search 工具使用的一组资源。
FunctionDefinition	函数的输入定义信息。
FunctionToolDefinition	用于配置代理的函数工具的输入定义信息。
IncompleteDetailsReason	运行不完整的原因。 这将指出在运行过程中达到了哪个特定令牌限制。
IncompleteRunDetails	有关运行为何不完整的详细信息。 如果运行不完整，将 null。
MessageAttachment	这描述了文件已附加到哪些工具。
MessageRole	归因于线程中消息的角色的可能值。
OpenApiAnonymousAuthDetails	OpenApi 匿名身份验证的安全详细信息
OpenApiAuthType	OpenApi 终端节点的身份验证类型。 允许的类型包括： 匿名（无需身份验证） 连接（需要connection_id到端点，如 AI Foundry 中的设置） Managed_Identity （需要受众进行基于身份的身份验证）
OpenApiConnectionAuthDetails	OpenApi 连接身份验证的安全详细信息
OpenApiConnectionSecurityScheme	OpenApi managed_identity身份验证的安全方案
OpenApiFunctionDefinition	openapi 函数的输入定义信息。
OpenApiManagedAuthDetails	OpenApi managed_identity身份验证的安全详细信息
OpenApiManagedSecurityScheme	OpenApi managed_identity身份验证的安全方案
OpenApiToolDefinition	用于配置代理的 OpenAPI 工具的输入定义信息。
RequiredFunctionToolCall	对函数工具的请求调用的表示形式，模型需要它才能继续评估运行。
RequiredFunctionToolCallDetails	调用函数工具所需的操作提供函数调用的详细信息，其中包括函数的名称和参数。
RunAdditionalFieldList	要包含在响应中的其他字段的列表。
RunCompletionUsage	与运行相关的使用情况统计信息。 如果运行不处于终端状态（即 null、in_progress等），则此值将 queued。
RunError	代理线程运行遇到的错误的详细信息。
RunStatus	代理线程运行状态的可能值。
SubmitToolOutputsAction	必须提交代理线程运行才能继续的所需工具调用的详细信息。
SubmitToolOutputsDetails	描述应调用以提交工具输出的工具的详细信息。
ThreadMessageOptions	代理线程中的单个消息，在该线程创建期间为初始状态提供。
ThreadRun	表示代理线程的单个评估运行的数据。
ToolResources	代理工具使用的一组资源。 资源特定于工具类型。 例如，code_interpreter 工具需要文件 ID 列表，而 file_search 工具需要矢量存储 ID 列表。
TruncationObject	用于指示在运行之前如何截断线程的控件。 使用此控件可控制运行的初始上下文窗口。
TruncationStrategy	线程的可能截断策略。
VectorStoreConfiguration	矢量存储配置是数据源列表，当多个文件可用于企业文件搜索时使用。
VectorStoreConfigurations	结构，包含矢量存储配置列表，即 Azure 资产 ID 的列表。
VectorStoreDataSource	结构，包含 Azure 资产 URI 路径和用作企业文件搜索数据源的文件的资产类型。
VectorStoreDataSourceAssetType	矢量存储资产的类型。 资产类型可以是uri_asset，在这种情况下，它应包含资产 URI ID，在这种情况下，它应包含数据 ID id_asset。

AgentErrorDetail

Object

描述代理 API 返回的错误信息。

名称	类型	说明
code	string	机器可读的错误代码。
message	string	错误的可读描述。
param	string	导致错误的参数的名称（如果适用）。
type	string	错误类型标识符（例如 invalid_request_error）。

AgentV1Error

Object

代理 API 返回的错误负载。

名称	类型	说明
error	AgentErrorDetail	表示错误。

AISearchIndexResource

Object

AI 搜索索引资源。

名称	类型	说明
filter	string	搜索资源的 filter 字符串。
index_asset_id	string	为搜索资源的资产 ID 编制索引。
index_connection_id	string	附加到此代理的 IndexResource 中的索引连接 ID。
index_name	string	附加到此代理的 IndexResource 中的索引的名称。
query_type	AzureAISearchQueryType	附加到此代理的 AIIndexResource 中的查询类型。
top_k	integer (int32)	要从搜索中检索到的文档数，并将其呈现到模型。

AzureAISearchQueryType

枚举

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

值	说明
semantic	查询类型 semantic
simple	查询类型 simple
vector	查询类型 vector
vector_semantic_hybrid	查询类型 vector_semantic_hybrid
vector_simple_hybrid	查询类型 vector_simple_hybrid

AzureAISearchToolDefinition

Object

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

名称	类型	说明
type	string: azure_ai_search	对象类型。

AzureAISearchToolResource

Object

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

名称	类型	说明
indexes	AISearchIndexResource[]	附加到此代理的索引。 最多可以有 1 个索引资源附加到代理。

AzureFunctionBinding

Object

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

名称	类型	说明
storage_queue	AzureFunctionStorageQueue	存储队列。
type	enum: storage_queue	绑定的类型，始终为“storage_queue”。

AzureFunctionDefinition

Object

Azure 函数的定义。

名称	类型	说明
function	FunctionDefinition	Azure 函数的定义及其参数。
input_binding	AzureFunctionBinding	输入存储队列。 队列存储触发器在向其中添加消息时运行函数。
output_binding	AzureFunctionBinding	输出存储队列。 处理输入项时，该函数会将输出写入此队列。

AzureFunctionStorageQueue

Object

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

名称	类型	说明
queue_name	string	Azure 函数存储队列的名称。
queue_service_endpoint	string	Azure 存储队列服务的 URI，允许你作队列。

AzureFunctionToolDefinition

Object

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

名称	类型	说明
azure_function	AzureFunctionDefinition	函数工具应调用的具体函数的定义。
type	string: azure_function	对象类型。

BingGroundingSearchConfiguration

Object

搜索 Bing Grounding 的配置

名称	类型	说明
connection_id	string	使用 bing 搜索接地的连接 ID
count	integer (int64)	要在 bing api 响应中返回的搜索结果数
freshness	string	按特定时间范围筛选搜索结果。 接受的值： https://learn.microsoft.com/bing/search-apis/bing-web-search/reference/query-parameters
market	string	结果来源的市场。
set_lang	string	调用 Bing API 时用于用户界面字符串的语言。

BingGroundingSearchToolParameters

Object

bing 接地搜索工具参数。

名称	类型	说明
search_configurations	BingGroundingSearchConfiguration[]	附加到此工具的搜索配置。 该工具最多可以附加 1 个搜索配置资源。

BingGroundingToolDefinition

Object

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

名称	类型	说明
bing_grounding	BingGroundingSearchToolParameters	bing 接地搜索工具参数。
type	string: bing_grounding	对象类型。

CodeInterpreterToolDefinition

Object

用于配置代理的代码解释器工具的输入定义信息。

名称	类型	说明
type	string: code_interpreter	对象类型。

CodeInterpreterToolResource

Object

code_interpreter 工具使用的一组资源。

名称	类型	说明
data_sources	VectorStoreDataSource[]	要使用的数据源。 此选项与 fileIds 属性互斥。
file_ids	string[]	可供 code_interpreter 工具使用的文件 ID 列表。 最多可以有 20 个与该工具关联的文件。

ConnectedAgentDetails

Object

将一个代理作为工具连接到另一个代理的信息

名称	类型	说明
description	string	代理执行的作的描述，模型使用它来选择何时以及如何调用代理。
id	string	子代理的标识符。
name	string	要调用的代理的名称。

ConnectedAgentToolDefinition

Object

已连接代理程序工具的输入定义信息，用于定义特定于域的子代理程序

名称	类型	说明
connected_agent	ConnectedAgentDetails	要连接的子代理
type	string: connected_agent	对象类型。

CreateRunOptions

Object

创建新代理线程运行时使用的详细信息。

名称	类型	默认值	说明
additional_instructions	string		要追加到运行指令末尾的其他说明。 这对不替代其他指令的情况下按运行修改行为很有用。
additional_messages	ThreadMessageOptions[]		在创建运行之前，将其他消息添加到线程。
assistant_id	string		应运行线程的代理的 ID。
instructions	string		重写的系统说明，代理应使用该指令来运行线程。
max_completion_tokens	integer (int32)		在运行过程中可能会使用的完成令牌的最大数目。 在多轮运行中，运行将尽最大可能地只使用指定的补全令牌数。 如果运行超过指定的补全令牌数，则运行将以状态 incomplete 结束。 有关详细信息，请参阅 incomplete_details。
max_prompt_tokens	integer (int32)		在运行过程中可能会使用的提示令牌的最大数目。 在多轮运行中，运行将尽最大可能地只使用指定的提示令牌数。 如果运行超过指定的提示令牌数，则运行将以状态 incomplete 结束。 有关详细信息，请参阅 incomplete_details。
metadata	object		一组最多可以附加到对象的 16 个键/值对，用于以结构化格式存储有关该对象的其他信息。 键长度可能最多为 64 个字符，值长度可能最多为 512 个字符。
model	string		代理应用于运行线程的重写模型名称。
parallel_tool_calls	boolean		如果在工具使用期间 true 函数将并行运行。
response_format	AgentsResponseFormatOption		指定模型必须输出的格式。
stream	boolean		如果为 true，则返回在运行为服务器发送事件期间发生的事件流，在运行进入附带 data: [DONE] 消息的终端状态时终止。
temperature	number (float)	1	要使用的采样温度，介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性
tool_choice	AgentsToolChoiceOption		控制模型是否调用了哪个工具。
tools	ToolDefinition[]: AzureAISearchToolDefinition[] AzureFunctionToolDefinition[] BingGroundingToolDefinition[] CodeInterpreterToolDefinition[] ConnectedAgentToolDefinition[] FileSearchToolDefinition[] FunctionToolDefinition[] OpenApiToolDefinition[]		代理应用于运行线程的已启用工具的重写列表。
top_p	number (float)	1	温度采样的替代方法，称为核采样，其中模型考虑具有 top_p 概率质量的令牌的结果。 所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。 我们通常建议更改此设置或温度，但不要同时更改这两者。
truncation_strategy	TruncationObject		在上下文窗口向前移动时用于删除消息的策略。

FileSearchRankingOptions

Object

文件搜索的排名选项。

名称	类型	说明
ranker	string	文件搜索排名器。
score_threshold	number (float)	排名器搜索阈值。

FileSearchToolDefinition

Object

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

名称	类型	说明
file_search	FileSearchToolDefinitionDetails	文件搜索工具的选项替代。
type	string: file_search	对象类型。

FileSearchToolDefinitionDetails

Object

文件搜索工具的选项替代。

名称	类型	说明
max_num_results	integer (int32) minimum: 1 maximum: 50	文件搜索工具应输出的最大结果数。 对于 gpt-4* 模型，默认值为 20；对于 gpt-3.5-turbo，默认值为 5。 此数字应介于 1 和 50 之间（含）。 请注意，文件搜索工具输出的结果可能会少于 max_num_results 个。 有关详细信息，请参阅文件搜索工具文档。
ranking_options	FileSearchRankingOptions	文件搜索的排名选项。

FileSearchToolResource

Object

file_search 工具使用的一组资源。

名称	类型	说明
vector_store_ids	string[]	附加到此代理的向量存储的 ID。 最多可以有 1 个向量存储附加到代理。
vector_stores	VectorStoreConfigurations[]	来自 Azure 的矢量存储配置对象列表。 此列表限制为一个元素。 此列表的唯一元素包含搜索工具使用的 Azure 资产 ID 列表。

FunctionDefinition

Object

函数的输入定义信息。

名称	类型	说明
description	string	函数作用的描述，由模型用于选择何时以及如何调用函数。
name	string	要调用的函数的名称。
parameters		函数接受的参数，被描述为 JSON 架构对象。

FunctionToolDefinition

Object

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

名称	类型	说明
function	FunctionDefinition	函数工具应调用的具体函数的定义。
type	string: function	对象类型。

IncompleteDetailsReason

枚举

运行不完整的原因。 这将指出在运行过程中达到了哪个特定令牌限制。

值	说明
max_completion_tokens	超出最大完成令牌数
max_prompt_tokens	超出最大提示令牌数

IncompleteRunDetails

Object

有关运行为何不完整的详细信息。 如果运行不完整，将 null。

名称	类型	说明
reason	IncompleteDetailsReason	运行不完整的原因。 这表示在运行期间达到了特定的令牌限制。

MessageAttachment

Object

这描述了文件已附加到哪些工具。

名称	类型	说明
data_source	VectorStoreDataSource	Azure 资产 ID。
file_id	string	要附加到消息的文件的 ID。
tools	MessageAttachmentToolDefinition[]	要添加到此文件的工具。

MessageRole

枚举

归因于线程中消息的角色的可能值。

值	说明
assistant	表示代理的角色。
user	表示最终用户的角色。

OpenApiAnonymousAuthDetails

Object

OpenApi 匿名身份验证的安全详细信息

名称	类型	说明
type	string: anonymous	身份验证类型必须为 anonymous/connection/managed_identity

OpenApiAuthType

枚举

OpenApi 终端节点的身份验证类型。 允许的类型包括：

• 匿名（无需身份验证）
• 连接（需要connection_id到端点，如 AI Foundry 中的设置）
• Managed_Identity （需要受众进行基于身份的身份验证）

值	说明
anonymous
connection
managed_identity

OpenApiConnectionAuthDetails

Object

OpenApi 连接身份验证的安全详细信息

名称	类型	说明
security_scheme	OpenApiConnectionSecurityScheme	连接身份验证安全详细信息
type	string: connection	身份验证类型必须为 anonymous/connection/managed_identity

OpenApiConnectionSecurityScheme

Object

OpenApi managed_identity身份验证的安全方案

名称	类型	说明
connection_id	string	连接身份验证类型的连接 ID

OpenApiFunctionDefinition

Object

openapi 函数的输入定义信息。

名称	类型	说明
auth	OpenApiAuthDetails: OpenApiAnonymousAuthDetails OpenApiConnectionAuthDetails OpenApiManagedAuthDetails	打开 API 身份验证详细信息
default_params	string[]	将使用用户提供的默认值的 OpenAPI 规范参数列表
description	string	函数作用的描述，由模型用于选择何时以及如何调用函数。
functions	FunctionDefinition[]	OpenApi 工具使用的函数定义列表
name	string	要调用的函数的名称。
spec		openapi 函数形状，描述为 JSON 架构对象。

OpenApiManagedAuthDetails

Object

OpenApi managed_identity身份验证的安全详细信息

名称	类型	说明
security_scheme	OpenApiManagedSecurityScheme	连接身份验证安全详细信息
type	string: managed_identity	身份验证类型必须为 anonymous/connection/managed_identity

OpenApiManagedSecurityScheme

Object

OpenApi managed_identity身份验证的安全方案

名称	类型	说明
audience	string	managed_identity身份验证类型的身份验证范围

OpenApiToolDefinition

Object

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

名称	类型	说明
openapi	OpenApiFunctionDefinition	openapi 函数定义。
type	string: openapi	对象类型。

RequiredFunctionToolCall

Object

对函数工具的请求调用的表示形式，模型需要它才能继续评估运行。

名称	类型	说明
function	RequiredFunctionToolCallDetails	有关由包含名称和参数的工具执行的函数的详细信息。
id	string	工具调用的 ID。 提交工具输出时必须引用此 ID。
type	string: function	所需工具调用的对象类型。

RequiredFunctionToolCallDetails

Object

调用函数工具所需的操作提供函数调用的详细信息，其中包括函数的名称和参数。

名称	类型	说明
arguments	string	调用命名函数时要使用的自变量，由模型提供。 参数呈现为 JSON 文档，应对其进行验证和分析以供评估。
name	string	函数的名称。

RunAdditionalFieldList

枚举

要包含在响应中的其他字段的列表。

值	说明
step_details.tool_calls[*].file_search.results[*].content	文件搜索结果内容。

RunCompletionUsage

Object

与运行相关的使用情况统计信息。 如果运行不处于终端状态（即 null、in_progress等），则此值将 queued。

名称	类型	说明
completion_tokens	integer (int64)	在运行过程中使用的补全令牌的数目。
prompt_tokens	integer (int64)	在运行过程中使用的提示令牌的最大数目。
total_tokens	integer (int64)	使用的令牌总数（提示 + 补全）。

RunError

Object

代理线程运行遇到的错误的详细信息。

名称	类型	说明
code	string	错误的状态。
message	string	与错误关联的人工可读文本。

RunStatus

枚举

代理线程运行状态的可能值。

值	说明
cancelled	表示已取消的运行。
cancelling	表示正在取消的运行。
completed	表示已成功完成的运行。
expired	表示在完成之前过期的运行。
failed	表示失败的运行。
in_progress	表示正在进行的运行。
queued	表示排队等待启动的运行。
requires_action	表示需要其他作 （例如工具输出提交） 才能继续的运行。

SubmitToolOutputsAction

Object

必须提交代理线程运行才能继续的所需工具调用的详细信息。

名称	类型	说明
submit_tool_outputs	SubmitToolOutputsDetails	描述应调用以提交工具输出的工具的详细信息。
type	string: submit_tool_outputs	对象类型。

SubmitToolOutputsDetails

Object

描述应调用以提交工具输出的工具的详细信息。

名称	类型	说明
tool_calls	RequiredToolCall[]: RequiredFunctionToolCall[]	必须解析代理线程运行才能继续的工具调用列表。

ThreadMessageOptions

Object

代理线程中的单个消息，在该线程创建期间为初始状态提供。

名称	类型	说明
attachments	MessageAttachment[]	附加到消息的文件列表及其应添加到的工具。
content	MessageInputContent	初始消息的内容。 这可以是基本字符串（如果只需要文本）或键入内容块的数组（例如，文本、image_file、image_url等）。
metadata	object	一组最多可以附加到对象的 16 个键/值对，用于以结构化格式存储有关该对象的其他信息。 键长度可能最多为 64 个字符，值长度可能最多为 512 个字符。
role	MessageRole	正在创建消息的实体的角色。 允许的值包括： user，它指示消息由实际用户发送（在大多数情况下应用于表示用户生成的消息），以及 assistant，指示消息由代理生成（使用此值将来自代理的消息插入到对话中）。

ThreadRun

Object

表示代理线程的单个评估运行的数据。

名称	类型	说明
assistant_id	string	与此运行所针对的线程关联的代理的 ID。
cancelled_at	integer (unixtime)	Unix 时间戳（以秒为单位）表示何时取消。
completed_at	integer (unixtime)	Unix 时间戳（以秒为单位）表示此时间。
created_at	integer (unixtime)	Unix 时间戳（以秒为单位）表示创建此对象的时间。
expires_at	integer (unixtime)	Unix 时间戳（以秒为单位）表示此项过期的时间。
failed_at	integer (unixtime)	Unix 时间戳（以秒为单位）表示此时间戳失败的时间。
id	string	可以在 API 终结点中引用的标识符。
incomplete_details	IncompleteRunDetails	有关运行为何不完整的详细信息。 如果运行不完整，将 null。
instructions	string	用于此代理线程运行的重写的系统指令。
last_error	RunError	此代理线程运行的最后一个错误（如果有）。
max_completion_tokens	integer (int32)	指定的在运行过程中已使用完成令牌的最大数目。
max_prompt_tokens	integer (int32)	指定的在运行过程中已使用提示令牌的最大数目。
metadata	object	一组最多可以附加到对象的 16 个键/值对，用于以结构化格式存储有关该对象的其他信息。 键长度可能最多为 64 个字符，值长度可能最多为 512 个字符。
model	string	要使用的模型的 ID。
object	enum: thread.run	对象类型，始终为“thread.run”。
parallel_tool_calls	boolean	确定是否可以在运行中并行执行工具。
required_action	RequiredAction: SubmitToolOutputsAction	代理线程运行继续所需的操作的详细信息。
response_format	AgentsResponseFormatOption	此运行中使用的工具调用的响应格式。
started_at	integer (unixtime)	Unix 时间戳（以秒为单位）表示此项的启动时间。
status	RunStatus	代理线程运行的状态。
temperature	number (float)	用于此运行的采样温度。 如果未设置，则默认值为 1。
thread_id	string	与此运行关联的线程的 ID。
tool_choice	AgentsToolChoiceOption	控制模型是否调用了哪个工具。
tool_resources	ToolResources	重写代理可用于此运行的工具。 这对于按运行修改行为非常有用
tools	ToolDefinition[]: AzureAISearchToolDefinition[] AzureFunctionToolDefinition[] BingGroundingToolDefinition[] CodeInterpreterToolDefinition[] ConnectedAgentToolDefinition[] FileSearchToolDefinition[] FunctionToolDefinition[] OpenApiToolDefinition[]	用于此代理线程运行的已启用重写的工具。
top_p	number (float)	用于此运行的核心采样值。 如果未设置，则默认值为 1。
truncation_strategy	TruncationObject	在上下文窗口向前移动时用于删除消息的策略。
usage	RunCompletionUsage	与运行相关的使用情况统计信息。 如果运行不处于终端状态（即 null、in_progress等），则此值将 queued。

ToolResources

Object

代理工具使用的一组资源。 资源特定于工具类型。 例如，code_interpreter 工具需要文件 ID 列表，而 file_search 工具需要矢量存储 ID 列表。

名称	类型	说明
azure_ai_search	AzureAISearchToolResource	由索引 ID 和名称组成的 azure_ai_search 工具使用的资源。
code_interpreter	CodeInterpreterToolResource	由文件 ID 组成的 code_interpreter 工具使用的资源。
file_search	FileSearchToolResource	由矢量存储 ID 组成的 file_search 工具使用的资源。

TruncationObject

Object

用于指示在运行之前如何截断线程的控件。 使用此控件可控制运行的初始上下文窗口。

名称	类型	默认值	说明
last_messages	integer (int32)		构造运行上下文时线程中的最新消息数。
type	TruncationStrategy	auto	用于线程的截断策略。 默认值为 auto。 如果设置为 last_messages，则线程将被截断为线程中最新消息的 lastMessages 计数。 设置为 auto 时，将删除线程中间的消息，以适应模型的上下文长度 max_prompt_tokens。

TruncationStrategy

枚举

线程的可能截断策略。

值	说明
auto	默认值。 线程中间的消息将被丢弃以适应模型的上下文长度。
last_messages	线程将截断为 lastMessages 最近消息的计数。

VectorStoreConfiguration

Object

矢量存储配置是数据源列表，当多个文件可用于企业文件搜索时使用。

名称	类型	说明
data_sources	VectorStoreDataSource[]	数据源

VectorStoreConfigurations

Object

结构，包含矢量存储配置列表，即 Azure 资产 ID 的列表。

名称	类型	说明
configuration	VectorStoreConfiguration	配置
name	string	名称

VectorStoreDataSource

Object

结构，包含 Azure 资产 URI 路径和用作企业文件搜索数据源的文件的资产类型。

名称	类型	说明
type	VectorStoreDataSourceAssetType	资产类型
uri	string	资产 URI。

VectorStoreDataSourceAssetType

枚举

矢量存储资产的类型。 资产类型可以是uri_asset，在这种情况下，它应包含资产 URI ID，在这种情况下，它应包含数据 ID id_asset。

值	说明
id_asset	数据 ID
uri_asset	Azure URI