Utilisez l'opération d'API DescribeKnowledgeBase pour interroger la configuration complète d'une base de connaissances spécifiée.
Prérequis
Une instance AgentStorage a été créée et se trouve dans l'état
normal. Vous devez disposer du nom de l'instance et de son endpoint.Une clé API a été créée.
Paramètres de la requête
|
Paramètre |
Type |
Description |
|
|
string |
Nom de la base de connaissances. (Obligatoire) |
Exemple de requête
Lorsque vous vous authentifiez avec une clé API, transmettez le nom de l'instance et la clé API via les en-têtes de requête x-ots-instancename et x-ots-apikey.
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"}'
Réponse
|
Champ |
Type |
Description |
|
|
string |
Nom de la base de connaissances. |
|
|
string |
Description de la base de connaissances. |
|
|
list<string> |
Liste des tags. |
|
|
boolean |
Indique si la fonctionnalité de sous-espace est activée. |
|
|
int |
Horodatage de création, en millisecondes. |
|
|
int |
Horodatage de mise à jour, en millisecondes. |
|
|
list<object> |
Définitions des champs de métadonnées. |
|
|
object |
Configuration d'incorporation (embedding). |
|
|
object |
Configuration de récupération. |
{
"code": "SUCCESS",
"data": {
"knowledgeBaseName": "product_docs_kb",
"description": "Knowledge base for product documentation",
"tags": [
"product",
"documentation"
],
"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"
}