Obtenir la liste des documents

Obtenez une liste des documents de connaissances présents dans la base de connaissances de l'Agent.

Méthode de requête

GET

URL de la requête

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

Authentification de la requête

Consultez la section Présentation pour les détails d'authentification.

Requête

Exemple de requête

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

Ce bloc de code dans la fenêtre flottante

En-tête de la requête

Champ	Type	Description
Authorization	Bearer ${API Key}	Utilisez Authorization: Bearer ${API Key} pour l'authentification. Obtenez la clé API depuis la page Clé API.

Paramètres de la requête

Champ	Type	Obligatoire	Description
knowledge_base_id	String	Oui	L'identifiant de la base de connaissances.
page	Integer	Oui	Numéro de page, à partir de 1.
page_size	Integer	Oui	Nombre de documents par page. Valeur comprise entre 10 et 100.

Réponse

Exemple de réponse

{ "list": [ { "id": "xxxxxx", "name": "Mon 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": "Mon 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": "Mon 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": "Mon 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
}

Ce bloc de code dans la fenêtre flottante

Réponse en cas de succès

Nom du champ	Type	Description
list	Array<Object>	Liste des documents.
id	String	Identifiant du document.
name	String	Nom du document.
format	String	Format du document.
source_url	String	URL source du document.
status	String	Statut du document.
chunk	Integer	Nombre de segments de connaissances dans le document.
token	Integer	Nombre de tokens dans le document.
char_count	Integer	Nombre de caractères dans le document.
create_time	Long	Date de création du document, timestamp.
update_time	Long	Date de mise à jour du document, timestamp.
creator_id	String	Identifiant du créateur du document.
creator_email	String	Email du créateur du document.
total	Integer	Nombre total de documents trouvés.

Réponse en cas d'échec

Champ	Type	Description
code	Int	Code d'erreur.
message	String	Détails de l'erreur.