更新时间:2025-05-26 GMT+08:00
分享

智能分析助手列表查询接口

功能介绍

查询智能分析助手列表。

URI

GET /v1/{project_id}/subjects

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取方法请参见获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

keyword

String

智能分析助手名称。

sort_dir

String

排序类别:

  • desc:倒序。

  • asc:正序。

sort_key

String

排序字段。

limit

Integer

返回条目数。不传该参数时,默认查询前10条信息。

offset

Integer

返回条目的起始offset。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Workspace-Id

String

工作空间ID。获取方法请参见获取工作空间ID

X-Auth-Token

String

用户Token。通过调用IAM服务,获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

count

Integer

总条目数。

page_data

Array of ExtSubjectVO objects

当前页的数据,元素类型为ExtSubjectVO。

表5 ExtSubjectVO

参数

参数类型

描述

name

String

智能分析助手名称。

id

String

智能分析助手ID。

comments

String

智能分析助手描述。

status

Integer

智能分析助手状态。初始化(0),图构建(1),索引构建(2),训练成功(3),训练失败(4),训练停止(5)。

permission_list

Array of strings

当前用户拥有的协同授权权限点:edit、export、use、read。

workspace_id

String

智能分析助手所属工作空间ID。

project_id

String

智能分析助手所属的项目ID。

create_user

String

智能分析助手的创建者。

create_user_name

String

智能分析助手的创建者名称。

create_date

Long

智能分析助手的创建时间。

update_user

String

智能分析助手的更新者。

update_user_name

String

智能分析助手的更新者名称。

update_date

Long

智能分析助手的更新时间。

datasets

Array of ExtSubjectDatasetVO objects

智能分析助手关联数据集列表。

recommended_questions

String

智能分析助手的推荐问题。

表6 ExtSubjectDatasetVO

参数

参数类型

描述

dataset_id

String

数据集ID。

name

String

数据集名称。

请求示例

查询智能分析助手列表。

GET https://{endpoint}/v1/{project_id}/subjects?subjects?keyword=&sort_key=&sort_dir=&limit=20&offset=0

响应示例

状态码:200

查询智能分析助手列表成功。

{
  "count" : 1,
  "page_data" : [ {
    "name" : "xxxxxxxxx",
    "subject_id" : "xxxxxxxxxxxxx",
    "comments" : "",
    "status" : 3,
    "permission_list" : [ "edit", "use" ],
    "workspace_id" : "xx4xxaxxxxac8x51xxx30",
    "project_id" : "xxb4dxx4xxx886xx33xx27",
    "create_user" : "xxxb4xxx4b0baxxxxx0dc18xxx3",
    "create_user_name" : "xxv_l00xxxx",
    "create_date" : 1702046652513,
    "update_user" : "xxxxxxx4b0xxxb8xxxx27x",
    "update_user_name" : "xxv_l00xxxx",
    "update_date" : 1710496061316,
    "datasets" : [ {
      "dataset_id" : "xxxxxxxxxxxxx",
      "name" : "xxxxxxxxxx"
    } ],
    "recommended_questions" : "xxxxxxxxxxxxx"
  } ]
}

状态码

状态码

描述

200

查询智能分析助手列表成功。

错误码

请参见错误码

相关文档