CreateKnowledgeBase: Create a knowledge base - Tablestore - Centre de documentation Alibaba Cloud

Prérequis

Une instance AgentStorage a été créée, est à l'état normal et vous disposez du endpoint ainsi que du nom de l'instance.
Une clé API a été générée.

Paramètres de requête

Paramètre

Type

Description

knowledgeBaseName

string

Nom de la base de connaissances. Ce paramètre est obligatoire. Le nom doit commencer par une lettre et ne contenir que des lettres, des chiffres et des traits de soulignement. Sa longueur doit être comprise entre 1 et 64 caractères et il doit être unique.

description

string

Description de la base de connaissances. La taille maximale est de 4 Ko.

subspace

boolean

Indique si les sous-espaces sont activés. Valeur par défaut : false. Lorsque les sous-espaces sont activés, toutes les opérations sur les documents et les requêtes de récupération doivent spécifier le champ subspace. Ce paramètre ne peut pas être modifié après la création de la base de connaissances.

tags

list<string>

Liste des tags. La longueur totale ne peut pas dépasser 4 Ko.

metadata

list<object>

Définitions des champs de métadonnées. Pour plus d'informations, consultez la description ci-dessous.

embeddingConfiguration

object

Configuration d'embedding. Ce paramètre ne peut pas être modifié après la création de la base de connaissances. Si vous ne spécifiez pas ce paramètre, le modèle Bailian text-embedding-v4 (1024 dimensions) est utilisé par défaut.

retrievalConfiguration

object

Configuration de récupération par défaut. L'opération Retrieve utilise ces paramètres lorsqu'aucune configuration n'est spécifiée dans la requête. Après la création de la base de connaissances, appelez UpdateKnowledgeBase pour modifier la configuration.

Définitions des champs de métadonnées

Chaque élément contient un name (nom du champ) et un type (type du champ). Il est impossible d'ajouter ou de supprimer des définitions de champs de métadonnées après la création de la base de connaissances. Planifiez tous les champs que vous souhaitez utiliser pour le filtrage avant de créer la base de connaissances. Les valeurs de métadonnées que vous spécifiez lors de l'importation ou de la mise à jour des documents doivent respecter ces définitions.

Élément de définition

Description

Types pris en charge

string, long, double, boolean, date, string_list, long_list, double_list, boolean_list et date_list

Nom du champ

Maximum de 128 octets UTF-8. Le nom du champ ne peut pas contenir le caractère .

Nombre de champs

Maximum de 200 champs.

Champs réservés

_uid, _id, _type, _all, _parent, _routing, _index, _size, _timestamp, _ttl et _score

embeddingConfiguration

Paramètre

Type

Description

provider

string

Fournisseur du modèle. Valeur par défaut : bailian (modèle Bailian intégré). La valeur custom (modèle personnalisé) est également prise en charge.

model

string

Nom du modèle. Valeur par défaut : text-embedding-v4. Bailian prend également en charge text-embedding-v3

dimension

int

Dimensions du vecteur. Valeur par défaut : 1024.

apiKey

string

Obligatoire uniquement en mode custom.

url

string

Obligatoire uniquement en mode custom. Vous devez contacter Tablestore pour enregistrer l'URL au préalable.

retrievalConfiguration

Paramètre

Type

Description

searchType

list<string>

Types de récupération. Valeur par défaut : ["DENSE_VECTOR", "FULL_TEXT"]

denseVectorSearchConfiguration.numberOfResults

int

Nombre de résultats renvoyés par la recherche vectorielle. Valeur par défaut : 20.

fullTextSearchConfiguration.numberOfResults

int

Nombre de résultats renvoyés par la recherche en texte intégral. Valeur par défaut : 20.

rerankingConfiguration.type

string

Type de reclassement. Valeurs valides : RRF, WEIGHT et MODEL. Valeur par défaut : WEIGHT

rerankingConfiguration.numberOfResults

int

Nombre de résultats renvoyés après le reclassement. Valeur par défaut : 20.

weightConfiguration.denseVectorSearchWeight

double

Poids de la recherche vectorielle. Valeur par défaut : 0,7.

weightConfiguration.fullTextSearchWeight

double

Poids de la recherche en texte intégral. Valeur par défaut : 0,3.

rrfConfiguration.denseVectorSearchWeight

double

Poids de la recherche vectorielle en mode RRF. Valeur par défaut : 1,0.

rrfConfiguration.fullTextSearchWeight

double

Poids de la recherche en texte intégral en mode RRF. Valeur par défaut : 1,0.

rrfConfiguration.k

int

Paramètre de l'algorithme RRF. Valeur par défaut : 60. La valeur doit être supérieure à 0.

modelConfiguration.provider

string

Fournisseur du modèle de reclassement. Valeur par défaut : bailian. Seul Bailian est pris en charge.

modelConfiguration.model

string

Nom du modèle de reclassement. Valeur par défaut : gte-rerank-v2 (la valeur par défaut dans la région de Singapour est qwen3-rerank).

Pour plus d'informations sur la configuration complète de récupération, consultez la rubrique Récupérer et trier.

Exemple de requête

Lorsque vous utilisez l'authentification par clé API, transmettez le nom de l'instance et la clé API dans les en-têtes de requête x-ots-instancename et x-ots-apikey.

curl -X POST https://<endpoint>/CreateKnowledgeBase \
  -H "x-ots-instancename: <instance-name>" \
  -H "x-ots-apikey: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "knowledgeBaseName": "product_docs_kb",
    "description": "Knowledge base for product documentation",
    "subspace": true,
    "tags": ["product", "documentation"],
    "metadata": [
      {"name": "author", "type": "string"},
      {"name": "date", "type": "date"},
      {"name": "score", "type": "double"}
    ],
    "embeddingConfiguration": {
      "provider": "bailian",
      "model": "text-embedding-v4",
      "dimension": 1024
    },
    "retrievalConfiguration": {
      "searchType": ["DENSE_VECTOR", "FULL_TEXT"],
      "denseVectorSearchConfiguration": {"numberOfResults": 10},
      "fullTextSearchConfiguration": {"numberOfResults": 10},
      "rerankingConfiguration": {
        "type": "RRF",
        "numberOfResults": 5,
        "rrfConfiguration": {"denseVectorSearchWeight": 0.6, "fullTextSearchWeight": 0.4, "k": 60}
      }
    }
  }'

Réponse

{"code": "SUCCESS", "data": {}, "message": "succeed"}