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

Descrição da operação

Solicitação

Esta operação obtém os detalhes da sessão e transmite a resposta do Agent usando Server-Sent Events (SSE).
Se a sessão de destino não existir, a operação retorna um frame de erro com o código de erro 400.
A resposta inclui informações sobre o processamento da solicitação pelo Agent, como fragmentos de mensagem, processos de pensamento e atualizações de status de chamadas de ferramentas.
O campo stopReason indica por que o Agent interrompe o turno atual. Os valores possíveis incluem atingir o limite máximo de turnos ou ser cancelado.
O conteúdo retornado está em conformidade com o Agent Client Protocol (ACP). Para obter mais informações, consulte https://agentclientprotocol.com.

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

none

*All Resource

*

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. O valor deve ser `2.0`.	2.0
Id	string	Não	O ID da solicitação gerado pelo cliente, que é retornado na resposta.	4as3dasf654a
Params	object	Não	Parâmetros de negócio.
SessionId	string	Não	O ID da sessão de destino. Se a sessão não existir, um frame de erro SSE é retornado.	sess_0f12abc34
Meta	object	Não	Parâmetros estendidos específicos do DataWorks para ACP.
IsReload	boolean	Não	Especifica se deve ser usada a transferência retomável. Se o fluxo SSE for interrompido devido a problemas como uma conexão de rede instável, você pode definir este parâmetro como `true` para buscar novamente os dados do fluxo a partir do ponto de falha.	true or false
BeginLogOffset	integer	Não	Em um cenário de transferência retomável, especifica o deslocamento a partir do qual retomar a busca da saída SSE.	10000

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID de solicitação exclusivo gerado para esta solicitação.	0D41C608-0C60-5EB0-B986-1460909CF642
Timestamp	integer	O timestamp.	1769479322828
Jsonrpc	string	A versão do JSON-RPC. O valor é `2.0`.	2.0
Id	string	O ID da solicitação gerado pelo cliente, retornado da solicitação.	676303114031776
Result	any	O objeto de resultado do frame SSE. Este campo está presente quando a operação é bem-sucedida.	{"stopReason":"end_turn"}
Error	any	O objeto de erro do frame SSE. Este campo está presente quando ocorre um erro.	{"code": 400, "errorCode": "0x50000000001", "message": "not exist session", "data": null}
Method	string	O método do frame SSE.	session/update
Params	any	Os parâmetros do frame SSE.	{"sessionId":"af4f5ef8-e8f5-481c-ad1f-94886c6c0aed","update":{"sessionUpdate":"agent_message_chunk","content":{"type":"text","text":"hello world"}}}

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0D41C608-0C60-5EB0-B986-1460909CF642",
  "Timestamp": 1769479322828,
  "Jsonrpc": "2.0",
  "Id": "676303114031776",
  "Result": "{\"stopReason\":\"end_turn\"}",
  "Error": "{\"code\": 400, \"errorCode\": \"0x50000000001\", \"message\": \"not exist session\", \"data\": null}",
  "Method": "session/update",
  "Params": "{\"sessionId\":\"af4f5ef8-e8f5-481c-ad1f-94886c6c0aed\",\"update\":{\"sessionUpdate\":\"agent_message_chunk\",\"content\":{\"type\":\"text\",\"text\":\"hello world\"}}}"
}

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.