Class GetProcessedDocumentRequest (0.11.11)

GetProcessedDocumentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Request message for DocumentService.GetDocument method.

Attributes

Name Description
name str
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.
processed_document_type google.cloud.discoveryengine_v1alpha.types.GetProcessedDocumentRequest.ProcessedDocumentType
Required. What type of processing to return.
processed_document_format google.cloud.discoveryengine_v1alpha.types.GetProcessedDocumentRequest.ProcessedDocumentFormat
What format output should be. If unspecified, defaults to JSON.

Classes

ProcessedDocumentFormat

ProcessedDocumentFormat(value)

The format of the returned processed document. If unspecified, defaults to JSON.

Values: PROCESSED_DOCUMENT_FORMAT_UNSPECIFIED (0): Default value. JSON (1): output format will be a JSON string representation of processed document.

ProcessedDocumentType

ProcessedDocumentType(value)

The type of processing to return in the response.

Values: PROCESSED_DOCUMENT_TYPE_UNSPECIFIED (0): Default value. PARSED_DOCUMENT (1): Available for all data store parsing configs. CHUNKED_DOCUMENT (2): Only available if ChunkingConfig is enabeld on the data store.