导出语义条目

导出知识库定义和语义条目,用于审阅或迁移。

GET https://moi.matrixorigin.cn/newmoi/semantic-models/{model_id}/export

调用前准备

查询知识库列表取得知识库 ID。准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

请求参数

curl "https://moi.matrixorigin.cn/newmoi/semantic-models/$MODEL_ID/export" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

字段

类型

必填

说明

model_id

integer

要导出定义的知识库 ID。

成功响应

成功时返回 200。迁移前先导出当前状态,并确认导入目标没有语义条目。

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "model": {
      "id": 401,
      "name": "product_docs",
      "source_counts": {
        "files": 2,
        "tables": 1,
        "total": 3
      }
    },
    "entries": [
      {
        "id": 501,
        "kind": "metric",
        "key": "total_rows",
        "tables": ["orders"],
        "spec": {
          "expr": "COUNT(*)"
        }
      }
    ]
  }
}

字段

类型

说明

code

string

成功时为 OK

msg

string

成功时为 OK

data

object

响应数据。

下面表格展开响应示例中 data 对象;每一行是该对象的一个字段。

字段

类型

说明

model

object

知识库定义。

entries

array of object

当前知识库中的语义条目。

下面表格展开响应示例中 data.model 对象;每一行是该对象的一个字段。

字段

类型

说明

id

integer

知识库 ID。

name

string

知识库名称。

description

string

知识库说明。

tables

array of object

兼容的旧式表来源定义。

files

object

兼容的旧式文件来源定义;未设置时可能省略。

source_counts

object

来源数量统计。

created_at

integer

创建时间。

updated_at

integer

最近更新时间。

下面表格展开响应示例中 data.model.tables 数组的每一项;每一行是该数组项的一个字段。

字段

类型

说明

db_name

string

数据库名称。

table_names

array of string

该数据库中的表名称。

下面表格展开响应示例中 data.model.files 对象;每一行是该对象的一个字段。

字段

类型

说明

file_ids

array of string

文件 ID。

parents

array of string

文件父目录路径。

volume_ids

array of integer

卷 ID。

volumes

array of object

卷及其扫描路径。

vector_table

string

文本向量表名称。

embedding_model

string

文本嵌入模型标识。

image_vector_table

string

图片向量表名称。

image_embedding_model

string

图片嵌入模型标识。

image_embedding_backend_id

string

图片嵌入后端 ID。

image_embedding_dimension

integer

图片嵌入维度。

image_preprocess_version

string

图片预处理版本。

image_distance_metric

string

图片向量距离度量。

tags

array of string

文件来源标签。

下面表格展开响应示例中 data.model.files.volumes 数组的每一项;每一行是该数组项的一个字段。

字段

类型

说明

volume_id

integer

卷 ID。

parents

array of string

卷内父目录路径。

path

string

卷内起始路径。

下面表格展开响应示例中 data.model.source_counts 对象;每一行是该对象的一个字段。

字段

类型

说明

files

integer

文件来源数量。

tables

integer

表来源数量。

total

integer

来源总数。

下面表格展开响应示例中 data.entries 数组的每一项;每一行是该数组项的一个字段。

字段

类型

说明

id

integer

条目 ID。

kind

string

条目类型。

key

string

稳定引用键。

tables

array of string

关联表名称;未设置时可能省略。

spec

object

json.RawMessage 类型专属配置对象;结构严格由 data.entries[].kind 决定。各 kind 的固定字段、join_columns[] 子字段和 sql_resultset 嵌套字段见创建语义条目

created_at

integer

创建时间。

updated_at

integer

最近更新时间。

下面表格展开响应示例中 data.entries[].spec 对象;实际字段随 kind 变化。

字段

类型

说明

expr

string

示例中指标条目的计算表达式。

错误响应

{
  "code": "ErrNotFound",
  "msg": "resource not found",
  "data": null
}

字段

类型

说明

code

string

错误代码。

msg

string

面向调用者的错误信息。

data

null

发生错误时为 null

后续操作

迁移或批量写入前,用导出结果对照没有语义条目的目标知识库,再导入语义条目

最后更新于