查询知识库

更新时间:
复制 MD 格式

使用 DescribeKnowledgeBase 接口查询指定知识库的完整配置。

前提条件

请求参数

参数

类型

说明

knowledgeBaseName

string

知识库名称(必填)

请求示例

使用 API Key 认证时,通过 x-ots-instancename 和 x-ots-apikey 请求头传入实例名和 API Key。

curl -X POST https://<endpoint>/DescribeKnowledgeBase \
  -H "x-ots-instancename: <instance-name>" \
  -H "x-ots-apikey: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{"knowledgeBaseName": "product_docs_kb"}'

响应

字段

类型

说明

knowledgeBaseName

string

知识库名称

description

string

知识库描述

tags

list<string>

标签列表

subspace

boolean

是否开启子空间

createdAt

int

创建时间戳(毫秒)

updatedAt

int

更新时间戳(毫秒)

metadata

list<object>

元数据字段定义

embeddingConfiguration

object

Embedding 配置

retrievalConfiguration

object

检索配置

{
    "code": "SUCCESS",
    "data": {
        "knowledgeBaseName": "product_docs_kb",
        "description": "产品文档知识库",
        "tags": [
            "产品",
            "文档"
        ],
        "subspace": true,
        "multimodal": false,
        "metadata": [
            {
                "name": "author",
                "type": "string"
            },
            {
                "name": "date",
                "type": "date"
            },
            {
                "name": "score",
                "type": "double"
            }
        ],
        "createdAt": 1789633023582,
        "updatedAt": 1789633023582,
        "embeddingConfiguration": {
            "provider": "bailian",
            "model": "text-embedding-v4",
            "dimension": 1024,
            "url": null,
            "apiKey": null
        },
        "ingestConfiguration": {
            "enableTableFormulaCaption": false
        },
        "retrievalConfiguration": {
            "searchType": [
                "DENSE_VECTOR",
                "FULL_TEXT"
            ],
            "denseVectorSearchConfiguration": {
                "numberOfResults": 10
            },
            "fullTextSearchConfiguration": {
                "numberOfResults": 10
            },
            "rerankingConfiguration": {
                "type": "RRF",
                "numberOfResults": 5,
                "modelConfiguration": {
                    "provider": "bailian",
                    "model": "gte-rerank-v2"
                },
                "rrfConfiguration": {
                    "denseVectorSearchWeight": 0.6,
                    "fullTextSearchWeight": 0.4,
                    "k": 60
                },
                "weightConfiguration": {
                    "denseVectorSearchWeight": 0.7,
                    "fullTextSearchWeight": 0.3
                }
            }
        }
    },
    "message": "succeed"
}