Dokumentenliste abrufen

Rufen Sie eine Liste der Wissensdokumente in der Wissensdatenbank innerhalb des Agenten ab.

Anfragemethode

GET

Anfrage-URL

https://api-${endpoint}.gptbots.ai/v1/bot/doc/query/page

Authentifizierung der Anfrage

Siehe Übersicht für Details zur Authentifizierung.

Anfrage

Beispielanfrage

curl -X GET 'https://api.gptbots.ai/v1/bot/doc/query/page?page=1&page_size=10&knowledge_base_id=67457fea6f658672d6482542' \ -H 'Authorization: Bearer ${API Key}'

                      
                      curl -X GET 'https://api.gptbots.ai/v1/bot/doc/query/page?page=1&page_size=10&knowledge_base_id=67457fea6f658672d6482542' \
-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. Den API-Schlüssel erhalten Sie auf der API-Key-Seite.

Anfrageparameter

Feld	Typ	Erforderlich	Beschreibung
knowledge_base_id	String	Ja	Die ID der Wissensdatenbank.
page	Integer	Ja	Seitennummer, beginnend mit 1.
page_size	Integer	Ja	Anzahl der Dokumente pro Seite. Wert zwischen 10 und 100 angeben.

Antwort

Beispielantwort

{ "list": [ { "id": "xxxxxx", "name": "My Doc", "format": "pdf", "source_url": "https://gptbots.ai/article_1.pdf", "status": "ACTIVE", "chunk": 100, "token": 1000000, "char_count": 10000000, "create_time": 1699843200, "update_time": 1699843200, "creator_id": "xxxxxx", "creator_email": "johnlee@gptbots.ai" }, { "id": "xxxxxx", "name": "My Doc 2", "format": "txt", "source_url": "https://gptbots.ai/article_2.html", "status": "ACTIVE", "chunk": 100, "token": 1000000, "char_count": 10000000, "create_time": 1699843200, "update_time": 1699843200, "creator_id": "xxxxxx", "creator_email": "johnlee@gptbots.ai" } ], "total": 100 }

                      
                      {
    "list": [
        {
            "id": "xxxxxx",
            "name": "My Doc",
            "format": "pdf",
            "source_url": "https://gptbots.ai/article_1.pdf",
            "status": "ACTIVE",
            "chunk": 100,
            "token": 1000000,
            "char_count": 10000000,
            "create_time": 1699843200,
            "update_time": 1699843200,
            "creator_id": "xxxxxx",
            "creator_email": "johnlee@gptbots.ai"
        },
        {
            "id": "xxxxxx",
            "name": "My Doc 2",
            "format": "txt",
            "source_url": "https://gptbots.ai/article_2.html",
            "status": "ACTIVE",
            "chunk": 100,
            "token": 1000000,
            "char_count": 10000000,
            "create_time": 1699843200,
            "update_time": 1699843200,
            "creator_id": "xxxxxx",
            "creator_email": "johnlee@gptbots.ai"
        }
    ],
    "total": 100
}

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Feldname	Typ	Beschreibung
list	Array<Object>	Dokumentenliste.
id	String	Dokumenten-ID.
name	String	Dokumentenname.
format	String	Dokumentenformat.
source_url	String	Quell-URL des Dokuments.
status	String	Dokumentenstatus.
chunk	Integer	Anzahl der Wissensabschnitte im Dokument.
token	Integer	Anzahl der Tokens im Dokument.
char_count	Integer	Anzahl der Zeichen im Dokument.
create_time	Long	Erstellungszeitpunkt des Dokuments (Timestamp).
update_time	Long	Aktualisierungszeitpunkt des Dokuments (Timestamp).
creator_id	String	Ersteller:innen-ID des Dokuments.
creator_email	String	E-Mail-Adresse des/der Ersteller:in des Dokuments.
total	Integer	Gesamtanzahl der gefundenen Dokumente.

Fehlerantwort

Feld	Typ	Beschreibung
code	Int	Fehlercode.
message	String	Fehlerdetails.