Referenzierte Wissensbasisdaten abrufen

Rufen Sie die Wissensbasisabschnitte ab, die in der Antwort des Agenten referenziert wurden, einschließlich Abschnittsinhalt, Dokumenten-ID, Dokumentenname, Quell-URL und Relevanzbewertung.

Anfragemethode

GET

Anfrage-URL

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

Authentifizierung der Anfrage

Informationen zur Authentifizierung finden Sie unter API-Übersicht.

Anfrage

Beispielanfrage

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

Dieser Codeblock im schwebenden Fenster

Anfrage-Header

Feld	Typ	Beschreibung
Authorization	Bearer ${API Key}	Verwenden Sie Authorization: Bearer ${API Key} zur Authentifizierung. Sie erhalten den API Key auf der Seite „API-Key“.

Anfrageparameter

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

Antwort

Beispielantwort

{ "conversation_id": "65dc320df07244300b25b993", "question_id": "65dc323ef07244300b25b9c5", "answer_id": "65dc323ef07244300b25b9c6", "correlate_dataset": [ { "content": "Die Chinesische Mauer wurde erbaut, um die Invasion nordischer Nomadenstämme abzuwehren.", "data_id": "65dc3234f07244300b25b9b9", "data_name": "Chinesische Geschichte", "source_url": "https://www.example.com/chinese-history", "score": 0.93492633 } ] }

                      
                      {
    "conversation_id": "65dc320df07244300b25b993",
    "question_id": "65dc323ef07244300b25b9c5",
    "answer_id": "65dc323ef07244300b25b9c6",
    "correlate_dataset": [
        {
            "content": "Die Chinesische Mauer wurde erbaut, um die Invasion nordischer Nomadenstämme abzuwehren.",
            "data_id": "65dc3234f07244300b25b9b9",
            "data_name": "Chinesische Geschichte",
            "source_url": "https://www.example.com/chinese-history",
            "score": 0.93492633
        }
    ]
}

Dieser Codeblock im schwebenden Fenster

Erfolgsantwort

Feld	Typ	Beschreibung
conversation_id	string	Konversations-ID
question_id	string	Message-ID der Nutzeranfrage
answer_id	string	Message-ID der Agenten-Antwort
correlate_dataset	JSON Array	Korrelierte Datensätze
content	string	Inhalt des Wissensbasisabschnitts
data_id	string	Dokumenten-ID
data_name	string	Dokumentenname
source_url	string	Quell-URL des Dokuments
score	string	Semantische Relevanz zwischen Wissensabschnitt und Anfrage

Fehlerantwort

Feld	Typ	Beschreibung
code	int	Fehlercode
message	string	Fehlerdetails

Fehlercodes

Code	Nachricht
40000	Ungültiger Parameter
40379	Guthaben nicht ausreichend
200222	Agenten-Konfiguration unterstützt diese Funktion nicht.
40378	Agent gelöscht
20055	API ist gesperrt
40127	Entwickler-Authentifizierung fehlgeschlagen