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

Cria um agente.

Descrição da operação

Descrição da solicitação

Nome do agente: Deve ser único na conta atual.
Configuração do modelo: Opcional. Especifica o modelo usado pelo agente e suas configurações relacionadas.
Nível de visibilidade: Define quem pode acessar o agente. Suporta visibilidade em toda a conta, específica do projeto ou específica do usuário.
Escopo de visibilidade: Quando PROJECT ou USER é selecionado como nível de visibilidade, você deve especificar os IDs de projeto ou IDs de usuário específicos.
Outros parâmetros: Parâmetros como nome de exibição e descrição são opcionais. Especifique-os conforme necessário.

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:CreateAgent

create

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Name	string	Sim	O nome do agente. O nome deve ser único na conta atual.	my-agent
DisplayName	string	Não	O nome de exibição do agente.	My Assistant
Description	string	Não	A descrição do agente.	Data analytics assistant
Model	object	Não	A configuração do modelo.	{ "modelName": "dataworks-public-bailian/qwen-max" }
SystemPrompt	string	Não	O prompt do sistema.	You are a data analytics assistant.
Tools	array<object>	Não	A lista de ferramentas.	-
	object	Não	As informações da ferramenta.	-
BuiltinName	string	Não	Obrigatório quando Kind é BUILTIN_TOOLSET. Especifica o nome do conjunto de ferramentas integrado suportado pelo servidor de destino. Omita este parâmetro quando Kind for MCP_TOOLSET.	web_search
Kind	string	Não	Obrigatório para referências de ferramentas válidas. BUILTIN_TOOLSET indica um conjunto de ferramentas integrado, e BuiltinName deve ser especificado. MCP_TOOLSET indica um conjunto de ferramentas MCP, e McpServerName deve ser especificado. O servidor de destino valida o parâmetro com base no tipo de ferramenta. Valores válidos: BUILTIN_TOOLSET MCP_TOOLSET	MCP_TOOLSET
McpItems	array	Não	Opcional quando Kind é MCP_TOOLSET. Se especificado, apenas as ferramentas listadas serão usadas. Se omitido ou deixado como uma matriz vazia, as ferramentas não serão filtradas por nome. Cada item deve ser o nome de uma ferramenta real no serviço MCP de destino.	["only-this-tool"]
	string	Não	O nome da ferramenta MCP.	only-this-tool
McpServerName	string	Não	Obrigatório quando Kind é MCP_TOOLSET. Especifica o nome do serviço MCP que o chamador atual tem permissão para invocar e referenciar e que possui uma versão publicada ativa.	mcp-a
Name	string	Não	O nome do servidor MCP.	server-1
Skills	array<object>	Não	A lista de habilidades.	-
	object	Não	A configuração da habilidade.	["my-skill"]
Name	string	Não	O nome da habilidade.	skill-1
SkillId	string	Não	Quando Source é OFFICIAL, especifique o ID do catálogo oficial. Não especifique Name, Version ou VersionSelector. Não especifique este campo para habilidades pessoais ou corporativas.	dataworks-semantic
Source	string	Não	OFFICIAL indica um recurso do catálogo oficial. DB indica um recurso pessoal ou corporativo. Se omitido, a semântica original de consulta por nome é mantida. Valores válidos: DB OFFICIAL	OFFICIAL
Version	integer	Não	Usado apenas para habilidades pessoais ou corporativas. Especifica o número de revisão inteiro fixo de um snapshot publicado. Este parâmetro é mutuamente exclusivo com VersionSelector. Publicar uma nova versão não altera a referência fixa. Se ambos forem omitidos, a versão mais recente será usada para cada nova sessão. Não especifique este parâmetro quando Source for OFFICIAL.	1
VersionSelector	string	Não	Usado apenas para recursos pessoais ou corporativos. Este parâmetro é mutuamente exclusivo com Version. Suporta versões semânticas exatas, latest e sintaxe completa de intervalo npm/node-semver, como 1.2.*, ^1.2.3, ~1.2.3, >=1.0.0 <2.0.0 e 1.x \|\| 2.x. Se ambos forem omitidos, a versão mais recente será usada, e a versão publicada correspondente mais alta será selecionada para cada nova sessão. As referências de inteiros fixos existentes permanecem inalteradas. Não especifique este parâmetro quando Source for OFFICIAL.	^1.2.3
ExpertSuites	array<object>	Não	As suítes de especialistas publicadas vinculadas ao agente. Para suítes pessoais ou corporativas, use SuiteId e, opcionalmente, especifique uma Version ou VersionSelector fixa. Para suítes oficiais, você deve especificar explicitamente Source=OFFICIAL e o SuiteId do catálogo oficial, e não especificar Version ou VersionSelector. Se não for especificado, uma lista vazia será criada e todas as suítes oficiais não serão carregadas por padrão.	[{"Source":"OFFICIAL","SuiteId":"dataworks-data-analysis-extension"},{"SuiteId":"suite_example","Version":1}]
	object	Não
