Skip to main content
POST
/
v2
/
team
/
sessions
/
{id}
Modify session
curl --request POST \
  --url https://app.ai.relyt.cn/app/api/v2/team/sessions/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-pd-api-key: <api-key>' \
  --data '
{
  "name": "hello",
  "output_language": "EN",
  "job_mode": "DATA_ANALYSIS",
  "max_contextual_job_history": 3,
  "user_id": "tmm-ddsdfsfgs"
}
'
import requests

url = "https://app.ai.relyt.cn/app/api/v2/team/sessions/{id}"

payload = {
"name": "hello",
"output_language": "EN",
"job_mode": "DATA_ANALYSIS",
"max_contextual_job_history": 3,
"user_id": "tmm-ddsdfsfgs"
}
headers = {
"x-pd-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-pd-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'hello',
output_language: 'EN',
job_mode: 'DATA_ANALYSIS',
max_contextual_job_history: 3,
user_id: 'tmm-ddsdfsfgs'
})
};

fetch('https://app.ai.relyt.cn/app/api/v2/team/sessions/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://app.ai.relyt.cn/app/api/v2/team/sessions/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'hello',
'output_language' => 'EN',
'job_mode' => 'DATA_ANALYSIS',
'max_contextual_job_history' => 3,
'user_id' => 'tmm-ddsdfsfgs'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-pd-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://app.ai.relyt.cn/app/api/v2/team/sessions/{id}"

payload := strings.NewReader("{\n \"name\": \"hello\",\n \"output_language\": \"EN\",\n \"job_mode\": \"DATA_ANALYSIS\",\n \"max_contextual_job_history\": 3,\n \"user_id\": \"tmm-ddsdfsfgs\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-pd-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://app.ai.relyt.cn/app/api/v2/team/sessions/{id}")
.header("x-pd-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"hello\",\n \"output_language\": \"EN\",\n \"job_mode\": \"DATA_ANALYSIS\",\n \"max_contextual_job_history\": 3,\n \"user_id\": \"tmm-ddsdfsfgs\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.ai.relyt.cn/app/api/v2/team/sessions/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-pd-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"hello\",\n \"output_language\": \"EN\",\n \"job_mode\": \"DATA_ANALYSIS\",\n \"max_contextual_job_history\": 3,\n \"user_id\": \"tmm-ddsdfsfgs\"\n}"

response = http.request(request)
puts response.read_body
{
  "code": 123,
  "data": {}
}

Authorizations

x-pd-api-key
string
header
required

Headers

x-pd-external-trace-id
string

您本地系统中设置的 Trace ID,至多支持 128 个字符。当请求发生错误时,可以将此 ID 提供给 Relyt AI 团队,协助进行故障排查。

Path Parameters

id
string
required

要修改的会话 ID。

如需查看项目中存在的会话,请调用 GET /v2/team/sessions 接口。

Body

application/json
name
string
required

会话名称,至多可支持 128 个字符。如超过此限制,名称将被截断展示。

user_id
string
required

用户 ID,即您在组织中的唯一身份标识。

output_language
enum<string>
default:AUTO

Relyt AI 的回复语言。例如,当设置为 EN 时,则 Relyt AI 使用英语进行回复。如不指定,将使用默认值 AUTO,即 Relyt AI 会根据提示词自动选择合适的回复语言。可选值包括:

  • AUTO:根据提示词自动识别
  • EN:英语
  • ES:西班牙语
  • AR:阿拉伯语
  • PT:葡萄牙语
  • ID:印尼语
  • JA:日语
  • RU:俄语
  • HI:印地语
  • FR:法语
  • DE:德语
  • VI:越南语
  • TR:土耳其语
  • PL:波兰语
  • IT:意大利语
  • KO:韩语
  • ZH-CN:简体中文
  • ZH-TW:繁体中文
Available options:
AUTO,
EN,
ES,
AR,
PT,
ID,
JA,
RU,
HI,
FR,
DE,
VI,
TR,
PL,
IT,
KO,
ZH-CN,
ZH-TW
job_mode
enum<string>
default:DATA_ANALYTICS

任务类型。可选值包括:

  • AUTO:Relyt AI 根据你的提问进行意图判断,决定该任务为数据分析任务或信息检索任务。
  • DATA_ANALYTICS:Relyt AI 会根据你的输入进行数据分析。

如不指定,则采用默认值 AUTO。如果您明确地想要进行数据分析,我们建议您将值设置为 DATA_ANALYTICS,从而 Relyt AI 可以跳过意图识别步骤,加快问题处理速度。

Available options:
AUTO,
DATA_ANALYTICS
max_contextual_job_history
integer

作为下一个任务上下文的历史任务数,取值范围为 010,默认值为 10。如设置为 0,则当前任务将不使用任何历史任务作为上下文信息。

Response

200 - application/json
code
integer
required

状态码。0 表示操作成功。其它值则表示操作失败。如需进行错误排查,请参阅 错误码

data
object
required

操作成功则返回 null。