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

Obtém as informações de esquema analisadas para um Document.

Pedido HTTP

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

O URL usa a sintaxe de transcodificação de 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 autorização para aceder ao Document, independentemente de existir ou não, é devolvido um erro PERMISSION_DENIED.

Se o Document pedido não existir, é devolvido um erro NOT_FOUND.

Parâmetros de consulta

Parâmetros
processedDocumentType

enum (ProcessedDocumentType)

Obrigatório. Que tipo de processamento a devolver.
processedDocumentFormat

enum (ProcessedDocumentFormat)

Qual deve ser o formato de saída. Se não for especificado, a predefinição é JSON.
imageId

string

Opcional. Especifica a configuração para IMAGE_BYTES.

Corpo do pedido

O corpo do pedido tem de estar vazio.

Corpo da resposta

Se for bem-sucedido, o corpo da resposta contém uma instância de ProcessedDocument.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso name:

  • discoveryengine.documents.get

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