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, que representa quando esse 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 chaves podem ter até 64 caracteres de comprimento e os valores podem ter até 512 caracteres de comprimento.
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 esse agente.
temperature	Qual temperatura de amostragem usar, 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 ferramenta code_interpreter requer uma lista de IDs de arquivo, enquanto a ferramenta file_search requer uma lista de IDs do repositório de vetores.
tools	A coleção de ferramentas habilitada para o agente.
topP	Uma alternativa à amostragem com temperatura, chamada de amostragem de núcleo, onde o modelo considera os resultados dos tokens com massa de probabilidade top_p. Portanto, 0,1 significa que apenas os tokens que compõem a massa de probabilidade de 10% do topo são considerados. Geralmente, é recomendável alterar este ou a temperatura, mas não ambos.

Detalhes da propriedade

createdAt

O carimbo de data/hora Unix, em segundos, que representa quando esse objeto foi criado.

createdAt: Date

Valor da propriedade

Date

description

A descrição do agente.

description: null | string

Valor da propriedade

null | string

id

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

id: string

Valor da propriedade

string

instructions

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

instructions: null | string

Valor da 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 chaves podem ter até 64 caracteres de comprimento e os valores podem ter até 512 caracteres de comprimento.

metadata: null | Record<string, string>

Valor da propriedade

null | Record<string, string>

model

A ID do modelo a ser usado.

model: string

Valor da propriedade

string

name

O nome do agente.

name: null | string

Valor da propriedade

null | string

object

O tipo de objeto, que é sempre assistente.

object: "assistant"

Valor da propriedade

"assistant"

responseFormat

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

responseFormat?: null | AgentsResponseFormatOption

Valor da propriedade

null | AgentsResponseFormatOption

temperature

Qual temperatura de amostragem usar, 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 da 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 ferramenta code_interpreter requer uma lista de IDs de arquivo, enquanto a ferramenta file_search requer uma lista de IDs do repositório de vetores.

toolResources: null | ToolResources

Valor da propriedade

null | ToolResources

tools

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

tools: ToolDefinitionUnion[]

Valor da propriedade

ToolDefinitionUnion[]

topP

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

Geralmente, é recomendável alterar este ou a temperatura, mas não ambos.

topP: null | number

Valor da propriedade

null | number