Source	string	Não	OFFICIAL indica um recurso do catálogo oficial. DB indica um recurso pessoal ou corporativo. Se omitido, a semântica original de consulta de recursos de banco de dados é mantida. Para recursos oficiais, a versão do artefato é fixada quando o agente é publicado. Valores válidos: DB OFFICIAL	OFFICIAL
SuiteId	string	Não	Ao passar referências de suítes de especialistas, cada item deve fornecer um SuiteId, que é validado pelo servidor. Quando Source é OFFICIAL, este é o ID do catálogo oficial. Caso contrário, este é o ID retornado pelo gerenciamento de suítes de especialistas. O recurso referenciado deve estar visível para o chamador.	dataworks-data-analysis-extension
Version	integer	Não	Usado apenas para suítes pessoais ou corporativas. Especifica o número de revisão inteiro fixo de um snapshot publicado. Este parâmetro é mutuamente exclusivo com VersionSelector. Publicar uma nova versão não altera a referência fixa. Se ambos forem omitidos, a versão mais recente será usada para cada nova sessão. Não especifique este parâmetro quando Source for OFFICIAL.	1
VersionSelector	string	Não	Usado apenas para recursos pessoais ou corporativos. Este parâmetro é mutuamente exclusivo com Version. Suporta versões semânticas exatas, latest e sintaxe completa de intervalo npm/node-semver, como 1.2.*, ^1.2.3, ~1.2.3, >=1.0.0 <2.0.0 e 1.x \|\| 2.x. Se ambos forem omitidos, a versão mais recente será usada, e a versão publicada correspondente mais alta será selecionada para cada nova sessão. As referências de inteiros fixos existentes permanecem inalteradas. Não especifique este parâmetro quando Source for OFFICIAL.	^1.2.3
CallableAgents	array<object>	Não	A lista de subagentes que podem ser chamados por este agente.	-
	object	Não	O nome do agente.	["agent-name"]
Name	string	Não	O nome do agente.	agent-1
PublishImmediately	boolean	Não	Especifica se o agente deve ser publicado imediatamente após a criação. Um valor true publica a versão criada. Um valor false ou a omissão deste parâmetro mantém o comportamento original de criar apenas um rascunho. Salvar e publicar não são operações atômicas. Se a publicação falhar, o rascunho já poderá existir. Antes de tentar novamente, consulte o agente primeiro para evitar criação duplicada.	false
Metadata	object	Não	Os metadados estendidos em pares chave-valor.	{}
Visibility	string	Não	O nível de visibilidade. Valores válidos: `TENANT`: Visível na conta. `PROJECT`: Visível para projetos especificados. `USER`: Visível para usuários especificados. Valores válidos: PROJECT : Projeto. USER : Usuário. TENANT : Locatário.	TENANT
VisibilityScope	object	Não	O escopo de visibilidade. Especifique os campos correspondentes com base no valor de Visibility.
ProjectIds	array	Não	A lista de IDs de projetos visíveis. Este parâmetro entra em vigor quando Visibility é definido como `PROJECT`.
	string	Não	O ID do espaço de trabalho.	[21791]
UserIds	array	Não	A lista de IDs de usuários visíveis. Este parâmetro entra em vigor quando Visibility é definido como `USER`.
	string	Não	O ID do usuário visível. Este parâmetro entra em vigor quando Visibility é definido como USER.	[]

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
Agent	object	Os detalhes do agente criado.
ExpertSuites	array<object>	As referências de suíte salvas. Os recursos oficiais retornam a origem e o ID do diretório. A versão do artefato publicado é representada por PackageVersion.
	object
PackageVersion	string	Este campo não é retornado durante a criação. Use GetAgent para consultar explicitamente a versão publicada e obter a versão fixa do artefato da suíte oficial.	0.1.0.202610211408
Source	string	A origem da suíte de especialistas.	OFFICIAL
SuiteId	string	O ID da suíte de especialistas.	dataworks-data-analysis-extension
Version	integer	O número da versão de lançamento da suíte personalizada.	1
VersionSelector	string	A estratégia de seleção de versão salva é retornada apenas para recursos pessoais ou corporativos e é mutuamente exclusiva com o inteiro fixo Version. Ela não representa a revisão específica realmente carregada na sessão. Este campo 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
Name	string	O nome do agente.	my-agent
Skills	array<object>	As referências de habilidade salvas. As habilidades oficiais retornam um PackageVersion fixo após a publicação do agente.
	object
Name	string	O nome da habilidade personalizada.	my-business-skill
PackageVersion	string	Este campo não é retornado durante a criação. Use GetAgent para consultar explicitamente a versão publicada e obter a versão fixa do artefato oficial.	0.6.0.202608201110
SkillId	string	O ID da habilidade oficial.	dataworks-semantic
Source	string	A origem da habilidade.	OFFICIAL
Version	integer	O número da versão de lançamento da habilidade personalizada.	1
VersionSelector	string	A estratégia de seleção de versão salva é retornada apenas para recursos pessoais ou corporativos e é mutuamente exclusiva com o inteiro fixo Version. Ela não representa a revisão específica realmente carregada na sessão. Este campo não é retornado para recursos oficiais.	^1.2.3
RequestId	string	O ID da solicitação.	824F80BA-1778-5D8A-BAFF-668A4D9C4CC7

Exemplos

Resposta de sucesso

JSON formato

{
  "Agent": {
    "ExpertSuites": [
      {
        "PackageVersion": "0.1.0.202610211408",
        "Source": "OFFICIAL",
        "SuiteId": "dataworks-data-analysis-extension",
        "Version": 1,
        "VersionSelector": "^1.2.3"
      }
    ],
    "GmtCreateTime": "1780555634000",
    "GmtModifiedTime": "1780555634000",
    "Name": "my-agent",
    "Skills": [
      {
        "Name": "my-business-skill",
        "PackageVersion": "0.6.0.202608201110",
        "SkillId": "dataworks-semantic",
        "Source": "OFFICIAL",
        "Version": 1,
        "VersionSelector": "^1.2.3"
      }
    ]
  },
  "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.