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

Version latest

• 1.34.0 (latest)
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.5
• 1.29.0
• 1.28.1
• 1.27.0
• 1.26.1
• 1.25.0
• 1.24.0
• 1.23.8
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.1
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.1

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Note: To get more information about this package, such as access to older versions, view this package on pkg.go.dev.

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.

ProcessorVersion_ModelType_name, ProcessorVersion_ModelType_value

var (
	ProcessorVersion_ModelType_name = map[int32]string{
		0: "MODEL_TYPE_UNSPECIFIED",
		1: "MODEL_TYPE_GENERATIVE",
		2: "MODEL_TYPE_CUSTOM",
	}
	ProcessorVersion_ModelType_value = map[string]int32{
		"MODEL_TYPE_UNSPECIFIED": 0,
		"MODEL_TYPE_GENERATIVE":  1,
		"MODEL_TYPE_CUSTOM":      2,
	}
)

Enum value maps for ProcessorVersion_ModelType.

ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_CustomModelType_name, ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_CustomModelType_value

var (
	ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_CustomModelType_name = map[int32]string{
		0: "CUSTOM_MODEL_TYPE_UNSPECIFIED",
		1: "VERSIONED_FOUNDATION",
		2: "FINE_TUNED",
	}
	ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_CustomModelType_value = map[string]int32{
		"CUSTOM_MODEL_TYPE_UNSPECIFIED": 0,
		"VERSIONED_FOUNDATION":          1,
		"FINE_TUNED":                    2,
	}
)

Enum value maps for ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_CustomModelType.

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 (x *BatchDatasetDocuments) GetIndividualDocumentIds() *BatchDatasetDocuments_IndividualDocumentIds

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

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

Deprecated: Use BatchDatasetDocuments_IndividualDocumentIds.ProtoReflect.Descriptor instead.

func (*BatchDatasetDocuments_IndividualDocumentIds) GetDocumentIds

func (x *BatchDatasetDocuments_IndividualDocumentIds) GetDocumentIds() []*DocumentId

func (*BatchDatasetDocuments_IndividualDocumentIds) ProtoMessage

func (*BatchDatasetDocuments_IndividualDocumentIds) ProtoMessage()

func (*BatchDatasetDocuments_IndividualDocumentIds) ProtoReflect

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

func (*BatchDatasetDocuments_IndividualDocumentIds) Reset

func (x *BatchDatasetDocuments_IndividualDocumentIds) Reset()

func (*BatchDatasetDocuments_IndividualDocumentIds) String

func (x *BatchDatasetDocuments_IndividualDocumentIds) String() 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 (x *BatchDeleteDocumentsMetadata) GetIndividualBatchDeleteStatuses() []*BatchDeleteDocumentsMetadata_IndividualBatchDeleteStatus

func (*BatchDeleteDocumentsMetadata) GetTotalDocumentCount

func (x *BatchDeleteDocumentsMetadata) GetTotalDocumentCount() int32

func (*BatchDeleteDocumentsMetadata) ProtoMessage

func (*BatchDeleteDocumentsMetadata) ProtoMessage()

func (*BatchDeleteDocumentsMetadata) ProtoReflect

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

func (*BatchDeleteDocumentsMetadata) Reset

func (x *BatchDeleteDocumentsMetadata) Reset()

func (*BatchDeleteDocumentsMetadata) String

func (x *BatchDeleteDocumentsMetadata) String() 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

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

Deprecated: Use BatchDeleteDocumentsMetadata_IndividualBatchDeleteStatus.ProtoReflect.Descriptor instead.

func (*BatchDeleteDocumentsMetadata_IndividualBatchDeleteStatus) GetDocumentId

func (x *BatchDeleteDocumentsMetadata_IndividualBatchDeleteStatus) GetDocumentId() *DocumentId

func (*BatchDeleteDocumentsMetadata_IndividualBatchDeleteStatus) GetStatus

func (x *BatchDeleteDocumentsMetadata_IndividualBatchDeleteStatus) GetStatus() *status.Status

func (*BatchDeleteDocumentsMetadata_IndividualBatchDeleteStatus) ProtoMessage

func (*BatchDeleteDocumentsMetadata_IndividualBatchDeleteStatus) ProtoMessage()

