文档首页/ 应用平台 AppStage/ API参考/ API/ 知识中心/ 检索知识库数据
更新时间：2024-12-11 GMT+08:00
查看PDF
分享

检索知识库数据

功能介绍

检索知识库数据，根据用户提供的检索信息，返回命中的信息数据。

URI

POST https://aiae.appstage.myhuaweicloud.com/v1/knowledge-bases/{knowledge_base_id}/embed-datas

表1 路径参数

参数

是否必选

参数类型

描述

knowledge_base_id

是

String

知识库id。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Authorization

是

String

AI原生应用引擎鉴权API Key。

1.以管理员身份登录AI原生应用引擎工作台，在左侧导航栏选择“系统管理 > 平台租户鉴权”。

2.在“平台租户鉴权”页面，选择“平台API Key”页签，单击“新增平台API Key”。

3.在“新增平台API Key”对话框中的输入框设置API Key名称，用以区分API Key。

4.在弹出的下载窗口中单击“立即下载”，将API Key下载到本地查看。

5.使用时，需在sk前加上Bearer ，如Bearer sk-xxxxxxxx。
表3 请求Body参数

参数

是否必选

参数类型

描述

keyword

否

String

搜索关键字。

similarity_min

否

Float

相似度最小值（范围在0-1之间）。

limit

是

Integer

检索返回切片限制数量（范围在1-100之间）。

filter

否

Object

过滤条件。

order_by

否

Object

排序规则。

data_sets

否

Array of DataSetSearchInfo objects

检索的数据集信息（数量在1-10之间），用于检索知识库中部分数据集。
表4 SearchSqlFilter

参数

是否必选

参数类型

描述

group_type

否

String

过滤条件运算符（枚举值：AND和OR）。

expressions

否

Array of Expression objects

过滤条件。
表5 Expression

参数

是否必选

参数类型

描述

field

否

String

过滤字段。

field_type

否

String

过滤字段类型（枚举值：INT、FLOAT、BOOLEAN和STRING）。

operator

否

String

过滤操作符（枚举值：EQUAL、NOT_EQUAL、GREAT_THAN、GREAT_EQUAL、LESS_THAN、LESS_EQUAL、IN、NOTIN和STARTS_WITH）。

values

否

Array of strings

过滤值。
表6 SqlOrder

参数

是否必选

参数类型

描述

order_items

否

Array of OrderItem objects

排序规则（数量在1到10之间）。
表7 OrderItem

参数

是否必选

参数类型

描述

field

否

String

排序字段。

field_type

否

String

排序字段类型（枚举值：INT、FLOAT、BOOLEAN和STRING）。

order_type

否

String

排序类型（枚举值：ASC和DESC）。
表8 DataSetSearchInfo

参数

是否必选

参数类型

描述

data_set_id

否

String

数据集id。

响应参数

状态码： 200

表9 响应Body参数

参数

参数类型

描述

data

Array of ChunkData objects

检索知识库数据具体内容。
表10 ChunkData

参数

参数类型

描述

id

String

切片id。

document

String

切片向量化内容。

chunk

String

完整切片内容。

chunk_fragments

Map<String,String>

切片片段（map类型，key为切片片段名称，value为切片片段内容）。

similarity

Float

向量化内容（document）和检索关键字（keyword）的向量相似度。

metadata

metadata object

文本过滤字段。

download_addresses

Map<String,String>

图片或视频临时下载地址（map类型，key为文件路径，value为下载地址）。

download_address

String

废弃字段，请使用download_addresses。

data_set_id

String

切片所属知识数据集id。
表11 metadata

参数

参数类型

描述

order

Integer

切片序号。

file_name

String

文件名称。

path

String

文件路径。

状态码： 500

表12 响应Body参数

参数

参数类型

描述

error_code

String

异常错误码。

error_msg

String

异常错误信息。

请求示例

{
  "keyword" : "户外",
  "similarity_min" : "0.78",
  "limit" : 10,
  "filter" : {
    "group_type" : "AND",
    "expressions" : [ {
      "field" : "metadata.answer",
      "field_type" : "STRING",
      "operator" : "EQUAL",
      "values" : [ "我是xxx。" ]
    } ]
  },
  "order_by" : {
    "order_items" : [ {
      "field" : "metadata.order",
      "field_type" : "INT",
      "order_type" : "DESC"
    } ]
  },
  "data_sets" : [ {
    "data_set_id" : "a31ed909-xxxx-xxxx-xxxx-10958c90b3f7"
  } ]
}

响应示例

状态码： 200

OK。

{
  "data" : [ {
    "id" : "812857ef-xxxx-xxxx-xxxx-24ba9fd5e95c",
    "document" : "问题：你是谁。回答：我是xxx。回答用户id：000。",
    "chunk" : "问题：你是谁。回答：我是xxx。回答用户id：000。",
    "chunk_fragments" : {
      "question" : "你是谁。",
      "answer" : "我是xxx。"
    },
    "similarity" : 0.87,
    "metadata" : {
      "order" : 10,
      "file_name" : "户外运动热度大大带动各相关产业发展.docx",
      "path" : "户外运动热度大大带动各相关产业发展.docx",
      "question" : "你是谁。",
      "answer" : "我是xxx。"
    },
    "download_addresses" : {
      "xxx.png" : "https://xxxx"
    },
    "download_address" : null,
    "data_set_id" : "3967c49d-xxxx-xxxx-xxxx-5eda056a1f1b"
  } ]
}

状态码： 500

服务器内部错误或三方服务器内部错误。

{
  "error_code" : "AIAE.00001500",
  "error_msg" : "系统内部错误。"
}

状态码

状态码

描述

200

OK。

500

服务器内部错误或三方服务器内部错误。

错误码

请参见错误码。

父主题： 知识中心

相关文档