CreateChatSession - Energy Expert - Alibaba Cloud Documentation Center

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

none

*All Resource

*

None

Request syntax

POST /api/v2/aidoc/document/chat/session/create HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request parameter.
userId	string	No	The unique ID of the user. If you do not specify this parameter, the ID of the account that calls the software development kit (SDK) is used by default.	12344
folderId	string	Yes	The folder ID. The knowledge base Q&A feature retrieves Q&A pairs from the current folder and its subfolders. Important If you enter an empty string, Q&A is performed based on a custom file list. In this case, you must use this parameter with the Chat or ChatStream API operation and pass a list of file IDs in the API call. For more information, see the documentation for the Chat and ChatStream API operations. Otherwise, the feature will not work correctly.	1a851c4a-1d65-11ef-99a7-ssfsfdd
name	string	Yes	The name of the current session.	analyzer_1744684195

Response elements

Element	Type	Description	Example
	object	The returned result.
requestId	string	The request ID.	9bc20a5a-b26b-4c28-922a-7cd10b61f96f
data	object	The returned data structure.
sessionId	string	The Q&A session ID. It is used to record multiple Q&A interactions for the same user.	596ac39c-8855-4128-bad7-78aebeff48fc

Examples

Success response

JSON format

{
  "requestId": "9bc20a5a-b26b-4c28-922a-7cd10b61f96f",
  "data": {
    "sessionId": "596ac39c-8855-4128-bad7-78aebeff48fc"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.