Obtenir la connaissance référencée

Récupérez les données de tranche de la base de connaissances référencées dans la réponse de l'Agent, incluant le contenu de la tranche, l'ID du document, le nom du document, l'URL source et le score de pertinence.

Méthode de requête

GET

URL de la requête

https://api-${endpoint}.gptbots.ai/v1/correlate/dataset

Authentification de la requête

Consultez la section Présentation de l'API pour les instructions d'authentification.

Requête

Exemple de requête

curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/correlate/dataset?message_id=65e04591a0e1e42392696d78' \ -H 'Authorization: Bearer ${API Key}' \

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/correlate/dataset?message_id=65e04591a0e1e42392696d78' \
-H 'Authorization: Bearer ${API Key}' \

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
message_id	string	oui	ID du message de la réponse de l'Agent.

Réponse

Exemple de réponse

{ "conversation_id": "65dc320df07244300b25b993", "question_id": "65dc323ef07244300b25b9c5", "answer_id": "65dc323ef07244300b25b9c6", "correlate_dataset": [ { "content": "La Grande Muraille de Chine a été construite pour résister à l'invasion des tribus nomades du nord.", "data_id": "65dc3234f07244300b25b9b9", "data_name": "Histoire de la Chine", "source_url": "https://www.example.com/chinese-history", "score": 0.93492633 } ] }

                      
                      {
    "conversation_id": "65dc320df07244300b25b993",
    "question_id": "65dc323ef07244300b25b9c5",
    "answer_id": "65dc323ef07244300b25b9c6",
    "correlate_dataset": [
        {
            "content": "La Grande Muraille de Chine a été construite pour résister à l'invasion des tribus nomades du nord.",
            "data_id": "65dc3234f07244300b25b9b9",
            "data_name": "Histoire de la Chine",
            "source_url": "https://www.example.com/chinese-history",
            "score": 0.93492633
        }
    ]
}

Ce bloc de code dans la fenêtre flottante

Réponse réussie

Champ	Type	Description
conversation_id	string	ID de la conversation
question_id	string	ID du message de la question utilisateur
answer_id	string	ID du message de la réponse de l'Agent
correlate_dataset	Tableau JSON	Ensemble de données corrélées
content	string	Contenu de la tranche de connaissance
data_id	string	ID du document
data_name	string	Nom du document
source_url	string	URL source du document
score	string	Pertinence sémantique entre la tranche de connaissance et la question.

Réponse d'échec

Champ	Type	Description
code	int	Code d'erreur.
message	string	Détails de l'erreur.

Codes d'erreur

Code	Message
40000	Paramètre invalide
40379	Crédit insuffisant
200222	La configuration de l'Agent ne prend pas en charge cette fonctionnalité.
40378	Agent supprimé
20055	API interdite
40127	Échec de l'authentification du développeur