func (*BatchDeleteDocumentsMetadata_IndividualBatchDeleteStatus) ProtoReflect

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

func (*BatchDeleteDocumentsMetadata_IndividualBatchDeleteStatus) Reset

func (x *BatchDeleteDocumentsMetadata_IndividualBatchDeleteStatus) Reset()

func (*BatchDeleteDocumentsMetadata_IndividualBatchDeleteStatus) String

func (x *BatchDeleteDocumentsMetadata_IndividualBatchDeleteStatus) String() 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 (x *BatchDeleteDocumentsRequest) ProtoReflect() protoreflect.Message

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 (x *BatchDeleteDocumentsResponse) ProtoReflect() protoreflect.Message

func (*BatchDeleteDocumentsResponse) Reset

func (x *BatchDeleteDocumentsResponse) Reset()

func (*BatchDeleteDocumentsResponse) String

func (x *BatchDeleteDocumentsResponse) String() 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 (x *BatchDocumentsInputConfig) ProtoReflect() protoreflect.Message

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 (x *BatchProcessMetadata) GetState() BatchProcessMetadata_State

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

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

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 (x *BatchProcessMetadata_IndividualProcessStatus) GetHumanReviewStatus() *HumanReviewStatus

func (*BatchProcessMetadata_IndividualProcessStatus) GetInputGcsSource

func (x *BatchProcessMetadata_IndividualProcessStatus) GetInputGcsSource() string

func (*BatchProcessMetadata_IndividualProcessStatus) GetOutputGcsDestination

func (x *BatchProcessMetadata_IndividualProcessStatus) GetOutputGcsDestination() string

func (*BatchProcessMetadata_IndividualProcessStatus) GetStatus

func (x *BatchProcessMetadata_IndividualProcessStatus) GetStatus() *status.Status

func (*BatchProcessMetadata_IndividualProcessStatus) ProtoMessage

func (*BatchProcessMetadata_IndividualProcessStatus) ProtoMessage()

func (*BatchProcessMetadata_IndividualProcessStatus) ProtoReflect

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

func (*BatchProcessMetadata_IndividualProcessStatus) Reset

func (x *BatchProcessMetadata_IndividualProcessStatus) Reset()

func (*BatchProcessMetadata_IndividualProcessStatus) String

func (x *BatchProcessMetadata_IndividualProcessStatus) String() 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) Descriptor() protoreflect.EnumDescriptor

func (BatchProcessMetadata_State) Enum

func (x BatchProcessMetadata_State) Enum() *BatchProcessMetadata_State

func (BatchProcessMetadata_State) EnumDescriptor

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

Deprecated: Use BatchProcessMetadata_State.Descriptor instead.

func (BatchProcessMetadata_State) Number

func (x BatchProcessMetadata_State) Number() protoreflect.EnumNumber

func (BatchProcessMetadata_State) String

func (x BatchProcessMetadata_State) String() string

func (BatchProcessMetadata_State) Type

func (BatchProcessMetadata_State) Type() protoreflect.EnumType

BatchProcessRequest

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

	InputConfigs []*BatchProcessRequest_BatchInputConfig `protobuf:"bytes,2,rep,name=input_configs,json=inputConfigs,proto3" json:"input_configs,omitempty"`

	OutputConfig *BatchProcessRequest_BatchOutputConfig `protobuf:"bytes,3,opt,name=output_config,json=outputConfig,proto3" json:"output_config,omitempty"`

	InputDocuments *BatchDocumentsInputConfig `protobuf:"bytes,5,opt,name=input_documents,json=inputDocuments,proto3" json:"input_documents,omitempty"`

	DocumentOutputConfig *DocumentOutputConfig `protobuf:"bytes,6,opt,name=document_output_config,json=documentOutputConfig,proto3" json:"document_output_config,omitempty"`

	SkipHumanReview bool `protobuf:"varint,4,opt,name=skip_human_review,json=skipHumanReview,proto3" json:"skip_human_review,omitempty"`

	ProcessOptions *ProcessOptions `protobuf:"bytes,7,opt,name=process_options,json=processOptions,proto3" json:"process_options,omitempty"`

	Labels map[string]string "" /* 153 byte string literal not displayed */

}

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

func (x *BatchProcessRequest) GetInputConfigs() []*BatchProcessRequest_BatchInputConfig

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

