GetAgent - DataWorks: Central de Documentação do Alibaba Cloud

Obtém os detalhes de um agente.

Descrição da operação

Descrição da solicitação\nEsta operação de API obtém as informações de configuração detalhadas de um agente pelo seu nome, incluindo, mas não se limitando a, configurações de modelo, prompts do sistema e listas de ferramentas. Você deve fornecer o nome exato do agente como um parâmetro na solicitação.

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

dataworks:GetAgent

get

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Name	string	Sim	O nome da habilidade a ser obtida.	my-skill
AgentVersion	integer	Não	Se omitida, a definição atual é obtida. Se uma versão publicada for especificada, o snapshot correspondente e as versões fixas das habilidades oficiais e dos artefatos da suíte são obtidos. Se uma versão não publicada for especificada, o rascunho é retornado sem versões fixas de artefatos. Este não é o parâmetro de sistema Version do POP.	2

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
Agent	object	Os detalhes do agente criado.
AgentVersion	integer	A versão da definição lida nesta solicitação. Ao atualizar a definição atual, use este valor como ExpectedVersion para UpdateAgent para evitar a substituição de novas versões enviadas por outros chamadores. A versão lida de um snapshot histórico não representa a versão atual.	2
CallableAgents	array<object>	A lista de subagentes chamáveis.
	object
DisplayName	string	O nome de exibição do subagente.	Sub-assistant
Name	string	O nome do subagente.	sub-agent
Source	string	A origem do subagente.	custom
Version	integer	O número da versão do subagente.	-
CreatorId	string	O ID do criador.	123456
Description	string	A descrição.	Data analytics assistant
DisplayName	string	O nome de exibição.	My assistant
ExpertSuites	array<object>	As suítes de especialistas vinculadas à definição do agente, incluindo um número de revisão inteiro fixo ou uma política de seleção de versão. Os recursos oficiais continuam a usar PackageVersion para indicar a versão do artefato.
	object
Description	string	Se a suíte for excluída, o snapshot publicado estiver ausente ou o chamador não tiver permissão para visualizá-lo, o resumo da suíte não será retornado e apenas o ID e o número da versão serão mantidos.	Data analytics expert capability set
DisplayName	string	O nome de exibição da versão vinculada.	Data analytics expert suite
Name	string	O nome da suíte da versão vinculada.	analysis-suite
PackageVersion	string	Retorna a versão fixa do artefato oficial ao consultar explicitamente uma versão publicada do agente. Não é retornado ao consultar um rascunho ou uma suíte personalizada.	0.1.0.202610211408
SemanticVersion	string	Um campo opcional de resumo da suíte que não é retornado pelos novos aplicativos DataAgent atuais. Um valor ausente não indica a versão 0. Este campo não pode ser usado como Version para UpdateAgent e deve ser omitido ao gravar referências de volta. Para a versão fixa de artefatos oficiais, leia PackageVersion.	1.2.0
Source	string	OFFICIAL indica um recurso do catálogo oficial. Omitido ou DB indica um recurso pessoal ou corporativo.	OFFICIAL
SuiteId	string	O ID da suíte de especialistas.	suite_example
Version	integer	Retornado apenas quando uma suíte pessoal ou corporativa especifica explicitamente uma versão inteira fixa na referência. Não é retornado para suítes oficiais. Um valor ausente não é 0. Se o SDK inicializar um inteiro ausente como 0, ele deverá ser omitido ao gravar de volta. Para itens oficiais, apenas Source e SuiteId são gravados de volta, e Version, VersionSelector, SemanticVersion ou PackageVersion não são transmitidos.	3
VersionSelector	string	Retornado apenas para recursos pessoais ou corporativos para indicar a política de seleção de versão salva, que é mutuamente exclusiva com a Version inteira fixa. Não representa a revisão específica realmente carregada na sessão. Não é retornado para recursos oficiais.	^1.2.3
GmtCreateTime	string	A hora de criação em milissegundos.	1780555634000
GmtModifiedTime	string	A hora da última modificação em milissegundos.	1780555634000
Metadata	object	Os metadados estendidos.	{}
Model	object	A configuração do modelo.
Config	object	A configuração adicional do modelo.	{}
MaxTokens	integer	O número máximo de tokens de saída por solicitação.	8192
ModelName	string	O nome do modelo.	qwen3-max
Stream	boolean	Especifica se deve ser usada a saída em streaming.	true
Temperature	number	A temperatura de amostragem.	1
TopP	number	O valor top-P para amostragem de núcleo.	1
ModifierId	string	O ID do último modificador.	123456
Name	string	O nome do agente.	my-agent
RequiredRuntime	array	As dependências de ambiente necessárias para o tempo de execução.
	string	Vazio.	-
