Abrufen korrelierter Dokumente

Mit dieser API können Sie die vom Agenten bei der Beantwortung einer Nachricht referenzierten Dokumente anhand der angegebenen message_id abrufen. Die Antwort enthält Informationen wie Dokument-IDs, Dokumentnamen und Quell-URLs der referenzierten Dokumente.

Anfragemethode

POST

Anfrage-URL

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

Authentifizierung der Anfrage

Weitere Informationen zur Authentifizierung finden Sie in der Übersicht.

Anfrage

Beispielanfrage

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"
}'

Dieser Codeblock im schwebenden Fenster

Anfrage-Header

Feld	Typ	Beschreibung
Authorization	Bearer ${token}	Verwenden Sie `Authorization: Bearer ${token}` zur Authentifizierung. Den Schlüssel erhalten Sie als Token auf der Seite API Keys.
Content-Type	application/json	Datentyp, Wert ist application/json.

Anfrage-Body

Feld	Typ	Erforderlich	Beschreibung
message_id	string	ja	Message-ID der Antwort des Agenten.

Antwort

Beispielantwort

{ "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"
            }
        ]
    }
}

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Feld	Typ	Beschreibung
conversationId	string	Konversations-ID
questionId	string	Message-ID der Nutzer:innen-Frage
answerId	string	Message-ID der Antwort des Agenten
refDoc	JSON Array	Referenzierte Dokumente
dataId	string	Dokumenten-ID
dataName	string	Dokumentenname
sourceUrl	string	Quell-URL des Dokuments

Fehlermeldungen

Feld	Typ	Beschreibung
code	int	Fehlercode
msg	string	Fehlermeldung

Fehlercodes

Code	Meldung
40000	Ungültiger Parameter
40379	Nicht genügend Guthaben
40378	Agent gelöscht
20055	API ist deaktiviert
40127	Entwickler-Authentifizierung fehlgeschlagen