Package cloud.google.com/go/documentai/apiv1beta3/documentaipb (v1.23.8)

Variables

Dataset_State_name, Dataset_State_value

var (
	Dataset_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "UNINITIALIZED",
		2: "INITIALIZING",
		3: "INITIALIZED",
	}
	Dataset_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"UNINITIALIZED":     1,
		"INITIALIZING":      2,
		"INITIALIZED":       3,
	}
)

Enum value maps for Dataset_State.

Document_Page_Layout_Orientation_name, Document_Page_Layout_Orientation_value

var (
	Document_Page_Layout_Orientation_name = map[int32]string{
		0: "ORIENTATION_UNSPECIFIED",
		1: "PAGE_UP",
		2: "PAGE_RIGHT",
		3: "PAGE_DOWN",
		4: "PAGE_LEFT",
	}
	Document_Page_Layout_Orientation_value = map[string]int32{
		"ORIENTATION_UNSPECIFIED": 0,
		"PAGE_UP":                 1,
		"PAGE_RIGHT":              2,
		"PAGE_DOWN":               3,
		"PAGE_LEFT":               4,
	}
)

Enum value maps for Document_Page_Layout_Orientation.

Document_Page_Token_DetectedBreak_Type_name, Document_Page_Token_DetectedBreak_Type_value

var (
	Document_Page_Token_DetectedBreak_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "SPACE",
		2: "WIDE_SPACE",
		3: "HYPHEN",
	}
	Document_Page_Token_DetectedBreak_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED": 0,
		"SPACE":            1,
		"WIDE_SPACE":       2,
		"HYPHEN":           3,
	}
)

Enum value maps for Document_Page_Token_DetectedBreak_Type.

Document_PageAnchor_PageRef_LayoutType_name, Document_PageAnchor_PageRef_LayoutType_value

var (
	Document_PageAnchor_PageRef_LayoutType_name = map[int32]string{
		0: "LAYOUT_TYPE_UNSPECIFIED",
		1: "BLOCK",
		2: "PARAGRAPH",
		3: "LINE",
		4: "TOKEN",
		5: "VISUAL_ELEMENT",
		6: "TABLE",
		7: "FORM_FIELD",
	}
	Document_PageAnchor_PageRef_LayoutType_value = map[string]int32{
		"LAYOUT_TYPE_UNSPECIFIED": 0,
		"BLOCK":                   1,
		"PARAGRAPH":               2,
		"LINE":                    3,
		"TOKEN":                   4,
		"VISUAL_ELEMENT":          5,
		"TABLE":                   6,
		"FORM_FIELD":              7,
	}
)

Enum value maps for Document_PageAnchor_PageRef_LayoutType.

Document_Provenance_OperationType_name, Document_Provenance_OperationType_value

var (
	Document_Provenance_OperationType_name = map[int32]string{
		0: "OPERATION_TYPE_UNSPECIFIED",
		1: "ADD",
		2: "REMOVE",
		7: "UPDATE",
		3: "REPLACE",
		4: "EVAL_REQUESTED",
		5: "EVAL_APPROVED",
		6: "EVAL_SKIPPED",
	}
	Document_Provenance_OperationType_value = map[string]int32{
		"OPERATION_TYPE_UNSPECIFIED": 0,
		"ADD":                        1,
		"REMOVE":                     2,
		"UPDATE":                     7,
		"REPLACE":                    3,
		"EVAL_REQUESTED":             4,
		"EVAL_APPROVED":              5,
		"EVAL_SKIPPED":               6,
	}
)

Enum value maps for Document_Provenance_OperationType.

RevisionRef_RevisionCase_name, RevisionRef_RevisionCase_value

var (
	RevisionRef_RevisionCase_name = map[int32]string{
		0: "REVISION_CASE_UNSPECIFIED",
		1: "LATEST_HUMAN_REVIEW",
		2: "LATEST_TIMESTAMP",
		3: "BASE_OCR_REVISION",
	}
	RevisionRef_RevisionCase_value = map[string]int32{
		"REVISION_CASE_UNSPECIFIED": 0,
		"LATEST_HUMAN_REVIEW":       1,
		"LATEST_TIMESTAMP":          2,
		"BASE_OCR_REVISION":         3,
	}
)

Enum value maps for RevisionRef_RevisionCase.

HumanReviewStatus_State_name, HumanReviewStatus_State_value

var (
	HumanReviewStatus_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "SKIPPED",
		2: "VALIDATION_PASSED",
		3: "IN_PROGRESS",
		4: "ERROR",
	}
	HumanReviewStatus_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"SKIPPED":           1,
		"VALIDATION_PASSED": 2,
		"IN_PROGRESS":       3,
		"ERROR":             4,
	}
)

Enum value maps for HumanReviewStatus_State.

BatchProcessMetadata_State_name, BatchProcessMetadata_State_value

var (
	BatchProcessMetadata_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "WAITING",
		2: "RUNNING",
		3: "SUCCEEDED",
		4: "CANCELLING",
		5: "CANCELLED",
		6: "FAILED",
	}
	BatchProcessMetadata_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"WAITING":           1,
		"RUNNING":           2,
		"SUCCEEDED":         3,
		"CANCELLING":        4,
		"CANCELLED":         5,
		"FAILED":            6,
	}
)

Enum value maps for BatchProcessMetadata_State.

TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TrainingMethod_name, TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TrainingMethod_value

var (
	TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TrainingMethod_name = map[int32]string{
		0: "TRAINING_METHOD_UNSPECIFIED",
		1: "MODEL_BASED",
		2: "TEMPLATE_BASED",
	}
	TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TrainingMethod_value = map[string]int32{
		"TRAINING_METHOD_UNSPECIFIED": 0,
		"MODEL_BASED":                 1,
		"TEMPLATE_BASED":              2,
	}
)

Enum value maps for TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TrainingMethod.

ReviewDocumentRequest_Priority_name, ReviewDocumentRequest_Priority_value

var (
	ReviewDocumentRequest_Priority_name = map[int32]string{
		0: "DEFAULT",
		1: "URGENT",
	}
	ReviewDocumentRequest_Priority_value = map[string]int32{
		"DEFAULT": 0,
		"URGENT":  1,
	}
)

Enum value maps for ReviewDocumentRequest_Priority.

ReviewDocumentResponse_State_name, ReviewDocumentResponse_State_value

var (
	ReviewDocumentResponse_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "REJECTED",
		2: "SUCCEEDED",
	}
	ReviewDocumentResponse_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"REJECTED":          1,
		"SUCCEEDED":         2,
	}
)

Enum value maps for ReviewDocumentResponse_State.

ReviewDocumentOperationMetadata_State_name, ReviewDocumentOperationMetadata_State_value

var (
	ReviewDocumentOperationMetadata_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "RUNNING",
		2: "CANCELLING",
		3: "SUCCEEDED",
		4: "FAILED",
		5: "CANCELLED",
	}
	ReviewDocumentOperationMetadata_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"RUNNING":           1,
		"CANCELLING":        2,
		"SUCCEEDED":         3,
		"FAILED":            4,
		"CANCELLED":         5,
	}
)

Enum value maps for ReviewDocumentOperationMetadata_State.

SummaryOptions_Length_name, SummaryOptions_Length_value

var (
	SummaryOptions_Length_name = map[int32]string{
		0: "LENGTH_UNSPECIFIED",
		1: "BRIEF",
		2: "MODERATE",
		3: "COMPREHENSIVE",
	}
	SummaryOptions_Length_value = map[string]int32{
		"LENGTH_UNSPECIFIED": 0,
		"BRIEF":              1,
		"MODERATE":           2,
		"COMPREHENSIVE":      3,
	}
)

Enum value maps for SummaryOptions_Length.

SummaryOptions_Format_name, SummaryOptions_Format_value

var (
	SummaryOptions_Format_name = map[int32]string{
		0: "FORMAT_UNSPECIFIED",
		1: "PARAGRAPH",
		2: "BULLETS",
	}
	SummaryOptions_Format_value = map[string]int32{
		"FORMAT_UNSPECIFIED": 0,
		"PARAGRAPH":          1,
		"BULLETS":            2,
	}
)

Enum value maps for SummaryOptions_Format.

DocumentSchema_EntityType_Property_OccurrenceType_name, DocumentSchema_EntityType_Property_OccurrenceType_value

var (
	DocumentSchema_EntityType_Property_OccurrenceType_name = map[int32]string{
		0: "OCCURRENCE_TYPE_UNSPECIFIED",
		1: "OPTIONAL_ONCE",
		2: "OPTIONAL_MULTIPLE",
		3: "REQUIRED_ONCE",
		4: "REQUIRED_MULTIPLE",
	}
	DocumentSchema_EntityType_Property_OccurrenceType_value = map[string]int32{
		"OCCURRENCE_TYPE_UNSPECIFIED": 0,
		"OPTIONAL_ONCE":               1,
		"OPTIONAL_MULTIPLE":           2,
		"REQUIRED_ONCE":               3,
		"REQUIRED_MULTIPLE":           4,
	}
)

Enum value maps for DocumentSchema_EntityType_Property_OccurrenceType.

DatasetSplitType_name, DatasetSplitType_value

var (
	DatasetSplitType_name = map[int32]string{
		0: "DATASET_SPLIT_TYPE_UNSPECIFIED",
		1: "DATASET_SPLIT_TRAIN",
		2: "DATASET_SPLIT_TEST",
		3: "DATASET_SPLIT_UNASSIGNED",
	}
	DatasetSplitType_value = map[string]int32{
		"DATASET_SPLIT_TYPE_UNSPECIFIED": 0,
		"DATASET_SPLIT_TRAIN":            1,
		"DATASET_SPLIT_TEST":             2,
		"DATASET_SPLIT_UNASSIGNED":       3,
	}
)

Enum value maps for DatasetSplitType.

DocumentLabelingState_name, DocumentLabelingState_value

var (
	DocumentLabelingState_name = map[int32]string{
		0: "DOCUMENT_LABELING_STATE_UNSPECIFIED",
		1: "DOCUMENT_LABELED",
		2: "DOCUMENT_UNLABELED",
		3: "DOCUMENT_AUTO_LABELED",
	}
	DocumentLabelingState_value = map[string]int32{
		"DOCUMENT_LABELING_STATE_UNSPECIFIED": 0,
		"DOCUMENT_LABELED":                    1,
		"DOCUMENT_UNLABELED":                  2,
		"DOCUMENT_AUTO_LABELED":               3,
	}
)

Enum value maps for DocumentLabelingState.

Evaluation_MultiConfidenceMetrics_MetricsType_name, Evaluation_MultiConfidenceMetrics_MetricsType_value

var (
	Evaluation_MultiConfidenceMetrics_MetricsType_name = map[int32]string{
		0: "METRICS_TYPE_UNSPECIFIED",
		1: "AGGREGATE",
	}
	Evaluation_MultiConfidenceMetrics_MetricsType_value = map[string]int32{
		"METRICS_TYPE_UNSPECIFIED": 0,
		"AGGREGATE":                1,
	}
)

Enum value maps for Evaluation_MultiConfidenceMetrics_MetricsType.

CommonOperationMetadata_State_name, CommonOperationMetadata_State_value

var (
	CommonOperationMetadata_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "RUNNING",
		2: "CANCELLING",
		3: "SUCCEEDED",
		4: "FAILED",
		5: "CANCELLED",
	}
	CommonOperationMetadata_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"RUNNING":           1,
		"CANCELLING":        2,
		"SUCCEEDED":         3,
		"FAILED":            4,
		"CANCELLED":         5,
	}
)

Enum value maps for CommonOperationMetadata_State.

ProcessorVersion_State_name, ProcessorVersion_State_value

var (
	ProcessorVersion_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "DEPLOYED",
		2: "DEPLOYING",
		3: "UNDEPLOYED",
		4: "UNDEPLOYING",
		5: "CREATING",
		6: "DELETING",
		7: "FAILED",
		8: "IMPORTING",
	}
	ProcessorVersion_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"DEPLOYED":          1,
		"DEPLOYING":         2,
		"UNDEPLOYED":        3,
		"UNDEPLOYING":       4,
		"CREATING":          5,
		"DELETING":          6,
		"FAILED":            7,
		"IMPORTING":         8,
	}
)

Enum value maps for ProcessorVersion_State.

Processor_State_name, Processor_State_value

var (
	Processor_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "ENABLED",
		2: "DISABLED",
		3: "ENABLING",
		4: "DISABLING",
		5: "CREATING",
		6: "FAILED",
		7: "DELETING",
	}
	Processor_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"ENABLED":           1,
		"DISABLED":          2,
		"ENABLING":          3,
		"DISABLING":         4,
		"CREATING":          5,
		"FAILED":            6,
		"DELETING":          7,
	}
)

Enum value maps for Processor_State.

File_google_cloud_documentai_v1beta3_barcode_proto

var File_google_cloud_documentai_v1beta3_barcode_proto protoreflect.FileDescriptor

File_google_cloud_documentai_v1beta3_dataset_proto

var File_google_cloud_documentai_v1beta3_dataset_proto protoreflect.FileDescriptor

File_google_cloud_documentai_v1beta3_document_io_proto

var File_google_cloud_documentai_v1beta3_document_io_proto protoreflect.FileDescriptor

File_google_cloud_documentai_v1beta3_document_processor_service_proto

var File_google_cloud_documentai_v1beta3_document_processor_service_proto protoreflect.FileDescriptor

File_google_cloud_documentai_v1beta3_document_proto

var File_google_cloud_documentai_v1beta3_document_proto protoreflect.FileDescriptor

File_google_cloud_documentai_v1beta3_document_schema_proto

var File_google_cloud_documentai_v1beta3_document_schema_proto protoreflect.FileDescriptor

File_google_cloud_documentai_v1beta3_document_service_proto

var File_google_cloud_documentai_v1beta3_document_service_proto protoreflect.FileDescriptor

File_google_cloud_documentai_v1beta3_evaluation_proto

var File_google_cloud_documentai_v1beta3_evaluation_proto protoreflect.FileDescriptor

File_google_cloud_documentai_v1beta3_geometry_proto

var File_google_cloud_documentai_v1beta3_geometry_proto protoreflect.FileDescriptor

File_google_cloud_documentai_v1beta3_operation_metadata_proto

var File_google_cloud_documentai_v1beta3_operation_metadata_proto protoreflect.FileDescriptor

File_google_cloud_documentai_v1beta3_processor_proto

var File_google_cloud_documentai_v1beta3_processor_proto protoreflect.FileDescriptor

File_google_cloud_documentai_v1beta3_processor_type_proto

var File_google_cloud_documentai_v1beta3_processor_type_proto protoreflect.FileDescriptor

Functions

func RegisterDocumentProcessorServiceServer

func RegisterDocumentProcessorServiceServer(s *grpc.Server, srv DocumentProcessorServiceServer)

func RegisterDocumentServiceServer

func RegisterDocumentServiceServer(s *grpc.Server, srv DocumentServiceServer)

Barcode

type Barcode struct {

	// Format of a barcode.
	// The supported formats are:
	//
	// - `CODE_128`: Code 128 type.
	// - `CODE_39`: Code 39 type.
	// - `CODE_93`: Code 93 type.
	// - `CODABAR`: Codabar type.
	// - `DATA_MATRIX`: 2D Data Matrix type.
	// - `ITF`: ITF type.
	// - `EAN_13`: EAN-13 type.
	// - `EAN_8`: EAN-8 type.
	// - `QR_CODE`: 2D QR code type.
	// - `UPC_A`: UPC-A type.
	// - `UPC_E`: UPC-E type.
	// - `PDF417`: PDF417 type.
	// - `AZTEC`: 2D Aztec code type.
	// - `DATABAR`: GS1 DataBar code type.
	Format string `protobuf:"bytes,1,opt,name=format,proto3" json:"format,omitempty"`
	// Value format describes the format of the value that a barcode
	// encodes.
	// The supported formats are:
	//
	// - `CONTACT_INFO`: Contact information.
	// - `EMAIL`: Email address.
	// - `ISBN`: ISBN identifier.
	// - `PHONE`: Phone number.
	// - `PRODUCT`: Product.
	// - `SMS`: SMS message.
	// - `TEXT`: Text string.
	// - `URL`: URL address.
	// - `WIFI`: Wifi information.
	// - `GEO`: Geo-localization.
	// - `CALENDAR_EVENT`: Calendar event.
	// - `DRIVER_LICENSE`: Driver's license.
	ValueFormat string `protobuf:"bytes,2,opt,name=value_format,json=valueFormat,proto3" json:"value_format,omitempty"`
	// Raw value encoded in the barcode.
	// For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.
	RawValue string `protobuf:"bytes,3,opt,name=raw_value,json=rawValue,proto3" json:"raw_value,omitempty"`
	// contains filtered or unexported fields
}

Encodes the detailed information of a barcode.

func (*Barcode) Descriptor

func (*Barcode) Descriptor() ([]byte, []int)

Deprecated: Use Barcode.ProtoReflect.Descriptor instead.

func (*Barcode) GetFormat

func (x *Barcode) GetFormat() string

func (*Barcode) GetRawValue

func (x *Barcode) GetRawValue() string

func (*Barcode) GetValueFormat

func (x *Barcode) GetValueFormat() string

func (*Barcode) ProtoMessage

func (*Barcode) ProtoMessage()

func (*Barcode) ProtoReflect

func (x *Barcode) ProtoReflect() protoreflect.Message

func (*Barcode) Reset

func (x *Barcode) Reset()

func (*Barcode) String

func (x *Barcode) String() string

BatchDatasetDocuments

type BatchDatasetDocuments struct {

	// Types that are assignable to Criteria:
	//
	//	*BatchDatasetDocuments_IndividualDocumentIds_
	//	*BatchDatasetDocuments_Filter
	Criteria isBatchDatasetDocuments_Criteria `protobuf_oneof:"criteria"`
	// contains filtered or unexported fields
}

Dataset documents that the batch operation will be applied to.

func (*BatchDatasetDocuments) Descriptor

func (*BatchDatasetDocuments) Descriptor() ([]byte, []int)

Deprecated: Use BatchDatasetDocuments.ProtoReflect.Descriptor instead.

func (*BatchDatasetDocuments) GetCriteria

func (m *BatchDatasetDocuments) GetCriteria() isBatchDatasetDocuments_Criteria

func (*BatchDatasetDocuments) GetFilter

func (x *BatchDatasetDocuments) GetFilter() string

func (*BatchDatasetDocuments) GetIndividualDocumentIds

func (*BatchDatasetDocuments) ProtoMessage

func (*BatchDatasetDocuments) ProtoMessage()

func (*BatchDatasetDocuments) ProtoReflect

func (x *BatchDatasetDocuments) ProtoReflect() protoreflect.Message

func (*BatchDatasetDocuments) Reset

func (x *BatchDatasetDocuments) Reset()

func (*BatchDatasetDocuments) String

func (x *BatchDatasetDocuments) String() string

BatchDatasetDocuments_Filter

type BatchDatasetDocuments_Filter struct {
	// A filter matching the documents.
	// Follows the same format and restriction as
	// [google.cloud.documentai.master.ListDocumentsRequest.filter].
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3,oneof"`
}

BatchDatasetDocuments_IndividualDocumentIds

type BatchDatasetDocuments_IndividualDocumentIds struct {

	// Required. List of Document IDs indicating where the actual documents are
	// stored.
	DocumentIds []*DocumentId `protobuf:"bytes,1,rep,name=document_ids,json=documentIds,proto3" json:"document_ids,omitempty"`
	// contains filtered or unexported fields
}

List of individual DocumentIds.

func (*BatchDatasetDocuments_IndividualDocumentIds) Descriptor

Deprecated: Use BatchDatasetDocuments_IndividualDocumentIds.ProtoReflect.Descriptor instead.

func (*BatchDatasetDocuments_IndividualDocumentIds) GetDocumentIds

func (*BatchDatasetDocuments_IndividualDocumentIds) ProtoMessage

func (*BatchDatasetDocuments_IndividualDocumentIds) ProtoReflect

func (*BatchDatasetDocuments_IndividualDocumentIds) Reset

func (*BatchDatasetDocuments_IndividualDocumentIds) String

BatchDatasetDocuments_IndividualDocumentIds_

type BatchDatasetDocuments_IndividualDocumentIds_ struct {
	// Document identifiers.
	IndividualDocumentIds *BatchDatasetDocuments_IndividualDocumentIds `protobuf:"bytes,1,opt,name=individual_document_ids,json=individualDocumentIds,proto3,oneof"`
}

BatchDeleteDocumentsMetadata

type BatchDeleteDocumentsMetadata struct {
	CommonMetadata *CommonOperationMetadata `protobuf:"bytes,1,opt,name=common_metadata,json=commonMetadata,proto3" json:"common_metadata,omitempty"`

	IndividualBatchDeleteStatuses []*BatchDeleteDocumentsMetadata_IndividualBatchDeleteStatus "" /* 152 byte string literal not displayed */

	TotalDocumentCount int32 `protobuf:"varint,3,opt,name=total_document_count,json=totalDocumentCount,proto3" json:"total_document_count,omitempty"`

	ErrorDocumentCount int32 `protobuf:"varint,4,opt,name=error_document_count,json=errorDocumentCount,proto3" json:"error_document_count,omitempty"`

}

func (*BatchDeleteDocumentsMetadata) Descriptor

func (*BatchDeleteDocumentsMetadata) Descriptor() ([]byte, []int)

Deprecated: Use BatchDeleteDocumentsMetadata.ProtoReflect.Descriptor instead.

func (*BatchDeleteDocumentsMetadata) GetCommonMetadata

func (x *BatchDeleteDocumentsMetadata) GetCommonMetadata() *CommonOperationMetadata

func (*BatchDeleteDocumentsMetadata) GetErrorDocumentCount

func (x *BatchDeleteDocumentsMetadata) GetErrorDocumentCount() int32

func (*BatchDeleteDocumentsMetadata) GetIndividualBatchDeleteStatuses

func (*BatchDeleteDocumentsMetadata) GetTotalDocumentCount

func (x *BatchDeleteDocumentsMetadata) GetTotalDocumentCount() int32

func (*BatchDeleteDocumentsMetadata) ProtoMessage

func (*BatchDeleteDocumentsMetadata) ProtoMessage()

func (*BatchDeleteDocumentsMetadata) ProtoReflect

func (*BatchDeleteDocumentsMetadata) Reset

func (x *BatchDeleteDocumentsMetadata) Reset()

func (*BatchDeleteDocumentsMetadata) String

BatchDeleteDocumentsMetadata_IndividualBatchDeleteStatus

