Agent interface

Pacote:

@azure/ai-agents

Representa um agente que pode chamar o modelo e usar ferramentas.

Propriedades

createdAt	O carimbo de data/hora Unix, em segundos, representando quando este objeto foi criado.
description	A descrição do agente.
id	O identificador, que pode ser referenciado em pontos de extremidade de API.
instructions	As instruções do sistema para o agente usar.
metadata	Um conjunto de até 16 pares chave/valor que podem ser anexados a um objeto, usado para armazenar informações adicionais sobre esse objeto em um formato estruturado. As teclas podem ter até 64 caracteres e os valores podem ter até 512 caracteres.
model	A ID do modelo a ser usado.
name	O nome do agente.
object	O tipo de objeto, que é sempre assistente.
responseFormat	O formato de resposta das chamadas de ferramenta usadas por este agente.
temperature	Qual a temperatura de amostragem a utilizar, entre 0 e 2. Valores mais altos como 0,8 tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística.
toolResources	Um conjunto de recursos que são usados pelas ferramentas do agente. Os recursos são específicos para o tipo de ferramenta. Por exemplo, a code_interpreter ferramenta requer uma lista de IDs de arquivo, enquanto a file_search ferramenta requer uma lista de IDs de armazenamento vetorial.
tools	A coleção de ferramentas habilitadas para o agente.
topP	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com a massa de probabilidade top_p. Assim, 0,1 significa que apenas os tokens que compõem a massa de probabilidade superior de 10% são considerados. Geralmente recomendamos alterar esta ou a temperatura, mas não ambas.

Detalhes de Propriedade

createdAt

O carimbo de data/hora Unix, em segundos, representando quando este objeto foi criado.

createdAt: Date

Valor de Propriedade

Date

description

A descrição do agente.

description: null | string

Valor de Propriedade

null | string

id

O identificador, que pode ser referenciado em pontos de extremidade de API.

id: string

Valor de Propriedade

string

instructions

As instruções do sistema para o agente usar.

instructions: null | string

Valor de Propriedade

null | string

metadata

Um conjunto de até 16 pares chave/valor que podem ser anexados a um objeto, usado para armazenar informações adicionais sobre esse objeto em um formato estruturado. As teclas podem ter até 64 caracteres e os valores podem ter até 512 caracteres.

metadata: null | Record<string, string>

Valor de Propriedade

null | Record<string, string>

model

A ID do modelo a ser usado.

model: string

Valor de Propriedade

string

name

O nome do agente.

name: null | string

Valor de Propriedade

null | string

object

O tipo de objeto, que é sempre assistente.

object: "assistant"

Valor de Propriedade

"assistant"

responseFormat

O formato de resposta das chamadas de ferramenta usadas por este agente.

responseFormat?: null | AgentsResponseFormatOption

Valor de Propriedade

null | AgentsResponseFormatOption

temperature

Qual a temperatura de amostragem a utilizar, entre 0 e 2. Valores mais altos como 0,8 tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística.

temperature: null | number

Valor de Propriedade

null | number

toolResources

Um conjunto de recursos que são usados pelas ferramentas do agente. Os recursos são específicos para o tipo de ferramenta. Por exemplo, a code_interpreter ferramenta requer uma lista de IDs de arquivo, enquanto a file_search ferramenta requer uma lista de IDs de armazenamento vetorial.

toolResources: null | ToolResources

Valor de Propriedade

null | ToolResources

tools

A coleção de ferramentas habilitadas para o agente.

tools: ToolDefinitionUnion[]

Valor de Propriedade

ToolDefinitionUnion[]

topP

Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com a massa de probabilidade top_p. Assim, 0,1 significa que apenas os tokens que compõem a massa de probabilidade superior de 10% são considerados.

Geralmente recomendamos alterar esta ou a temperatura, mas não ambas.

topP: null | number

Valor de Propriedade

null | number