Q&A-Liste abrufen

Mit der API-Funktion „Q&A-Liste abrufen“ können Sie die Q&A-Liste aus dem Chatverlauf eines Agenten gezielt auslesen. Diese API-Dokumentation zeigt Ihnen, wie Sie mit einer Beispielanfrage die gewünschten Q&A-Einträge effizient abrufen.

HTTP-Methode

GET

Anfrage-URL

https://api.gptbots.ai/v1/message/qa/record/page

Authentifizierung der Anfragen

Details zur Authentifizierung finden Sie in der Übersicht. Für den Zugriff benötigen Sie einen API-Schlüssel.

Beispielanfrage

curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/message/qa/record/page?page=1&page_size=10&start_time=1732982400000&end_time=1735660799999&user_feedback=ALL' \ -H 'Authorization: Bearer ${API-Schlüssel}'

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/message/qa/record/page?page=1&page_size=10&start_time=1732982400000&end_time=1735660799999&user_feedback=ALL' \
-H 'Authorization: Bearer ${API-Schlüssel}'

Dieser Codeblock im schwebenden Fenster

Anfrage-Header

Feld	Typ	Beschreibung
Authorization	Bearer ${API-Schlüssel}	Verwenden Sie `Authorization: Bearer ${API-Schlüssel}` zur Authentifizierung. Den API-Schlüssel erhalten Sie auf der API-Schlüssel-Seite.

Anfrage-Body

Feld	Typ	Erforderlich	Beschreibung
user_feedback	String	Ja	Nutzer:innen-Feedback. ALL: Alle. NONE: Kein Feedback. GOOD: Positives Feedback, Likes, Lob. BAD: Negatives Feedback, Dislikes, Beschwerden.
start_time	Long	Ja	Startzeit des Abfragezeitraums im Zeitstempel-Format. Abfrageobjekt ist die Zeit der Fragen (Q) im Q&A.
end_time	Long	Ja	Endzeit des Abfragezeitraums im Zeitstempel-Format. Abfrageobjekt ist die Zeit der Fragen (Q) im Q&A.
page	Integer	Ja	Seitenzahl, beginnend mit 1.
page_size	Integer	Ja	Anzahl der Dokumente pro Seite. Wertebereich: 10–100.

Antwortbeispiel

{ "qa": [ { "id": "xxxxxx", "q_time": 1699891200, "q": "xxxxxx", "a": "xxxxxx", "user_feedback": "GOOD", "convo_id": "xxxxxx", "convo_type": "API", "aid": "xxxxxx", "user_id": "xxxxxx" }, { "id": "xxxxxx", "q_time": 1699891214, "q": "xxxxxx", "a": "xxxxxx", "user_feedback": "BAD", "convo_id": "xxxxxx", "convo_type": "API", "aid": "xxxxxx", "user_id": "xxxxxx" } ] }

                      
                      {
    "qa": [
        {
            "id": "xxxxxx",
            "q_time": 1699891200,
            "q": "xxxxxx",
            "a": "xxxxxx",
            "user_feedback": "GOOD",
            "convo_id": "xxxxxx",
            "convo_type": "API",
            "aid": "xxxxxx",
            "user_id": "xxxxxx"
        },
        {
            "id": "xxxxxx",
            "q_time": 1699891214,
            "q": "xxxxxx",
            "a": "xxxxxx",
            "user_feedback": "BAD",
            "convo_id": "xxxxxx",
            "convo_type": "API",
            "aid": "xxxxxx",
            "user_id": "xxxxxx"
        }
    ]
}

Dieser Codeblock im schwebenden Fenster

Antwort bei Erfolg

Feldname	Typ	Beschreibung
qa	Array<Object>	Liste der Q&A-Einträge.
id	String	ID des Q&A-Eintrags.
q_time	Long	Zeitstempel, zu dem die Frage (Q) gestellt wurde.
q	String	Inhalt der Frage.
a	String	Inhalt der Antwort.
user_feedback	String	Nutzer:innen-Feedback.
convo_id	String	ID der zugehörigen Konversation.
convo_type	String	Typ der zugehörigen Konversation.
user_id	String	Nutzer:innen-ID. Eine von der/dem Agentenentwickler:in über Drittsysteme vergebene, individuelle ID zur Identifikation der jeweiligen Nutzer:innen-Identität.

Fehlermeldung

Feld	Typ	Beschreibung
code	Int	Fehlercode.
message	String	Fehlerdetails.