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

Recupera le informazioni sul layout analizzate per un Document.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
name

string

Obbligatorio. Nome completo della risorsa di Document, ad esempio projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{document}.

Se il chiamante non dispone dell'autorizzazione per accedere a Document, indipendentemente dalla sua esistenza, viene restituito un errore PERMISSION_DENIED.

Se il Document richiesto non esiste, viene restituito un errore NOT_FOUND.

Parametri di query

Parametri
processedDocumentType

enum (ProcessedDocumentType)

Obbligatorio. Quale tipo di elaborazione restituire.
processedDocumentFormat

enum (ProcessedDocumentFormat)

Il formato dell'output. Se non specificato, il valore predefinito è JSON.
imageId

string

Facoltativo. Specifica la configurazione per IMAGE_BYTES.

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

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • discoveryengine.documents.get

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