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

Agent interface

表示可以调用模型并使用工具的代理。

属性

createdAt

Unix 时间戳(以秒为单位)表示创建此对象的时间。

description

代理的说明。

id

可以在 API 终结点中引用的标识符。

instructions

代理要使用的系统说明。

metadata

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

model

要使用的模型的 ID。

name

代理的名称。

object

对象类型,始终是助手。

responseFormat

此代理使用的工具调用的响应格式。

temperature

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

toolResources

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

tools

为代理启用的工具集合。

topP

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

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

属性详细信息

createdAt

Unix 时间戳(以秒为单位)表示创建此对象的时间。

createdAt: Date

属性值

Date

description

代理的说明。

description: null | string

属性值

null | string

id

可以在 API 终结点中引用的标识符。

id: string

属性值

string

instructions

代理要使用的系统说明。

instructions: null | string

属性值

null | string

metadata

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

metadata: null | Record<string, string>

属性值

null | Record<string, string>

model

要使用的模型的 ID。

model: string

属性值

string

name

代理的名称。

name: null | string

属性值

null | string

object

对象类型,始终是助手。

object: "assistant"

属性值

"assistant"

responseFormat

此代理使用的工具调用的响应格式。

responseFormat?: null | AgentsResponseFormatOption

属性值

temperature

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

temperature: null | number

属性值

null | number

toolResources

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

toolResources: null | ToolResources

属性值

null | ToolResources

tools

为代理启用的工具集合。

tools: ToolDefinitionUnion[]

属性值

topP

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

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

topP: null | number

属性值

null | number