2024-03-20
▼ ▲ discoveryengine.projects.locations.collections.dataStores.branches.documents.getProcessedDocument
Path: v1alpha/{+name}:getProcessedDocument
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}:getProcessedDocument
HTTP Method: GET
Parameters:
name
Description: Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/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.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$
Location: path
Required: Yes
Type: string
processedDocumentType
Description: Required. What type of processing to return.
Location: query
Type: string
Enum Descriptions:
Enum:
processedDocumentFormat
Description: What format output should be. If unspecified, defaults to JSON.
Location: query
Type: string
Enum Descriptions:
Enum:
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets the parsed layout information for a Document.
▼ ▲ discoveryengine.projects.locations.dataStores.branches.documents.getProcessedDocument
Path: v1alpha/{+name}:getProcessedDocument
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}:getProcessedDocument
HTTP Method: GET
Parameters:
name
Description: Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/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.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$
Location: path
Required: Yes
Type: string
processedDocumentType
Description: Required. What type of processing to return.
Location: query
Type: string
Enum Descriptions:
Enum:
processedDocumentFormat
Description: What format output should be. If unspecified, defaults to JSON.
Location: query
Type: string
Enum Descriptions:
Enum:
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets the parsed layout information for a Document.