Skills	array<object>	A lista de habilidades.
	object	Os detalhes da habilidade associada ao agente.
Name	string	O nome da habilidade.	my-skill
PackageVersion	string	Retorna a versão fixa do artefato oficial ao consultar um snapshot publicado com um AgentVersion especificado. Não é retornado ao consultar um rascunho ou uma habilidade personalizada.	0.6.0.202608201110
SkillId	string	O ID da habilidade oficial.	dataworks-semantic
Source	string	OFFICIAL indica um recurso do catálogo oficial. Omitido ou DB indica um recurso pessoal ou corporativo original.	OFFICIAL
Version	integer	O número da versão da habilidade.	-
VersionSelector	string	Retornado apenas para recursos pessoais ou corporativos para indicar a política de seleção de versão salva, que é mutuamente exclusiva com a Version inteira fixa. Não representa a revisão específica realmente carregada na sessão. Não é retornado para recursos oficiais.	^1.2.3
SystemPrompt	string	O prompt do sistema.	You are a data analytics assistant.
Tools	array<object>	A lista de ferramentas.
	object
BuiltinName	string	O nome da ferramenta integrada. Válido quando Kind é builtin.	builtin_sql
Kind	string	O tipo de ferramenta.	builtin
McpItems	array	Os itens de ferramenta MCP selecionados. Válido quando Kind é mcp.
	string	O nome da ferramenta. O padrão é all.	search_table
McpServerName	string	O nome do servidor MCP associado. Válido quando Kind é mcp.	server-name
Visibility	string	O nível de visibilidade.	TENANT
VisibilityScope	object	O escopo de visibilidade.
ProjectIds	array	A lista de IDs de projetos visíveis.
	string	O ID do projeto.	proj_001
UserIds	array	A lista de IDs de usuários visíveis.
	string	O ID do usuário.	123456
RequestId	string	O ID da solicitação.	824F80BA-1778-5D8A-BAFF-668A4D9C4CC7

Exemplos

Resposta de sucesso

JSON formato

{
  "Agent": {
    "AgentVersion": 2,
    "CallableAgents": [
      {
        "DisplayName": "Sub-assistant",
        "Name": "sub-agent",
        "Source": "custom",
        "Version": 0
      }
    ],
    "CreatorId": "123456",
    "Description": "Data analytics assistant",
    "DisplayName": "My assistant",
    "ExpertSuites": [
      {
        "Description": "Data analytics expert capability set",
        "DisplayName": "Data analytics expert suite",
        "Name": "analysis-suite",
        "PackageVersion": "0.1.0.202610211408",
        "SemanticVersion": "1.2.0",
        "Source": "OFFICIAL",
        "SuiteId": "suite_example",
        "Version": 3,
        "VersionSelector": "^1.2.3"
      }
    ],
    "GmtCreateTime": "1780555634000",
    "GmtModifiedTime": "1780555634000",
    "Metadata": {},
    "Model": {
      "Config": {},
      "MaxTokens": 8192,
      "ModelName": "qwen3-max",
      "Stream": true,
      "Temperature": 1,
      "TopP": 1
    },
    "ModifierId": "123456",
    "Name": "my-agent",
    "RequiredRuntime": [
      "-"
    ],
    "Skills": [
      {
        "Name": "my-skill",
        "PackageVersion": "0.6.0.202608201110",
        "SkillId": "dataworks-semantic",
        "Source": "OFFICIAL",
        "Version": 0,
        "VersionSelector": "^1.2.3"
      }
    ],
    "SystemPrompt": "You are a data analytics assistant.",
    "Tools": [
      {
        "BuiltinName": "builtin_sql",
        "Kind": "builtin",
        "McpItems": [
          "search_table"
        ],
        "McpServerName": "server-name"
      }
    ],
    "Visibility": "TENANT",
    "VisibilityScope": {
      "ProjectIds": [
        "proj_001"
      ],
      "UserIds": [
        "123456"
      ]
    }
  },
  "RequestId": "824F80BA-1778-5D8A-BAFF-668A4D9C4CC7"
}

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.