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

Envia um prompt para uma sessão existente e transmite a resposta do agente em streaming.

Descrição da operação

Solicitação

Esta API envia um prompt do usuário para um ID de sessão especificado e transmite a resposta do agente em streaming via SSE (Server-Sent Events).
A resposta pode incluir fragmentos de mensagens, processo de pensamento e atualizações de status de chamada de ferramentas.
Se a sessão especificada não existir, a API retornará um erro 400 em um quadro de erro SSE.
O campo stopReason indica por que o agente encerrou o turno.
Você pode usar vários tipos de blocos de conteúdo no prompt, como texto e links de download de arquivos do OSS.
Você pode fornecer metadados adicionais no parâmetro Meta para passar mais contexto ao servidor.
O conteúdo da resposta está em conformidade com a especificação de código aberto Agent Client Protocol (ACP). Para mais informações, consulte https://agentclientprotocol.com
**Revise os métodos de cobrança e os preços do Data Agent antes de usar esta API**: https://www.alibabacloud.com/help/zh/dataworks/dataworks-data-agent-agent-billing.

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

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. Valor fixo: 2.0.	2.0
Id	string	Não	O ID passado pelo chamador. O valor é retornado exatamente como recebido na resposta.	1021418411
Params	object	Não	Os parâmetros de negócio.
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
Prompt	array<object>	Não	O array de blocos de conteúdo da mensagem do usuário. Para mais informações, consulte https://agentclientprotocol.com/protocol/content.
	array<object>	Não
Type	string	Não	O tipo de bloco de conteúdo..	text
Text	string	Não	O conteúdo de texto..	Sales in the last 7 days
Uri	string	Não	O URI do arquivo.	oss://${bucket}/${ossKey}
Name	string	Não	O nome do arquivo.	xxx.csv
MimeType	string	Não	O tipo MIME do arquivo.	text/csv‌
Size	integer	Não	O tamanho do arquivo. Unidade: bytes.	1231231
Title	string	Não	O título do arquivo.	Sales_Order_Details.csv
Description	string	Não	A descrição do arquivo.	Sales_Order_Details.csv
Meta	object	Não	Os metadados do prompt estendidos pelo DataWorks.
Hide	boolean	Não	Specifies whether to hide the prompt from the user. For example, if a user asks "Sales amount in the last 7 days" in a chat dialog, the calling system may use RAG to retrieve relevant business domain knowledge and append it to the agent context before calling the API. If you do not want to display this supplemental information to the user, set this parameter to true.	true or false
Meta	object	Não	Os metadados estendidos.
Context	any	Não	Um valor do tipo Map. Em cenários de agente personalizado, você pode usar este parâmetro para substituir parâmetros de espaço reservado.	{ "key1": "value1", "key2": "value2" }

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	D5D70885-7CC7-594A-80C7-2EF1B00FFB4B
Timestamp	integer	O timestamp.	1747447032
Jsonrpc	string	A versão do JSON-RPC. Valor fixo: 2.0.	2.0
Id	string	O ID passado pelo chamador. O valor é retornado exatamente como recebido na resposta.	631478864897630XXXX
Result	any	O conjunto de resultados do quadro SSE. O conteúdo da resposta está em conformidade com a especificação de código aberto Agent Client Protocol (ACP). Para mais informações, consulte https://agentclientprotocol.com/protocol/prompt-turn.	{"stopReason":"end_turn"}
Error	any	As informações de erro retornadas no quadro SSE. O conteúdo da resposta está em conformidade com a especificação de código aberto Agent Client Protocol (ACP). Para mais informações, consulte https://agentclientprotocol.com/protocol/prompt-turn.	{"code": 400, "errorCode": "0x50000000001", "message": "not exist session", "data": null}
Method	string	O método SSE. O conteúdo da resposta está em conformidade com a especificação de código aberto Agent Client Protocol (ACP). Para mais informações, consulte https://agentclientprotocol.com/protocol/prompt-turn.	session/update
Params	any	Os parâmetros SSE. O conteúdo da resposta está em conformidade com a especificação de código aberto Agent Client Protocol (ACP). Para 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"}}}

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "D5D70885-7CC7-594A-80C7-2EF1B00FFB4B",
  "Timestamp": 1747447032,
  "Jsonrpc": "2.0",
  "Id": "631478864897630XXXX",
  "Result": "{\"stopReason\":\"end_turn\"}\n",
  "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.