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

Recebe uma lista de Documents.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso da ramificação principal, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}. Use default_branch como o ID da ramificação para listar documentos na ramificação padrão.

Se o autor da chamada não tiver permissão para listar Documents nessa ramificação, independente de ela existir ou não, um erro PERMISSION_DENIED será retornado.

Parâmetros de consulta

Parâmetros
pageSize

integer

Número máximo de Documents a serem retornados. Se não for especificado, o padrão será 100. O valor máximo permitido é 1.000. Valores acima de 1.000 são definidos como 1.000.

Se esse campo for negativo, um erro INVALID_ARGUMENT será retornado.
pageToken

string

Um token de página ListDocumentsResponse.next_page_token recebido de uma chamada DocumentService.ListDocuments anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para DocumentService.ListDocuments precisam corresponder à chamada que forneceu o token da página. Caso contrário, um erro INVALID_ARGUMENT será retornado.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de ListDocumentsResponse.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • discoveryengine.documents.list

Para mais informações, consulte a documentação do IAM.