type BatchDeleteDocumentsMetadata_IndividualBatchDeleteStatus struct {

	// The document id of the document.
	DocumentId *DocumentId `protobuf:"bytes,1,opt,name=document_id,json=documentId,proto3" json:"document_id,omitempty"`
	// The status of deleting the document in storage.
	Status *status.Status `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

The status of each individual document in the batch delete process.

func (*BatchDeleteDocumentsMetadata_IndividualBatchDeleteStatus) Descriptor

Deprecated: Use BatchDeleteDocumentsMetadata_IndividualBatchDeleteStatus.ProtoReflect.Descriptor instead.

func (*BatchDeleteDocumentsMetadata_IndividualBatchDeleteStatus) GetDocumentId

func (*BatchDeleteDocumentsMetadata_IndividualBatchDeleteStatus) GetStatus

func (*BatchDeleteDocumentsMetadata_IndividualBatchDeleteStatus) ProtoMessage

func (*BatchDeleteDocumentsMetadata_IndividualBatchDeleteStatus) ProtoReflect

func (*BatchDeleteDocumentsMetadata_IndividualBatchDeleteStatus) Reset

func (*BatchDeleteDocumentsMetadata_IndividualBatchDeleteStatus) String

BatchDeleteDocumentsRequest

type BatchDeleteDocumentsRequest struct {

	// Required. The dataset resource name.
	// Format:
	// projects/{project}/locations/{location}/processors/{processor}/dataset
	Dataset string `protobuf:"bytes,1,opt,name=dataset,proto3" json:"dataset,omitempty"`
	// Required. Dataset documents input. If given `filter`, all documents
	// satisfying the filter will be deleted. If given documentIds, a maximum of
	// 50 documents can be deleted in a batch. The request will be rejected if
	// more than 50 document_ids are provided.
	DatasetDocuments *BatchDatasetDocuments `protobuf:"bytes,3,opt,name=dataset_documents,json=datasetDocuments,proto3" json:"dataset_documents,omitempty"`
	// contains filtered or unexported fields
}

func (*BatchDeleteDocumentsRequest) Descriptor

func (*BatchDeleteDocumentsRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchDeleteDocumentsRequest.ProtoReflect.Descriptor instead.

func (*BatchDeleteDocumentsRequest) GetDataset

func (x *BatchDeleteDocumentsRequest) GetDataset() string

func (*BatchDeleteDocumentsRequest) GetDatasetDocuments

func (x *BatchDeleteDocumentsRequest) GetDatasetDocuments() *BatchDatasetDocuments

func (*BatchDeleteDocumentsRequest) ProtoMessage

func (*BatchDeleteDocumentsRequest) ProtoMessage()

func (*BatchDeleteDocumentsRequest) ProtoReflect

func (*BatchDeleteDocumentsRequest) Reset

func (x *BatchDeleteDocumentsRequest) Reset()

func (*BatchDeleteDocumentsRequest) String

func (x *BatchDeleteDocumentsRequest) String() string

BatchDeleteDocumentsResponse

type BatchDeleteDocumentsResponse struct {
	// contains filtered or unexported fields
}

Response of the delete documents operation.

func (*BatchDeleteDocumentsResponse) Descriptor

func (*BatchDeleteDocumentsResponse) Descriptor() ([]byte, []int)

Deprecated: Use BatchDeleteDocumentsResponse.ProtoReflect.Descriptor instead.

func (*BatchDeleteDocumentsResponse) ProtoMessage

func (*BatchDeleteDocumentsResponse) ProtoMessage()

func (*BatchDeleteDocumentsResponse) ProtoReflect

func (*BatchDeleteDocumentsResponse) Reset

func (x *BatchDeleteDocumentsResponse) Reset()

func (*BatchDeleteDocumentsResponse) String

BatchDocumentsInputConfig

type BatchDocumentsInputConfig struct {

	// The source.
	//
	// Types that are assignable to Source:
	//
	//	*BatchDocumentsInputConfig_GcsPrefix
	//	*BatchDocumentsInputConfig_GcsDocuments
	Source isBatchDocumentsInputConfig_Source `protobuf_oneof:"source"`
	// contains filtered or unexported fields
}

The common config to specify a set of documents used as input.

func (*BatchDocumentsInputConfig) Descriptor

func (*BatchDocumentsInputConfig) Descriptor() ([]byte, []int)

Deprecated: Use BatchDocumentsInputConfig.ProtoReflect.Descriptor instead.

func (*BatchDocumentsInputConfig) GetGcsDocuments

func (x *BatchDocumentsInputConfig) GetGcsDocuments() *GcsDocuments

func (*BatchDocumentsInputConfig) GetGcsPrefix

func (x *BatchDocumentsInputConfig) GetGcsPrefix() *GcsPrefix

func (*BatchDocumentsInputConfig) GetSource

func (m *BatchDocumentsInputConfig) GetSource() isBatchDocumentsInputConfig_Source

func (*BatchDocumentsInputConfig) ProtoMessage

func (*BatchDocumentsInputConfig) ProtoMessage()

func (*BatchDocumentsInputConfig) ProtoReflect

func (*BatchDocumentsInputConfig) Reset

func (x *BatchDocumentsInputConfig) Reset()

func (*BatchDocumentsInputConfig) String

func (x *BatchDocumentsInputConfig) String() string

BatchDocumentsInputConfig_GcsDocuments

type BatchDocumentsInputConfig_GcsDocuments struct {
	// The set of documents individually specified on Cloud Storage.
	GcsDocuments *GcsDocuments `protobuf:"bytes,2,opt,name=gcs_documents,json=gcsDocuments,proto3,oneof"`
}

BatchDocumentsInputConfig_GcsPrefix

type BatchDocumentsInputConfig_GcsPrefix struct {
	// The set of documents that match the specified Cloud Storage `gcs_prefix`.
	GcsPrefix *GcsPrefix `protobuf:"bytes,1,opt,name=gcs_prefix,json=gcsPrefix,proto3,oneof"`
}

BatchProcessMetadata

type BatchProcessMetadata struct {
	State BatchProcessMetadata_State "" /* 128 byte string literal not displayed */

	StateMessage string `protobuf:"bytes,2,opt,name=state_message,json=stateMessage,proto3" json:"state_message,omitempty"`

	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`

	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`

	IndividualProcessStatuses []*BatchProcessMetadata_IndividualProcessStatus "" /* 138 byte string literal not displayed */

}

The long-running operation metadata for [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments].

func (*BatchProcessMetadata) Descriptor

func (*BatchProcessMetadata) Descriptor() ([]byte, []int)

Deprecated: Use BatchProcessMetadata.ProtoReflect.Descriptor instead.

func (*BatchProcessMetadata) GetCreateTime

func (x *BatchProcessMetadata) GetCreateTime() *timestamppb.Timestamp

func (*BatchProcessMetadata) GetIndividualProcessStatuses

func (x *BatchProcessMetadata) GetIndividualProcessStatuses() []*BatchProcessMetadata_IndividualProcessStatus

func (*BatchProcessMetadata) GetState

func (*BatchProcessMetadata) GetStateMessage

func (x *BatchProcessMetadata) GetStateMessage() string

func (*BatchProcessMetadata) GetUpdateTime

func (x *BatchProcessMetadata) GetUpdateTime() *timestamppb.Timestamp

func (*BatchProcessMetadata) ProtoMessage

func (*BatchProcessMetadata) ProtoMessage()

func (*BatchProcessMetadata) ProtoReflect

func (x *BatchProcessMetadata) ProtoReflect() protoreflect.Message

func (*BatchProcessMetadata) Reset

func (x *BatchProcessMetadata) Reset()

func (*BatchProcessMetadata) String

func (x *BatchProcessMetadata) String() string

BatchProcessMetadata_IndividualProcessStatus

type BatchProcessMetadata_IndividualProcessStatus struct {

	// The source of the document, same as the
	// [input_gcs_source][google.cloud.documentai.v1beta3.BatchProcessMetadata.IndividualProcessStatus.input_gcs_source]
	// field in the request when the batch process started.
	InputGcsSource string `protobuf:"bytes,1,opt,name=input_gcs_source,json=inputGcsSource,proto3" json:"input_gcs_source,omitempty"`
	// The status processing the document.
	Status *status.Status `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// The Cloud Storage output destination (in the request as
	// [DocumentOutputConfig.GcsOutputConfig.gcs_uri][google.cloud.documentai.v1beta3.DocumentOutputConfig.GcsOutputConfig.gcs_uri])
	// of the processed document if it was successful, otherwise empty.
	OutputGcsDestination string `protobuf:"bytes,3,opt,name=output_gcs_destination,json=outputGcsDestination,proto3" json:"output_gcs_destination,omitempty"`
	// The name of the operation triggered by the processed document. If the
	// human review process isn't triggered, this field will be empty. It has
	// the same response type and metadata as the long-running operation
	// returned by the
	// [ReviewDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ReviewDocument]
	// method.
	//
	// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document_processor_service.proto.
	HumanReviewOperation string `protobuf:"bytes,4,opt,name=human_review_operation,json=humanReviewOperation,proto3" json:"human_review_operation,omitempty"`
	// The status of human review on the processed document.
	HumanReviewStatus *HumanReviewStatus `protobuf:"bytes,5,opt,name=human_review_status,json=humanReviewStatus,proto3" json:"human_review_status,omitempty"`
	// contains filtered or unexported fields
}

The status of a each individual document in the batch process.

func (*BatchProcessMetadata_IndividualProcessStatus) Descriptor

Deprecated: Use BatchProcessMetadata_IndividualProcessStatus.ProtoReflect.Descriptor instead.

func (*BatchProcessMetadata_IndividualProcessStatus) GetHumanReviewOperation

func (x *BatchProcessMetadata_IndividualProcessStatus) GetHumanReviewOperation() string

Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document_processor_service.proto.

func (*BatchProcessMetadata_IndividualProcessStatus) GetHumanReviewStatus

func (*BatchProcessMetadata_IndividualProcessStatus) GetInputGcsSource

func (*BatchProcessMetadata_IndividualProcessStatus) GetOutputGcsDestination

func (x *BatchProcessMetadata_IndividualProcessStatus) GetOutputGcsDestination() string

func (*BatchProcessMetadata_IndividualProcessStatus) GetStatus

func (*BatchProcessMetadata_IndividualProcessStatus) ProtoMessage

func (*BatchProcessMetadata_IndividualProcessStatus) ProtoReflect

func (*BatchProcessMetadata_IndividualProcessStatus) Reset

func (*BatchProcessMetadata_IndividualProcessStatus) String

BatchProcessMetadata_State

type BatchProcessMetadata_State int32

Possible states of the batch processing operation.

BatchProcessMetadata_STATE_UNSPECIFIED, BatchProcessMetadata_WAITING, BatchProcessMetadata_RUNNING, BatchProcessMetadata_SUCCEEDED, BatchProcessMetadata_CANCELLING, BatchProcessMetadata_CANCELLED, BatchProcessMetadata_FAILED

const (
	// The default value. This value is used if the state is omitted.
	BatchProcessMetadata_STATE_UNSPECIFIED BatchProcessMetadata_State = 0
	// Request operation is waiting for scheduling.
	BatchProcessMetadata_WAITING BatchProcessMetadata_State = 1
	// Request is being processed.
	BatchProcessMetadata_RUNNING BatchProcessMetadata_State = 2
	// The batch processing completed successfully.
	BatchProcessMetadata_SUCCEEDED BatchProcessMetadata_State = 3
	// The batch processing was being cancelled.
	BatchProcessMetadata_CANCELLING BatchProcessMetadata_State = 4
	// The batch processing was cancelled.
	BatchProcessMetadata_CANCELLED BatchProcessMetadata_State = 5
	// The batch processing has failed.
	BatchProcessMetadata_FAILED BatchProcessMetadata_State = 6
)

func (BatchProcessMetadata_State) Descriptor

func (BatchProcessMetadata_State) Enum

func (BatchProcessMetadata_State) EnumDescriptor