func (*BatchProcessRequest) GetInputDocuments

func (x *BatchProcessRequest) GetInputDocuments() *BatchDocumentsInputConfig

func (*BatchProcessRequest) GetLabels

func (x *BatchProcessRequest) GetLabels() map[string]string

func (*BatchProcessRequest) GetName

func (x *BatchProcessRequest) GetName() string

func (*BatchProcessRequest) GetOutputConfig

func (x *BatchProcessRequest) GetOutputConfig() *BatchProcessRequest_BatchOutputConfig

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 (x *BatchProcessRequest_BatchInputConfig) GetMimeType() string

func (*BatchProcessRequest_BatchInputConfig) ProtoMessage (deprecated)

func (*BatchProcessRequest_BatchInputConfig) ProtoMessage()

func (*BatchProcessRequest_BatchInputConfig) ProtoReflect (deprecated)

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

func (*BatchProcessRequest_BatchInputConfig) Reset (deprecated)

func (x *BatchProcessRequest_BatchInputConfig) Reset()

func (*BatchProcessRequest_BatchInputConfig) String (deprecated)

func (x *BatchProcessRequest_BatchInputConfig) String() string

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 (x *BatchProcessRequest_BatchOutputConfig) ProtoReflect() protoreflect.Message

func (*BatchProcessRequest_BatchOutputConfig) Reset (deprecated)

func (x *BatchProcessRequest_BatchOutputConfig) Reset()

func (*BatchProcessRequest_BatchOutputConfig) String (deprecated)

func (x *BatchProcessRequest_BatchOutputConfig) String() string

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 (x *CommonOperationMetadata) GetState() CommonOperationMetadata_State

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) Descriptor() protoreflect.EnumDescriptor

func (CommonOperationMetadata_State) Enum

func (x CommonOperationMetadata_State) Enum() *CommonOperationMetadata_State

func (CommonOperationMetadata_State) EnumDescriptor

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

Deprecated: Use CommonOperationMetadata_State.Descriptor instead.

func (CommonOperationMetadata_State) Number

func (x CommonOperationMetadata_State) Number() protoreflect.EnumNumber

func (CommonOperationMetadata_State) String

func (x CommonOperationMetadata_State) String() string

func (CommonOperationMetadata_State) Type

