GetYaoChiAgent - Database Autonomy Service: Central de Documentação do Alibaba Cloud

Invoca a API do modelo de linguagem grande do ApsaraDB Agent para executar tarefas como perguntas e respostas de conhecimento e diagnósticos de desempenho.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

hdm:GetYaoChiAgent

get

*All resources.

*

Nenhuma

Sintaxe da solicitação

POST /agent HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Query	string	Sim	A descrição em linguagem natural da consulta.	Are there any issues or abnormalities with my instance rm-xxx?
SessionId	string	Não	Opcional. O ID da sessão, que é uma string UUID. Se este parâmetro não for especificado, uma nova sessão será criada. Para manter o contexto em uma conversa, use o mesmo ID de sessão.	123e4567-e89b-12d3-a456-xxxxxxxxxxxx
Source	string	Não	Opcional. O serviço de nuvem de origem. Especifica o serviço de nuvem ao qual as perguntas e respostas pertencem. Valor padrão: yaochi. Valores válidos: tair : tair. dbs : dbs. polardb-ai : polardb-ai. polarx : polarx. yaochi : yaochi. polarx-light : polarx-light. lindorm : lindorm. mongodb : mongodb. polardb : polardb.	yaochi
ExtraInfo	string	Não	Opcional. As informações adicionais, que são uma string JSON.	{}
ImageKeys	string	Não

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
Content	string	O conteúdo da resposta.	xxx
RequestId	string	O ID da solicitação.	7172BECE-588A-5961-8126-C216E16B****
ReasoningContent	string	O conteúdo de raciocínio gerado pelo modelo.	xxx
Product	string	O tipo do serviço de nuvem.	polardb
FunctionCall	array<object>	A lista de invocações de ferramentas.
	object	A lista de strings.
Name	string	O nome da ferramenta chamada.	sqlReview
Arguments	string	Os argumentos da ferramenta chamada.	{"arg": "xxx"}
Id	string	O ID da ferramenta.	12345
Status	string	O status da invocação da ferramenta.	RUNNING
UiFunctionCall	array<object>	A lista de invocações da ferramenta de cartão.
	object	A lista de strings.
ArgsText	string	Os argumentos da ferramenta de cartão.	{"arg": "xxx"}
ToolName	string	O nome da ferramenta de cartão.	card
SessionId	string	O ID da sessão, que é o mesmo que o parâmetro de solicitação SessionId.	123e4567-e89b-12d3-a456-xxxxxxxxxxxx
QueryId	string	O ID da consulta, que é o mesmo que o parâmetro de solicitação QueryId.	123e4567-e89b-12d3-a456-xxxxxxxxxxxx
SubAgentCall	array<object>	A lista de informações de invocação do subagente.
	object	A lista de strings.
SubAgentId	string	O ID do subagente.	12345
SubAgentName	string	O nome do subagente.	XX Agent
Status	string	O status do subagente.	running
ParentId	string	O ID pai. Este campo existe apenas quando a mensagem é gerada por um subagente, e seu valor é o ID do subagente.	12345

Exemplos

Resposta de sucesso

JSON formato

{
  "Content": "xxx",
  "RequestId": "7172BECE-588A-5961-8126-C216E16B****",
  "ReasoningContent": "xxx",
  "Product": "polardb",
  "FunctionCall": [
    {
      "Name": "sqlReview",
      "Arguments": "{\"arg\": \"xxx\"}",
      "Id": "12345",
      "Status": "RUNNING"
    }
  ],
  "UiFunctionCall": [
    {
      "ArgsText": "{\"arg\": \"xxx\"}",
      "ToolName": "card"
    }
  ],
  "SessionId": "123e4567-e89b-12d3-a456-xxxxxxxxxxxx",
  "QueryId": "123e4567-e89b-12d3-a456-xxxxxxxxxxxx",
  "SubAgentCall": [
    {
      "SubAgentId": "12345",
      "SubAgentName": "XX Agent",
      "Status": "running"
    }
  ],
  "ParentId": "12345"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.