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

CreateThreadAndRunOptionalParams interface

可选参数。

扩展

属性

instructions

重写的系统指令代理应用于运行线程。

maxCompletionTokens

在运行过程中可能会使用的完成令牌的最大数目。 在多轮运行中,运行将尽最大可能地只使用指定的补全令牌数。 如果运行超过指定的补全令牌数,则运行将以状态 incomplete 结束。 有关详细信息,请参阅 incomplete_details

maxPromptTokens

在运行过程中可能会使用的提示令牌的最大数目。 在多轮运行中,运行将尽最大可能地只使用指定的提示令牌数。 如果运行超过指定的提示令牌数,则运行将以状态 incomplete 结束。 有关详细信息,请参阅 incomplete_details

metadata

一组最多可以附加到对象的 16 个键/值对,用于以结构化格式存储有关该对象的其他信息。 键长度可能最多为 64 个字符,值长度可能最多为 512 个字符。

model

代理应用于运行线程的重写模型。

parallelToolCalls

如果在工具使用期间 true 函数将并行运行。

responseFormat

指定模型必须输出的格式。

stream

如果为 true,则返回在运行为服务器发送事件期间发生的事件流,在运行进入附带 data: [DONE] 消息的终端状态时终止。

temperature

要使用的采样温度,介于 0 和 2 之间。 较高的值(如 0.8)将使输出更随机,而较小的值(如 0.2)将使输出更集中且更具确定性

thread

用于创建新线程的详细信息。 如果未提供线程,将创建一个空线程。

toolChoice

控制模型是否调用了哪个工具。

toolResources

重写代理可用于此运行的工具。 这对于按运行修改行为非常有用

tools

代理应用来运行线程的已启用工具的重写列表。

topP

温度采样的替代方法,称为核采样,其中模型考虑具有 top_p 概率质量的令牌的结果。 所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。

我们通常建议更改此设置或温度,但不要同时更改这两者。

truncationStrategy

在上下文窗口向前移动时用于删除消息的策略。

继承属性

abortSignal

可用于中止请求的信号。

onResponse

在执行请求的作时,每次从服务器接收响应时调用的函数。 可以多次调用。

requestOptions

为此作创建和发送 HTTP 请求时使用的选项。

tracingOptions

启用跟踪时使用的选项。

属性详细信息

instructions

重写的系统指令代理应用于运行线程。

instructions?: null | string

属性值

null | string

maxCompletionTokens

在运行过程中可能会使用的完成令牌的最大数目。 在多轮运行中,运行将尽最大可能地只使用指定的补全令牌数。 如果运行超过指定的补全令牌数,则运行将以状态 incomplete 结束。 有关详细信息,请参阅 incomplete_details

maxCompletionTokens?: null | number

属性值

null | number

maxPromptTokens

在运行过程中可能会使用的提示令牌的最大数目。 在多轮运行中,运行将尽最大可能地只使用指定的提示令牌数。 如果运行超过指定的提示令牌数,则运行将以状态 incomplete 结束。 有关详细信息,请参阅 incomplete_details

maxPromptTokens?: null | number

属性值

null | number

metadata

一组最多可以附加到对象的 16 个键/值对,用于以结构化格式存储有关该对象的其他信息。 键长度可能最多为 64 个字符,值长度可能最多为 512 个字符。

metadata?: null | Record<string, string>

属性值

null | Record<string, string>

model

代理应用于运行线程的重写模型。

model?: null | string

属性值

null | string

parallelToolCalls

如果在工具使用期间 true 函数将并行运行。

parallelToolCalls?: boolean

属性值

boolean

responseFormat

指定模型必须输出的格式。

responseFormat?: null | AgentsResponseFormatOption

属性值

stream

如果为 true,则返回在运行为服务器发送事件期间发生的事件流,在运行进入附带 data: [DONE] 消息的终端状态时终止。

stream?: boolean

属性值

boolean

temperature

要使用的采样温度,介于 0 和 2 之间。 较高的值(如 0.8)将使输出更随机,而较小的值(如 0.2)将使输出更集中且更具确定性

temperature?: null | number

属性值

null | number

thread

用于创建新线程的详细信息。 如果未提供线程,将创建一个空线程。

thread?: AgentThreadCreationOptions

属性值

toolChoice

控制模型是否调用了哪个工具。

toolChoice?: null | AgentsToolChoiceOption

属性值

toolResources

重写代理可用于此运行的工具。 这对于按运行修改行为非常有用

toolResources?: null | ToolResources

属性值

null | ToolResources

tools

代理应用来运行线程的已启用工具的重写列表。

tools?: null | ToolDefinitionUnion[]

属性值

topP

温度采样的替代方法,称为核采样,其中模型考虑具有 top_p 概率质量的令牌的结果。 所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。

我们通常建议更改此设置或温度,但不要同时更改这两者。

topP?: null | number

属性值

null | number

truncationStrategy

在上下文窗口向前移动时用于删除消息的策略。

truncationStrategy?: null | TruncationObject

属性值

继承属性详细信息

abortSignal

可用于中止请求的信号。

abortSignal?: AbortSignalLike

属性值

继承自 OperationOptions.abortSignal 的

onResponse

在执行请求的作时,每次从服务器接收响应时调用的函数。 可以多次调用。

onResponse?: RawResponseCallback

属性值

继承自 OperationOptions.onResponse

requestOptions

为此作创建和发送 HTTP 请求时使用的选项。

requestOptions?: OperationRequestOptions

属性值

继承自 OperationOptions.requestOptions

tracingOptions

启用跟踪时使用的选项。

tracingOptions?: OperationTracingOptions

属性值

继承自 OperationOptions.tracingOptions