文档首页/ 智能数据洞察 DataArts Insight/ API参考/ 嵌入分析/ 创建嵌入分析 - CreateEmbedding
更新时间：2025-11-25 GMT+08:00
查看PDF
分享

创建嵌入分析 - CreateEmbedding

功能介绍

创建嵌入分析。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

POST /v1/{project_id}/embeddings

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

id

否

String

参数解释：

嵌入分析id。

取值范围：

不涉及

name

是

String

参数解释：

嵌入分析名称。

取值范围：

不涉及

resource_type

是

String

参数解释：

嵌入分析对应的资源类型。

取值范围：

  • dashboard：看板

  • screen：大屏

  • subject：助手

resource_id

是

String

参数解释：

嵌入分析对应的资源id。

取值范围：

不涉及

root_resource_id

是

String

参数解释：

嵌入分析对应的根资源id。

取值范围：

不涉及

auth_type

否

String

参数解释：

嵌入分析的访问类型。

取值范围：

  • 0：登录访问

  • 1：ticket认证

config

否

String

参数解释：

嵌入分析配置参数。

取值范围：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

id

String

参数解释：

创建好的嵌入分析id。

取值范围：

不涉及

请求示例

创建嵌入分析。

POST https://{endpoint}/v1/{project_id}/embeddings

{
  "id" : "6cb08a50xxxxxxxxxxxxxxxxxxxxxx",
  "name" : "新建嵌入分析",
  "resource_type" : "dashboard",
  "resource_id" : "866a519fxxxxxxxxxxxxxxxx",
  "root_resource_id" : "866a519fxxxxxxxxxxxxxxxx",
  "config" : "ticket=ec85f874axxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "auth_type" : 1
}

响应示例

状态码：200

创建嵌入分析成功。

{    
"id": "6cb08a50xxxxxxxxxxxxxxxxxxxxxxx",
}

状态码

状态码

描述

200

创建嵌入分析成功。

错误码

请参见错误码。

父主题： 嵌入分析

相关文档