A API de assistentes simplifica a criação de assistentes, um tipo de aplicação baseada em Large Language Model (LLM). Este tópico descreve os métodos fornecidos pela API de assistentes para gerenciar esses recursos, incluindo criação, listagem, recuperação, atualização e exclusão.
Recursos : Para obter mais informações sobre os recursos e o uso básico da API de assistentes, consulte Visão geral da API de Assistentes .
Persistência : Todas as instâncias de assistentes são salvas no servidor do Alibaba Cloud Model Studio e não possuem data de expiração. É possível recuperar um assistente utilizando seu assistant.id.
- Aplicações de agente: Crie, visualize, atualize e exclua aplicações de agente exclusivamente no console. Para chamá-las, utilize a API de chamada de aplicação.
- Assistentes: Crie, visualize, atualize, exclua e chame assistentes apenas por meio da API de assistentes.
Criar um agente
Cria um novo assistente.
- HTTP
- SDK
| Nome do parâmetro | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| model | O modelo utilizado pelo agente. | str | Sim |
| name | O nome do agente. | str | Não |
| description | A descrição do agente. | str | Não |
| instructions | O prompt do sistema para o LLM no agente. | str | Não |
| tools | Uma lista de ferramentas que o agente pode chamar.Transmite informações de autenticação para um plugin personalizado. | Optional[List[Dict]] | Não (padrão: []) |
| metadata | Outros parâmetros relacionados ao agente. Utilize este parâmetro para armazenar informações adicionais pertinentes. | Dict | Não |
| temperature | Controla o grau de aleatoriedade e diversidade. | float | Não |
| top_p | O limiar de probabilidade para o método de amostragem de núcleo durante a geração. | float | Não |
| top_k | O tamanho do conjunto de candidatos para amostragem durante a geração. | integer | Não |
Listar agentes
Retorna uma lista de assistentes.
- HTTP
- SDK
Nome do parâmetro de entrada | Descrições do parâmetro de entrada | Tipo | Obrigatório |
|---|---|---|---|
limit | Quantidade de agentes | int | Não |
order | A ordem de classificação por hora de criação. | str | Não (padrão: |
Recuperar Agente
- HTTP
- SDK
Nome do parâmetro de entrada | Descrições do parâmetro de entrada | Tipo | Obrigatório |
|---|---|---|---|
assistant_id | O ID do agente a ser recuperado. | str | Sim |
Atualizar um agente
- HTTP
- SDK
Nome do parâmetro de entrada | Descrições do parâmetro de entrada | Tipo | Obrigatório |
|---|---|---|---|
assistant_id | O ID do agente a ser recuperado | str | Sim |
* | Outros parâmetros de entrada opcionais. | str | Não |
model | O ID do modelo utilizado pelo agente. | str | Sim |
name | O nome do agente. | str | Não |
description | A descrição do agente. | str | Não |
instructions | O prompt do sistema para o LLM no agente. | str | Não |
tools | Uma lista de ferramentas que o agente pode chamar. As ferramentas devem estar registradas no Alibaba Cloud Model Studio. | Optional[List[Dict]] | Não (padrão: []) |
file_ids | O ID de um arquivo que o agente pode utilizar. Faça o upload do arquivo antecipadamente para obter o ID correspondente. | Optional[str] | Não (padrão: []) |
metadata | Armazena outros parâmetros relacionados ao agente. | Dict | Não |
Excluir um agente
- HTTP
- SDK
Nome do parâmetro de entrada | Descrição | Tipo | Obrigatório |
|---|---|---|---|
assistant_id | O ID do agente a ser recuperado. | str | Sim |
Objeto Agente
Um objeto Assistant capaz de chamar modelos e utilizar ferramentas.
Exemplo de Objeto Agente
Nome do parâmetro | Tipo de dados | Descrição |
|---|---|---|
id | string | O identificador exclusivo do agente, correspondente ao ID do assistente. |
object | string | O tipo do objeto. Sempre definido como |
created_at | integer | O timestamp Unix de 13 dígitos, em milissegundos, indicando a criação do agente. |
model | string | O nome do modelo utilizado pelo agente. Consulte todos os modelos disponíveis na Visão geral da API de Assistentes ou veja a Lista de modelos para mais detalhes. |
name | string | O nome do agente. |
description | string | A descrição do agente. |
instructions | string | As instruções de sistema utilizadas pelo agente. |
tools | array | Uma lista de ferramentas habilitadas no agente. Podem ser plugins oficiais (como |
metadata | dict | Informações adicionais sobre o objeto agente armazenadas em formato estruturado. |
temperature | float | A temperatura de amostragem, variando entre 0 e 2. Valores mais altos, como 1, tornam a saída mais aleatória. Valores menores, como 0,2, resultam em saídas mais focadas e determinísticas. |
top_p | float | Uma alternativa à amostragem por temperatura, denominada amostragem de núcleo. Neste método, o LLM seleciona resultados de tokens cuja massa cumulativa de probabilidade atinja Ajuste este parâmetro ou |
top_k | integer | Semelhante ao Não ajuste este parâmetro juntamente com |
max_tokens | integer | O número máximo de tokens que o agente pode gerar em uma única vez. |
request_id | string | O identificador exclusivo da chamada associada ao agente. |