Obtener lista de documentos

Obtiene una lista de documentos de conocimiento de la base de conocimiento del agente.

Método de solicitud

GET

URL de la solicitud

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

Autenticación de la solicitud

Consulte la sección «Visión general» para obtener información detallada sobre la autenticación.

Solicitud

Ejemplo de solicitud

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

Este bloque de código en una ventana flotante

Cabeceras de la solicitud

Campo	Tipo	Descripción
Authorization	Bearer ${API Key}	Se utiliza `Authorization: Bearer ${API Key}` para la autenticación. La clave de API se obtiene en la página «API Key».

Parámetros de la solicitud

Campo	Tipo	Obligatorio	Descripción
knowledge_base_id	String	Sí	ID de la base de conocimiento.
page	Integer	Sí	Número de página, a partir de 1.
page_size	Integer	Sí	Número de documentos por página. Indicar un valor entre 10 y 100.

Respuesta

Ejemplo de respuesta

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

Este bloque de código en una ventana flotante

Respuesta de éxito

Nombre del campo	Tipo	Descripción
list	Array	Lista de documentos.
list[].id	String	ID del documento.
list[].name	String	Nombre del documento.
list[].format	String	Formato del documento.
list[].source_url	String	URL de origen del documento.
list[].status	String	Estado del documento.
list[].chunk	Integer	Número de fragmentos de conocimiento del documento.
list[].token	Integer	Número de tokens del documento.
list[].char_count	Integer	Número de caracteres del documento.
list[].create_time	Long	Hora de creación del documento (timestamp Unix).
list[].update_time	Long	Hora de actualización del documento (timestamp Unix).
list[].creator_id	String	ID del creador del documento.
list[].creator_email	String	Correo electrónico del creador del documento.
total	Integer	Número total de documentos encontrados.

Respuesta de error

Campo	Tipo	Descripción
code	Int	Código de error.
message	String	Detalles del error.