Skip to main content
GET
/
v2
/
team
/
datasets
/
{id}
/
status
Get status summary of data sources in dataset
curl --request GET \
  --url https://app.ai.relyt.cn/app/api/v2/team/datasets/{id}/status \
  --header 'x-pd-api-key: <api-key>'
import requests

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

headers = {"x-pd-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-pd-api-key': '<api-key>'}};

fetch('https://app.ai.relyt.cn/app/api/v2/team/datasets/{id}/status', 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/datasets/{id}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)

func main() {

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

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-pd-api-key", "<api-key>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://app.ai.relyt.cn/app/api/v2/team/datasets/{id}/status")
.header("x-pd-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["x-pd-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "code": 0,
  "data": {
    "synched_count": 5,
    "invalid_count": 0,
    "synching_count": 0
  }
}
此接口会计算并返回指定数据集中处于每个状态的数据源数量。您可以使用该接口来检查数据集中的所有数据源是否已完成同步并可用于数据分析任务。 只有当返回中的 invalidCountsynchingCount 均为 0时,才表示该数据集中的所有数据源都能用于问答。否则,Relyt AI 将无法使用未完成同步的数据源进行数据分析与探索。 请求示例:
curl --request GET \
  --url https://app.ai.relyt.cn/app/api/v2/team/datasets/{id}/status?user_id=tmm-dafasdfasdfasdf \
  --header 'x-pd-api-key: <api-key>'
import requests

url = "https://app.ai.relyt.cn/app/api/v2/team/datasets/{id}/status?user_id=tmm-dafasdfasdfasdf"

headers = {"x-pd-api-key": "<api-key>"}

response = requests.request("GET", url, headers=headers)

print(response.text)
返回示例:
200
{
  "code": 0,
  "data": {
    "synched_count": 5,
    "invalid_count": 0,
    "synching_count": 0
  }
}

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。

Query Parameters

user_id
string
required

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

Response

200 - application/json
code
integer
required

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

data
object
required

处于每个状态的数据源数量。

请注意,只有当 invalid_countsynching_count 都为 0 时,使用 Relyt AI 进行问答时才能使用数据集中的所有数据源。否则,Relyt AI 将无法使用未完成同步的数据源进行数据分析与探索。