GetChatContent-阿里云帮助中心

Operation description

Request Description

The response is returned as an SSE stream, where each event follows the SSEEvent schema and contains meta-information such as the message level.
The content field in each SSE event may carry actual message text or a JSON object, depending on the value of content_type.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:GetChatContent

get

*All Resource

*

None

Request syntax

POST /api/v1/chat/stream HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
DMSUnit	string	No	The current DMS unit. Chinese mainland users of Alibaba Cloud should use cn-hangzhou by default.	cn-hangzhou
SessionId	string	No	The session ID. This parameter is required.	sess_12345
AgentId	string	No	The agent ID. This parameter is required.	xxxx-xxxx-xxxx
Checkpoint	string	No	The backend will return output starting from this checkpoint.	0

Response elements

Element	Type	Description	Example
	object	Each data entry in the SSE response stream conforms to this JSON structure.
content	string	The message content.	Data understanding completed.
event_type	string	The type of the message, used to distinguish control signals from actual messages. For example, `CHAT_START` indicates the beginning of an Agent reply, `CHAT_FINISH` indicates the end of an Agent reply, `DATA` indicates a message carrying content, and `DELTA` indicates a part of an incrementally output message.	DATA
content_type	string	The type of the content field. Valid values: `[str, json]`. When the value is json, the content field can be further parsed as a JSON structure.	str
checkpoint	integer	The checkpoint value.	0
level	integer	The output level of the message. A higher level indicates higher importance.	20
category	string	The category of the message, used to assist in parsing the content of the json type. For example, `PLAN` indicates that the message is a display of an execution plan and conforms to the execution plan schema.	PLAN
timestamp	string	The UNIX timestamp in seconds when this message was generated by the Agent.	1774578047

Examples

Success response

JSON format

{
  "content": "Data understanding completed.",
  "event_type": "DATA",
  "content_type": "str",
  "checkpoint": 0,
  "level": 20,
  "category": "PLAN",
  "timestamp": "1774578047"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.