func (BatchProcessMetadata_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use BatchProcessMetadata_State.Descriptor instead.

func (BatchProcessMetadata_State) Number

func (BatchProcessMetadata_State) String

func (BatchProcessMetadata_State) Type

BatchProcessRequest

type BatchProcessRequest struct {

	// Required. The resource name of
	// [Processor][google.cloud.documentai.v1beta3.Processor] or
	// [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion].
	// Format: `projects/{project}/locations/{location}/processors/{processor}`,
	// or
	// `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The input config for each single document in the batch process.
	//
	// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document_processor_service.proto.
	InputConfigs []*BatchProcessRequest_BatchInputConfig `protobuf:"bytes,2,rep,name=input_configs,json=inputConfigs,proto3" json:"input_configs,omitempty"`
	// The overall output config for batch process.
	//
	// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document_processor_service.proto.
	OutputConfig *BatchProcessRequest_BatchOutputConfig `protobuf:"bytes,3,opt,name=output_config,json=outputConfig,proto3" json:"output_config,omitempty"`
	// The input documents for the
	// [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments]
	// method.
	InputDocuments *BatchDocumentsInputConfig `protobuf:"bytes,5,opt,name=input_documents,json=inputDocuments,proto3" json:"input_documents,omitempty"`
	// The output configuration for the
	// [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments]
	// method.
	DocumentOutputConfig *DocumentOutputConfig `protobuf:"bytes,6,opt,name=document_output_config,json=documentOutputConfig,proto3" json:"document_output_config,omitempty"`
	// Whether human review should be skipped for this request. Default to
	// `false`.
	SkipHumanReview bool `protobuf:"varint,4,opt,name=skip_human_review,json=skipHumanReview,proto3" json:"skip_human_review,omitempty"`
	// Inference-time options for the process API
	ProcessOptions *ProcessOptions `protobuf:"bytes,7,opt,name=process_options,json=processOptions,proto3" json:"process_options,omitempty"`
	// contains filtered or unexported fields
}

Request message for [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments].

func (*BatchProcessRequest) Descriptor

func (*BatchProcessRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchProcessRequest.ProtoReflect.Descriptor instead.

func (*BatchProcessRequest) GetDocumentOutputConfig

func (x *BatchProcessRequest) GetDocumentOutputConfig() *DocumentOutputConfig

func (*BatchProcessRequest) GetInputConfigs

Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document_processor_service.proto.

func (*BatchProcessRequest) GetInputDocuments

func (x *BatchProcessRequest) GetInputDocuments() *BatchDocumentsInputConfig

func (*BatchProcessRequest) GetName

func (x *BatchProcessRequest) GetName() string

func (*BatchProcessRequest) GetOutputConfig

Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document_processor_service.proto.

func (*BatchProcessRequest) GetProcessOptions

func (x *BatchProcessRequest) GetProcessOptions() *ProcessOptions

func (*BatchProcessRequest) GetSkipHumanReview

func (x *BatchProcessRequest) GetSkipHumanReview() bool

func (*BatchProcessRequest) ProtoMessage

func (*BatchProcessRequest) ProtoMessage()

func (*BatchProcessRequest) ProtoReflect

func (x *BatchProcessRequest) ProtoReflect() protoreflect.Message

func (*BatchProcessRequest) Reset

func (x *BatchProcessRequest) Reset()

func (*BatchProcessRequest) String

func (x *BatchProcessRequest) String() string

BatchProcessRequest_BatchInputConfig (deprecated)

type BatchProcessRequest_BatchInputConfig struct {

	// The Cloud Storage location as the source of the document.
	GcsSource string `protobuf:"bytes,1,opt,name=gcs_source,json=gcsSource,proto3" json:"gcs_source,omitempty"`
	// An IANA published [media type (MIME
	// type)](https://www.iana.org/assignments/media-types/media-types.xhtml) of
	// the input. If the input is a raw document, refer to [supported file
	// types](https://cloud.google.com/document-ai/docs/file-types) for the list
	// of media types. If the input is a
	// [Document][google.cloud.documentai.v1beta3.Document], the type should be
	// `application/json`.
	MimeType string `protobuf:"bytes,2,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// contains filtered or unexported fields
}

The message for input config in batch process.

Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document_processor_service.proto.

func (*BatchProcessRequest_BatchInputConfig) Descriptor (deprecated)

func (*BatchProcessRequest_BatchInputConfig) Descriptor() ([]byte, []int)

Deprecated: Use BatchProcessRequest_BatchInputConfig.ProtoReflect.Descriptor instead.

func (*BatchProcessRequest_BatchInputConfig) GetGcsSource (deprecated)

func (x *BatchProcessRequest_BatchInputConfig) GetGcsSource() string

func (*BatchProcessRequest_BatchInputConfig) GetMimeType (deprecated)

func (*BatchProcessRequest_BatchInputConfig) ProtoMessage (deprecated)

func (*BatchProcessRequest_BatchInputConfig) ProtoMessage()

func (*BatchProcessRequest_BatchInputConfig) ProtoReflect (deprecated)

func (*BatchProcessRequest_BatchInputConfig) Reset (deprecated)

func (*BatchProcessRequest_BatchInputConfig) String (deprecated)

BatchProcessRequest_BatchOutputConfig (deprecated)

type BatchProcessRequest_BatchOutputConfig struct {

	// The output Cloud Storage directory to put the processed documents.
	GcsDestination string `protobuf:"bytes,1,opt,name=gcs_destination,json=gcsDestination,proto3" json:"gcs_destination,omitempty"`
	// contains filtered or unexported fields
}

The output configuration in the [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments] method.

Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document_processor_service.proto.

func (*BatchProcessRequest_BatchOutputConfig) Descriptor (deprecated)

func (*BatchProcessRequest_BatchOutputConfig) Descriptor() ([]byte, []int)

Deprecated: Use BatchProcessRequest_BatchOutputConfig.ProtoReflect.Descriptor instead.

func (*BatchProcessRequest_BatchOutputConfig) GetGcsDestination (deprecated)

func (x *BatchProcessRequest_BatchOutputConfig) GetGcsDestination() string

func (*BatchProcessRequest_BatchOutputConfig) ProtoMessage (deprecated)

func (*BatchProcessRequest_BatchOutputConfig) ProtoMessage()

func (*BatchProcessRequest_BatchOutputConfig) ProtoReflect (deprecated)

func (*BatchProcessRequest_BatchOutputConfig) Reset (deprecated)

func (*BatchProcessRequest_BatchOutputConfig) String (deprecated)

BatchProcessResponse

type BatchProcessResponse struct {
	// contains filtered or unexported fields
}

Response message for [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments].

func (*BatchProcessResponse) Descriptor

func (*BatchProcessResponse) Descriptor() ([]byte, []int)

Deprecated: Use BatchProcessResponse.ProtoReflect.Descriptor instead.

func (*BatchProcessResponse) ProtoMessage

func (*BatchProcessResponse) ProtoMessage()

func (*BatchProcessResponse) ProtoReflect

func (x *BatchProcessResponse) ProtoReflect() protoreflect.Message

func (*BatchProcessResponse) Reset

func (x *BatchProcessResponse) Reset()

func (*BatchProcessResponse) String

func (x *BatchProcessResponse) String() string

BoundingPoly

type BoundingPoly struct {

	// The bounding polygon vertices.
	Vertices []*Vertex `protobuf:"bytes,1,rep,name=vertices,proto3" json:"vertices,omitempty"`
	// The bounding polygon normalized vertices.
	NormalizedVertices []*NormalizedVertex `protobuf:"bytes,2,rep,name=normalized_vertices,json=normalizedVertices,proto3" json:"normalized_vertices,omitempty"`
	// contains filtered or unexported fields
}

A bounding polygon for the detected image annotation.

func (*BoundingPoly) Descriptor

func (*BoundingPoly) Descriptor() ([]byte, []int)

Deprecated: Use BoundingPoly.ProtoReflect.Descriptor instead.

func (*BoundingPoly) GetNormalizedVertices

func (x *BoundingPoly) GetNormalizedVertices() []*NormalizedVertex

func (*BoundingPoly) GetVertices

func (x *BoundingPoly) GetVertices() []*Vertex

func (*BoundingPoly) ProtoMessage

func (*BoundingPoly) ProtoMessage()

func (*BoundingPoly) ProtoReflect

func (x *BoundingPoly) ProtoReflect() protoreflect.Message

func (*BoundingPoly) Reset

func (x *BoundingPoly) Reset()

func (*BoundingPoly) String

func (x *BoundingPoly) String() string

CommonOperationMetadata

type CommonOperationMetadata struct {
	State CommonOperationMetadata_State "" /* 131 byte string literal not displayed */

	StateMessage string `protobuf:"bytes,2,opt,name=state_message,json=stateMessage,proto3" json:"state_message,omitempty"`

	Resource string `protobuf:"bytes,5,opt,name=resource,proto3" json:"resource,omitempty"`

	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`

	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`

}

The common metadata for long running operations.

func (*CommonOperationMetadata) Descriptor

func (*CommonOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CommonOperationMetadata.ProtoReflect.Descriptor instead.

func (*CommonOperationMetadata) GetCreateTime

func (x *CommonOperationMetadata) GetCreateTime() *timestamppb.Timestamp

func (*CommonOperationMetadata) GetResource

func (x *CommonOperationMetadata) GetResource() string

func (*CommonOperationMetadata) GetState

func (*CommonOperationMetadata) GetStateMessage

func (x *CommonOperationMetadata) GetStateMessage() string

func (*CommonOperationMetadata) GetUpdateTime

func (x *CommonOperationMetadata) GetUpdateTime() *timestamppb.Timestamp

func (*CommonOperationMetadata) ProtoMessage

func (*CommonOperationMetadata) ProtoMessage()

func (*CommonOperationMetadata) ProtoReflect

func (x *CommonOperationMetadata) ProtoReflect() protoreflect.Message

func (*CommonOperationMetadata) Reset

func (x *CommonOperationMetadata) Reset()

func (*CommonOperationMetadata) String

func (x *CommonOperationMetadata) String() string

CommonOperationMetadata_State

type CommonOperationMetadata_State int32

State of the longrunning operation.

CommonOperationMetadata_STATE_UNSPECIFIED, CommonOperationMetadata_RUNNING, CommonOperationMetadata_CANCELLING, CommonOperationMetadata_SUCCEEDED, CommonOperationMetadata_FAILED, CommonOperationMetadata_CANCELLED

const (
	// Unspecified state.
	CommonOperationMetadata_STATE_UNSPECIFIED CommonOperationMetadata_State = 0
	// Operation is still running.
	CommonOperationMetadata_RUNNING CommonOperationMetadata_State = 1
	// Operation is being cancelled.
	CommonOperationMetadata_CANCELLING CommonOperationMetadata_State = 2
	// Operation succeeded.
	CommonOperationMetadata_SUCCEEDED CommonOperationMetadata_State = 3
	// Operation failed.
	CommonOperationMetadata_FAILED CommonOperationMetadata_State = 4
	// Operation is cancelled.
	CommonOperationMetadata_CANCELLED CommonOperationMetadata_State = 5
)

func (CommonOperationMetadata_State) Descriptor

func (CommonOperationMetadata_State) Enum

func (CommonOperationMetadata_State) EnumDescriptor

func (CommonOperationMetadata_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use CommonOperationMetadata_State.Descriptor instead.

func (CommonOperationMetadata_State) Number

func (CommonOperationMetadata_State) String

func (CommonOperationMetadata_State) Type

CreateProcessorRequest

type CreateProcessorRequest struct {

	// Required. The parent (project and location) under which to create the
	// processor. Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The processor to be created, requires
	// [Processor.type][google.cloud.documentai.v1beta3.Processor.type] and
	// [Processor.display_name]][] to be set. Also, the
	// [Processor.kms_key_name][google.cloud.documentai.v1beta3.Processor.kms_key_name]
	// field must be set if the processor is under CMEK.
	Processor *Processor `protobuf:"bytes,2,opt,name=processor,proto3" json:"processor,omitempty"`
	// contains filtered or unexported fields
}

Request message for the [CreateProcessor][google.cloud.documentai.v1beta3.DocumentProcessorService.CreateProcessor] method. Notice this request is sent to a regionalized backend service. If the [ProcessorType][google.cloud.documentai.v1beta3.ProcessorType] isn't available in that region, the creation fails.

func (*CreateProcessorRequest) Descriptor

func (*CreateProcessorRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateProcessorRequest.ProtoReflect.Descriptor instead.

func (*CreateProcessorRequest) GetParent

func (x *CreateProcessorRequest) GetParent() string

func (*CreateProcessorRequest) GetProcessor

func (x *CreateProcessorRequest) GetProcessor() *Processor

func (*CreateProcessorRequest) ProtoMessage

func (*CreateProcessorRequest) ProtoMessage()

func (*CreateProcessorRequest) ProtoReflect

func (x *CreateProcessorRequest) ProtoReflect() protoreflect.Message

func (*CreateProcessorRequest) Reset

func (x *CreateProcessorRequest) Reset()

func (*CreateProcessorRequest) String

func (x *CreateProcessorRequest) String() string

Dataset

type Dataset struct {

	// Types that are assignable to StorageSource:
	//
	//	*Dataset_GcsManagedConfig
	//	*Dataset_DocumentWarehouseConfig_
	//	*Dataset_UnmanagedDatasetConfig_
	StorageSource isDataset_StorageSource `protobuf_oneof:"storage_source"`
	// Types that are assignable to IndexingSource:
	//
	//	*Dataset_SpannerIndexingConfig_
	IndexingSource isDataset_IndexingSource `protobuf_oneof:"indexing_source"`
	// Dataset resource name.
	// Format:
	// `projects/{project}/locations/{location}/processors/{processor}/dataset`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. State of the dataset. Ignored when updating dataset.
	State Dataset_State `protobuf:"varint,2,opt,name=state,proto3,enum=google.cloud.documentai.v1beta3.Dataset_State" json:"state,omitempty"`
	// contains filtered or unexported fields
}

A singleton resource under a [Processor][google.cloud.documentai.v1beta3.Processor] which configures a collection of documents.

func (*Dataset) Descriptor

func (*Dataset) Descriptor() ([]byte, []int)

Deprecated: Use Dataset.ProtoReflect.Descriptor instead.

func (*Dataset) GetDocumentWarehouseConfig

func (x *Dataset) GetDocumentWarehouseConfig() *Dataset_DocumentWarehouseConfig

func (*Dataset) GetGcsManagedConfig

func (x *Dataset) GetGcsManagedConfig() *Dataset_GCSManagedConfig

func (*Dataset) GetIndexingSource

func (m *Dataset) GetIndexingSource() isDataset_IndexingSource

func (*Dataset) GetName

func (x *Dataset) GetName() string

func (*Dataset) GetSpannerIndexingConfig

func (x *Dataset) GetSpannerIndexingConfig() *Dataset_SpannerIndexingConfig

func (*Dataset) GetState

func (x *Dataset) GetState() Dataset_State

func (*Dataset) GetStorageSource

func (m *Dataset) GetStorageSource() isDataset_StorageSource

func (*Dataset) GetUnmanagedDatasetConfig

func (x *Dataset) GetUnmanagedDatasetConfig() *Dataset_UnmanagedDatasetConfig

func (*Dataset) ProtoMessage

func (*Dataset) ProtoMessage()

func (*Dataset) ProtoReflect

func (x *Dataset) ProtoReflect() protoreflect.Message

func (*Dataset) Reset

func (x *Dataset) Reset()

func (*Dataset) String

func (x *Dataset) String() string

DatasetSchema

type DatasetSchema struct {

	// Dataset schema resource name.
	// Format:
	// `projects/{project}/locations/{location}/processors/{processor}/dataset/datasetSchema`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. Schema of the dataset.
	DocumentSchema *DocumentSchema `protobuf:"bytes,3,opt,name=document_schema,json=documentSchema,proto3" json:"document_schema,omitempty"`
	// contains filtered or unexported fields
}

Dataset Schema.

func (*DatasetSchema) Descriptor

func (*DatasetSchema) Descriptor() ([]byte, []int)

Deprecated: Use DatasetSchema.ProtoReflect.Descriptor instead.

func (*DatasetSchema) GetDocumentSchema

func (x *DatasetSchema) GetDocumentSchema() *DocumentSchema

func (*DatasetSchema) GetName

func (x *DatasetSchema) GetName() string

func (*DatasetSchema) ProtoMessage

func (*DatasetSchema) ProtoMessage()

func (*DatasetSchema) ProtoReflect

func (x *DatasetSchema) ProtoReflect() protoreflect.Message

func (*DatasetSchema) Reset

func (x *DatasetSchema) Reset()

func (*DatasetSchema) String

func (x *DatasetSchema) String() string

DatasetSplitType

type DatasetSplitType int32

Documents belonging to a dataset will be split into different groups referred to as splits: train, test.

DatasetSplitType_DATASET_SPLIT_TYPE_UNSPECIFIED, DatasetSplitType_DATASET_SPLIT_TRAIN, DatasetSplitType_DATASET_SPLIT_TEST, DatasetSplitType_DATASET_SPLIT_UNASSIGNED

const (
	// Default value if the enum is not set.
	DatasetSplitType_DATASET_SPLIT_TYPE_UNSPECIFIED DatasetSplitType = 0
	// Identifies the train documents.
	DatasetSplitType_DATASET_SPLIT_TRAIN DatasetSplitType = 1
	// Identifies the test documents.
	DatasetSplitType_DATASET_SPLIT_TEST DatasetSplitType = 2
	// Identifies the unassigned documents.
	DatasetSplitType_DATASET_SPLIT_UNASSIGNED DatasetSplitType = 3
)

func (DatasetSplitType) Descriptor

func (DatasetSplitType) Enum

func (DatasetSplitType) EnumDescriptor

func (DatasetSplitType) EnumDescriptor() ([]byte, []int)

Deprecated: Use DatasetSplitType.Descriptor instead.

func (DatasetSplitType) Number

func (DatasetSplitType) String

func (x DatasetSplitType) String() string

func (DatasetSplitType) Type

Dataset_DocumentWarehouseConfig

type Dataset_DocumentWarehouseConfig struct {

	// Output only. The collection in Document AI Warehouse associated with the
	// dataset.
	Collection string `protobuf:"bytes,1,opt,name=collection,proto3" json:"collection,omitempty"`
	// Output only. The schema in Document AI Warehouse associated with the
	// dataset.
	Schema string `protobuf:"bytes,2,opt,name=schema,proto3" json:"schema,omitempty"`
	// contains filtered or unexported fields
}

Configuration specific to the Document AI Warehouse-based implementation.

func (*Dataset_DocumentWarehouseConfig) Descriptor

func (*Dataset_DocumentWarehouseConfig) Descriptor() ([]byte, []int)

Deprecated: Use Dataset_DocumentWarehouseConfig.ProtoReflect.Descriptor instead.

func (*Dataset_DocumentWarehouseConfig) GetCollection

func (x *Dataset_DocumentWarehouseConfig) GetCollection() string

func (*Dataset_DocumentWarehouseConfig) GetSchema

func (x *Dataset_DocumentWarehouseConfig) GetSchema() string

func (*Dataset_DocumentWarehouseConfig) ProtoMessage

func (*Dataset_DocumentWarehouseConfig) ProtoMessage()

func (*Dataset_DocumentWarehouseConfig) ProtoReflect

func (*Dataset_DocumentWarehouseConfig) Reset

func (*Dataset_DocumentWarehouseConfig) String

Dataset_DocumentWarehouseConfig_

type Dataset_DocumentWarehouseConfig_ struct {
	// Optional. Document AI Warehouse-based dataset configuration.
	DocumentWarehouseConfig *Dataset_DocumentWarehouseConfig `protobuf:"bytes,5,opt,name=document_warehouse_config,json=documentWarehouseConfig,proto3,oneof"`
}

Dataset_GCSManagedConfig

type Dataset_GCSManagedConfig struct {

	// Required. The Cloud Storage URI (a directory) where the documents
	// belonging to the dataset must be stored.
	GcsPrefix *GcsPrefix `protobuf:"bytes,1,opt,name=gcs_prefix,json=gcsPrefix,proto3" json:"gcs_prefix,omitempty"`
	// contains filtered or unexported fields
}

Configuration specific to the Cloud Storage-based implementation.

func (*Dataset_GCSManagedConfig) Descriptor

func (*Dataset_GCSManagedConfig) Descriptor() ([]byte, []int)

Deprecated: Use Dataset_GCSManagedConfig.ProtoReflect.Descriptor instead.

func (*Dataset_GCSManagedConfig) GetGcsPrefix

func (x *Dataset_GCSManagedConfig) GetGcsPrefix() *GcsPrefix

func (*Dataset_GCSManagedConfig) ProtoMessage

func (*Dataset_GCSManagedConfig) ProtoMessage()

func (*Dataset_GCSManagedConfig) ProtoReflect

func (x *Dataset_GCSManagedConfig) ProtoReflect() protoreflect.Message

func (*Dataset_GCSManagedConfig) Reset

func (x *Dataset_GCSManagedConfig) Reset()

func (*Dataset_GCSManagedConfig) String

func (x *Dataset_GCSManagedConfig) String() string

Dataset_GcsManagedConfig

type Dataset_GcsManagedConfig struct {
	// Optional. User-managed Cloud Storage dataset configuration. Use this
	// configuration if the dataset documents are stored under a user-managed
	// Cloud Storage location.
	GcsManagedConfig *Dataset_GCSManagedConfig `protobuf:"bytes,3,opt,name=gcs_managed_config,json=gcsManagedConfig,proto3,oneof"`
}

Dataset_SpannerIndexingConfig

type Dataset_SpannerIndexingConfig struct {
	// contains filtered or unexported fields
}

Configuration specific to spanner-based indexing.

func (*Dataset_SpannerIndexingConfig) Descriptor

func (*Dataset_SpannerIndexingConfig) Descriptor() ([]byte, []int)

Deprecated: Use Dataset_SpannerIndexingConfig.ProtoReflect.Descriptor instead.

func (*Dataset_SpannerIndexingConfig) ProtoMessage

func (*Dataset_SpannerIndexingConfig) ProtoMessage()

func (*Dataset_SpannerIndexingConfig) ProtoReflect

func (*Dataset_SpannerIndexingConfig) Reset

func (x *Dataset_SpannerIndexingConfig) Reset()

func (*Dataset_SpannerIndexingConfig) String

Dataset_SpannerIndexingConfig_

type Dataset_SpannerIndexingConfig_ struct {
	// Optional. A lightweight indexing source with low latency and high
	// reliability, but lacking advanced features like CMEK and content-based
	// search.
	SpannerIndexingConfig *Dataset_SpannerIndexingConfig `protobuf:"bytes,4,opt,name=spanner_indexing_config,json=spannerIndexingConfig,proto3,oneof"`
}

Dataset_State

type Dataset_State int32

Different states of a dataset.

Dataset_STATE_UNSPECIFIED, Dataset_UNINITIALIZED, Dataset_INITIALIZING, Dataset_INITIALIZED

const (
	// Default unspecified enum, should not be used.
	Dataset_STATE_UNSPECIFIED Dataset_State = 0
	// Dataset has not been initialized.
	Dataset_UNINITIALIZED Dataset_State = 1
	// Dataset is being initialized.
	Dataset_INITIALIZING Dataset_State = 2
	// Dataset has been initialized.
	Dataset_INITIALIZED Dataset_State = 3
)

func (Dataset_State) Descriptor

func (Dataset_State) Enum

func (x Dataset_State) Enum() *Dataset_State

func (Dataset_State) EnumDescriptor

func (Dataset_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Dataset_State.Descriptor instead.

func (Dataset_State) Number

func (Dataset_State) String

func (x Dataset_State) String() string

func (Dataset_State) Type

Dataset_UnmanagedDatasetConfig

type Dataset_UnmanagedDatasetConfig struct {
	// contains filtered or unexported fields
}

Configuration specific to an unmanaged dataset.

func (*Dataset_UnmanagedDatasetConfig) Descriptor

func (*Dataset_UnmanagedDatasetConfig) Descriptor() ([]byte, []int)

Deprecated: Use Dataset_UnmanagedDatasetConfig.ProtoReflect.Descriptor instead.

func (*Dataset_UnmanagedDatasetConfig) ProtoMessage

func (*Dataset_UnmanagedDatasetConfig) ProtoMessage()

func (*Dataset_UnmanagedDatasetConfig) ProtoReflect

func (*Dataset_UnmanagedDatasetConfig) Reset

func (x *Dataset_UnmanagedDatasetConfig) Reset()

func (*Dataset_UnmanagedDatasetConfig) String

Dataset_UnmanagedDatasetConfig_

type Dataset_UnmanagedDatasetConfig_ struct {
	// Optional. Unmanaged dataset configuration. Use this configuration if the
	// dataset documents are managed by the document service internally (not
	// user-managed).
	UnmanagedDatasetConfig *Dataset_UnmanagedDatasetConfig `protobuf:"bytes,6,opt,name=unmanaged_dataset_config,json=unmanagedDatasetConfig,proto3,oneof"`
}

DeleteProcessorMetadata

type DeleteProcessorMetadata struct {

	// The basic metadata of the long-running operation.
	CommonMetadata *CommonOperationMetadata `protobuf:"bytes,5,opt,name=common_metadata,json=commonMetadata,proto3" json:"common_metadata,omitempty"`
	// contains filtered or unexported fields
}

The long-running operation metadata for the [DeleteProcessor][google.cloud.documentai.v1beta3.DocumentProcessorService.DeleteProcessor] method.

func (*DeleteProcessorMetadata) Descriptor

func (*DeleteProcessorMetadata) Descriptor() ([]byte, []int)

Deprecated: Use DeleteProcessorMetadata.ProtoReflect.Descriptor instead.

func (*DeleteProcessorMetadata) GetCommonMetadata

func (x *DeleteProcessorMetadata) GetCommonMetadata() *CommonOperationMetadata

func (*DeleteProcessorMetadata) ProtoMessage

func (*DeleteProcessorMetadata) ProtoMessage()

func (*DeleteProcessorMetadata) ProtoReflect

func (x *DeleteProcessorMetadata) ProtoReflect() protoreflect.Message

func (*DeleteProcessorMetadata) Reset

func (x *DeleteProcessorMetadata) Reset()

func (*DeleteProcessorMetadata) String

func (x *DeleteProcessorMetadata) String() string

DeleteProcessorRequest

type DeleteProcessorRequest struct {

	// Required. The processor resource name to be deleted.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for the [DeleteProcessor][google.cloud.documentai.v1beta3.DocumentProcessorService.DeleteProcessor] method.

func (*DeleteProcessorRequest) Descriptor

func (*DeleteProcessorRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteProcessorRequest.ProtoReflect.Descriptor instead.

func (*DeleteProcessorRequest) GetName

func (x *DeleteProcessorRequest) GetName() string

func (*DeleteProcessorRequest) ProtoMessage

func (*DeleteProcessorRequest) ProtoMessage()

func (*DeleteProcessorRequest) ProtoReflect

func (x *DeleteProcessorRequest) ProtoReflect() protoreflect.Message

func (*DeleteProcessorRequest) Reset

func (x *DeleteProcessorRequest) Reset()

func (*DeleteProcessorRequest) String

func (x *DeleteProcessorRequest) String() string

DeleteProcessorVersionMetadata

type DeleteProcessorVersionMetadata struct {

	// The basic metadata of the long-running operation.
	CommonMetadata *CommonOperationMetadata `protobuf:"bytes,1,opt,name=common_metadata,json=commonMetadata,proto3" json:"common_metadata,omitempty"`
	// contains filtered or unexported fields
}

The long-running operation metadata for the [DeleteProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.DeleteProcessorVersion] method.

func (*DeleteProcessorVersionMetadata) Descriptor

func (*DeleteProcessorVersionMetadata) Descriptor() ([]byte, []int)

Deprecated: Use DeleteProcessorVersionMetadata.ProtoReflect.Descriptor instead.

func (*DeleteProcessorVersionMetadata) GetCommonMetadata

func (*DeleteProcessorVersionMetadata) ProtoMessage

func (*DeleteProcessorVersionMetadata) ProtoMessage()

func (*DeleteProcessorVersionMetadata) ProtoReflect

func (*DeleteProcessorVersionMetadata) Reset

func (x *DeleteProcessorVersionMetadata) Reset()

func (*DeleteProcessorVersionMetadata) String

DeleteProcessorVersionRequest

type DeleteProcessorVersionRequest struct {

	// Required. The processor version resource name to be deleted.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for the [DeleteProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.DeleteProcessorVersion] method.

func (*DeleteProcessorVersionRequest) Descriptor

func (*DeleteProcessorVersionRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteProcessorVersionRequest.ProtoReflect.Descriptor instead.

func (*DeleteProcessorVersionRequest) GetName

func (*DeleteProcessorVersionRequest) ProtoMessage

func (*DeleteProcessorVersionRequest) ProtoMessage()

func (*DeleteProcessorVersionRequest) ProtoReflect

func (*DeleteProcessorVersionRequest) Reset

func (x *DeleteProcessorVersionRequest) Reset()

func (*DeleteProcessorVersionRequest) String

DeployProcessorVersionMetadata

type DeployProcessorVersionMetadata struct {

	// The basic metadata of the long-running operation.
	CommonMetadata *CommonOperationMetadata `protobuf:"bytes,1,opt,name=common_metadata,json=commonMetadata,proto3" json:"common_metadata,omitempty"`
	// contains filtered or unexported fields
}

The long-running operation metadata for the [DeployProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.DeployProcessorVersion] method.

func (*DeployProcessorVersionMetadata) Descriptor

func (*DeployProcessorVersionMetadata) Descriptor() ([]byte, []int)

Deprecated: Use DeployProcessorVersionMetadata.ProtoReflect.Descriptor instead.

func (*DeployProcessorVersionMetadata) GetCommonMetadata

func (*DeployProcessorVersionMetadata) ProtoMessage

func (*DeployProcessorVersionMetadata) ProtoMessage()

func (*DeployProcessorVersionMetadata) ProtoReflect

func (*DeployProcessorVersionMetadata) Reset

func (x *DeployProcessorVersionMetadata) Reset()

func (*DeployProcessorVersionMetadata) String

DeployProcessorVersionRequest

type DeployProcessorVersionRequest struct {

	// Required. The processor version resource name to be deployed.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for the [DeployProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.DeployProcessorVersion] method.

func (*DeployProcessorVersionRequest) Descriptor

func (*DeployProcessorVersionRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeployProcessorVersionRequest.ProtoReflect.Descriptor instead.

func (*DeployProcessorVersionRequest) GetName

func (*DeployProcessorVersionRequest) ProtoMessage

func (*DeployProcessorVersionRequest) ProtoMessage()

func (*DeployProcessorVersionRequest) ProtoReflect

func (*DeployProcessorVersionRequest) Reset

func (x *DeployProcessorVersionRequest) Reset()

func (*DeployProcessorVersionRequest) String

DeployProcessorVersionResponse

type DeployProcessorVersionResponse struct {
	// contains filtered or unexported fields
}

Response message for the [DeployProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.DeployProcessorVersion] method.

func (*DeployProcessorVersionResponse) Descriptor

func (*DeployProcessorVersionResponse) Descriptor() ([]byte, []int)

Deprecated: Use DeployProcessorVersionResponse.ProtoReflect.Descriptor instead.

func (*DeployProcessorVersionResponse) ProtoMessage

func (*DeployProcessorVersionResponse) ProtoMessage()

func (*DeployProcessorVersionResponse) ProtoReflect

func (*DeployProcessorVersionResponse) Reset

func (x *DeployProcessorVersionResponse) Reset()

func (*DeployProcessorVersionResponse) String

DisableProcessorMetadata

type DisableProcessorMetadata struct {

	// The basic metadata of the long-running operation.
	CommonMetadata *CommonOperationMetadata `protobuf:"bytes,5,opt,name=common_metadata,json=commonMetadata,proto3" json:"common_metadata,omitempty"`
	// contains filtered or unexported fields
}

The long-running operation metadata for the [DisableProcessor][google.cloud.documentai.v1beta3.DocumentProcessorService.DisableProcessor] method.

func (*DisableProcessorMetadata) Descriptor

func (*DisableProcessorMetadata) Descriptor() ([]byte, []int)

Deprecated: Use DisableProcessorMetadata.ProtoReflect.Descriptor instead.

func (*DisableProcessorMetadata) GetCommonMetadata

func (x *DisableProcessorMetadata) GetCommonMetadata() *CommonOperationMetadata

func (*DisableProcessorMetadata) ProtoMessage

func (*DisableProcessorMetadata) ProtoMessage()

func (*DisableProcessorMetadata) ProtoReflect

func (x *DisableProcessorMetadata) ProtoReflect() protoreflect.Message

func (*DisableProcessorMetadata) Reset

func (x *DisableProcessorMetadata) Reset()

func (*DisableProcessorMetadata) String

func (x *DisableProcessorMetadata) String() string

DisableProcessorRequest

type DisableProcessorRequest struct {

	// Required. The processor resource name to be disabled.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for the [DisableProcessor][google.cloud.documentai.v1beta3.DocumentProcessorService.DisableProcessor] method.

func (*DisableProcessorRequest) Descriptor

func (*DisableProcessorRequest) Descriptor() ([]byte, []int)

Deprecated: Use DisableProcessorRequest.ProtoReflect.Descriptor instead.

func (*DisableProcessorRequest) GetName

func (x *DisableProcessorRequest) GetName() string

func (*DisableProcessorRequest) ProtoMessage

func (*DisableProcessorRequest) ProtoMessage()

func (*DisableProcessorRequest) ProtoReflect

func (x *DisableProcessorRequest) ProtoReflect() protoreflect.Message

func (*DisableProcessorRequest) Reset

func (x *DisableProcessorRequest) Reset()

func (*DisableProcessorRequest) String

func (x *DisableProcessorRequest) String() string

DisableProcessorResponse

type DisableProcessorResponse struct {
	// contains filtered or unexported fields
}

Response message for the [DisableProcessor][google.cloud.documentai.v1beta3.DocumentProcessorService.DisableProcessor] method. Intentionally empty proto for adding fields in future.

func (*DisableProcessorResponse) Descriptor

func (*DisableProcessorResponse) Descriptor() ([]byte, []int)

Deprecated: Use DisableProcessorResponse.ProtoReflect.Descriptor instead.

func (*DisableProcessorResponse) ProtoMessage

func (*DisableProcessorResponse) ProtoMessage()

func (*DisableProcessorResponse) ProtoReflect

func (x *DisableProcessorResponse) ProtoReflect() protoreflect.Message

func (*DisableProcessorResponse) Reset

func (x *DisableProcessorResponse) Reset()

func (*DisableProcessorResponse) String

func (x *DisableProcessorResponse) String() string

Document

type Document struct {

	// Original source document from the user.
	//
	// Types that are assignable to Source:
	//
	//	*Document_Uri
	//	*Document_Content
	Source isDocument_Source `protobuf_oneof:"source"`
	// An IANA published [media type (MIME
	// type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
	MimeType string `protobuf:"bytes,3,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// Optional. UTF-8 encoded text in reading order from the document.
	Text string `protobuf:"bytes,4,opt,name=text,proto3" json:"text,omitempty"`
	// Styles for the
	// [Document.text][google.cloud.documentai.v1beta3.Document.text].
	//
	// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.
	TextStyles []*Document_Style `protobuf:"bytes,5,rep,name=text_styles,json=textStyles,proto3" json:"text_styles,omitempty"`
	// Visual page layout for the
	// [Document][google.cloud.documentai.v1beta3.Document].
	Pages []*Document_Page `protobuf:"bytes,6,rep,name=pages,proto3" json:"pages,omitempty"`
	// A list of entities detected on
	// [Document.text][google.cloud.documentai.v1beta3.Document.text]. For
	// document shards, entities in this list may cross shard boundaries.
	Entities []*Document_Entity `protobuf:"bytes,7,rep,name=entities,proto3" json:"entities,omitempty"`
	// Placeholder.  Relationship among
	// [Document.entities][google.cloud.documentai.v1beta3.Document.entities].
	EntityRelations []*Document_EntityRelation `protobuf:"bytes,8,rep,name=entity_relations,json=entityRelations,proto3" json:"entity_relations,omitempty"`
	// Placeholder.  A list of text corrections made to
	// [Document.text][google.cloud.documentai.v1beta3.Document.text].  This is
	// usually used for annotating corrections to OCR mistakes.  Text changes for
	// a given revision may not overlap with each other.
	TextChanges []*Document_TextChange `protobuf:"bytes,14,rep,name=text_changes,json=textChanges,proto3" json:"text_changes,omitempty"`
	// Information about the sharding if this document is sharded part of a larger
	// document. If the document is not sharded, this message is not specified.
	ShardInfo *Document_ShardInfo `protobuf:"bytes,9,opt,name=shard_info,json=shardInfo,proto3" json:"shard_info,omitempty"`
	// Any error that occurred while processing this document.
	Error *status.Status `protobuf:"bytes,10,opt,name=error,proto3" json:"error,omitempty"`
	// Placeholder. Revision history of this document.
	Revisions []*Document_Revision `protobuf:"bytes,13,rep,name=revisions,proto3" json:"revisions,omitempty"`
	// contains filtered or unexported fields
}

Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality.

func (*Document) Descriptor

func (*Document) Descriptor() ([]byte, []int)

Deprecated: Use Document.ProtoReflect.Descriptor instead.

func (*Document) GetContent

func (x *Document) GetContent() []byte

func (*Document) GetEntities

func (x *Document) GetEntities() []*Document_Entity

func (*Document) GetEntityRelations

func (x *Document) GetEntityRelations() []*Document_EntityRelation

func (*Document) GetError

func (x *Document) GetError() *status.Status

func (*Document) GetMimeType

func (x *Document) GetMimeType() string

func (*Document) GetPages

func (x *Document) GetPages() []*Document_Page

func (*Document) GetRevisions

func (x *Document) GetRevisions() []*Document_Revision

func (*Document) GetShardInfo

func (x *Document) GetShardInfo() *Document_ShardInfo

func (*Document) GetSource

func (m *Document) GetSource() isDocument_Source

func (*Document) GetText

func (x *Document) GetText() string

func (*Document) GetTextChanges

func (x *Document) GetTextChanges() []*Document_TextChange

func (*Document) GetTextStyles

func (x *Document) GetTextStyles() []*Document_Style

Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.

func (*Document) GetUri

func (x *Document) GetUri() string

func (*Document) ProtoMessage

func (*Document) ProtoMessage()

func (*Document) ProtoReflect

func (x *Document) ProtoReflect() protoreflect.Message

func (*Document) Reset

func (x *Document) Reset()

func (*Document) String

func (x *Document) String() string

DocumentId

type DocumentId struct {

	// Types that are assignable to Type:
	//
	//	*DocumentId_GcsManagedDocId
	//	*DocumentId_UnmanagedDocId
	Type isDocumentId_Type `protobuf_oneof:"type"`
	// Points to a specific revision of the document if set.
	RevisionRef *RevisionRef `protobuf:"bytes,3,opt,name=revision_ref,json=revisionRef,proto3" json:"revision_ref,omitempty"`
	// contains filtered or unexported fields
}

Document Identifier.

func (*DocumentId) Descriptor

func (*DocumentId) Descriptor() ([]byte, []int)

Deprecated: Use DocumentId.ProtoReflect.Descriptor instead.

func (*DocumentId) GetGcsManagedDocId

func (x *DocumentId) GetGcsManagedDocId() *DocumentId_GCSManagedDocumentId

func (*DocumentId) GetRevisionRef

func (x *DocumentId) GetRevisionRef() *RevisionRef

func (*DocumentId) GetType

func (m *DocumentId) GetType() isDocumentId_Type

func (*DocumentId) GetUnmanagedDocId

func (x *DocumentId) GetUnmanagedDocId() *DocumentId_UnmanagedDocumentId

func (*DocumentId) ProtoMessage

func (*DocumentId) ProtoMessage()

func (*DocumentId) ProtoReflect

func (x *DocumentId) ProtoReflect() protoreflect.Message

func (*DocumentId) Reset

func (x *DocumentId) Reset()

func (*DocumentId) String

func (x *DocumentId) String() string

DocumentId_GCSManagedDocumentId

type DocumentId_GCSManagedDocumentId struct {

	// Required. The Cloud Storage URI where the actual document is stored.
	GcsUri string `protobuf:"bytes,1,opt,name=gcs_uri,json=gcsUri,proto3" json:"gcs_uri,omitempty"`
	// Id of the document (indexed) managed by Content Warehouse.
	//
	// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/dataset.proto.
	CwDocId string `protobuf:"bytes,2,opt,name=cw_doc_id,json=cwDocId,proto3" json:"cw_doc_id,omitempty"`
	// contains filtered or unexported fields
}

Identifies a document uniquely within the scope of a dataset in the user-managed Cloud Storage option.

func (*DocumentId_GCSManagedDocumentId) Descriptor

func (*DocumentId_GCSManagedDocumentId) Descriptor() ([]byte, []int)

Deprecated: Use DocumentId_GCSManagedDocumentId.ProtoReflect.Descriptor instead.

func (*DocumentId_GCSManagedDocumentId) GetCwDocId

func (x *DocumentId_GCSManagedDocumentId) GetCwDocId() string

Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/dataset.proto.

func (*DocumentId_GCSManagedDocumentId) GetGcsUri

func (x *DocumentId_GCSManagedDocumentId) GetGcsUri() string

func (*DocumentId_GCSManagedDocumentId) ProtoMessage

func (*DocumentId_GCSManagedDocumentId) ProtoMessage()

func (*DocumentId_GCSManagedDocumentId) ProtoReflect

func (*DocumentId_GCSManagedDocumentId) Reset

func (*DocumentId_GCSManagedDocumentId) String

DocumentId_GcsManagedDocId

type DocumentId_GcsManagedDocId struct {
	// A document id within user-managed Cloud Storage.
	GcsManagedDocId *DocumentId_GCSManagedDocumentId `protobuf:"bytes,1,opt,name=gcs_managed_doc_id,json=gcsManagedDocId,proto3,oneof"`
}

DocumentId_UnmanagedDocId

type DocumentId_UnmanagedDocId struct {
	// A document id within unmanaged dataset.
	UnmanagedDocId *DocumentId_UnmanagedDocumentId `protobuf:"bytes,4,opt,name=unmanaged_doc_id,json=unmanagedDocId,proto3,oneof"`
}

DocumentId_UnmanagedDocumentId

type DocumentId_UnmanagedDocumentId struct {

	// Required. The id of the document.
	DocId string `protobuf:"bytes,1,opt,name=doc_id,json=docId,proto3" json:"doc_id,omitempty"`
	// contains filtered or unexported fields
}

Identifies a document uniquely within the scope of a dataset in unmanaged option.

func (*DocumentId_UnmanagedDocumentId) Descriptor

func (*DocumentId_UnmanagedDocumentId) Descriptor() ([]byte, []int)

Deprecated: Use DocumentId_UnmanagedDocumentId.ProtoReflect.Descriptor instead.

func (*DocumentId_UnmanagedDocumentId) GetDocId

func (x *DocumentId_UnmanagedDocumentId) GetDocId() string

func (*DocumentId_UnmanagedDocumentId) ProtoMessage

func (*DocumentId_UnmanagedDocumentId) ProtoMessage()

func (*DocumentId_UnmanagedDocumentId) ProtoReflect

func (*DocumentId_UnmanagedDocumentId) Reset

func (x *DocumentId_UnmanagedDocumentId) Reset()

func (*DocumentId_UnmanagedDocumentId) String

DocumentLabelingState

type DocumentLabelingState int32

Describes the labelling status of a document.

DocumentLabelingState_DOCUMENT_LABELING_STATE_UNSPECIFIED, DocumentLabelingState_DOCUMENT_LABELED, DocumentLabelingState_DOCUMENT_UNLABELED, DocumentLabelingState_DOCUMENT_AUTO_LABELED

const (
	// Default value if the enum is not set.
	DocumentLabelingState_DOCUMENT_LABELING_STATE_UNSPECIFIED DocumentLabelingState = 0
	// Document has been labelled.
	DocumentLabelingState_DOCUMENT_LABELED DocumentLabelingState = 1
	// Document has not been labelled.
	DocumentLabelingState_DOCUMENT_UNLABELED DocumentLabelingState = 2
	// Document has been auto-labelled.
	DocumentLabelingState_DOCUMENT_AUTO_LABELED DocumentLabelingState = 3
)

func (DocumentLabelingState) Descriptor

func (DocumentLabelingState) Enum

func (DocumentLabelingState) EnumDescriptor

func (DocumentLabelingState) EnumDescriptor() ([]byte, []int)

Deprecated: Use DocumentLabelingState.Descriptor instead.

func (DocumentLabelingState) Number

func (DocumentLabelingState) String

func (x DocumentLabelingState) String() string

func (DocumentLabelingState) Type

DocumentMetadata

type DocumentMetadata struct {
	DocumentId *DocumentId `protobuf:"bytes,1,opt,name=document_id,json=documentId,proto3" json:"document_id,omitempty"`

	PageCount int32 `protobuf:"varint,2,opt,name=page_count,json=pageCount,proto3" json:"page_count,omitempty"`

	DatasetType DatasetSplitType "" /* 149 byte string literal not displayed */

	LabelingState DocumentLabelingState "" /* 160 byte string literal not displayed */

	DisplayName string `protobuf:"bytes,6,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`

}

Metadata about a document.

func (*DocumentMetadata) Descriptor

func (*DocumentMetadata) Descriptor() ([]byte, []int)

Deprecated: Use DocumentMetadata.ProtoReflect.Descriptor instead.

func (*DocumentMetadata) GetDatasetType

func (x *DocumentMetadata) GetDatasetType() DatasetSplitType

func (*DocumentMetadata) GetDisplayName

func (x *DocumentMetadata) GetDisplayName() string

func (*DocumentMetadata) GetDocumentId

func (x *DocumentMetadata) GetDocumentId() *DocumentId

func (*DocumentMetadata) GetLabelingState

func (x *DocumentMetadata) GetLabelingState() DocumentLabelingState

func (*DocumentMetadata) GetPageCount

func (x *DocumentMetadata) GetPageCount() int32

func (*DocumentMetadata) ProtoMessage

func (*DocumentMetadata) ProtoMessage()

func (*DocumentMetadata) ProtoReflect

func (x *DocumentMetadata) ProtoReflect() protoreflect.Message

func (*DocumentMetadata) Reset

func (x *DocumentMetadata) Reset()

func (*DocumentMetadata) String

func (x *DocumentMetadata) String() string

DocumentOutputConfig

type DocumentOutputConfig struct {

	// The destination of the results.
	//
	// Types that are assignable to Destination:
	//
	//	*DocumentOutputConfig_GcsOutputConfig_
	Destination isDocumentOutputConfig_Destination `protobuf_oneof:"destination"`
	// contains filtered or unexported fields
}

Config that controls the output of documents. All documents will be written as a JSON file.

func (*DocumentOutputConfig) Descriptor

func (*DocumentOutputConfig) Descriptor() ([]byte, []int)

Deprecated: Use DocumentOutputConfig.ProtoReflect.Descriptor instead.

func (*DocumentOutputConfig) GetDestination

func (m *DocumentOutputConfig) GetDestination() isDocumentOutputConfig_Destination

func (*DocumentOutputConfig) GetGcsOutputConfig

func (*DocumentOutputConfig) ProtoMessage

func (*DocumentOutputConfig) ProtoMessage()

func (*DocumentOutputConfig) ProtoReflect

func (x *DocumentOutputConfig) ProtoReflect() protoreflect.Message

func (*DocumentOutputConfig) Reset

func (x *DocumentOutputConfig) Reset()

func (*DocumentOutputConfig) String

func (x *DocumentOutputConfig) String() string

DocumentOutputConfig_GcsOutputConfig

type DocumentOutputConfig_GcsOutputConfig struct {

	// The Cloud Storage uri (a directory) of the output.
	GcsUri string `protobuf:"bytes,1,opt,name=gcs_uri,json=gcsUri,proto3" json:"gcs_uri,omitempty"`
	// Specifies which fields to include in the output documents.
	// Only supports top level document and pages field so it must be in the
	// form of `{document_field_name}` or `pages.{page_field_name}`.
	FieldMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=field_mask,json=fieldMask,proto3" json:"field_mask,omitempty"`
	// Specifies the sharding config for the output document.
	ShardingConfig *DocumentOutputConfig_GcsOutputConfig_ShardingConfig `protobuf:"bytes,3,opt,name=sharding_config,json=shardingConfig,proto3" json:"sharding_config,omitempty"`
	// contains filtered or unexported fields
}

The configuration used when outputting documents.

func (*DocumentOutputConfig_GcsOutputConfig) Descriptor

func (*DocumentOutputConfig_GcsOutputConfig) Descriptor() ([]byte, []int)

Deprecated: Use DocumentOutputConfig_GcsOutputConfig.ProtoReflect.Descriptor instead.

func (*DocumentOutputConfig_GcsOutputConfig) GetFieldMask

func (*DocumentOutputConfig_GcsOutputConfig) GetGcsUri

func (*DocumentOutputConfig_GcsOutputConfig) GetShardingConfig

func (*DocumentOutputConfig_GcsOutputConfig) ProtoMessage

func (*DocumentOutputConfig_GcsOutputConfig) ProtoMessage()

func (*DocumentOutputConfig_GcsOutputConfig) ProtoReflect

func (*DocumentOutputConfig_GcsOutputConfig) Reset

func (*DocumentOutputConfig_GcsOutputConfig) String

DocumentOutputConfig_GcsOutputConfig_

type DocumentOutputConfig_GcsOutputConfig_ struct {
	// Output config to write the results to Cloud Storage.
	GcsOutputConfig *DocumentOutputConfig_GcsOutputConfig `protobuf:"bytes,1,opt,name=gcs_output_config,json=gcsOutputConfig,proto3,oneof"`
}

DocumentOutputConfig_GcsOutputConfig_ShardingConfig

type DocumentOutputConfig_GcsOutputConfig_ShardingConfig struct {

	// The number of pages per shard.
	PagesPerShard int32 `protobuf:"varint,1,opt,name=pages_per_shard,json=pagesPerShard,proto3" json:"pages_per_shard,omitempty"`
	// The number of overlapping pages between consecutive shards.
	PagesOverlap int32 `protobuf:"varint,2,opt,name=pages_overlap,json=pagesOverlap,proto3" json:"pages_overlap,omitempty"`
	// contains filtered or unexported fields
}

The sharding config for the output document.

func (*DocumentOutputConfig_GcsOutputConfig_ShardingConfig) Descriptor

Deprecated: Use DocumentOutputConfig_GcsOutputConfig_ShardingConfig.ProtoReflect.Descriptor instead.

func (*DocumentOutputConfig_GcsOutputConfig_ShardingConfig) GetPagesOverlap

func (*DocumentOutputConfig_GcsOutputConfig_ShardingConfig) GetPagesPerShard

func (*DocumentOutputConfig_GcsOutputConfig_ShardingConfig) ProtoMessage

func (*DocumentOutputConfig_GcsOutputConfig_ShardingConfig) ProtoReflect

func (*DocumentOutputConfig_GcsOutputConfig_ShardingConfig) Reset

func (*DocumentOutputConfig_GcsOutputConfig_ShardingConfig) String

DocumentPageRange

type DocumentPageRange struct {

	// First page number (one-based index) to be returned.
	Start int32 `protobuf:"varint,1,opt,name=start,proto3" json:"start,omitempty"`
	// Last page number (one-based index) to be returned.
	End int32 `protobuf:"varint,2,opt,name=end,proto3" json:"end,omitempty"`
	// contains filtered or unexported fields
}

Range of pages present in a document.

func (*DocumentPageRange) Descriptor

func (*DocumentPageRange) Descriptor() ([]byte, []int)

Deprecated: Use DocumentPageRange.ProtoReflect.Descriptor instead.

func (*DocumentPageRange) GetEnd

func (x *DocumentPageRange) GetEnd() int32

func (*DocumentPageRange) GetStart

func (x *DocumentPageRange) GetStart() int32

func (*DocumentPageRange) ProtoMessage

func (*DocumentPageRange) ProtoMessage()

func (*DocumentPageRange) ProtoReflect

func (x *DocumentPageRange) ProtoReflect() protoreflect.Message

func (*DocumentPageRange) Reset

func (x *DocumentPageRange) Reset()

func (*DocumentPageRange) String

func (x *DocumentPageRange) String() string

DocumentProcessorServiceClient

type DocumentProcessorServiceClient interface {
	// Processes a single document.
	ProcessDocument(ctx context.Context, in *ProcessRequest, opts ...grpc.CallOption) (*ProcessResponse, error)
	// LRO endpoint to batch process many documents. The output is written
	// to Cloud Storage as JSON in the [Document] format.
	BatchProcessDocuments(ctx context.Context, in *BatchProcessRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Fetches processor types. Note that we don't use
	// [ListProcessorTypes][google.cloud.documentai.v1beta3.DocumentProcessorService.ListProcessorTypes]
	// here, because it isn't paginated.
	FetchProcessorTypes(ctx context.Context, in *FetchProcessorTypesRequest, opts ...grpc.CallOption) (*FetchProcessorTypesResponse, error)
	// Lists the processor types that exist.
	ListProcessorTypes(ctx context.Context, in *ListProcessorTypesRequest, opts ...grpc.CallOption) (*ListProcessorTypesResponse, error)
	// Gets a processor type detail.
	GetProcessorType(ctx context.Context, in *GetProcessorTypeRequest, opts ...grpc.CallOption) (*ProcessorType, error)
	// Lists all processors which belong to this project.
	ListProcessors(ctx context.Context, in *ListProcessorsRequest, opts ...grpc.CallOption) (*ListProcessorsResponse, error)
	// Gets a processor detail.
	GetProcessor(ctx context.Context, in *GetProcessorRequest, opts ...grpc.CallOption) (*Processor, error)
	// Trains a new processor version.
	// Operation metadata is returned as
	// [TrainProcessorVersionMetadata][google.cloud.documentai.v1beta3.TrainProcessorVersionMetadata].
	TrainProcessorVersion(ctx context.Context, in *TrainProcessorVersionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets a processor version detail.
	GetProcessorVersion(ctx context.Context, in *GetProcessorVersionRequest, opts ...grpc.CallOption) (*ProcessorVersion, error)
	// Lists all versions of a processor.
	ListProcessorVersions(ctx context.Context, in *ListProcessorVersionsRequest, opts ...grpc.CallOption) (*ListProcessorVersionsResponse, error)
	// Deletes the processor version, all artifacts under the processor version
	// will be deleted.
	DeleteProcessorVersion(ctx context.Context, in *DeleteProcessorVersionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deploys the processor version.
	DeployProcessorVersion(ctx context.Context, in *DeployProcessorVersionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Undeploys the processor version.
	UndeployProcessorVersion(ctx context.Context, in *UndeployProcessorVersionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Creates a processor from the
	// [ProcessorType][google.cloud.documentai.v1beta3.ProcessorType] provided.
	// The processor will be at `ENABLED` state by default after its creation.
	CreateProcessor(ctx context.Context, in *CreateProcessorRequest, opts ...grpc.CallOption) (*Processor, error)
	// Deletes the processor, unloads all deployed model artifacts if it was
	// enabled and then deletes all artifacts associated with this processor.
	DeleteProcessor(ctx context.Context, in *DeleteProcessorRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Enables a processor
	EnableProcessor(ctx context.Context, in *EnableProcessorRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Disables a processor
	DisableProcessor(ctx context.Context, in *DisableProcessorRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Set the default (active) version of a
	// [Processor][google.cloud.documentai.v1beta3.Processor] that will be used in
	// [ProcessDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ProcessDocument]
	// and
	// [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments].
	SetDefaultProcessorVersion(ctx context.Context, in *SetDefaultProcessorVersionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Send a document for Human Review. The input document should be processed by
	// the specified processor.
	ReviewDocument(ctx context.Context, in *ReviewDocumentRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Evaluates a ProcessorVersion against annotated documents, producing an
	// Evaluation.
	EvaluateProcessorVersion(ctx context.Context, in *EvaluateProcessorVersionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Retrieves a specific evaluation.
	GetEvaluation(ctx context.Context, in *GetEvaluationRequest, opts ...grpc.CallOption) (*Evaluation, error)
	// Retrieves a set of evaluations for a given processor version.
	ListEvaluations(ctx context.Context, in *ListEvaluationsRequest, opts ...grpc.CallOption) (*ListEvaluationsResponse, error)
	// Imports a processor version from source processor version.
	ImportProcessorVersion(ctx context.Context, in *ImportProcessorVersionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

DocumentProcessorServiceClient is the client API for DocumentProcessorService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewDocumentProcessorServiceClient

func NewDocumentProcessorServiceClient(cc grpc.ClientConnInterface) DocumentProcessorServiceClient

DocumentProcessorServiceServer

type DocumentProcessorServiceServer interface {
	// Processes a single document.
	ProcessDocument(context.Context, *ProcessRequest) (*ProcessResponse, error)
	// LRO endpoint to batch process many documents. The output is written
	// to Cloud Storage as JSON in the [Document] format.
	BatchProcessDocuments(context.Context, *BatchProcessRequest) (*longrunningpb.Operation, error)
	// Fetches processor types. Note that we don't use
	// [ListProcessorTypes][google.cloud.documentai.v1beta3.DocumentProcessorService.ListProcessorTypes]
	// here, because it isn't paginated.
	FetchProcessorTypes(context.Context, *FetchProcessorTypesRequest) (*FetchProcessorTypesResponse, error)
	// Lists the processor types that exist.
	ListProcessorTypes(context.Context, *ListProcessorTypesRequest) (*ListProcessorTypesResponse, error)
	// Gets a processor type detail.
	GetProcessorType(context.Context, *GetProcessorTypeRequest) (*ProcessorType, error)
	// Lists all processors which belong to this project.
	ListProcessors(context.Context, *ListProcessorsRequest) (*ListProcessorsResponse, error)
	// Gets a processor detail.
	GetProcessor(context.Context, *GetProcessorRequest) (*Processor, error)
	// Trains a new processor version.
	// Operation metadata is returned as
	// [TrainProcessorVersionMetadata][google.cloud.documentai.v1beta3.TrainProcessorVersionMetadata].
	TrainProcessorVersion(context.Context, *TrainProcessorVersionRequest) (*longrunningpb.Operation, error)
	// Gets a processor version detail.
	GetProcessorVersion(context.Context, *GetProcessorVersionRequest) (*ProcessorVersion, error)
	// Lists all versions of a processor.
	ListProcessorVersions(context.Context, *ListProcessorVersionsRequest) (*ListProcessorVersionsResponse, error)
	// Deletes the processor version, all artifacts under the processor version
	// will be deleted.
	DeleteProcessorVersion(context.Context, *DeleteProcessorVersionRequest) (*longrunningpb.Operation, error)
	// Deploys the processor version.
	DeployProcessorVersion(context.Context, *DeployProcessorVersionRequest) (*longrunningpb.Operation, error)
	// Undeploys the processor version.
	UndeployProcessorVersion(context.Context, *UndeployProcessorVersionRequest) (*longrunningpb.Operation, error)
	// Creates a processor from the
	// [ProcessorType][google.cloud.documentai.v1beta3.ProcessorType] provided.
	// The processor will be at `ENABLED` state by default after its creation.
	CreateProcessor(context.Context, *CreateProcessorRequest) (*Processor, error)
	// Deletes the processor, unloads all deployed model artifacts if it was
	// enabled and then deletes all artifacts associated with this processor.
	DeleteProcessor(context.Context, *DeleteProcessorRequest) (*longrunningpb.Operation, error)
	// Enables a processor
	EnableProcessor(context.Context, *EnableProcessorRequest) (*longrunningpb.Operation, error)
	// Disables a processor
	DisableProcessor(context.Context, *DisableProcessorRequest) (*longrunningpb.Operation, error)
	// Set the default (active) version of a
	// [Processor][google.cloud.documentai.v1beta3.Processor] that will be used in
	// [ProcessDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ProcessDocument]
	// and
	// [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments].
	SetDefaultProcessorVersion(context.Context, *SetDefaultProcessorVersionRequest) (*longrunningpb.Operation, error)
	// Send a document for Human Review. The input document should be processed by
	// the specified processor.
	ReviewDocument(context.Context, *ReviewDocumentRequest) (*longrunningpb.Operation, error)
	// Evaluates a ProcessorVersion against annotated documents, producing an
	// Evaluation.
	EvaluateProcessorVersion(context.Context, *EvaluateProcessorVersionRequest) (*longrunningpb.Operation, error)
	// Retrieves a specific evaluation.
	GetEvaluation(context.Context, *GetEvaluationRequest) (*Evaluation, error)
	// Retrieves a set of evaluations for a given processor version.
	ListEvaluations(context.Context, *ListEvaluationsRequest) (*ListEvaluationsResponse, error)
	// Imports a processor version from source processor version.
	ImportProcessorVersion(context.Context, *ImportProcessorVersionRequest) (*longrunningpb.Operation, error)
}

DocumentProcessorServiceServer is the server API for DocumentProcessorService service.

DocumentSchema

type DocumentSchema struct {

	// Display name to show to users.
	DisplayName string `protobuf:"bytes,1,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Description of the schema.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// Entity types of the schema.
	EntityTypes []*DocumentSchema_EntityType `protobuf:"bytes,3,rep,name=entity_types,json=entityTypes,proto3" json:"entity_types,omitempty"`
	// Metadata of the schema.
	Metadata *DocumentSchema_Metadata `protobuf:"bytes,4,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

The schema defines the output of the processed document by a processor.

func (*DocumentSchema) Descriptor

func (*DocumentSchema) Descriptor() ([]byte, []int)

Deprecated: Use DocumentSchema.ProtoReflect.Descriptor instead.

func (*DocumentSchema) GetDescription

func (x *DocumentSchema) GetDescription() string

func (*DocumentSchema) GetDisplayName

func (x *DocumentSchema) GetDisplayName() string

func (*DocumentSchema) GetEntityTypes

func (x *DocumentSchema) GetEntityTypes() []*DocumentSchema_EntityType

func (*DocumentSchema) GetMetadata

func (x *DocumentSchema) GetMetadata() *DocumentSchema_Metadata

func (*DocumentSchema) ProtoMessage

func (*DocumentSchema) ProtoMessage()

func (*DocumentSchema) ProtoReflect

func (x *DocumentSchema) ProtoReflect() protoreflect.Message

func (*DocumentSchema) Reset

func (x *DocumentSchema) Reset()

func (*DocumentSchema) String

func (x *DocumentSchema) String() string

DocumentSchema_EntityType

type DocumentSchema_EntityType struct {

	// Types that are assignable to ValueSource:
	//
	//	*DocumentSchema_EntityType_EnumValues_
	ValueSource isDocumentSchema_EntityType_ValueSource `protobuf_oneof:"value_source"`
	// User defined name for the type.
	DisplayName string `protobuf:"bytes,13,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Name of the type. It must be unique within the schema file and
	// cannot be a "Common Type".  The following naming conventions are used:
	//
	//   - Use `snake_casing`.
	//   - Name matching is case-sensitive.
	//   - Maximum 64 characters.
	//   - Must start with a letter.
	//   - Allowed characters: ASCII letters `[a-z0-9_-]`.  (For backward
	//     compatibility internal infrastructure and tooling can handle any ascii
	//     character.)
	//   - The `/` is sometimes used to denote a property of a type.  For example
	//     `line_item/amount`.  This convention is deprecated, but will still be
	//     honored for backward compatibility.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The entity type that this type is derived from.  For now, one and only
	// one should be set.
	BaseTypes []string `protobuf:"bytes,2,rep,name=base_types,json=baseTypes,proto3" json:"base_types,omitempty"`
	// Description the nested structure, or composition of an entity.
	Properties []*DocumentSchema_EntityType_Property `protobuf:"bytes,6,rep,name=properties,proto3" json:"properties,omitempty"`
	// Metadata for the entity type.
	EntityTypeMetadata *EntityTypeMetadata `protobuf:"bytes,11,opt,name=entity_type_metadata,json=entityTypeMetadata,proto3" json:"entity_type_metadata,omitempty"`
	// contains filtered or unexported fields
}

EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.

func (*DocumentSchema_EntityType) Descriptor

func (*DocumentSchema_EntityType) Descriptor() ([]byte, []int)

Deprecated: Use DocumentSchema_EntityType.ProtoReflect.Descriptor instead.

func (*DocumentSchema_EntityType) GetBaseTypes

func (x *DocumentSchema_EntityType) GetBaseTypes() []string

func (*DocumentSchema_EntityType) GetDisplayName

func (x *DocumentSchema_EntityType) GetDisplayName() string

func (*DocumentSchema_EntityType) GetEntityTypeMetadata

func (x *DocumentSchema_EntityType) GetEntityTypeMetadata() *EntityTypeMetadata

func (*DocumentSchema_EntityType) GetEnumValues

func (*DocumentSchema_EntityType) GetName

func (x *DocumentSchema_EntityType) GetName() string

func (*DocumentSchema_EntityType) GetProperties

func (*DocumentSchema_EntityType) GetValueSource

func (m *DocumentSchema_EntityType) GetValueSource() isDocumentSchema_EntityType_ValueSource

func (*DocumentSchema_EntityType) ProtoMessage

func (*DocumentSchema_EntityType) ProtoMessage()

func (*DocumentSchema_EntityType) ProtoReflect

func (*DocumentSchema_EntityType) Reset

func (x *DocumentSchema_EntityType) Reset()

func (*DocumentSchema_EntityType) String

func (x *DocumentSchema_EntityType) String() string

DocumentSchema_EntityType_EnumValues

type DocumentSchema_EntityType_EnumValues struct {

	// The individual values that this enum values type can include.
	Values []string `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

Defines the a list of enum values.

func (*DocumentSchema_EntityType_EnumValues) Descriptor

func (*DocumentSchema_EntityType_EnumValues) Descriptor() ([]byte, []int)

Deprecated: Use DocumentSchema_EntityType_EnumValues.ProtoReflect.Descriptor instead.

func (*DocumentSchema_EntityType_EnumValues) GetValues

func (*DocumentSchema_EntityType_EnumValues) ProtoMessage

func (*DocumentSchema_EntityType_EnumValues) ProtoMessage()

func (*DocumentSchema_EntityType_EnumValues) ProtoReflect

func (*DocumentSchema_EntityType_EnumValues) Reset

func (*DocumentSchema_EntityType_EnumValues) String

DocumentSchema_EntityType_EnumValues_

type DocumentSchema_EntityType_EnumValues_ struct {
	// If specified, lists all the possible values for this entity.  This
	// should not be more than a handful of values.  If the number of values
	// is >10 or could change frequently use the `EntityType.value_ontology`
	// field and specify a list of all possible values in a value ontology
	// file.
	EnumValues *DocumentSchema_EntityType_EnumValues `protobuf:"bytes,14,opt,name=enum_values,json=enumValues,proto3,oneof"`
}

DocumentSchema_EntityType_Property

type DocumentSchema_EntityType_Property struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`

	ValueType string `protobuf:"bytes,2,opt,name=value_type,json=valueType,proto3" json:"value_type,omitempty"`

	OccurrenceType DocumentSchema_EntityType_Property_OccurrenceType "" /* 191 byte string literal not displayed */

	PropertyMetadata *PropertyMetadata `protobuf:"bytes,5,opt,name=property_metadata,json=propertyMetadata,proto3" json:"property_metadata,omitempty"`

}

Defines properties that can be part of the entity type.

func (*DocumentSchema_EntityType_Property) Descriptor

func (*DocumentSchema_EntityType_Property) Descriptor() ([]byte, []int)

Deprecated: Use DocumentSchema_EntityType_Property.ProtoReflect.Descriptor instead.

func (*DocumentSchema_EntityType_Property) GetName

func (*DocumentSchema_EntityType_Property) GetOccurrenceType

func (*DocumentSchema_EntityType_Property) GetPropertyMetadata

func (x *DocumentSchema_EntityType_Property) GetPropertyMetadata() *PropertyMetadata

func (*DocumentSchema_EntityType_Property) GetValueType

func (x *DocumentSchema_EntityType_Property) GetValueType() string

func (*DocumentSchema_EntityType_Property) ProtoMessage

func (*DocumentSchema_EntityType_Property) ProtoMessage()

func (*DocumentSchema_EntityType_Property) ProtoReflect

func (*DocumentSchema_EntityType_Property) Reset

func (*DocumentSchema_EntityType_Property) String

DocumentSchema_EntityType_Property_OccurrenceType

type DocumentSchema_EntityType_Property_OccurrenceType int32

Types of occurrences of the entity type in the document. This represents the number of instances of instances of an entity, not number of mentions of an entity. For example, a bank statement may only have one account_number, but this account number may be mentioned in several places on the document. In this case the 'account_number' would be considered a REQUIRED_ONCE entity type. If, on the other hand, we expect a bank statement to contain the status of multiple different accounts for the customers, the occurrence type will be set to REQUIRED_MULTIPLE.

DocumentSchema_EntityType_Property_OCCURRENCE_TYPE_UNSPECIFIED, DocumentSchema_EntityType_Property_OPTIONAL_ONCE, DocumentSchema_EntityType_Property_OPTIONAL_MULTIPLE, DocumentSchema_EntityType_Property_REQUIRED_ONCE, DocumentSchema_EntityType_Property_REQUIRED_MULTIPLE

const (
	// Unspecified occurrence type.
	DocumentSchema_EntityType_Property_OCCURRENCE_TYPE_UNSPECIFIED DocumentSchema_EntityType_Property_OccurrenceType = 0
	// There will be zero or one instance of this entity type.  The same
	// entity instance may be mentioned multiple times.
	DocumentSchema_EntityType_Property_OPTIONAL_ONCE DocumentSchema_EntityType_Property_OccurrenceType = 1
	// The entity type will appear zero or multiple times.
	DocumentSchema_EntityType_Property_OPTIONAL_MULTIPLE DocumentSchema_EntityType_Property_OccurrenceType = 2
	// The entity type will only appear exactly once.  The same
	// entity instance may be mentioned multiple times.
	DocumentSchema_EntityType_Property_REQUIRED_ONCE DocumentSchema_EntityType_Property_OccurrenceType = 3
	// The entity type will appear once or more times.
	DocumentSchema_EntityType_Property_REQUIRED_MULTIPLE DocumentSchema_EntityType_Property_OccurrenceType = 4
)

func (DocumentSchema_EntityType_Property_OccurrenceType) Descriptor

func (DocumentSchema_EntityType_Property_OccurrenceType) Enum

func (DocumentSchema_EntityType_Property_OccurrenceType) EnumDescriptor

Deprecated: Use DocumentSchema_EntityType_Property_OccurrenceType.Descriptor instead.

func (DocumentSchema_EntityType_Property_OccurrenceType) Number

func (DocumentSchema_EntityType_Property_OccurrenceType) String

func (DocumentSchema_EntityType_Property_OccurrenceType) Type

DocumentSchema_Metadata

type DocumentSchema_Metadata struct {
	DocumentSplitter bool `protobuf:"varint,1,opt,name=document_splitter,json=documentSplitter,proto3" json:"document_splitter,omitempty"`

	DocumentAllowMultipleLabels bool "" /* 147 byte string literal not displayed */

	PrefixedNamingOnProperties bool "" /* 144 byte string literal not displayed */

	SkipNamingValidation bool `protobuf:"varint,7,opt,name=skip_naming_validation,json=skipNamingValidation,proto3" json:"skip_naming_validation,omitempty"`

}

Metadata for global schema behavior.

func (*DocumentSchema_Metadata) Descriptor

func (*DocumentSchema_Metadata) Descriptor() ([]byte, []int)

Deprecated: Use DocumentSchema_Metadata.ProtoReflect.Descriptor instead.

func (*DocumentSchema_Metadata) GetDocumentAllowMultipleLabels

func (x *DocumentSchema_Metadata) GetDocumentAllowMultipleLabels() bool

func (*DocumentSchema_Metadata) GetDocumentSplitter

func (x *DocumentSchema_Metadata) GetDocumentSplitter() bool

func (*DocumentSchema_Metadata) GetPrefixedNamingOnProperties

func (x *DocumentSchema_Metadata) GetPrefixedNamingOnProperties() bool

func (*DocumentSchema_Metadata) GetSkipNamingValidation

func (x *DocumentSchema_Metadata) GetSkipNamingValidation() bool

func (*DocumentSchema_Metadata) ProtoMessage

func (*DocumentSchema_Metadata) ProtoMessage()

func (*DocumentSchema_Metadata) ProtoReflect

func (x *DocumentSchema_Metadata) ProtoReflect() protoreflect.Message

func (*DocumentSchema_Metadata) Reset

func (x *DocumentSchema_Metadata) Reset()

func (*DocumentSchema_Metadata) String

func (x *DocumentSchema_Metadata) String() string

DocumentServiceClient

type DocumentServiceClient interface {
	// Updates metadata associated with a dataset.
	UpdateDataset(ctx context.Context, in *UpdateDatasetRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Import documents into a dataset.
	ImportDocuments(ctx context.Context, in *ImportDocumentsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Returns relevant fields present in the requested document.
	GetDocument(ctx context.Context, in *GetDocumentRequest, opts ...grpc.CallOption) (*GetDocumentResponse, error)
	// Returns a list of documents present in the dataset.
	ListDocuments(ctx context.Context, in *ListDocumentsRequest, opts ...grpc.CallOption) (*ListDocumentsResponse, error)
	// Deletes a set of documents.
	BatchDeleteDocuments(ctx context.Context, in *BatchDeleteDocumentsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets the `DatasetSchema` of a `Dataset`.
	GetDatasetSchema(ctx context.Context, in *GetDatasetSchemaRequest, opts ...grpc.CallOption) (*DatasetSchema, error)
	// Updates a `DatasetSchema`.
	UpdateDatasetSchema(ctx context.Context, in *UpdateDatasetSchemaRequest, opts ...grpc.CallOption) (*DatasetSchema, error)
}

DocumentServiceClient is the client API for DocumentService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewDocumentServiceClient

func NewDocumentServiceClient(cc grpc.ClientConnInterface) DocumentServiceClient

DocumentServiceServer

type DocumentServiceServer interface {
	// Updates metadata associated with a dataset.
	UpdateDataset(context.Context, *UpdateDatasetRequest) (*longrunningpb.Operation, error)
	// Import documents into a dataset.
	ImportDocuments(context.Context, *ImportDocumentsRequest) (*longrunningpb.Operation, error)
	// Returns relevant fields present in the requested document.
	GetDocument(context.Context, *GetDocumentRequest) (*GetDocumentResponse, error)
	// Returns a list of documents present in the dataset.
	ListDocuments(context.Context, *ListDocumentsRequest) (*ListDocumentsResponse, error)
	// Deletes a set of documents.
	BatchDeleteDocuments(context.Context, *BatchDeleteDocumentsRequest) (*longrunningpb.Operation, error)
	// Gets the `DatasetSchema` of a `Dataset`.
	GetDatasetSchema(context.Context, *GetDatasetSchemaRequest) (*DatasetSchema, error)
	// Updates a `DatasetSchema`.
	UpdateDatasetSchema(context.Context, *UpdateDatasetSchemaRequest) (*DatasetSchema, error)
}

DocumentServiceServer is the server API for DocumentService service.

Document_Content

type Document_Content struct {
	// Optional. Inline document content, represented as a stream of bytes.
	// Note: As with all `bytes` fields, protobuffers use a pure binary
	// representation, whereas JSON representations use base64.
	Content []byte `protobuf:"bytes,2,opt,name=content,proto3,oneof"`
}

Document_Entity

type Document_Entity struct {

	// Optional. Provenance of the entity.
	// Text anchor indexing into the
	// [Document.text][google.cloud.documentai.v1beta3.Document.text].
	TextAnchor *Document_TextAnchor `protobuf:"bytes,1,opt,name=text_anchor,json=textAnchor,proto3" json:"text_anchor,omitempty"`
	// Required. Entity type from a schema e.g. `Address`.
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.
	MentionText string `protobuf:"bytes,3,opt,name=mention_text,json=mentionText,proto3" json:"mention_text,omitempty"`
	// Optional. Deprecated.  Use `id` field instead.
	MentionId string `protobuf:"bytes,4,opt,name=mention_id,json=mentionId,proto3" json:"mention_id,omitempty"`
	// Optional. Confidence of detected Schema entity. Range `[0, 1]`.
	Confidence float32 `protobuf:"fixed32,5,opt,name=confidence,proto3" json:"confidence,omitempty"`
	// Optional. Represents the provenance of this entity wrt. the location on
	// the page where it was found.
	PageAnchor *Document_PageAnchor `protobuf:"bytes,6,opt,name=page_anchor,json=pageAnchor,proto3" json:"page_anchor,omitempty"`
	// Optional. Canonical id. This will be a unique value in the entity list
	// for this document.
	Id string `protobuf:"bytes,7,opt,name=id,proto3" json:"id,omitempty"`
	// Optional. Normalized entity value. Absent if the extracted value could
	// not be converted or the type (e.g. address) is not supported for certain
	// parsers. This field is also only populated for certain supported document
	// types.
	NormalizedValue *Document_Entity_NormalizedValue `protobuf:"bytes,9,opt,name=normalized_value,json=normalizedValue,proto3" json:"normalized_value,omitempty"`
	// Optional. Entities can be nested to form a hierarchical data structure
	// representing the content in the document.
	Properties []*Document_Entity `protobuf:"bytes,10,rep,name=properties,proto3" json:"properties,omitempty"`
	// Optional. The history of this annotation.
	Provenance *Document_Provenance `protobuf:"bytes,11,opt,name=provenance,proto3" json:"provenance,omitempty"`
	// Optional. Whether the entity will be redacted for de-identification
	// purposes.
	Redacted bool `protobuf:"varint,12,opt,name=redacted,proto3" json:"redacted,omitempty"`
	// contains filtered or unexported fields
}

An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.

func (*Document_Entity) Descriptor

func (*Document_Entity) Descriptor() ([]byte, []int)

Deprecated: Use Document_Entity.ProtoReflect.Descriptor instead.

func (*Document_Entity) GetConfidence

func (x *Document_Entity) GetConfidence() float32

func (*Document_Entity) GetId

func (x *Document_Entity) GetId() string

func (*Document_Entity) GetMentionId

func (x *Document_Entity) GetMentionId() string

func (*Document_Entity) GetMentionText

func (x *Document_Entity) GetMentionText() string

func (*Document_Entity) GetNormalizedValue

func (x *Document_Entity) GetNormalizedValue() *Document_Entity_NormalizedValue

func (*Document_Entity) GetPageAnchor

func (x *Document_Entity) GetPageAnchor() *Document_PageAnchor

func (*Document_Entity) GetProperties

func (x *Document_Entity) GetProperties() []*Document_Entity

func (*Document_Entity) GetProvenance

func (x *Document_Entity) GetProvenance() *Document_Provenance

func (*Document_Entity) GetRedacted

func (x *Document_Entity) GetRedacted() bool

func (*Document_Entity) GetTextAnchor

func (x *Document_Entity) GetTextAnchor() *Document_TextAnchor

func (*Document_Entity) GetType

func (x *Document_Entity) GetType() string

func (*Document_Entity) ProtoMessage

func (*Document_Entity) ProtoMessage()

func (*Document_Entity) ProtoReflect

func (x *Document_Entity) ProtoReflect() protoreflect.Message

func (*Document_Entity) Reset

func (x *Document_Entity) Reset()

func (*Document_Entity) String

func (x *Document_Entity) String() string

Document_EntityRelation

type Document_EntityRelation struct {

	// Subject entity id.
	SubjectId string `protobuf:"bytes,1,opt,name=subject_id,json=subjectId,proto3" json:"subject_id,omitempty"`
	// Object entity id.
	ObjectId string `protobuf:"bytes,2,opt,name=object_id,json=objectId,proto3" json:"object_id,omitempty"`
	// Relationship description.
	Relation string `protobuf:"bytes,3,opt,name=relation,proto3" json:"relation,omitempty"`
	// contains filtered or unexported fields
}

Relationship between [Entities][google.cloud.documentai.v1beta3.Document.Entity].

func (*Document_EntityRelation) Descriptor

func (*Document_EntityRelation) Descriptor() ([]byte, []int)

Deprecated: Use Document_EntityRelation.ProtoReflect.Descriptor instead.

func (*Document_EntityRelation) GetObjectId

func (x *Document_EntityRelation) GetObjectId() string

func (*Document_EntityRelation) GetRelation

func (x *Document_EntityRelation) GetRelation() string

func (*Document_EntityRelation) GetSubjectId

func (x *Document_EntityRelation) GetSubjectId() string

func (*Document_EntityRelation) ProtoMessage

func (*Document_EntityRelation) ProtoMessage()

func (*Document_EntityRelation) ProtoReflect

func (x *Document_EntityRelation) ProtoReflect() protoreflect.Message

func (*Document_EntityRelation) Reset

func (x *Document_EntityRelation) Reset()

func (*Document_EntityRelation) String

func (x *Document_EntityRelation) String() string

Document_Entity_NormalizedValue

type Document_Entity_NormalizedValue struct {

	// An optional structured entity value.
	// Must match entity type defined in schema if
	// known. If this field is present, the `text` field could also be
	// populated.
	//
	// Types that are assignable to StructuredValue:
	//
	//	*Document_Entity_NormalizedValue_MoneyValue
	//	*Document_Entity_NormalizedValue_DateValue
	//	*Document_Entity_NormalizedValue_DatetimeValue
	//	*Document_Entity_NormalizedValue_AddressValue
	//	*Document_Entity_NormalizedValue_BooleanValue
	//	*Document_Entity_NormalizedValue_IntegerValue
	//	*Document_Entity_NormalizedValue_FloatValue
	StructuredValue isDocument_Entity_NormalizedValue_StructuredValue `protobuf_oneof:"structured_value"`
	// Optional. An optional field to store a normalized string.
	// For some entity types, one of respective `structured_value` fields may
	// also be populated. Also not all the types of `structured_value` will be
	// normalized. For example, some processors may not generate `float`
	// or `integer` normalized text by default.
	//
	// Below are sample formats mapped to structured values.
	//
	// - Money/Currency type (`money_value`) is in the ISO 4217 text format.
	// - Date type (`date_value`) is in the ISO 8601 text format.
	// - Datetime type (`datetime_value`) is in the ISO 8601 text format.
	Text string `protobuf:"bytes,1,opt,name=text,proto3" json:"text,omitempty"`
	// contains filtered or unexported fields
}

Parsed and normalized entity value.

func (*Document_Entity_NormalizedValue) Descriptor

func (*Document_Entity_NormalizedValue) Descriptor() ([]byte, []int)

Deprecated: Use Document_Entity_NormalizedValue.ProtoReflect.Descriptor instead.

func (*Document_Entity_NormalizedValue) GetAddressValue

func (*Document_Entity_NormalizedValue) GetBooleanValue

func (x *Document_Entity_NormalizedValue) GetBooleanValue() bool

func (*Document_Entity_NormalizedValue) GetDateValue

func (x *Document_Entity_NormalizedValue) GetDateValue() *date.Date

func (*Document_Entity_NormalizedValue) GetDatetimeValue

func (x *Document_Entity_NormalizedValue) GetDatetimeValue() *datetime.DateTime

func (*Document_Entity_NormalizedValue) GetFloatValue

func (x *Document_Entity_NormalizedValue) GetFloatValue() float32

func (*Document_Entity_NormalizedValue) GetIntegerValue

func (x *Document_Entity_NormalizedValue) GetIntegerValue() int32

func (*Document_Entity_NormalizedValue) GetMoneyValue

func (x *Document_Entity_NormalizedValue) GetMoneyValue() *money.Money

func (*Document_Entity_NormalizedValue) GetStructuredValue

func (m *Document_Entity_NormalizedValue) GetStructuredValue() isDocument_Entity_NormalizedValue_StructuredValue

func (*Document_Entity_NormalizedValue) GetText

func (*Document_Entity_NormalizedValue) ProtoMessage

func (*Document_Entity_NormalizedValue) ProtoMessage()

func (*Document_Entity_NormalizedValue) ProtoReflect

func (*Document_Entity_NormalizedValue) Reset

func (*Document_Entity_NormalizedValue) String

Document_Entity_NormalizedValue_AddressValue

type Document_Entity_NormalizedValue_AddressValue struct {
	// Postal address. See also:
	// https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
	AddressValue *postaladdress.PostalAddress `protobuf:"bytes,5,opt,name=address_value,json=addressValue,proto3,oneof"`
}

Document_Entity_NormalizedValue_BooleanValue

type Document_Entity_NormalizedValue_BooleanValue struct {
	// Boolean value. Can be used for entities with binary values, or for
	// checkboxes.
	BooleanValue bool `protobuf:"varint,6,opt,name=boolean_value,json=booleanValue,proto3,oneof"`
}

Document_Entity_NormalizedValue_DateValue

type Document_Entity_NormalizedValue_DateValue struct {
	// Date value. Includes year, month, day. See also:
	// https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
	DateValue *date.Date `protobuf:"bytes,3,opt,name=date_value,json=dateValue,proto3,oneof"`
}

Document_Entity_NormalizedValue_DatetimeValue

type Document_Entity_NormalizedValue_DatetimeValue struct {
	// DateTime value. Includes date, time, and timezone. See also:
	// https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
	DatetimeValue *datetime.DateTime `protobuf:"bytes,4,opt,name=datetime_value,json=datetimeValue,proto3,oneof"`
}

Document_Entity_NormalizedValue_FloatValue

type Document_Entity_NormalizedValue_FloatValue struct {
	// Float value.
	FloatValue float32 `protobuf:"fixed32,8,opt,name=float_value,json=floatValue,proto3,oneof"`
}

Document_Entity_NormalizedValue_IntegerValue

type Document_Entity_NormalizedValue_IntegerValue struct {
	// Integer value.
	IntegerValue int32 `protobuf:"varint,7,opt,name=integer_value,json=integerValue,proto3,oneof"`
}

Document_Entity_NormalizedValue_MoneyValue

type Document_Entity_NormalizedValue_MoneyValue struct {
	// Money value. See also:
	// https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
	MoneyValue *money.Money `protobuf:"bytes,2,opt,name=money_value,json=moneyValue,proto3,oneof"`
}

Document_Page

type Document_Page struct {

	// 1-based index for current
	// [Page][google.cloud.documentai.v1beta3.Document.Page] in a parent
	// [Document][google.cloud.documentai.v1beta3.Document]. Useful when a page
	// is taken out of a [Document][google.cloud.documentai.v1beta3.Document]
	// for individual processing.
	PageNumber int32 `protobuf:"varint,1,opt,name=page_number,json=pageNumber,proto3" json:"page_number,omitempty"`
	// Rendered image for this page. This image is preprocessed to remove any
	// skew, rotation, and distortions such that the annotation bounding boxes
	// can be upright and axis-aligned.
	Image *Document_Page_Image `protobuf:"bytes,13,opt,name=image,proto3" json:"image,omitempty"`
	// Transformation matrices that were applied to the original document image
	// to produce
	// [Page.image][google.cloud.documentai.v1beta3.Document.Page.image].
	Transforms []*Document_Page_Matrix `protobuf:"bytes,14,rep,name=transforms,proto3" json:"transforms,omitempty"`
	// Physical dimension of the page.
	Dimension *Document_Page_Dimension `protobuf:"bytes,2,opt,name=dimension,proto3" json:"dimension,omitempty"`
	// [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the
	// page.
	Layout *Document_Page_Layout `protobuf:"bytes,3,opt,name=layout,proto3" json:"layout,omitempty"`
	// A list of detected languages together with confidence.
	DetectedLanguages []*Document_Page_DetectedLanguage `protobuf:"bytes,4,rep,name=detected_languages,json=detectedLanguages,proto3" json:"detected_languages,omitempty"`
	// A list of visually detected text blocks on the page.
	// A block has a set of lines (collected into paragraphs) that have a common
	// line-spacing and orientation.
	Blocks []*Document_Page_Block `protobuf:"bytes,5,rep,name=blocks,proto3" json:"blocks,omitempty"`
	// A list of visually detected text paragraphs on the page.
	// A collection of lines that a human would perceive as a paragraph.
	Paragraphs []*Document_Page_Paragraph `protobuf:"bytes,6,rep,name=paragraphs,proto3" json:"paragraphs,omitempty"`
	// A list of visually detected text lines on the page.
	// A collection of tokens that a human would perceive as a line.
	Lines []*Document_Page_Line `protobuf:"bytes,7,rep,name=lines,proto3" json:"lines,omitempty"`
	// A list of visually detected tokens on the page.
	Tokens []*Document_Page_Token `protobuf:"bytes,8,rep,name=tokens,proto3" json:"tokens,omitempty"`
	// A list of detected non-text visual elements e.g. checkbox,
	// signature etc. on the page.
	VisualElements []*Document_Page_VisualElement `protobuf:"bytes,9,rep,name=visual_elements,json=visualElements,proto3" json:"visual_elements,omitempty"`
	// A list of visually detected tables on the page.
	Tables []*Document_Page_Table `protobuf:"bytes,10,rep,name=tables,proto3" json:"tables,omitempty"`
	// A list of visually detected form fields on the page.
	FormFields []*Document_Page_FormField `protobuf:"bytes,11,rep,name=form_fields,json=formFields,proto3" json:"form_fields,omitempty"`
	// A list of visually detected symbols on the page.
	Symbols []*Document_Page_Symbol `protobuf:"bytes,12,rep,name=symbols,proto3" json:"symbols,omitempty"`
	// A list of detected barcodes.
	DetectedBarcodes []*Document_Page_DetectedBarcode `protobuf:"bytes,15,rep,name=detected_barcodes,json=detectedBarcodes,proto3" json:"detected_barcodes,omitempty"`
	// Image quality scores.
	ImageQualityScores *Document_Page_ImageQualityScores `protobuf:"bytes,17,opt,name=image_quality_scores,json=imageQualityScores,proto3" json:"image_quality_scores,omitempty"`
	// The history of this page.
	//
	// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.
	Provenance *Document_Provenance `protobuf:"bytes,16,opt,name=provenance,proto3" json:"provenance,omitempty"`
	// contains filtered or unexported fields
}

A page in a [Document][google.cloud.documentai.v1beta3.Document].

func (*Document_Page) Descriptor

func (*Document_Page) Descriptor() ([]byte, []int)

Deprecated: Use Document_Page.ProtoReflect.Descriptor instead.

func (*Document_Page) GetBlocks

func (x *Document_Page) GetBlocks() []*Document_Page_Block

func (*Document_Page) GetDetectedBarcodes

func (x *Document_Page) GetDetectedBarcodes() []*Document_Page_DetectedBarcode

func (*Document_Page) GetDetectedLanguages

func (x *Document_Page) GetDetectedLanguages() []*Document_Page_DetectedLanguage

func (*Document_Page) GetDimension

func (x *Document_Page) GetDimension() *Document_Page_Dimension

func (*Document_Page) GetFormFields

func (x *Document_Page) GetFormFields() []*Document_Page_FormField

func (*Document_Page) GetImage

func (x *Document_Page) GetImage() *Document_Page_Image

func (*Document_Page) GetImageQualityScores

func (x *Document_Page) GetImageQualityScores() *Document_Page_ImageQualityScores

func (*Document_Page) GetLayout

func (x *Document_Page) GetLayout() *Document_Page_Layout

func (*Document_Page) GetLines

func (x *Document_Page) GetLines() []*Document_Page_Line

func (*Document_Page) GetPageNumber

func (x *Document_Page) GetPageNumber() int32

func (*Document_Page) GetParagraphs

func (x *Document_Page) GetParagraphs() []*Document_Page_Paragraph

func (*Document_Page) GetProvenance

func (x *Document_Page) GetProvenance() *Document_Provenance

Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.

func (*Document_Page) GetSymbols

func (x *Document_Page) GetSymbols() []*Document_Page_Symbol

func (*Document_Page) GetTables

func (x *Document_Page) GetTables() []*Document_Page_Table

func (*Document_Page) GetTokens

func (x *Document_Page) GetTokens() []*Document_Page_Token

func (*Document_Page) GetTransforms

func (x *Document_Page) GetTransforms() []*Document_Page_Matrix

func (*Document_Page) GetVisualElements

func (x *Document_Page) GetVisualElements() []*Document_Page_VisualElement

func (*Document_Page) ProtoMessage

func (*Document_Page) ProtoMessage()

func (*Document_Page) ProtoReflect

func (x *Document_Page) ProtoReflect() protoreflect.Message

func (*Document_Page) Reset

func (x *Document_Page) Reset()

func (*Document_Page) String

func (x *Document_Page) String() string

Document_PageAnchor

type Document_PageAnchor struct {

	// One or more references to visual page elements
	PageRefs []*Document_PageAnchor_PageRef `protobuf:"bytes,1,rep,name=page_refs,json=pageRefs,proto3" json:"page_refs,omitempty"`
	// contains filtered or unexported fields
}

Referencing the visual context of the entity in the [Document.pages][google.cloud.documentai.v1beta3.Document.pages]. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types.

func (*Document_PageAnchor) Descriptor

func (*Document_PageAnchor) Descriptor() ([]byte, []int)

Deprecated: Use Document_PageAnchor.ProtoReflect.Descriptor instead.

func (*Document_PageAnchor) GetPageRefs

func (*Document_PageAnchor) ProtoMessage

func (*Document_PageAnchor) ProtoMessage()

func (*Document_PageAnchor) ProtoReflect

func (x *Document_PageAnchor) ProtoReflect() protoreflect.Message

func (*Document_PageAnchor) Reset

func (x *Document_PageAnchor) Reset()

func (*Document_PageAnchor) String

func (x *Document_PageAnchor) String() string

Document_PageAnchor_PageRef

type Document_PageAnchor_PageRef struct {
	Page int64 `protobuf:"varint,1,opt,name=page,proto3" json:"page,omitempty"`

	LayoutType Document_PageAnchor_PageRef_LayoutType "" /* 168 byte string literal not displayed */

	LayoutId string `protobuf:"bytes,3,opt,name=layout_id,json=layoutId,proto3" json:"layout_id,omitempty"`

	BoundingPoly *BoundingPoly `protobuf:"bytes,4,opt,name=bounding_poly,json=boundingPoly,proto3" json:"bounding_poly,omitempty"`

	Confidence float32 `protobuf:"fixed32,5,opt,name=confidence,proto3" json:"confidence,omitempty"`

}

Represents a weak reference to a page element within a document.

func (*Document_PageAnchor_PageRef) Descriptor

func (*Document_PageAnchor_PageRef) Descriptor() ([]byte, []int)

Deprecated: Use Document_PageAnchor_PageRef.ProtoReflect.Descriptor instead.

func (*Document_PageAnchor_PageRef) GetBoundingPoly

func (x *Document_PageAnchor_PageRef) GetBoundingPoly() *BoundingPoly

func (*Document_PageAnchor_PageRef) GetConfidence

func (x *Document_PageAnchor_PageRef) GetConfidence() float32

func (*Document_PageAnchor_PageRef) GetLayoutId

func (x *Document_PageAnchor_PageRef) GetLayoutId() string

Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.

func (*Document_PageAnchor_PageRef) GetLayoutType

func (*Document_PageAnchor_PageRef) GetPage

func (x *Document_PageAnchor_PageRef) GetPage() int64

func (*Document_PageAnchor_PageRef) ProtoMessage

func (*Document_PageAnchor_PageRef) ProtoMessage()

func (*Document_PageAnchor_PageRef) ProtoReflect

func (*Document_PageAnchor_PageRef) Reset

func (x *Document_PageAnchor_PageRef) Reset()

func (*Document_PageAnchor_PageRef) String

func (x *Document_PageAnchor_PageRef) String() string

Document_PageAnchor_PageRef_LayoutType

type Document_PageAnchor_PageRef_LayoutType int32

The type of layout that is being referenced.

Document_PageAnchor_PageRef_LAYOUT_TYPE_UNSPECIFIED, Document_PageAnchor_PageRef_BLOCK, Document_PageAnchor_PageRef_PARAGRAPH, Document_PageAnchor_PageRef_LINE, Document_PageAnchor_PageRef_TOKEN, Document_PageAnchor_PageRef_VISUAL_ELEMENT, Document_PageAnchor_PageRef_TABLE, Document_PageAnchor_PageRef_FORM_FIELD

const (
	// Layout Unspecified.
	Document_PageAnchor_PageRef_LAYOUT_TYPE_UNSPECIFIED Document_PageAnchor_PageRef_LayoutType = 0
	// References a
	// [Page.blocks][google.cloud.documentai.v1beta3.Document.Page.blocks]
	// element.
	Document_PageAnchor_PageRef_BLOCK Document_PageAnchor_PageRef_LayoutType = 1
	// References a
	// [Page.paragraphs][google.cloud.documentai.v1beta3.Document.Page.paragraphs]
	// element.
	Document_PageAnchor_PageRef_PARAGRAPH Document_PageAnchor_PageRef_LayoutType = 2
	// References a
	// [Page.lines][google.cloud.documentai.v1beta3.Document.Page.lines]
	// element.
	Document_PageAnchor_PageRef_LINE Document_PageAnchor_PageRef_LayoutType = 3
	// References a
	// [Page.tokens][google.cloud.documentai.v1beta3.Document.Page.tokens]
	// element.
	Document_PageAnchor_PageRef_TOKEN Document_PageAnchor_PageRef_LayoutType = 4
	// References a
	// [Page.visual_elements][google.cloud.documentai.v1beta3.Document.Page.visual_elements]
	// element.
	Document_PageAnchor_PageRef_VISUAL_ELEMENT Document_PageAnchor_PageRef_LayoutType = 5
	// Refrrences a
	// [Page.tables][google.cloud.documentai.v1beta3.Document.Page.tables]
	// element.
	Document_PageAnchor_PageRef_TABLE Document_PageAnchor_PageRef_LayoutType = 6
	// References a
	// [Page.form_fields][google.cloud.documentai.v1beta3.Document.Page.form_fields]
	// element.
	Document_PageAnchor_PageRef_FORM_FIELD Document_PageAnchor_PageRef_LayoutType = 7
)

func (Document_PageAnchor_PageRef_LayoutType) Descriptor

func (Document_PageAnchor_PageRef_LayoutType) Enum

func (Document_PageAnchor_PageRef_LayoutType) EnumDescriptor

func (Document_PageAnchor_PageRef_LayoutType) EnumDescriptor() ([]byte, []int)

Deprecated: Use Document_PageAnchor_PageRef_LayoutType.Descriptor instead.

func (Document_PageAnchor_PageRef_LayoutType) Number

func (Document_PageAnchor_PageRef_LayoutType) String

func (Document_PageAnchor_PageRef_LayoutType) Type

Document_Page_Block

type Document_Page_Block struct {

	// [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for
	// [Block][google.cloud.documentai.v1beta3.Document.Page.Block].
	Layout *Document_Page_Layout `protobuf:"bytes,1,opt,name=layout,proto3" json:"layout,omitempty"`
	// A list of detected languages together with confidence.
	DetectedLanguages []*Document_Page_DetectedLanguage `protobuf:"bytes,2,rep,name=detected_languages,json=detectedLanguages,proto3" json:"detected_languages,omitempty"`
	// The history of this annotation.
	//
	// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.
	Provenance *Document_Provenance `protobuf:"bytes,3,opt,name=provenance,proto3" json:"provenance,omitempty"`
	// contains filtered or unexported fields
}

A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.

func (*Document_Page_Block) Descriptor

func (*Document_Page_Block) Descriptor() ([]byte, []int)

Deprecated: Use Document_Page_Block.ProtoReflect.Descriptor instead.

func (*Document_Page_Block) GetDetectedLanguages

func (x *Document_Page_Block) GetDetectedLanguages() []*Document_Page_DetectedLanguage

func (*Document_Page_Block) GetLayout

func (x *Document_Page_Block) GetLayout() *Document_Page_Layout

func (*Document_Page_Block) GetProvenance

func (x *Document_Page_Block) GetProvenance() *Document_Provenance

Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.

func (*Document_Page_Block) ProtoMessage

func (*Document_Page_Block) ProtoMessage()

func (*Document_Page_Block) ProtoReflect

func (x *Document_Page_Block) ProtoReflect() protoreflect.Message

func (*Document_Page_Block) Reset

func (x *Document_Page_Block) Reset()

func (*Document_Page_Block) String

func (x *Document_Page_Block) String() string

Document_Page_DetectedBarcode

type Document_Page_DetectedBarcode struct {

	// [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for
	// [DetectedBarcode][google.cloud.documentai.v1beta3.Document.Page.DetectedBarcode].
	Layout *Document_Page_Layout `protobuf:"bytes,1,opt,name=layout,proto3" json:"layout,omitempty"`
	// Detailed barcode information of the
	// [DetectedBarcode][google.cloud.documentai.v1beta3.Document.Page.DetectedBarcode].
	Barcode *Barcode `protobuf:"bytes,2,opt,name=barcode,proto3" json:"barcode,omitempty"`
	// contains filtered or unexported fields
}

A detected barcode.

func (*Document_Page_DetectedBarcode) Descriptor

func (*Document_Page_DetectedBarcode) Descriptor() ([]byte, []int)

Deprecated: Use Document_Page_DetectedBarcode.ProtoReflect.Descriptor instead.

func (*Document_Page_DetectedBarcode) GetBarcode

func (x *Document_Page_DetectedBarcode) GetBarcode() *Barcode

func (*Document_Page_DetectedBarcode) GetLayout

func (*Document_Page_DetectedBarcode) ProtoMessage

func (*Document_Page_DetectedBarcode) ProtoMessage()

func (*Document_Page_DetectedBarcode) ProtoReflect

func (*Document_Page_DetectedBarcode) Reset

func (x *Document_Page_DetectedBarcode) Reset()

func (*Document_Page_DetectedBarcode) String

Document_Page_DetectedLanguage

type Document_Page_DetectedLanguage struct {

	// The [BCP-47 language
	// code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier),
	// such as `en-US` or `sr-Latn`.
	LanguageCode string `protobuf:"bytes,1,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
	// Confidence of detected language. Range `[0, 1]`.
	Confidence float32 `protobuf:"fixed32,2,opt,name=confidence,proto3" json:"confidence,omitempty"`
	// contains filtered or unexported fields
}

Detected language for a structural component.

func (*Document_Page_DetectedLanguage) Descriptor

func (*Document_Page_DetectedLanguage) Descriptor() ([]byte, []int)

Deprecated: Use Document_Page_DetectedLanguage.ProtoReflect.Descriptor instead.

func (*Document_Page_DetectedLanguage) GetConfidence

func (x *Document_Page_DetectedLanguage) GetConfidence() float32

func (*Document_Page_DetectedLanguage) GetLanguageCode

func (x *Document_Page_DetectedLanguage) GetLanguageCode() string

func (*Document_Page_DetectedLanguage) ProtoMessage

func (*Document_Page_DetectedLanguage) ProtoMessage()

func (*Document_Page_DetectedLanguage) ProtoReflect

func (*Document_Page_DetectedLanguage) Reset

func (x *Document_Page_DetectedLanguage) Reset()

func (*Document_Page_DetectedLanguage) String

Document_Page_Dimension

type Document_Page_Dimension struct {

	// Page width.
	Width float32 `protobuf:"fixed32,1,opt,name=width,proto3" json:"width,omitempty"`
	// Page height.
	Height float32 `protobuf:"fixed32,2,opt,name=height,proto3" json:"height,omitempty"`
	// Dimension unit.
	Unit string `protobuf:"bytes,3,opt,name=unit,proto3" json:"unit,omitempty"`
	// contains filtered or unexported fields
}

Dimension for the page.

func (*Document_Page_Dimension) Descriptor

func (*Document_Page_Dimension) Descriptor() ([]byte, []int)

Deprecated: Use Document_Page_Dimension.ProtoReflect.Descriptor instead.

func (*Document_Page_Dimension) GetHeight

func (x *Document_Page_Dimension) GetHeight() float32

func (*Document_Page_Dimension) GetUnit

func (x *Document_Page_Dimension) GetUnit() string

func (*Document_Page_Dimension) GetWidth

func (x *Document_Page_Dimension) GetWidth() float32

func (*Document_Page_Dimension) ProtoMessage

func (*Document_Page_Dimension) ProtoMessage()

func (*Document_Page_Dimension) ProtoReflect

func (x *Document_Page_Dimension) ProtoReflect() protoreflect.Message

func (*Document_Page_Dimension) Reset

func (x *Document_Page_Dimension) Reset()

func (*Document_Page_Dimension) String

func (x *Document_Page_Dimension) String() string

Document_Page_FormField

type Document_Page_FormField struct {
	FieldName *Document_Page_Layout `protobuf:"bytes,1,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`

	FieldValue *Document_Page_Layout `protobuf:"bytes,2,opt,name=field_value,json=fieldValue,proto3" json:"field_value,omitempty"`

	NameDetectedLanguages []*Document_Page_DetectedLanguage `protobuf:"bytes,3,rep,name=name_detected_languages,json=nameDetectedLanguages,proto3" json:"name_detected_languages,omitempty"`

	ValueDetectedLanguages []*Document_Page_DetectedLanguage "" /* 129 byte string literal not displayed */

	ValueType string `protobuf:"bytes,5,opt,name=value_type,json=valueType,proto3" json:"value_type,omitempty"`

	CorrectedKeyText string `protobuf:"bytes,6,opt,name=corrected_key_text,json=correctedKeyText,proto3" json:"corrected_key_text,omitempty"`

	CorrectedValueText string `protobuf:"bytes,7,opt,name=corrected_value_text,json=correctedValueText,proto3" json:"corrected_value_text,omitempty"`

	Provenance *Document_Provenance `protobuf:"bytes,8,opt,name=provenance,proto3" json:"provenance,omitempty"`

}

A form field detected on the page.

func (*Document_Page_FormField) Descriptor

func (*Document_Page_FormField) Descriptor() ([]byte, []int)

Deprecated: Use Document_Page_FormField.ProtoReflect.Descriptor instead.

func (*Document_Page_FormField) GetCorrectedKeyText

func (x *Document_Page_FormField) GetCorrectedKeyText() string

func (*Document_Page_FormField) GetCorrectedValueText

func (x *Document_Page_FormField) GetCorrectedValueText() string

func (*Document_Page_FormField) GetFieldName

func (x *Document_Page_FormField) GetFieldName() *Document_Page_Layout

func (*Document_Page_FormField) GetFieldValue

func (x *Document_Page_FormField) GetFieldValue() *Document_Page_Layout

func (*Document_Page_FormField) GetNameDetectedLanguages

func (x *Document_Page_FormField) GetNameDetectedLanguages() []*Document_Page_DetectedLanguage

func (*Document_Page_FormField) GetProvenance

func (x *Document_Page_FormField) GetProvenance() *Document_Provenance

func (*Document_Page_FormField) GetValueDetectedLanguages

func (x *Document_Page_FormField) GetValueDetectedLanguages() []*Document_Page_DetectedLanguage

func (*Document_Page_FormField) GetValueType

func (x *Document_Page_FormField) GetValueType() string

func (*Document_Page_FormField) ProtoMessage

func (*Document_Page_FormField) ProtoMessage()

func (*Document_Page_FormField) ProtoReflect

func (x *Document_Page_FormField) ProtoReflect() protoreflect.Message

func (*Document_Page_FormField) Reset

func (x *Document_Page_FormField) Reset()

func (*Document_Page_FormField) String

func (x *Document_Page_FormField) String() string

Document_Page_Image

type Document_Page_Image struct {

	// Raw byte content of the image.
	Content []byte `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"`
	// Encoding [media type (MIME
	// type)](https://www.iana.org/assignments/media-types/media-types.xhtml)
	// for the image.
	MimeType string `protobuf:"bytes,2,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// Width of the image in pixels.
	Width int32 `protobuf:"varint,3,opt,name=width,proto3" json:"width,omitempty"`
	// Height of the image in pixels.
	Height int32 `protobuf:"varint,4,opt,name=height,proto3" json:"height,omitempty"`
	// contains filtered or unexported fields
}

Rendered image contents for this page.

func (*Document_Page_Image) Descriptor

func (*Document_Page_Image) Descriptor() ([]byte, []int)

Deprecated: Use Document_Page_Image.ProtoReflect.Descriptor instead.

func (*Document_Page_Image) GetContent

func (x *Document_Page_Image) GetContent() []byte

func (*Document_Page_Image) GetHeight

func (x *Document_Page_Image) GetHeight() int32

func (*Document_Page_Image) GetMimeType

func (x *Document_Page_Image) GetMimeType() string

func (*Document_Page_Image) GetWidth

func (x *Document_Page_Image) GetWidth() int32

func (*Document_Page_Image) ProtoMessage

func (*Document_Page_Image) ProtoMessage()

func (*Document_Page_Image) ProtoReflect

func (x *Document_Page_Image) ProtoReflect() protoreflect.Message

func (*Document_Page_Image) Reset

func (x *Document_Page_Image) Reset()

func (*Document_Page_Image) String

func (x *Document_Page_Image) String() string

Document_Page_ImageQualityScores

type Document_Page_ImageQualityScores struct {

	// The overall quality score. Range `[0, 1]` where `1` is perfect quality.
	QualityScore float32 `protobuf:"fixed32,1,opt,name=quality_score,json=qualityScore,proto3" json:"quality_score,omitempty"`
	// A list of detected defects.
	DetectedDefects []*Document_Page_ImageQualityScores_DetectedDefect `protobuf:"bytes,2,rep,name=detected_defects,json=detectedDefects,proto3" json:"detected_defects,omitempty"`
	// contains filtered or unexported fields
}

Image quality scores for the page image.

func (*Document_Page_ImageQualityScores) Descriptor

func (*Document_Page_ImageQualityScores) Descriptor() ([]byte, []int)

Deprecated: Use Document_Page_ImageQualityScores.ProtoReflect.Descriptor instead.

func (*Document_Page_ImageQualityScores) GetDetectedDefects

func (*Document_Page_ImageQualityScores) GetQualityScore

func (x *Document_Page_ImageQualityScores) GetQualityScore() float32

func (*Document_Page_ImageQualityScores) ProtoMessage

func (*Document_Page_ImageQualityScores) ProtoMessage()

func (*Document_Page_ImageQualityScores) ProtoReflect

func (*Document_Page_ImageQualityScores) Reset

func (*Document_Page_ImageQualityScores) String

Document_Page_ImageQualityScores_DetectedDefect

type Document_Page_ImageQualityScores_DetectedDefect struct {

	// Name of the defect type. Supported values are:
	//
	// - `quality/defect_blurry`
	// - `quality/defect_noisy`
	// - `quality/defect_dark`
	// - `quality/defect_faint`
	// - `quality/defect_text_too_small`
	// - `quality/defect_document_cutoff`
	// - `quality/defect_text_cutoff`
	// - `quality/defect_glare`
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// Confidence of detected defect. Range `[0, 1]` where `1` indicates
	// strong confidence that the defect exists.
	Confidence float32 `protobuf:"fixed32,2,opt,name=confidence,proto3" json:"confidence,omitempty"`
	// contains filtered or unexported fields
}

Image Quality Defects

func (*Document_Page_ImageQualityScores_DetectedDefect) Descriptor

Deprecated: Use Document_Page_ImageQualityScores_DetectedDefect.ProtoReflect.Descriptor instead.

func (*Document_Page_ImageQualityScores_DetectedDefect) GetConfidence

func (*Document_Page_ImageQualityScores_DetectedDefect) GetType

func (*Document_Page_ImageQualityScores_DetectedDefect) ProtoMessage

func (*Document_Page_ImageQualityScores_DetectedDefect) ProtoReflect

func (*Document_Page_ImageQualityScores_DetectedDefect) Reset

func (*Document_Page_ImageQualityScores_DetectedDefect) String

Document_Page_Layout

type Document_Page_Layout struct {
	TextAnchor *Document_TextAnchor `protobuf:"bytes,1,opt,name=text_anchor,json=textAnchor,proto3" json:"text_anchor,omitempty"`

	Confidence float32 `protobuf:"fixed32,2,opt,name=confidence,proto3" json:"confidence,omitempty"`

	BoundingPoly *BoundingPoly `protobuf:"bytes,3,opt,name=bounding_poly,json=boundingPoly,proto3" json:"bounding_poly,omitempty"`

	Orientation Document_Page_Layout_Orientation "" /* 146 byte string literal not displayed */

}

Visual element describing a layout unit on a page.

func (*Document_Page_Layout) Descriptor

func (*Document_Page_Layout) Descriptor() ([]byte, []int)

Deprecated: Use Document_Page_Layout.ProtoReflect.Descriptor instead.

func (*Document_Page_Layout) GetBoundingPoly

func (x *Document_Page_Layout) GetBoundingPoly() *BoundingPoly

func (*Document_Page_Layout) GetConfidence

func (x *Document_Page_Layout) GetConfidence() float32

func (*Document_Page_Layout) GetOrientation

func (*Document_Page_Layout) GetTextAnchor

func (x *Document_Page_Layout) GetTextAnchor() *Document_TextAnchor

func (*Document_Page_Layout) ProtoMessage

func (*Document_Page_Layout) ProtoMessage()

func (*Document_Page_Layout) ProtoReflect

func (x *Document_Page_Layout) ProtoReflect() protoreflect.Message

func (*Document_Page_Layout) Reset

func (x *Document_Page_Layout) Reset()

func (*Document_Page_Layout) String

func (x *Document_Page_Layout) String() string

Document_Page_Layout_Orientation

type Document_Page_Layout_Orientation int32

Detected human reading orientation.

Document_Page_Layout_ORIENTATION_UNSPECIFIED, Document_Page_Layout_PAGE_UP, Document_Page_Layout_PAGE_RIGHT, Document_Page_Layout_PAGE_DOWN, Document_Page_Layout_PAGE_LEFT

const (
	// Unspecified orientation.
	Document_Page_Layout_ORIENTATION_UNSPECIFIED Document_Page_Layout_Orientation = 0
	// Orientation is aligned with page up.
	Document_Page_Layout_PAGE_UP Document_Page_Layout_Orientation = 1
	// Orientation is aligned with page right.
	// Turn the head 90 degrees clockwise from upright to read.
	Document_Page_Layout_PAGE_RIGHT Document_Page_Layout_Orientation = 2
	// Orientation is aligned with page down.
	// Turn the head 180 degrees from upright to read.
	Document_Page_Layout_PAGE_DOWN Document_Page_Layout_Orientation = 3
	// Orientation is aligned with page left.
	// Turn the head 90 degrees counterclockwise from upright to read.
	Document_Page_Layout_PAGE_LEFT Document_Page_Layout_Orientation = 4
)

func (Document_Page_Layout_Orientation) Descriptor

func (Document_Page_Layout_Orientation) Enum

func (Document_Page_Layout_Orientation) EnumDescriptor

func (Document_Page_Layout_Orientation) EnumDescriptor() ([]byte, []int)

Deprecated: Use Document_Page_Layout_Orientation.Descriptor instead.

func (Document_Page_Layout_Orientation) Number

func (Document_Page_Layout_Orientation) String

func (Document_Page_Layout_Orientation) Type

Document_Page_Line

type Document_Page_Line struct {

	// [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for
	// [Line][google.cloud.documentai.v1beta3.Document.Page.Line].
	Layout *Document_Page_Layout `protobuf:"bytes,1,opt,name=layout,proto3" json:"layout,omitempty"`
	// A list of detected languages together with confidence.
	DetectedLanguages []*Document_Page_DetectedLanguage `protobuf:"bytes,2,rep,name=detected_languages,json=detectedLanguages,proto3" json:"detected_languages,omitempty"`
	// The  history of this annotation.
	//
	// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.
	Provenance *Document_Provenance `protobuf:"bytes,3,opt,name=provenance,proto3" json:"provenance,omitempty"`
	// contains filtered or unexported fields
}

A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.

func (*Document_Page_Line) Descriptor

func (*Document_Page_Line) Descriptor() ([]byte, []int)

Deprecated: Use Document_Page_Line.ProtoReflect.Descriptor instead.

func (*Document_Page_Line) GetDetectedLanguages

func (x *Document_Page_Line) GetDetectedLanguages() []*Document_Page_DetectedLanguage

func (*Document_Page_Line) GetLayout

func (x *Document_Page_Line) GetLayout() *Document_Page_Layout

func (*Document_Page_Line) GetProvenance

func (x *Document_Page_Line) GetProvenance() *Document_Provenance

Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.

func (*Document_Page_Line) ProtoMessage

func (*Document_Page_Line) ProtoMessage()

func (*Document_Page_Line) ProtoReflect

func (x *Document_Page_Line) ProtoReflect() protoreflect.Message

func (*Document_Page_Line) Reset

func (x *Document_Page_Line) Reset()

func (*Document_Page_Line) String

func (x *Document_Page_Line) String() string

Document_Page_Matrix

type Document_Page_Matrix struct {

	// Number of rows in the matrix.
	Rows int32 `protobuf:"varint,1,opt,name=rows,proto3" json:"rows,omitempty"`
	// Number of columns in the matrix.
	Cols int32 `protobuf:"varint,2,opt,name=cols,proto3" json:"cols,omitempty"`
	// This encodes information about what data type the matrix uses.
	// For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list
	// of OpenCV primitive data types, please refer to
	// https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html
	Type int32 `protobuf:"varint,3,opt,name=type,proto3" json:"type,omitempty"`
	// The matrix data.
	Data []byte `protobuf:"bytes,4,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.

func (*Document_Page_Matrix) Descriptor

func (*Document_Page_Matrix) Descriptor() ([]byte, []int)

Deprecated: Use Document_Page_Matrix.ProtoReflect.Descriptor instead.

func (*Document_Page_Matrix) GetCols

func (x *Document_Page_Matrix) GetCols() int32

func (*Document_Page_Matrix) GetData

func (x *Document_Page_Matrix) GetData() []byte

func (*Document_Page_Matrix) GetRows

func (x *Document_Page_Matrix) GetRows() int32

func (*Document_Page_Matrix) GetType

func (x *Document_Page_Matrix) GetType() int32

func (*Document_Page_Matrix) ProtoMessage

func (*Document_Page_Matrix) ProtoMessage()

func (*Document_Page_Matrix) ProtoReflect

func (x *Document_Page_Matrix) ProtoReflect() protoreflect.Message

func (*Document_Page_Matrix) Reset

func (x *Document_Page_Matrix) Reset()

func (*Document_Page_Matrix) String

func (x *Document_Page_Matrix) String() string

Document_Page_Paragraph

type Document_Page_Paragraph struct {

	// [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for
	// [Paragraph][google.cloud.documentai.v1beta3.Document.Page.Paragraph].
	Layout *Document_Page_Layout `protobuf:"bytes,1,opt,name=layout,proto3" json:"layout,omitempty"`
	// A list of detected languages together with confidence.
	DetectedLanguages []*Document_Page_DetectedLanguage `protobuf:"bytes,2,rep,name=detected_languages,json=detectedLanguages,proto3" json:"detected_languages,omitempty"`
	// The  history of this annotation.
	//
	// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.
	Provenance *Document_Provenance `protobuf:"bytes,3,opt,name=provenance,proto3" json:"provenance,omitempty"`
	// contains filtered or unexported fields
}

A collection of lines that a human would perceive as a paragraph.

func (*Document_Page_Paragraph) Descriptor

func (*Document_Page_Paragraph) Descriptor() ([]byte, []int)

Deprecated: Use Document_Page_Paragraph.ProtoReflect.Descriptor instead.

func (*Document_Page_Paragraph) GetDetectedLanguages

func (x *Document_Page_Paragraph) GetDetectedLanguages() []*Document_Page_DetectedLanguage

func (*Document_Page_Paragraph) GetLayout

func (*Document_Page_Paragraph) GetProvenance

func (x *Document_Page_Paragraph) GetProvenance() *Document_Provenance

Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.

func (*Document_Page_Paragraph) ProtoMessage

func (*Document_Page_Paragraph) ProtoMessage()

func (*Document_Page_Paragraph) ProtoReflect

func (x *Document_Page_Paragraph) ProtoReflect() protoreflect.Message

func (*Document_Page_Paragraph) Reset

func (x *Document_Page_Paragraph) Reset()

func (*Document_Page_Paragraph) String

func (x *Document_Page_Paragraph) String() string

Document_Page_Symbol

type Document_Page_Symbol struct {

	// [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for
	// [Symbol][google.cloud.documentai.v1beta3.Document.Page.Symbol].
	Layout *Document_Page_Layout `protobuf:"bytes,1,opt,name=layout,proto3" json:"layout,omitempty"`
	// A list of detected languages together with confidence.
	DetectedLanguages []*Document_Page_DetectedLanguage `protobuf:"bytes,2,rep,name=detected_languages,json=detectedLanguages,proto3" json:"detected_languages,omitempty"`
	// contains filtered or unexported fields
}

A detected symbol.

func (*Document_Page_Symbol) Descriptor

func (*Document_Page_Symbol) Descriptor() ([]byte, []int)

Deprecated: Use Document_Page_Symbol.ProtoReflect.Descriptor instead.

func (*Document_Page_Symbol) GetDetectedLanguages

func (x *Document_Page_Symbol) GetDetectedLanguages() []*Document_Page_DetectedLanguage

func (*Document_Page_Symbol) GetLayout

func (*Document_Page_Symbol) ProtoMessage

func (*Document_Page_Symbol) ProtoMessage()

func (*Document_Page_Symbol) ProtoReflect

func (x *Document_Page_Symbol) ProtoReflect() protoreflect.Message

func (*Document_Page_Symbol) Reset

func (x *Document_Page_Symbol) Reset()

func (*Document_Page_Symbol) String

func (x *Document_Page_Symbol) String() string

Document_Page_Table

type Document_Page_Table struct {

	// [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for
	// [Table][google.cloud.documentai.v1beta3.Document.Page.Table].
	Layout *Document_Page_Layout `protobuf:"bytes,1,opt,name=layout,proto3" json:"layout,omitempty"`
	// Header rows of the table.
	HeaderRows []*Document_Page_Table_TableRow `protobuf:"bytes,2,rep,name=header_rows,json=headerRows,proto3" json:"header_rows,omitempty"`
	// Body rows of the table.
	BodyRows []*Document_Page_Table_TableRow `protobuf:"bytes,3,rep,name=body_rows,json=bodyRows,proto3" json:"body_rows,omitempty"`
	// A list of detected languages together with confidence.
	DetectedLanguages []*Document_Page_DetectedLanguage `protobuf:"bytes,4,rep,name=detected_languages,json=detectedLanguages,proto3" json:"detected_languages,omitempty"`
	// The history of this table.
	//
	// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.
	Provenance *Document_Provenance `protobuf:"bytes,5,opt,name=provenance,proto3" json:"provenance,omitempty"`
	// contains filtered or unexported fields
}

A table representation similar to HTML table structure.

func (*Document_Page_Table) Descriptor

func (*Document_Page_Table) Descriptor() ([]byte, []int)

Deprecated: Use Document_Page_Table.ProtoReflect.Descriptor instead.

func (*Document_Page_Table) GetBodyRows

func (*Document_Page_Table) GetDetectedLanguages

func (x *Document_Page_Table) GetDetectedLanguages() []*Document_Page_DetectedLanguage

func (*Document_Page_Table) GetHeaderRows

func (x *Document_Page_Table) GetHeaderRows() []*Document_Page_Table_TableRow

func (*Document_Page_Table) GetLayout

func (x *Document_Page_Table) GetLayout() *Document_Page_Layout

func (*Document_Page_Table) GetProvenance

func (x *Document_Page_Table) GetProvenance() *Document_Provenance

Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.

func (*Document_Page_Table) ProtoMessage

func (*Document_Page_Table) ProtoMessage()

func (*Document_Page_Table) ProtoReflect

func (x *Document_Page_Table) ProtoReflect() protoreflect.Message

func (*Document_Page_Table) Reset

func (x *Document_Page_Table) Reset()

func (*Document_Page_Table) String

func (x *Document_Page_Table) String() string

Document_Page_Table_TableCell

type Document_Page_Table_TableCell struct {

	// [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for
	// [TableCell][google.cloud.documentai.v1beta3.Document.Page.Table.TableCell].
	Layout *Document_Page_Layout `protobuf:"bytes,1,opt,name=layout,proto3" json:"layout,omitempty"`
	// How many rows this cell spans.
	RowSpan int32 `protobuf:"varint,2,opt,name=row_span,json=rowSpan,proto3" json:"row_span,omitempty"`
	// How many columns this cell spans.
	ColSpan int32 `protobuf:"varint,3,opt,name=col_span,json=colSpan,proto3" json:"col_span,omitempty"`
	// A list of detected languages together with confidence.
	DetectedLanguages []*Document_Page_DetectedLanguage `protobuf:"bytes,4,rep,name=detected_languages,json=detectedLanguages,proto3" json:"detected_languages,omitempty"`
	// contains filtered or unexported fields
}

A cell representation inside the table.

func (*Document_Page_Table_TableCell) Descriptor

func (*Document_Page_Table_TableCell) Descriptor() ([]byte, []int)

Deprecated: Use Document_Page_Table_TableCell.ProtoReflect.Descriptor instead.

func (*Document_Page_Table_TableCell) GetColSpan

func (x *Document_Page_Table_TableCell) GetColSpan() int32

func (*Document_Page_Table_TableCell) GetDetectedLanguages

func (*Document_Page_Table_TableCell) GetLayout

func (*Document_Page_Table_TableCell) GetRowSpan

func (x *Document_Page_Table_TableCell) GetRowSpan() int32

func (*Document_Page_Table_TableCell) ProtoMessage

func (*Document_Page_Table_TableCell) ProtoMessage()

func (*Document_Page_Table_TableCell) ProtoReflect

func (*Document_Page_Table_TableCell) Reset

func (x *Document_Page_Table_TableCell) Reset()

func (*Document_Page_Table_TableCell) String

Document_Page_Table_TableRow

type Document_Page_Table_TableRow struct {

	// Cells that make up this row.
	Cells []*Document_Page_Table_TableCell `protobuf:"bytes,1,rep,name=cells,proto3" json:"cells,omitempty"`
	// contains filtered or unexported fields
}

A row of table cells.

func (*Document_Page_Table_TableRow) Descriptor

func (*Document_Page_Table_TableRow) Descriptor() ([]byte, []int)

Deprecated: Use Document_Page_Table_TableRow.ProtoReflect.Descriptor instead.

func (*Document_Page_Table_TableRow) GetCells

func (*Document_Page_Table_TableRow) ProtoMessage

func (*Document_Page_Table_TableRow) ProtoMessage()

func (*Document_Page_Table_TableRow) ProtoReflect

func (*Document_Page_Table_TableRow) Reset

func (x *Document_Page_Table_TableRow) Reset()

func (*Document_Page_Table_TableRow) String

Document_Page_Token

type Document_Page_Token struct {

	// [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for
	// [Token][google.cloud.documentai.v1beta3.Document.Page.Token].
	Layout *Document_Page_Layout `protobuf:"bytes,1,opt,name=layout,proto3" json:"layout,omitempty"`
	// Detected break at the end of a
	// [Token][google.cloud.documentai.v1beta3.Document.Page.Token].
	DetectedBreak *Document_Page_Token_DetectedBreak `protobuf:"bytes,2,opt,name=detected_break,json=detectedBreak,proto3" json:"detected_break,omitempty"`
	// A list of detected languages together with confidence.
	DetectedLanguages []*Document_Page_DetectedLanguage `protobuf:"bytes,3,rep,name=detected_languages,json=detectedLanguages,proto3" json:"detected_languages,omitempty"`
	// The history of this annotation.
	//
	// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.
	Provenance *Document_Provenance `protobuf:"bytes,4,opt,name=provenance,proto3" json:"provenance,omitempty"`
	// Text style attributes.
	StyleInfo *Document_Page_Token_StyleInfo `protobuf:"bytes,5,opt,name=style_info,json=styleInfo,proto3" json:"style_info,omitempty"`
	// contains filtered or unexported fields
}

A detected token.

func (*Document_Page_Token) Descriptor

func (*Document_Page_Token) Descriptor() ([]byte, []int)

Deprecated: Use Document_Page_Token.ProtoReflect.Descriptor instead.

func (*Document_Page_Token) GetDetectedBreak

func (*Document_Page_Token) GetDetectedLanguages

func (x *Document_Page_Token) GetDetectedLanguages() []*Document_Page_DetectedLanguage

func (*Document_Page_Token) GetLayout

func (x *Document_Page_Token) GetLayout() *Document_Page_Layout

func (*Document_Page_Token) GetProvenance

func (x *Document_Page_Token) GetProvenance() *Document_Provenance

Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.

func (*Document_Page_Token) GetStyleInfo

func (*Document_Page_Token) ProtoMessage

func (*Document_Page_Token) ProtoMessage()

func (*Document_Page_Token) ProtoReflect

func (x *Document_Page_Token) ProtoReflect() protoreflect.Message

func (*Document_Page_Token) Reset

func (x *Document_Page_Token) Reset()

func (*Document_Page_Token) String

func (x *Document_Page_Token) String() string

Document_Page_Token_DetectedBreak

type Document_Page_Token_DetectedBreak struct {
	Type Document_Page_Token_DetectedBreak_Type "" /* 138 byte string literal not displayed */

}

Detected break at the end of a [Token][google.cloud.documentai.v1beta3.Document.Page.Token].

func (*Document_Page_Token_DetectedBreak) Descriptor

func (*Document_Page_Token_DetectedBreak) Descriptor() ([]byte, []int)

Deprecated: Use Document_Page_Token_DetectedBreak.ProtoReflect.Descriptor instead.

func (*Document_Page_Token_DetectedBreak) GetType

func (*Document_Page_Token_DetectedBreak) ProtoMessage

func (*Document_Page_Token_DetectedBreak) ProtoMessage()

func (*Document_Page_Token_DetectedBreak) ProtoReflect

func (*Document_Page_Token_DetectedBreak) Reset

func (*Document_Page_Token_DetectedBreak) String

Document_Page_Token_DetectedBreak_Type

type Document_Page_Token_DetectedBreak_Type int32

Enum to denote the type of break found.

Document_Page_Token_DetectedBreak_TYPE_UNSPECIFIED, Document_Page_Token_DetectedBreak_SPACE, Document_Page_Token_DetectedBreak_WIDE_SPACE, Document_Page_Token_DetectedBreak_HYPHEN

const (
	// Unspecified break type.
	Document_Page_Token_DetectedBreak_TYPE_UNSPECIFIED Document_Page_Token_DetectedBreak_Type = 0
	// A single whitespace.
	Document_Page_Token_DetectedBreak_SPACE Document_Page_Token_DetectedBreak_Type = 1
	// A wider whitespace.
	Document_Page_Token_DetectedBreak_WIDE_SPACE Document_Page_Token_DetectedBreak_Type = 2
	// A hyphen that indicates that a token has been split across lines.
	Document_Page_Token_DetectedBreak_HYPHEN Document_Page_Token_DetectedBreak_Type = 3
)

func (Document_Page_Token_DetectedBreak_Type) Descriptor

func (Document_Page_Token_DetectedBreak_Type) Enum

func (Document_Page_Token_DetectedBreak_Type) EnumDescriptor

func (Document_Page_Token_DetectedBreak_Type) EnumDescriptor() ([]byte, []int)

Deprecated: Use Document_Page_Token_DetectedBreak_Type.Descriptor instead.

func (Document_Page_Token_DetectedBreak_Type) Number

func (Document_Page_Token_DetectedBreak_Type) String

func (Document_Page_Token_DetectedBreak_Type) Type

Document_Page_Token_StyleInfo

type Document_Page_Token_StyleInfo struct {

	// Font size in points (`1` point is `¹⁄₇₂` inches).
	FontSize int32 `protobuf:"varint,1,opt,name=font_size,json=fontSize,proto3" json:"font_size,omitempty"`
	// Font size in pixels, equal to _unrounded
	// [font_size][google.cloud.documentai.v1beta3.Document.Page.Token.StyleInfo.font_size]_
	// * _resolution_ ÷ `72.0`.
	PixelFontSize float64 `protobuf:"fixed64,2,opt,name=pixel_font_size,json=pixelFontSize,proto3" json:"pixel_font_size,omitempty"`
	// Letter spacing in points.
	LetterSpacing float64 `protobuf:"fixed64,3,opt,name=letter_spacing,json=letterSpacing,proto3" json:"letter_spacing,omitempty"`
	// Name or style of the font.
	FontType string `protobuf:"bytes,4,opt,name=font_type,json=fontType,proto3" json:"font_type,omitempty"`
	// Whether the text is bold (equivalent to
	// [font_weight][google.cloud.documentai.v1beta3.Document.Page.Token.StyleInfo.font_weight]
	// is at least `700`).
	Bold bool `protobuf:"varint,5,opt,name=bold,proto3" json:"bold,omitempty"`
	// Whether the text is italic.
	Italic bool `protobuf:"varint,6,opt,name=italic,proto3" json:"italic,omitempty"`
	// Whether the text is underlined.
	Underlined bool `protobuf:"varint,7,opt,name=underlined,proto3" json:"underlined,omitempty"`
	// Whether the text is strikethrough.
	Strikeout bool `protobuf:"varint,8,opt,name=strikeout,proto3" json:"strikeout,omitempty"`
	// Whether the text is a subscript.
	Subscript bool `protobuf:"varint,9,opt,name=subscript,proto3" json:"subscript,omitempty"`
	// Whether the text is a superscript.
	Superscript bool `protobuf:"varint,10,opt,name=superscript,proto3" json:"superscript,omitempty"`
	// Whether the text is in small caps.
	Smallcaps bool `protobuf:"varint,11,opt,name=smallcaps,proto3" json:"smallcaps,omitempty"`
	// TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy).
	// Normal is `400`, bold is `700`.
	FontWeight int32 `protobuf:"varint,12,opt,name=font_weight,json=fontWeight,proto3" json:"font_weight,omitempty"`
	// Whether the text is handwritten.
	Handwritten bool `protobuf:"varint,13,opt,name=handwritten,proto3" json:"handwritten,omitempty"`
	// Color of the text.
	TextColor *color.Color `protobuf:"bytes,14,opt,name=text_color,json=textColor,proto3" json:"text_color,omitempty"`
	// Color of the background.
	BackgroundColor *color.Color `protobuf:"bytes,15,opt,name=background_color,json=backgroundColor,proto3" json:"background_color,omitempty"`
	// contains filtered or unexported fields
}

Font and other text style attributes.

func (*Document_Page_Token_StyleInfo) Descriptor

func (*Document_Page_Token_StyleInfo) Descriptor() ([]byte, []int)

Deprecated: Use Document_Page_Token_StyleInfo.ProtoReflect.Descriptor instead.

func (*Document_Page_Token_StyleInfo) GetBackgroundColor

func (x *Document_Page_Token_StyleInfo) GetBackgroundColor() *color.Color

func (*Document_Page_Token_StyleInfo) GetBold

func (x *Document_Page_Token_StyleInfo) GetBold() bool

func (*Document_Page_Token_StyleInfo) GetFontSize

func (x *Document_Page_Token_StyleInfo) GetFontSize() int32

func (*Document_Page_Token_StyleInfo) GetFontType

func (x *Document_Page_Token_StyleInfo) GetFontType() string

func (*Document_Page_Token_StyleInfo) GetFontWeight

func (x *Document_Page_Token_StyleInfo) GetFontWeight() int32

func (*Document_Page_Token_StyleInfo) GetHandwritten

func (x *Document_Page_Token_StyleInfo) GetHandwritten() bool

func (*Document_Page_Token_StyleInfo) GetItalic

func (x *Document_Page_Token_StyleInfo) GetItalic() bool

func (*Document_Page_Token_StyleInfo) GetLetterSpacing

func (x *Document_Page_Token_StyleInfo) GetLetterSpacing() float64

func (*Document_Page_Token_StyleInfo) GetPixelFontSize

func (x *Document_Page_Token_StyleInfo) GetPixelFontSize() float64

func (*Document_Page_Token_StyleInfo) GetSmallcaps

func (x *Document_Page_Token_StyleInfo) GetSmallcaps() bool

func (*Document_Page_Token_StyleInfo) GetStrikeout

func (x *Document_Page_Token_StyleInfo) GetStrikeout() bool

func (*Document_Page_Token_StyleInfo) GetSubscript

func (x *Document_Page_Token_StyleInfo) GetSubscript() bool

func (*Document_Page_Token_StyleInfo) GetSuperscript

func (x *Document_Page_Token_StyleInfo) GetSuperscript() bool

func (*Document_Page_Token_StyleInfo) GetTextColor

func (x *Document_Page_Token_StyleInfo) GetTextColor() *color.Color

func (*Document_Page_Token_StyleInfo) GetUnderlined

func (x *Document_Page_Token_StyleInfo) GetUnderlined() bool

func (*Document_Page_Token_StyleInfo) ProtoMessage

func (*Document_Page_Token_StyleInfo) ProtoMessage()

func (*Document_Page_Token_StyleInfo) ProtoReflect

func (*Document_Page_Token_StyleInfo) Reset

func (x *Document_Page_Token_StyleInfo) Reset()

func (*Document_Page_Token_StyleInfo) String

Document_Page_VisualElement

type Document_Page_VisualElement struct {

	// [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for
	// [VisualElement][google.cloud.documentai.v1beta3.Document.Page.VisualElement].
	Layout *Document_Page_Layout `protobuf:"bytes,1,opt,name=layout,proto3" json:"layout,omitempty"`
	// Type of the
	// [VisualElement][google.cloud.documentai.v1beta3.Document.Page.VisualElement].
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// A list of detected languages together with confidence.
	DetectedLanguages []*Document_Page_DetectedLanguage `protobuf:"bytes,3,rep,name=detected_languages,json=detectedLanguages,proto3" json:"detected_languages,omitempty"`
	// contains filtered or unexported fields
}

Detected non-text visual elements e.g. checkbox, signature etc. on the page.

func (*Document_Page_VisualElement) Descriptor

func (*Document_Page_VisualElement) Descriptor() ([]byte, []int)

Deprecated: Use Document_Page_VisualElement.ProtoReflect.Descriptor instead.

func (*Document_Page_VisualElement) GetDetectedLanguages

func (x *Document_Page_VisualElement) GetDetectedLanguages() []*Document_Page_DetectedLanguage

func (*Document_Page_VisualElement) GetLayout

func (*Document_Page_VisualElement) GetType

func (x *Document_Page_VisualElement) GetType() string

func (*Document_Page_VisualElement) ProtoMessage

func (*Document_Page_VisualElement) ProtoMessage()

func (*Document_Page_VisualElement) ProtoReflect

func (*Document_Page_VisualElement) Reset

func (x *Document_Page_VisualElement) Reset()

func (*Document_Page_VisualElement) String

func (x *Document_Page_VisualElement) String() string

Document_Provenance

type Document_Provenance struct {
	Revision int32 `protobuf:"varint,1,opt,name=revision,proto3" json:"revision,omitempty"`

	Id int32 `protobuf:"varint,2,opt,name=id,proto3" json:"id,omitempty"`

	Parents []*Document_Provenance_Parent `protobuf:"bytes,3,rep,name=parents,proto3" json:"parents,omitempty"`

	Type Document_Provenance_OperationType "" /* 133 byte string literal not displayed */

}

Structure to identify provenance relationships between annotations in different revisions.

func (*Document_Provenance) Descriptor

func (*Document_Provenance) Descriptor() ([]byte, []int)

Deprecated: Use Document_Provenance.ProtoReflect.Descriptor instead.

func (*Document_Provenance) GetId

func (x *Document_Provenance) GetId() int32

Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.

func (*Document_Provenance) GetParents

func (*Document_Provenance) GetRevision

func (x *Document_Provenance) GetRevision() int32

Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.

func (*Document_Provenance) GetType

func (*Document_Provenance) ProtoMessage

func (*Document_Provenance) ProtoMessage()

func (*Document_Provenance) ProtoReflect

func (x *Document_Provenance) ProtoReflect() protoreflect.Message

func (*Document_Provenance) Reset

func (x *Document_Provenance) Reset()

func (*Document_Provenance) String

func (x *Document_Provenance) String() string

Document_Provenance_OperationType

type Document_Provenance_OperationType int32

If a processor or agent does an explicit operation on existing elements.

Document_Provenance_OPERATION_TYPE_UNSPECIFIED, Document_Provenance_ADD, Document_Provenance_REMOVE, Document_Provenance_UPDATE, Document_Provenance_REPLACE, Document_Provenance_EVAL_REQUESTED, Document_Provenance_EVAL_APPROVED, Document_Provenance_EVAL_SKIPPED

const (
	// Operation type unspecified. If no operation is specified a provenance
	// entry is simply used to match against a `parent`.
	Document_Provenance_OPERATION_TYPE_UNSPECIFIED Document_Provenance_OperationType = 0
	// Add an element.
	Document_Provenance_ADD Document_Provenance_OperationType = 1
	// Remove an element identified by `parent`.
	Document_Provenance_REMOVE Document_Provenance_OperationType = 2
	// Updates any fields within the given provenance scope of the message. It
	// overwrites the fields rather than replacing them.  Use this when you
	// want to update a field value of an entity without also updating all the
	// child properties.
	Document_Provenance_UPDATE Document_Provenance_OperationType = 7
	// Currently unused. Replace an element identified by `parent`.
	Document_Provenance_REPLACE Document_Provenance_OperationType = 3
	// Deprecated. Request human review for the element identified by
	// `parent`.
	//
	// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.
	Document_Provenance_EVAL_REQUESTED Document_Provenance_OperationType = 4
	// Deprecated. Element is reviewed and approved at human review,
	// confidence will be set to 1.0.
	//
	// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.
	Document_Provenance_EVAL_APPROVED Document_Provenance_OperationType = 5
	// Deprecated. Element is skipped in the validation process.
	//
	// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.
	Document_Provenance_EVAL_SKIPPED Document_Provenance_OperationType = 6
)

func (Document_Provenance_OperationType) Descriptor

func (Document_Provenance_OperationType) Enum

func (Document_Provenance_OperationType) EnumDescriptor

func (Document_Provenance_OperationType) EnumDescriptor() ([]byte, []int)

Deprecated: Use Document_Provenance_OperationType.Descriptor instead.

func (Document_Provenance_OperationType) Number

func (Document_Provenance_OperationType) String

func (Document_Provenance_OperationType) Type

Document_Provenance_Parent

type Document_Provenance_Parent struct {

	// The index of the index into current revision's parent_ids list.
	Revision int32 `protobuf:"varint,1,opt,name=revision,proto3" json:"revision,omitempty"`
	// The index of the parent item in the corresponding item list (eg. list
	// of entities, properties within entities, etc.) in the parent revision.
	Index int32 `protobuf:"varint,3,opt,name=index,proto3" json:"index,omitempty"`
	// The id of the parent provenance.
	//
	// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.
	Id int32 `protobuf:"varint,2,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.

func (*Document_Provenance_Parent) Descriptor

func (*Document_Provenance_Parent) Descriptor() ([]byte, []int)

Deprecated: Use Document_Provenance_Parent.ProtoReflect.Descriptor instead.

func (*Document_Provenance_Parent) GetId

func (x *Document_Provenance_Parent) GetId() int32

Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.

func (*Document_Provenance_Parent) GetIndex

func (x *Document_Provenance_Parent) GetIndex() int32

func (*Document_Provenance_Parent) GetRevision

func (x *Document_Provenance_Parent) GetRevision() int32

func (*Document_Provenance_Parent) ProtoMessage

func (*Document_Provenance_Parent) ProtoMessage()

func (*Document_Provenance_Parent) ProtoReflect

func (*Document_Provenance_Parent) Reset

func (x *Document_Provenance_Parent) Reset()

func (*Document_Provenance_Parent) String

func (x *Document_Provenance_Parent) String() string

Document_Revision

type Document_Revision struct {

	// Who/what made the change
	//
	// Types that are assignable to Source:
	//
	//	*Document_Revision_Agent
	//	*Document_Revision_Processor
	Source isDocument_Revision_Source `protobuf_oneof:"source"`
	// Id of the revision, internally generated by doc proto storage.
	// Unique within the context of the document.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The revisions that this revision is based on.  This can include one or
	// more parent (when documents are merged.)  This field represents the
	// index into the `revisions` field.
	//
	// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.
	Parent []int32 `protobuf:"varint,2,rep,packed,name=parent,proto3" json:"parent,omitempty"`
	// The revisions that this revision is based on. Must include all the ids
	// that have anything to do with this revision - eg. there are
	// `provenance.parent.revision` fields that index into this field.
	ParentIds []string `protobuf:"bytes,7,rep,name=parent_ids,json=parentIds,proto3" json:"parent_ids,omitempty"`
	// The time that the revision was created, internally generated by
	// doc proto storage at the time of create.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Human Review information of this revision.
	HumanReview *Document_Revision_HumanReview `protobuf:"bytes,6,opt,name=human_review,json=humanReview,proto3" json:"human_review,omitempty"`
	// contains filtered or unexported fields
}

Contains past or forward revisions of this document.

func (*Document_Revision) Descriptor

func (*Document_Revision) Descriptor() ([]byte, []int)

Deprecated: Use Document_Revision.ProtoReflect.Descriptor instead.

func (*Document_Revision) GetAgent

func (x *Document_Revision) GetAgent() string

func (*Document_Revision) GetCreateTime

func (x *Document_Revision) GetCreateTime() *timestamppb.Timestamp

func (*Document_Revision) GetHumanReview

func (x *Document_Revision) GetHumanReview() *Document_Revision_HumanReview

func (*Document_Revision) GetId

func (x *Document_Revision) GetId() string

func (*Document_Revision) GetParent

func (x *Document_Revision) GetParent() []int32

Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.

func (*Document_Revision) GetParentIds

func (x *Document_Revision) GetParentIds() []string

func (*Document_Revision) GetProcessor

func (x *Document_Revision) GetProcessor() string

func (*Document_Revision) GetSource

func (m *Document_Revision) GetSource() isDocument_Revision_Source

func (*Document_Revision) ProtoMessage

func (*Document_Revision) ProtoMessage()

func (*Document_Revision) ProtoReflect

func (x *Document_Revision) ProtoReflect() protoreflect.Message

func (*Document_Revision) Reset

func (x *Document_Revision) Reset()

func (*Document_Revision) String

func (x *Document_Revision) String() string

Document_Revision_Agent

type Document_Revision_Agent struct {
	// If the change was made by a person specify the name or id of that
	// person.
	Agent string `protobuf:"bytes,4,opt,name=agent,proto3,oneof"`
}

Document_Revision_HumanReview

type Document_Revision_HumanReview struct {

	// Human review state. e.g. `requested`, `succeeded`, `rejected`.
	State string `protobuf:"bytes,1,opt,name=state,proto3" json:"state,omitempty"`
	// A message providing more details about the current state of processing.
	// For example, the rejection reason when the state is `rejected`.
	StateMessage string `protobuf:"bytes,2,opt,name=state_message,json=stateMessage,proto3" json:"state_message,omitempty"`
	// contains filtered or unexported fields
}

Human Review information of the document.

func (*Document_Revision_HumanReview) Descriptor

func (*Document_Revision_HumanReview) Descriptor() ([]byte, []int)

Deprecated: Use Document_Revision_HumanReview.ProtoReflect.Descriptor instead.

func (*Document_Revision_HumanReview) GetState

func (x *Document_Revision_HumanReview) GetState() string

func (*Document_Revision_HumanReview) GetStateMessage

func (x *Document_Revision_HumanReview) GetStateMessage() string

func (*Document_Revision_HumanReview) ProtoMessage

func (*Document_Revision_HumanReview) ProtoMessage()

func (*Document_Revision_HumanReview) ProtoReflect

func (*Document_Revision_HumanReview) Reset

func (x *Document_Revision_HumanReview) Reset()

func (*Document_Revision_HumanReview) String

Document_Revision_Processor

type Document_Revision_Processor struct {
	// If the annotation was made by processor identify the processor by its
	// resource name.
	Processor string `protobuf:"bytes,5,opt,name=processor,proto3,oneof"`
}

Document_ShardInfo

type Document_ShardInfo struct {

	// The 0-based index of this shard.
	ShardIndex int64 `protobuf:"varint,1,opt,name=shard_index,json=shardIndex,proto3" json:"shard_index,omitempty"`
	// Total number of shards.
	ShardCount int64 `protobuf:"varint,2,opt,name=shard_count,json=shardCount,proto3" json:"shard_count,omitempty"`
	// The index of the first character in
	// [Document.text][google.cloud.documentai.v1beta3.Document.text] in the
	// overall document global text.
	TextOffset int64 `protobuf:"varint,3,opt,name=text_offset,json=textOffset,proto3" json:"text_offset,omitempty"`
	// contains filtered or unexported fields
}

For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is.

func (*Document_ShardInfo) Descriptor

func (*Document_ShardInfo) Descriptor() ([]byte, []int)

Deprecated: Use Document_ShardInfo.ProtoReflect.Descriptor instead.

func (*Document_ShardInfo) GetShardCount

func (x *Document_ShardInfo) GetShardCount() int64

func (*Document_ShardInfo) GetShardIndex

func (x *Document_ShardInfo) GetShardIndex() int64

func (*Document_ShardInfo) GetTextOffset

func (x *Document_ShardInfo) GetTextOffset() int64

func (*Document_ShardInfo) ProtoMessage

func (*Document_ShardInfo) ProtoMessage()

func (*Document_ShardInfo) ProtoReflect

func (x *Document_ShardInfo) ProtoReflect() protoreflect.Message

func (*Document_ShardInfo) Reset

func (x *Document_ShardInfo) Reset()

func (*Document_ShardInfo) String

func (x *Document_ShardInfo) String() string

Document_Style

type Document_Style struct {

	// Text anchor indexing into the
	// [Document.text][google.cloud.documentai.v1beta3.Document.text].
	TextAnchor *Document_TextAnchor `protobuf:"bytes,1,opt,name=text_anchor,json=textAnchor,proto3" json:"text_anchor,omitempty"`
	// Text color.
	Color *color.Color `protobuf:"bytes,2,opt,name=color,proto3" json:"color,omitempty"`
	// Text background color.
	BackgroundColor *color.Color `protobuf:"bytes,3,opt,name=background_color,json=backgroundColor,proto3" json:"background_color,omitempty"`
	// [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp).
	// Possible values are `normal`, `bold`, `bolder`, and `lighter`.
	FontWeight string `protobuf:"bytes,4,opt,name=font_weight,json=fontWeight,proto3" json:"font_weight,omitempty"`
	// [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp).
	// Possible values are `normal`, `italic`, and `oblique`.
	TextStyle string `protobuf:"bytes,5,opt,name=text_style,json=textStyle,proto3" json:"text_style,omitempty"`
	// [Text
	// decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp).
	// Follows CSS standard. 

Annotation for common text style attributes. This adheres to CSS conventions as much as possible.

func (*Document_Style) Descriptor

func (*Document_Style) Descriptor() ([]byte, []int)

Deprecated: Use Document_Style.ProtoReflect.Descriptor instead.

func (*Document_Style) GetBackgroundColor

func (x *Document_Style) GetBackgroundColor() *color.Color

func (*Document_Style) GetColor

func (x *Document_Style) GetColor() *color.Color

func (*Document_Style) GetFontFamily

func (x *Document_Style) GetFontFamily() string

func (*Document_Style) GetFontSize

func (x *Document_Style) GetFontSize() *Document_Style_FontSize

func (*Document_Style) GetFontWeight

func (x *Document_Style) GetFontWeight() string

func (*Document_Style) GetTextAnchor

func (x *Document_Style) GetTextAnchor() *Document_TextAnchor

func (*Document_Style) GetTextDecoration

func (x *Document_Style) GetTextDecoration() string

func (*Document_Style) GetTextStyle

func (x *Document_Style) GetTextStyle() string

func (*Document_Style) ProtoMessage

func (*Document_Style) ProtoMessage()

func (*Document_Style) ProtoReflect

func (x *Document_Style) ProtoReflect() protoreflect.Message

func (*Document_Style) Reset

func (x *Document_Style) Reset()

func (*Document_Style) String

func (x *Document_Style) String() string

Document_Style_FontSize

type Document_Style_FontSize struct {

	// Font size for the text.
	Size float32 `protobuf:"fixed32,1,opt,name=size,proto3" json:"size,omitempty"`
	// Unit for the font size. Follows CSS naming (such as `in`, `px`, and
	// `pt`).
	Unit string `protobuf:"bytes,2,opt,name=unit,proto3" json:"unit,omitempty"`
	// contains filtered or unexported fields
}

Font size with unit.

func (*Document_Style_FontSize) Descriptor

func (*Document_Style_FontSize) Descriptor() ([]byte, []int)

Deprecated: Use Document_Style_FontSize.ProtoReflect.Descriptor instead.

func (*Document_Style_FontSize) GetSize

func (x *Document_Style_FontSize) GetSize() float32

func (*Document_Style_FontSize) GetUnit

func (x *Document_Style_FontSize) GetUnit() string

func (*Document_Style_FontSize) ProtoMessage

func (*Document_Style_FontSize) ProtoMessage()

func (*Document_Style_FontSize) ProtoReflect

func (x *Document_Style_FontSize) ProtoReflect() protoreflect.Message

func (*Document_Style_FontSize) Reset

func (x *Document_Style_FontSize) Reset()

func (*Document_Style_FontSize) String

func (x *Document_Style_FontSize) String() string

Document_TextAnchor

type Document_TextAnchor struct {

	// The text segments from the
	// [Document.text][google.cloud.documentai.v1beta3.Document.text].
	TextSegments []*Document_TextAnchor_TextSegment `protobuf:"bytes,1,rep,name=text_segments,json=textSegments,proto3" json:"text_segments,omitempty"`
	// Contains the content of the text span so that users do
	// not have to look it up in the text_segments.  It is always
	// populated for formFields.
	Content string `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// contains filtered or unexported fields
}

Text reference indexing into the [Document.text][google.cloud.documentai.v1beta3.Document.text].

func (*Document_TextAnchor) Descriptor

func (*Document_TextAnchor) Descriptor() ([]byte, []int)

Deprecated: Use Document_TextAnchor.ProtoReflect.Descriptor instead.

func (*Document_TextAnchor) GetContent

func (x *Document_TextAnchor) GetContent() string

func (*Document_TextAnchor) GetTextSegments

func (x *Document_TextAnchor) GetTextSegments() []*Document_TextAnchor_TextSegment

func (*Document_TextAnchor) ProtoMessage

func (*Document_TextAnchor) ProtoMessage()

func (*Document_TextAnchor) ProtoReflect

func (x *Document_TextAnchor) ProtoReflect() protoreflect.Message

func (*Document_TextAnchor) Reset

func (x *Document_TextAnchor) Reset()

func (*Document_TextAnchor) String

func (x *Document_TextAnchor) String() string

Document_TextAnchor_TextSegment

type Document_TextAnchor_TextSegment struct {

	// [TextSegment][google.cloud.documentai.v1beta3.Document.TextAnchor.TextSegment]
	// start UTF-8 char index in the
	// [Document.text][google.cloud.documentai.v1beta3.Document.text].
	StartIndex int64 `protobuf:"varint,1,opt,name=start_index,json=startIndex,proto3" json:"start_index,omitempty"`
	// [TextSegment][google.cloud.documentai.v1beta3.Document.TextAnchor.TextSegment]
	// half open end UTF-8 char index in the
	// [Document.text][google.cloud.documentai.v1beta3.Document.text].
	EndIndex int64 `protobuf:"varint,2,opt,name=end_index,json=endIndex,proto3" json:"end_index,omitempty"`
	// contains filtered or unexported fields
}

A text segment in the [Document.text][google.cloud.documentai.v1beta3.Document.text]. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See [ShardInfo.text_offset][google.cloud.documentai.v1beta3.Document.ShardInfo.text_offset]

func (*Document_TextAnchor_TextSegment) Descriptor

func (*Document_TextAnchor_TextSegment) Descriptor() ([]byte, []int)

Deprecated: Use Document_TextAnchor_TextSegment.ProtoReflect.Descriptor instead.

func (*Document_TextAnchor_TextSegment) GetEndIndex

func (x *Document_TextAnchor_TextSegment) GetEndIndex() int64

func (*Document_TextAnchor_TextSegment) GetStartIndex

func (x *Document_TextAnchor_TextSegment) GetStartIndex() int64

func (*Document_TextAnchor_TextSegment) ProtoMessage

func (*Document_TextAnchor_TextSegment) ProtoMessage()

func (*Document_TextAnchor_TextSegment) ProtoReflect

func (*Document_TextAnchor_TextSegment) Reset

func (*Document_TextAnchor_TextSegment) String

Document_TextChange

type Document_TextChange struct {

	// Provenance of the correction.
	// Text anchor indexing into the
	// [Document.text][google.cloud.documentai.v1beta3.Document.text].  There
	// can only be a single `TextAnchor.text_segments` element.  If the start
	// and end index of the text segment are the same, the text change is
	// inserted before that index.
	TextAnchor *Document_TextAnchor `protobuf:"bytes,1,opt,name=text_anchor,json=textAnchor,proto3" json:"text_anchor,omitempty"`
	// The text that replaces the text identified in the `text_anchor`.
	ChangedText string `protobuf:"bytes,2,opt,name=changed_text,json=changedText,proto3" json:"changed_text,omitempty"`
	// The history of this annotation.
	//
	// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.
	Provenance []*Document_Provenance `protobuf:"bytes,3,rep,name=provenance,proto3" json:"provenance,omitempty"`
	// contains filtered or unexported fields
}

This message is used for text changes aka. OCR corrections.

func (*Document_TextChange) Descriptor

func (*Document_TextChange) Descriptor() ([]byte, []int)

Deprecated: Use Document_TextChange.ProtoReflect.Descriptor instead.

func (*Document_TextChange) GetChangedText

func (x *Document_TextChange) GetChangedText() string

func (*Document_TextChange) GetProvenance

func (x *Document_TextChange) GetProvenance() []*Document_Provenance

Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.

func (*Document_TextChange) GetTextAnchor

func (x *Document_TextChange) GetTextAnchor() *Document_TextAnchor

func (*Document_TextChange) ProtoMessage

func (*Document_TextChange) ProtoMessage()

func (*Document_TextChange) ProtoReflect

func (x *Document_TextChange) ProtoReflect() protoreflect.Message

func (*Document_TextChange) Reset

func (x *Document_TextChange) Reset()

func (*Document_TextChange) String

func (x *Document_TextChange) String() string

Document_Uri

type Document_Uri struct {
	// Optional. Currently supports Google Cloud Storage URI of the form
	// `gs://bucket_name/object_name`. Object versioning is not supported.
	// For more information, refer to [Google Cloud Storage Request
	// URIs](https://cloud.google.com/storage/docs/reference-uris).
	Uri string `protobuf:"bytes,1,opt,name=uri,proto3,oneof"`
}

EnableProcessorMetadata

type EnableProcessorMetadata struct {

	// The basic metadata of the long-running operation.
	CommonMetadata *CommonOperationMetadata `protobuf:"bytes,5,opt,name=common_metadata,json=commonMetadata,proto3" json:"common_metadata,omitempty"`
	// contains filtered or unexported fields
}

The long-running operation metadata for the [EnableProcessor][google.cloud.documentai.v1beta3.DocumentProcessorService.EnableProcessor] method.

func (*EnableProcessorMetadata) Descriptor

func (*EnableProcessorMetadata) Descriptor() ([]byte, []int)

Deprecated: Use EnableProcessorMetadata.ProtoReflect.Descriptor instead.

func (*EnableProcessorMetadata) GetCommonMetadata

func (x *EnableProcessorMetadata) GetCommonMetadata() *CommonOperationMetadata

func (*EnableProcessorMetadata) ProtoMessage

func (*EnableProcessorMetadata) ProtoMessage()

func (*EnableProcessorMetadata) ProtoReflect

func (x *EnableProcessorMetadata) ProtoReflect() protoreflect.Message

func (*EnableProcessorMetadata) Reset

func (x *EnableProcessorMetadata) Reset()

func (*EnableProcessorMetadata) String

func (x *EnableProcessorMetadata) String() string

EnableProcessorRequest

type EnableProcessorRequest struct {

	// Required. The processor resource name to be enabled.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for the [EnableProcessor][google.cloud.documentai.v1beta3.DocumentProcessorService.EnableProcessor] method.

func (*EnableProcessorRequest) Descriptor

func (*EnableProcessorRequest) Descriptor() ([]byte, []int)

Deprecated: Use EnableProcessorRequest.ProtoReflect.Descriptor instead.

func (*EnableProcessorRequest) GetName

func (x *EnableProcessorRequest) GetName() string

func (*EnableProcessorRequest) ProtoMessage

func (*EnableProcessorRequest) ProtoMessage()

func (*EnableProcessorRequest) ProtoReflect

func (x *EnableProcessorRequest) ProtoReflect() protoreflect.Message

func (*EnableProcessorRequest) Reset

func (x *EnableProcessorRequest) Reset()

func (*EnableProcessorRequest) String

func (x *EnableProcessorRequest) String() string

EnableProcessorResponse

type EnableProcessorResponse struct {
	// contains filtered or unexported fields
}

Response message for the [EnableProcessor][google.cloud.documentai.v1beta3.DocumentProcessorService.EnableProcessor] method. Intentionally empty proto for adding fields in future.

func (*EnableProcessorResponse) Descriptor

func (*EnableProcessorResponse) Descriptor() ([]byte, []int)

Deprecated: Use EnableProcessorResponse.ProtoReflect.Descriptor instead.

func (*EnableProcessorResponse) ProtoMessage

func (*EnableProcessorResponse) ProtoMessage()

func (*EnableProcessorResponse) ProtoReflect

func (x *EnableProcessorResponse) ProtoReflect() protoreflect.Message

func (*EnableProcessorResponse) Reset