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

Cria uma nova sessão de agente e retorna o ID da sessão.

Descrição da operação

Descrição da solicitação

Esta operação cria uma nova sessão de agente.
Especifique o nome do agente vinculado usando Params.Meta.Agent.AgentName. Este parâmetro é obrigatório.
- dataworks_data_agent: Agente integrado do DataWorks - Data Agent. Fornece recursos de IA para todo o ciclo de vida de desenvolvimento de dados, incluindo integração, desenvolvimento, O&M, governança e análise de dados.
- dataworks_chatbi_agent: Agente integrado do DataWorks - ChatBI. Com base em tecnologias de processamento de linguagem natural e análise inteligente, automatiza todo o processo de análise, desde a análise de requisitos, extração de dados e geração automática de código até a saída de relatórios visuais por meio de interação conversacional.
- dataworks_ai_assistant_agent: Agente integrado do DataWorks - AI Assistant. Um assistente de IA de nível empresarial para o DataWorks construído em frameworks de código aberto, como OpenClaw e Hermes Agent.
Você pode especificar a origem da sessão usando Params.Meta.Config.SessionSource para facilitar a recuperação posterior por origem.
Você pode passar tags de sessão usando Params.Meta.Config.SessionTags[].SessionTagCode.
Defina configurações iniciais opcionais da sessão usando Params.Meta.InitialConfigOptions. Use Model, Mode e ReasoningEffort para o modelo, modo de autorização e configuração de raciocínio, respectivamente. Após a criação da sessão, salve o ID da sessão da resposta para enviar prompts ou assinar eventos da sessão posteriormente.

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

create

*All resources.

*

Nenhuma

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Jsonrpc	string	Não	A versão do JSON-RPC. Fixada em 2.0.	2.0
Id	string	Não	O ID passado pelo solicitante. O valor é retornado como está.	4758330557805415712
Params	object	Não	Os parâmetros de negócio.
Meta	object	Não	Os metadados estendidos que contêm a vinculação do agente, a origem da sessão e as tags.
Agent	object	Não	A configuração do agente para a sessão. Os valores válidos são os resultados retornados pela operação ListAgents.
AgentName	string	Não	O nome do agente vinculado à sessão. Este parâmetro é obrigatório. Valores válidos: dataworks_data_agent: Agente integrado do DataWorks - Data Agent. Fornece recursos de IA para todo o ciclo de vida de desenvolvimento de dados, incluindo integração, desenvolvimento, O&M, governança e análise de dados. dataworks_chatbi_agent: Agente integrado do DataWorks - ChatBI. Com base em tecnologias de processamento de linguagem natural e análise inteligente, automatiza todo o processo de análise, desde a análise de requisitos, extração de dados e geração automática de código até a saída de relatórios visuais por meio de interação conversacional. dataworks_ai_assistant_agent: Agente integrado do DataWorks - AI Assistant. Um assistente de IA de nível empresarial para o DataWorks construído em frameworks de código aberto, como OpenClaw e Hermes Agent.	dataworks_data_agent
Config	object	Não	As configurações de parâmetros da sessão, como as configurações de parâmetros de filtro com base na origem da sessão e nas tags da sessão.
SessionSource	string	Não	O identificador de origem da sessão, que facilita a recuperação por origem. Por exemplo, se um agente for usado tanto na Página A quanto na Página B, e você quiser exibir apenas as sessões criadas na Página A quando estiver na Página A, poderá filtrar as sessões com base neste parâmetro. O valor pode ter até 128 caracteres e pode conter letras, dígitos, hifens (-) e sublinhados (_).	openapi_sdk
SessionTags	array<object>	Não	A lista de tags da sessão. Você pode pesquisar e filtrar sessões com base nas tags da sessão posteriormente.
	object	Não
