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

Descrição da operação

Descrição da solicitação\n- Esta operação recupera os detalhes de uma sessão especificada e retorna a resposta do agente em streaming por meio de Server-Sent Events (SSE).\n- Se a sessão de destino não existir, um quadro de erro com o código de erro 400 será retornado.\n- A resposta inclui informações de processamento sobre como o agente lida com a solicitação, como fragmentação de mensagens, processo de raciocínio e atualizações de status de invocação de ferramentas.\n- O campo `stopReason` indica o motivo pelo qual o agente interrompe a conversa atual. Os valores válidos incluem, mas não se limitam a, atingir o número máximo de turnos e ser cancelado.\n- O conteúdo retornado está em conformidade com a especificação de código aberto 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 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. O valor é fixo em 2.0.	2.0
Id	string	Não	O ID transmitido pelo solicitante. O valor é retornado como está.	4as3dasf654a
Params	object	Não	Os parâmetros de negócio.
Meta	object	Não	Os parâmetros de extensão ACP do DataWorks.
BeginLogOffset	integer	Não	Busca a saída SSE subsequente a partir da posição especificada em um cenário de transferência retomável.	10000
IsReload	boolean	Não	Especifica se este é um cenário de transferência retomável. Em cenários onde o fluxo SSE é instável, como instabilidade de rede que causa a queda da conexão SSE no meio do processo, você pode usar este sinalizador para buscar os dados de resposta SSE novamente a partir do ponto de interrupção.	true
SessionId	string	Não	O ID da sessão de destino. Se a sessão não existir, um quadro de erro SSE será retornado.	sess_0f12abc34

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Error	any	A mensagem de erro nas informações do quadro SSE. O conteúdo retornado está em conformidade com a especificação de código aberto Agent Client Protocol (ACP). Para obter mais informações, consulte https://agentclientprotocol.com/protocol/prompt-turn.	{"code": 400, "errorCode": "0x50000000001", "message": "not exist session", "data": null}
Id	string	O ID transmitido pelo solicitante. O valor é retornado como está.	676303114031776
Jsonrpc	string	A versão do JSON-RPC. O valor é fixo em 2.0.	2.0
Method	string	O método do SSE. O conteúdo retornado está em conformidade com a especificação de código aberto Agent Client Protocol (ACP). Para obter mais informações, consulte https://agentclientprotocol.com/protocol/prompt-turn.	session/update
Params	any	Os parâmetros do SSE. O conteúdo retornado está em conformidade com a especificação de código aberto Agent Client Protocol (ACP). Para obter mais informações, consulte https://agentclientprotocol.com/protocol/prompt-turn.	{"sessionId":"af4f5ef8-e8f5-481c-ad1f-94886c6c0aed","update":{"sessionUpdate":"agent_message_chunk","content":{"type":"text","text":"hello world"}}}
RequestId	string	O ID da solicitação.	0D41C608-0C60-5EB0-B986-1460909CF642
Result	any	O conjunto de resultados do quadro SSE. O conteúdo retornado está em conformidade com a especificação de código aberto Agent Client Protocol (ACP). Para obter mais informações, consulte https://agentclientprotocol.com/protocol/prompt-turn.	{"stopReason":"end_turn"}
Timestamp	integer	O timestamp.	1769479322828

Exemplos

Resposta de sucesso

JSON formato

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

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.