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

Version latest

• 1.39.0 (latest)
• 1.38.1
• 1.37.0
• 1.36.1
• 1.35.3
• 1.34.0
• 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.

Constants

DocumentProcessorService_ProcessDocument_FullMethodName, DocumentProcessorService_BatchProcessDocuments_FullMethodName, DocumentProcessorService_FetchProcessorTypes_FullMethodName, DocumentProcessorService_ListProcessorTypes_FullMethodName, DocumentProcessorService_GetProcessorType_FullMethodName, DocumentProcessorService_ListProcessors_FullMethodName, DocumentProcessorService_GetProcessor_FullMethodName, DocumentProcessorService_TrainProcessorVersion_FullMethodName, DocumentProcessorService_GetProcessorVersion_FullMethodName, DocumentProcessorService_ListProcessorVersions_FullMethodName, DocumentProcessorService_DeleteProcessorVersion_FullMethodName, DocumentProcessorService_DeployProcessorVersion_FullMethodName, DocumentProcessorService_UndeployProcessorVersion_FullMethodName, DocumentProcessorService_CreateProcessor_FullMethodName, DocumentProcessorService_DeleteProcessor_FullMethodName, DocumentProcessorService_EnableProcessor_FullMethodName, DocumentProcessorService_DisableProcessor_FullMethodName, DocumentProcessorService_SetDefaultProcessorVersion_FullMethodName, DocumentProcessorService_ReviewDocument_FullMethodName, DocumentProcessorService_EvaluateProcessorVersion_FullMethodName, DocumentProcessorService_GetEvaluation_FullMethodName, DocumentProcessorService_ListEvaluations_FullMethodName, DocumentProcessorService_ImportProcessorVersion_FullMethodName

const (
	DocumentProcessorService_ProcessDocument_FullMethodName            = "/google.cloud.documentai.v1beta3.DocumentProcessorService/ProcessDocument"
	DocumentProcessorService_BatchProcessDocuments_FullMethodName      = "/google.cloud.documentai.v1beta3.DocumentProcessorService/BatchProcessDocuments"
	DocumentProcessorService_FetchProcessorTypes_FullMethodName        = "/google.cloud.documentai.v1beta3.DocumentProcessorService/FetchProcessorTypes"
	DocumentProcessorService_ListProcessorTypes_FullMethodName         = "/google.cloud.documentai.v1beta3.DocumentProcessorService/ListProcessorTypes"
	DocumentProcessorService_GetProcessorType_FullMethodName           = "/google.cloud.documentai.v1beta3.DocumentProcessorService/GetProcessorType"
	DocumentProcessorService_ListProcessors_FullMethodName             = "/google.cloud.documentai.v1beta3.DocumentProcessorService/ListProcessors"
	DocumentProcessorService_GetProcessor_FullMethodName               = "/google.cloud.documentai.v1beta3.DocumentProcessorService/GetProcessor"
	DocumentProcessorService_TrainProcessorVersion_FullMethodName      = "/google.cloud.documentai.v1beta3.DocumentProcessorService/TrainProcessorVersion"
	DocumentProcessorService_GetProcessorVersion_FullMethodName        = "/google.cloud.documentai.v1beta3.DocumentProcessorService/GetProcessorVersion"
	DocumentProcessorService_ListProcessorVersions_FullMethodName      = "/google.cloud.documentai.v1beta3.DocumentProcessorService/ListProcessorVersions"
	DocumentProcessorService_DeleteProcessorVersion_FullMethodName     = "/google.cloud.documentai.v1beta3.DocumentProcessorService/DeleteProcessorVersion"
	DocumentProcessorService_DeployProcessorVersion_FullMethodName     = "/google.cloud.documentai.v1beta3.DocumentProcessorService/DeployProcessorVersion"
	DocumentProcessorService_UndeployProcessorVersion_FullMethodName   = "/google.cloud.documentai.v1beta3.DocumentProcessorService/UndeployProcessorVersion"
	DocumentProcessorService_CreateProcessor_FullMethodName            = "/google.cloud.documentai.v1beta3.DocumentProcessorService/CreateProcessor"
	DocumentProcessorService_DeleteProcessor_FullMethodName            = "/google.cloud.documentai.v1beta3.DocumentProcessorService/DeleteProcessor"
	DocumentProcessorService_EnableProcessor_FullMethodName            = "/google.cloud.documentai.v1beta3.DocumentProcessorService/EnableProcessor"
	DocumentProcessorService_DisableProcessor_FullMethodName           = "/google.cloud.documentai.v1beta3.DocumentProcessorService/DisableProcessor"
	DocumentProcessorService_SetDefaultProcessorVersion_FullMethodName = "/google.cloud.documentai.v1beta3.DocumentProcessorService/SetDefaultProcessorVersion"
	DocumentProcessorService_ReviewDocument_FullMethodName             = "/google.cloud.documentai.v1beta3.DocumentProcessorService/ReviewDocument"
	DocumentProcessorService_EvaluateProcessorVersion_FullMethodName   = "/google.cloud.documentai.v1beta3.DocumentProcessorService/EvaluateProcessorVersion"
	DocumentProcessorService_GetEvaluation_FullMethodName              = "/google.cloud.documentai.v1beta3.DocumentProcessorService/GetEvaluation"
	DocumentProcessorService_ListEvaluations_FullMethodName            = "/google.cloud.documentai.v1beta3.DocumentProcessorService/ListEvaluations"
	DocumentProcessorService_ImportProcessorVersion_FullMethodName     = "/google.cloud.documentai.v1beta3.DocumentProcessorService/ImportProcessorVersion"
)

DocumentService_UpdateDataset_FullMethodName, DocumentService_ImportDocuments_FullMethodName, DocumentService_GetDocument_FullMethodName, DocumentService_ListDocuments_FullMethodName, DocumentService_BatchDeleteDocuments_FullMethodName, DocumentService_GetDatasetSchema_FullMethodName, DocumentService_UpdateDatasetSchema_FullMethodName

const (
	DocumentService_UpdateDataset_FullMethodName        = "/google.cloud.documentai.v1beta3.DocumentService/UpdateDataset"
	DocumentService_ImportDocuments_FullMethodName      = "/google.cloud.documentai.v1beta3.DocumentService/ImportDocuments"
	DocumentService_GetDocument_FullMethodName          = "/google.cloud.documentai.v1beta3.DocumentService/GetDocument"
	DocumentService_ListDocuments_FullMethodName        = "/google.cloud.documentai.v1beta3.DocumentService/ListDocuments"
	DocumentService_BatchDeleteDocuments_FullMethodName = "/google.cloud.documentai.v1beta3.DocumentService/BatchDeleteDocuments"
	DocumentService_GetDatasetSchema_FullMethodName     = "/google.cloud.documentai.v1beta3.DocumentService/GetDatasetSchema"
	DocumentService_UpdateDatasetSchema_FullMethodName  = "/google.cloud.documentai.v1beta3.DocumentService/UpdateDatasetSchema"
)

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_Entity_Method_name, Document_Entity_Method_value

var (
	Document_Entity_Method_name = map[int32]string{
		0: "METHOD_UNSPECIFIED",
		1: "EXTRACT",
		2: "DERIVE",
	}
	Document_Entity_Method_value = map[string]int32{
		"METHOD_UNSPECIFIED": 0,
		"EXTRACT":            1,
		"DERIVE":             2,
	}
)

Enum value maps for Document_Entity_Method.

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.

Document_EntityValidationOutput_ValidationResult_ValidationResultType_name, Document_EntityValidationOutput_ValidationResult_ValidationResultType_value

var (
	Document_EntityValidationOutput_ValidationResult_ValidationResultType_name = map[int32]string{
		0: "VALIDATION_RESULT_TYPE_UNSPECIFIED",
		1: "VALIDATION_RESULT_TYPE_VALID",
		2: "VALIDATION_RESULT_TYPE_INVALID",
		3: "VALIDATION_RESULT_TYPE_SKIPPED",
		4: "VALIDATION_RESULT_TYPE_NOT_APPLICABLE",
	}
	Document_EntityValidationOutput_ValidationResult_ValidationResultType_value = map[string]int32{
		"VALIDATION_RESULT_TYPE_UNSPECIFIED":    0,
		"VALIDATION_RESULT_TYPE_VALID":          1,
		"VALIDATION_RESULT_TYPE_INVALID":        2,
		"VALIDATION_RESULT_TYPE_SKIPPED":        3,
		"VALIDATION_RESULT_TYPE_NOT_APPLICABLE": 4,
	}
)

Enum value maps for Document_EntityValidationOutput_ValidationResult_ValidationResultType.

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.

DocumentSchema_EntityType_Property_Method_name, DocumentSchema_EntityType_Property_Method_value

var (
	DocumentSchema_EntityType_Property_Method_name = map[int32]string{
		0: "METHOD_UNSPECIFIED",
		1: "EXTRACT",
		2: "DERIVE",
	}
	DocumentSchema_EntityType_Property_Method_value = map[string]int32{
		"METHOD_UNSPECIFIED": 0,
		"EXTRACT":            1,
		"DERIVE":             2,
	}
)

Enum value maps for DocumentSchema_EntityType_Property_Method.

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.

DocumentProcessorService_ServiceDesc

var DocumentProcessorService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.documentai.v1beta3.DocumentProcessorService",
	HandlerType: (*DocumentProcessorServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ProcessDocument",
			Handler:    _DocumentProcessorService_ProcessDocument_Handler,
		},
		{
			MethodName: "BatchProcessDocuments",
			Handler:    _DocumentProcessorService_BatchProcessDocuments_Handler,
		},
		{
			MethodName: "FetchProcessorTypes",
			Handler:    _DocumentProcessorService_FetchProcessorTypes_Handler,
		},
		{
			MethodName: "ListProcessorTypes",
			Handler:    _DocumentProcessorService_ListProcessorTypes_Handler,
		},
		{
			MethodName: "GetProcessorType",
			Handler:    _DocumentProcessorService_GetProcessorType_Handler,
		},
		{
			MethodName: "ListProcessors",
			Handler:    _DocumentProcessorService_ListProcessors_Handler,
		},
		{
			MethodName: "GetProcessor",
			Handler:    _DocumentProcessorService_GetProcessor_Handler,
		},
		{
			MethodName: "TrainProcessorVersion",
			Handler:    _DocumentProcessorService_TrainProcessorVersion_Handler,
		},
		{
			MethodName: "GetProcessorVersion",
			Handler:    _DocumentProcessorService_GetProcessorVersion_Handler,
		},
		{
			MethodName: "ListProcessorVersions",
			Handler:    _DocumentProcessorService_ListProcessorVersions_Handler,
		},
		{
			MethodName: "DeleteProcessorVersion",
			Handler:    _DocumentProcessorService_DeleteProcessorVersion_Handler,
		},
		{
			MethodName: "DeployProcessorVersion",
			Handler:    _DocumentProcessorService_DeployProcessorVersion_Handler,
		},
		{
			MethodName: "UndeployProcessorVersion",
			Handler:    _DocumentProcessorService_UndeployProcessorVersion_Handler,
		},
		{
			MethodName: "CreateProcessor",
			Handler:    _DocumentProcessorService_CreateProcessor_Handler,
		},
		{
			MethodName: "DeleteProcessor",
			Handler:    _DocumentProcessorService_DeleteProcessor_Handler,
		},
		{
			MethodName: "EnableProcessor",
			Handler:    _DocumentProcessorService_EnableProcessor_Handler,
		},
		{
			MethodName: "DisableProcessor",
			Handler:    _DocumentProcessorService_DisableProcessor_Handler,
		},
		{
			MethodName: "SetDefaultProcessorVersion",
			Handler:    _DocumentProcessorService_SetDefaultProcessorVersion_Handler,
		},
		{
			MethodName: "ReviewDocument",
			Handler:    _DocumentProcessorService_ReviewDocument_Handler,
		},
		{
			MethodName: "EvaluateProcessorVersion",
			Handler:    _DocumentProcessorService_EvaluateProcessorVersion_Handler,
		},
		{
			MethodName: "GetEvaluation",
			Handler:    _DocumentProcessorService_GetEvaluation_Handler,
		},
		{
			MethodName: "ListEvaluations",
			Handler:    _DocumentProcessorService_ListEvaluations_Handler,
		},
		{
			MethodName: "ImportProcessorVersion",
			Handler:    _DocumentProcessorService_ImportProcessorVersion_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/documentai/v1beta3/document_processor_service.proto",
}

DocumentProcessorService_ServiceDesc is the grpc.ServiceDesc for DocumentProcessorService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

DocumentService_ServiceDesc

var DocumentService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.documentai.v1beta3.DocumentService",
	HandlerType: (*DocumentServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "UpdateDataset",
			Handler:    _DocumentService_UpdateDataset_Handler,
		},
		{
			MethodName: "ImportDocuments",
			Handler:    _DocumentService_ImportDocuments_Handler,
		},
		{
			MethodName: "GetDocument",
			Handler:    _DocumentService_GetDocument_Handler,
		},
		{
			MethodName: "ListDocuments",
			Handler:    _DocumentService_ListDocuments_Handler,
		},
		{
			MethodName: "BatchDeleteDocuments",
			Handler:    _DocumentService_BatchDeleteDocuments_Handler,
		},
		{
			MethodName: "GetDatasetSchema",
			Handler:    _DocumentService_GetDatasetSchema_Handler,
		},
		{
			MethodName: "UpdateDatasetSchema",
			Handler:    _DocumentService_UpdateDatasetSchema_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/documentai/v1beta3/document_service.proto",
}

DocumentService_ServiceDesc is the grpc.ServiceDesc for DocumentService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

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.ServiceRegistrar, srv DocumentProcessorServiceServer)

func RegisterDocumentServiceServer

func RegisterDocumentServiceServer(s grpc.ServiceRegistrar, 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 {

	// The basic metadata of the long-running operation.
	CommonMetadata *CommonOperationMetadata `protobuf:"bytes,1,opt,name=common_metadata,json=commonMetadata,proto3" json:"common_metadata,omitempty"`
	// The list of response details of each document.
	IndividualBatchDeleteStatuses []*BatchDeleteDocumentsMetadata_IndividualBatchDeleteStatus `protobuf:"bytes,2,rep,name=individual_batch_delete_statuses,json=individualBatchDeleteStatuses,proto3" json:"individual_batch_delete_statuses,omitempty"`
	// Total number of documents deleting from dataset.
	TotalDocumentCount int32 `protobuf:"varint,3,opt,name=total_document_count,json=totalDocumentCount,proto3" json:"total_document_count,omitempty"`
	// Total number of documents that failed to be deleted in storage.
	ErrorDocumentCount int32 `protobuf:"varint,4,opt,name=error_document_count,json=errorDocumentCount,proto3" json:"error_document_count,omitempty"`
	// contains filtered or unexported fields
}

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. Make sure that the caller of the API has storage.objects.get
	// access to the buckets.
	//
	// 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 {

	// The state of the current batch processing.
	State BatchProcessMetadata_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.cloud.documentai.v1beta3.BatchProcessMetadata_State" json:"state,omitempty"`
	// A message providing more details about the current state of processing.
	// For example, the error message if the operation is failed.
	StateMessage string `protobuf:"bytes,2,opt,name=state_message,json=stateMessage,proto3" json:"state_message,omitempty"`
	// The creation time of the operation.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// The last update time of the operation.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// The list of response details of each document.
	IndividualProcessStatuses []*BatchProcessMetadata_IndividualProcessStatus `protobuf:"bytes,5,rep,name=individual_process_statuses,json=individualProcessStatuses,proto3" json:"individual_process_statuses,omitempty"`
	// contains filtered or unexported fields
}

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 {

	// Required. The resource name of
	// [Processor][google.cloud.documentai.v1beta3.Processor] or
	// [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion].
	// Format: `projects/{project}/locations/{location}/processors/{processor}`,
	// or
	// `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The input config for each single document in the batch process.
	//
	// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document_processor_service.proto.
	InputConfigs []*BatchProcessRequest_BatchInputConfig `protobuf:"bytes,2,rep,name=input_configs,json=inputConfigs,proto3" json:"input_configs,omitempty"`
	// The overall output config for batch process.
	//
	// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document_processor_service.proto.
	OutputConfig *BatchProcessRequest_BatchOutputConfig `protobuf:"bytes,3,opt,name=output_config,json=outputConfig,proto3" json:"output_config,omitempty"`
	// The input documents for the
	// [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments]
	// method.
	InputDocuments *BatchDocumentsInputConfig `protobuf:"bytes,5,opt,name=input_documents,json=inputDocuments,proto3" json:"input_documents,omitempty"`
	// The output configuration for the
	// [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments]
	// method.
	DocumentOutputConfig *DocumentOutputConfig `protobuf:"bytes,6,opt,name=document_output_config,json=documentOutputConfig,proto3" json:"document_output_config,omitempty"`
	// Whether human review should be skipped for this request. Default to
	// `false`.
	SkipHumanReview bool `protobuf:"varint,4,opt,name=skip_human_review,json=skipHumanReview,proto3" json:"skip_human_review,omitempty"`
	// Inference-time options for the process API
	ProcessOptions *ProcessOptions `protobuf:"bytes,7,opt,name=process_options,json=processOptions,proto3" json:"process_options,omitempty"`
	// Optional. The labels with user-defined metadata for the request.
	//
	// Label keys and values can be no longer than 63 characters
	// (Unicode codepoints) and can only contain lowercase letters, numeric
	// characters, underscores, and dashes. International characters are allowed.
	// Label values are optional. Label keys must start with a letter.
	Labels map[string]string `protobuf:"bytes,9,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
	// contains filtered or unexported fields
}

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

func (*BatchProcessRequest) Descriptor

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

Deprecated: Use BatchProcessRequest.ProtoReflect.Descriptor instead.

func (*BatchProcessRequest) GetDocumentOutputConfig

func (x *BatchProcessRequest) GetDocumentOutputConfig() *DocumentOutputConfig

func (*BatchProcessRequest) GetInputConfigs

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 {

	// The state of the operation.
	State CommonOperationMetadata_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.cloud.documentai.v1beta3.CommonOperationMetadata_State" json:"state,omitempty"`
	// A message providing more details about the current state of processing.
	StateMessage string `protobuf:"bytes,2,opt,name=state_message,json=stateMessage,proto3" json:"state_message,omitempty"`
	// A related resource to this operation.
	Resource string `protobuf:"bytes,5,opt,name=resource,proto3" json:"resource,omitempty"`
	// The creation time of the operation.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// The last update time of the operation.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// contains filtered or unexported fields
}

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"`
	// Output only. Reserved for future use.
	SatisfiesPzs bool `protobuf:"varint,4,opt,name=satisfies_pzs,json=satisfiesPzs,proto3" json:"satisfies_pzs,omitempty"`
	// Output only. Reserved for future use.
	SatisfiesPzi bool `protobuf:"varint,5,opt,name=satisfies_pzi,json=satisfiesPzi,proto3" json:"satisfies_pzi,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) GetSatisfiesPzi

func (x *DatasetSchema) GetSatisfiesPzi() bool

func (*DatasetSchema) GetSatisfiesPzs

func (x *DatasetSchema) GetSatisfiesPzs() bool

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"`
	// Optional. An internal identifier for document. Should be loggable (no PII).
	Docid string `protobuf:"bytes,15,opt,name=docid,proto3" json:"docid,omitempty"`
	// 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"`
	// Optional. The blob assets in this document. This is used to store the
	// content of the inline blobs in this document, e.g. image bytes, such that
	// it can be referenced by other fields in the document via asset id.
	BlobAssets []*Document_BlobAsset `protobuf:"bytes,19,rep,name=blob_assets,json=blobAssets,proto3" json:"blob_assets,omitempty"`
	// The entity validation output for the document. This is the validation
	// output for `document.entities` field.
	EntityValidationOutput *Document_EntityValidationOutput `protobuf:"bytes,21,opt,name=entity_validation_output,json=entityValidationOutput,proto3" json:"entity_validation_output,omitempty"`
	// A list of entity revisions. The entity revisions are appended to the
	// document in the processing order. This field can be used for comparing the
	// entity extraction results at different stages of the processing.
	EntitiesRevisions []*Document_EntitiesRevision `protobuf:"bytes,22,rep,name=entities_revisions,json=entitiesRevisions,proto3" json:"entities_revisions,omitempty"`
	// The entity revision id that `document.entities` field is based on.
	// If this field is set and `entities_revisions` is not empty, the entities in
	// `document.entities` field are the entities in the entity revision with this
	// id and `document.entity_validation_output` field is the
	// `entity_validation_output` field in this entity revision.
	EntitiesRevisionId string `protobuf:"bytes,23,opt,name=entities_revision_id,json=entitiesRevisionId,proto3" json:"entities_revision_id,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) GetBlobAssets

func (x *Document) GetBlobAssets() []*Document_BlobAsset

func (*Document) GetChunkedDocument

func (x *Document) GetChunkedDocument() *Document_ChunkedDocument

func (*Document) GetContent

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

func (*Document) GetDocid

func (x *Document) GetDocid() string

func (*Document) GetDocumentLayout

func (x *Document) GetDocumentLayout() *Document_DocumentLayout

func (*Document) GetEntities

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

func (*Document) GetEntitiesRevisionId

func (x *Document) GetEntitiesRevisionId() string

func (*Document) GetEntitiesRevisions

func (x *Document) GetEntitiesRevisions() []*Document_EntitiesRevision

func (*Document) GetEntityRelations

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

func (*Document) GetEntityValidationOutput

func (x *Document) GetEntityValidationOutput() *Document_EntityValidationOutput

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 {

	// Document identifier.
	DocumentId *DocumentId `protobuf:"bytes,1,opt,name=document_id,json=documentId,proto3" json:"document_id,omitempty"`
	// Number of pages in the document.
	PageCount int32 `protobuf:"varint,2,opt,name=page_count,json=pageCount,proto3" json:"page_count,omitempty"`
	// Type of the dataset split to which the document belongs.
	DatasetType DatasetSplitType `protobuf:"varint,3,opt,name=dataset_type,json=datasetType,proto3,enum=google.cloud.documentai.v1beta3.DatasetSplitType" json:"dataset_type,omitempty"`
	// Labeling state of the document.
	LabelingState DocumentLabelingState `protobuf:"varint,5,opt,name=labeling_state,json=labelingState,proto3,enum=google.cloud.documentai.v1beta3.DocumentLabelingState" json:"labeling_state,omitempty"`
	// The display name of the document.
	DisplayName string `protobuf:"bytes,6,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// contains filtered or unexported fields
}

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://pkg.go.dev/google.golang.org/grpc/?tab=doc#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. All implementations should embed UnimplementedDocumentProcessorServiceServer for forward compatibility

DocumentSchema

type DocumentSchema struct {

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

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

func (*DocumentSchema) Descriptor

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

Deprecated: Use DocumentSchema.ProtoReflect.Descriptor instead.

func (*DocumentSchema) GetDescription

func (x *DocumentSchema) GetDescription() string

func (*DocumentSchema) GetDisplayName

func (x *DocumentSchema) GetDisplayName() string

func (*DocumentSchema) GetEntityTypes

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

func (*DocumentSchema) GetMetadata

func (x *DocumentSchema) GetMetadata() *DocumentSchema_Metadata

func (*DocumentSchema) ProtoMessage

func (*DocumentSchema) ProtoMessage()

func (*DocumentSchema) ProtoReflect

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

func (*DocumentSchema) Reset

func (x *DocumentSchema) Reset()

func (*DocumentSchema) String

func (x *DocumentSchema) String() string

DocumentSchema_EntityType

type DocumentSchema_EntityType struct {

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

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

func (*DocumentSchema_EntityType) Descriptor

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

Deprecated: Use DocumentSchema_EntityType.ProtoReflect.Descriptor instead.

func (*DocumentSchema_EntityType) GetBaseTypes

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

func (*DocumentSchema_EntityType) GetDescription

func (x *DocumentSchema_EntityType) GetDescription() string

func (*DocumentSchema_EntityType) GetDisplayName

func (x *DocumentSchema_EntityType) GetDisplayName() string

func (*DocumentSchema_EntityType) GetEntityTypeMetadata

func (x *DocumentSchema_EntityType) GetEntityTypeMetadata() *EntityTypeMetadata

func (*DocumentSchema_EntityType) GetEnumValues

func (x *DocumentSchema_EntityType) GetEnumValues() *DocumentSchema_EntityType_EnumValues

func (*DocumentSchema_EntityType) GetName

func (x *DocumentSchema_EntityType) GetName() string

func (*DocumentSchema_EntityType) GetProperties

func (x *DocumentSchema_EntityType) GetProperties() []*DocumentSchema_EntityType_Property

func (*DocumentSchema_EntityType) GetValueSource

func (m *DocumentSchema_EntityType) GetValueSource() isDocumentSchema_EntityType_ValueSource

func (*DocumentSchema_EntityType) ProtoMessage

func (*DocumentSchema_EntityType) ProtoMessage()

func (*DocumentSchema_EntityType) ProtoReflect

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

func (*DocumentSchema_EntityType) Reset

func (x *DocumentSchema_EntityType) Reset()

func (*DocumentSchema_EntityType) String

func (x *DocumentSchema_EntityType) String() string

DocumentSchema_EntityType_EnumValues

type DocumentSchema_EntityType_EnumValues struct {

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

Defines the a list of enum values.

func (*DocumentSchema_EntityType_EnumValues) Descriptor

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

Deprecated: Use DocumentSchema_EntityType_EnumValues.ProtoReflect.Descriptor instead.

func (*DocumentSchema_EntityType_EnumValues) GetValues

func (x *DocumentSchema_EntityType_EnumValues) GetValues() []string

func (*DocumentSchema_EntityType_EnumValues) ProtoMessage

func (*DocumentSchema_EntityType_EnumValues) ProtoMessage()

func (*DocumentSchema_EntityType_EnumValues) ProtoReflect

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

func (*DocumentSchema_EntityType_EnumValues) Reset

func (x *DocumentSchema_EntityType_EnumValues) Reset()

func (*DocumentSchema_EntityType_EnumValues) String

func (x *DocumentSchema_EntityType_EnumValues) String() string

DocumentSchema_EntityType_EnumValues_

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

DocumentSchema_EntityType_Property

type DocumentSchema_EntityType_Property struct {

	// The name of the property.  Follows the same guidelines as the
	// EntityType name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The description of the property. Could be used to provide more
	// information about the property for model calls.
	Description string `protobuf:"bytes,7,opt,name=description,proto3" json:"description,omitempty"`
	// User defined name for the property.
	DisplayName string `protobuf:"bytes,6,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// A reference to the value type of the property.  This type is subject
	// to the same conventions as the `Entity.base_types` field.
	ValueType string `protobuf:"bytes,2,opt,name=value_type,json=valueType,proto3" json:"value_type,omitempty"`
	// Occurrence type limits the number of instances an entity type appears
	// in the document.
	OccurrenceType DocumentSchema_EntityType_Property_OccurrenceType `protobuf:"varint,3,opt,name=occurrence_type,json=occurrenceType,proto3,enum=google.cloud.documentai.v1beta3.DocumentSchema_EntityType_Property_OccurrenceType" json:"occurrence_type,omitempty"`
	// Specifies how the entity's value is obtained.
	Method DocumentSchema_EntityType_Property_Method `protobuf:"varint,8,opt,name=method,proto3,enum=google.cloud.documentai.v1beta3.DocumentSchema_EntityType_Property_Method" json:"method,omitempty"`
	// Any additional metadata about the property can be added here.
	PropertyMetadata *PropertyMetadata `protobuf:"bytes,5,opt,name=property_metadata,json=propertyMetadata,proto3" json:"property_metadata,omitempty"`
	// contains filtered or unexported fields
}

Defines properties that can be part of the entity type.

func (*DocumentSchema_EntityType_Property) Descriptor

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

Deprecated: Use DocumentSchema_EntityType_Property.ProtoReflect.Descriptor instead.

func (*DocumentSchema_EntityType_Property) GetDescription

func (x *DocumentSchema_EntityType_Property) GetDescription() string

func (*DocumentSchema_EntityType_Property) GetDisplayName

func (x *DocumentSchema_EntityType_Property) GetDisplayName() string

func (*DocumentSchema_EntityType_Property) GetMethod

func (x *DocumentSchema_EntityType_Property) GetMethod() DocumentSchema_EntityType_Property_Method

func (*DocumentSchema_EntityType_Property) GetName

func (x *DocumentSchema_EntityType_Property) GetName() string

func (*DocumentSchema_EntityType_Property) GetOccurrenceType

func (x *DocumentSchema_EntityType_Property) GetOccurrenceType() DocumentSchema_EntityType_Property_OccurrenceType

func (*DocumentSchema_EntityType_Property) GetPropertyMetadata

func (x *DocumentSchema_EntityType_Property) GetPropertyMetadata() *PropertyMetadata

func (*DocumentSchema_EntityType_Property) GetValueType

func (x *DocumentSchema_EntityType_Property) GetValueType() string

func (*DocumentSchema_EntityType_Property) ProtoMessage

func (*DocumentSchema_EntityType_Property) ProtoMessage()

func (*DocumentSchema_EntityType_Property) ProtoReflect

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

func (*DocumentSchema_EntityType_Property) Reset

func (x *DocumentSchema_EntityType_Property) Reset()

func (*DocumentSchema_EntityType_Property) String

func (x *DocumentSchema_EntityType_Property) String() string

DocumentSchema_EntityType_Property_Method

type DocumentSchema_EntityType_Property_Method int32

Specifies how the entity's value is obtained from the document.

DocumentSchema_EntityType_Property_METHOD_UNSPECIFIED, DocumentSchema_EntityType_Property_EXTRACT, DocumentSchema_EntityType_Property_DERIVE

const (
	// Unspecified method. It defaults to `EXTRACT`.
	DocumentSchema_EntityType_Property_METHOD_UNSPECIFIED DocumentSchema_EntityType_Property_Method = 0
	// The entity's value is directly extracted as-is from the document
	// text.
	DocumentSchema_EntityType_Property_EXTRACT DocumentSchema_EntityType_Property_Method = 1
	// The entity's value is derived through inference and is not
	// necessarily an exact text extraction from the document.
	DocumentSchema_EntityType_Property_DERIVE DocumentSchema_EntityType_Property_Method = 2
)

func (DocumentSchema_EntityType_Property_Method) Descriptor

func (DocumentSchema_EntityType_Property_Method) Descriptor() protoreflect.EnumDescriptor

func (DocumentSchema_EntityType_Property_Method) Enum

func (x DocumentSchema_EntityType_Property_Method) Enum() *DocumentSchema_EntityType_Property_Method

func (DocumentSchema_EntityType_Property_Method) EnumDescriptor

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

Deprecated: Use DocumentSchema_EntityType_Property_Method.Descriptor instead.

func (DocumentSchema_EntityType_Property_Method) Number

func (x DocumentSchema_EntityType_Property_Method) Number() protoreflect.EnumNumber

func (DocumentSchema_EntityType_Property_Method) String

func (x DocumentSchema_EntityType_Property_Method) String() string

func (DocumentSchema_EntityType_Property_Method) Type

func (DocumentSchema_EntityType_Property_Method) Type() protoreflect.EnumType

DocumentSchema_EntityType_Property_OccurrenceType

type DocumentSchema_EntityType_Property_OccurrenceType int32

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

DocumentSchema_EntityType_Property_OCCURRENCE_TYPE_UNSPECIFIED, DocumentSchema_EntityType_Property_OPTIONAL_ONCE, DocumentSchema_EntityType_Property_OPTIONAL_MULTIPLE, DocumentSchema_EntityType_Property_REQUIRED_ONCE, DocumentSchema_EntityType_Property_REQUIRED_MULTIPLE

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

func (DocumentSchema_EntityType_Property_OccurrenceType) Descriptor

func (DocumentSchema_EntityType_Property_OccurrenceType) Descriptor() protoreflect.EnumDescriptor

func (DocumentSchema_EntityType_Property_OccurrenceType) Enum

func (x DocumentSchema_EntityType_Property_OccurrenceType) Enum() *DocumentSchema_EntityType_Property_OccurrenceType

func (DocumentSchema_EntityType_Property_OccurrenceType) EnumDescriptor

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

Deprecated: Use DocumentSchema_EntityType_Property_OccurrenceType.Descriptor instead.

func (DocumentSchema_EntityType_Property_OccurrenceType) Number

func (x DocumentSchema_EntityType_Property_OccurrenceType) Number() protoreflect.EnumNumber

func (DocumentSchema_EntityType_Property_OccurrenceType) String

func (x DocumentSchema_EntityType_Property_OccurrenceType) String() string

func (DocumentSchema_EntityType_Property_OccurrenceType) Type

func (DocumentSchema_EntityType_Property_OccurrenceType) Type() protoreflect.EnumType

DocumentSchema_Metadata

type DocumentSchema_Metadata struct {

	// If true, a `document` entity type can be applied to subdocument
	// (splitting). Otherwise, it can only be applied to the entire document
	// (classification).
	DocumentSplitter bool `protobuf:"varint,1,opt,name=document_splitter,json=documentSplitter,proto3" json:"document_splitter,omitempty"`
	// If true, on a given page, there can be multiple `document` annotations
	// covering it.
	DocumentAllowMultipleLabels bool `protobuf:"varint,2,opt,name=document_allow_multiple_labels,json=documentAllowMultipleLabels,proto3" json:"document_allow_multiple_labels,omitempty"`
	// If set, all the nested entities must be prefixed with the parents.
	PrefixedNamingOnProperties bool `protobuf:"varint,6,opt,name=prefixed_naming_on_properties,json=prefixedNamingOnProperties,proto3" json:"prefixed_naming_on_properties,omitempty"`
	// If set, we will skip the naming format validation in the schema. So the
	// string values in `DocumentSchema.EntityType.name` and
	// `DocumentSchema.EntityType.Property.name` will not be checked.
	SkipNamingValidation bool `protobuf:"varint,7,opt,name=skip_naming_validation,json=skipNamingValidation,proto3" json:"skip_naming_validation,omitempty"`
	// contains filtered or unexported fields
}

Metadata for global schema behavior.

func (*DocumentSchema_Metadata) Descriptor

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

Deprecated: Use DocumentSchema_Metadata.ProtoReflect.Descriptor instead.

func (*DocumentSchema_Metadata) GetDocumentAllowMultipleLabels

func (x *DocumentSchema_Metadata) GetDocumentAllowMultipleLabels() bool

func (*DocumentSchema_Metadata) GetDocumentSplitter

func (x *DocumentSchema_Metadata) GetDocumentSplitter() bool

func (*DocumentSchema_Metadata) GetPrefixedNamingOnProperties

func (x *DocumentSchema_Metadata) GetPrefixedNamingOnProperties() bool

func (*DocumentSchema_Metadata) GetSkipNamingValidation

func (x *DocumentSchema_Metadata) GetSkipNamingValidation() bool

func (*DocumentSchema_Metadata) ProtoMessage

func (*DocumentSchema_Metadata) ProtoMessage()

func (*DocumentSchema_Metadata) ProtoReflect

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

func (*DocumentSchema_Metadata) Reset

func (x *DocumentSchema_Metadata) Reset()

func (*DocumentSchema_Metadata) String

func (x *DocumentSchema_Metadata) String() string

DocumentServiceClient

type DocumentServiceClient interface {
	// Updates metadata associated with a dataset.
	// Note that this method requires the
	// `documentai.googleapis.com/datasets.update` 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.
	UpdateDataset(ctx context.Context, in *UpdateDatasetRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Import documents into a dataset.
	ImportDocuments(ctx context.Context, in *ImportDocumentsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Returns relevant fields present in the requested document.
	GetDocument(ctx context.Context, in *GetDocumentRequest, opts ...grpc.CallOption) (*GetDocumentResponse, error)
	// Returns a list of documents present in the dataset.
	ListDocuments(ctx context.Context, in *ListDocumentsRequest, opts ...grpc.CallOption) (*ListDocumentsResponse, error)
	// Deletes a set of documents.
	BatchDeleteDocuments(ctx context.Context, in *BatchDeleteDocumentsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets the `DatasetSchema` of a `Dataset`.
	GetDatasetSchema(ctx context.Context, in *GetDatasetSchemaRequest, opts ...grpc.CallOption) (*DatasetSchema, error)
	// Updates a `DatasetSchema`.
	UpdateDatasetSchema(ctx context.Context, in *UpdateDatasetSchemaRequest, opts ...grpc.CallOption) (*DatasetSchema, error)
}

DocumentServiceClient is the client API for DocumentService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewDocumentServiceClient

func NewDocumentServiceClient(cc grpc.ClientConnInterface) DocumentServiceClient

DocumentServiceServer

type DocumentServiceServer interface {
	// Updates metadata associated with a dataset.
	// Note that this method requires the
	// `documentai.googleapis.com/datasets.update` 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.
	UpdateDataset(context.Context, *UpdateDatasetRequest) (*longrunningpb.Operation, error)
	// Import documents into a dataset.
	ImportDocuments(context.Context, *ImportDocumentsRequest) (*longrunningpb.Operation, error)
	// Returns relevant fields present in the requested document.
	GetDocument(context.Context, *GetDocumentRequest) (*GetDocumentResponse, error)
	// Returns a list of documents present in the dataset.
	ListDocuments(context.Context, *ListDocumentsRequest) (*ListDocumentsResponse, error)
	// Deletes a set of documents.
	BatchDeleteDocuments(context.Context, *BatchDeleteDocumentsRequest) (*longrunningpb.Operation, error)
	// Gets the `DatasetSchema` of a `Dataset`.
	GetDatasetSchema(context.Context, *GetDatasetSchemaRequest) (*DatasetSchema, error)
	// Updates a `DatasetSchema`.
	UpdateDatasetSchema(context.Context, *UpdateDatasetSchemaRequest) (*DatasetSchema, error)
}

DocumentServiceServer is the server API for DocumentService service. All implementations should embed UnimplementedDocumentServiceServer for forward compatibility

Document_Annotations

type Document_Annotations struct {

	// The description of the content with this annotation.
	Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

Represents the annotation of a block or a chunk.

func (*Document_Annotations) Descriptor

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

Deprecated: Use Document_Annotations.ProtoReflect.Descriptor instead.

func (*Document_Annotations) GetDescription

func (x *Document_Annotations) GetDescription() string

func (*Document_Annotations) ProtoMessage

func (*Document_Annotations) ProtoMessage()

func (*Document_Annotations) ProtoReflect

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

func (*Document_Annotations) Reset

func (x *Document_Annotations) Reset()

func (*Document_Annotations) String

func (x *Document_Annotations) String() string

Document_BlobAsset

type Document_BlobAsset struct {

	// Optional. The id of the blob asset.
	AssetId string `protobuf:"bytes,1,opt,name=asset_id,json=assetId,proto3" json:"asset_id,omitempty"`
	// Optional. The content of the blob asset, e.g. image bytes.
	Content []byte `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// The mime type of the blob asset.
	// 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"`
	// contains filtered or unexported fields
}

Represents a blob asset. It's used to store the content of the inline blob in this document, e.g. image bytes, such that it can be referenced by other fields in the document via asset id.

func (*Document_BlobAsset) Descriptor

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

Deprecated: Use Document_BlobAsset.ProtoReflect.Descriptor instead.

func (*Document_BlobAsset) GetAssetId

func (x *Document_BlobAsset) GetAssetId() string

func (*Document_BlobAsset) GetContent

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

func (*Document_BlobAsset) GetMimeType

func (x *Document_BlobAsset) GetMimeType() string

func (*Document_BlobAsset) ProtoMessage

func (*Document_BlobAsset) ProtoMessage()

func (*Document_BlobAsset) ProtoReflect

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

func (*Document_BlobAsset) Reset

func (x *Document_BlobAsset) Reset()

func (*Document_BlobAsset) String

func (x *Document_BlobAsset) String() string

Document_ChunkedDocument

type Document_ChunkedDocument struct {

	// List of chunks.
	Chunks []*Document_ChunkedDocument_Chunk `protobuf:"bytes,1,rep,name=chunks,proto3" json:"chunks,omitempty"`
	// contains filtered or unexported fields
}

Represents the chunks that the document is divided into.

func (*Document_ChunkedDocument) Descriptor

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

Deprecated: Use Document_ChunkedDocument.ProtoReflect.Descriptor instead.

func (*Document_ChunkedDocument) GetChunks

func (x *Document_ChunkedDocument) GetChunks() []*Document_ChunkedDocument_Chunk

func (*Document_ChunkedDocument) ProtoMessage

func (*Document_ChunkedDocument) ProtoMessage()

func (*Document_ChunkedDocument) ProtoReflect

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

func (*Document_ChunkedDocument) Reset

func (x *Document_ChunkedDocument) Reset()

func (*Document_ChunkedDocument) String

func (x *Document_ChunkedDocument) String() string

Document_ChunkedDocument_Chunk

type Document_ChunkedDocument_Chunk struct {

	// ID of the chunk.
	ChunkId string `protobuf:"bytes,1,opt,name=chunk_id,json=chunkId,proto3" json:"chunk_id,omitempty"`
	// Unused.
	SourceBlockIds []string `protobuf:"bytes,2,rep,name=source_block_ids,json=sourceBlockIds,proto3" json:"source_block_ids,omitempty"`
	// Text content of the chunk.
	Content string `protobuf:"bytes,3,opt,name=content,proto3" json:"content,omitempty"`
	// Page span of the chunk.
	PageSpan *Document_ChunkedDocument_Chunk_ChunkPageSpan `protobuf:"bytes,4,opt,name=page_span,json=pageSpan,proto3" json:"page_span,omitempty"`
	// Page headers associated with the chunk.
	PageHeaders []*Document_ChunkedDocument_Chunk_ChunkPageHeader `protobuf:"bytes,5,rep,name=page_headers,json=pageHeaders,proto3" json:"page_headers,omitempty"`
	// Page footers associated with the chunk.
	PageFooters []*Document_ChunkedDocument_Chunk_ChunkPageFooter `protobuf:"bytes,6,rep,name=page_footers,json=pageFooters,proto3" json:"page_footers,omitempty"`
	// Chunk fields inside this chunk.
	ChunkFields []*Document_ChunkedDocument_Chunk_ChunkField `protobuf:"bytes,7,rep,name=chunk_fields,json=chunkFields,proto3" json:"chunk_fields,omitempty"`
	// contains filtered or unexported fields
}

Represents a chunk.

func (*Document_ChunkedDocument_Chunk) Descriptor

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

Deprecated: Use Document_ChunkedDocument_Chunk.ProtoReflect.Descriptor instead.

func (*Document_ChunkedDocument_Chunk) GetChunkFields

func (x *Document_ChunkedDocument_Chunk) GetChunkFields() []*Document_ChunkedDocument_Chunk_ChunkField

func (*Document_ChunkedDocument_Chunk) GetChunkId

func (x *Document_ChunkedDocument_Chunk) GetChunkId() string

func (*Document_ChunkedDocument_Chunk) GetContent

func (x *Document_ChunkedDocument_Chunk) GetContent() string

func (*Document_ChunkedDocument_Chunk) GetPageFooters

func (x *Document_ChunkedDocument_Chunk) GetPageFooters() []*Document_ChunkedDocument_Chunk_ChunkPageFooter

func (*Document_ChunkedDocument_Chunk) GetPageHeaders

func (x *Document_ChunkedDocument_Chunk) GetPageHeaders() []*Document_ChunkedDocument_Chunk_ChunkPageHeader

func (*Document_ChunkedDocument_Chunk) GetPageSpan

func (x *Document_ChunkedDocument_Chunk) GetPageSpan() *Document_ChunkedDocument_Chunk_ChunkPageSpan

func (*Document_ChunkedDocument_Chunk) GetSourceBlockIds

func (x *Document_ChunkedDocument_Chunk) GetSourceBlockIds() []string

func (*Document_ChunkedDocument_Chunk) ProtoMessage

func (*Document_ChunkedDocument_Chunk) ProtoMessage()

func (*Document_ChunkedDocument_Chunk) ProtoReflect

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

func (*Document_ChunkedDocument_Chunk) Reset

func (x *Document_ChunkedDocument_Chunk) Reset()

func (*Document_ChunkedDocument_Chunk) String

func (x *Document_ChunkedDocument_Chunk) String() string

Document_ChunkedDocument_Chunk_ChunkField

type Document_ChunkedDocument_Chunk_ChunkField struct {

	// The type of the chunk field.
	//
	// Types that are assignable to FieldType:
	//
	//	*Document_ChunkedDocument_Chunk_ChunkField_ImageChunkField
	//	*Document_ChunkedDocument_Chunk_ChunkField_TableChunkField
	FieldType isDocument_ChunkedDocument_Chunk_ChunkField_FieldType `protobuf_oneof:"field_type"`
	// contains filtered or unexported fields
}

The chunk field in the chunk. A chunk field could be one of the various types (e.g. image, table) supported.

func (*Document_ChunkedDocument_Chunk_ChunkField) Descriptor

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

Deprecated: Use Document_ChunkedDocument_Chunk_ChunkField.ProtoReflect.Descriptor instead.

func (*Document_ChunkedDocument_Chunk_ChunkField) GetFieldType

func (m *Document_ChunkedDocument_Chunk_ChunkField) GetFieldType() isDocument_ChunkedDocument_Chunk_ChunkField_FieldType

func (*Document_ChunkedDocument_Chunk_ChunkField) GetImageChunkField

func (x *Document_ChunkedDocument_Chunk_ChunkField) GetImageChunkField() *Document_ChunkedDocument_Chunk_ImageChunkField

func (*Document_ChunkedDocument_Chunk_ChunkField) GetTableChunkField

func (x *Document_ChunkedDocument_Chunk_ChunkField) GetTableChunkField() *Document_ChunkedDocument_Chunk_TableChunkField

func (*Document_ChunkedDocument_Chunk_ChunkField) ProtoMessage

func (*Document_ChunkedDocument_Chunk_ChunkField) ProtoMessage()

func (*Document_ChunkedDocument_Chunk_ChunkField) ProtoReflect

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

func (*Document_ChunkedDocument_Chunk_ChunkField) Reset

func (x *Document_ChunkedDocument_Chunk_ChunkField) Reset()

func (*Document_ChunkedDocument_Chunk_ChunkField) String

func (x *Document_ChunkedDocument_Chunk_ChunkField) String() string

Document_ChunkedDocument_Chunk_ChunkField_ImageChunkField

type Document_ChunkedDocument_Chunk_ChunkField_ImageChunkField struct {
	// The image chunk field in the chunk.
	ImageChunkField *Document_ChunkedDocument_Chunk_ImageChunkField `protobuf:"bytes,1,opt,name=image_chunk_field,json=imageChunkField,proto3,oneof"`
}

Document_ChunkedDocument_Chunk_ChunkField_TableChunkField

type Document_ChunkedDocument_Chunk_ChunkField_TableChunkField struct {
	// The table chunk field in the chunk.
	TableChunkField *Document_ChunkedDocument_Chunk_TableChunkField `protobuf:"bytes,2,opt,name=table_chunk_field,json=tableChunkField,proto3,oneof"`
}

Document_ChunkedDocument_Chunk_ChunkPageFooter

type Document_ChunkedDocument_Chunk_ChunkPageFooter struct {

	// Footer in text format.
	Text string `protobuf:"bytes,1,opt,name=text,proto3" json:"text,omitempty"`
	// Page span of the footer.
	PageSpan *Document_ChunkedDocument_Chunk_ChunkPageSpan `protobuf:"bytes,2,opt,name=page_span,json=pageSpan,proto3" json:"page_span,omitempty"`
	// contains filtered or unexported fields
}

Represents the page footer associated with the chunk.

func (*Document_ChunkedDocument_Chunk_ChunkPageFooter) Descriptor

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

Deprecated: Use Document_ChunkedDocument_Chunk_ChunkPageFooter.ProtoReflect.Descriptor instead.

func (*Document_ChunkedDocument_Chunk_ChunkPageFooter) GetPageSpan

func (x *Document_ChunkedDocument_Chunk_ChunkPageFooter) GetPageSpan() *Document_ChunkedDocument_Chunk_ChunkPageSpan

func (*Document_ChunkedDocument_Chunk_ChunkPageFooter) GetText

func (x *Document_ChunkedDocument_Chunk_ChunkPageFooter) GetText() string

func (*Document_ChunkedDocument_Chunk_ChunkPageFooter) ProtoMessage

func (*Document_ChunkedDocument_Chunk_ChunkPageFooter) ProtoMessage()

func (*Document_ChunkedDocument_Chunk_ChunkPageFooter) ProtoReflect

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

func (*Document_ChunkedDocument_Chunk_ChunkPageFooter) Reset

func (x *Document_ChunkedDocument_Chunk_ChunkPageFooter) Reset()

func (*Document_ChunkedDocument_Chunk_ChunkPageFooter) String

func (x *Document_ChunkedDocument_Chunk_ChunkPageFooter) String() string

Document_ChunkedDocument_Chunk_ChunkPageHeader

type Document_ChunkedDocument_Chunk_ChunkPageHeader struct {

	// Header in text format.
	Text string `protobuf:"bytes,1,opt,name=text,proto3" json:"text,omitempty"`
	// Page span of the header.
	PageSpan *Document_ChunkedDocument_Chunk_ChunkPageSpan `protobuf:"bytes,2,opt,name=page_span,json=pageSpan,proto3" json:"page_span,omitempty"`
	// contains filtered or unexported fields
}

Represents the page header associated with the chunk.

func (*Document_ChunkedDocument_Chunk_ChunkPageHeader) Descriptor

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

Deprecated: Use Document_ChunkedDocument_Chunk_ChunkPageHeader.ProtoReflect.Descriptor instead.

func (*Document_ChunkedDocument_Chunk_ChunkPageHeader) GetPageSpan

func (x *Document_ChunkedDocument_Chunk_ChunkPageHeader) GetPageSpan() *Document_ChunkedDocument_Chunk_ChunkPageSpan

func (*Document_ChunkedDocument_Chunk_ChunkPageHeader) GetText

func (x *Document_ChunkedDocument_Chunk_ChunkPageHeader) GetText() string

func (*Document_ChunkedDocument_Chunk_ChunkPageHeader) ProtoMessage

func (*Document_ChunkedDocument_Chunk_ChunkPageHeader) ProtoMessage()

func (*Document_ChunkedDocument_Chunk_ChunkPageHeader) ProtoReflect

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

func (*Document_ChunkedDocument_Chunk_ChunkPageHeader) Reset

func (x *Document_ChunkedDocument_Chunk_ChunkPageHeader) Reset()

func (*Document_ChunkedDocument_Chunk_ChunkPageHeader) String

func (x *Document_ChunkedDocument_Chunk_ChunkPageHeader) String() string

Document_ChunkedDocument_Chunk_ChunkPageSpan

type Document_ChunkedDocument_Chunk_ChunkPageSpan struct {

	// Page where chunk starts in the document.
	PageStart int32 `protobuf:"varint,1,opt,name=page_start,json=pageStart,proto3" json:"page_start,omitempty"`
	// Page where chunk ends in the document.
	PageEnd int32 `protobuf:"varint,2,opt,name=page_end,json=pageEnd,proto3" json:"page_end,omitempty"`
	// contains filtered or unexported fields
}

Represents where the chunk starts and ends in the document.

func (*Document_ChunkedDocument_Chunk_ChunkPageSpan) Descriptor

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

Deprecated: Use Document_ChunkedDocument_Chunk_ChunkPageSpan.ProtoReflect.Descriptor instead.

func (*Document_ChunkedDocument_Chunk_ChunkPageSpan) GetPageEnd

func (x *Document_ChunkedDocument_Chunk_ChunkPageSpan) GetPageEnd() int32

func (*Document_ChunkedDocument_Chunk_ChunkPageSpan) GetPageStart

func (x *Document_ChunkedDocument_Chunk_ChunkPageSpan) GetPageStart() int32

func (*Document_ChunkedDocument_Chunk_ChunkPageSpan) ProtoMessage

func (*Document_ChunkedDocument_Chunk_ChunkPageSpan) ProtoMessage()

func (*Document_ChunkedDocument_Chunk_ChunkPageSpan) ProtoReflect

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

func (*Document_ChunkedDocument_Chunk_ChunkPageSpan) Reset

func (x *Document_ChunkedDocument_Chunk_ChunkPageSpan) Reset()

func (*Document_ChunkedDocument_Chunk_ChunkPageSpan) String

func (x *Document_ChunkedDocument_Chunk_ChunkPageSpan) String() string

Document_ChunkedDocument_Chunk_ImageChunkField

type Document_ChunkedDocument_Chunk_ImageChunkField struct {

	// Source of the image.
	//
	// Types that are assignable to ImageSource:
	//
	//	*Document_ChunkedDocument_Chunk_ImageChunkField_BlobAssetId
	//	*Document_ChunkedDocument_Chunk_ImageChunkField_GcsUri
	//	*Document_ChunkedDocument_Chunk_ImageChunkField_DataUri
	ImageSource isDocument_ChunkedDocument_Chunk_ImageChunkField_ImageSource `protobuf_oneof:"image_source"`
	// Annotation of the image chunk field.
	Annotations *Document_Annotations `protobuf:"bytes,4,opt,name=annotations,proto3" json:"annotations,omitempty"`
	// contains filtered or unexported fields
}

The image chunk field in the chunk.

func (*Document_ChunkedDocument_Chunk_ImageChunkField) Descriptor

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

Deprecated: Use Document_ChunkedDocument_Chunk_ImageChunkField.ProtoReflect.Descriptor instead.

func (*Document_ChunkedDocument_Chunk_ImageChunkField) GetAnnotations

func (x *Document_ChunkedDocument_Chunk_ImageChunkField) GetAnnotations() *Document_Annotations

func (*Document_ChunkedDocument_Chunk_ImageChunkField) GetBlobAssetId

func (x *Document_ChunkedDocument_Chunk_ImageChunkField) GetBlobAssetId() string

func (*Document_ChunkedDocument_Chunk_ImageChunkField) GetDataUri

func (x *Document_ChunkedDocument_Chunk_ImageChunkField) GetDataUri() string

func (*Document_ChunkedDocument_Chunk_ImageChunkField) GetGcsUri

func (x *Document_ChunkedDocument_Chunk_ImageChunkField) GetGcsUri() string

func (*Document_ChunkedDocument_Chunk_ImageChunkField) GetImageSource

func (m *Document_ChunkedDocument_Chunk_ImageChunkField) GetImageSource() isDocument_ChunkedDocument_Chunk_ImageChunkField_ImageSource

func (*Document_ChunkedDocument_Chunk_ImageChunkField) ProtoMessage

func (*Document_ChunkedDocument_Chunk_ImageChunkField) ProtoMessage()

func (*Document_ChunkedDocument_Chunk_ImageChunkField) ProtoReflect

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

func (*Document_ChunkedDocument_Chunk_ImageChunkField) Reset

func (x *Document_ChunkedDocument_Chunk_ImageChunkField) Reset()

func (*Document_ChunkedDocument_Chunk_ImageChunkField) String

func (x *Document_ChunkedDocument_Chunk_ImageChunkField) String() string

Document_ChunkedDocument_Chunk_ImageChunkField_BlobAssetId

type Document_ChunkedDocument_Chunk_ImageChunkField_BlobAssetId struct {
	// Optional. Asset id of the inline image. If set, find the image
	// content in the blob_assets field.
	BlobAssetId string `protobuf:"bytes,1,opt,name=blob_asset_id,json=blobAssetId,proto3,oneof"`
}

Document_ChunkedDocument_Chunk_ImageChunkField_DataUri

type Document_ChunkedDocument_Chunk_ImageChunkField_DataUri struct {
	// Optional. Data uri of the image.
	// It is composed of four parts: a prefix (data:), a MIME type
	// indicating the type of data, an optional base64 token if
	// non-textual, and the data itself:
	// data:[

Document_ChunkedDocument_Chunk_ImageChunkField_GcsUri

type Document_ChunkedDocument_Chunk_ImageChunkField_GcsUri struct {
	// Optional. Google Cloud Storage uri of the image.
	GcsUri string `protobuf:"bytes,2,opt,name=gcs_uri,json=gcsUri,proto3,oneof"`
}

Document_ChunkedDocument_Chunk_TableChunkField

type Document_ChunkedDocument_Chunk_TableChunkField struct {

	// Annotation of the table chunk field.
	Annotations *Document_Annotations `protobuf:"bytes,1,opt,name=annotations,proto3" json:"annotations,omitempty"`
	// contains filtered or unexported fields
}

The table chunk field in the chunk.

func (*Document_ChunkedDocument_Chunk_TableChunkField) Descriptor

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

Deprecated: Use Document_ChunkedDocument_Chunk_TableChunkField.ProtoReflect.Descriptor instead.

func (*Document_ChunkedDocument_Chunk_TableChunkField) GetAnnotations

func (x *Document_ChunkedDocument_Chunk_TableChunkField) GetAnnotations() *Document_Annotations

func (*Document_ChunkedDocument_Chunk_TableChunkField) ProtoMessage

func (*Document_ChunkedDocument_Chunk_TableChunkField) ProtoMessage()

func (*Document_ChunkedDocument_Chunk_TableChunkField) ProtoReflect

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

func (*Document_ChunkedDocument_Chunk_TableChunkField) Reset

func (x *Document_ChunkedDocument_Chunk_TableChunkField) Reset()

func (*Document_ChunkedDocument_Chunk_TableChunkField) String

func (x *Document_ChunkedDocument_Chunk_TableChunkField) String() string

Document_Content

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

Document_DocumentLayout

type Document_DocumentLayout struct {

	// List of blocks in the document.
	Blocks []*Document_DocumentLayout_DocumentLayoutBlock `protobuf:"bytes,1,rep,name=blocks,proto3" json:"blocks,omitempty"`
	// contains filtered or unexported fields
}

Represents the parsed layout of a document as a collection of blocks that the document is divided into.

func (*Document_DocumentLayout) Descriptor

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

Deprecated: Use Document_DocumentLayout.ProtoReflect.Descriptor instead.

func (*Document_DocumentLayout) GetBlocks

func (x *Document_DocumentLayout) GetBlocks() []*Document_DocumentLayout_DocumentLayoutBlock

func (*Document_DocumentLayout) ProtoMessage

func (*Document_DocumentLayout) ProtoMessage()

func (*Document_DocumentLayout) ProtoReflect

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

func (*Document_DocumentLayout) Reset

func (x *Document_DocumentLayout) Reset()

func (*Document_DocumentLayout) String

func (x *Document_DocumentLayout) String() string

Document_DocumentLayout_DocumentLayoutBlock

type Document_DocumentLayout_DocumentLayoutBlock struct {

	// Types that are assignable to Block:
	//
	//	*Document_DocumentLayout_DocumentLayoutBlock_TextBlock
	//	*Document_DocumentLayout_DocumentLayoutBlock_TableBlock
	//	*Document_DocumentLayout_DocumentLayoutBlock_ListBlock
	//	*Document_DocumentLayout_DocumentLayoutBlock_ImageBlock
	Block isDocument_DocumentLayout_DocumentLayoutBlock_Block `protobuf_oneof:"block"`
	// ID of the block.
	BlockId string `protobuf:"bytes,1,opt,name=block_id,json=blockId,proto3" json:"block_id,omitempty"`
	// Page span of the block.
	PageSpan *Document_DocumentLayout_DocumentLayoutBlock_LayoutPageSpan `protobuf:"bytes,5,opt,name=page_span,json=pageSpan,proto3" json:"page_span,omitempty"`
	// Identifies the bounding box for the block.
	BoundingBox *BoundingPoly `protobuf:"bytes,6,opt,name=bounding_box,json=boundingBox,proto3" json:"bounding_box,omitempty"`
	// contains filtered or unexported fields
}

Represents a block. A block could be one of the various types (text, table, list) supported.

func (*Document_DocumentLayout_DocumentLayoutBlock) Descriptor

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

Deprecated: Use Document_DocumentLayout_DocumentLayoutBlock.ProtoReflect.Descriptor instead.

func (*Document_DocumentLayout_DocumentLayoutBlock) GetBlock

func (m *Document_DocumentLayout_DocumentLayoutBlock) GetBlock() isDocument_DocumentLayout_DocumentLayoutBlock_Block

func (*Document_DocumentLayout_DocumentLayoutBlock) GetBlockId

func (x *Document_DocumentLayout_DocumentLayoutBlock) GetBlockId() string

func (*Document_DocumentLayout_DocumentLayoutBlock) GetBoundingBox

func (x *Document_DocumentLayout_DocumentLayoutBlock) GetBoundingBox() *BoundingPoly

func (*Document_DocumentLayout_DocumentLayoutBlock) GetImageBlock

func (x *Document_DocumentLayout_DocumentLayoutBlock) GetImageBlock() *Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock

func (*Document_DocumentLayout_DocumentLayoutBlock) GetListBlock

func (x *Document_DocumentLayout_DocumentLayoutBlock) GetListBlock() *Document_DocumentLayout_DocumentLayoutBlock_LayoutListBlock

func (*Document_DocumentLayout_DocumentLayoutBlock) GetPageSpan

func (x *Document_DocumentLayout_DocumentLayoutBlock) GetPageSpan() *Document_DocumentLayout_DocumentLayoutBlock_LayoutPageSpan

func (*Document_DocumentLayout_DocumentLayoutBlock) GetTableBlock

func (x *Document_DocumentLayout_DocumentLayoutBlock) GetTableBlock() *Document_DocumentLayout_DocumentLayoutBlock_LayoutTableBlock

func (*Document_DocumentLayout_DocumentLayoutBlock) GetTextBlock

func (x *Document_DocumentLayout_DocumentLayoutBlock) GetTextBlock() *Document_DocumentLayout_DocumentLayoutBlock_LayoutTextBlock

func (*Document_DocumentLayout_DocumentLayoutBlock) ProtoMessage

func (*Document_DocumentLayout_DocumentLayoutBlock) ProtoMessage()

func (*Document_DocumentLayout_DocumentLayoutBlock) ProtoReflect

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

func (*Document_DocumentLayout_DocumentLayoutBlock) Reset

func (x *Document_DocumentLayout_DocumentLayoutBlock) Reset()

func (*Document_DocumentLayout_DocumentLayoutBlock) String

func (x *Document_DocumentLayout_DocumentLayoutBlock) String() string

Document_DocumentLayout_DocumentLayoutBlock_ImageBlock

type Document_DocumentLayout_DocumentLayoutBlock_ImageBlock struct {
	// Block consisting of image content.
	ImageBlock *Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock `protobuf:"bytes,7,opt,name=image_block,json=imageBlock,proto3,oneof"`
}

Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock

type Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock struct {

	// Source of the image.
	//
	// Types that are assignable to ImageSource:
	//
	//	*Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock_BlobAssetId
	//	*Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock_GcsUri
	//	*Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock_DataUri
	ImageSource isDocument_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock_ImageSource `protobuf_oneof:"image_source"`
	// Mime type of the image. An IANA published [media type (MIME type)]
	// (https://www.iana.org/assignments/media-types/media-types.xhtml).
	MimeType string `protobuf:"bytes,1,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// Text extracted from the image using OCR or alt text describing the
	// image.
	ImageText string `protobuf:"bytes,2,opt,name=image_text,json=imageText,proto3" json:"image_text,omitempty"`
	// Annotation of the image block.
	Annotations *Document_Annotations `protobuf:"bytes,3,opt,name=annotations,proto3" json:"annotations,omitempty"`
	// contains filtered or unexported fields
}

Represents an image type block.

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock) Descriptor

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

Deprecated: Use Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock.ProtoReflect.Descriptor instead.

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock) GetAnnotations

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock) GetAnnotations() *Document_Annotations

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock) GetBlobAssetId

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock) GetBlobAssetId() string

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock) GetDataUri

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock) GetDataUri() string

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock) GetGcsUri

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock) GetGcsUri() string

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock) GetImageSource

func (m *Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock) GetImageSource() isDocument_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock_ImageSource

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock) GetImageText

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock) GetImageText() string

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock) GetMimeType

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock) GetMimeType() string

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock) ProtoMessage

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock) ProtoMessage()

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock) ProtoReflect

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

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock) Reset

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock) Reset()

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock) String

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock) String() string

Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock_BlobAssetId

type Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock_BlobAssetId struct {
	// Optional. Asset id of the inline image. If set, find the image
	// content in the blob_assets field.
	BlobAssetId string `protobuf:"bytes,4,opt,name=blob_asset_id,json=blobAssetId,proto3,oneof"`
}

Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock_DataUri

type Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock_DataUri struct {
	// Optional. Data uri of the image.
	// It is composed of four parts: a prefix (data:), a MIME type
	// indicating the type of data, an optional base64 token if
	// non-textual, and the data itself:
	// data:[

Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock_GcsUri

type Document_DocumentLayout_DocumentLayoutBlock_LayoutImageBlock_GcsUri struct {
	// Optional. Google Cloud Storage uri of the image.
	GcsUri string `protobuf:"bytes,5,opt,name=gcs_uri,json=gcsUri,proto3,oneof"`
}

Document_DocumentLayout_DocumentLayoutBlock_LayoutListBlock

type Document_DocumentLayout_DocumentLayoutBlock_LayoutListBlock struct {

	// List entries that constitute a list block.
	ListEntries []*Document_DocumentLayout_DocumentLayoutBlock_LayoutListEntry `protobuf:"bytes,1,rep,name=list_entries,json=listEntries,proto3" json:"list_entries,omitempty"`
	// Type of the list_entries (if exist). Available options are `ordered`
	// and `unordered`.
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// contains filtered or unexported fields
}

Represents a list type block.

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutListBlock) Descriptor

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

Deprecated: Use Document_DocumentLayout_DocumentLayoutBlock_LayoutListBlock.ProtoReflect.Descriptor instead.

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutListBlock) GetListEntries

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutListBlock) GetListEntries() []*Document_DocumentLayout_DocumentLayoutBlock_LayoutListEntry

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutListBlock) GetType

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutListBlock) GetType() string

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutListBlock) ProtoMessage

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutListBlock) ProtoMessage()

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutListBlock) ProtoReflect

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

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutListBlock) Reset

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutListBlock) Reset()

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutListBlock) String

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutListBlock) String() string

Document_DocumentLayout_DocumentLayoutBlock_LayoutListEntry

type Document_DocumentLayout_DocumentLayoutBlock_LayoutListEntry struct {

	// A list entry is a list of blocks.
	// Repeated blocks support further hierarchies and nested blocks.
	Blocks []*Document_DocumentLayout_DocumentLayoutBlock `protobuf:"bytes,1,rep,name=blocks,proto3" json:"blocks,omitempty"`
	// contains filtered or unexported fields
}

Represents an entry in the list.

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutListEntry) Descriptor

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

Deprecated: Use Document_DocumentLayout_DocumentLayoutBlock_LayoutListEntry.ProtoReflect.Descriptor instead.

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutListEntry) GetBlocks

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutListEntry) GetBlocks() []*Document_DocumentLayout_DocumentLayoutBlock

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutListEntry) ProtoMessage

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutListEntry) ProtoMessage()

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutListEntry) ProtoReflect

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

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutListEntry) Reset

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutListEntry) Reset()

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutListEntry) String

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutListEntry) String() string

Document_DocumentLayout_DocumentLayoutBlock_LayoutPageSpan

type Document_DocumentLayout_DocumentLayoutBlock_LayoutPageSpan struct {

	// Page where block starts in the document.
	PageStart int32 `protobuf:"varint,1,opt,name=page_start,json=pageStart,proto3" json:"page_start,omitempty"`
	// Page where block ends in the document.
	PageEnd int32 `protobuf:"varint,2,opt,name=page_end,json=pageEnd,proto3" json:"page_end,omitempty"`
	// contains filtered or unexported fields
}

Represents where the block starts and ends in the document.

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutPageSpan) Descriptor

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

Deprecated: Use Document_DocumentLayout_DocumentLayoutBlock_LayoutPageSpan.ProtoReflect.Descriptor instead.

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutPageSpan) GetPageEnd

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutPageSpan) GetPageEnd() int32

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutPageSpan) GetPageStart

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutPageSpan) GetPageStart() int32

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutPageSpan) ProtoMessage

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutPageSpan) ProtoMessage()

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutPageSpan) ProtoReflect

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

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutPageSpan) Reset

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutPageSpan) Reset()

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutPageSpan) String

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutPageSpan) String() string

Document_DocumentLayout_DocumentLayoutBlock_LayoutTableBlock

type Document_DocumentLayout_DocumentLayoutBlock_LayoutTableBlock struct {

	// Header rows at the top of the table.
	HeaderRows []*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableRow `protobuf:"bytes,1,rep,name=header_rows,json=headerRows,proto3" json:"header_rows,omitempty"`
	// Body rows containing main table content.
	BodyRows []*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableRow `protobuf:"bytes,2,rep,name=body_rows,json=bodyRows,proto3" json:"body_rows,omitempty"`
	// Table caption/title.
	Caption string `protobuf:"bytes,3,opt,name=caption,proto3" json:"caption,omitempty"`
	// Annotation of the table block.
	Annotations *Document_Annotations `protobuf:"bytes,4,opt,name=annotations,proto3" json:"annotations,omitempty"`
	// contains filtered or unexported fields
}

Represents a table type block.

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableBlock) Descriptor

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

Deprecated: Use Document_DocumentLayout_DocumentLayoutBlock_LayoutTableBlock.ProtoReflect.Descriptor instead.

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableBlock) GetAnnotations

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutTableBlock) GetAnnotations() *Document_Annotations

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableBlock) GetBodyRows

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutTableBlock) GetBodyRows() []*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableRow

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableBlock) GetCaption

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutTableBlock) GetCaption() string

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableBlock) GetHeaderRows

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutTableBlock) GetHeaderRows() []*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableRow

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableBlock) ProtoMessage

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableBlock) ProtoMessage()

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableBlock) ProtoReflect

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

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableBlock) Reset

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutTableBlock) Reset()

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableBlock) String

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutTableBlock) String() string

Document_DocumentLayout_DocumentLayoutBlock_LayoutTableCell

type Document_DocumentLayout_DocumentLayoutBlock_LayoutTableCell struct {

	// A table cell is a list of blocks.
	// Repeated blocks support further hierarchies and nested blocks.
	Blocks []*Document_DocumentLayout_DocumentLayoutBlock `protobuf:"bytes,1,rep,name=blocks,proto3" json:"blocks,omitempty"`
	// How many rows this cell spans.
	RowSpan int32 `protobuf:"varint,2,opt,name=row_span,json=rowSpan,proto3" json:"row_span,omitempty"`
	// How many columns this cell spans.
	ColSpan int32 `protobuf:"varint,3,opt,name=col_span,json=colSpan,proto3" json:"col_span,omitempty"`
	// contains filtered or unexported fields
}

Represents a cell in a table row.

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableCell) Descriptor

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

Deprecated: Use Document_DocumentLayout_DocumentLayoutBlock_LayoutTableCell.ProtoReflect.Descriptor instead.

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableCell) GetBlocks

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutTableCell) GetBlocks() []*Document_DocumentLayout_DocumentLayoutBlock

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableCell) GetColSpan

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutTableCell) GetColSpan() int32

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableCell) GetRowSpan

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutTableCell) GetRowSpan() int32

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableCell) ProtoMessage

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableCell) ProtoMessage()

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableCell) ProtoReflect

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

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableCell) Reset

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutTableCell) Reset()

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableCell) String

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutTableCell) String() string

Document_DocumentLayout_DocumentLayoutBlock_LayoutTableRow

type Document_DocumentLayout_DocumentLayoutBlock_LayoutTableRow struct {

	// A table row is a list of table cells.
	Cells []*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableCell `protobuf:"bytes,1,rep,name=cells,proto3" json:"cells,omitempty"`
	// contains filtered or unexported fields
}

Represents a row in a table.

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableRow) Descriptor

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

Deprecated: Use Document_DocumentLayout_DocumentLayoutBlock_LayoutTableRow.ProtoReflect.Descriptor instead.

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableRow) GetCells

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutTableRow) GetCells() []*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableCell

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableRow) ProtoMessage

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableRow) ProtoMessage()

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableRow) ProtoReflect

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

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableRow) Reset

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutTableRow) Reset()

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTableRow) String

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutTableRow) String() string

Document_DocumentLayout_DocumentLayoutBlock_LayoutTextBlock

type Document_DocumentLayout_DocumentLayoutBlock_LayoutTextBlock struct {

	// Text content stored in the block.
	Text string `protobuf:"bytes,1,opt,name=text,proto3" json:"text,omitempty"`
	// Type of the text in the block. Available options are: `paragraph`,
	// `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`,
	// `heading-5`, `header`, `footer`.
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// A text block could further have child blocks.
	// Repeated blocks support further hierarchies and nested blocks.
	Blocks []*Document_DocumentLayout_DocumentLayoutBlock `protobuf:"bytes,3,rep,name=blocks,proto3" json:"blocks,omitempty"`
	// Annotation of the text block.
	Annotations *Document_Annotations `protobuf:"bytes,4,opt,name=annotations,proto3" json:"annotations,omitempty"`
	// contains filtered or unexported fields
}

Represents a text type block.

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTextBlock) Descriptor

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

Deprecated: Use Document_DocumentLayout_DocumentLayoutBlock_LayoutTextBlock.ProtoReflect.Descriptor instead.

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTextBlock) GetAnnotations

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutTextBlock) GetAnnotations() *Document_Annotations

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTextBlock) GetBlocks

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutTextBlock) GetBlocks() []*Document_DocumentLayout_DocumentLayoutBlock

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTextBlock) GetText

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutTextBlock) GetText() string

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTextBlock) GetType

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutTextBlock) GetType() string

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTextBlock) ProtoMessage

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTextBlock) ProtoMessage()

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTextBlock) ProtoReflect

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

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTextBlock) Reset

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutTextBlock) Reset()

func (*Document_DocumentLayout_DocumentLayoutBlock_LayoutTextBlock) String

func (x *Document_DocumentLayout_DocumentLayoutBlock_LayoutTextBlock) String() string

Document_DocumentLayout_DocumentLayoutBlock_ListBlock

type Document_DocumentLayout_DocumentLayoutBlock_ListBlock struct {
	// Block consisting of list content/structure.
	ListBlock *Document_DocumentLayout_DocumentLayoutBlock_LayoutListBlock `protobuf:"bytes,4,opt,name=list_block,json=listBlock,proto3,oneof"`
}

Document_DocumentLayout_DocumentLayoutBlock_TableBlock

type Document_DocumentLayout_DocumentLayoutBlock_TableBlock struct {
	// Block consisting of table content/structure.
	TableBlock *Document_DocumentLayout_DocumentLayoutBlock_LayoutTableBlock `protobuf:"bytes,3,opt,name=table_block,json=tableBlock,proto3,oneof"`
}

Document_DocumentLayout_DocumentLayoutBlock_TextBlock

type Document_DocumentLayout_DocumentLayoutBlock_TextBlock struct {
	// Block consisting of text content.
	TextBlock *Document_DocumentLayout_DocumentLayoutBlock_LayoutTextBlock `protobuf:"bytes,2,opt,name=text_block,json=textBlock,proto3,oneof"`
}

Document_EntitiesRevision

type Document_EntitiesRevision struct {

	// The revision id.
	RevisionId string `protobuf:"bytes,1,opt,name=revision_id,json=revisionId,proto3" json:"revision_id,omitempty"`
	// The entities in this revision.
	Entities []*Document_Entity `protobuf:"bytes,2,rep,name=entities,proto3" json:"entities,omitempty"`
	// The entity validation output for this revision.
	EntityValidationOutput *Document_EntityValidationOutput `protobuf:"bytes,3,opt,name=entity_validation_output,json=entityValidationOutput,proto3" json:"entity_validation_output,omitempty"`
	// contains filtered or unexported fields
}

Entity revision.

func (*Document_EntitiesRevision) Descriptor

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

Deprecated: Use Document_EntitiesRevision.ProtoReflect.Descriptor instead.

func (*Document_EntitiesRevision) GetEntities

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

func (*Document_EntitiesRevision) GetEntityValidationOutput

func (x *Document_EntitiesRevision) GetEntityValidationOutput() *Document_EntityValidationOutput

func (*Document_EntitiesRevision) GetRevisionId

func (x *Document_EntitiesRevision) GetRevisionId() string

func (*Document_EntitiesRevision) ProtoMessage

func (*Document_EntitiesRevision) ProtoMessage()

func (*Document_EntitiesRevision) ProtoReflect

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

func (*Document_EntitiesRevision) Reset

func (x *Document_EntitiesRevision) Reset()

func (*Document_EntitiesRevision) String

func (x *Document_EntitiesRevision) String() string

Document_Entity

type Document_Entity struct {

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

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

func (*Document_Entity) Descriptor

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

Deprecated: Use Document_Entity.ProtoReflect.Descriptor instead.

func (*Document_Entity) GetConfidence

func (x *Document_Entity) GetConfidence() float32

func (*Document_Entity) GetId

func (x *Document_Entity) GetId() string

func (*Document_Entity) GetMentionId

func (x *Document_Entity) GetMentionId() string

func (*Document_Entity) GetMentionText

func (x *Document_Entity) GetMentionText() string

func (*Document_Entity) GetMethod

func (x *Document_Entity) GetMethod() Document_Entity_Method

func (*Document_Entity) GetNormalizedValue

func (x *Document_Entity) GetNormalizedValue() *Document_Entity_NormalizedValue

func (*Document_Entity) GetPageAnchor

func (x *Document_Entity) GetPageAnchor() *Document_PageAnchor

func (*Document_Entity) GetProperties

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

func (*Document_Entity) GetProvenance

func (x *Document_Entity) GetProvenance() *Document_Provenance

func (*Document_Entity) GetRedacted

func (x *Document_Entity) GetRedacted() bool

func (*Document_Entity) GetTextAnchor

func (x *Document_Entity) GetTextAnchor() *Document_TextAnchor

func (*Document_Entity) GetType

func (x *Document_Entity) GetType() string

func (*Document_Entity) ProtoMessage

func (*Document_Entity) ProtoMessage()

func (*Document_Entity) ProtoReflect

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

func (*Document_Entity) Reset

func (x *Document_Entity) Reset()

func (*Document_Entity) String

func (x *Document_Entity) String() string

Document_EntityRelation

type Document_EntityRelation struct {

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

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

func (*Document_EntityRelation) Descriptor

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

Deprecated: Use Document_EntityRelation.ProtoReflect.Descriptor instead.

func (*Document_EntityRelation) GetObjectId

func (x *Document_EntityRelation) GetObjectId() string

func (*Document_EntityRelation) GetRelation

func (x *Document_EntityRelation) GetRelation() string

func (*Document_EntityRelation) GetSubjectId

func (x *Document_EntityRelation) GetSubjectId() string

func (*Document_EntityRelation) ProtoMessage

func (*Document_EntityRelation) ProtoMessage()

func (*Document_EntityRelation) ProtoReflect

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

func (*Document_EntityRelation) Reset

func (x *Document_EntityRelation) Reset()

func (*Document_EntityRelation) String

func (x *Document_EntityRelation) String() string

Document_EntityValidationOutput

type Document_EntityValidationOutput struct {

	// The result of each validation rule.
	ValidationResults []*Document_EntityValidationOutput_ValidationResult `protobuf:"bytes,1,rep,name=validation_results,json=validationResults,proto3" json:"validation_results,omitempty"`
	// The overall result of the validation, true if all applicable rules are
	// valid.
	PassAllRules bool `protobuf:"varint,2,opt,name=pass_all_rules,json=passAllRules,proto3" json:"pass_all_rules,omitempty"`
	// contains filtered or unexported fields
}

The output of the validation given the document and the validation rules.

func (*Document_EntityValidationOutput) Descriptor

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

Deprecated: Use Document_EntityValidationOutput.ProtoReflect.Descriptor instead.

func (*Document_EntityValidationOutput) GetPassAllRules

func (x *Document_EntityValidationOutput) GetPassAllRules() bool

func (*Document_EntityValidationOutput) GetValidationResults

func (x *Document_EntityValidationOutput) GetValidationResults() []*Document_EntityValidationOutput_ValidationResult

func (*Document_EntityValidationOutput) ProtoMessage

func (*Document_EntityValidationOutput) ProtoMessage()

func (*Document_EntityValidationOutput) ProtoReflect

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

func (*Document_EntityValidationOutput) Reset

func (x *Document_EntityValidationOutput) Reset()

func (*Document_EntityValidationOutput) String

func (x *Document_EntityValidationOutput) String() string

Document_EntityValidationOutput_ValidationResult

type Document_EntityValidationOutput_ValidationResult struct {

	// The name of the validation rule.
	RuleName string `protobuf:"bytes,1,opt,name=rule_name,json=ruleName,proto3" json:"rule_name,omitempty"`
	// The description of the validation rule.
	RuleDescription string `protobuf:"bytes,2,opt,name=rule_description,json=ruleDescription,proto3" json:"rule_description,omitempty"`
	// The result of the validation rule.
	ValidationResultType Document_EntityValidationOutput_ValidationResult_ValidationResultType `protobuf:"varint,3,opt,name=validation_result_type,json=validationResultType,proto3,enum=google.cloud.documentai.v1beta3.Document_EntityValidationOutput_ValidationResult_ValidationResultType" json:"validation_result_type,omitempty"`
	// The detailed information of the running the validation process using
	// the entity from the document based on the validation rule.
	ValidationDetails string `protobuf:"bytes,4,opt,name=validation_details,json=validationDetails,proto3" json:"validation_details,omitempty"`
	// contains filtered or unexported fields
}

Validation result for a single validation rule.

func (*Document_EntityValidationOutput_ValidationResult) Descriptor

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

Deprecated: Use Document_EntityValidationOutput_ValidationResult.ProtoReflect.Descriptor instead.

func (*Document_EntityValidationOutput_ValidationResult) GetRuleDescription

func (x *Document_EntityValidationOutput_ValidationResult) GetRuleDescription() string

func (*Document_EntityValidationOutput_ValidationResult) GetRuleName

func (x *Document_EntityValidationOutput_ValidationResult) GetRuleName() string

func (*Document_EntityValidationOutput_ValidationResult) GetValidationDetails

func (x *Document_EntityValidationOutput_ValidationResult) GetValidationDetails() string

func (*Document_EntityValidationOutput_ValidationResult) GetValidationResultType

func (x *Document_EntityValidationOutput_ValidationResult) GetValidationResultType() Document_EntityValidationOutput_ValidationResult_ValidationResultType

func (*Document_EntityValidationOutput_ValidationResult) ProtoMessage

func (*Document_EntityValidationOutput_ValidationResult) ProtoMessage()

func (*Document_EntityValidationOutput_ValidationResult) ProtoReflect

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

func (*Document_EntityValidationOutput_ValidationResult) Reset

func (x *Document_EntityValidationOutput_ValidationResult) Reset()

func (*Document_EntityValidationOutput_ValidationResult) String

func (x *Document_EntityValidationOutput_ValidationResult) String() string

Document_EntityValidationOutput_ValidationResult_ValidationResultType

type Document_EntityValidationOutput_ValidationResult_ValidationResultType int32

The result of the validation rule.

Document_EntityValidationOutput_ValidationResult_VALIDATION_RESULT_TYPE_UNSPECIFIED, Document_EntityValidationOutput_ValidationResult_VALIDATION_RESULT_TYPE_VALID, Document_EntityValidationOutput_ValidationResult_VALIDATION_RESULT_TYPE_INVALID, Document_EntityValidationOutput_ValidationResult_VALIDATION_RESULT_TYPE_SKIPPED, Document_EntityValidationOutput_ValidationResult_VALIDATION_RESULT_TYPE_NOT_APPLICABLE

const (
	// The validation result type is unspecified.
	Document_EntityValidationOutput_ValidationResult_VALIDATION_RESULT_TYPE_UNSPECIFIED Document_EntityValidationOutput_ValidationResult_ValidationResultType = 0
	// The validation is valid.
	Document_EntityValidationOutput_ValidationResult_VALIDATION_RESULT_TYPE_VALID Document_EntityValidationOutput_ValidationResult_ValidationResultType = 1
	// The validation is invalid.
	Document_EntityValidationOutput_ValidationResult_VALIDATION_RESULT_TYPE_INVALID Document_EntityValidationOutput_ValidationResult_ValidationResultType = 2
	// The validation is skipped.
	Document_EntityValidationOutput_ValidationResult_VALIDATION_RESULT_TYPE_SKIPPED Document_EntityValidationOutput_ValidationResult_ValidationResultType = 3
	// The validation is not applicable.
	Document_EntityValidationOutput_ValidationResult_VALIDATION_RESULT_TYPE_NOT_APPLICABLE Document_EntityValidationOutput_ValidationResult_ValidationResultType = 4
)

func (Document_EntityValidationOutput_ValidationResult_ValidationResultType) Descriptor

func (Document_EntityValidationOutput_ValidationResult_ValidationResultType) Descriptor() protoreflect.EnumDescriptor

func (Document_EntityValidationOutput_ValidationResult_ValidationResultType) Enum

func (x Document_EntityValidationOutput_ValidationResult_ValidationResultType) Enum() *Document_EntityValidationOutput_ValidationResult_ValidationResultType

func (Document_EntityValidationOutput_ValidationResult_ValidationResultType) EnumDescriptor

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

Deprecated: Use Document_EntityValidationOutput_ValidationResult_ValidationResultType.Descriptor instead.

func (Document_EntityValidationOutput_ValidationResult_ValidationResultType) Number

func (x Document_EntityValidationOutput_ValidationResult_ValidationResultType) Number() protoreflect.EnumNumber

func (Document_EntityValidationOutput_ValidationResult_ValidationResultType) String

func (x Document_EntityValidationOutput_ValidationResult_ValidationResultType) String() string

func (Document_EntityValidationOutput_ValidationResult_ValidationResultType) Type

func (Document_EntityValidationOutput_ValidationResult_ValidationResultType) Type() protoreflect.EnumType

Document_Entity_Method

type Document_Entity_Method int32

Specifies how the entity's value is obtained.

Document_Entity_METHOD_UNSPECIFIED, Document_Entity_EXTRACT, Document_Entity_DERIVE

const (
	// When the method is not specified, it should be treated as `EXTRACT`.
	Document_Entity_METHOD_UNSPECIFIED Document_Entity_Method = 0
	// The entity's value is directly extracted as-is from the document
	// text.
	Document_Entity_EXTRACT Document_Entity_Method = 1
	// The entity's value is derived through inference and is not
	// necessarily an exact text extraction from the document.
	Document_Entity_DERIVE Document_Entity_Method = 2
)

func (Document_Entity_Method) Descriptor

func (Document_Entity_Method) Descriptor() protoreflect.EnumDescriptor

func (Document_Entity_Method) Enum

func (x Document_Entity_Method) Enum() *Document_Entity_Method

func (Document_Entity_Method) EnumDescriptor

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

Deprecated: Use Document_Entity_Method.Descriptor instead.

func (Document_Entity_Method) Number

func (x Document_Entity_Method) Number() protoreflect.EnumNumber

func (Document_Entity_Method) String

func (x Document_Entity_Method) String() string

func (Document_Entity_Method) Type

func (Document_Entity_Method) Type() protoreflect.EnumType

Document_Entity_NormalizedValue

type Document_Entity_NormalizedValue struct {

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

Parsed and normalized entity value.

func (*Document_Entity_NormalizedValue) Descriptor

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

Deprecated: Use Document_Entity_NormalizedValue.ProtoReflect.Descriptor instead.

func (*Document_Entity_NormalizedValue) GetAddressValue

func (x *Document_Entity_NormalizedValue) GetAddressValue() *postaladdress.PostalAddress

func (*Document_Entity_NormalizedValue) GetBooleanValue

func (x *Document_Entity_NormalizedValue) GetBooleanValue() bool

func (*Document_Entity_NormalizedValue) GetDateValue

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

func (*Document_Entity_NormalizedValue) GetDatetimeValue

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

func (*Document_Entity_NormalizedValue) GetFloatValue

func (x *Document_Entity_NormalizedValue) GetFloatValue() float32

func (*Document_Entity_NormalizedValue) GetIntegerValue

func (x *Document_Entity_NormalizedValue) GetIntegerValue() int32

func (*Document_Entity_NormalizedValue) GetMoneyValue

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

func (*Document_Entity_NormalizedValue) GetSignatureValue

func (x *Document_Entity_NormalizedValue) GetSignatureValue() bool

func (*Document_Entity_NormalizedValue) GetStructuredValue

func (m *Document_Entity_NormalizedValue) GetStructuredValue() isDocument_Entity_NormalizedValue_StructuredValue

func (*Document_Entity_NormalizedValue) GetText

func (x *Document_Entity_NormalizedValue) GetText() string

func (*Document_Entity_NormalizedValue) ProtoMessage

func (*Document_Entity_NormalizedValue) ProtoMessage()

func (*Document_Entity_NormalizedValue) ProtoReflect

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

func (*Document_Entity_NormalizedValue) Reset

func (x *Document_Entity_NormalizedValue) Reset()

func (*Document_Entity_NormalizedValue) String

func (x *Document_Entity_NormalizedValue) String() string

Document_Entity_NormalizedValue_AddressValue

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

Document_Entity_NormalizedValue_BooleanValue

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

Document_Entity_NormalizedValue_DateValue

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

Document_Entity_NormalizedValue_DatetimeValue

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

Document_Entity_NormalizedValue_FloatValue

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

Document_Entity_NormalizedValue_IntegerValue

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

Document_Entity_NormalizedValue_MoneyValue

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

Document_Entity_NormalizedValue_SignatureValue

type Document_Entity_NormalizedValue_SignatureValue struct {
	// A signature - a graphical representation of a person's name,
	// often used to sign a document.
	SignatureValue bool `protobuf:"varint,10,opt,name=signature_value,json=signatureValue,proto3,oneof"`
}

Document_Page

type Document_Page struct {

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

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

func (*Document_Page) Descriptor

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

Deprecated: Use Document_Page.ProtoReflect.Descriptor instead.

func (*Document_Page) GetBlocks

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

func (*Document_Page) GetDetectedBarcodes

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

func (*Document_Page) GetDetectedLanguages

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

func (*Document_Page) GetDimension

func (x *Document_Page) GetDimension() *Document_Page_Dimension

func (*Document_Page) GetFormFields

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

func (*Document_Page) GetImage

func (x *Document_Page) GetImage() *Document_Page_Image

func (*Document_Page) GetImageQualityScores

func (x *Document_Page) GetImageQualityScores() *Document_Page_ImageQualityScores

func (*Document_Page) GetLayout

func (x *Document_Page) GetLayout() *Document_Page_Layout

func (*Document_Page) GetLines

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

func (*Document_Page) GetPageNumber

func (x *Document_Page) GetPageNumber() int32

func (*Document_Page) GetParagraphs

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

func (*Document_Page) GetProvenance

func (x *Document_Page) GetProvenance() *Document_Provenance

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

func (*Document_Page) GetSymbols

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

func (*Document_Page) GetTables

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

func (*Document_Page) GetTokens

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

func (*Document_Page) GetTransforms

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

func (*Document_Page) GetVisualElements

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

func (*Document_Page) ProtoMessage

func (*Document_Page) ProtoMessage()

func (*Document_Page) ProtoReflect

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

func (*Document_Page) Reset

func (x *Document_Page) Reset()

func (*Document_Page) String

func (x *Document_Page) String() string

Document_PageAnchor

type Document_PageAnchor struct {

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

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

func (*Document_PageAnchor) Descriptor

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

Deprecated: Use Document_PageAnchor.ProtoReflect.Descriptor instead.

func (*Document_PageAnchor) GetPageRefs

func (x *Document_PageAnchor) GetPageRefs() []*Document_PageAnchor_PageRef

func (*Document_PageAnchor) ProtoMessage

func (*Document_PageAnchor) ProtoMessage()

func (*Document_PageAnchor) ProtoReflect

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

func (*Document_PageAnchor) Reset

func (x *Document_PageAnchor) Reset()

func (*Document_PageAnchor) String

func (x *Document_PageAnchor) String() string

Document_PageAnchor_PageRef

type Document_PageAnchor_PageRef struct {

	// Required. Index into the
	// [Document.pages][google.cloud.documentai.v1beta3.Document.pages]
	// element, for example using
	// `[Document.pages][page_refs.page]` to locate the related page element.
	// This field is skipped when its value is the default `0`. See
	// https://developers.google.com/protocol-buffers/docs/proto3#json.
	Page int64 `protobuf:"varint,1,opt,name=page,proto3" json:"page,omitempty"`
	// Optional. The type of the layout element that is being referenced if
	// any.
	LayoutType Document_PageAnchor_PageRef_LayoutType `protobuf:"varint,2,opt,name=layout_type,json=layoutType,proto3,enum=google.cloud.documentai.v1beta3.Document_PageAnchor_PageRef_LayoutType" json:"layout_type,omitempty"`
	// Optional. Deprecated.  Use
	// [PageRef.bounding_poly][google.cloud.documentai.v1beta3.Document.PageAnchor.PageRef.bounding_poly]
	// instead.
	//
	// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.
	LayoutId string `protobuf:"bytes,3,opt,name=layout_id,json=layoutId,proto3" json:"layout_id,omitempty"`
	// Optional. Identifies the bounding polygon of a layout element on the
	// page. If `layout_type` is set, the bounding polygon must be exactly the
	// same to the layout element it's referring to.
	BoundingPoly *BoundingPoly `protobuf:"bytes,4,opt,name=bounding_poly,json=boundingPoly,proto3" json:"bounding_poly,omitempty"`
	// Optional. Confidence of detected page element, if applicable. Range
	// `[0, 1]`.
	Confidence float32 `protobuf:"fixed32,5,opt,name=confidence,proto3" json:"confidence,omitempty"`
	// contains filtered or unexported fields
}

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

func (*Document_PageAnchor_PageRef) Descriptor

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

Deprecated: Use Document_PageAnchor_PageRef.ProtoReflect.Descriptor instead.

func (*Document_PageAnchor_PageRef) GetBoundingPoly

func (x *Document_PageAnchor_PageRef) GetBoundingPoly() *BoundingPoly

func (*Document_PageAnchor_PageRef) GetConfidence

func (x *Document_PageAnchor_PageRef) GetConfidence() float32

func (*Document_PageAnchor_PageRef) GetLayoutId

func (x *Document_PageAnchor_PageRef) GetLayoutId() string

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

func (*Document_PageAnchor_PageRef) GetLayoutType

func (x *Document_PageAnchor_PageRef) GetLayoutType() Document_PageAnchor_PageRef_LayoutType

func (*Document_PageAnchor_PageRef) GetPage

func (x *Document_PageAnchor_PageRef) GetPage() int64

func (*Document_PageAnchor_PageRef) ProtoMessage

func (*Document_PageAnchor_PageRef) ProtoMessage()

func (*Document_PageAnchor_PageRef) ProtoReflect

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

func (*Document_PageAnchor_PageRef) Reset

func (x *Document_PageAnchor_PageRef) Reset()

func (*Document_PageAnchor_PageRef) String

func (x *Document_PageAnchor_PageRef) String() string

Document_PageAnchor_PageRef_LayoutType

type Document_PageAnchor_PageRef_LayoutType int32

The type of layout that is being referenced.

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

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

func (Document_PageAnchor_PageRef_LayoutType) Descriptor

func (Document_PageAnchor_PageRef_LayoutType) Descriptor() protoreflect.EnumDescriptor

func (Document_PageAnchor_PageRef_LayoutType) Enum

func (x Document_PageAnchor_PageRef_LayoutType) Enum() *Document_PageAnchor_PageRef_LayoutType

func (Document_PageAnchor_PageRef_LayoutType) EnumDescriptor

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

Deprecated: Use Document_PageAnchor_PageRef_LayoutType.Descriptor instead.

func (Document_PageAnchor_PageRef_LayoutType) Number

func (x Document_PageAnchor_PageRef_LayoutType) Number() protoreflect.EnumNumber

func (Document_PageAnchor_PageRef_LayoutType) String

func (x Document_PageAnchor_PageRef_LayoutType) String() string

func (Document_PageAnchor_PageRef_LayoutType) Type

func (Document_PageAnchor_PageRef_LayoutType) Type() protoreflect.EnumType

Document_Page_Block

type Document_Page_Block struct {

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

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

func (*Document_Page_Block) Descriptor

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

Deprecated: Use Document_Page_Block.ProtoReflect.Descriptor instead.

func (*Document_Page_Block) GetDetectedLanguages

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

func (*Document_Page_Block) GetLayout

func (x *Document_Page_Block) GetLayout() *Document_Page_Layout

func (*Document_Page_Block) GetProvenance

func (x *Document_Page_Block) GetProvenance() *Document_Provenance

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

func (*Document_Page_Block) ProtoMessage

func (*Document_Page_Block) ProtoMessage()

func (*Document_Page_Block) ProtoReflect

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

func (*Document_Page_Block) Reset

func (x *Document_Page_Block) Reset()

func (*Document_Page_Block) String

func (x *Document_Page_Block) String() string

Document_Page_DetectedBarcode

type Document_Page_DetectedBarcode struct {

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

A detected barcode.

func (*Document_Page_DetectedBarcode) Descriptor

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

Deprecated: Use Document_Page_DetectedBarcode.ProtoReflect.Descriptor instead.

func (*Document_Page_DetectedBarcode) GetBarcode

func (x *Document_Page_DetectedBarcode) GetBarcode() *Barcode

func (*Document_Page_DetectedBarcode) GetLayout

func (x *Document_Page_DetectedBarcode) GetLayout() *Document_Page_Layout

func (*Document_Page_DetectedBarcode) ProtoMessage

func (*Document_Page_DetectedBarcode) ProtoMessage()

func (*Document_Page_DetectedBarcode) ProtoReflect

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

func (*Document_Page_DetectedBarcode) Reset

func (x *Document_Page_DetectedBarcode) Reset()

func (*Document_Page_DetectedBarcode) String

func (x *Document_Page_DetectedBarcode) String() string

Document_Page_DetectedLanguage

type Document_Page_DetectedLanguage struct {

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

Detected language for a structural component.

func (*Document_Page_DetectedLanguage) Descriptor

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

Deprecated: Use Document_Page_DetectedLanguage.ProtoReflect.Descriptor instead.

func (*Document_Page_DetectedLanguage) GetConfidence

func (x *Document_Page_DetectedLanguage) GetConfidence() float32

func (*Document_Page_DetectedLanguage) GetLanguageCode

func (x *Document_Page_DetectedLanguage) GetLanguageCode() string

func (*Document_Page_DetectedLanguage) ProtoMessage

func (*Document_Page_DetectedLanguage) ProtoMessage()

func (*Document_Page_DetectedLanguage) ProtoReflect

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

func (*Document_Page_DetectedLanguage) Reset

func (x *Document_Page_DetectedLanguage) Reset()

func (*Document_Page_DetectedLanguage) String

func (x *Document_Page_DetectedLanguage) String() string

Document_Page_Dimension

type Document_Page_Dimension struct {

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

Dimension for the page.

func (*Document_Page_Dimension) Descriptor

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

Deprecated: Use Document_Page_Dimension.ProtoReflect.Descriptor instead.

func (*Document_Page_Dimension) GetHeight

func (x *Document_Page_Dimension) GetHeight() float32

func (*Document_Page_Dimension) GetUnit

func (x *Document_Page_Dimension) GetUnit() string

func (*Document_Page_Dimension) GetWidth

func (x *Document_Page_Dimension) GetWidth() float32

func (*Document_Page_Dimension) ProtoMessage

func (*Document_Page_Dimension) ProtoMessage()

func (*Document_Page_Dimension) ProtoReflect

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

func (*Document_Page_Dimension) Reset

func (x *Document_Page_Dimension) Reset()

func (*Document_Page_Dimension) String

func (x *Document_Page_Dimension) String() string

Document_Page_FormField

type Document_Page_FormField struct {

	// [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the
	// [FormField][google.cloud.documentai.v1beta3.Document.Page.FormField]
	// name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
	FieldName *Document_Page_Layout `protobuf:"bytes,1,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
	// [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the
	// [FormField][google.cloud.documentai.v1beta3.Document.Page.FormField]
	// value.
	FieldValue *Document_Page_Layout `protobuf:"bytes,2,opt,name=field_value,json=fieldValue,proto3" json:"field_value,omitempty"`
	// A list of detected languages for name together with confidence.
	NameDetectedLanguages []*Document_Page_DetectedLanguage `protobuf:"bytes,3,rep,name=name_detected_languages,json=nameDetectedLanguages,proto3" json:"name_detected_languages,omitempty"`
	// A list of detected languages for value together with confidence.
	ValueDetectedLanguages []*Document_Page_DetectedLanguage `protobuf:"bytes,4,rep,name=value_detected_languages,json=valueDetectedLanguages,proto3" json:"value_detected_languages,omitempty"`
	// If the value is non-textual, this field represents the type. Current
	// valid values are:
	//
	// - blank (this indicates the `field_value` is normal text)
	// - `unfilled_checkbox`
	// - `filled_checkbox`
	ValueType string `protobuf:"bytes,5,opt,name=value_type,json=valueType,proto3" json:"value_type,omitempty"`
	// Created for Labeling UI to export key text.
	// If corrections were made to the text identified by the
	// `field_name.text_anchor`, this field will contain the correction.
	CorrectedKeyText string `protobuf:"bytes,6,opt,name=corrected_key_text,json=correctedKeyText,proto3" json:"corrected_key_text,omitempty"`
	// Created for Labeling UI to export value text.
	// If corrections were made to the text identified by the
	// `field_value.text_anchor`, this field will contain the correction.
	CorrectedValueText string `protobuf:"bytes,7,opt,name=corrected_value_text,json=correctedValueText,proto3" json:"corrected_value_text,omitempty"`
	// The history of this annotation.
	Provenance *Document_Provenance `protobuf:"bytes,8,opt,name=provenance,proto3" json:"provenance,omitempty"`
	// contains filtered or unexported fields
}

A form field detected on the page.

func (*Document_Page_FormField) Descriptor

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

Deprecated: Use Document_Page_FormField.ProtoReflect.Descriptor instead.

func (*Document_Page_FormField) GetCorrectedKeyText

func (x *Document_Page_FormField) GetCorrectedKeyText() string

func (*Document_Page_FormField) GetCorrectedValueText

func (x *Document_Page_FormField) GetCorrectedValueText() string

func (*Document_Page_FormField) GetFieldName

func (x *Document_Page_FormField) GetFieldName() *Document_Page_Layout

func (*Document_Page_FormField) GetFieldValue

func (x *Document_Page_FormField) GetFieldValue() *Document_Page_Layout

func (*Document_Page_FormField) GetNameDetectedLanguages

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

func (*Document_Page_FormField) GetProvenance

func (x *Document_Page_FormField) GetProvenance() *Document_Provenance

func (*Document_Page_FormField) GetValueDetectedLanguages

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

func (*Document_Page_FormField) GetValueType

func (x *Document_Page_FormField) GetValueType() string

func (*Document_Page_FormField) ProtoMessage

func (*Document_Page_FormField) ProtoMessage()

func (*Document_Page_FormField) ProtoReflect

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

func (*Document_Page_FormField) Reset

func (x *Document_Page_FormField) Reset()

func (*Document_Page_FormField) String

func (x *Document_Page_FormField) String() string

Document_Page_Image

type Document_Page_Image struct {

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

Rendered image contents for this page.

func (*Document_Page_Image) Descriptor

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

Deprecated: Use Document_Page_Image.ProtoReflect.Descriptor instead.

func (*Document_Page_Image) GetContent

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

func (*Document_Page_Image) GetHeight

func (x *Document_Page_Image) GetHeight() int32

func (*Document_Page_Image) GetMimeType

func (x *Document_Page_Image) GetMimeType() string

func (*Document_Page_Image) GetWidth

func (x *Document_Page_Image) GetWidth() int32

func (*Document_Page_Image) ProtoMessage

func (*Document_Page_Image) ProtoMessage()

func (*Document_Page_Image) ProtoReflect

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

func (*Document_Page_Image) Reset

func (x *Document_Page_Image) Reset()

func (*Document_Page_Image) String

func (x *Document_Page_Image) String() string

Document_Page_ImageQualityScores

type Document_Page_ImageQualityScores struct {

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

Image quality scores for the page image.

func (*Document_Page_ImageQualityScores) Descriptor

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

Deprecated: Use Document_Page_ImageQualityScores.ProtoReflect.Descriptor instead.

func (*Document_Page_ImageQualityScores) GetDetectedDefects

func (x *Document_Page_ImageQualityScores) GetDetectedDefects() []*Document_Page_ImageQualityScores_DetectedDefect

func (*Document_Page_ImageQualityScores) GetQualityScore

func (x *Document_Page_ImageQualityScores) GetQualityScore() float32

func (*Document_Page_ImageQualityScores) ProtoMessage

func (*Document_Page_ImageQualityScores) ProtoMessage()

func (*Document_Page_ImageQualityScores) ProtoReflect

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

func (*Document_Page_ImageQualityScores) Reset

func (x *Document_Page_ImageQualityScores) Reset()

func (*Document_Page_ImageQualityScores) String

func (x *Document_Page_ImageQualityScores) String() string

Document_Page_ImageQualityScores_DetectedDefect

type Document_Page_ImageQualityScores_DetectedDefect struct {

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

Image Quality Defects

func (*Document_Page_ImageQualityScores_DetectedDefect) Descriptor

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

Deprecated: Use Document_Page_ImageQualityScores_DetectedDefect.ProtoReflect.Descriptor instead.

func (*Document_Page_ImageQualityScores_DetectedDefect) GetConfidence

func (x *Document_Page_ImageQualityScores_DetectedDefect) GetConfidence() float32

func (*Document_Page_ImageQualityScores_DetectedDefect) GetType

func (x *Document_Page_ImageQualityScores_DetectedDefect) GetType() string

func (*Document_Page_ImageQualityScores_DetectedDefect) ProtoMessage

func (*Document_Page_ImageQualityScores_DetectedDefect) ProtoMessage()

func (*Document_Page_ImageQualityScores_DetectedDefect) ProtoReflect

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

func (*Document_Page_ImageQualityScores_DetectedDefect) Reset

func (x *Document_Page_ImageQualityScores_DetectedDefect) Reset()

func (*Document_Page_ImageQualityScores_DetectedDefect) String

func (x *Document_Page_ImageQualityScores_DetectedDefect) String() string

Document_Page_Layout

type Document_Page_Layout struct {

	// Text anchor indexing into the
	// [Document.text][google.cloud.documentai.v1beta3.Document.text].
	TextAnchor *Document_TextAnchor `protobuf:"bytes,1,opt,name=text_anchor,json=textAnchor,proto3" json:"text_anchor,omitempty"`
	// Confidence of the current
	// [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] within
	// context of the object this layout is for. e.g. confidence can be for a
	// single token, a table, a visual element, etc. depending on context.
	// Range `[0, 1]`.
	Confidence float32 `protobuf:"fixed32,2,opt,name=confidence,proto3" json:"confidence,omitempty"`
	// The bounding polygon for the
	// [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout].
	BoundingPoly *BoundingPoly `protobuf:"bytes,3,opt,name=bounding_poly,json=boundingPoly,proto3" json:"bounding_poly,omitempty"`
	// Detected orientation for the
	// [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout].
	Orientation Document_Page_Layout_Orientation `protobuf:"varint,4,opt,name=orientation,proto3,enum=google.cloud.documentai.v1beta3.Document_Page_Layout_Orientation" json:"orientation,omitempty"`
	// contains filtered or unexported fields
}

Visual element describing a layout unit on a page.

func (*Document_Page_Layout) Descriptor

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

Deprecated: Use Document_Page_Layout.ProtoReflect.Descriptor instead.

func (*Document_Page_Layout) GetBoundingPoly

func (x *Document_Page_Layout) GetBoundingPoly() *BoundingPoly

func (*Document_Page_Layout) GetConfidence

func (x *Document_Page_Layout) GetConfidence() float32

func (*Document_Page_Layout) GetOrientation

func (x *Document_Page_Layout) GetOrientation() Document_Page_Layout_Orientation

func (*Document_Page_Layout) GetTextAnchor

func (x *Document_Page_Layout) GetTextAnchor() *Document_TextAnchor

func (*Document_Page_Layout) ProtoMessage

func (*Document_Page_Layout) ProtoMessage()

func (*Document_Page_Layout) ProtoReflect

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

func (*Document_Page_Layout) Reset

func (x *Document_Page_Layout) Reset()

func (*Document_Page_Layout) String

func (x *Document_Page_Layout) String() string

Document_Page_Layout_Orientation

type Document_Page_Layout_Orientation int32

Detected human reading orientation.

Document_Page_Layout_ORIENTATION_UNSPECIFIED, Document_Page_Layout_PAGE_UP, Document_Page_Layout_PAGE_RIGHT, Document_Page_Layout_PAGE_DOWN, Document_Page_Layout_PAGE_LEFT

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

func (Document_Page_Layout_Orientation) Descriptor

func (Document_Page_Layout_Orientation) Descriptor() protoreflect.EnumDescriptor

func (Document_Page_Layout_Orientation) Enum

func (x Document_Page_Layout_Orientation) Enum() *Document_Page_Layout_Orientation

func (Document_Page_Layout_Orientation) EnumDescriptor

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

Deprecated: Use Document_Page_Layout_Orientation.Descriptor instead.

func (Document_Page_Layout_Orientation) Number

func (x Document_Page_Layout_Orientation) Number() protoreflect.EnumNumber

func (Document_Page_Layout_Orientation) String

func (x Document_Page_Layout_Orientation) String() string

func (Document_Page_Layout_Orientation) Type

func (Document_Page_Layout_Orientation) Type() protoreflect.EnumType

Document_Page_Line

type Document_Page_Line struct {

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

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

func (*Document_Page_Line) Descriptor

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

Deprecated: Use Document_Page_Line.ProtoReflect.Descriptor instead.

func (*Document_Page_Line) GetDetectedLanguages

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

func (*Document_Page_Line) GetLayout

func (x *Document_Page_Line) GetLayout() *Document_Page_Layout

func (*Document_Page_Line) GetProvenance

func (x *Document_Page_Line) GetProvenance() *Document_Provenance

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

func (*Document_Page_Line) ProtoMessage

func (*Document_Page_Line) ProtoMessage()

func (*Document_Page_Line) ProtoReflect

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

func (*Document_Page_Line) Reset

func (x *Document_Page_Line) Reset()

func (*Document_Page_Line) String

func (x *Document_Page_Line) String() string

Document_Page_Matrix

type Document_Page_Matrix struct {

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

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

func (*Document_Page_Matrix) Descriptor

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

Deprecated: Use Document_Page_Matrix.ProtoReflect.Descriptor instead.

func (*Document_Page_Matrix) GetCols

func (x *Document_Page_Matrix) GetCols() int32

func (*Document_Page_Matrix) GetData

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

func (*Document_Page_Matrix) GetRows

func (x *Document_Page_Matrix) GetRows() int32

func (*Document_Page_Matrix) GetType

func (x *Document_Page_Matrix) GetType() int32

func (*Document_Page_Matrix) ProtoMessage

func (*Document_Page_Matrix) ProtoMessage()

func (*Document_Page_Matrix) ProtoReflect

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

func (*Document_Page_Matrix) Reset

func (x *Document_Page_Matrix) Reset()

func (*Document_Page_Matrix) String

func (x *Document_Page_Matrix) String() string

Document_Page_Paragraph

type Document_Page_Paragraph struct {

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

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

func (*Document_Page_Paragraph) Descriptor

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

Deprecated: Use Document_Page_Paragraph.ProtoReflect.Descriptor instead.

func (*Document_Page_Paragraph) GetDetectedLanguages

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

func (*Document_Page_Paragraph) GetLayout

func (x *Document_Page_Paragraph) GetLayout() *Document_Page_Layout

func (*Document_Page_Paragraph) GetProvenance

func (x *Document_Page_Paragraph) GetProvenance() *Document_Provenance

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

func (*Document_Page_Paragraph) ProtoMessage

func (*Document_Page_Paragraph) ProtoMessage()

func (*Document_Page_Paragraph) ProtoReflect

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

func (*Document_Page_Paragraph) Reset

func (x *Document_Page_Paragraph) Reset()

func (*Document_Page_Paragraph) String

func (x *Document_Page_Paragraph) String() string

Document_Page_Symbol

type Document_Page_Symbol struct {

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

A detected symbol.

func (*Document_Page_Symbol) Descriptor

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

Deprecated: Use Document_Page_Symbol.ProtoReflect.Descriptor instead.

func (*Document_Page_Symbol) GetDetectedLanguages

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

func (*Document_Page_Symbol) GetLayout

func (x *Document_Page_Symbol) GetLayout() *Document_Page_Layout

func (*Document_Page_Symbol) ProtoMessage

func (*Document_Page_Symbol) ProtoMessage()

func (*Document_Page_Symbol) ProtoReflect

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

func (*Document_Page_Symbol) Reset

func (x *Document_Page_Symbol) Reset()

func (*Document_Page_Symbol) String

func (x *Document_Page_Symbol) String() string

Document_Page_Table

type Document_Page_Table struct {

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

A table representation similar to HTML table structure.

func (*Document_Page_Table) Descriptor

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

Deprecated: Use Document_Page_Table.ProtoReflect.Descriptor instead.

func (*Document_Page_Table) GetBodyRows

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

func (*Document_Page_Table) GetDetectedLanguages

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

func (*Document_Page_Table) GetHeaderRows

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

func (*Document_Page_Table) GetLayout

func (x *Document_Page_Table) GetLayout() *Document_Page_Layout

func (*Document_Page_Table) GetProvenance

func (x *Document_Page_Table) GetProvenance() *Document_Provenance

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

func (*Document_Page_Table) ProtoMessage

func (*Document_Page_Table) ProtoMessage()

func (*Document_Page_Table) ProtoReflect

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

func (*Document_Page_Table) Reset

func (x *Document_Page_Table) Reset()

func (*Document_Page_Table) String

func (x *Document_Page_Table) String() string

Document_Page_Table_TableCell

type Document_Page_Table_TableCell struct {

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

A cell representation inside the table.

func (*Document_Page_Table_TableCell) Descriptor

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

Deprecated: Use Document_Page_Table_TableCell.ProtoReflect.Descriptor instead.

func (*Document_Page_Table_TableCell) GetColSpan

func (x *Document_Page_Table_TableCell) GetColSpan() int32

func (*Document_Page_Table_TableCell) GetDetectedLanguages

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

func (*Document_Page_Table_TableCell) GetLayout

func (x *Document_Page_Table_TableCell) GetLayout() *Document_Page_Layout

func (*Document_Page_Table_TableCell) GetRowSpan

func (x *Document_Page_Table_TableCell) GetRowSpan() int32

func (*Document_Page_Table_TableCell) ProtoMessage

func (*Document_Page_Table_TableCell) ProtoMessage()

func (*Document_Page_Table_TableCell) ProtoReflect

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

func (*Document_Page_Table_TableCell) Reset

func (x *Document_Page_Table_TableCell) Reset()

func (*Document_Page_Table_TableCell) String

func (x *Document_Page_Table_TableCell) String() string

Document_Page_Table_TableRow

type Document_Page_Table_TableRow struct {

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

A row of table cells.

func (*Document_Page_Table_TableRow) Descriptor

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

Deprecated: Use Document_Page_Table_TableRow.ProtoReflect.Descriptor instead.

func (*Document_Page_Table_TableRow) GetCells

func (x *Document_Page_Table_TableRow) GetCells() []*Document_Page_Table_TableCell

func (*Document_Page_Table_TableRow) ProtoMessage

func (*Document_Page_Table_TableRow) ProtoMessage()

func (*Document_Page_Table_TableRow) ProtoReflect

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

func (*Document_Page_Table_TableRow) Reset

func (x *Document_Page_Table_TableRow) Reset()

func (*Document_Page_Table_TableRow) String

func (x *Document_Page_Table_TableRow) String() string

Document_Page_Token

type Document_Page_Token struct {

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

A detected token.

func (*Document_Page_Token) Descriptor

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

Deprecated: Use Document_Page_Token.ProtoReflect.Descriptor instead.

func (*Document_Page_Token) GetDetectedBreak

func (x *Document_Page_Token) GetDetectedBreak() *Document_Page_Token_DetectedBreak

func (*Document_Page_Token) GetDetectedLanguages

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

func (*Document_Page_Token) GetLayout

func (x *Document_Page_Token) GetLayout() *Document_Page_Layout

func (*Document_Page_Token) GetProvenance

func (x *Document_Page_Token) GetProvenance() *Document_Provenance

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

func (*Document_Page_Token) GetStyleInfo

func (x *Document_Page_Token) GetStyleInfo() *Document_Page_Token_StyleInfo

func (*Document_Page_Token) ProtoMessage

func (*Document_Page_Token) ProtoMessage()

func (*Document_Page_Token) ProtoReflect

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

func (*Document_Page_Token) Reset

func (x *Document_Page_Token) Reset()

func (*Document_Page_Token) String

func (x *Document_Page_Token) String() string

Document_Page_Token_DetectedBreak

type Document_Page_Token_DetectedBreak struct {

	// Detected break type.
	Type Document_Page_Token_DetectedBreak_Type `protobuf:"varint,1,opt,name=type,proto3,enum=google.cloud.documentai.v1beta3.Document_Page_Token_DetectedBreak_Type" json:"type,omitempty"`
	// contains filtered or unexported fields
}

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

func (*Document_Page_Token_DetectedBreak) Descriptor

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

Deprecated: Use Document_Page_Token_DetectedBreak.ProtoReflect.Descriptor instead.

func (*Document_Page_Token_DetectedBreak) GetType

func (x *Document_Page_Token_DetectedBreak) GetType() Document_Page_Token_DetectedBreak_Type

func (*Document_Page_Token_DetectedBreak) ProtoMessage

func (*Document_Page_Token_DetectedBreak) ProtoMessage()

func (*Document_Page_Token_DetectedBreak) ProtoReflect

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

func (*Document_Page_Token_DetectedBreak) Reset

func (x *Document_Page_Token_DetectedBreak) Reset()

func (*Document_Page_Token_DetectedBreak) String

func (x *Document_Page_Token_DetectedBreak) String() string

Document_Page_Token_DetectedBreak_Type

type Document_Page_Token_DetectedBreak_Type int32

Enum to denote the type of break found.

Document_Page_Token_DetectedBreak_TYPE_UNSPECIFIED, Document_Page_Token_DetectedBreak_SPACE, Document_Page_Token_DetectedBreak_WIDE_SPACE, Document_Page_Token_DetectedBreak_HYPHEN

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

func (Document_Page_Token_DetectedBreak_Type) Descriptor

func (Document_Page_Token_DetectedBreak_Type) Descriptor() protoreflect.EnumDescriptor

func (Document_Page_Token_DetectedBreak_Type) Enum

func (x Document_Page_Token_DetectedBreak_Type) Enum() *Document_Page_Token_DetectedBreak_Type

func (Document_Page_Token_DetectedBreak_Type) EnumDescriptor

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

Deprecated: Use Document_Page_Token_DetectedBreak_Type.Descriptor instead.

func (Document_Page_Token_DetectedBreak_Type) Number

func (x Document_Page_Token_DetectedBreak_Type) Number() protoreflect.EnumNumber

func (Document_Page_Token_DetectedBreak_Type) String

func (x Document_Page_Token_DetectedBreak_Type) String() string

func (Document_Page_Token_DetectedBreak_Type) Type

func (Document_Page_Token_DetectedBreak_Type) Type() protoreflect.EnumType

Document_Page_Token_StyleInfo

type Document_Page_Token_StyleInfo struct {

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

Font and other text style attributes.

func (*Document_Page_Token_StyleInfo) Descriptor

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

Deprecated: Use Document_Page_Token_StyleInfo.ProtoReflect.Descriptor instead.

func (*Document_Page_Token_StyleInfo) GetBackgroundColor

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

func (*Document_Page_Token_StyleInfo) GetBold

func (x *Document_Page_Token_StyleInfo) GetBold() bool

func (*Document_Page_Token_StyleInfo) GetFontSize

func (x *Document_Page_Token_StyleInfo) GetFontSize() int32

func (*Document_Page_Token_StyleInfo) GetFontType

func (x *Document_Page_Token_StyleInfo) GetFontType() string

func (*Document_Page_Token_StyleInfo) GetFontWeight

func (x *Document_Page_Token_StyleInfo) GetFontWeight() int32

func (*Document_Page_Token_StyleInfo) GetHandwritten

func (x *Document_Page_Token_StyleInfo) GetHandwritten() bool

func (*Document_Page_Token_StyleInfo) GetItalic

func (x *Document_Page_Token_StyleInfo) GetItalic() bool

func (*Document_Page_Token_StyleInfo) GetLetterSpacing

func (x *Document_Page_Token_StyleInfo) GetLetterSpacing() float64

func (*Document_Page_Token_StyleInfo) GetPixelFontSize

func (x *Document_Page_Token_StyleInfo) GetPixelFontSize() float64

func (*Document_Page_Token_StyleInfo) GetSmallcaps

func (x *Document_Page_Token_StyleInfo) GetSmallcaps() bool

func (*Document_Page_Token_StyleInfo) GetStrikeout

func (x *Document_Page_Token_StyleInfo) GetStrikeout() bool

func (*Document_Page_Token_StyleInfo) GetSubscript

func (x *Document_Page_Token_StyleInfo) GetSubscript() bool

func (*Document_Page_Token_StyleInfo) GetSuperscript

func (x *Document_Page_Token_StyleInfo) GetSuperscript() bool

func (*Document_Page_Token_StyleInfo) GetTextColor

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

func (*Document_Page_Token_StyleInfo) GetUnderlined

func (x *Document_Page_Token_StyleInfo) GetUnderlined() bool

func (*Document_Page_Token_StyleInfo) ProtoMessage

func (*Document_Page_Token_StyleInfo) ProtoMessage()

func (*Document_Page_Token_StyleInfo) ProtoReflect

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

func (*Document_Page_Token_StyleInfo) Reset

func (x *Document_Page_Token_StyleInfo) Reset()

func (*Document_Page_Token_StyleInfo) String

func (x *Document_Page_Token_StyleInfo) String() string

Document_Page_VisualElement

type Document_Page_VisualElement struct {

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

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

func (*Document_Page_VisualElement) Descriptor

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

Deprecated: Use Document_Page_VisualElement.ProtoReflect.Descriptor instead.

func (*Document_Page_VisualElement) GetDetectedLanguages

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

func (*Document_Page_VisualElement) GetLayout

func (x *Document_Page_VisualElement) GetLayout() *Document_Page_Layout

func (*Document_Page_VisualElement) GetType

func (x *Document_Page_VisualElement) GetType() string

func (*Document_Page_VisualElement) ProtoMessage

func (*Document_Page_VisualElement) ProtoMessage()

func (*Document_Page_VisualElement) ProtoReflect

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

func (*Document_Page_VisualElement) Reset

func (x *Document_Page_VisualElement) Reset()

func (*Document_Page_VisualElement) String

func (x *Document_Page_VisualElement) String() string

Document_Provenance

type Document_Provenance struct {

	// The index of the revision that produced this element.
	//
	// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.
	Revision int32 `protobuf:"varint,1,opt,name=revision,proto3" json:"revision,omitempty"`
	// The Id of this operation.  Needs to be unique within the scope of the
	// revision.
	//
	// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.
	Id int32 `protobuf:"varint,2,opt,name=id,proto3" json:"id,omitempty"`
	// References to the original elements that are replaced.
	Parents []*Document_Provenance_Parent `protobuf:"bytes,3,rep,name=parents,proto3" json:"parents,omitempty"`
	// The type of provenance operation.
	Type Document_Provenance_OperationType `protobuf:"varint,4,opt,name=type,proto3,enum=google.cloud.documentai.v1beta3.Document_Provenance_OperationType" json:"type,omitempty"`
	// contains filtered or unexported fields
}

Structure to identify provenance relationships between annotations in different revisions.

func (*Document_Provenance) Descriptor

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

Deprecated: Use Document_Provenance.ProtoReflect.Descriptor instead.

func (*Document_Provenance) GetId

func (x *Document_Provenance) GetId() int32

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

func (*Document_Provenance) GetParents

func (x *Document_Provenance) GetParents() []*Document_Provenance_Parent

func (*Document_Provenance) GetRevision

func (x *Document_Provenance) GetRevision() int32

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

func (*Document_Provenance) GetType

func (x *Document_Provenance) GetType() Document_Provenance_OperationType

func (*Document_Provenance) ProtoMessage

func (*Document_Provenance) ProtoMessage()

func (*Document_Provenance) ProtoReflect

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

func (*Document_Provenance) Reset

func (x *Document_Provenance) Reset()

func (*Document_Provenance) String

func (x *Document_Provenance) String() string

Document_Provenance_OperationType

type Document_Provenance_OperationType int32

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

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

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

func (Document_Provenance_OperationType) Descriptor

func (Document_Provenance_OperationType) Descriptor() protoreflect.EnumDescriptor

func (Document_Provenance_OperationType) Enum

func (x Document_Provenance_OperationType) Enum() *Document_Provenance_OperationType

func (Document_Provenance_OperationType) EnumDescriptor

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

Deprecated: Use Document_Provenance_OperationType.Descriptor instead.

func (Document_Provenance_OperationType) Number

func (x Document_Provenance_OperationType) Number() protoreflect.EnumNumber

func (Document_Provenance_OperationType) String

func (x Document_Provenance_OperationType) String() string

func (Document_Provenance_OperationType) Type

func (Document_Provenance_OperationType) Type() protoreflect.EnumType

Document_Provenance_Parent

type Document_Provenance_Parent struct {

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

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

func (*Document_Provenance_Parent) Descriptor

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

Deprecated: Use Document_Provenance_Parent.ProtoReflect.Descriptor instead.

func (*Document_Provenance_Parent) GetId

func (x *Document_Provenance_Parent) GetId() int32

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

func (*Document_Provenance_Parent) GetIndex

func (x *Document_Provenance_Parent) GetIndex() int32

func (*Document_Provenance_Parent) GetRevision

func (x *Document_Provenance_Parent) GetRevision() int32

func (*Document_Provenance_Parent) ProtoMessage

func (*Document_Provenance_Parent) ProtoMessage()

func (*Document_Provenance_Parent) ProtoReflect

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

func (*Document_Provenance_Parent) Reset

func (x *Document_Provenance_Parent) Reset()

func (*Document_Provenance_Parent) String

func (x *Document_Provenance_Parent) String() string

Document_Revision

type Document_Revision struct {

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

Contains past or forward revisions of this document.

func (*Document_Revision) Descriptor

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

Deprecated: Use Document_Revision.ProtoReflect.Descriptor instead.

func (*Document_Revision) GetAgent

func (x *Document_Revision) GetAgent() string

func (*Document_Revision) GetCreateTime

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

func (*Document_Revision) GetHumanReview

func (x *Document_Revision) GetHumanReview() *Document_Revision_HumanReview

func (*Document_Revision) GetId

func (x *Document_Revision) GetId() string

func (*Document_Revision) GetParent

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

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

func (*Document_Revision) GetParentIds

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

func (*Document_Revision) GetProcessor

func (x *Document_Revision) GetProcessor() string

func (*Document_Revision) GetSource

func (m *Document_Revision) GetSource() isDocument_Revision_Source

func (*Document_Revision) ProtoMessage

func (*Document_Revision) ProtoMessage()

func (*Document_Revision) ProtoReflect

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

func (*Document_Revision) Reset

func (x *Document_Revision) Reset()

func (*Document_Revision) String

func (x *Document_Revision) String() string

Document_Revision_Agent

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

Document_Revision_HumanReview

type Document_Revision_HumanReview struct {

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

Human Review information of the document.

func (*Document_Revision_HumanReview) Descriptor

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

Deprecated: Use Document_Revision_HumanReview.ProtoReflect.Descriptor instead.

func (*Document_Revision_HumanReview) GetState

func (x *Document_Revision_HumanReview) GetState() string

func (*Document_Revision_HumanReview) GetStateMessage

func (x *Document_Revision_HumanReview) GetStateMessage() string

func (*Document_Revision_HumanReview) ProtoMessage

func (*Document_Revision_HumanReview) ProtoMessage()

func (*Document_Revision_HumanReview) ProtoReflect

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

func (*Document_Revision_HumanReview) Reset

func (x *Document_Revision_HumanReview) Reset()

func (*Document_Revision_HumanReview) String

func (x *Document_Revision_HumanReview) String() string

Document_Revision_Processor

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

Document_ShardInfo

type Document_ShardInfo struct {

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

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

func (*Document_ShardInfo) Descriptor

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

Deprecated: Use Document_ShardInfo.ProtoReflect.Descriptor instead.

func (*Document_ShardInfo) GetShardCount

func (x *Document_ShardInfo) GetShardCount() int64

func (*Document_ShardInfo) GetShardIndex

func (x *Document_ShardInfo) GetShardIndex() int64

func (*Document_ShardInfo) GetTextOffset

func (x *Document_ShardInfo) GetTextOffset() int64

func (*Document_ShardInfo) ProtoMessage

func (*Document_ShardInfo) ProtoMessage()

func (*Document_ShardInfo) ProtoReflect

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

func (*Document_ShardInfo) Reset

func (x *Document_ShardInfo) Reset()

func (*Document_ShardInfo) String

func (x *Document_ShardInfo) String() string

Document_Style

type Document_Style struct {

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

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

func (*Document_Style) Descriptor

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

Deprecated: Use Document_Style.ProtoReflect.Descriptor instead.

func (*Document_Style) GetBackgroundColor

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

func (*Document_Style) GetColor

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

func (*Document_Style) GetFontFamily

func (x *Document_Style) GetFontFamily() string

func (*Document_Style) GetFontSize

func (x *Document_Style) GetFontSize() *Document_Style_FontSize

func (*Document_Style) GetFontWeight

func (x *Document_Style) GetFontWeight() string

func (*Document_Style) GetTextAnchor

func (x *Document_Style) GetTextAnchor() *Document_TextAnchor

func (*Document_Style) GetTextDecoration

func (x *Document_Style) GetTextDecoration() string

func (*Document_Style) GetTextStyle

func (x *Document_Style) GetTextStyle() string

func (*Document_Style) ProtoMessage

func (*Document_Style) ProtoMessage()

func (*Document_Style) ProtoReflect

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

func (*Document_Style) Reset

func (x *Document_Style) Reset()

func (*Document_Style) String

func (x *Document_Style) String() string

Document_Style_FontSize

type Document_Style_FontSize struct {

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

Font size with unit.

func (*Document_Style_FontSize) Descriptor

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

Deprecated: Use Document_Style_FontSize.ProtoReflect.Descriptor instead.

func (*Document_Style_FontSize) GetSize

func (x *Document_Style_FontSize) GetSize() float32

func (*Document_Style_FontSize) GetUnit

func (x *Document_Style_FontSize) GetUnit() string

func (*Document_Style_FontSize) ProtoMessage

func (*Document_Style_FontSize) ProtoMessage()

func (*Document_Style_FontSize) ProtoReflect

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

func (*Document_Style_FontSize) Reset

func (x *Document_Style_FontSize) Reset()

func (*Document_Style_FontSize) String

func (x *Document_Style_FontSize) String() string

Document_TextAnchor

type Document_TextAnchor struct {

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

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

func (*Document_TextAnchor) Descriptor

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

Deprecated: Use Document_TextAnchor.ProtoReflect.Descriptor instead.

func (*Document_TextAnchor) GetContent

func (x *Document_TextAnchor) GetContent() string

func (*Document_TextAnchor) GetTextSegments

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

func (*Document_TextAnchor) ProtoMessage

func (*Document_TextAnchor) ProtoMessage()

func (*Document_TextAnchor) ProtoReflect

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

func (*Document_TextAnchor) Reset

func (x *Document_TextAnchor) Reset()

func (*Document_TextAnchor) String

func (x *Document_TextAnchor) String() string

Document_TextAnchor_TextSegment

type Document_TextAnchor_TextSegment struct {

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

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

func (*Document_TextAnchor_TextSegment) Descriptor

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

Deprecated: Use Document_TextAnchor_TextSegment.ProtoReflect.Descriptor instead.

func (*Document_TextAnchor_TextSegment) GetEndIndex

func (x *Document_TextAnchor_TextSegment) GetEndIndex() int64

func (*Document_TextAnchor_TextSegment) GetStartIndex

func (x *Document_TextAnchor_TextSegment) GetStartIndex() int64

func (*Document_TextAnchor_TextSegment) ProtoMessage

func (*Document_TextAnchor_TextSegment) ProtoMessage()

func (*Document_TextAnchor_TextSegment) ProtoReflect

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

func (*Document_TextAnchor_TextSegment) Reset

func (x *Document_TextAnchor_TextSegment) Reset()

func (*Document_TextAnchor_TextSegment) String

func (x *Document_TextAnchor_TextSegment) String() string

Document_TextChange

type Document_TextChange struct {

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

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

func (*Document_TextChange) Descriptor

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

Deprecated: Use Document_TextChange.ProtoReflect.Descriptor instead.

func (*Document_TextChange) GetChangedText

func (x *Document_TextChange) GetChangedText() string

func (*Document_TextChange) GetProvenance

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

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

func (*Document_TextChange) GetTextAnchor

func (x *Document_TextChange) GetTextAnchor() *Document_TextAnchor

func (*Document_TextChange) ProtoMessage

func (*Document_TextChange) ProtoMessage()

func (*Document_TextChange) ProtoReflect

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

func (*Document_TextChange) Reset

func (x *Document_TextChange) Reset()

func (*Document_TextChange) String

func (x *Document_TextChange) String() string

Document_Uri

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

EnableProcessorMetadata

type EnableProcessorMetadata struct {

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

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

func (*EnableProcessorMetadata) Descriptor

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

Deprecated: Use EnableProcessorMetadata.ProtoReflect.Descriptor instead.

func (*EnableProcessorMetadata) GetCommonMetadata

func (x *EnableProcessorMetadata) GetCommonMetadata() *CommonOperationMetadata

func (*EnableProcessorMetadata) ProtoMessage

func (*EnableProcessorMetadata) ProtoMessage()

func (*EnableProcessorMetadata) ProtoReflect

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

func (*EnableProcessorMetadata) Reset

func (x *EnableProcessorMetadata) Reset()

func (*EnableProcessorMetadata) String

func (x *EnableProcessorMetadata) String() string

EnableProcessorRequest

type EnableProcessorRequest struct {

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

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

func (*EnableProcessorRequest) Descriptor

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

Deprecated: Use EnableProcessorRequest.ProtoReflect.Descriptor instead.

func (*EnableProcessorRequest) GetName

func (x *EnableProcessorRequest) GetName() string

func (*EnableProcessorRequest) ProtoMessage

func (*EnableProcessorRequest) ProtoMessage()

func (*EnableProcessorRequest) ProtoReflect

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

func (*EnableProcessorRequest) Reset

func (x *EnableProcessorRequest) Reset()

func (*EnableProcessorRequest) String

func (x *EnableProcessorRequest) String() string

EnableProcessorResponse

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

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

func (*EnableProcessorResponse) Descriptor

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

Deprecated: Use EnableProcessorResponse.ProtoReflect.Descriptor instead.

func (*EnableProcessorResponse) ProtoMessage

func (*EnableProcessorResponse) ProtoMessage()

func (*EnableProcessorResponse) ProtoReflect

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

func (*EnableProcessorResponse) Reset

func (x *EnableProcessorResponse) Reset()

func (*EnableProcessorResponse) String

func (x *EnableProcessorResponse) String() string

EntityTypeMetadata

type EntityTypeMetadata struct {

	// Whether the entity type should be considered inactive.
	Inactive bool `protobuf:"varint,5,opt,name=inactive,proto3" json:"inactive,omitempty"`
	// contains filtered or unexported fields
}

Metadata about an entity type.

func (*EntityTypeMetadata) Descriptor

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

Deprecated: Use EntityTypeMetadata.ProtoReflect.Descriptor instead.

func (*EntityTypeMetadata) GetInactive

func (x *EntityTypeMetadata) GetInactive() bool

func (*EntityTypeMetadata) ProtoMessage

func (*EntityTypeMetadata) ProtoMessage()

func (*EntityTypeMetadata) ProtoReflect

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

func (*EntityTypeMetadata) Reset

func (x *EntityTypeMetadata) Reset()

func (*EntityTypeMetadata) String

func (x *EntityTypeMetadata) String() string

EvaluateProcessorVersionMetadata

type EvaluateProcessorVersionMetadata 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
}

Metadata of the [EvaluateProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.EvaluateProcessorVersion] method.

func (*EvaluateProcessorVersionMetadata) Descriptor

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

Deprecated: Use EvaluateProcessorVersionMetadata.ProtoReflect.Descriptor instead.

func (*EvaluateProcessorVersionMetadata) GetCommonMetadata

func (x *EvaluateProcessorVersionMetadata) GetCommonMetadata() *CommonOperationMetadata

func (*EvaluateProcessorVersionMetadata) ProtoMessage

func (*EvaluateProcessorVersionMetadata) ProtoMessage()

func (*EvaluateProcessorVersionMetadata) ProtoReflect

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

func (*EvaluateProcessorVersionMetadata) Reset

func (x *EvaluateProcessorVersionMetadata) Reset()

func (*EvaluateProcessorVersionMetadata) String

func (x *EvaluateProcessorVersionMetadata) String() string

EvaluateProcessorVersionRequest

type EvaluateProcessorVersionRequest struct {

	// Required. The resource name of the
	// [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion] to
	// evaluate.
	// `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
	ProcessorVersion string `protobuf:"bytes,1,opt,name=processor_version,json=processorVersion,proto3" json:"processor_version,omitempty"`
	// Optional. The documents used in the evaluation. If unspecified, use the
	// processor's dataset as evaluation input.
	EvaluationDocuments *BatchDocumentsInputConfig `protobuf:"bytes,3,opt,name=evaluation_documents,json=evaluationDocuments,proto3" json:"evaluation_documents,omitempty"`
	// contains filtered or unexported fields
}

Evaluates the given [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion] against the supplied documents.

func (*EvaluateProcessorVersionRequest) Descriptor

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

Deprecated: Use EvaluateProcessorVersionRequest.ProtoReflect.Descriptor instead.

func (*EvaluateProcessorVersionRequest) GetEvaluationDocuments

func (x *EvaluateProcessorVersionRequest) GetEvaluationDocuments() *BatchDocumentsInputConfig

func (*EvaluateProcessorVersionRequest) GetProcessorVersion

func (x *EvaluateProcessorVersionRequest) GetProcessorVersion() string

func (*EvaluateProcessorVersionRequest) ProtoMessage

func (*EvaluateProcessorVersionRequest) ProtoMessage()

func (*EvaluateProcessorVersionRequest) ProtoReflect

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

func (*EvaluateProcessorVersionRequest) Reset

func (x *EvaluateProcessorVersionRequest) Reset()

func (*EvaluateProcessorVersionRequest) String

func (x *EvaluateProcessorVersionRequest) String() string

EvaluateProcessorVersionResponse

type EvaluateProcessorVersionResponse struct {

	// The resource name of the created evaluation.
	Evaluation string `protobuf:"bytes,2,opt,name=evaluation,proto3" json:"evaluation,omitempty"`
	// contains filtered or unexported fields
}

Response of the [EvaluateProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.EvaluateProcessorVersion] method.

func (*EvaluateProcessorVersionResponse) Descriptor

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

Deprecated: Use EvaluateProcessorVersionResponse.ProtoReflect.Descriptor instead.

func (*EvaluateProcessorVersionResponse) GetEvaluation

func (x *EvaluateProcessorVersionResponse) GetEvaluation() string

func (*EvaluateProcessorVersionResponse) ProtoMessage

func (*EvaluateProcessorVersionResponse) ProtoMessage()

func (*EvaluateProcessorVersionResponse) ProtoReflect

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

func (*EvaluateProcessorVersionResponse) Reset

func (x *EvaluateProcessorVersionResponse) Reset()

func (*EvaluateProcessorVersionResponse) String

func (x *EvaluateProcessorVersionResponse) String() string

Evaluation

type Evaluation struct {

	// The resource name of the evaluation.
	// Format:
	// `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The time that the evaluation was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Counters for the documents used in the evaluation.
	DocumentCounters *Evaluation_Counters `protobuf:"bytes,5,opt,name=document_counters,json=documentCounters,proto3" json:"document_counters,omitempty"`
	// Metrics for all the entities in aggregate.
	AllEntitiesMetrics *Evaluation_MultiConfidenceMetrics `protobuf:"bytes,3,opt,name=all_entities_metrics,json=allEntitiesMetrics,proto3" json:"all_entities_metrics,omitempty"`
	// Metrics across confidence levels, for different entities.
	EntityMetrics map[string]*Evaluation_MultiConfidenceMetrics `protobuf:"bytes,4,rep,name=entity_metrics,json=entityMetrics,proto3" json:"entity_metrics,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
	// The KMS key name used for encryption.
	KmsKeyName string `protobuf:"bytes,6,opt,name=kms_key_name,json=kmsKeyName,proto3" json:"kms_key_name,omitempty"`
	// The KMS key version with which data is encrypted.
	KmsKeyVersionName string `protobuf:"bytes,7,opt,name=kms_key_version_name,json=kmsKeyVersionName,proto3" json:"kms_key_version_name,omitempty"`
	// contains filtered or unexported fields
}

An evaluation of a ProcessorVersion's performance.

func (*Evaluation) Descriptor

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

Deprecated: Use Evaluation.ProtoReflect.Descriptor instead.

func (*Evaluation) GetAllEntitiesMetrics

func (x *Evaluation) GetAllEntitiesMetrics() *Evaluation_MultiConfidenceMetrics

func (*Evaluation) GetCreateTime

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

func (*Evaluation) GetDocumentCounters

func (x *Evaluation) GetDocumentCounters() *Evaluation_Counters

func (*Evaluation) GetEntityMetrics

func (x *Evaluation) GetEntityMetrics() map[string]*Evaluation_MultiConfidenceMetrics

func (*Evaluation) GetKmsKeyName

func (x *Evaluation) GetKmsKeyName() string

func (*Evaluation) GetKmsKeyVersionName

func (x *Evaluation) GetKmsKeyVersionName() string

func (*Evaluation) GetName

func (x *Evaluation) GetName() string

func (*Evaluation) ProtoMessage

func (*Evaluation) ProtoMessage()

func (*Evaluation) ProtoReflect

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

func (*Evaluation) Reset

func (x *Evaluation) Reset()

func (*Evaluation) String

func (x *Evaluation) String() string

EvaluationReference

type EvaluationReference struct {

	// The resource name of the Long Running Operation for the evaluation.
	Operation string `protobuf:"bytes,1,opt,name=operation,proto3" json:"operation,omitempty"`
	// The resource name of the evaluation.
	Evaluation string `protobuf:"bytes,2,opt,name=evaluation,proto3" json:"evaluation,omitempty"`
	// An aggregate of the statistics for the evaluation with fuzzy matching on.
	AggregateMetrics *Evaluation_Metrics `protobuf:"bytes,4,opt,name=aggregate_metrics,json=aggregateMetrics,proto3" json:"aggregate_metrics,omitempty"`
	// An aggregate of the statistics for the evaluation with fuzzy matching off.
	AggregateMetricsExact *Evaluation_Metrics `protobuf:"bytes,5,opt,name=aggregate_metrics_exact,json=aggregateMetricsExact,proto3" json:"aggregate_metrics_exact,omitempty"`
	// contains filtered or unexported fields
}

Gives a short summary of an evaluation, and links to the evaluation itself.

func (*EvaluationReference) Descriptor

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

Deprecated: Use EvaluationReference.ProtoReflect.Descriptor instead.

func (*EvaluationReference) GetAggregateMetrics

func (x *EvaluationReference) GetAggregateMetrics() *Evaluation_Metrics

func (*EvaluationReference) GetAggregateMetricsExact

func (x *EvaluationReference) GetAggregateMetricsExact() *Evaluation_Metrics

func (*EvaluationReference) GetEvaluation

func (x *EvaluationReference) GetEvaluation() string

func (*EvaluationReference) GetOperation

func (x *EvaluationReference) GetOperation() string

func (*EvaluationReference) ProtoMessage

func (*EvaluationReference) ProtoMessage()

func (*EvaluationReference) ProtoReflect

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

func (*EvaluationReference) Reset

func (x *EvaluationReference) Reset()

func (*EvaluationReference) String

func (x *EvaluationReference) String() string

Evaluation_ConfidenceLevelMetrics

type Evaluation_ConfidenceLevelMetrics struct {

	// The confidence level.
	ConfidenceLevel float32 `protobuf:"fixed32,1,opt,name=confidence_level,json=confidenceLevel,proto3" json:"confidence_level,omitempty"`
	// The metrics at the specific confidence level.
	Metrics *Evaluation_Metrics `protobuf:"bytes,2,opt,name=metrics,proto3" json:"metrics,omitempty"`
	// contains filtered or unexported fields
}

Evaluations metrics, at a specific confidence level.

func (*Evaluation_ConfidenceLevelMetrics) Descriptor

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

Deprecated: Use Evaluation_ConfidenceLevelMetrics.ProtoReflect.Descriptor instead.

func (*Evaluation_ConfidenceLevelMetrics) GetConfidenceLevel

func (x *Evaluation_ConfidenceLevelMetrics) GetConfidenceLevel() float32

func (*Evaluation_ConfidenceLevelMetrics) GetMetrics

func (x *Evaluation_ConfidenceLevelMetrics) GetMetrics() *Evaluation_Metrics

func (*Evaluation_ConfidenceLevelMetrics) ProtoMessage

func (*Evaluation_ConfidenceLevelMetrics) ProtoMessage()

func (*Evaluation_ConfidenceLevelMetrics) ProtoReflect

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

func (*Evaluation_ConfidenceLevelMetrics) Reset

func (x *Evaluation_ConfidenceLevelMetrics) Reset()

func (*Evaluation_ConfidenceLevelMetrics) String

func (x *Evaluation_ConfidenceLevelMetrics) String() string

Evaluation_Counters

type Evaluation_Counters struct {

	// How many documents were sent for evaluation.
	InputDocumentsCount int32 `protobuf:"varint,1,opt,name=input_documents_count,json=inputDocumentsCount,proto3" json:"input_documents_count,omitempty"`
	// How many documents were not included in the evaluation as they didn't
	// pass validation.
	InvalidDocumentsCount int32 `protobuf:"varint,2,opt,name=invalid_documents_count,json=invalidDocumentsCount,proto3" json:"invalid_documents_count,omitempty"`
	// How many documents were not included in the evaluation as Document AI
	// failed to process them.
	FailedDocumentsCount int32 `protobuf:"varint,3,opt,name=failed_documents_count,json=failedDocumentsCount,proto3" json:"failed_documents_count,omitempty"`
	// How many documents were used in the evaluation.
	EvaluatedDocumentsCount int32 `protobuf:"varint,4,opt,name=evaluated_documents_count,json=evaluatedDocumentsCount,proto3" json:"evaluated_documents_count,omitempty"`
	// contains filtered or unexported fields
}

Evaluation counters for the documents that were used.

func (*Evaluation_Counters) Descriptor

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

Deprecated: Use Evaluation_Counters.ProtoReflect.Descriptor instead.

func (*Evaluation_Counters) GetEvaluatedDocumentsCount

func (x *Evaluation_Counters) GetEvaluatedDocumentsCount() int32

func (*Evaluation_Counters) GetFailedDocumentsCount

func (x *Evaluation_Counters) GetFailedDocumentsCount() int32

func (*Evaluation_Counters) GetInputDocumentsCount

func (x *Evaluation_Counters) GetInputDocumentsCount() int32

func (*Evaluation_Counters) GetInvalidDocumentsCount

func (x *Evaluation_Counters) GetInvalidDocumentsCount() int32

func (*Evaluation_Counters) ProtoMessage

func (*Evaluation_Counters) ProtoMessage()

func (*Evaluation_Counters) ProtoReflect

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

func (*Evaluation_Counters) Reset

func (x *Evaluation_Counters) Reset()

func (*Evaluation_Counters) String

func (x *Evaluation_Counters) String() string

Evaluation_Metrics

type Evaluation_Metrics struct {

	// The calculated precision.
	Precision float32 `protobuf:"fixed32,1,opt,name=precision,proto3" json:"precision,omitempty"`
	// The calculated recall.
	Recall float32 `protobuf:"fixed32,2,opt,name=recall,proto3" json:"recall,omitempty"`
	// The calculated f1 score.
	F1Score float32 `protobuf:"fixed32,3,opt,name=f1_score,json=f1Score,proto3" json:"f1_score,omitempty"`
	// The amount of occurrences in predicted documents.
	PredictedOccurrencesCount int32 `protobuf:"varint,4,opt,name=predicted_occurrences_count,json=predictedOccurrencesCount,proto3" json:"predicted_occurrences_count,omitempty"`
	// The amount of occurrences in ground truth documents.
	GroundTruthOccurrencesCount int32 `protobuf:"varint,5,opt,name=ground_truth_occurrences_count,json=groundTruthOccurrencesCount,proto3" json:"ground_truth_occurrences_count,omitempty"`
	// The amount of documents with a predicted occurrence.
	PredictedDocumentCount int32 `protobuf:"varint,10,opt,name=predicted_document_count,json=predictedDocumentCount,proto3" json:"predicted_document_count,omitempty"`
	// The amount of documents with a ground truth occurrence.
	GroundTruthDocumentCount int32 `protobuf:"varint,11,opt,name=ground_truth_document_count,json=groundTruthDocumentCount,proto3" json:"ground_truth_document_count,omitempty"`
	// The amount of true positives.
	TruePositivesCount int32 `protobuf:"varint,6,opt,name=true_positives_count,json=truePositivesCount,proto3" json:"true_positives_count,omitempty"`
	// The amount of false positives.
	FalsePositivesCount int32 `protobuf:"varint,7,opt,name=false_positives_count,json=falsePositivesCount,proto3" json:"false_positives_count,omitempty"`
	// The amount of false negatives.
	FalseNegativesCount int32 `protobuf:"varint,8,opt,name=false_negatives_count,json=falseNegativesCount,proto3" json:"false_negatives_count,omitempty"`
	// The amount of documents that had an occurrence of this label.
	TotalDocumentsCount int32 `protobuf:"varint,9,opt,name=total_documents_count,json=totalDocumentsCount,proto3" json:"total_documents_count,omitempty"`
	// contains filtered or unexported fields
}

Evaluation metrics, either in aggregate or about a specific entity.

func (*Evaluation_Metrics) Descriptor

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

Deprecated: Use Evaluation_Metrics.ProtoReflect.Descriptor instead.

func (*Evaluation_Metrics) GetF1Score

func (x *Evaluation_Metrics) GetF1Score() float32

func (*Evaluation_Metrics) GetFalseNegativesCount

func (x *Evaluation_Metrics) GetFalseNegativesCount() int32

func (*Evaluation_Metrics) GetFalsePositivesCount

func (x *Evaluation_Metrics) GetFalsePositivesCount() int32

func (*Evaluation_Metrics) GetGroundTruthDocumentCount

func (x *Evaluation_Metrics) GetGroundTruthDocumentCount() int32

func (*Evaluation_Metrics) GetGroundTruthOccurrencesCount

func (x *Evaluation_Metrics) GetGroundTruthOccurrencesCount() int32

func (*Evaluation_Metrics) GetPrecision

func (x *Evaluation_Metrics) GetPrecision() float32

func (*Evaluation_Metrics) GetPredictedDocumentCount

func (x *Evaluation_Metrics) GetPredictedDocumentCount() int32

func (*Evaluation_Metrics) GetPredictedOccurrencesCount

func (x *Evaluation_Metrics) GetPredictedOccurrencesCount() int32

func (*Evaluation_Metrics) GetRecall

func (x *Evaluation_Metrics) GetRecall() float32

func (*Evaluation_Metrics) GetTotalDocumentsCount

func (x *Evaluation_Metrics) GetTotalDocumentsCount() int32

func (*Evaluation_Metrics) GetTruePositivesCount

func (x *Evaluation_Metrics) GetTruePositivesCount() int32

func (*Evaluation_Metrics) ProtoMessage

func (*Evaluation_Metrics) ProtoMessage()

func (*Evaluation_Metrics) ProtoReflect

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

func (*Evaluation_Metrics) Reset

func (x *Evaluation_Metrics) Reset()

func (*Evaluation_Metrics) String

func (x *Evaluation_Metrics) String() string

Evaluation_MultiConfidenceMetrics

type Evaluation_MultiConfidenceMetrics struct {

	// Metrics across confidence levels with fuzzy matching enabled.
	ConfidenceLevelMetrics []*Evaluation_ConfidenceLevelMetrics `protobuf:"bytes,1,rep,name=confidence_level_metrics,json=confidenceLevelMetrics,proto3" json:"confidence_level_metrics,omitempty"`
	// Metrics across confidence levels with only exact matching.
	ConfidenceLevelMetricsExact []*Evaluation_ConfidenceLevelMetrics `protobuf:"bytes,4,rep,name=confidence_level_metrics_exact,json=confidenceLevelMetricsExact,proto3" json:"confidence_level_metrics_exact,omitempty"`
	// The calculated area under the precision recall curve (AUPRC), computed by
	// integrating over all confidence thresholds.
	Auprc float32 `protobuf:"fixed32,2,opt,name=auprc,proto3" json:"auprc,omitempty"`
	// The Estimated Calibration Error (ECE) of the confidence of the predicted
	// entities.
	EstimatedCalibrationError float32 `protobuf:"fixed32,3,opt,name=estimated_calibration_error,json=estimatedCalibrationError,proto3" json:"estimated_calibration_error,omitempty"`
	// The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching
	// only.
	AuprcExact float32 `protobuf:"fixed32,5,opt,name=auprc_exact,json=auprcExact,proto3" json:"auprc_exact,omitempty"`
	// The ECE for the predicted entities with fuzzy matching disabled, i.e.,
	// exact matching only.
	EstimatedCalibrationErrorExact float32 `protobuf:"fixed32,6,opt,name=estimated_calibration_error_exact,json=estimatedCalibrationErrorExact,proto3" json:"estimated_calibration_error_exact,omitempty"`
	// The metrics type for the label.
	MetricsType Evaluation_MultiConfidenceMetrics_MetricsType `protobuf:"varint,7,opt,name=metrics_type,json=metricsType,proto3,enum=google.cloud.documentai.v1beta3.Evaluation_MultiConfidenceMetrics_MetricsType" json:"metrics_type,omitempty"`
	// contains filtered or unexported fields
}

Metrics across multiple confidence levels.

func (*Evaluation_MultiConfidenceMetrics) Descriptor

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

Deprecated: Use Evaluation_MultiConfidenceMetrics.ProtoReflect.Descriptor instead.

func (*Evaluation_MultiConfidenceMetrics) GetAuprc

func (x *Evaluation_MultiConfidenceMetrics) GetAuprc() float32

func (*Evaluation_MultiConfidenceMetrics) GetAuprcExact

func (x *Evaluation_MultiConfidenceMetrics) GetAuprcExact() float32

func (*Evaluation_MultiConfidenceMetrics) GetConfidenceLevelMetrics

func (x *Evaluation_MultiConfidenceMetrics) GetConfidenceLevelMetrics() []*Evaluation_ConfidenceLevelMetrics

func (*Evaluation_MultiConfidenceMetrics) GetConfidenceLevelMetricsExact

func (x *Evaluation_MultiConfidenceMetrics) GetConfidenceLevelMetricsExact() []*Evaluation_ConfidenceLevelMetrics

func (*Evaluation_MultiConfidenceMetrics) GetEstimatedCalibrationError

func (x *Evaluation_MultiConfidenceMetrics) GetEstimatedCalibrationError() float32

func (*Evaluation_MultiConfidenceMetrics) GetEstimatedCalibrationErrorExact

func (x *Evaluation_MultiConfidenceMetrics) GetEstimatedCalibrationErrorExact() float32

func (*Evaluation_MultiConfidenceMetrics) GetMetricsType

func (x *Evaluation_MultiConfidenceMetrics) GetMetricsType() Evaluation_MultiConfidenceMetrics_MetricsType

func (*Evaluation_MultiConfidenceMetrics) ProtoMessage

func (*Evaluation_MultiConfidenceMetrics) ProtoMessage()

func (*Evaluation_MultiConfidenceMetrics) ProtoReflect

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

func (*Evaluation_MultiConfidenceMetrics) Reset

func (x *Evaluation_MultiConfidenceMetrics) Reset()

func (*Evaluation_MultiConfidenceMetrics) String

func (x *Evaluation_MultiConfidenceMetrics) String() string

Evaluation_MultiConfidenceMetrics_MetricsType

type Evaluation_MultiConfidenceMetrics_MetricsType int32

A type that determines how metrics should be interpreted.

Evaluation_MultiConfidenceMetrics_METRICS_TYPE_UNSPECIFIED, Evaluation_MultiConfidenceMetrics_AGGREGATE

const (
	// The metrics type is unspecified. By default, metrics without a
	// particular specification are for leaf entity types (i.e., top-level
	// entity types without child types, or child types which are not
	// parent types themselves).
	Evaluation_MultiConfidenceMetrics_METRICS_TYPE_UNSPECIFIED Evaluation_MultiConfidenceMetrics_MetricsType = 0
	// Indicates whether metrics for this particular label type represent an
	// aggregate of metrics for other types instead of being based on actual
	// TP/FP/FN values for the label type. Metrics for parent (i.e., non-leaf)
	// entity types are an aggregate of metrics for their children.
	Evaluation_MultiConfidenceMetrics_AGGREGATE Evaluation_MultiConfidenceMetrics_MetricsType = 1
)

func (Evaluation_MultiConfidenceMetrics_MetricsType) Descriptor

func (Evaluation_MultiConfidenceMetrics_MetricsType) Descriptor() protoreflect.EnumDescriptor

func (Evaluation_MultiConfidenceMetrics_MetricsType) Enum

func (x Evaluation_MultiConfidenceMetrics_MetricsType) Enum() *Evaluation_MultiConfidenceMetrics_MetricsType

func (Evaluation_MultiConfidenceMetrics_MetricsType) EnumDescriptor

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

Deprecated: Use Evaluation_MultiConfidenceMetrics_MetricsType.Descriptor instead.

func (Evaluation_MultiConfidenceMetrics_MetricsType) Number

func (x Evaluation_MultiConfidenceMetrics_MetricsType) Number() protoreflect.EnumNumber

func (Evaluation_MultiConfidenceMetrics_MetricsType) String

func (x Evaluation_MultiConfidenceMetrics_MetricsType) String() string

func (Evaluation_MultiConfidenceMetrics_MetricsType) Type

func (Evaluation_MultiConfidenceMetrics_MetricsType) Type() protoreflect.EnumType

FetchProcessorTypesRequest

type FetchProcessorTypesRequest struct {

	// Required. The location of processor types to list.
	// Format: `projects/{project}/locations/{location}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// contains filtered or unexported fields
}

Request message for the [FetchProcessorTypes][google.cloud.documentai.v1beta3.DocumentProcessorService.FetchProcessorTypes] method. Some processor types may require the project be added to an allowlist.

func (*FetchProcessorTypesRequest) Descriptor

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

Deprecated: Use FetchProcessorTypesRequest.ProtoReflect.Descriptor instead.

func (*FetchProcessorTypesRequest) GetParent

func (x *FetchProcessorTypesRequest) GetParent() string

func (*FetchProcessorTypesRequest) ProtoMessage

func (*FetchProcessorTypesRequest) ProtoMessage()

func (*FetchProcessorTypesRequest) ProtoReflect

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

func (*FetchProcessorTypesRequest) Reset

func (x *FetchProcessorTypesRequest) Reset()

func (*FetchProcessorTypesRequest) String

func (x *FetchProcessorTypesRequest) String() string

FetchProcessorTypesResponse

type FetchProcessorTypesResponse struct {

	// The list of processor types.
	ProcessorTypes []*ProcessorType `protobuf:"bytes,1,rep,name=processor_types,json=processorTypes,proto3" json:"processor_types,omitempty"`
	// contains filtered or unexported fields
}

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

func (*FetchProcessorTypesResponse) Descriptor

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

Deprecated: Use FetchProcessorTypesResponse.ProtoReflect.Descriptor instead.

func (*FetchProcessorTypesResponse) GetProcessorTypes

func (x *FetchProcessorTypesResponse) GetProcessorTypes() []*ProcessorType

func (*FetchProcessorTypesResponse) ProtoMessage

func (*FetchProcessorTypesResponse) ProtoMessage()

func (*FetchProcessorTypesResponse) ProtoReflect

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

func (*FetchProcessorTypesResponse) Reset

func (x *FetchProcessorTypesResponse) Reset()

func (*FetchProcessorTypesResponse) String

func (x *FetchProcessorTypesResponse) String() string

FieldExtractionMetadata

type FieldExtractionMetadata struct {

	// Summary options config.
	SummaryOptions *SummaryOptions `protobuf:"bytes,2,opt,name=summary_options,json=summaryOptions,proto3" json:"summary_options,omitempty"`
	// contains filtered or unexported fields
}

Metadata for how this field value is extracted.

func (*FieldExtractionMetadata) Descriptor

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

Deprecated: Use FieldExtractionMetadata.ProtoReflect.Descriptor instead.

func (*FieldExtractionMetadata) GetSummaryOptions

func (x *FieldExtractionMetadata) GetSummaryOptions() *SummaryOptions

func (*FieldExtractionMetadata) ProtoMessage

func (*FieldExtractionMetadata) ProtoMessage()

func (*FieldExtractionMetadata) ProtoReflect

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

func (*FieldExtractionMetadata) Reset

func (x *FieldExtractionMetadata) Reset()

func (*FieldExtractionMetadata) String

func (x *FieldExtractionMetadata) String() string

GcsDocument

type GcsDocument struct {

	// The Cloud Storage object uri.
	GcsUri string `protobuf:"bytes,1,opt,name=gcs_uri,json=gcsUri,proto3" json:"gcs_uri,omitempty"`
	// An IANA MIME type (RFC6838) of the content.
	MimeType string `protobuf:"bytes,2,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// contains filtered or unexported fields
}

Specifies a document stored on Cloud Storage.

func (*GcsDocument) Descriptor

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

Deprecated: Use GcsDocument.ProtoReflect.Descriptor instead.

func (*GcsDocument) GetGcsUri

func (x *GcsDocument) GetGcsUri() string

func (*GcsDocument) GetMimeType

func (x *GcsDocument) GetMimeType() string

func (*GcsDocument) ProtoMessage

func (*GcsDocument) ProtoMessage()

func (*GcsDocument) ProtoReflect

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

func (*GcsDocument) Reset

func (x *GcsDocument) Reset()

func (*GcsDocument) String

func (x *GcsDocument) String() string

GcsDocuments

type GcsDocuments struct {

	// The list of documents.
	Documents []*GcsDocument `protobuf:"bytes,1,rep,name=documents,proto3" json:"documents,omitempty"`
	// contains filtered or unexported fields
}

Specifies a set of documents on Cloud Storage.

func (*GcsDocuments) Descriptor

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

Deprecated: Use GcsDocuments.ProtoReflect.Descriptor instead.

func (*GcsDocuments) GetDocuments

func (x *GcsDocuments) GetDocuments() []*GcsDocument

func (*GcsDocuments) ProtoMessage

func (*GcsDocuments) ProtoMessage()

func (*GcsDocuments) ProtoReflect

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

func (*GcsDocuments) Reset

func (x *GcsDocuments) Reset()

func (*GcsDocuments) String

func (x *GcsDocuments) String() string

GcsPrefix

type GcsPrefix struct {

	// The URI prefix.
	GcsUriPrefix string `protobuf:"bytes,1,opt,name=gcs_uri_prefix,json=gcsUriPrefix,proto3" json:"gcs_uri_prefix,omitempty"`
	// contains filtered or unexported fields
}

Specifies all documents on Cloud Storage with a common prefix.

func (*GcsPrefix) Descriptor

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

Deprecated: Use GcsPrefix.ProtoReflect.Descriptor instead.

func (*GcsPrefix) GetGcsUriPrefix

func (x *GcsPrefix) GetGcsUriPrefix() string

func (*GcsPrefix) ProtoMessage

func (*GcsPrefix) ProtoMessage()

func (*GcsPrefix) ProtoReflect

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

func (*GcsPrefix) Reset

func (x *GcsPrefix) Reset()

func (*GcsPrefix) String

func (x *GcsPrefix) String() string

GetDatasetSchemaRequest

type GetDatasetSchemaRequest struct {

	// Required. The 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"`
	// If set, only returns the visible fields of the schema.
	VisibleFieldsOnly bool `protobuf:"varint,2,opt,name=visible_fields_only,json=visibleFieldsOnly,proto3" json:"visible_fields_only,omitempty"`
	// contains filtered or unexported fields
}

Request for GetDatasetSchema.

func (*GetDatasetSchemaRequest) Descriptor

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

Deprecated: Use GetDatasetSchemaRequest.ProtoReflect.Descriptor instead.

func (*GetDatasetSchemaRequest) GetName

func (x *GetDatasetSchemaRequest) GetName() string

func (*GetDatasetSchemaRequest) GetVisibleFieldsOnly

func (x *GetDatasetSchemaRequest) GetVisibleFieldsOnly() bool

func (*GetDatasetSchemaRequest) ProtoMessage

func (*GetDatasetSchemaRequest) ProtoMessage()

func (*GetDatasetSchemaRequest) ProtoReflect

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

func (*GetDatasetSchemaRequest) Reset

func (x *GetDatasetSchemaRequest) Reset()

func (*GetDatasetSchemaRequest) String

func (x *GetDatasetSchemaRequest) String() string

GetDocumentRequest

type GetDocumentRequest struct {

	// Required. The resource name of the dataset that the document belongs to .
	// Format:
	// projects/{project}/locations/{location}/processors/{processor}/dataset
	Dataset string `protobuf:"bytes,1,opt,name=dataset,proto3" json:"dataset,omitempty"`
	// Required. Document identifier.
	DocumentId *DocumentId `protobuf:"bytes,2,opt,name=document_id,json=documentId,proto3" json:"document_id,omitempty"`
	// If set, only fields listed here will be returned. Otherwise, all fields
	// will be returned by default.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// List of pages for which the fields specified in the `read_mask` must
	// be served.
	PageRange *DocumentPageRange `protobuf:"bytes,4,opt,name=page_range,json=pageRange,proto3" json:"page_range,omitempty"`
	// contains filtered or unexported fields
}

func (*GetDocumentRequest) Descriptor

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

Deprecated: Use GetDocumentRequest.ProtoReflect.Descriptor instead.

func (*GetDocumentRequest) GetDataset

func (x *GetDocumentRequest) GetDataset() string

func (*GetDocumentRequest) GetDocumentId

func (x *GetDocumentRequest) GetDocumentId() *DocumentId

func (*GetDocumentRequest) GetPageRange

func (x *GetDocumentRequest) GetPageRange() *DocumentPageRange

func (*GetDocumentRequest) GetReadMask

func (x *GetDocumentRequest) GetReadMask() *fieldmaskpb.FieldMask

func (*GetDocumentRequest) ProtoMessage

func (*GetDocumentRequest) ProtoMessage()

func (*GetDocumentRequest) ProtoReflect

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

func (*GetDocumentRequest) Reset

func (x *GetDocumentRequest) Reset()

func (*GetDocumentRequest) String

func (x *GetDocumentRequest) String() string

GetDocumentResponse

type GetDocumentResponse struct {
	Document *Document `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
	// contains filtered or unexported fields
}

func (*GetDocumentResponse) Descriptor

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

Deprecated: Use GetDocumentResponse.ProtoReflect.Descriptor instead.

func (*GetDocumentResponse) GetDocument

func (x *GetDocumentResponse) GetDocument() *Document

func (*GetDocumentResponse) ProtoMessage

func (*GetDocumentResponse) ProtoMessage()

func (*GetDocumentResponse) ProtoReflect

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

func (*GetDocumentResponse) Reset

func (x *GetDocumentResponse) Reset()

func (*GetDocumentResponse) String

func (x *GetDocumentResponse) String() string

GetEvaluationRequest

type GetEvaluationRequest struct {

	// Required. The resource name of the
	// [Evaluation][google.cloud.documentai.v1beta3.Evaluation] to get.
	// `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Retrieves a specific Evaluation.

func (*GetEvaluationRequest) Descriptor

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

Deprecated: Use GetEvaluationRequest.ProtoReflect.Descriptor instead.

func (*GetEvaluationRequest) GetName

func (x *GetEvaluationRequest) GetName() string

func (*GetEvaluationRequest) ProtoMessage

func (*GetEvaluationRequest) ProtoMessage()

func (*GetEvaluationRequest) ProtoReflect

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

func (*GetEvaluationRequest) Reset

func (x *GetEvaluationRequest) Reset()

func (*GetEvaluationRequest) String

func (x *GetEvaluationRequest) String() string

GetProcessorRequest

type GetProcessorRequest struct {

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

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

func (*GetProcessorRequest) Descriptor

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

Deprecated: Use GetProcessorRequest.ProtoReflect.Descriptor instead.

func (*GetProcessorRequest) GetName

func (x *GetProcessorRequest) GetName() string

func (*GetProcessorRequest) ProtoMessage

func (*GetProcessorRequest) ProtoMessage()

func (*GetProcessorRequest) ProtoReflect

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

func (*GetProcessorRequest) Reset

func (x *GetProcessorRequest) Reset()

func (*GetProcessorRequest) String

func (x *GetProcessorRequest) String() string

GetProcessorTypeRequest

type GetProcessorTypeRequest struct {

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

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

func (*GetProcessorTypeRequest) Descriptor

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

Deprecated: Use GetProcessorTypeRequest.ProtoReflect.Descriptor instead.

func (*GetProcessorTypeRequest) GetName

func (x *GetProcessorTypeRequest) GetName() string

func (*GetProcessorTypeRequest) ProtoMessage

func (*GetProcessorTypeRequest) ProtoMessage()

func (*GetProcessorTypeRequest) ProtoReflect

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

func (*GetProcessorTypeRequest) Reset

func (x *GetProcessorTypeRequest) Reset()

func (*GetProcessorTypeRequest) String

func (x *GetProcessorTypeRequest) String() string

GetProcessorVersionRequest

type GetProcessorVersionRequest struct {

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

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

func (*GetProcessorVersionRequest) Descriptor

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

Deprecated: Use GetProcessorVersionRequest.ProtoReflect.Descriptor instead.

func (*GetProcessorVersionRequest) GetName

func (x *GetProcessorVersionRequest) GetName() string

func (*GetProcessorVersionRequest) ProtoMessage

func (*GetProcessorVersionRequest) ProtoMessage()

func (*GetProcessorVersionRequest) ProtoReflect

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

func (*GetProcessorVersionRequest) Reset

func (x *GetProcessorVersionRequest) Reset()

func (*GetProcessorVersionRequest) String

func (x *GetProcessorVersionRequest) String() string

HumanReviewStatus

type HumanReviewStatus struct {

	// The state of human review on the processing request.
	State HumanReviewStatus_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.cloud.documentai.v1beta3.HumanReviewStatus_State" json:"state,omitempty"`
	// A message providing more details about the human review state.
	StateMessage string `protobuf:"bytes,2,opt,name=state_message,json=stateMessage,proto3" json:"state_message,omitempty"`
	// The name of the operation triggered by the processed document. This field
	// is populated only when the
	// [state][google.cloud.documentai.v1beta3.HumanReviewStatus.state] is
	// `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as
	// the long-running operation returned by
	// [ReviewDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ReviewDocument].
	HumanReviewOperation string `protobuf:"bytes,3,opt,name=human_review_operation,json=humanReviewOperation,proto3" json:"human_review_operation,omitempty"`
	// contains filtered or unexported fields
}

The status of human review on a processed document.

func (*HumanReviewStatus) Descriptor

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

Deprecated: Use HumanReviewStatus.ProtoReflect.Descriptor instead.

func (*HumanReviewStatus) GetHumanReviewOperation

func (x *HumanReviewStatus) GetHumanReviewOperation() string

func (*HumanReviewStatus) GetState

func (x *HumanReviewStatus) GetState() HumanReviewStatus_State

func (*HumanReviewStatus) GetStateMessage

func (x *HumanReviewStatus) GetStateMessage() string

func (*HumanReviewStatus) ProtoMessage

func (*HumanReviewStatus) ProtoMessage()

func (*HumanReviewStatus) ProtoReflect

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

func (*HumanReviewStatus) Reset

func (x *HumanReviewStatus) Reset()

func (*HumanReviewStatus) String

func (x *HumanReviewStatus) String() string

HumanReviewStatus_State

type HumanReviewStatus_State int32

The final state of human review on a processed document.

HumanReviewStatus_STATE_UNSPECIFIED, HumanReviewStatus_SKIPPED, HumanReviewStatus_VALIDATION_PASSED, HumanReviewStatus_IN_PROGRESS, HumanReviewStatus_ERROR

const (
	// Human review state is unspecified. Most likely due to an internal error.
	HumanReviewStatus_STATE_UNSPECIFIED HumanReviewStatus_State = 0
	// Human review is skipped for the document. This can happen because human
	// review isn't enabled on the processor or the processing request has
	// been set to skip this document.
	HumanReviewStatus_SKIPPED HumanReviewStatus_State = 1
	// Human review validation is triggered and passed, so no review is needed.
	HumanReviewStatus_VALIDATION_PASSED HumanReviewStatus_State = 2
	// Human review validation is triggered and the document is under review.
	HumanReviewStatus_IN_PROGRESS HumanReviewStatus_State = 3
	// Some error happened during triggering human review, see the
	// [state_message][google.cloud.documentai.v1beta3.HumanReviewStatus.state_message]
	// for details.
	HumanReviewStatus_ERROR HumanReviewStatus_State = 4
)

func (HumanReviewStatus_State) Descriptor

func (HumanReviewStatus_State) Descriptor() protoreflect.EnumDescriptor

func (HumanReviewStatus_State) Enum

func (x HumanReviewStatus_State) Enum() *HumanReviewStatus_State

func (HumanReviewStatus_State) EnumDescriptor

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

Deprecated: Use HumanReviewStatus_State.Descriptor instead.

func (HumanReviewStatus_State) Number

func (x HumanReviewStatus_State) Number() protoreflect.EnumNumber

func (HumanReviewStatus_State) String

func (x HumanReviewStatus_State) String() string

func (HumanReviewStatus_State) Type

func (HumanReviewStatus_State) Type() protoreflect.EnumType

ImportDocumentsMetadata

type ImportDocumentsMetadata 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"`
	// The list of response details of each document.
	IndividualImportStatuses []*ImportDocumentsMetadata_IndividualImportStatus `protobuf:"bytes,2,rep,name=individual_import_statuses,json=individualImportStatuses,proto3" json:"individual_import_statuses,omitempty"`
	// Validation statuses of the batch documents import config.
	ImportConfigValidationResults []*ImportDocumentsMetadata_ImportConfigValidationResult `protobuf:"bytes,4,rep,name=import_config_validation_results,json=importConfigValidationResults,proto3" json:"import_config_validation_results,omitempty"`
	// Total number of the documents that are qualified for importing.
	TotalDocumentCount int32 `protobuf:"varint,3,opt,name=total_document_count,json=totalDocumentCount,proto3" json:"total_document_count,omitempty"`
	// contains filtered or unexported fields
}

Metadata of the import document operation.

func (*ImportDocumentsMetadata) Descriptor

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

Deprecated: Use ImportDocumentsMetadata.ProtoReflect.Descriptor instead.

func (*ImportDocumentsMetadata) GetCommonMetadata

func (x *ImportDocumentsMetadata) GetCommonMetadata() *CommonOperationMetadata

func (*ImportDocumentsMetadata) GetImportConfigValidationResults

func (x *ImportDocumentsMetadata) GetImportConfigValidationResults() []*ImportDocumentsMetadata_ImportConfigValidationResult

func (*ImportDocumentsMetadata) GetIndividualImportStatuses

func (x *ImportDocumentsMetadata) GetIndividualImportStatuses() []*ImportDocumentsMetadata_IndividualImportStatus

func (*ImportDocumentsMetadata) GetTotalDocumentCount

func (x *ImportDocumentsMetadata) GetTotalDocumentCount() int32

func (*ImportDocumentsMetadata) ProtoMessage

func (*ImportDocumentsMetadata) ProtoMessage()

func (*ImportDocumentsMetadata) ProtoReflect

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

func (*ImportDocumentsMetadata) Reset

func (x *ImportDocumentsMetadata) Reset()

func (*ImportDocumentsMetadata) String

func (x *ImportDocumentsMetadata) String() string

ImportDocumentsMetadata_ImportConfigValidationResult

type ImportDocumentsMetadata_ImportConfigValidationResult struct {

	// The source Cloud Storage URI specified in the import config.
	InputGcsSource string `protobuf:"bytes,1,opt,name=input_gcs_source,json=inputGcsSource,proto3" json:"input_gcs_source,omitempty"`
	// The validation status of import config.
	Status *status.Status `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

The validation status of each import config. Status is set to an error if there are no documents to import in the import_config, or OK if the operation will try to proceed with at least one document.

func (*ImportDocumentsMetadata_ImportConfigValidationResult) Descriptor

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

Deprecated: Use ImportDocumentsMetadata_ImportConfigValidationResult.ProtoReflect.Descriptor instead.

func (*ImportDocumentsMetadata_ImportConfigValidationResult) GetInputGcsSource

func (x *ImportDocumentsMetadata_ImportConfigValidationResult) GetInputGcsSource() string

func (*ImportDocumentsMetadata_ImportConfigValidationResult) GetStatus

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

func (*ImportDocumentsMetadata_ImportConfigValidationResult) ProtoMessage

func (*ImportDocumentsMetadata_ImportConfigValidationResult) ProtoMessage()

func (*ImportDocumentsMetadata_ImportConfigValidationResult) ProtoReflect

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

func (*ImportDocumentsMetadata_ImportConfigValidationResult) Reset

func (x *ImportDocumentsMetadata_ImportConfigValidationResult) Reset()

func (*ImportDocumentsMetadata_ImportConfigValidationResult) String

func (x *ImportDocumentsMetadata_ImportConfigValidationResult) String() string

ImportDocumentsMetadata_IndividualImportStatus

type ImportDocumentsMetadata_IndividualImportStatus struct {

	// The source Cloud Storage URI of the document.
	InputGcsSource string `protobuf:"bytes,1,opt,name=input_gcs_source,json=inputGcsSource,proto3" json:"input_gcs_source,omitempty"`
	// The status of the importing of the document.
	Status *status.Status `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// The document id of imported document if it was successful, otherwise
	// empty.
	OutputDocumentId *DocumentId `protobuf:"bytes,4,opt,name=output_document_id,json=outputDocumentId,proto3" json:"output_document_id,omitempty"`
	// contains filtered or unexported fields
}

The status of each individual document in the import process.

func (*ImportDocumentsMetadata_IndividualImportStatus) Descriptor

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

Deprecated: Use ImportDocumentsMetadata_IndividualImportStatus.ProtoReflect.Descriptor instead.

func (*ImportDocumentsMetadata_IndividualImportStatus) GetInputGcsSource

func (x *ImportDocumentsMetadata_IndividualImportStatus) GetInputGcsSource() string

func (*ImportDocumentsMetadata_IndividualImportStatus) GetOutputDocumentId

func (x *ImportDocumentsMetadata_IndividualImportStatus) GetOutputDocumentId() *DocumentId

func (*ImportDocumentsMetadata_IndividualImportStatus) GetStatus

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

func (*ImportDocumentsMetadata_IndividualImportStatus) ProtoMessage

func (*ImportDocumentsMetadata_IndividualImportStatus) ProtoMessage()

func (*ImportDocumentsMetadata_IndividualImportStatus) ProtoReflect

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

func (*ImportDocumentsMetadata_IndividualImportStatus) Reset

func (x *ImportDocumentsMetadata_IndividualImportStatus) Reset()

func (*ImportDocumentsMetadata_IndividualImportStatus) String

func (x *ImportDocumentsMetadata_IndividualImportStatus) String() string

ImportDocumentsRequest

type ImportDocumentsRequest 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. The Cloud Storage uri containing raw documents that must be
	// imported.
	BatchDocumentsImportConfigs []*ImportDocumentsRequest_BatchDocumentsImportConfig `protobuf:"bytes,4,rep,name=batch_documents_import_configs,json=batchDocumentsImportConfigs,proto3" json:"batch_documents_import_configs,omitempty"`
	// contains filtered or unexported fields
}

func (*ImportDocumentsRequest) Descriptor

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

Deprecated: Use ImportDocumentsRequest.ProtoReflect.Descriptor instead.

func (*ImportDocumentsRequest) GetBatchDocumentsImportConfigs

func (x *ImportDocumentsRequest) GetBatchDocumentsImportConfigs() []*ImportDocumentsRequest_BatchDocumentsImportConfig

func (*ImportDocumentsRequest) GetDataset

func (x *ImportDocumentsRequest) GetDataset() string

func (*ImportDocumentsRequest) ProtoMessage

func (*ImportDocumentsRequest) ProtoMessage()

func (*ImportDocumentsRequest) ProtoReflect

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

func (*ImportDocumentsRequest) Reset

func (x *ImportDocumentsRequest) Reset()

func (*ImportDocumentsRequest) String

func (x *ImportDocumentsRequest) String() string

ImportDocumentsRequest_BatchDocumentsImportConfig

type ImportDocumentsRequest_BatchDocumentsImportConfig struct {

	// Types that are assignable to SplitTypeConfig:
	//
	//	*ImportDocumentsRequest_BatchDocumentsImportConfig_DatasetSplit
	//	*ImportDocumentsRequest_BatchDocumentsImportConfig_AutoSplitConfig_
	SplitTypeConfig isImportDocumentsRequest_BatchDocumentsImportConfig_SplitTypeConfig `protobuf_oneof:"split_type_config"`
	// The common config to specify a set of documents used as input.
	BatchInputConfig *BatchDocumentsInputConfig `protobuf:"bytes,1,opt,name=batch_input_config,json=batchInputConfig,proto3" json:"batch_input_config,omitempty"`
	// contains filtered or unexported fields
}

Config for importing documents. Each batch can have its own dataset split type.

func (*ImportDocumentsRequest_BatchDocumentsImportConfig) Descriptor

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

Deprecated: Use ImportDocumentsRequest_BatchDocumentsImportConfig.ProtoReflect.Descriptor instead.

func (*ImportDocumentsRequest_BatchDocumentsImportConfig) GetAutoSplitConfig

func (x *ImportDocumentsRequest_BatchDocumentsImportConfig) GetAutoSplitConfig() *ImportDocumentsRequest_BatchDocumentsImportConfig_AutoSplitConfig

func (*ImportDocumentsRequest_BatchDocumentsImportConfig) GetBatchInputConfig

func (x *ImportDocumentsRequest_BatchDocumentsImportConfig) GetBatchInputConfig() *BatchDocumentsInputConfig

func (*ImportDocumentsRequest_BatchDocumentsImportConfig) GetDatasetSplit

func (x *ImportDocumentsRequest_BatchDocumentsImportConfig) GetDatasetSplit() DatasetSplitType

func (*ImportDocumentsRequest_BatchDocumentsImportConfig) GetSplitTypeConfig

func (m *ImportDocumentsRequest_BatchDocumentsImportConfig) GetSplitTypeConfig() isImportDocumentsRequest_BatchDocumentsImportConfig_SplitTypeConfig

func (*ImportDocumentsRequest_BatchDocumentsImportConfig) ProtoMessage

func (*ImportDocumentsRequest_BatchDocumentsImportConfig) ProtoMessage()

func (*ImportDocumentsRequest_BatchDocumentsImportConfig) ProtoReflect

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

func (*ImportDocumentsRequest_BatchDocumentsImportConfig) Reset

func (x *ImportDocumentsRequest_BatchDocumentsImportConfig) Reset()

func (*ImportDocumentsRequest_BatchDocumentsImportConfig) String

func (x *ImportDocumentsRequest_BatchDocumentsImportConfig) String() string

ImportDocumentsRequest_BatchDocumentsImportConfig_AutoSplitConfig

type ImportDocumentsRequest_BatchDocumentsImportConfig_AutoSplitConfig struct {

	// Ratio of training dataset split.
	TrainingSplitRatio float32 `protobuf:"fixed32,1,opt,name=training_split_ratio,json=trainingSplitRatio,proto3" json:"training_split_ratio,omitempty"`
	// contains filtered or unexported fields
}

The config for auto-split.

func (*ImportDocumentsRequest_BatchDocumentsImportConfig_AutoSplitConfig) Descriptor

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

Deprecated: Use ImportDocumentsRequest_BatchDocumentsImportConfig_AutoSplitConfig.ProtoReflect.Descriptor instead.

func (*ImportDocumentsRequest_BatchDocumentsImportConfig_AutoSplitConfig) GetTrainingSplitRatio

func (x *ImportDocumentsRequest_BatchDocumentsImportConfig_AutoSplitConfig) GetTrainingSplitRatio() float32

func (*ImportDocumentsRequest_BatchDocumentsImportConfig_AutoSplitConfig) ProtoMessage

func (*ImportDocumentsRequest_BatchDocumentsImportConfig_AutoSplitConfig) ProtoMessage()

func (*ImportDocumentsRequest_BatchDocumentsImportConfig_AutoSplitConfig) ProtoReflect

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

func (*ImportDocumentsRequest_BatchDocumentsImportConfig_AutoSplitConfig) Reset

func (x *ImportDocumentsRequest_BatchDocumentsImportConfig_AutoSplitConfig) Reset()

func (*ImportDocumentsRequest_BatchDocumentsImportConfig_AutoSplitConfig) String

func (x *ImportDocumentsRequest_BatchDocumentsImportConfig_AutoSplitConfig) String() string

ImportDocumentsRequest_BatchDocumentsImportConfig_AutoSplitConfig_

type ImportDocumentsRequest_BatchDocumentsImportConfig_AutoSplitConfig_ struct {
	// If set, documents will be automatically split into training and test
	// split category with the specified ratio.
	AutoSplitConfig *ImportDocumentsRequest_BatchDocumentsImportConfig_AutoSplitConfig `protobuf:"bytes,3,opt,name=auto_split_config,json=autoSplitConfig,proto3,oneof"`
}

ImportDocumentsRequest_BatchDocumentsImportConfig_DatasetSplit

type ImportDocumentsRequest_BatchDocumentsImportConfig_DatasetSplit struct {
	// Target dataset split where the documents must be stored.
	DatasetSplit DatasetSplitType `protobuf:"varint,2,opt,name=dataset_split,json=datasetSplit,proto3,enum=google.cloud.documentai.v1beta3.DatasetSplitType,oneof"`
}

ImportDocumentsResponse

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

Response of the import document operation.

func (*ImportDocumentsResponse) Descriptor

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

Deprecated: Use ImportDocumentsResponse.ProtoReflect.Descriptor instead.

func (*ImportDocumentsResponse) ProtoMessage

func (*ImportDocumentsResponse) ProtoMessage()

func (*ImportDocumentsResponse) ProtoReflect

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

func (*ImportDocumentsResponse) Reset

func (x *ImportDocumentsResponse) Reset()

func (*ImportDocumentsResponse) String

func (x *ImportDocumentsResponse) String() string

ImportProcessorVersionMetadata

type ImportProcessorVersionMetadata struct {

	// The basic metadata for 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 [ImportProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.ImportProcessorVersion] method.

func (*ImportProcessorVersionMetadata) Descriptor

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

Deprecated: Use ImportProcessorVersionMetadata.ProtoReflect.Descriptor instead.

func (*ImportProcessorVersionMetadata) GetCommonMetadata

func (x *ImportProcessorVersionMetadata) GetCommonMetadata() *CommonOperationMetadata

func (*ImportProcessorVersionMetadata) ProtoMessage

func (*ImportProcessorVersionMetadata) ProtoMessage()

func (*ImportProcessorVersionMetadata) ProtoReflect

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

func (*ImportProcessorVersionMetadata) Reset

func (x *ImportProcessorVersionMetadata) Reset()

func (*ImportProcessorVersionMetadata) String

func (x *ImportProcessorVersionMetadata) String() string

ImportProcessorVersionRequest

type ImportProcessorVersionRequest struct {

	// Types that are assignable to Source:
	//
	//	*ImportProcessorVersionRequest_ProcessorVersionSource
	//	*ImportProcessorVersionRequest_ExternalProcessorVersionSource_
	Source isImportProcessorVersionRequest_Source `protobuf_oneof:"source"`
	// Required. The destination processor name to create the processor version
	// in. Format:
	// `projects/{project}/locations/{location}/processors/{processor}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// contains filtered or unexported fields
}

The request message for the [ImportProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.ImportProcessorVersion] method.

The Document AI Service Agent of the destination project must have Document AI Editor role on the source project.

The destination project is specified as part of the [parent][google.cloud.documentai.v1beta3.ImportProcessorVersionRequest.parent] field. The source project is specified as part of the [source][google.cloud.documentai.v1beta3.ImportProcessorVersionRequest.processor_version_source] or [external_processor_version_source][google.cloud.documentai.v1beta3.ImportProcessorVersionRequest.external_processor_version_source] field.

func (*ImportProcessorVersionRequest) Descriptor

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

Deprecated: Use ImportProcessorVersionRequest.ProtoReflect.Descriptor instead.

func (*ImportProcessorVersionRequest) GetExternalProcessorVersionSource

func (x *ImportProcessorVersionRequest) GetExternalProcessorVersionSource() *ImportProcessorVersionRequest_ExternalProcessorVersionSource

func (*ImportProcessorVersionRequest) GetParent

func (x *ImportProcessorVersionRequest) GetParent() string

func (*ImportProcessorVersionRequest) GetProcessorVersionSource

func (x *ImportProcessorVersionRequest) GetProcessorVersionSource() string

func (*ImportProcessorVersionRequest) GetSource

func (m *ImportProcessorVersionRequest) GetSource() isImportProcessorVersionRequest_Source

func (*ImportProcessorVersionRequest) ProtoMessage

func (*ImportProcessorVersionRequest) ProtoMessage()

func (*ImportProcessorVersionRequest) ProtoReflect

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

func (*ImportProcessorVersionRequest) Reset

func (x *ImportProcessorVersionRequest) Reset()

func (*ImportProcessorVersionRequest) String

func (x *ImportProcessorVersionRequest) String() string

ImportProcessorVersionRequest_ExternalProcessorVersionSource

type ImportProcessorVersionRequest_ExternalProcessorVersionSource struct {

	// Required. The processor version name. Format:
	// `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
	ProcessorVersion string `protobuf:"bytes,1,opt,name=processor_version,json=processorVersion,proto3" json:"processor_version,omitempty"`
	// Optional. The Document AI service endpoint. For example,
	// 'https://us-documentai.googleapis.com'
	ServiceEndpoint string `protobuf:"bytes,2,opt,name=service_endpoint,json=serviceEndpoint,proto3" json:"service_endpoint,omitempty"`
	// contains filtered or unexported fields
}

The external source processor version.

func (*ImportProcessorVersionRequest_ExternalProcessorVersionSource) Descriptor

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

Deprecated: Use ImportProcessorVersionRequest_ExternalProcessorVersionSource.ProtoReflect.Descriptor instead.

func (*ImportProcessorVersionRequest_ExternalProcessorVersionSource) GetProcessorVersion

func (x *ImportProcessorVersionRequest_ExternalProcessorVersionSource) GetProcessorVersion() string

func (*ImportProcessorVersionRequest_ExternalProcessorVersionSource) GetServiceEndpoint

func (x *ImportProcessorVersionRequest_ExternalProcessorVersionSource) GetServiceEndpoint() string

func (*ImportProcessorVersionRequest_ExternalProcessorVersionSource) ProtoMessage

func (*ImportProcessorVersionRequest_ExternalProcessorVersionSource) ProtoMessage()

func (*ImportProcessorVersionRequest_ExternalProcessorVersionSource) ProtoReflect

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

func (*ImportProcessorVersionRequest_ExternalProcessorVersionSource) Reset

func (x *ImportProcessorVersionRequest_ExternalProcessorVersionSource) Reset()

func (*ImportProcessorVersionRequest_ExternalProcessorVersionSource) String

func (x *ImportProcessorVersionRequest_ExternalProcessorVersionSource) String() string

ImportProcessorVersionRequest_ExternalProcessorVersionSource_

type ImportProcessorVersionRequest_ExternalProcessorVersionSource_ struct {
	// The source processor version to import from. It can be from a different
	// environment and region than the destination processor.
	ExternalProcessorVersionSource *ImportProcessorVersionRequest_ExternalProcessorVersionSource `protobuf:"bytes,3,opt,name=external_processor_version_source,json=externalProcessorVersionSource,proto3,oneof"`
}

ImportProcessorVersionRequest_ProcessorVersionSource

type ImportProcessorVersionRequest_ProcessorVersionSource struct {
	// The source processor version to import from. The source processor version
	// and destination processor need to be in the same environment and region.
	ProcessorVersionSource string `protobuf:"bytes,2,opt,name=processor_version_source,json=processorVersionSource,proto3,oneof"`
}

ImportProcessorVersionResponse

type ImportProcessorVersionResponse struct {

	// The destination processor version name.
	ProcessorVersion string `protobuf:"bytes,1,opt,name=processor_version,json=processorVersion,proto3" json:"processor_version,omitempty"`
	// contains filtered or unexported fields
}

The response message for the [ImportProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.ImportProcessorVersion] method.

func (*ImportProcessorVersionResponse) Descriptor

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

Deprecated: Use ImportProcessorVersionResponse.ProtoReflect.Descriptor instead.

func (*ImportProcessorVersionResponse) GetProcessorVersion

func (x *ImportProcessorVersionResponse) GetProcessorVersion() string

func (*ImportProcessorVersionResponse) ProtoMessage

func (*ImportProcessorVersionResponse) ProtoMessage()

func (*ImportProcessorVersionResponse) ProtoReflect

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

func (*ImportProcessorVersionResponse) Reset

func (x *ImportProcessorVersionResponse) Reset()

func (*ImportProcessorVersionResponse) String

func (x *ImportProcessorVersionResponse) String() string

ListDocumentsRequest

type ListDocumentsRequest struct {

	// Required. The resource name of the dataset to be listed.
	// Format:
	// projects/{project}/locations/{location}/processors/{processor}/dataset
	Dataset string `protobuf:"bytes,1,opt,name=dataset,proto3" json:"dataset,omitempty"`
	// The maximum number of documents to return. The service may return
	// fewer than this value.
	// If unspecified, at most 20 documents will be returned.
	// The maximum value is 100; values above 100 will be coerced to 100.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous `ListDocuments` call.
	// Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to `ListDocuments`
	// must match the call that provided the page token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. Query to filter the documents based on
	// https://google.aip.dev/160.
	// ## Currently support query strings are:
	//
	// `SplitType=DATASET_SPLIT_TEST|DATASET_SPLIT_TRAIN|DATASET_SPLIT_UNASSIGNED`
	// - `LabelingState=DOCUMENT_LABELED|DOCUMENT_UNLABELED|DOCUMENT_AUTO_LABELED`
	// - `DisplayName=\"file_name.pdf\"`
	// - `EntityType=abc/def`
	// - `TagName=\"auto-labeling-running\"|\"sampled\"`
	//
	// Note:
	//   - Only `AND`, `=` and `!=` are supported.
	//     e.g. `DisplayName=file_name AND EntityType!=abc` IS supported.
	//   - Wildcard `*` is supported only in `DisplayName` filter
	//   - No duplicate filter keys are allowed,
	//     e.g. `EntityType=a AND EntityType=b` is NOT supported.
	//   - String match is case sensitive (for filter `DisplayName` & `EntityType`).
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional. Controls if the request requires a total size of matched
	// documents. See
	// [ListDocumentsResponse.total_size][google.cloud.documentai.v1beta3.ListDocumentsResponse.total_size].
	//
	// Enabling this flag may adversely impact performance.
	//
	// Defaults to false.
	ReturnTotalSize bool `protobuf:"varint,6,opt,name=return_total_size,json=returnTotalSize,proto3" json:"return_total_size,omitempty"`
	// Optional. Number of results to skip beginning from the `page_token` if
	// provided. https://google.aip.dev/158#skipping-results. It must be a
	// non-negative integer. Negative values will be rejected. Note that this is
	// not the number of pages to skip. If this value causes the cursor to move
	// past the end of results,
	// [ListDocumentsResponse.document_metadata][google.cloud.documentai.v1beta3.ListDocumentsResponse.document_metadata]
	// and
	// [ListDocumentsResponse.next_page_token][google.cloud.documentai.v1beta3.ListDocumentsResponse.next_page_token]
	// will be empty.
	Skip int32 `protobuf:"varint,8,opt,name=skip,proto3" json:"skip,omitempty"`
	// contains filtered or unexported fields
}

func (*ListDocumentsRequest) Descriptor

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

Deprecated: Use ListDocumentsRequest.ProtoReflect.Descriptor instead.

func (*ListDocumentsRequest) GetDataset

func (x *ListDocumentsRequest) GetDataset() string

func (*ListDocumentsRequest) GetFilter

func (x *ListDocumentsRequest) GetFilter() string

func (*ListDocumentsRequest) GetPageSize

func (x *ListDocumentsRequest) GetPageSize() int32

func (*ListDocumentsRequest) GetPageToken

func (x *ListDocumentsRequest) GetPageToken() string

func (*ListDocumentsRequest) GetReturnTotalSize

func (x *ListDocumentsRequest) GetReturnTotalSize() bool

func (*ListDocumentsRequest) GetSkip

func (x *ListDocumentsRequest) GetSkip() int32

func (*ListDocumentsRequest) ProtoMessage

func (*ListDocumentsRequest) ProtoMessage()

func (*ListDocumentsRequest) ProtoReflect

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

func (*ListDocumentsRequest) Reset

func (x *ListDocumentsRequest) Reset()

func (*ListDocumentsRequest) String

func (x *ListDocumentsRequest) String() string

ListDocumentsResponse

type ListDocumentsResponse struct {

	// Document metadata corresponding to the listed documents.
	DocumentMetadata []*DocumentMetadata `protobuf:"bytes,1,rep,name=document_metadata,json=documentMetadata,proto3" json:"document_metadata,omitempty"`
	// A token, which can be sent as
	// [ListDocumentsRequest.page_token][google.cloud.documentai.v1beta3.ListDocumentsRequest.page_token]
	// to retrieve the next page. If this field is omitted, there are no
	// subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// Total count of documents queried.
	TotalSize int32 `protobuf:"varint,3,opt,name=total_size,json=totalSize,proto3" json:"total_size,omitempty"`
	// contains filtered or unexported fields
}

func (*ListDocumentsResponse) Descriptor

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

Deprecated: Use ListDocumentsResponse.ProtoReflect.Descriptor instead.

func (*ListDocumentsResponse) GetDocumentMetadata

func (x *ListDocumentsResponse) GetDocumentMetadata() []*DocumentMetadata

func (*ListDocumentsResponse) GetNextPageToken

func (x *ListDocumentsResponse) GetNextPageToken() string

func (*ListDocumentsResponse) GetTotalSize

func (x *ListDocumentsResponse) GetTotalSize() int32

func (*ListDocumentsResponse) ProtoMessage

func (*ListDocumentsResponse) ProtoMessage()

func (*ListDocumentsResponse) ProtoReflect

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

func (*ListDocumentsResponse) Reset

func (x *ListDocumentsResponse) Reset()

func (*ListDocumentsResponse) String

func (x *ListDocumentsResponse) String() string

ListEvaluationsRequest

type ListEvaluationsRequest struct {

	// Required. The resource name of the
	// [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion] to
	// list evaluations for.
	// `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The standard list page size.
	// If unspecified, at most `5` evaluations are returned.
	// The maximum value is `100`. Values above `100` are coerced to `100`.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous `ListEvaluations` call.
	// Provide this to retrieve the subsequent page.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Retrieves a list of evaluations for a given [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion].

func (*ListEvaluationsRequest) Descriptor

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

Deprecated: Use ListEvaluationsRequest.ProtoReflect.Descriptor instead.

func (*ListEvaluationsRequest) GetPageSize

func (x *ListEvaluationsRequest) GetPageSize() int32

func (*ListEvaluationsRequest) GetPageToken

func (x *ListEvaluationsRequest) GetPageToken() string

func (*ListEvaluationsRequest) GetParent

func (x *ListEvaluationsRequest) GetParent() string

func (*ListEvaluationsRequest) ProtoMessage

func (*ListEvaluationsRequest) ProtoMessage()

func (*ListEvaluationsRequest) ProtoReflect

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

func (*ListEvaluationsRequest) Reset

func (x *ListEvaluationsRequest) Reset()

func (*ListEvaluationsRequest) String

func (x *ListEvaluationsRequest) String() string

ListEvaluationsResponse

type ListEvaluationsResponse struct {

	// The evaluations requested.
	Evaluations []*Evaluation `protobuf:"bytes,1,rep,name=evaluations,proto3" json:"evaluations,omitempty"`
	// A token, which can be sent as `page_token` to retrieve the next page.
	// If this field is omitted, there are no subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The response from ListEvaluations.

func (*ListEvaluationsResponse) Descriptor

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

Deprecated: Use ListEvaluationsResponse.ProtoReflect.Descriptor instead.

func (*ListEvaluationsResponse) GetEvaluations

func (x *ListEvaluationsResponse) GetEvaluations() []*Evaluation

func (*ListEvaluationsResponse) GetNextPageToken

func (x *ListEvaluationsResponse) GetNextPageToken() string

func (*ListEvaluationsResponse) ProtoMessage

func (*ListEvaluationsResponse) ProtoMessage()

func (*ListEvaluationsResponse) ProtoReflect

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

func (*ListEvaluationsResponse) Reset

func (x *ListEvaluationsResponse) Reset()

func (*ListEvaluationsResponse) String

func (x *ListEvaluationsResponse) String() string

ListProcessorTypesRequest

type ListProcessorTypesRequest struct {

	// Required. The location of processor types to list.
	// Format: `projects/{project}/locations/{location}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of processor types to return.
	// If unspecified, at most `100` processor types will be returned.
	// The maximum value is `500`. Values above `500` will be coerced to `500`.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Used to retrieve the next page of results, empty if at the end of the list.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for the [ListProcessorTypes][google.cloud.documentai.v1beta3.DocumentProcessorService.ListProcessorTypes] method. Some processor types may require the project be added to an allowlist.

func (*ListProcessorTypesRequest) Descriptor

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

Deprecated: Use ListProcessorTypesRequest.ProtoReflect.Descriptor instead.

func (*ListProcessorTypesRequest) GetPageSize

func (x *ListProcessorTypesRequest) GetPageSize() int32

func (*ListProcessorTypesRequest) GetPageToken

func (x *ListProcessorTypesRequest) GetPageToken() string

func (*ListProcessorTypesRequest) GetParent

func (x *ListProcessorTypesRequest) GetParent() string

func (*ListProcessorTypesRequest) ProtoMessage

func (*ListProcessorTypesRequest) ProtoMessage()

func (*ListProcessorTypesRequest) ProtoReflect

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

func (*ListProcessorTypesRequest) Reset

func (x *ListProcessorTypesRequest) Reset()

func (*ListProcessorTypesRequest) String

func (x *ListProcessorTypesRequest) String() string

ListProcessorTypesResponse

type ListProcessorTypesResponse struct {

	// The processor types.
	ProcessorTypes []*ProcessorType `protobuf:"bytes,1,rep,name=processor_types,json=processorTypes,proto3" json:"processor_types,omitempty"`
	// Points to the next page, otherwise empty.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ListProcessorTypesResponse) Descriptor

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

Deprecated: Use ListProcessorTypesResponse.ProtoReflect.Descriptor instead.

func (*ListProcessorTypesResponse) GetNextPageToken

func (x *ListProcessorTypesResponse) GetNextPageToken() string

func (*ListProcessorTypesResponse) GetProcessorTypes

func (x *ListProcessorTypesResponse) GetProcessorTypes() []*ProcessorType

func (*ListProcessorTypesResponse) ProtoMessage

func (*ListProcessorTypesResponse) ProtoMessage()

func (*ListProcessorTypesResponse) ProtoReflect

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

func (*ListProcessorTypesResponse) Reset

func (x *ListProcessorTypesResponse) Reset()

func (*ListProcessorTypesResponse) String

func (x *ListProcessorTypesResponse) String() string

ListProcessorVersionsRequest

type ListProcessorVersionsRequest struct {

	// Required. The parent (project, location and processor) to list all
	// versions. Format:
	// `projects/{project}/locations/{location}/processors/{processor}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of processor versions to return.
	// If unspecified, at most `10` processor versions will be returned.
	// The maximum value is `20`. Values above `20` will be coerced to `20`.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// We will return the processor versions sorted by creation time. The page
	// token will point to the next processor version.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for list all processor versions belongs to a processor.

func (*ListProcessorVersionsRequest) Descriptor

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

Deprecated: Use ListProcessorVersionsRequest.ProtoReflect.Descriptor instead.

func (*ListProcessorVersionsRequest) GetPageSize

func (x *ListProcessorVersionsRequest) GetPageSize() int32

func (*ListProcessorVersionsRequest) GetPageToken

func (x *ListProcessorVersionsRequest) GetPageToken() string

func (*ListProcessorVersionsRequest) GetParent

func (x *ListProcessorVersionsRequest) GetParent() string

func (*ListProcessorVersionsRequest) ProtoMessage

func (*ListProcessorVersionsRequest) ProtoMessage()

func (*ListProcessorVersionsRequest) ProtoReflect

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

func (*ListProcessorVersionsRequest) Reset

func (x *ListProcessorVersionsRequest) Reset()

func (*ListProcessorVersionsRequest) String

func (x *ListProcessorVersionsRequest) String() string

ListProcessorVersionsResponse

type ListProcessorVersionsResponse struct {

	// The list of processors.
	ProcessorVersions []*ProcessorVersion `protobuf:"bytes,1,rep,name=processor_versions,json=processorVersions,proto3" json:"processor_versions,omitempty"`
	// Points to the next processor, otherwise empty.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ListProcessorVersionsResponse) Descriptor

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

Deprecated: Use ListProcessorVersionsResponse.ProtoReflect.Descriptor instead.

func (*ListProcessorVersionsResponse) GetNextPageToken

func (x *ListProcessorVersionsResponse) GetNextPageToken() string

func (*ListProcessorVersionsResponse) GetProcessorVersions

func (x *ListProcessorVersionsResponse) GetProcessorVersions() []*ProcessorVersion

func (*ListProcessorVersionsResponse) ProtoMessage

func (*ListProcessorVersionsResponse) ProtoMessage()

func (*ListProcessorVersionsResponse) ProtoReflect

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

func (*ListProcessorVersionsResponse) Reset

func (x *ListProcessorVersionsResponse) Reset()

func (*ListProcessorVersionsResponse) String

func (x *ListProcessorVersionsResponse) String() string

ListProcessorsRequest

type ListProcessorsRequest struct {

	// Required. The parent (project and location) which owns this collection of
	// Processors. Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of processors to return.
	// If unspecified, at most `50` processors will be returned.
	// The maximum value is `100`. Values above `100` will be coerced to `100`.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// We will return the processors sorted by creation time. The page token
	// will point to the next processor.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for list all processors belongs to a project.

func (*ListProcessorsRequest) Descriptor

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

Deprecated: Use ListProcessorsRequest.ProtoReflect.Descriptor instead.

func (*ListProcessorsRequest) GetPageSize

func (x *ListProcessorsRequest) GetPageSize() int32

func (*ListProcessorsRequest) GetPageToken

func (x *ListProcessorsRequest) GetPageToken() string

func (*ListProcessorsRequest) GetParent

func (x *ListProcessorsRequest) GetParent() string

func (*ListProcessorsRequest) ProtoMessage

func (*ListProcessorsRequest) ProtoMessage()

func (*ListProcessorsRequest) ProtoReflect

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

func (*ListProcessorsRequest) Reset

func (x *ListProcessorsRequest) Reset()

func (*ListProcessorsRequest) String

func (x *ListProcessorsRequest) String() string

ListProcessorsResponse

type ListProcessorsResponse struct {

	// The list of processors.
	Processors []*Processor `protobuf:"bytes,1,rep,name=processors,proto3" json:"processors,omitempty"`
	// Points to the next processor, otherwise empty.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ListProcessorsResponse) Descriptor

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

Deprecated: Use ListProcessorsResponse.ProtoReflect.Descriptor instead.

func (*ListProcessorsResponse) GetNextPageToken

func (x *ListProcessorsResponse) GetNextPageToken() string

func (*ListProcessorsResponse) GetProcessors

func (x *ListProcessorsResponse) GetProcessors() []*Processor

func (*ListProcessorsResponse) ProtoMessage

func (*ListProcessorsResponse) ProtoMessage()

func (*ListProcessorsResponse) ProtoReflect

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

func (*ListProcessorsResponse) Reset

func (x *ListProcessorsResponse) Reset()

func (*ListProcessorsResponse) String

func (x *ListProcessorsResponse) String() string

NormalizedVertex

type NormalizedVertex struct {

	// X coordinate.
	X float32 `protobuf:"fixed32,1,opt,name=x,proto3" json:"x,omitempty"`
	// Y coordinate (starts from the top of the image).
	Y float32 `protobuf:"fixed32,2,opt,name=y,proto3" json:"y,omitempty"`
	// contains filtered or unexported fields
}

A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.

func (*NormalizedVertex) Descriptor

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

Deprecated: Use NormalizedVertex.ProtoReflect.Descriptor instead.

func (*NormalizedVertex) GetX

func (x *NormalizedVertex) GetX() float32

func (*NormalizedVertex) GetY

func (x *NormalizedVertex) GetY() float32

func (*NormalizedVertex) ProtoMessage

func (*NormalizedVertex) ProtoMessage()

func (*NormalizedVertex) ProtoReflect

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

func (*NormalizedVertex) Reset

func (x *NormalizedVertex) Reset()

func (*NormalizedVertex) String

func (x *NormalizedVertex) String() string

OcrConfig

type OcrConfig struct {

	// Hints for the OCR model.
	Hints *OcrConfig_Hints `protobuf:"bytes,2,opt,name=hints,proto3" json:"hints,omitempty"`
	// Enables special handling for PDFs with existing text information. Results
	// in better text extraction quality in such PDF inputs.
	EnableNativePdfParsing bool `protobuf:"varint,3,opt,name=enable_native_pdf_parsing,json=enableNativePdfParsing,proto3" json:"enable_native_pdf_parsing,omitempty"`
	// Enables intelligent document quality scores after OCR. Can help with
	// diagnosing why OCR responses are of poor quality for a given input.
	// Adds additional latency comparable to regular OCR to the process call.
	EnableImageQualityScores bool `protobuf:"varint,4,opt,name=enable_image_quality_scores,json=enableImageQualityScores,proto3" json:"enable_image_quality_scores,omitempty"`
	// A list of advanced OCR options to further fine-tune OCR behavior. Current
	// valid values are:
	//
	// - `legacy_layout`: a heuristics layout detection algorithm, which serves as
	// an alternative to the current ML-based layout detection algorithm.
	// Customers can choose the best suitable layout algorithm based on their
	// situation.
	AdvancedOcrOptions []string `protobuf:"bytes,5,rep,name=advanced_ocr_options,json=advancedOcrOptions,proto3" json:"advanced_ocr_options,omitempty"`
	// Includes symbol level OCR information if set to true.
	EnableSymbol bool `protobuf:"varint,6,opt,name=enable_symbol,json=enableSymbol,proto3" json:"enable_symbol,omitempty"`
	// Turn on font identification model and return font style information.
	// Deprecated, use
	// [PremiumFeatures.compute_style_info][google.cloud.documentai.v1beta3.OcrConfig.PremiumFeatures.compute_style_info]
	// instead.
	//
	// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document_io.proto.
	ComputeStyleInfo bool `protobuf:"varint,8,opt,name=compute_style_info,json=computeStyleInfo,proto3" json:"compute_style_info,omitempty"`
	// Turn off character box detector in OCR engine. Character box detection is
	// enabled by default in OCR 2.0 (and later) processors.
	DisableCharacterBoxesDetection bool `protobuf:"varint,10,opt,name=disable_character_boxes_detection,json=disableCharacterBoxesDetection,proto3" json:"disable_character_boxes_detection,omitempty"`
	// Configurations for premium OCR features.
	PremiumFeatures *OcrConfig_PremiumFeatures `protobuf:"bytes,11,opt,name=premium_features,json=premiumFeatures,proto3" json:"premium_features,omitempty"`
	// contains filtered or unexported fields
}

Config for Document OCR.

func (*OcrConfig) Descriptor

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

Deprecated: Use OcrConfig.ProtoReflect.Descriptor instead.

func (*OcrConfig) GetAdvancedOcrOptions

func (x *OcrConfig) GetAdvancedOcrOptions() []string

func (*OcrConfig) GetComputeStyleInfo

func (x *OcrConfig) GetComputeStyleInfo() bool

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

func (*OcrConfig) GetDisableCharacterBoxesDetection

func (x *OcrConfig) GetDisableCharacterBoxesDetection() bool

func (*OcrConfig) GetEnableImageQualityScores

func (x *OcrConfig) GetEnableImageQualityScores() bool

func (*OcrConfig) GetEnableNativePdfParsing

func (x *OcrConfig) GetEnableNativePdfParsing() bool

func (*OcrConfig) GetEnableSymbol

func (x *OcrConfig) GetEnableSymbol() bool

func (*OcrConfig) GetHints

func (x *OcrConfig) GetHints() *OcrConfig_Hints

func (*OcrConfig) GetPremiumFeatures

func (x *OcrConfig) GetPremiumFeatures() *OcrConfig_PremiumFeatures

func (*OcrConfig) ProtoMessage

func (*OcrConfig) ProtoMessage()

func (*OcrConfig) ProtoReflect

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

func (*OcrConfig) Reset

func (x *OcrConfig) Reset()

func (*OcrConfig) String

func (x *OcrConfig) String() string

OcrConfig_Hints

type OcrConfig_Hints struct {

	// List of BCP-47 language codes to use for OCR. In most cases, not
	// specifying it yields the best results since it enables automatic language
	// detection. For languages based on the Latin alphabet, setting hints is
	// not needed. In rare cases, when the language of the text in the
	// image is known, setting a hint will help get better results (although it
	// will be a significant hindrance if the hint is wrong).
	LanguageHints []string `protobuf:"bytes,1,rep,name=language_hints,json=languageHints,proto3" json:"language_hints,omitempty"`
	// contains filtered or unexported fields
}

Hints for OCR Engine

func (*OcrConfig_Hints) Descriptor

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

Deprecated: Use OcrConfig_Hints.ProtoReflect.Descriptor instead.

func (*OcrConfig_Hints) GetLanguageHints

func (x *OcrConfig_Hints) GetLanguageHints() []string

func (*OcrConfig_Hints) ProtoMessage

func (*OcrConfig_Hints) ProtoMessage()

func (*OcrConfig_Hints) ProtoReflect

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

func (*OcrConfig_Hints) Reset

func (x *OcrConfig_Hints) Reset()

func (*OcrConfig_Hints) String

func (x *OcrConfig_Hints) String() string

OcrConfig_PremiumFeatures

type OcrConfig_PremiumFeatures struct {

	// Turn on selection mark detector in OCR engine. Only available in OCR 2.0
	// (and later) processors.
	EnableSelectionMarkDetection bool `protobuf:"varint,3,opt,name=enable_selection_mark_detection,json=enableSelectionMarkDetection,proto3" json:"enable_selection_mark_detection,omitempty"`
	// Turn on font identification model and return font style information.
	ComputeStyleInfo bool `protobuf:"varint,4,opt,name=compute_style_info,json=computeStyleInfo,proto3" json:"compute_style_info,omitempty"`
	// Turn on the model that can extract LaTeX math formulas.
	EnableMathOcr bool `protobuf:"varint,5,opt,name=enable_math_ocr,json=enableMathOcr,proto3" json:"enable_math_ocr,omitempty"`
	// contains filtered or unexported fields
}

Configurations for premium OCR features.

func (*OcrConfig_PremiumFeatures) Descriptor

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

Deprecated: Use OcrConfig_PremiumFeatures.ProtoReflect.Descriptor instead.

func (*OcrConfig_PremiumFeatures) GetComputeStyleInfo

func (x *OcrConfig_PremiumFeatures) GetComputeStyleInfo() bool

func (*OcrConfig_PremiumFeatures) GetEnableMathOcr

func (x *OcrConfig_PremiumFeatures) GetEnableMathOcr() bool

func (*OcrConfig_PremiumFeatures) GetEnableSelectionMarkDetection

func (x *OcrConfig_PremiumFeatures) GetEnableSelectionMarkDetection() bool

func (*OcrConfig_PremiumFeatures) ProtoMessage

func (*OcrConfig_PremiumFeatures) ProtoMessage()

func (*OcrConfig_PremiumFeatures) ProtoReflect

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

func (*OcrConfig_PremiumFeatures) Reset

func (x *OcrConfig_PremiumFeatures) Reset()

func (*OcrConfig_PremiumFeatures) String

func (x *OcrConfig_PremiumFeatures) String() string

ProcessOptions

type ProcessOptions struct {

	// A subset of pages to process. If not specified, all pages are processed.
	// If a page range is set, only the given pages are extracted and processed
	// from the document. In the output document,
	// [Document.Page.page_number][google.cloud.documentai.v1beta3.Document.Page.page_number]
	// refers to the page number in the original document.
	// This configuration only applies to online processing with
	// [ProcessDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ProcessDocument].
	//
	// Types that are assignable to PageRange:
	//
	//	*ProcessOptions_IndividualPageSelector_
	//	*ProcessOptions_FromStart
	//	*ProcessOptions_FromEnd
	PageRange isProcessOptions_PageRange `protobuf_oneof:"page_range"`
	// Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`.
	// Returns error if set on other processor types.
	OcrConfig *OcrConfig `protobuf:"bytes,1,opt,name=ocr_config,json=ocrConfig,proto3" json:"ocr_config,omitempty"`
	// Optional. Only applicable to `LAYOUT_PARSER_PROCESSOR`.
	// Returns error if set on other processor types.
	LayoutConfig *ProcessOptions_LayoutConfig `protobuf:"bytes,9,opt,name=layout_config,json=layoutConfig,proto3" json:"layout_config,omitempty"`
	// Optional. Override the schema of the
	// [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion]. Will
	// return an Invalid Argument error if this field is set when the underlying
	// [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion]
	// doesn't support schema override.
	SchemaOverride *DocumentSchema `protobuf:"bytes,8,opt,name=schema_override,json=schemaOverride,proto3" json:"schema_override,omitempty"`
	// contains filtered or unexported fields
}

Options for Process API

func (*ProcessOptions) Descriptor

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

Deprecated: Use ProcessOptions.ProtoReflect.Descriptor instead.

func (*ProcessOptions) GetFromEnd

func (x *ProcessOptions) GetFromEnd() int32

func (*ProcessOptions) GetFromStart

func (x *ProcessOptions) GetFromStart() int32

func (*ProcessOptions) GetIndividualPageSelector

func (x *ProcessOptions) GetIndividualPageSelector() *ProcessOptions_IndividualPageSelector

func (*ProcessOptions) GetLayoutConfig

func (x *ProcessOptions) GetLayoutConfig() *ProcessOptions_LayoutConfig

func (*ProcessOptions) GetOcrConfig

func (x *ProcessOptions) GetOcrConfig() *OcrConfig

func (*ProcessOptions) GetPageRange

func (m *ProcessOptions) GetPageRange() isProcessOptions_PageRange

func (*ProcessOptions) GetSchemaOverride

func (x *ProcessOptions) GetSchemaOverride() *DocumentSchema

func (*ProcessOptions) ProtoMessage

func (*ProcessOptions) ProtoMessage()

func (*ProcessOptions) ProtoReflect

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

func (*ProcessOptions) Reset

func (x *ProcessOptions) Reset()

func (*ProcessOptions) String

func (x *ProcessOptions) String() string

ProcessOptions_FromEnd

type ProcessOptions_FromEnd struct {
	// Only process certain pages from the end, same as above.
	FromEnd int32 `protobuf:"varint,7,opt,name=from_end,json=fromEnd,proto3,oneof"`
}

ProcessOptions_FromStart

type ProcessOptions_FromStart struct {
	// Only process certain pages from the start. Process all if the document
	// has fewer pages.
	FromStart int32 `protobuf:"varint,6,opt,name=from_start,json=fromStart,proto3,oneof"`
}

ProcessOptions_IndividualPageSelector

type ProcessOptions_IndividualPageSelector struct {

	// Optional. Indices of the pages (starting from 1).
	Pages []int32 `protobuf:"varint,1,rep,packed,name=pages,proto3" json:"pages,omitempty"`
	// contains filtered or unexported fields
}

A list of individual page numbers.

func (*ProcessOptions_IndividualPageSelector) Descriptor

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

Deprecated: Use ProcessOptions_IndividualPageSelector.ProtoReflect.Descriptor instead.

func (*ProcessOptions_IndividualPageSelector) GetPages

func (x *ProcessOptions_IndividualPageSelector) GetPages() []int32

func (*ProcessOptions_IndividualPageSelector) ProtoMessage

func (*ProcessOptions_IndividualPageSelector) ProtoMessage()

func (*ProcessOptions_IndividualPageSelector) ProtoReflect

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

func (*ProcessOptions_IndividualPageSelector) Reset

func (x *ProcessOptions_IndividualPageSelector) Reset()

func (*ProcessOptions_IndividualPageSelector) String

func (x *ProcessOptions_IndividualPageSelector) String() string

ProcessOptions_IndividualPageSelector_

type ProcessOptions_IndividualPageSelector_ struct {
	// Which pages to process (1-indexed).
	IndividualPageSelector *ProcessOptions_IndividualPageSelector `protobuf:"bytes,5,opt,name=individual_page_selector,json=individualPageSelector,proto3,oneof"`
}

ProcessOptions_LayoutConfig

type ProcessOptions_LayoutConfig struct {

	// Optional. Config for chunking in layout parser processor.
	ChunkingConfig *ProcessOptions_LayoutConfig_ChunkingConfig `protobuf:"bytes,1,opt,name=chunking_config,json=chunkingConfig,proto3" json:"chunking_config,omitempty"`
	// Optional. Whether to include images in layout parser processor response.
	ReturnImages bool `protobuf:"varint,2,opt,name=return_images,json=returnImages,proto3" json:"return_images,omitempty"`
	// Optional. Whether to include bounding boxes in layout parser processor
	// response.
	ReturnBoundingBoxes bool `protobuf:"varint,3,opt,name=return_bounding_boxes,json=returnBoundingBoxes,proto3" json:"return_bounding_boxes,omitempty"`
	// Optional. Whether to include image annotations in layout parser response.
	EnableImageAnnotation bool `protobuf:"varint,4,opt,name=enable_image_annotation,json=enableImageAnnotation,proto3" json:"enable_image_annotation,omitempty"`
	// Optional. Whether to extract images in layout parser response.
	EnableImageExtraction bool `protobuf:"varint,7,opt,name=enable_image_extraction,json=enableImageExtraction,proto3" json:"enable_image_extraction,omitempty"`
	// Optional. Whether to refine PDF layout using LLM.
	EnableLlmLayoutParsing bool `protobuf:"varint,5,opt,name=enable_llm_layout_parsing,json=enableLlmLayoutParsing,proto3" json:"enable_llm_layout_parsing,omitempty"`
	// Optional. Whether to include table annotations in layout parser response.
	EnableTableAnnotation bool `protobuf:"varint,6,opt,name=enable_table_annotation,json=enableTableAnnotation,proto3" json:"enable_table_annotation,omitempty"`
	// contains filtered or unexported fields
}

Serving config for layout parser processor.

func (*ProcessOptions_LayoutConfig) Descriptor

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

Deprecated: Use ProcessOptions_LayoutConfig.ProtoReflect.Descriptor instead.

func (*ProcessOptions_LayoutConfig) GetChunkingConfig

func (x *ProcessOptions_LayoutConfig) GetChunkingConfig() *ProcessOptions_LayoutConfig_ChunkingConfig

func (*ProcessOptions_LayoutConfig) GetEnableImageAnnotation

func (x *ProcessOptions_LayoutConfig) GetEnableImageAnnotation() bool

func (*ProcessOptions_LayoutConfig) GetEnableImageExtraction

func (x *ProcessOptions_LayoutConfig) GetEnableImageExtraction() bool

func (*ProcessOptions_LayoutConfig) GetEnableLlmLayoutParsing

func (x *ProcessOptions_LayoutConfig) GetEnableLlmLayoutParsing() bool

func (*ProcessOptions_LayoutConfig) GetEnableTableAnnotation

func (x *ProcessOptions_LayoutConfig) GetEnableTableAnnotation() bool

func (*ProcessOptions_LayoutConfig) GetReturnBoundingBoxes

func (x *ProcessOptions_LayoutConfig) GetReturnBoundingBoxes() bool

func (*ProcessOptions_LayoutConfig) GetReturnImages

func (x *ProcessOptions_LayoutConfig) GetReturnImages() bool

func (*ProcessOptions_LayoutConfig) ProtoMessage

func (*ProcessOptions_LayoutConfig) ProtoMessage()

func (*ProcessOptions_LayoutConfig) ProtoReflect

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

func (*ProcessOptions_LayoutConfig) Reset

func (x *ProcessOptions_LayoutConfig) Reset()

func (*ProcessOptions_LayoutConfig) String

func (x *ProcessOptions_LayoutConfig) String() string

ProcessOptions_LayoutConfig_ChunkingConfig

type ProcessOptions_LayoutConfig_ChunkingConfig struct {

	// Optional. The chunk sizes to use when splitting documents, in order of
	// level.
	ChunkSize int32 `protobuf:"varint,1,opt,name=chunk_size,json=chunkSize,proto3" json:"chunk_size,omitempty"`
	// Optional. Whether or not to include ancestor headings when splitting.
	IncludeAncestorHeadings bool `protobuf:"varint,2,opt,name=include_ancestor_headings,json=includeAncestorHeadings,proto3" json:"include_ancestor_headings,omitempty"`
	// Optional. The number of tokens to group together when evaluating
	// semantic similarity. THIS FIELD IS NOT YET USED.
	SemanticChunkingGroupSize bool `protobuf:"varint,3,opt,name=semantic_chunking_group_size,json=semanticChunkingGroupSize,proto3" json:"semantic_chunking_group_size,omitempty"`
	// Optional. The percentile of cosine dissimilarity that must be exceeded
	// between a group of tokens and the next. The smaller this number is, the
	// more chunks will be generated. THIS FIELD IS NOT YET USED.
	BreakpointPercentileThreshold int32 `protobuf:"varint,4,opt,name=breakpoint_percentile_threshold,json=breakpointPercentileThreshold,proto3" json:"breakpoint_percentile_threshold,omitempty"`
	// contains filtered or unexported fields
}

Serving config for chunking.

func (*ProcessOptions_LayoutConfig_ChunkingConfig) Descriptor

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

Deprecated: Use ProcessOptions_LayoutConfig_ChunkingConfig.ProtoReflect.Descriptor instead.

func (*ProcessOptions_LayoutConfig_ChunkingConfig) GetBreakpointPercentileThreshold

func (x *ProcessOptions_LayoutConfig_ChunkingConfig) GetBreakpointPercentileThreshold() int32

func (*ProcessOptions_LayoutConfig_ChunkingConfig) GetChunkSize

func (x *ProcessOptions_LayoutConfig_ChunkingConfig) GetChunkSize() int32

func (*ProcessOptions_LayoutConfig_ChunkingConfig) GetIncludeAncestorHeadings

func (x *ProcessOptions_LayoutConfig_ChunkingConfig) GetIncludeAncestorHeadings() bool

func (*ProcessOptions_LayoutConfig_ChunkingConfig) GetSemanticChunkingGroupSize

func (x *ProcessOptions_LayoutConfig_ChunkingConfig) GetSemanticChunkingGroupSize() bool

func (*ProcessOptions_LayoutConfig_ChunkingConfig) ProtoMessage

func (*ProcessOptions_LayoutConfig_ChunkingConfig) ProtoMessage()

func (*ProcessOptions_LayoutConfig_ChunkingConfig) ProtoReflect

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

func (*ProcessOptions_LayoutConfig_ChunkingConfig) Reset

func (x *ProcessOptions_LayoutConfig_ChunkingConfig) Reset()

func (*ProcessOptions_LayoutConfig_ChunkingConfig) String

func (x *ProcessOptions_LayoutConfig_ChunkingConfig) String() string

ProcessRequest

type ProcessRequest struct {

	// The document payload.
	//
	// Types that are assignable to Source:
	//
	//	*ProcessRequest_InlineDocument
	//	*ProcessRequest_RawDocument
	//	*ProcessRequest_GcsDocument
	Source isProcessRequest_Source `protobuf_oneof:"source"`
	// Required. The resource name of the
	// [Processor][google.cloud.documentai.v1beta3.Processor] or
	// [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion]
	// to use for processing. If a
	// [Processor][google.cloud.documentai.v1beta3.Processor] is specified, the
	// server will use its [default
	// version][google.cloud.documentai.v1beta3.Processor.default_processor_version].
	// Format: `projects/{project}/locations/{location}/processors/{processor}`,
	// or
	// `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The document payload, the
	// [content][google.cloud.documentai.v1beta3.Document.content] and
	// [mime_type][google.cloud.documentai.v1beta3.Document.mime_type] fields must
	// be set.
	//
	// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document_processor_service.proto.
	Document *Document `protobuf:"bytes,2,opt,name=document,proto3" json:"document,omitempty"`
	// Whether human review should be skipped for this request. Default to
	// `false`.
	SkipHumanReview bool `protobuf:"varint,3,opt,name=skip_human_review,json=skipHumanReview,proto3" json:"skip_human_review,omitempty"`
	// Specifies which fields to include in the
	// [ProcessResponse.document][google.cloud.documentai.v1beta3.ProcessResponse.document]
	// output. 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,6,opt,name=field_mask,json=fieldMask,proto3" json:"field_mask,omitempty"`
	// Inference-time options for the process API
	ProcessOptions *ProcessOptions `protobuf:"bytes,7,opt,name=process_options,json=processOptions,proto3" json:"process_options,omitempty"`
	// Optional. The labels with user-defined metadata for the request.
	//
	// Label keys and values can be no longer than 63 characters
	// (Unicode codepoints) and can only contain lowercase letters, numeric
	// characters, underscores, and dashes. International characters are allowed.
	// Label values are optional. Label keys must start with a letter.
	Labels map[string]string `protobuf:"bytes,10,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
	// Optional. Option to remove images from the document.
	ImagelessMode bool `protobuf:"varint,11,opt,name=imageless_mode,json=imagelessMode,proto3" json:"imageless_mode,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ProcessRequest) Descriptor

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

Deprecated: Use ProcessRequest.ProtoReflect.Descriptor instead.

func (*ProcessRequest) GetDocument

func (x *ProcessRequest) GetDocument() *Document

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

func (*ProcessRequest) GetFieldMask

func (x *ProcessRequest) GetFieldMask() *fieldmaskpb.FieldMask

func (*ProcessRequest) GetGcsDocument

func (x *ProcessRequest) GetGcsDocument() *GcsDocument

func (*ProcessRequest) GetImagelessMode

func (x *ProcessRequest) GetImagelessMode() bool

func (*ProcessRequest) GetInlineDocument

func (x *ProcessRequest) GetInlineDocument() *Document

func (*ProcessRequest) GetLabels

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

func (*ProcessRequest) GetName

func (x *ProcessRequest) GetName() string

func (*ProcessRequest) GetProcessOptions

func (x *ProcessRequest) GetProcessOptions() *ProcessOptions

func (*ProcessRequest) GetRawDocument

func (x *ProcessRequest) GetRawDocument() *RawDocument

func (*ProcessRequest) GetSkipHumanReview

func (x *ProcessRequest) GetSkipHumanReview() bool

func (*ProcessRequest) GetSource

func (m *ProcessRequest) GetSource() isProcessRequest_Source

func (*ProcessRequest) ProtoMessage

func (*ProcessRequest) ProtoMessage()

func (*ProcessRequest) ProtoReflect

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

func (*ProcessRequest) Reset

func (x *ProcessRequest) Reset()

func (*ProcessRequest) String

func (x *ProcessRequest) String() string

ProcessRequest_GcsDocument

type ProcessRequest_GcsDocument struct {
	// A raw document on Google Cloud Storage.
	GcsDocument *GcsDocument `protobuf:"bytes,8,opt,name=gcs_document,json=gcsDocument,proto3,oneof"`
}

ProcessRequest_InlineDocument

type ProcessRequest_InlineDocument struct {
	// An inline document proto.
	InlineDocument *Document `protobuf:"bytes,4,opt,name=inline_document,json=inlineDocument,proto3,oneof"`
}

ProcessRequest_RawDocument

type ProcessRequest_RawDocument struct {
	// A raw document content (bytes).
	RawDocument *RawDocument `protobuf:"bytes,5,opt,name=raw_document,json=rawDocument,proto3,oneof"`
}

ProcessResponse

type ProcessResponse struct {

	// The document payload, will populate fields based on the processor's
	// behavior.
	Document *Document `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
	// The name of the operation triggered by the processed document. If the human
	// review process isn't triggered, this field is empty. It has the same
	// response type and metadata as the long-running operation returned by
	// [ReviewDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ReviewDocument].
	//
	// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document_processor_service.proto.
	HumanReviewOperation string `protobuf:"bytes,2,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,3,opt,name=human_review_status,json=humanReviewStatus,proto3" json:"human_review_status,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ProcessResponse) Descriptor

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

Deprecated: Use ProcessResponse.ProtoReflect.Descriptor instead.

func (*ProcessResponse) GetDocument

func (x *ProcessResponse) GetDocument() *Document

func (*ProcessResponse) GetHumanReviewOperation

func (x *ProcessResponse) GetHumanReviewOperation() string

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

func (*ProcessResponse) GetHumanReviewStatus

func (x *ProcessResponse) GetHumanReviewStatus() *HumanReviewStatus

func (*ProcessResponse) ProtoMessage

func (*ProcessResponse) ProtoMessage()

func (*ProcessResponse) ProtoReflect

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

func (*ProcessResponse) Reset

func (x *ProcessResponse) Reset()

func (*ProcessResponse) String

func (x *ProcessResponse) String() string

Processor

type Processor struct {

	// Output only. Immutable. The resource name of the processor.
	// Format: `projects/{project}/locations/{location}/processors/{processor}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
	// To get a list of processor types, see
	// [FetchProcessorTypes][google.cloud.documentai.v1beta3.DocumentProcessorService.FetchProcessorTypes].
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// The display name of the processor.
	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Output only. The state of the processor.
	State Processor_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.cloud.documentai.v1beta3.Processor_State" json:"state,omitempty"`
	// The default processor version.
	DefaultProcessorVersion string `protobuf:"bytes,9,opt,name=default_processor_version,json=defaultProcessorVersion,proto3" json:"default_processor_version,omitempty"`
	// Output only. The processor version aliases.
	ProcessorVersionAliases []*ProcessorVersionAlias `protobuf:"bytes,10,rep,name=processor_version_aliases,json=processorVersionAliases,proto3" json:"processor_version_aliases,omitempty"`
	// Output only. Immutable. The http endpoint that can be called to invoke
	// processing.
	ProcessEndpoint string `protobuf:"bytes,6,opt,name=process_endpoint,json=processEndpoint,proto3" json:"process_endpoint,omitempty"`
	// Output only. The time the processor was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// The [KMS key](https://cloud.google.com/security-key-management) used for
	// encryption and decryption in CMEK scenarios.
	KmsKeyName string `protobuf:"bytes,8,opt,name=kms_key_name,json=kmsKeyName,proto3" json:"kms_key_name,omitempty"`
	// Output only. Reserved for future use.
	SatisfiesPzs bool `protobuf:"varint,12,opt,name=satisfies_pzs,json=satisfiesPzs,proto3" json:"satisfies_pzs,omitempty"`
	// Output only. Reserved for future use.
	SatisfiesPzi bool `protobuf:"varint,13,opt,name=satisfies_pzi,json=satisfiesPzi,proto3" json:"satisfies_pzi,omitempty"`
	// contains filtered or unexported fields
}

The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.

func (*Processor) Descriptor

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

Deprecated: Use Processor.ProtoReflect.Descriptor instead.

func (*Processor) GetCreateTime

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

func (*Processor) GetDefaultProcessorVersion

func (x *Processor) GetDefaultProcessorVersion() string

func (*Processor) GetDisplayName

func (x *Processor) GetDisplayName() string

func (*Processor) GetKmsKeyName

func (x *Processor) GetKmsKeyName() string

func (*Processor) GetName

func (x *Processor) GetName() string

func (*Processor) GetProcessEndpoint

func (x *Processor) GetProcessEndpoint() string

func (*Processor) GetProcessorVersionAliases

func (x *Processor) GetProcessorVersionAliases() []*ProcessorVersionAlias

func (*Processor) GetSatisfiesPzi

func (x *Processor) GetSatisfiesPzi() bool

func (*Processor) GetSatisfiesPzs

func (x *Processor) GetSatisfiesPzs() bool

func (*Processor) GetState

func (x *Processor) GetState() Processor_State

func (*Processor) GetType

func (x *Processor) GetType() string

func (*Processor) ProtoMessage

func (*Processor) ProtoMessage()

func (*Processor) ProtoReflect

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

func (*Processor) Reset

func (x *Processor) Reset()

func (*Processor) String

func (x *Processor) String() string

ProcessorType

type ProcessorType struct {

	// The resource name of the processor type.
	// Format: `projects/{project}/processorTypes/{processor_type}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// The processor category, used by UI to group processor types.
	Category string `protobuf:"bytes,3,opt,name=category,proto3" json:"category,omitempty"`
	// The locations in which this processor is available.
	AvailableLocations []*ProcessorType_LocationInfo `protobuf:"bytes,4,rep,name=available_locations,json=availableLocations,proto3" json:"available_locations,omitempty"`
	// Whether the processor type allows creation. If true, users can create a
	// processor of this processor type. Otherwise, users need to request access.
	AllowCreation bool `protobuf:"varint,6,opt,name=allow_creation,json=allowCreation,proto3" json:"allow_creation,omitempty"`
	// Launch stage of the processor type
	LaunchStage api.LaunchStage `protobuf:"varint,8,opt,name=launch_stage,json=launchStage,proto3,enum=google.api.LaunchStage" json:"launch_stage,omitempty"`
	// A set of Cloud Storage URIs of sample documents for this processor.
	SampleDocumentUris []string `protobuf:"bytes,9,rep,name=sample_document_uris,json=sampleDocumentUris,proto3" json:"sample_document_uris,omitempty"`
	// contains filtered or unexported fields
}

A processor type is responsible for performing a certain document understanding task on a certain type of document.

func (*ProcessorType) Descriptor

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

Deprecated: Use ProcessorType.ProtoReflect.Descriptor instead.

func (*ProcessorType) GetAllowCreation

func (x *ProcessorType) GetAllowCreation() bool

func (*ProcessorType) GetAvailableLocations

func (x *ProcessorType) GetAvailableLocations() []*ProcessorType_LocationInfo

func (*ProcessorType) GetCategory

func (x *ProcessorType) GetCategory() string

func (*ProcessorType) GetLaunchStage

func (x *ProcessorType) GetLaunchStage() api.LaunchStage

func (*ProcessorType) GetName

func (x *ProcessorType) GetName() string

func (*ProcessorType) GetSampleDocumentUris

func (x *ProcessorType) GetSampleDocumentUris() []string

func (*ProcessorType) GetType

func (x *ProcessorType) GetType() string

func (*ProcessorType) ProtoMessage

func (*ProcessorType) ProtoMessage()

func (*ProcessorType) ProtoReflect

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

func (*ProcessorType) Reset

func (x *ProcessorType) Reset()

func (*ProcessorType) String

func (x *ProcessorType) String() string

ProcessorType_LocationInfo

type ProcessorType_LocationInfo struct {

	// The location ID. For supported locations, refer to [regional and
	// multi-regional support](/document-ai/docs/regions).
	LocationId string `protobuf:"bytes,1,opt,name=location_id,json=locationId,proto3" json:"location_id,omitempty"`
	// contains filtered or unexported fields
}

The location information about where the processor is available.

func (*ProcessorType_LocationInfo) Descriptor

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

Deprecated: Use ProcessorType_LocationInfo.ProtoReflect.Descriptor instead.

func (*ProcessorType_LocationInfo) GetLocationId

func (x *ProcessorType_LocationInfo) GetLocationId() string

func (*ProcessorType_LocationInfo) ProtoMessage

func (*ProcessorType_LocationInfo) ProtoMessage()

func (*ProcessorType_LocationInfo) ProtoReflect

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

func (*ProcessorType_LocationInfo) Reset

func (x *ProcessorType_LocationInfo) Reset()

func (*ProcessorType_LocationInfo) String

func (x *ProcessorType_LocationInfo) String() string

ProcessorVersion

type ProcessorVersion struct {

	// Identifier. The resource name of the processor version.
	// Format:
	// `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The display name of the processor version.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Output only. The schema of the processor version. Describes the output.
	DocumentSchema *DocumentSchema `protobuf:"bytes,12,opt,name=document_schema,json=documentSchema,proto3" json:"document_schema,omitempty"`
	// Output only. The state of the processor version.
	State ProcessorVersion_State `protobuf:"varint,6,opt,name=state,proto3,enum=google.cloud.documentai.v1beta3.ProcessorVersion_State" json:"state,omitempty"`
	// Output only. The time the processor version was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The most recently invoked evaluation for the processor
	// version.
	LatestEvaluation *EvaluationReference `protobuf:"bytes,8,opt,name=latest_evaluation,json=latestEvaluation,proto3" json:"latest_evaluation,omitempty"`
	// Output only. The KMS key name used for encryption.
	KmsKeyName string `protobuf:"bytes,9,opt,name=kms_key_name,json=kmsKeyName,proto3" json:"kms_key_name,omitempty"`
	// Output only. The KMS key version with which data is encrypted.
	KmsKeyVersionName string `protobuf:"bytes,10,opt,name=kms_key_version_name,json=kmsKeyVersionName,proto3" json:"kms_key_version_name,omitempty"`
	// Output only. Denotes that this `ProcessorVersion` is managed by Google.
	GoogleManaged bool `protobuf:"varint,11,opt,name=google_managed,json=googleManaged,proto3" json:"google_managed,omitempty"`
	// Output only. If set, information about the eventual deprecation of this
	// version.
	DeprecationInfo *ProcessorVersion_DeprecationInfo `protobuf:"bytes,13,opt,name=deprecation_info,json=deprecationInfo,proto3" json:"deprecation_info,omitempty"`
	// Output only. The model type of this processor version.
	ModelType ProcessorVersion_ModelType `protobuf:"varint,15,opt,name=model_type,json=modelType,proto3,enum=google.cloud.documentai.v1beta3.ProcessorVersion_ModelType" json:"model_type,omitempty"`
	// Output only. Reserved for future use.
	SatisfiesPzs bool `protobuf:"varint,16,opt,name=satisfies_pzs,json=satisfiesPzs,proto3" json:"satisfies_pzs,omitempty"`
	// Output only. Reserved for future use.
	SatisfiesPzi bool `protobuf:"varint,17,opt,name=satisfies_pzi,json=satisfiesPzi,proto3" json:"satisfies_pzi,omitempty"`
	// Output only. Information about Generative AI model-based processor
	// versions.
	GenAiModelInfo *ProcessorVersion_GenAiModelInfo `protobuf:"bytes,18,opt,name=gen_ai_model_info,json=genAiModelInfo,proto3" json:"gen_ai_model_info,omitempty"`
	// contains filtered or unexported fields
}

A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that version.

func (*ProcessorVersion) Descriptor

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

Deprecated: Use ProcessorVersion.ProtoReflect.Descriptor instead.

func (*ProcessorVersion) GetCreateTime

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

func (*ProcessorVersion) GetDeprecationInfo

func (x *ProcessorVersion) GetDeprecationInfo() *ProcessorVersion_DeprecationInfo

func (*ProcessorVersion) GetDisplayName

func (x *ProcessorVersion) GetDisplayName() string

func (*ProcessorVersion) GetDocumentSchema

func (x *ProcessorVersion) GetDocumentSchema() *DocumentSchema

func (*ProcessorVersion) GetGenAiModelInfo

func (x *ProcessorVersion) GetGenAiModelInfo() *ProcessorVersion_GenAiModelInfo

func (*ProcessorVersion) GetGoogleManaged

func (x *ProcessorVersion) GetGoogleManaged() bool

func (*ProcessorVersion) GetKmsKeyName

func (x *ProcessorVersion) GetKmsKeyName() string

func (*ProcessorVersion) GetKmsKeyVersionName

func (x *ProcessorVersion) GetKmsKeyVersionName() string

func (*ProcessorVersion) GetLatestEvaluation

func (x *ProcessorVersion) GetLatestEvaluation() *EvaluationReference

func (*ProcessorVersion) GetModelType

func (x *ProcessorVersion) GetModelType() ProcessorVersion_ModelType

func (*ProcessorVersion) GetName

func (x *ProcessorVersion) GetName() string

func (*ProcessorVersion) GetSatisfiesPzi

func (x *ProcessorVersion) GetSatisfiesPzi() bool

func (*ProcessorVersion) GetSatisfiesPzs

func (x *ProcessorVersion) GetSatisfiesPzs() bool

func (*ProcessorVersion) GetState

func (x *ProcessorVersion) GetState() ProcessorVersion_State

func (*ProcessorVersion) ProtoMessage

func (*ProcessorVersion) ProtoMessage()

func (*ProcessorVersion) ProtoReflect

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

func (*ProcessorVersion) Reset

func (x *ProcessorVersion) Reset()

func (*ProcessorVersion) String

func (x *ProcessorVersion) String() string

ProcessorVersionAlias

type ProcessorVersionAlias struct {

	// The alias in the form of `processor_version` resource name.
	Alias string `protobuf:"bytes,1,opt,name=alias,proto3" json:"alias,omitempty"`
	// The resource name of aliased processor version.
	ProcessorVersion string `protobuf:"bytes,2,opt,name=processor_version,json=processorVersion,proto3" json:"processor_version,omitempty"`
	// contains filtered or unexported fields
}

Contains the alias and the aliased resource name of processor version.

func (*ProcessorVersionAlias) Descriptor

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

Deprecated: Use ProcessorVersionAlias.ProtoReflect.Descriptor instead.

func (*ProcessorVersionAlias) GetAlias

func (x *ProcessorVersionAlias) GetAlias() string

func (*ProcessorVersionAlias) GetProcessorVersion

func (x *ProcessorVersionAlias) GetProcessorVersion() string

func (*ProcessorVersionAlias) ProtoMessage

func (*ProcessorVersionAlias) ProtoMessage()

func (*ProcessorVersionAlias) ProtoReflect

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

func (*ProcessorVersionAlias) Reset

func (x *ProcessorVersionAlias) Reset()

func (*ProcessorVersionAlias) String

func (x *ProcessorVersionAlias) String() string

ProcessorVersion_DeprecationInfo

type ProcessorVersion_DeprecationInfo struct {

	// The time at which this processor version will be deprecated.
	DeprecationTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=deprecation_time,json=deprecationTime,proto3" json:"deprecation_time,omitempty"`
	// If set, the processor version that will be used as a replacement.
	ReplacementProcessorVersion string `protobuf:"bytes,2,opt,name=replacement_processor_version,json=replacementProcessorVersion,proto3" json:"replacement_processor_version,omitempty"`
	// contains filtered or unexported fields
}

Information about the upcoming deprecation of this processor version.

func (*ProcessorVersion_DeprecationInfo) Descriptor

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

Deprecated: Use ProcessorVersion_DeprecationInfo.ProtoReflect.Descriptor instead.

func (*ProcessorVersion_DeprecationInfo) GetDeprecationTime

func (x *ProcessorVersion_DeprecationInfo) GetDeprecationTime() *timestamppb.Timestamp

func (*ProcessorVersion_DeprecationInfo) GetReplacementProcessorVersion

func (x *ProcessorVersion_DeprecationInfo) GetReplacementProcessorVersion() string

func (*ProcessorVersion_DeprecationInfo) ProtoMessage

func (*ProcessorVersion_DeprecationInfo) ProtoMessage()

func (*ProcessorVersion_DeprecationInfo) ProtoReflect

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

func (*ProcessorVersion_DeprecationInfo) Reset

func (x *ProcessorVersion_DeprecationInfo) Reset()

func (*ProcessorVersion_DeprecationInfo) String

func (x *ProcessorVersion_DeprecationInfo) String() string

ProcessorVersion_GenAiModelInfo

type ProcessorVersion_GenAiModelInfo struct {

	// The processor version is either a pretrained Google-managed foundation
	// model or a custom Generative AI model created by the user.
	//
	// Types that are assignable to ModelInfo:
	//
	//	*ProcessorVersion_GenAiModelInfo_FoundationGenAiModelInfo_
	//	*ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_
	ModelInfo isProcessorVersion_GenAiModelInfo_ModelInfo `protobuf_oneof:"model_info"`
	// contains filtered or unexported fields
}

Information about Generative AI model-based processor versions.

func (*ProcessorVersion_GenAiModelInfo) Descriptor

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

Deprecated: Use ProcessorVersion_GenAiModelInfo.ProtoReflect.Descriptor instead.

func (*ProcessorVersion_GenAiModelInfo) GetCustomGenAiModelInfo

func (x *ProcessorVersion_GenAiModelInfo) GetCustomGenAiModelInfo() *ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo

func (*ProcessorVersion_GenAiModelInfo) GetFoundationGenAiModelInfo

func (x *ProcessorVersion_GenAiModelInfo) GetFoundationGenAiModelInfo() *ProcessorVersion_GenAiModelInfo_FoundationGenAiModelInfo

func (*ProcessorVersion_GenAiModelInfo) GetModelInfo

func (m *ProcessorVersion_GenAiModelInfo) GetModelInfo() isProcessorVersion_GenAiModelInfo_ModelInfo

func (*ProcessorVersion_GenAiModelInfo) ProtoMessage

func (*ProcessorVersion_GenAiModelInfo) ProtoMessage()

func (*ProcessorVersion_GenAiModelInfo) ProtoReflect

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

func (*ProcessorVersion_GenAiModelInfo) Reset

func (x *ProcessorVersion_GenAiModelInfo) Reset()

func (*ProcessorVersion_GenAiModelInfo) String

func (x *ProcessorVersion_GenAiModelInfo) String() string

ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo

type ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo struct {

	// The type of custom model created by the user.
	CustomModelType ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_CustomModelType `protobuf:"varint,1,opt,name=custom_model_type,json=customModelType,proto3,enum=google.cloud.documentai.v1beta3.ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_CustomModelType" json:"custom_model_type,omitempty"`
	// The base processor version ID for the custom model.
	BaseProcessorVersionId string `protobuf:"bytes,2,opt,name=base_processor_version_id,json=baseProcessorVersionId,proto3" json:"base_processor_version_id,omitempty"`
	// contains filtered or unexported fields
}

Information for a custom Generative AI model created by the user. These are created with Create New Version in either the Call foundation model or Fine tuning tabs.

func (*ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo) Descriptor

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

Deprecated: Use ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo.ProtoReflect.Descriptor instead.

func (*ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo) GetBaseProcessorVersionId

func (x *ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo) GetBaseProcessorVersionId() string

func (*ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo) GetCustomModelType

func (x *ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo) GetCustomModelType() ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_CustomModelType

func (*ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo) ProtoMessage

func (*ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo) ProtoMessage()

func (*ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo) ProtoReflect

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

func (*ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo) Reset

func (x *ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo) Reset()

func (*ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo) String

func (x *ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo) String() string

ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_

type ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_ struct {
	// Information for a custom Generative AI model created by the user.
	CustomGenAiModelInfo *ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo `protobuf:"bytes,2,opt,name=custom_gen_ai_model_info,json=customGenAiModelInfo,proto3,oneof"`
}

ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_CustomModelType

type ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_CustomModelType int32

The type of custom model created by the user.

ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_CUSTOM_MODEL_TYPE_UNSPECIFIED, ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_VERSIONED_FOUNDATION, ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_FINE_TUNED

const (
	// The model type is unspecified.
	ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_CUSTOM_MODEL_TYPE_UNSPECIFIED ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_CustomModelType = 0
	// The model is a versioned foundation model.
	ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_VERSIONED_FOUNDATION ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_CustomModelType = 1
	// The model is a finetuned foundation model.
	ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_FINE_TUNED ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_CustomModelType = 2
)

func (ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_CustomModelType) Descriptor

func (ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_CustomModelType) Descriptor() protoreflect.EnumDescriptor

func (ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_CustomModelType) Enum

func (x ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_CustomModelType) Enum() *ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_CustomModelType

func (ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_CustomModelType) EnumDescriptor

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

Deprecated: Use ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_CustomModelType.Descriptor instead.

func (ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_CustomModelType) Number

func (x ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_CustomModelType) Number() protoreflect.EnumNumber

func (ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_CustomModelType) String

func (x ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_CustomModelType) String() string

func (ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_CustomModelType) Type

func (ProcessorVersion_GenAiModelInfo_CustomGenAiModelInfo_CustomModelType) Type() protoreflect.EnumType

ProcessorVersion_GenAiModelInfo_FoundationGenAiModelInfo

type ProcessorVersion_GenAiModelInfo_FoundationGenAiModelInfo struct {

	// Whether finetuning is allowed for this base processor version.
	FinetuningAllowed bool `protobuf:"varint,1,opt,name=finetuning_allowed,json=finetuningAllowed,proto3" json:"finetuning_allowed,omitempty"`
	// The minimum number of labeled documents in the training dataset
	// required for finetuning.
	MinTrainLabeledDocuments int32 `protobuf:"varint,2,opt,name=min_train_labeled_documents,json=minTrainLabeledDocuments,proto3" json:"min_train_labeled_documents,omitempty"`
	// contains filtered or unexported fields
}

Information for a pretrained Google-managed foundation model.

func (*ProcessorVersion_GenAiModelInfo_FoundationGenAiModelInfo) Descriptor

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

Deprecated: Use ProcessorVersion_GenAiModelInfo_FoundationGenAiModelInfo.ProtoReflect.Descriptor instead.

func (*ProcessorVersion_GenAiModelInfo_FoundationGenAiModelInfo) GetFinetuningAllowed

func (x *ProcessorVersion_GenAiModelInfo_FoundationGenAiModelInfo) GetFinetuningAllowed() bool

func (*ProcessorVersion_GenAiModelInfo_FoundationGenAiModelInfo) GetMinTrainLabeledDocuments

func (x *ProcessorVersion_GenAiModelInfo_FoundationGenAiModelInfo) GetMinTrainLabeledDocuments() int32

func (*ProcessorVersion_GenAiModelInfo_FoundationGenAiModelInfo) ProtoMessage

func (*ProcessorVersion_GenAiModelInfo_FoundationGenAiModelInfo) ProtoMessage()

func (*ProcessorVersion_GenAiModelInfo_FoundationGenAiModelInfo) ProtoReflect

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

func (*ProcessorVersion_GenAiModelInfo_FoundationGenAiModelInfo) Reset

func (x *ProcessorVersion_GenAiModelInfo_FoundationGenAiModelInfo) Reset()

func (*ProcessorVersion_GenAiModelInfo_FoundationGenAiModelInfo) String

func (x *ProcessorVersion_GenAiModelInfo_FoundationGenAiModelInfo) String() string

ProcessorVersion_GenAiModelInfo_FoundationGenAiModelInfo_

type ProcessorVersion_GenAiModelInfo_FoundationGenAiModelInfo_ struct {
	// Information for a pretrained Google-managed foundation model.
	FoundationGenAiModelInfo *ProcessorVersion_GenAiModelInfo_FoundationGenAiModelInfo `protobuf:"bytes,1,opt,name=foundation_gen_ai_model_info,json=foundationGenAiModelInfo,proto3,oneof"`
}

ProcessorVersion_ModelType

type ProcessorVersion_ModelType int32

The possible model types of the processor version.

ProcessorVersion_MODEL_TYPE_UNSPECIFIED, ProcessorVersion_MODEL_TYPE_GENERATIVE, ProcessorVersion_MODEL_TYPE_CUSTOM

const (
	// The processor version has unspecified model type.
	ProcessorVersion_MODEL_TYPE_UNSPECIFIED ProcessorVersion_ModelType = 0
	// The processor version has generative model type.
	ProcessorVersion_MODEL_TYPE_GENERATIVE ProcessorVersion_ModelType = 1
	// The processor version has custom model type.
	ProcessorVersion_MODEL_TYPE_CUSTOM ProcessorVersion_ModelType = 2
)

func (ProcessorVersion_ModelType) Descriptor

func (ProcessorVersion_ModelType) Descriptor() protoreflect.EnumDescriptor

func (ProcessorVersion_ModelType) Enum

func (x ProcessorVersion_ModelType) Enum() *ProcessorVersion_ModelType

func (ProcessorVersion_ModelType) EnumDescriptor

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

Deprecated: Use ProcessorVersion_ModelType.Descriptor instead.

func (ProcessorVersion_ModelType) Number

func (x ProcessorVersion_ModelType) Number() protoreflect.EnumNumber

func (ProcessorVersion_ModelType) String

func (x ProcessorVersion_ModelType) String() string

func (ProcessorVersion_ModelType) Type

func (ProcessorVersion_ModelType) Type() protoreflect.EnumType

ProcessorVersion_State

type ProcessorVersion_State int32

The possible states of the processor version.

ProcessorVersion_STATE_UNSPECIFIED, ProcessorVersion_DEPLOYED, ProcessorVersion_DEPLOYING, ProcessorVersion_UNDEPLOYED, ProcessorVersion_UNDEPLOYING, ProcessorVersion_CREATING, ProcessorVersion_DELETING, ProcessorVersion_FAILED, ProcessorVersion_IMPORTING

const (
	// The processor version is in an unspecified state.
	ProcessorVersion_STATE_UNSPECIFIED ProcessorVersion_State = 0
	// The processor version is deployed and can be used for processing.
	ProcessorVersion_DEPLOYED ProcessorVersion_State = 1
	// The processor version is being deployed.
	ProcessorVersion_DEPLOYING ProcessorVersion_State = 2
	// The processor version is not deployed and cannot be used for processing.
	ProcessorVersion_UNDEPLOYED ProcessorVersion_State = 3
	// The processor version is being undeployed.
	ProcessorVersion_UNDEPLOYING ProcessorVersion_State = 4
	// The processor version is being created.
	ProcessorVersion_CREATING ProcessorVersion_State = 5
	// The processor version is being deleted.
	ProcessorVersion_DELETING ProcessorVersion_State = 6
	// The processor version failed and is in an indeterminate state.
	ProcessorVersion_FAILED ProcessorVersion_State = 7
	// The processor version is being imported.
	ProcessorVersion_IMPORTING ProcessorVersion_State = 8
)

func (ProcessorVersion_State) Descriptor

func (ProcessorVersion_State) Descriptor() protoreflect.EnumDescriptor

func (ProcessorVersion_State) Enum

func (x ProcessorVersion_State) Enum() *ProcessorVersion_State

func (ProcessorVersion_State) EnumDescriptor

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

Deprecated: Use ProcessorVersion_State.Descriptor instead.

func (ProcessorVersion_State) Number

func (x ProcessorVersion_State) Number() protoreflect.EnumNumber

func (ProcessorVersion_State) String

func (x ProcessorVersion_State) String() string

func (ProcessorVersion_State) Type

func (ProcessorVersion_State) Type() protoreflect.EnumType

Processor_State

type Processor_State int32

The possible states of the processor.

Processor_STATE_UNSPECIFIED, Processor_ENABLED, Processor_DISABLED, Processor_ENABLING, Processor_DISABLING, Processor_CREATING, Processor_FAILED, Processor_DELETING

const (
	// The processor is in an unspecified state.
	Processor_STATE_UNSPECIFIED Processor_State = 0
	// The processor is enabled, i.e., has an enabled version which can
	// currently serve processing requests and all the feature dependencies have
	// been successfully initialized.
	Processor_ENABLED Processor_State = 1
	// The processor is disabled.
	Processor_DISABLED Processor_State = 2
	// The processor is being enabled, will become `ENABLED` if successful.
	Processor_ENABLING Processor_State = 3
	// The processor is being disabled, will become `DISABLED` if successful.
	Processor_DISABLING Processor_State = 4
	// The processor is being created, will become either `ENABLED` (for
	// successful creation) or `FAILED` (for failed ones).
	// Once a processor is in this state, it can then be used for document
	// processing, but the feature dependencies of the processor might not be
	// fully created yet.
	Processor_CREATING Processor_State = 5
	// The processor failed during creation or initialization of feature
	// dependencies. The user should delete the processor and recreate one as
	// all the functionalities of the processor are disabled.
	Processor_FAILED Processor_State = 6
	// The processor is being deleted, will be removed if successful.
	Processor_DELETING Processor_State = 7
)

func (Processor_State) Descriptor

func (Processor_State) Descriptor() protoreflect.EnumDescriptor

func (Processor_State) Enum

func (x Processor_State) Enum() *Processor_State

func (Processor_State) EnumDescriptor

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

Deprecated: Use Processor_State.Descriptor instead.

func (Processor_State) Number

func (x Processor_State) Number() protoreflect.EnumNumber

func (Processor_State) String

func (x Processor_State) String() string

func (Processor_State) Type

func (Processor_State) Type() protoreflect.EnumType

PropertyMetadata

type PropertyMetadata struct {

	// Whether the property should be considered as "inactive".
	Inactive bool `protobuf:"varint,3,opt,name=inactive,proto3" json:"inactive,omitempty"`
	// Field extraction metadata on the property.
	FieldExtractionMetadata *FieldExtractionMetadata `protobuf:"bytes,9,opt,name=field_extraction_metadata,json=fieldExtractionMetadata,proto3" json:"field_extraction_metadata,omitempty"`
	// contains filtered or unexported fields
}

Metadata about a property.

func (*PropertyMetadata) Descriptor

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

Deprecated: Use PropertyMetadata.ProtoReflect.Descriptor instead.

func (*PropertyMetadata) GetFieldExtractionMetadata

func (x *PropertyMetadata) GetFieldExtractionMetadata() *FieldExtractionMetadata

func (*PropertyMetadata) GetInactive

func (x *PropertyMetadata) GetInactive() bool

func (*PropertyMetadata) ProtoMessage

func (*PropertyMetadata) ProtoMessage()

func (*PropertyMetadata) ProtoReflect

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

func (*PropertyMetadata) Reset

func (x *PropertyMetadata) Reset()

func (*PropertyMetadata) String

func (x *PropertyMetadata) String() string

RawDocument

type RawDocument struct {

	// Inline document content.
	Content []byte `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"`
	// An IANA MIME type (RFC6838) indicating the nature and format of the
	// [content][google.cloud.documentai.v1beta3.RawDocument.content].
	MimeType string `protobuf:"bytes,2,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// The display name of the document, it supports all Unicode characters except
	// the following:
	// `*`, `?`, `[`, `]`, `%`, `{`, `}`,`'`, `\"`, `,`
	// `~`, `=` and `:` are reserved.
	// If not specified, a default ID is generated.
	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// contains filtered or unexported fields
}

Payload message of raw document content (bytes).

func (*RawDocument) Descriptor

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

Deprecated: Use RawDocument.ProtoReflect.Descriptor instead.

func (*RawDocument) GetContent

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

func (*RawDocument) GetDisplayName

func (x *RawDocument) GetDisplayName() string

func (*RawDocument) GetMimeType

func (x *RawDocument) GetMimeType() string

func (*RawDocument) ProtoMessage

func (*RawDocument) ProtoMessage()

func (*RawDocument) ProtoReflect

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

func (*RawDocument) Reset

func (x *RawDocument) Reset()

func (*RawDocument) String

func (x *RawDocument) String() string

ReviewDocumentOperationMetadata

type ReviewDocumentOperationMetadata struct {

	// Used only when Operation.done is false.
	State ReviewDocumentOperationMetadata_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.cloud.documentai.v1beta3.ReviewDocumentOperationMetadata_State" json:"state,omitempty"`
	// A message providing more details about the current state of processing.
	// For example, the error message if the operation is failed.
	StateMessage string `protobuf:"bytes,2,opt,name=state_message,json=stateMessage,proto3" json:"state_message,omitempty"`
	// The creation time of the operation.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// The last update time of the operation.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// The basic metadata of the long-running operation.
	CommonMetadata *CommonOperationMetadata `protobuf:"bytes,5,opt,name=common_metadata,json=commonMetadata,proto3" json:"common_metadata,omitempty"`
	// The Crowd Compute question ID.
	QuestionId string `protobuf:"bytes,6,opt,name=question_id,json=questionId,proto3" json:"question_id,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ReviewDocumentOperationMetadata) Descriptor

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

Deprecated: Use ReviewDocumentOperationMetadata.ProtoReflect.Descriptor instead.

func (*ReviewDocumentOperationMetadata) GetCommonMetadata

func (x *ReviewDocumentOperationMetadata) GetCommonMetadata() *CommonOperationMetadata

func (*ReviewDocumentOperationMetadata) GetCreateTime

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

func (*ReviewDocumentOperationMetadata) GetQuestionId

func (x *ReviewDocumentOperationMetadata) GetQuestionId() string

func (*ReviewDocumentOperationMetadata) GetState

func (x *ReviewDocumentOperationMetadata) GetState() ReviewDocumentOperationMetadata_State

func (*ReviewDocumentOperationMetadata) GetStateMessage

func (x *ReviewDocumentOperationMetadata) GetStateMessage() string

func (*ReviewDocumentOperationMetadata) GetUpdateTime

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

func (*ReviewDocumentOperationMetadata) ProtoMessage

func (*ReviewDocumentOperationMetadata) ProtoMessage()

func (*ReviewDocumentOperationMetadata) ProtoReflect

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

func (*ReviewDocumentOperationMetadata) Reset

func (x *ReviewDocumentOperationMetadata) Reset()

func (*ReviewDocumentOperationMetadata) String

func (x *ReviewDocumentOperationMetadata) String() string

ReviewDocumentOperationMetadata_State

type ReviewDocumentOperationMetadata_State int32

State of the long-running operation.

ReviewDocumentOperationMetadata_STATE_UNSPECIFIED, ReviewDocumentOperationMetadata_RUNNING, ReviewDocumentOperationMetadata_CANCELLING, ReviewDocumentOperationMetadata_SUCCEEDED, ReviewDocumentOperationMetadata_FAILED, ReviewDocumentOperationMetadata_CANCELLED

const (
	// Unspecified state.
	ReviewDocumentOperationMetadata_STATE_UNSPECIFIED ReviewDocumentOperationMetadata_State = 0
	// Operation is still running.
	ReviewDocumentOperationMetadata_RUNNING ReviewDocumentOperationMetadata_State = 1
	// Operation is being cancelled.
	ReviewDocumentOperationMetadata_CANCELLING ReviewDocumentOperationMetadata_State = 2
	// Operation succeeded.
	ReviewDocumentOperationMetadata_SUCCEEDED ReviewDocumentOperationMetadata_State = 3
	// Operation failed.
	ReviewDocumentOperationMetadata_FAILED ReviewDocumentOperationMetadata_State = 4
	// Operation is cancelled.
	ReviewDocumentOperationMetadata_CANCELLED ReviewDocumentOperationMetadata_State = 5
)

func (ReviewDocumentOperationMetadata_State) Descriptor

func (ReviewDocumentOperationMetadata_State) Descriptor() protoreflect.EnumDescriptor

func (ReviewDocumentOperationMetadata_State) Enum

func (x ReviewDocumentOperationMetadata_State) Enum() *ReviewDocumentOperationMetadata_State

func (ReviewDocumentOperationMetadata_State) EnumDescriptor

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

Deprecated: Use ReviewDocumentOperationMetadata_State.Descriptor instead.

func (ReviewDocumentOperationMetadata_State) Number

func (x ReviewDocumentOperationMetadata_State) Number() protoreflect.EnumNumber

func (ReviewDocumentOperationMetadata_State) String

func (x ReviewDocumentOperationMetadata_State) String() string

func (ReviewDocumentOperationMetadata_State) Type

func (ReviewDocumentOperationMetadata_State) Type() protoreflect.EnumType

ReviewDocumentRequest

type ReviewDocumentRequest struct {

	// The document payload.
	//
	// Types that are assignable to Source:
	//
	//	*ReviewDocumentRequest_InlineDocument
	Source isReviewDocumentRequest_Source `protobuf_oneof:"source"`
	// Required. The resource name of the
	// [HumanReviewConfig][google.cloud.documentai.v1beta3.HumanReviewConfig] that
	// the document will be reviewed with.
	HumanReviewConfig string `protobuf:"bytes,1,opt,name=human_review_config,json=humanReviewConfig,proto3" json:"human_review_config,omitempty"`
	// The document that needs human review.
	//
	// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document_processor_service.proto.
	Document *Document `protobuf:"bytes,2,opt,name=document,proto3" json:"document,omitempty"`
	// Whether the validation should be performed on the ad-hoc review request.
	EnableSchemaValidation bool `protobuf:"varint,3,opt,name=enable_schema_validation,json=enableSchemaValidation,proto3" json:"enable_schema_validation,omitempty"`
	// The priority of the human review task.
	Priority ReviewDocumentRequest_Priority `protobuf:"varint,5,opt,name=priority,proto3,enum=google.cloud.documentai.v1beta3.ReviewDocumentRequest_Priority" json:"priority,omitempty"`
	// The document schema of the human review task.
	DocumentSchema *DocumentSchema `protobuf:"bytes,6,opt,name=document_schema,json=documentSchema,proto3" json:"document_schema,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ReviewDocumentRequest) Descriptor

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

Deprecated: Use ReviewDocumentRequest.ProtoReflect.Descriptor instead.

func (*ReviewDocumentRequest) GetDocument

func (x *ReviewDocumentRequest) GetDocument() *Document

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

func (*ReviewDocumentRequest) GetDocumentSchema

func (x *ReviewDocumentRequest) GetDocumentSchema() *DocumentSchema

func (*ReviewDocumentRequest) GetEnableSchemaValidation

func (x *ReviewDocumentRequest) GetEnableSchemaValidation() bool

func (*ReviewDocumentRequest) GetHumanReviewConfig

func (x *ReviewDocumentRequest) GetHumanReviewConfig() string

func (*ReviewDocumentRequest) GetInlineDocument

func (x *ReviewDocumentRequest) GetInlineDocument() *Document

func (*ReviewDocumentRequest) GetPriority

func (x *ReviewDocumentRequest) GetPriority() ReviewDocumentRequest_Priority

func (*ReviewDocumentRequest) GetSource

func (m *ReviewDocumentRequest) GetSource() isReviewDocumentRequest_Source

func (*ReviewDocumentRequest) ProtoMessage

func (*ReviewDocumentRequest) ProtoMessage()

func (*ReviewDocumentRequest) ProtoReflect

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

func (*ReviewDocumentRequest) Reset

func (x *ReviewDocumentRequest) Reset()

func (*ReviewDocumentRequest) String

func (x *ReviewDocumentRequest) String() string

ReviewDocumentRequest_InlineDocument

type ReviewDocumentRequest_InlineDocument struct {
	// An inline document proto.
	InlineDocument *Document `protobuf:"bytes,4,opt,name=inline_document,json=inlineDocument,proto3,oneof"`
}

ReviewDocumentRequest_Priority

type ReviewDocumentRequest_Priority int32

The priority level of the human review task.

ReviewDocumentRequest_DEFAULT, ReviewDocumentRequest_URGENT

const (
	// The default priority level.
	ReviewDocumentRequest_DEFAULT ReviewDocumentRequest_Priority = 0
	// The urgent priority level. The labeling manager should allocate labeler
	// resource to the urgent task queue to respect this priority level.
	ReviewDocumentRequest_URGENT ReviewDocumentRequest_Priority = 1
)

func (ReviewDocumentRequest_Priority) Descriptor

func (ReviewDocumentRequest_Priority) Descriptor() protoreflect.EnumDescriptor

func (ReviewDocumentRequest_Priority) Enum

func (x ReviewDocumentRequest_Priority) Enum() *ReviewDocumentRequest_Priority

func (ReviewDocumentRequest_Priority) EnumDescriptor

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

Deprecated: Use ReviewDocumentRequest_Priority.Descriptor instead.

func (ReviewDocumentRequest_Priority) Number

func (x ReviewDocumentRequest_Priority) Number() protoreflect.EnumNumber

func (ReviewDocumentRequest_Priority) String

func (x ReviewDocumentRequest_Priority) String() string

func (ReviewDocumentRequest_Priority) Type

func (ReviewDocumentRequest_Priority) Type() protoreflect.EnumType

ReviewDocumentResponse

type ReviewDocumentResponse struct {

	// The Cloud Storage uri for the human reviewed document if the review is
	// succeeded.
	GcsDestination string `protobuf:"bytes,1,opt,name=gcs_destination,json=gcsDestination,proto3" json:"gcs_destination,omitempty"`
	// The state of the review operation.
	State ReviewDocumentResponse_State `protobuf:"varint,2,opt,name=state,proto3,enum=google.cloud.documentai.v1beta3.ReviewDocumentResponse_State" json:"state,omitempty"`
	// The reason why the review is rejected by reviewer.
	RejectionReason string `protobuf:"bytes,3,opt,name=rejection_reason,json=rejectionReason,proto3" json:"rejection_reason,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ReviewDocumentResponse) Descriptor

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

Deprecated: Use ReviewDocumentResponse.ProtoReflect.Descriptor instead.

func (*ReviewDocumentResponse) GetGcsDestination

func (x *ReviewDocumentResponse) GetGcsDestination() string

func (*ReviewDocumentResponse) GetRejectionReason

func (x *ReviewDocumentResponse) GetRejectionReason() string

func (*ReviewDocumentResponse) GetState

func (x *ReviewDocumentResponse) GetState() ReviewDocumentResponse_State

func (*ReviewDocumentResponse) ProtoMessage

func (*ReviewDocumentResponse) ProtoMessage()

func (*ReviewDocumentResponse) ProtoReflect

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

func (*ReviewDocumentResponse) Reset

func (x *ReviewDocumentResponse) Reset()

func (*ReviewDocumentResponse) String

func (x *ReviewDocumentResponse) String() string

ReviewDocumentResponse_State

type ReviewDocumentResponse_State int32

Possible states of the review operation.

ReviewDocumentResponse_STATE_UNSPECIFIED, ReviewDocumentResponse_REJECTED, ReviewDocumentResponse_SUCCEEDED

const (
	// The default value. This value is used if the state is omitted.
	ReviewDocumentResponse_STATE_UNSPECIFIED ReviewDocumentResponse_State = 0
	// The review operation is rejected by the reviewer.
	ReviewDocumentResponse_REJECTED ReviewDocumentResponse_State = 1
	// The review operation is succeeded.
	ReviewDocumentResponse_SUCCEEDED ReviewDocumentResponse_State = 2
)

func (ReviewDocumentResponse_State) Descriptor

func (ReviewDocumentResponse_State) Descriptor() protoreflect.EnumDescriptor

func (ReviewDocumentResponse_State) Enum

func (x ReviewDocumentResponse_State) Enum() *ReviewDocumentResponse_State

func (ReviewDocumentResponse_State) EnumDescriptor

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

Deprecated: Use ReviewDocumentResponse_State.Descriptor instead.

func (ReviewDocumentResponse_State) Number

func (x ReviewDocumentResponse_State) Number() protoreflect.EnumNumber

func (ReviewDocumentResponse_State) String

func (x ReviewDocumentResponse_State) String() string

func (ReviewDocumentResponse_State) Type

func (ReviewDocumentResponse_State) Type() protoreflect.EnumType

RevisionRef

type RevisionRef struct {

	// Specifies which revision to read.
	//
	// Types that are assignable to Source:
	//
	//	*RevisionRef_RevisionCase_
	//	*RevisionRef_RevisionId
	//	*RevisionRef_LatestProcessorVersion
	Source isRevisionRef_Source `protobuf_oneof:"source"`
	// contains filtered or unexported fields
}

The revision reference specifies which revision on the document to read.

func (*RevisionRef) Descriptor

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

Deprecated: Use RevisionRef.ProtoReflect.Descriptor instead.

func (*RevisionRef) GetLatestProcessorVersion

func (x *RevisionRef) GetLatestProcessorVersion() string

func (*RevisionRef) GetRevisionCase

func (x *RevisionRef) GetRevisionCase() RevisionRef_RevisionCase

func (*RevisionRef) GetRevisionId

func (x *RevisionRef) GetRevisionId() string

func (*RevisionRef) GetSource

func (m *RevisionRef) GetSource() isRevisionRef_Source

func (*RevisionRef) ProtoMessage

func (*RevisionRef) ProtoMessage()

func (*RevisionRef) ProtoReflect

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

func (*RevisionRef) Reset

func (x *RevisionRef) Reset()

func (*RevisionRef) String

func (x *RevisionRef) String() string

RevisionRef_LatestProcessorVersion

type RevisionRef_LatestProcessorVersion struct {
	// Reads the revision generated by the processor version.
	// The format takes the full resource name of processor version.
	// `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
	LatestProcessorVersion string `protobuf:"bytes,3,opt,name=latest_processor_version,json=latestProcessorVersion,proto3,oneof"`
}

RevisionRef_RevisionCase

type RevisionRef_RevisionCase int32

Some predefined revision cases.

RevisionRef_REVISION_CASE_UNSPECIFIED, RevisionRef_LATEST_HUMAN_REVIEW, RevisionRef_LATEST_TIMESTAMP, RevisionRef_BASE_OCR_REVISION

const (
	// Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`.
	RevisionRef_REVISION_CASE_UNSPECIFIED RevisionRef_RevisionCase = 0
	// The latest revision made by a human.
	RevisionRef_LATEST_HUMAN_REVIEW RevisionRef_RevisionCase = 1
	// The latest revision based on timestamp.
	RevisionRef_LATEST_TIMESTAMP RevisionRef_RevisionCase = 2
	// The first (OCR) revision.
	RevisionRef_BASE_OCR_REVISION RevisionRef_RevisionCase = 3
)

func (RevisionRef_RevisionCase) Descriptor

func (RevisionRef_RevisionCase) Descriptor() protoreflect.EnumDescriptor

func (RevisionRef_RevisionCase) Enum

func (x RevisionRef_RevisionCase) Enum() *RevisionRef_RevisionCase

func (RevisionRef_RevisionCase) EnumDescriptor

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

Deprecated: Use RevisionRef_RevisionCase.Descriptor instead.

func (RevisionRef_RevisionCase) Number

func (x RevisionRef_RevisionCase) Number() protoreflect.EnumNumber

func (RevisionRef_RevisionCase) String

func (x RevisionRef_RevisionCase) String() string

func (RevisionRef_RevisionCase) Type

func (RevisionRef_RevisionCase) Type() protoreflect.EnumType

RevisionRef_RevisionCase_

type RevisionRef_RevisionCase_ struct {
	// Reads the revision by the predefined case.
	RevisionCase RevisionRef_RevisionCase `protobuf:"varint,1,opt,name=revision_case,json=revisionCase,proto3,enum=google.cloud.documentai.v1beta3.RevisionRef_RevisionCase,oneof"`
}

RevisionRef_RevisionId

type RevisionRef_RevisionId struct {
	// Reads the revision given by the id.
	RevisionId string `protobuf:"bytes,2,opt,name=revision_id,json=revisionId,proto3,oneof"`
}

SetDefaultProcessorVersionMetadata

type SetDefaultProcessorVersionMetadata 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 [SetDefaultProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.SetDefaultProcessorVersion] method.

func (*SetDefaultProcessorVersionMetadata) Descriptor

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

Deprecated: Use SetDefaultProcessorVersionMetadata.ProtoReflect.Descriptor instead.

func (*SetDefaultProcessorVersionMetadata) GetCommonMetadata

func (x *SetDefaultProcessorVersionMetadata) GetCommonMetadata() *CommonOperationMetadata

func (*SetDefaultProcessorVersionMetadata) ProtoMessage

func (*SetDefaultProcessorVersionMetadata) ProtoMessage()

func (*SetDefaultProcessorVersionMetadata) ProtoReflect

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

func (*SetDefaultProcessorVersionMetadata) Reset

func (x *SetDefaultProcessorVersionMetadata) Reset()

func (*SetDefaultProcessorVersionMetadata) String

func (x *SetDefaultProcessorVersionMetadata) String() string

SetDefaultProcessorVersionRequest

type SetDefaultProcessorVersionRequest struct {

	// Required. The resource name of the
	// [Processor][google.cloud.documentai.v1beta3.Processor] to change default
	// version.
	Processor string `protobuf:"bytes,1,opt,name=processor,proto3" json:"processor,omitempty"`
	// Required. The resource name of child
	// [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion] to use
	// as default. Format:
	// `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}`
	DefaultProcessorVersion string `protobuf:"bytes,2,opt,name=default_processor_version,json=defaultProcessorVersion,proto3" json:"default_processor_version,omitempty"`
	// contains filtered or unexported fields
}

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

func (*SetDefaultProcessorVersionRequest) Descriptor

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

Deprecated: Use SetDefaultProcessorVersionRequest.ProtoReflect.Descriptor instead.

func (*SetDefaultProcessorVersionRequest) GetDefaultProcessorVersion

func (x *SetDefaultProcessorVersionRequest) GetDefaultProcessorVersion() string

func (*SetDefaultProcessorVersionRequest) GetProcessor

func (x *SetDefaultProcessorVersionRequest) GetProcessor() string

func (*SetDefaultProcessorVersionRequest) ProtoMessage

func (*SetDefaultProcessorVersionRequest) ProtoMessage()

func (*SetDefaultProcessorVersionRequest) ProtoReflect

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

func (*SetDefaultProcessorVersionRequest) Reset

func (x *SetDefaultProcessorVersionRequest) Reset()

func (*SetDefaultProcessorVersionRequest) String

func (x *SetDefaultProcessorVersionRequest) String() string

SetDefaultProcessorVersionResponse

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

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

func (*SetDefaultProcessorVersionResponse) Descriptor

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

Deprecated: Use SetDefaultProcessorVersionResponse.ProtoReflect.Descriptor instead.

func (*SetDefaultProcessorVersionResponse) ProtoMessage

func (*SetDefaultProcessorVersionResponse) ProtoMessage()

func (*SetDefaultProcessorVersionResponse) ProtoReflect

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

func (*SetDefaultProcessorVersionResponse) Reset

func (x *SetDefaultProcessorVersionResponse) Reset()

func (*SetDefaultProcessorVersionResponse) String

func (x *SetDefaultProcessorVersionResponse) String() string

SummaryOptions

type SummaryOptions struct {

	// How long the summary should be.
	Length SummaryOptions_Length `protobuf:"varint,1,opt,name=length,proto3,enum=google.cloud.documentai.v1beta3.SummaryOptions_Length" json:"length,omitempty"`
	// The format the summary should be in.
	Format SummaryOptions_Format `protobuf:"varint,2,opt,name=format,proto3,enum=google.cloud.documentai.v1beta3.SummaryOptions_Format" json:"format,omitempty"`
	// contains filtered or unexported fields
}

Metadata for document summarization.

func (*SummaryOptions) Descriptor

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

Deprecated: Use SummaryOptions.ProtoReflect.Descriptor instead.

func (*SummaryOptions) GetFormat

func (x *SummaryOptions) GetFormat() SummaryOptions_Format

func (*SummaryOptions) GetLength

func (x *SummaryOptions) GetLength() SummaryOptions_Length

func (*SummaryOptions) ProtoMessage

func (*SummaryOptions) ProtoMessage()

func (*SummaryOptions) ProtoReflect

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

func (*SummaryOptions) Reset

func (x *SummaryOptions) Reset()

func (*SummaryOptions) String

func (x *SummaryOptions) String() string

SummaryOptions_Format

type SummaryOptions_Format int32

The Format enum.

SummaryOptions_FORMAT_UNSPECIFIED, SummaryOptions_PARAGRAPH, SummaryOptions_BULLETS

const (
	// Default.
	SummaryOptions_FORMAT_UNSPECIFIED SummaryOptions_Format = 0
	// Format the output in paragraphs.
	SummaryOptions_PARAGRAPH SummaryOptions_Format = 1
	// Format the output in bullets.
	SummaryOptions_BULLETS SummaryOptions_Format = 2
)

func (SummaryOptions_Format) Descriptor

func (SummaryOptions_Format) Descriptor() protoreflect.EnumDescriptor

func (SummaryOptions_Format) Enum

func (x SummaryOptions_Format) Enum() *SummaryOptions_Format

func (SummaryOptions_Format) EnumDescriptor

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

Deprecated: Use SummaryOptions_Format.Descriptor instead.

func (SummaryOptions_Format) Number

func (x SummaryOptions_Format) Number() protoreflect.EnumNumber

func (SummaryOptions_Format) String

func (x SummaryOptions_Format) String() string

func (SummaryOptions_Format) Type

func (SummaryOptions_Format) Type() protoreflect.EnumType

SummaryOptions_Length

type SummaryOptions_Length int32

The Length enum.

SummaryOptions_LENGTH_UNSPECIFIED, SummaryOptions_BRIEF, SummaryOptions_MODERATE, SummaryOptions_COMPREHENSIVE

const (
	// Default.
	SummaryOptions_LENGTH_UNSPECIFIED SummaryOptions_Length = 0
	// A brief summary of one or two sentences.
	SummaryOptions_BRIEF SummaryOptions_Length = 1
	// A paragraph-length summary.
	SummaryOptions_MODERATE SummaryOptions_Length = 2
	// The longest option available.
	SummaryOptions_COMPREHENSIVE SummaryOptions_Length = 3
)

func (SummaryOptions_Length) Descriptor

func (SummaryOptions_Length) Descriptor() protoreflect.EnumDescriptor

func (SummaryOptions_Length) Enum

func (x SummaryOptions_Length) Enum() *SummaryOptions_Length

func (SummaryOptions_Length) EnumDescriptor

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

Deprecated: Use SummaryOptions_Length.Descriptor instead.

func (SummaryOptions_Length) Number

func (x SummaryOptions_Length) Number() protoreflect.EnumNumber

func (SummaryOptions_Length) String

func (x SummaryOptions_Length) String() string

func (SummaryOptions_Length) Type

func (SummaryOptions_Length) Type() protoreflect.EnumType

TrainProcessorVersionMetadata

type TrainProcessorVersionMetadata 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"`
	// The training dataset validation information.
	TrainingDatasetValidation *TrainProcessorVersionMetadata_DatasetValidation `protobuf:"bytes,2,opt,name=training_dataset_validation,json=trainingDatasetValidation,proto3" json:"training_dataset_validation,omitempty"`
	// The test dataset validation information.
	TestDatasetValidation *TrainProcessorVersionMetadata_DatasetValidation `protobuf:"bytes,3,opt,name=test_dataset_validation,json=testDatasetValidation,proto3" json:"test_dataset_validation,omitempty"`
	// contains filtered or unexported fields
}

The metadata that represents a processor version being created.

func (*TrainProcessorVersionMetadata) Descriptor

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

Deprecated: Use TrainProcessorVersionMetadata.ProtoReflect.Descriptor instead.

func (*TrainProcessorVersionMetadata) GetCommonMetadata

func (x *TrainProcessorVersionMetadata) GetCommonMetadata() *CommonOperationMetadata

func (*TrainProcessorVersionMetadata) GetTestDatasetValidation

func (x *TrainProcessorVersionMetadata) GetTestDatasetValidation() *TrainProcessorVersionMetadata_DatasetValidation

func (*TrainProcessorVersionMetadata) GetTrainingDatasetValidation

func (x *TrainProcessorVersionMetadata) GetTrainingDatasetValidation() *TrainProcessorVersionMetadata_DatasetValidation

func (*TrainProcessorVersionMetadata) ProtoMessage

func (*TrainProcessorVersionMetadata) ProtoMessage()

func (*TrainProcessorVersionMetadata) ProtoReflect

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

func (*TrainProcessorVersionMetadata) Reset

func (x *TrainProcessorVersionMetadata) Reset()

func (*TrainProcessorVersionMetadata) String

func (x *TrainProcessorVersionMetadata) String() string

TrainProcessorVersionMetadata_DatasetValidation

type TrainProcessorVersionMetadata_DatasetValidation struct {

	// The total number of document errors.
	DocumentErrorCount int32 `protobuf:"varint,3,opt,name=document_error_count,json=documentErrorCount,proto3" json:"document_error_count,omitempty"`
	// The total number of dataset errors.
	DatasetErrorCount int32 `protobuf:"varint,4,opt,name=dataset_error_count,json=datasetErrorCount,proto3" json:"dataset_error_count,omitempty"`
	// Error information pertaining to specific documents. A maximum of 10
	// document errors will be returned.
	// Any document with errors will not be used throughout training.
	DocumentErrors []*status.Status `protobuf:"bytes,1,rep,name=document_errors,json=documentErrors,proto3" json:"document_errors,omitempty"`
	// Error information for the dataset as a whole. A maximum of 10 dataset
	// errors will be returned.
	// A single dataset error is terminal for training.
	DatasetErrors []*status.Status `protobuf:"bytes,2,rep,name=dataset_errors,json=datasetErrors,proto3" json:"dataset_errors,omitempty"`
	// contains filtered or unexported fields
}

The dataset validation information. This includes any and all errors with documents and the dataset.

func (*TrainProcessorVersionMetadata_DatasetValidation) Descriptor

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

Deprecated: Use TrainProcessorVersionMetadata_DatasetValidation.ProtoReflect.Descriptor instead.

func (*TrainProcessorVersionMetadata_DatasetValidation) GetDatasetErrorCount

func (x *TrainProcessorVersionMetadata_DatasetValidation) GetDatasetErrorCount() int32

func (*TrainProcessorVersionMetadata_DatasetValidation) GetDatasetErrors

func (x *TrainProcessorVersionMetadata_DatasetValidation) GetDatasetErrors() []*status.Status

func (*TrainProcessorVersionMetadata_DatasetValidation) GetDocumentErrorCount

func (x *TrainProcessorVersionMetadata_DatasetValidation) GetDocumentErrorCount() int32

func (*TrainProcessorVersionMetadata_DatasetValidation) GetDocumentErrors

func (x *TrainProcessorVersionMetadata_DatasetValidation) GetDocumentErrors() []*status.Status

func (*TrainProcessorVersionMetadata_DatasetValidation) ProtoMessage

func (*TrainProcessorVersionMetadata_DatasetValidation) ProtoMessage()

func (*TrainProcessorVersionMetadata_DatasetValidation) ProtoReflect

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

func (*TrainProcessorVersionMetadata_DatasetValidation) Reset

func (x *TrainProcessorVersionMetadata_DatasetValidation) Reset()

func (*TrainProcessorVersionMetadata_DatasetValidation) String

func (x *TrainProcessorVersionMetadata_DatasetValidation) String() string

TrainProcessorVersionRequest

type TrainProcessorVersionRequest struct {

	// Types that are assignable to ProcessorFlags:
	//
	//	*TrainProcessorVersionRequest_CustomDocumentExtractionOptions_
	//	*TrainProcessorVersionRequest_FoundationModelTuningOptions_
	ProcessorFlags isTrainProcessorVersionRequest_ProcessorFlags `protobuf_oneof:"processor_flags"`
	// Required. The parent (project, location and processor) to create the new
	// version for. Format:
	// `projects/{project}/locations/{location}/processors/{processor}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The processor version to be created.
	ProcessorVersion *ProcessorVersion `protobuf:"bytes,2,opt,name=processor_version,json=processorVersion,proto3" json:"processor_version,omitempty"`
	// Optional. The schema the processor version will be trained with.
	DocumentSchema *DocumentSchema `protobuf:"bytes,10,opt,name=document_schema,json=documentSchema,proto3" json:"document_schema,omitempty"`
	// Optional. The input data used to train the
	// [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion].
	InputData *TrainProcessorVersionRequest_InputData `protobuf:"bytes,4,opt,name=input_data,json=inputData,proto3" json:"input_data,omitempty"`
	// Optional. The processor version to use as a base for training. This
	// processor version must be a child of `parent`. Format:
	// `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.
	BaseProcessorVersion string `protobuf:"bytes,8,opt,name=base_processor_version,json=baseProcessorVersion,proto3" json:"base_processor_version,omitempty"`
	// contains filtered or unexported fields
}

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

func (*TrainProcessorVersionRequest) Descriptor

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

Deprecated: Use TrainProcessorVersionRequest.ProtoReflect.Descriptor instead.

func (*TrainProcessorVersionRequest) GetBaseProcessorVersion

func (x *TrainProcessorVersionRequest) GetBaseProcessorVersion() string

func (*TrainProcessorVersionRequest) GetCustomDocumentExtractionOptions

func (x *TrainProcessorVersionRequest) GetCustomDocumentExtractionOptions() *TrainProcessorVersionRequest_CustomDocumentExtractionOptions

func (*TrainProcessorVersionRequest) GetDocumentSchema

func (x *TrainProcessorVersionRequest) GetDocumentSchema() *DocumentSchema

func (*TrainProcessorVersionRequest) GetFoundationModelTuningOptions

func (x *TrainProcessorVersionRequest) GetFoundationModelTuningOptions() *TrainProcessorVersionRequest_FoundationModelTuningOptions

func (*TrainProcessorVersionRequest) GetInputData

func (x *TrainProcessorVersionRequest) GetInputData() *TrainProcessorVersionRequest_InputData

func (*TrainProcessorVersionRequest) GetParent

func (x *TrainProcessorVersionRequest) GetParent() string

func (*TrainProcessorVersionRequest) GetProcessorFlags

func (m *TrainProcessorVersionRequest) GetProcessorFlags() isTrainProcessorVersionRequest_ProcessorFlags

func (*TrainProcessorVersionRequest) GetProcessorVersion

func (x *TrainProcessorVersionRequest) GetProcessorVersion() *ProcessorVersion

func (*TrainProcessorVersionRequest) ProtoMessage

func (*TrainProcessorVersionRequest) ProtoMessage()

func (*TrainProcessorVersionRequest) ProtoReflect

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

func (*TrainProcessorVersionRequest) Reset

func (x *TrainProcessorVersionRequest) Reset()

func (*TrainProcessorVersionRequest) String

func (x *TrainProcessorVersionRequest) String() string

TrainProcessorVersionRequest_CustomDocumentExtractionOptions

type TrainProcessorVersionRequest_CustomDocumentExtractionOptions struct {

	// Optional. Training method to use for CDE training.
	TrainingMethod TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TrainingMethod `protobuf:"varint,3,opt,name=training_method,json=trainingMethod,proto3,enum=google.cloud.documentai.v1beta3.TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TrainingMethod" json:"training_method,omitempty"`
	// contains filtered or unexported fields
}

Options to control the training of the Custom Document Extraction (CDE) Processor.

func (*TrainProcessorVersionRequest_CustomDocumentExtractionOptions) Descriptor

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

Deprecated: Use TrainProcessorVersionRequest_CustomDocumentExtractionOptions.ProtoReflect.Descriptor instead.

func (*TrainProcessorVersionRequest_CustomDocumentExtractionOptions) GetTrainingMethod

func (x *TrainProcessorVersionRequest_CustomDocumentExtractionOptions) GetTrainingMethod() TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TrainingMethod

func (*TrainProcessorVersionRequest_CustomDocumentExtractionOptions) ProtoMessage

func (*TrainProcessorVersionRequest_CustomDocumentExtractionOptions) ProtoMessage()

func (*TrainProcessorVersionRequest_CustomDocumentExtractionOptions) ProtoReflect

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

func (*TrainProcessorVersionRequest_CustomDocumentExtractionOptions) Reset

func (x *TrainProcessorVersionRequest_CustomDocumentExtractionOptions) Reset()

func (*TrainProcessorVersionRequest_CustomDocumentExtractionOptions) String

func (x *TrainProcessorVersionRequest_CustomDocumentExtractionOptions) String() string

TrainProcessorVersionRequest_CustomDocumentExtractionOptions_

type TrainProcessorVersionRequest_CustomDocumentExtractionOptions_ struct {
	// Options to control Custom Document Extraction (CDE) Processor.
	CustomDocumentExtractionOptions *TrainProcessorVersionRequest_CustomDocumentExtractionOptions `protobuf:"bytes,5,opt,name=custom_document_extraction_options,json=customDocumentExtractionOptions,proto3,oneof"`
}

TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TrainingMethod

type TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TrainingMethod int32

Training Method for CDE. TRAINING_METHOD_UNSPECIFIED will fall back to MODEL_BASED.

TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TRAINING_METHOD_UNSPECIFIED, TrainProcessorVersionRequest_CustomDocumentExtractionOptions_MODEL_BASED, TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TEMPLATE_BASED

const (
	TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TRAINING_METHOD_UNSPECIFIED TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TrainingMethod = 0
	TrainProcessorVersionRequest_CustomDocumentExtractionOptions_MODEL_BASED                 TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TrainingMethod = 1
	TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TEMPLATE_BASED              TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TrainingMethod = 2
)

func (TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TrainingMethod) Descriptor

func (TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TrainingMethod) Descriptor() protoreflect.EnumDescriptor

func (TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TrainingMethod) Enum

func (x TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TrainingMethod) Enum() *TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TrainingMethod

func (TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TrainingMethod) EnumDescriptor

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

Deprecated: Use TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TrainingMethod.Descriptor instead.

func (TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TrainingMethod) Number

func (x TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TrainingMethod) Number() protoreflect.EnumNumber

func (TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TrainingMethod) String

func (x TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TrainingMethod) String() string

func (TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TrainingMethod) Type

func (TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TrainingMethod) Type() protoreflect.EnumType

TrainProcessorVersionRequest_FoundationModelTuningOptions

type TrainProcessorVersionRequest_FoundationModelTuningOptions struct {

	// Optional. The number of steps to run for model tuning. Valid values are
	// between 1 and 400. If not provided, recommended steps will be used.
	TrainSteps int32 `protobuf:"varint,2,opt,name=train_steps,json=trainSteps,proto3" json:"train_steps,omitempty"`
	// Optional. The multiplier to apply to the recommended learning rate. Valid
	// values are between 0.1 and 10. If not provided, recommended learning rate
	// will be used.
	LearningRateMultiplier float32 `protobuf:"fixed32,3,opt,name=learning_rate_multiplier,json=learningRateMultiplier,proto3" json:"learning_rate_multiplier,omitempty"`
	// contains filtered or unexported fields
}

Options to control foundation model tuning of the processor.

func (*TrainProcessorVersionRequest_FoundationModelTuningOptions) Descriptor

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

Deprecated: Use TrainProcessorVersionRequest_FoundationModelTuningOptions.ProtoReflect.Descriptor instead.

func (*TrainProcessorVersionRequest_FoundationModelTuningOptions) GetLearningRateMultiplier

func (x *TrainProcessorVersionRequest_FoundationModelTuningOptions) GetLearningRateMultiplier() float32

func (*TrainProcessorVersionRequest_FoundationModelTuningOptions) GetTrainSteps

func (x *TrainProcessorVersionRequest_FoundationModelTuningOptions) GetTrainSteps() int32

func (*TrainProcessorVersionRequest_FoundationModelTuningOptions) ProtoMessage

func (*TrainProcessorVersionRequest_FoundationModelTuningOptions) ProtoMessage()

func (*TrainProcessorVersionRequest_FoundationModelTuningOptions) ProtoReflect

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

func (*TrainProcessorVersionRequest_FoundationModelTuningOptions) Reset

func (x *TrainProcessorVersionRequest_FoundationModelTuningOptions) Reset()

func (*TrainProcessorVersionRequest_FoundationModelTuningOptions) String

func (x *TrainProcessorVersionRequest_FoundationModelTuningOptions) String() string

TrainProcessorVersionRequest_FoundationModelTuningOptions_

type TrainProcessorVersionRequest_FoundationModelTuningOptions_ struct {
	// Options to control foundation model tuning of a processor.
	FoundationModelTuningOptions *TrainProcessorVersionRequest_FoundationModelTuningOptions `protobuf:"bytes,12,opt,name=foundation_model_tuning_options,json=foundationModelTuningOptions,proto3,oneof"`
}

TrainProcessorVersionRequest_InputData

type TrainProcessorVersionRequest_InputData struct {

	// The documents used for training the new version.
	TrainingDocuments *BatchDocumentsInputConfig `protobuf:"bytes,3,opt,name=training_documents,json=trainingDocuments,proto3" json:"training_documents,omitempty"`
	// The documents used for testing the trained version.
	TestDocuments *BatchDocumentsInputConfig `protobuf:"bytes,4,opt,name=test_documents,json=testDocuments,proto3" json:"test_documents,omitempty"`
	// contains filtered or unexported fields
}

The input data used to train a new [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion].

func (*TrainProcessorVersionRequest_InputData) Descriptor

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

Deprecated: Use TrainProcessorVersionRequest_InputData.ProtoReflect.Descriptor instead.

func (*TrainProcessorVersionRequest_InputData) GetTestDocuments

func (x *TrainProcessorVersionRequest_InputData) GetTestDocuments() *BatchDocumentsInputConfig

func (*TrainProcessorVersionRequest_InputData) GetTrainingDocuments

func (x *TrainProcessorVersionRequest_InputData) GetTrainingDocuments() *BatchDocumentsInputConfig

func (*TrainProcessorVersionRequest_InputData) ProtoMessage

func (*TrainProcessorVersionRequest_InputData) ProtoMessage()

func (*TrainProcessorVersionRequest_InputData) ProtoReflect

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

func (*TrainProcessorVersionRequest_InputData) Reset

func (x *TrainProcessorVersionRequest_InputData) Reset()

func (*TrainProcessorVersionRequest_InputData) String

func (x *TrainProcessorVersionRequest_InputData) String() string

TrainProcessorVersionResponse

type TrainProcessorVersionResponse struct {

	// The resource name of the processor version produced by training.
	ProcessorVersion string `protobuf:"bytes,1,opt,name=processor_version,json=processorVersion,proto3" json:"processor_version,omitempty"`
	// contains filtered or unexported fields
}

The response for [TrainProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.TrainProcessorVersion].

func (*TrainProcessorVersionResponse) Descriptor

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

Deprecated: Use TrainProcessorVersionResponse.ProtoReflect.Descriptor instead.

func (*TrainProcessorVersionResponse) GetProcessorVersion

func (x *TrainProcessorVersionResponse) GetProcessorVersion() string

func (*TrainProcessorVersionResponse) ProtoMessage

func (*TrainProcessorVersionResponse) ProtoMessage()

func (*TrainProcessorVersionResponse) ProtoReflect

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

func (*TrainProcessorVersionResponse) Reset

func (x *TrainProcessorVersionResponse) Reset()

func (*TrainProcessorVersionResponse) String

func (x *TrainProcessorVersionResponse) String() string

UndeployProcessorVersionMetadata

type UndeployProcessorVersionMetadata 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 [UndeployProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.UndeployProcessorVersion] method.

func (*UndeployProcessorVersionMetadata) Descriptor

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

Deprecated: Use UndeployProcessorVersionMetadata.ProtoReflect.Descriptor instead.

func (*UndeployProcessorVersionMetadata) GetCommonMetadata

func (x *UndeployProcessorVersionMetadata) GetCommonMetadata() *CommonOperationMetadata

func (*UndeployProcessorVersionMetadata) ProtoMessage

func (*UndeployProcessorVersionMetadata) ProtoMessage()

func (*UndeployProcessorVersionMetadata) ProtoReflect

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

func (*UndeployProcessorVersionMetadata) Reset

func (x *UndeployProcessorVersionMetadata) Reset()

func (*UndeployProcessorVersionMetadata) String

func (x *UndeployProcessorVersionMetadata) String() string

UndeployProcessorVersionRequest

type UndeployProcessorVersionRequest struct {

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

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

func (*UndeployProcessorVersionRequest) Descriptor

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

Deprecated: Use UndeployProcessorVersionRequest.ProtoReflect.Descriptor instead.

func (*UndeployProcessorVersionRequest) GetName

func (x *UndeployProcessorVersionRequest) GetName() string

func (*UndeployProcessorVersionRequest) ProtoMessage

func (*UndeployProcessorVersionRequest) ProtoMessage()

func (*UndeployProcessorVersionRequest) ProtoReflect

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

func (*UndeployProcessorVersionRequest) Reset

func (x *UndeployProcessorVersionRequest) Reset()

func (*UndeployProcessorVersionRequest) String

func (x *UndeployProcessorVersionRequest) String() string

UndeployProcessorVersionResponse

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

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

func (*UndeployProcessorVersionResponse) Descriptor

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

Deprecated: Use UndeployProcessorVersionResponse.ProtoReflect.Descriptor instead.

func (*UndeployProcessorVersionResponse) ProtoMessage

func (*UndeployProcessorVersionResponse) ProtoMessage()

func (*UndeployProcessorVersionResponse) ProtoReflect

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

func (*UndeployProcessorVersionResponse) Reset

func (x *UndeployProcessorVersionResponse) Reset()

func (*UndeployProcessorVersionResponse) String

func (x *UndeployProcessorVersionResponse) String() string

UnimplementedDocumentProcessorServiceServer

type UnimplementedDocumentProcessorServiceServer struct {
}

UnimplementedDocumentProcessorServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedDocumentProcessorServiceServer) BatchProcessDocuments

func (UnimplementedDocumentProcessorServiceServer) BatchProcessDocuments(context.Context, *BatchProcessRequest) (*longrunningpb.Operation, error)

func (UnimplementedDocumentProcessorServiceServer) CreateProcessor

func (UnimplementedDocumentProcessorServiceServer) CreateProcessor(context.Context, *CreateProcessorRequest) (*Processor, error)

func (UnimplementedDocumentProcessorServiceServer) DeleteProcessor

func (UnimplementedDocumentProcessorServiceServer) DeleteProcessor(context.Context, *DeleteProcessorRequest) (*longrunningpb.Operation, error)

func (UnimplementedDocumentProcessorServiceServer) DeleteProcessorVersion

func (UnimplementedDocumentProcessorServiceServer) DeleteProcessorVersion(context.Context, *DeleteProcessorVersionRequest) (*longrunningpb.Operation, error)

func (UnimplementedDocumentProcessorServiceServer) DeployProcessorVersion

func (UnimplementedDocumentProcessorServiceServer) DeployProcessorVersion(context.Context, *DeployProcessorVersionRequest) (*longrunningpb.Operation, error)

func (UnimplementedDocumentProcessorServiceServer) DisableProcessor

func (UnimplementedDocumentProcessorServiceServer) DisableProcessor(context.Context, *DisableProcessorRequest) (*longrunningpb.Operation, error)

func (UnimplementedDocumentProcessorServiceServer) EnableProcessor

func (UnimplementedDocumentProcessorServiceServer) EnableProcessor(context.Context, *EnableProcessorRequest) (*longrunningpb.Operation, error)

func (UnimplementedDocumentProcessorServiceServer) EvaluateProcessorVersion

func (UnimplementedDocumentProcessorServiceServer) EvaluateProcessorVersion(context.Context, *EvaluateProcessorVersionRequest) (*longrunningpb.Operation, error)

func (UnimplementedDocumentProcessorServiceServer) FetchProcessorTypes

func (UnimplementedDocumentProcessorServiceServer) FetchProcessorTypes(context.Context, *FetchProcessorTypesRequest) (*FetchProcessorTypesResponse, error)

func (UnimplementedDocumentProcessorServiceServer) GetEvaluation

func (UnimplementedDocumentProcessorServiceServer) GetEvaluation(context.Context, *GetEvaluationRequest) (*Evaluation, error)

func (UnimplementedDocumentProcessorServiceServer) GetProcessor

func (UnimplementedDocumentProcessorServiceServer) GetProcessor(context.Context, *GetProcessorRequest) (*Processor, error)

func (UnimplementedDocumentProcessorServiceServer) GetProcessorType

func (UnimplementedDocumentProcessorServiceServer) GetProcessorType(context.Context, *GetProcessorTypeRequest) (*ProcessorType, error)

func (UnimplementedDocumentProcessorServiceServer) GetProcessorVersion

func (UnimplementedDocumentProcessorServiceServer) GetProcessorVersion(context.Context, *GetProcessorVersionRequest) (*ProcessorVersion, error)

func (UnimplementedDocumentProcessorServiceServer) ImportProcessorVersion

func (UnimplementedDocumentProcessorServiceServer) ImportProcessorVersion(context.Context, *ImportProcessorVersionRequest) (*longrunningpb.Operation, error)

func (UnimplementedDocumentProcessorServiceServer) ListEvaluations

func (UnimplementedDocumentProcessorServiceServer) ListEvaluations(context.Context, *ListEvaluationsRequest) (*ListEvaluationsResponse, error)

func (UnimplementedDocumentProcessorServiceServer) ListProcessorTypes

func (UnimplementedDocumentProcessorServiceServer) ListProcessorTypes(context.Context, *ListProcessorTypesRequest) (*ListProcessorTypesResponse, error)

func (UnimplementedDocumentProcessorServiceServer) ListProcessorVersions

func (UnimplementedDocumentProcessorServiceServer) ListProcessorVersions(context.Context, *ListProcessorVersionsRequest) (*ListProcessorVersionsResponse, error)

func (UnimplementedDocumentProcessorServiceServer) ListProcessors

func (UnimplementedDocumentProcessorServiceServer) ListProcessors(context.Context, *ListProcessorsRequest) (*ListProcessorsResponse, error)

func (UnimplementedDocumentProcessorServiceServer) ProcessDocument

func (UnimplementedDocumentProcessorServiceServer) ProcessDocument(context.Context, *ProcessRequest) (*ProcessResponse, error)

func (UnimplementedDocumentProcessorServiceServer) ReviewDocument

func (UnimplementedDocumentProcessorServiceServer) ReviewDocument(context.Context, *ReviewDocumentRequest) (*longrunningpb.Operation, error)

func (UnimplementedDocumentProcessorServiceServer) SetDefaultProcessorVersion

func (UnimplementedDocumentProcessorServiceServer) SetDefaultProcessorVersion(context.Context, *SetDefaultProcessorVersionRequest) (*longrunningpb.Operation, error)

func (UnimplementedDocumentProcessorServiceServer) TrainProcessorVersion

func (UnimplementedDocumentProcessorServiceServer) TrainProcessorVersion(context.Context, *TrainProcessorVersionRequest) (*longrunningpb.Operation, error)

func (UnimplementedDocumentProcessorServiceServer) UndeployProcessorVersion

func (UnimplementedDocumentProcessorServiceServer) UndeployProcessorVersion(context.Context, *UndeployProcessorVersionRequest) (*longrunningpb.Operation, error)

UnimplementedDocumentServiceServer

type UnimplementedDocumentServiceServer struct {
}

UnimplementedDocumentServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedDocumentServiceServer) BatchDeleteDocuments

func (UnimplementedDocumentServiceServer) BatchDeleteDocuments(context.Context, *BatchDeleteDocumentsRequest) (*longrunningpb.Operation, error)

func (UnimplementedDocumentServiceServer) GetDatasetSchema

func (UnimplementedDocumentServiceServer) GetDatasetSchema(context.Context, *GetDatasetSchemaRequest) (*DatasetSchema, error)

func (UnimplementedDocumentServiceServer) GetDocument

func (UnimplementedDocumentServiceServer) GetDocument(context.Context, *GetDocumentRequest) (*GetDocumentResponse, error)

func (UnimplementedDocumentServiceServer) ImportDocuments

func (UnimplementedDocumentServiceServer) ImportDocuments(context.Context, *ImportDocumentsRequest) (*longrunningpb.Operation, error)

func (UnimplementedDocumentServiceServer) ListDocuments

func (UnimplementedDocumentServiceServer) ListDocuments(context.Context, *ListDocumentsRequest) (*ListDocumentsResponse, error)

func (UnimplementedDocumentServiceServer) UpdateDataset

func (UnimplementedDocumentServiceServer) UpdateDataset(context.Context, *UpdateDatasetRequest) (*longrunningpb.Operation, error)

func (UnimplementedDocumentServiceServer) UpdateDatasetSchema

func (UnimplementedDocumentServiceServer) UpdateDatasetSchema(context.Context, *UpdateDatasetSchemaRequest) (*DatasetSchema, error)

UnsafeDocumentProcessorServiceServer

type UnsafeDocumentProcessorServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeDocumentProcessorServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to DocumentProcessorServiceServer will result in compilation errors.

UnsafeDocumentServiceServer

type UnsafeDocumentServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeDocumentServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to DocumentServiceServer will result in compilation errors.

UpdateDatasetOperationMetadata

type UpdateDatasetOperationMetadata 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
}

func (*UpdateDatasetOperationMetadata) Descriptor

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

Deprecated: Use UpdateDatasetOperationMetadata.ProtoReflect.Descriptor instead.

func (*UpdateDatasetOperationMetadata) GetCommonMetadata

func (x *UpdateDatasetOperationMetadata) GetCommonMetadata() *CommonOperationMetadata

func (*UpdateDatasetOperationMetadata) ProtoMessage

func (*UpdateDatasetOperationMetadata) ProtoMessage()

func (*UpdateDatasetOperationMetadata) ProtoReflect

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

func (*UpdateDatasetOperationMetadata) Reset

func (x *UpdateDatasetOperationMetadata) Reset()

func (*UpdateDatasetOperationMetadata) String

func (x *UpdateDatasetOperationMetadata) String() string

UpdateDatasetRequest

type UpdateDatasetRequest struct {

	// Required. The `name` field of the `Dataset` is used to identify the
	// resource to be updated.
	Dataset *Dataset `protobuf:"bytes,1,opt,name=dataset,proto3" json:"dataset,omitempty"`
	// The update mask applies to the resource.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateDatasetRequest) Descriptor

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

Deprecated: Use UpdateDatasetRequest.ProtoReflect.Descriptor instead.

func (*UpdateDatasetRequest) GetDataset

func (x *UpdateDatasetRequest) GetDataset() *Dataset

func (*UpdateDatasetRequest) GetUpdateMask

func (x *UpdateDatasetRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateDatasetRequest) ProtoMessage

func (*UpdateDatasetRequest) ProtoMessage()

func (*UpdateDatasetRequest) ProtoReflect

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

func (*UpdateDatasetRequest) Reset

func (x *UpdateDatasetRequest) Reset()

func (*UpdateDatasetRequest) String

func (x *UpdateDatasetRequest) String() string

UpdateDatasetSchemaRequest

type UpdateDatasetSchemaRequest struct {

	// Required. The name field of the `DatasetSchema` is used to identify the
	// resource to be updated.
	DatasetSchema *DatasetSchema `protobuf:"bytes,1,opt,name=dataset_schema,json=datasetSchema,proto3" json:"dataset_schema,omitempty"`
	// The update mask applies to the resource.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request for UpdateDatasetSchema.

func (*UpdateDatasetSchemaRequest) Descriptor

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

Deprecated: Use UpdateDatasetSchemaRequest.ProtoReflect.Descriptor instead.

func (*UpdateDatasetSchemaRequest) GetDatasetSchema

func (x *UpdateDatasetSchemaRequest) GetDatasetSchema() *DatasetSchema

func (*UpdateDatasetSchemaRequest) GetUpdateMask

func (x *UpdateDatasetSchemaRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateDatasetSchemaRequest) ProtoMessage

func (*UpdateDatasetSchemaRequest) ProtoMessage()

func (*UpdateDatasetSchemaRequest) ProtoReflect

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

func (*UpdateDatasetSchemaRequest) Reset

func (x *UpdateDatasetSchemaRequest) Reset()

func (*UpdateDatasetSchemaRequest) String

func (x *UpdateDatasetSchemaRequest) String() string

Vertex

type Vertex struct {

	// X coordinate.
	X int32 `protobuf:"varint,1,opt,name=x,proto3" json:"x,omitempty"`
	// Y coordinate (starts from the top of the image).
	Y int32 `protobuf:"varint,2,opt,name=y,proto3" json:"y,omitempty"`
	// contains filtered or unexported fields
}

A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

func (*Vertex) Descriptor

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

Deprecated: Use Vertex.ProtoReflect.Descriptor instead.

func (*Vertex) GetX

func (x *Vertex) GetX() int32

func (*Vertex) GetY

func (x *Vertex) GetY() int32

func (*Vertex) ProtoMessage

func (*Vertex) ProtoMessage()

func (*Vertex) ProtoReflect

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

func (*Vertex) Reset

func (x *Vertex) Reset()

func (*Vertex) String

func (x *Vertex) String() string