DescribeKnowledgeBase Query a knowledge base - Tablestore

Prerequisites

An AgentStorage instance has been created and is in the normal state, and you have obtained the instance endpoint and instance name.
An API Key has been created.

Request parameters

Parameter	Type	Description
`knowledgeBaseName`	string	The name of the knowledge base. (Required)

Request example

When you authenticate with an API Key, pass the instance name and API Key through the x-ots-instancename and x-ots-apikey request headers.

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"}'

Response

Field	Type	Description
`knowledgeBaseName`	string	The name of the knowledge base.
`description`	string	The description of the knowledge base.
`tags`	list<string>	The list of tags.
`subspace`	boolean	Indicates whether the subspace feature is enabled.
`createdAt`	int	The creation timestamp, in milliseconds.
`updatedAt`	int	The update timestamp, in milliseconds.
`metadata`	list<object>	The metadata field definitions.
`embeddingConfiguration`	object	The embedding configuration.
`retrievalConfiguration`	object	The retrieval configuration.

{
    "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"
}