Récupère, à partir du texte de requête, les fragments de connaissances (chunks) les plus pertinents dans les bases de connaissances rattachées à un Agent / Workflow, et renvoie le contenu du fragment, le document source et le score de similarité. Utile pour construire votre propre RAG, tester la qualité de la recherche et diagnostiquer le taux de couverture des connaissances.

Remarques

• La recherche porte sur les bases de connaissances rattachées à la version publiée de l'Agent / Workflow.
• Cet endpoint est en lecture seule : il ne modifie ni l'Agent, ni le Workflow, ni la base de connaissances.
• Une requête peut spécifier au maximum 10 data_ids ; au-delà, le code d'erreur 40332 est renvoyé.

Méthode de requête

POST

Endpoint

https://api-${endpoint}.gptbots.ai/v1/vector/match

Authentification

Pour plus de détails, consultez les instructions sur la méthode d'authentification dans la Vue d'ensemble de l'API.

Requête

Exemple de requête

Exemple 1 : rechercher dans des bases de connaissances précises

                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/vector/match' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
    "prompt": "Quelle est la politique de retour ?",
    "group_ids": ["6616e3f3d9d5cf1d5b6c8a21"],
    "top_k": 5,
    "doc_correlation": 0.5
}'

                    

Exemple 2 : limiter à des documents précis et activer le reranking

                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/vector/match' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
    "prompt": "Quelle est la politique de retour ?",
    "data_ids": ["6616e4a2d9d5cf1d5b6c8a35", "6616e4a2d9d5cf1d5b6c8a36"],
    "top_k": 3,
    "embedding_rate": 0.8,
    "rerank_version": "BGE-Rerank"
}'

                    

En-têtes de requête

Paramètres de la requête

Combinaison de group_ids et data_ids

Utilisation recommandée

• Recherche RAG sur une base de connaissances entière : ne transmettez que group_ids et omettez data_ids.
• Pour limiter à des documents précis : envoyez data_ids par lots de 10 au maximum.
• N'utilisez pas [] pour signifier « tout » : [] signifie « ne rien rechercher ».

Réponse

Exemple de réponse

                      
                      {
  "total": 2,
  "list": [
    {
      "content": "Les articles non ouverts peuvent être retournés sans motif dans les 7 jours suivant la réception…",
      "data_id": "6616e4a2d9d5cf1d5b6c8a35",
      "document_name": "Politique de service après-vente.pdf",
      "score": 0.87
    },
    {
      "content": "Les frais de retour sont à la charge de l'acheteur, sauf en cas de défaut de qualité…",
      "data_id": "6616e4a2d9d5cf1d5b6c8a35",
      "document_name": "Politique de service après-vente.pdf",
      "score": 0.79
    }
  ]
}

                    

Réponse en cas de succès

Réponse en cas d'échec

Codes d'erreur

Questions fréquentes

Q1: Les endpoints « Obtenir la liste des bases de connaissances » et « Obtenir la liste des documents » fonctionnent : pourquoi celui-ci renvoie-t-il 403 ?

A: Le plus souvent, plus de 10 data_ids ont été transmis (code d'erreur 40332). Les endpoints de listage n'ont pas cette limite, celui-ci l'a. Réduisez le nombre de data_ids ou utilisez group_ids.

Q2: Le résultat est vide (total à 0). Comment diagnostiquer ?

A: Vérifiez dans l'ordre : si group_ids ou data_ids a été transmis comme tableau vide [] ; si le seuil doc_correlation est trop élevé ; si les documents ciblés sont à l'état AVAILABLE ; et si la base de connaissances est rattachée à la version publiée de l'Agent / Workflow.