Method: corpora.documents.list

Enumera todos los Document en una Corpus.

Solicitud HTTP

GET https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

Obligatorio. Es el nombre de la Corpus que contiene Document. Ejemplo: corpora/my-corpus-123

Parámetros de consulta

Parámetros
pageSize

integer

Opcional. La cantidad máxima de Document que se mostrarán (por página). Es posible que el servicio muestre menos Document.

Si no se especifican, se mostrarán 10 Document como máximo. El límite de tamaño máximo es de 20 Document s por página.
pageToken

string

Opcional. Un token de página, recibido desde una llamada documents.list anterior.

Proporciona el nextPageToken que se muestra en la respuesta como un argumento en la solicitud siguiente para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a documents.list deben coincidir con la llamada que proporcionó el token de la página.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Respuesta de documents.list que contiene una lista paginada de Document. Los Document se ordenan por document.create_time de forma ascendente.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}
Campos
documents[]

object (Document)

Los Document que se muestran
nextPageToken

string

Un token que se puede enviar como pageToken para recuperar la página siguiente. Si se omite este campo, no hay más páginas.

Permisos de autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/generative-language.retriever
  • https://www.googleapis.com/auth/generative-language.retriever.readonly

Para obtener más información, consulta Descripción general de la autenticación.