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

Recebe as informações de layout analisadas para um Document.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. Nome completo do recurso de Document, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{document}.

Se o autor da chamada não tiver permissão para acessar o Document, independente de ele existir ou não, um erro PERMISSION_DENIED será retornado.

Se o Document solicitado não existir, um erro NOT_FOUND será retornado.

Parâmetros de consulta

Parâmetros
processedDocumentType

enum (ProcessedDocumentType)

Obrigatório. Qual tipo de processamento retornar.
processedDocumentFormat

enum (ProcessedDocumentFormat)

Qual formato de saída deve ser usado. Se não for especificado, o padrão será JSON.
imageId

string

Opcional. Especifica a configuração de IMAGE_BYTES.

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 ProcessedDocument.

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 name:

  • discoveryengine.documents.get

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