SessionTagCode	string	Não	A tag da sessão. Você pode filtrar sessões com base nas tags da sessão. Por exemplo, se você usar um usuário RAM fixo para chamar uma operação de API, mas o sistema chamador tiver seu próprio sistema de contas, e você precisar filtrar a lista de sessões com base no ID da conta, poderá passar o ID da conta do sistema chamador como esta tag. O valor pode ter até 128 caracteres e pode conter letras, dígitos, hifens (-) e sublinhados (_).	chatbi
InitialConfigOptions	object	Não	As configurações avançadas de parâmetros para o ambiente de execução do agente.
Cu	string	Não	A especificação de unidade de computação (CU) da instância de sessão. Apenas 2, 4, 8 e 12 são suportados. Se este parâmetro for omitido, o CU da instância não será especificado e a reutilização no modo compartilhado não será restringida pelo CU. Se este parâmetro for especificado, o modo compartilhado reutilizará apenas instâncias com o mesmo CU. Se o CU não corresponder, uma nova instância será criada.	4
ExecutionLane	string	Não	Modo de execução: chat: modo de conversação, adequado para cenários simples de consulta de dados e perguntas e respostas. A vantagem é que é rápido e consome menos tokens, mas a desvantagem é que não consegue lidar com problemas complexos. cli: modo sandbox, adequado para cenários complexos de análise de dados, processamento de dados e escrita de código. A vantagem é que consegue lidar com problemas complexos, e o modelo realiza análises e processamento de problemas de forma independente. A desvantagem é que a velocidade de processamento é mais lenta e o consumo de tokens é maior em comparação com o modo chat.	chat，cli
Mode	string	Não	O modo de autorização para execução de script. Atualmente, o OpenAPI suporta apenas o modo yolo. Valores válidos: yolo: autorização automática. Nenhuma intervenção manual é necessária e o modelo pode processar automaticamente.	yolo
Model	string	Não	O ID do modelo. Use o identificador completo do modelo suportado pelo ambiente de destino. Se este parâmetro for omitido, o modelo padrão será usado. Se este parâmetro for passado, o servidor verificará sua disponibilidade e o aplicará antes que a sessão seja criada.	qwen3.7-max(openai)
ProjectId	string	Não	O ID do espaço de trabalho do DataWorks. É usado para inicializar o contexto do projeto da sessão. Se este parâmetro for omitido, será processado como se não houvesse projeto. O contexto do projeto pode ser corrigido ou alternado posteriormente pelo contexto do projeto de PromptAgentSession.	12345
ReasoningEffort	string	Não	A configuração de raciocínio. O valor deve ser suportado pelo modelo de destino. Um valor none indica o desligamento do raciocínio, e default indica as configurações padrão do modelo. Se um valor não suportado for usado ou se a aplicação da configuração falhar, a criação da sessão falhará. Se este parâmetro for omitido, a configuração de raciocínio existente não será modificada. Uma configuração bem-sucedida atualiza o valor padrão do espaço de trabalho do daemon, o que afeta não apenas a solicitação atual.	none
ResourceGroupId	string	Não	O ID do grupo de recursos usado para inicialização.	Serverless_res_group_123123123_564657857
Skills	string	Não	Os nomes das habilidades personalizadas carregadas. Separe vários nomes com vírgulas (,).	skill-name-1,skill-name2,skill-name-3

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Parâmetros de resposta (resultado)
JsonRpcResponse	object	O resultado da resposta JSON-RPC.
Error	object	A mensagem de erro JSON-RPC. Este campo não é retornado quando a solicitação é bem-sucedida.
Code	integer	O código de erro JSON-RPC.	500
Data	any	As informações adicionais opcionais do erro. O conteúdo depende do tipo de erro.	{}
ErrorCode	string	O código de erro de negócio.	0x4883300000000019
Message	string	A mensagem de erro.	To create a DataAgent instance, you must specify a resource group. Pass the resource group ID in _meta.dataAgent.resourceGroupId of the request
Id	string	O ID passado pelo solicitante. O valor é retornado como está.	1
Jsonrpc	string	A versão do JSON-RPC. Fixada em 2.0.	2.0
Result	object	Os dados de negócio. O valor é nulo quando ocorre um erro.
SessionId	string	O ID da sessão recém-criada.	sess_0f12abc34
Timestamp	integer	A hora da resposta. É um carimbo de data/hora UNIX em milissegundos.	1789549200000
RequestId	string	O ID da solicitação desta invocação do OpenAPI, usado para solucionar problemas de chamadas de API.	8A9D5E6C-5817-5837-9715-6E3967EC6123

Exemplos

Resposta de sucesso

JSON formato

{
  "JsonRpcResponse": {
    "Error": {
      "Code": 500,
      "Data": "{}",
      "ErrorCode": "0x4883300000000019",
      "Message": "To create a DataAgent instance, you must specify a resource group. Pass the resource group ID in _meta.dataAgent.resourceGroupId of the request"
    },
    "Id": "1",
    "Jsonrpc": "2.0",
    "Result": {
      "SessionId": "sess_0f12abc34"
    },
    "Timestamp": 1789549200000
  },
  "RequestId": "8A9D5E6C-5817-5837-9715-6E3967EC6123"
}

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.