func (CommonOperationMetadata_State) Type() protoreflect.EnumType

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][google.cloud.documentai.v1beta3.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"`
	// Output only. Reserved for future use.
	SatisfiesPzs bool `protobuf:"varint,8,opt,name=satisfies_pzs,json=satisfiesPzs,proto3" json:"satisfies_pzs,omitempty"`
	// Output only. Reserved for future use.
	SatisfiesPzi bool `protobuf:"varint,9,opt,name=satisfies_pzi,json=satisfiesPzi,proto3" json:"satisfies_pzi,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

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

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) GetSatisfiesPzi

func (x *Dataset) GetSatisfiesPzi() bool

func (*Dataset) GetSatisfiesPzs

func (x *Dataset) GetSatisfiesPzs() bool

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) Descriptor() protoreflect.EnumDescriptor

func (DatasetSplitType) Enum

func (x DatasetSplitType) Enum() *DatasetSplitType

func (DatasetSplitType) EnumDescriptor

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

Deprecated: Use DatasetSplitType.Descriptor instead.

func (DatasetSplitType) Number

func (x DatasetSplitType) Number() protoreflect.EnumNumber

func (DatasetSplitType) String

func (x DatasetSplitType) String() string

func (DatasetSplitType) Type

func (DatasetSplitType) Type() protoreflect.EnumType

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 (x *Dataset_DocumentWarehouseConfig) ProtoReflect() protoreflect.Message

func (*Dataset_DocumentWarehouseConfig) Reset

func (x *Dataset_DocumentWarehouseConfig) Reset()

func (*Dataset_DocumentWarehouseConfig) String

func (x *Dataset_DocumentWarehouseConfig) String() string

Dataset_DocumentWarehouseConfig_

type Dataset_DocumentWarehouseConfig_ struct {
	// Optional. Deprecated. Warehouse-based dataset configuration is not
	// supported.
	//
	// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/dataset.proto.
	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 (x *Dataset_SpannerIndexingConfig) ProtoReflect() protoreflect.Message

func (*Dataset_SpannerIndexingConfig) Reset

func (x *Dataset_SpannerIndexingConfig) Reset()

func (*Dataset_SpannerIndexingConfig) String

func (x *Dataset_SpannerIndexingConfig) String() 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) Descriptor() protoreflect.EnumDescriptor

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 (x Dataset_State) Number() protoreflect.EnumNumber

func (Dataset_State) String

func (x Dataset_State) String() string

func (Dataset_State) Type

func (Dataset_State) Type() protoreflect.EnumType

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 (x *Dataset_UnmanagedDatasetConfig) ProtoReflect() protoreflect.Message

func (*Dataset_UnmanagedDatasetConfig) Reset

func (x *Dataset_UnmanagedDatasetConfig) Reset()

func (*Dataset_UnmanagedDatasetConfig) String

func (x *Dataset_UnmanagedDatasetConfig) String() 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 (x *DeleteProcessorVersionMetadata) GetCommonMetadata() *CommonOperationMetadata

func (*DeleteProcessorVersionMetadata) ProtoMessage

func (*DeleteProcessorVersionMetadata) ProtoMessage()

func (*DeleteProcessorVersionMetadata) ProtoReflect

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

func (*DeleteProcessorVersionMetadata) Reset

func (x *DeleteProcessorVersionMetadata) Reset()

func (*DeleteProcessorVersionMetadata) String

func (x *DeleteProcessorVersionMetadata) String() 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 (x *DeleteProcessorVersionRequest) GetName() string

func (*DeleteProcessorVersionRequest) ProtoMessage

func (*DeleteProcessorVersionRequest) ProtoMessage()

func (*DeleteProcessorVersionRequest) ProtoReflect

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

func (*DeleteProcessorVersionRequest) Reset

func (x *DeleteProcessorVersionRequest) Reset()

func (*DeleteProcessorVersionRequest) String

func (x *DeleteProcessorVersionRequest) String() 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 (x *DeployProcessorVersionMetadata) GetCommonMetadata() *CommonOperationMetadata

func (*DeployProcessorVersionMetadata) ProtoMessage

func (*DeployProcessorVersionMetadata) ProtoMessage()

func (*DeployProcessorVersionMetadata) ProtoReflect

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

func (*DeployProcessorVersionMetadata) Reset

func (x *DeployProcessorVersionMetadata) Reset()

func (*DeployProcessorVersionMetadata) String

func (x *DeployProcessorVersionMetadata) String() 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 (x *DeployProcessorVersionRequest) GetName() string

func (*DeployProcessorVersionRequest) ProtoMessage

func (*DeployProcessorVersionRequest) ProtoMessage()

func (*DeployProcessorVersionRequest) ProtoReflect

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

func (*DeployProcessorVersionRequest) Reset

func (x *DeployProcessorVersionRequest) Reset()

func (*DeployProcessorVersionRequest) String

func (x *DeployProcessorVersionRequest) String() 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 (x *DeployProcessorVersionResponse) ProtoReflect() protoreflect.Message

func (*DeployProcessorVersionResponse) Reset

func (x *DeployProcessorVersionResponse) Reset()

func (*DeployProcessorVersionResponse) String

func (x *DeployProcessorVersionResponse) String() 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"`
	// Parsed layout of the document.
	DocumentLayout *Document_DocumentLayout `protobuf:"bytes,17,opt,name=document_layout,json=documentLayout,proto3" json:"document_layout,omitempty"`
	// Document chunked based on chunking config.
	ChunkedDocument *Document_ChunkedDocument `protobuf:"bytes,18,opt,name=chunked_document,json=chunkedDocument,proto3" json:"chunked_document,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) GetChunkedDocument

func (x *Document) GetChunkedDocument() *Document_ChunkedDocument

func (*Document) GetContent

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

func (*Document) GetDocumentLayout

func (x *Document) GetDocumentLayout() *Document_DocumentLayout

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 (x *DocumentId_GCSManagedDocumentId) ProtoReflect() protoreflect.Message

func (*DocumentId_GCSManagedDocumentId) Reset

func (x *DocumentId_GCSManagedDocumentId) Reset()

func (*DocumentId_GCSManagedDocumentId) String

func (x *DocumentId_GCSManagedDocumentId) String() 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 (x *DocumentId_UnmanagedDocumentId) ProtoReflect() protoreflect.Message

func (*DocumentId_UnmanagedDocumentId) Reset

func (x *DocumentId_UnmanagedDocumentId) Reset()

func (*DocumentId_UnmanagedDocumentId) String

func (x *DocumentId_UnmanagedDocumentId) String() string

DocumentLabelingState

type DocumentLabelingState int32

Describes the labeling 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 labeled.
	DocumentLabelingState_DOCUMENT_LABELED DocumentLabelingState = 1
	// Document has not been labeled.
	DocumentLabelingState_DOCUMENT_UNLABELED DocumentLabelingState = 2
	// Document has been auto-labeled.
	DocumentLabelingState_DOCUMENT_AUTO_LABELED DocumentLabelingState = 3
)

func (DocumentLabelingState) Descriptor

func (DocumentLabelingState) Descriptor() protoreflect.EnumDescriptor

func (DocumentLabelingState) Enum

func (x DocumentLabelingState) Enum() *DocumentLabelingState

func (DocumentLabelingState) EnumDescriptor

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

Deprecated: Use DocumentLabelingState.Descriptor instead.

func (DocumentLabelingState) Number

func (x DocumentLabelingState) Number() protoreflect.EnumNumber

func (DocumentLabelingState) String

func (x DocumentLabelingState) String() string

func (DocumentLabelingState) Type

func (DocumentLabelingState) Type() protoreflect.EnumType

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 (x *DocumentOutputConfig) GetGcsOutputConfig() *DocumentOutputConfig_GcsOutputConfig

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 (x *DocumentOutputConfig_GcsOutputConfig) GetFieldMask() *fieldmaskpb.FieldMask

func (*DocumentOutputConfig_GcsOutputConfig) GetGcsUri

func (x *DocumentOutputConfig_GcsOutputConfig) GetGcsUri() string

func (*DocumentOutputConfig_GcsOutputConfig) GetShardingConfig

func (x *DocumentOutputConfig_GcsOutputConfig) GetShardingConfig() *DocumentOutputConfig_GcsOutputConfig_ShardingConfig

func (*DocumentOutputConfig_GcsOutputConfig) ProtoMessage

func (*DocumentOutputConfig_GcsOutputConfig) ProtoMessage()

func (*DocumentOutputConfig_GcsOutputConfig) ProtoReflect

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

func (*DocumentOutputConfig_GcsOutputConfig) Reset

func (x *DocumentOutputConfig_GcsOutputConfig) Reset()

func (*DocumentOutputConfig_GcsOutputConfig) String

func (x *DocumentOutputConfig_GcsOutputConfig) String() 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

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

Deprecated: Use DocumentOutputConfig_GcsOutputConfig_ShardingConfig.ProtoReflect.Descriptor instead.

func (*DocumentOutputConfig_GcsOutputConfig_ShardingConfig) GetPagesOverlap

func (x *DocumentOutputConfig_GcsOutputConfig_ShardingConfig) GetPagesOverlap() int32

func (*DocumentOutputConfig_GcsOutputConfig_ShardingConfig) GetPagesPerShard

func (x *DocumentOutputConfig_GcsOutputConfig_ShardingConfig) GetPagesPerShard() int32

func (*DocumentOutputConfig_GcsOutputConfig_ShardingConfig) ProtoMessage

func (*DocumentOutputConfig_GcsOutputConfig_ShardingConfig) ProtoMessage()

func (*DocumentOutputConfig_GcsOutputConfig_ShardingConfig) ProtoReflect

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

func (*DocumentOutputConfig_GcsOutputConfig_ShardingConfig) Reset

func (x *DocumentOutputConfig_GcsOutputConfig_ShardingConfig) Reset()

func (*DocumentOutputConfig_GcsOutputConfig_ShardingConfig) String

func (x *DocumentOutputConfig_GcsOutputConfig_ShardingConfig) String() 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.
	// Note that this method requires the `documentai.processors.create`
	// permission on the project, which is highly privileged. A user or service
	// account with this permission can create new processors that can interact
	// with any gcs bucket in your project.
	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.
	// Note that this method requires the `documentai.processors.create`
	// permission on the project, which is highly privileged. A user or service
	// account with this permission can create new processors that can interact
	// with any gcs bucket in your project.
	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