PATCH
/
v1
/
sessions
/
{sessionId}

Authorizations

​
x-pd-api-key
string
headerrequired

Headers

​
x-pd-api-agent-id
string
required

The ID of the data agent. If no data agent ID is available or you want to use the general mode, set it to GENERAL.

​
x-pd-external-trace-id
string

The external trace ID. The length ranges from 0 to 128 characters.

Path Parameters

​
sessionId
string
required

The ID of the session to modify.

Body

application/json
​
title
string

The new session name.

Specify at least one parameter: title, languageType, jobMode, or maxMessagesInContext.

​
languageType
enum<string>
default: AUTO

The new language in which the output is generated. Possible values are:

  • AUTO: adaptive recognition
  • EN: English
  • ES: Spanish
  • AR: Arabic
  • PT: Portuguese
  • ID: Indonesian
  • JA: Japanese
  • RU: Russian
  • HI: Hindi
  • FR: French
  • DE: German
  • VI: Vietnamese
  • TR: Turkish
  • PL: Polish
  • IT: Italian
  • KO: Korean
  • ZH-CN: Simplified Chinese
  • ZH-TW: Traditional Chinese

Specify at least one parameter: title, languageType, jobMode, or maxMessagesInContext.

Available options:
AUTO,
EN,
ES,
AR,
PT,
ID,
JA,
RU,
HI,
FR,
DE,
VI,
TR,
PL,
IT,
KO,
ZH-CN,
ZH-TW
​
jobMode
enum<string>
default: AUTO

The new job mode. Possible values are:

  • AUTO: Powerdrill automatically detects your intent and selects the appropriate job mode from data analysis and information retrieval.
  • DATA_ANALYTICS: Powerdrill focuses specifically on data analysis.

Specify at least one parameter: title, languageType, jobMode, or maxMessagesInContext.

Available options:
AUTO,
DATA_ANALYTICS
​
maxMessagesInContext
integer
default: 10

The new maximum number of messages retained per session, with a value range of 0 to 10. The default is 10.

Specify at least one parameter: title, languageType, jobMode, or maxMessagesInContext.

Response

200 - application/json
​
code
integer
required

Status code. 0 indicates that the operation is successful. Otherwise, the operation fails. Possible error codes include:

  • 100: Bad request.
  • 201: Request frequency limit.
  • 9999: Internal error.
  • 100001: Invalid operation.
​
data
object
required

Null is returned when the operation is successful.

List sessionsDelete session