ChatStream-阿里云帮助中心

Operation description

This operation answers questions based on the documents scoped to the specified session.
Call the GetChatSessionList operation to obtain the session ID.
Alternatively, call the CreateChatSession operation to create a new session.

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

energy:ChatStream

none

*All Resource

*

None

Request syntax

POST /api/v2/aidoc/document/chat/stream HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
sessionId	string	Yes	The Q&A session ID. Call the `GetChatSessionList` operation to retrieve the IDs of existing sessions. Alternatively, call the `CreateChatSession` operation to create a new session.	bfce2248-1546-4298-8bcf-70ac26e69646
question	string	Yes	The question or prompt.	知识库问答文档如何获取
documentIds	array	No	A list of document IDs for the Q&A. Important If you specify document IDs, ensure the `sessionId` you provide is not associated with a folder. The session must have been created with an empty folder ID.
	integer	No	The document ID. You can obtain the document ID from the SaaS page or by calling other SDK operations, such as `DetailDocument`.	3456

Response elements

Element	Type	Description	Example
	object	The returned result.
requestId	string	The request ID.	83A5A7DD-8974-5769-952E-590A97BEA34E
data	ChatItem	The details of the Q&A exchange.

Examples

Success response

JSON format

{
  "requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E",
  "data": {
    "question": "How to use the knowledge base.",
    "answer": "No related content found.",
    "createTime": 1747280158000,
    "refDocList": [
      {
        "docName": "a.pdf",
        "sourceType": "doc",
        "docUrl": "https://carbon-aidoc.oss-accelerate.aliyuncs.com/jobs/42dbc7-3a9e-4e18-8939-3fd2d247bd3c/document/97178d94c75941d3b932883c810c5e.pdf",
        "docInfo": {
          "pages": 23,
          "pageListInfo": [
            {
              "imageWidth": 23,
              "imageUrl": "2",
              "pageIdCurDoc": 2,
              "angle": 0,
              "excelParseResult": "null",
              "wordParseResult": "null",
              "pdfParseResult": "null",
              "imageHeight": 22
            }
          ]
        },
        "originDocName": "a.doc",
        "pageNum": [
          {
            "pos": [
              [
                {
                  "x": 22,
                  "y": 86
                }
              ]
            ],
            "num": 12
          }
        ],
        "originDocUrl": "https://carbon-aidoc.oss-accelerate.aliyuncs.com/jobs/42dbc7-3a9e-4e18-8939-3fd2d247bd3c/document/97178d94c75941d3b932883c810c5e.doc"
      }
    ],
    "folderName": "deafult folder",
    "folderId": "7708fddb-21dc-4403-a4ea-5b94eccce4c3"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.