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

Gets the parsed layout information for a Document.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Full resource name of Document, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{document}.

If the caller does not have permission to access the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested Document does not exist, a NOT_FOUND error is returned.

Query parameters

Parameters
processedDocumentType

enum (ProcessedDocumentType)

Required. What type of processing to return.
processedDocumentFormat

enum (ProcessedDocumentFormat)

What format output should be. If unspecified, defaults to JSON.
imageId

string

Optional. Specifies config for IMAGE_BYTES.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ProcessedDocument.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.documents.get

For more information, see the IAM documentation.