Créer une base de connaissances

Cette interface permet de créer une nouvelle base de connaissances pour l'Agent lié à la clé API.

Méthode de requête

POST

URL de la requête

https://api-${endpoint}.gptbots.ai/v1/bot/knowledge/base/create

Authentification de la requête

Consultez la section Présentation pour les détails d'authentification.

Requête

Exemple de requête

curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/bot/knowledge/base/create' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "name": "Base de connaissances produit", "desc": "Base de connaissances destinée aux manuels produit, FAQ et documents métier", "graph_enable": false, "access_control_enabled": false }'

                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/bot/knowledge/base/create' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
    "name": "Base de connaissances produit",
    "desc": "Base de connaissances destinée aux manuels produit, FAQ et documents métier",
    "graph_enable": false,
    "access_control_enabled": false
}'

Ce bloc de code dans la fenêtre flottante

En-têtes de la requête

Champ	Type	Description
Authorization	Bearer ${API Key}	Utilisez Authorization: Bearer ${API Key} pour l'authentification. Obtenez la clé API depuis la page Clé API.

Paramètres de la requête

Champ	Type	Obligatoire	Description
name	String	Oui	Nom de la base de connaissances.
desc	String	Oui	Description de la base de connaissances.
graph_enable	Boolean	Non	Indique si le graphe de connaissances est activé.
kg_ner_extraction_user_prompt	String	Non	Prompt d'extraction de triplets. Si vide, la configuration par défaut du système est utilisée.
access_control_enabled	Boolean	Non	Indique si le contrôle d'accès est activé, c'est-à-dire le filtrage des permissions au niveau des rôles ou des documents.

Réponse

Exemple de réponse

{ "knowledge_base_id": "6a475ee61d276b3d062a1bcb" }

                      
                      {
    "knowledge_base_id": "6a475ee61d276b3d062a1bcb"
}

Ce bloc de code dans la fenêtre flottante

Réponse en cas de succès

Champ	Type	Description
knowledge_base_id	String	ID de la base de connaissances nouvellement créée.

Réponse en cas d'échec

Champ	Type	Description
code	Integer	Code d'erreur.
message	String	Détails de l'erreur.