Obtenir le document corrélé

Récupérez les données du document référencé utilisé par l'Agent lors de la réponse à un message, en fonction de l'message_id fourni. La réponse inclut des informations telles que les identifiants de documents, les noms et les URL sources des documents référencés.

Méthode de requête

POST

URL de la requête

https://api-${endpoint}.gptbots.ai/v1/bot/data/references

Authentification de la requête

Voir 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/data/references' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "message_id": "xxxxx" }'

                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/bot/data/references' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
    "message_id": "xxxxx"
}'

Ce bloc de code dans la fenêtre flottante

En-têtes de la requête

Champ	Type	Description
Authorization	Bearer ${token}	Utilisez `Authorization: Bearer ${token}` pour l'authentification. Obtenez la clé depuis la page Clés API comme token.
Content-Type	application/json	Type de données, la valeur est application/json.

Corps de la requête

Champ	Type	Obligatoire	Description
message_id	string	true	ID du message de la réponse de l'Agent.

Réponse

Exemple de réponse

{ "code": 0, "msg": "success", "data": { "conversationId": "65dc320df07244300b25b993", "questionId": "65dc323ef07244300b25b9c5", "answerId": "65dc323ef07244300b25b9c6", "refDoc": [ { "dataId": "65dc3234f07244300b25b9b9", "dataName": "中国的历史", "sourceUrl": "https://www.example.com/chinese-history" } ] } }

                      
                      {
    "code": 0,
    "msg": "success",
    "data": {
        "conversationId": "65dc320df07244300b25b993",
        "questionId": "65dc323ef07244300b25b9c5",
        "answerId": "65dc323ef07244300b25b9c6",
        "refDoc": [
            {
                "dataId": "65dc3234f07244300b25b9b9",
                "dataName": "中国的历史",
                "sourceUrl": "https://www.example.com/chinese-history"
            }
        ]
    }
}

Ce bloc de code dans la fenêtre flottante

Réponse en cas de succès

Champ	Type	Description
conversationId	string	ID de la conversation
questionId	string	ID du message de la question utilisateur
answerId	string	ID du message de la réponse de l'Agent
refDoc	JSON Array	Données du document référencé
dataId	string	ID du document
dataName	string	Nom du document
sourceUrl	string	URL source du document

Réponse en cas d'échec

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

Codes d'erreur

Code	Message
40000	Paramètre invalide
40379	Crédit insuffisant
40378	Agent supprimé
20055	API interdite
40127	Échec de l'authentification du développeur