Method: projects.locations.dataStores.branches.documents.list

Recupera un elenco di Document.

Richiesta HTTP

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/dataStores/*/branches/*}/documents

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. Il nome della risorsa del ramo padre, ad esempio projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}. Utilizza default_branch come ID del ramo per elencare i documenti nel ramo predefinito.

Se il chiamante non ha l'autorizzazione per elencare i Document in questo ramo, indipendentemente dal fatto che il ramo esista o meno, viene restituito un errore PERMISSION_DENIED.

Parametri di query

Parametri
pageSize

integer

Numero massimo di Document da restituire. Se non specificato, il valore predefinito è 100. Il valore massimo consentito è 1000. I valori superiori a 1000 vengono impostati su 1000.

Se questo campo è negativo, viene restituito un errore INVALID_ARGUMENT.
pageToken

string

Un token di pagina ListDocumentsResponse.next_page_token ricevuto da una chiamata DocumentService.ListDocuments precedente. Fornisci questo valore per recuperare la pagina successiva.

Quando esegui la paginazione, tutti gli altri parametri forniti a DocumentService.ListDocuments devono corrispondere alla chiamata che ha fornito il token di pagina. In caso contrario, viene restituito un errore INVALID_ARGUMENT.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di ListDocumentsResponse.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • discoveryengine.documents.list

Per saperne di più, consulta la documentazione di IAM.