Variables
Document_Page_Layout_Orientation_name, Document_Page_Layout_Orientation_value
var (
Document_Page_Layout_Orientation_name = map[int32]string{
0: "ORIENTATION_UNSPECIFIED",
1: "PAGE_UP",
2: "PAGE_RIGHT",
3: "PAGE_DOWN",
4: "PAGE_LEFT",
}
Document_Page_Layout_Orientation_value = map[string]int32{
"ORIENTATION_UNSPECIFIED": 0,
"PAGE_UP": 1,
"PAGE_RIGHT": 2,
"PAGE_DOWN": 3,
"PAGE_LEFT": 4,
}
)Enum value maps for Document_Page_Layout_Orientation.
Document_Page_Token_DetectedBreak_Type_name, Document_Page_Token_DetectedBreak_Type_value
var (
Document_Page_Token_DetectedBreak_Type_name = map[int32]string{
0: "TYPE_UNSPECIFIED",
1: "SPACE",
2: "WIDE_SPACE",
3: "HYPHEN",
}
Document_Page_Token_DetectedBreak_Type_value = map[string]int32{
"TYPE_UNSPECIFIED": 0,
"SPACE": 1,
"WIDE_SPACE": 2,
"HYPHEN": 3,
}
)Enum value maps for Document_Page_Token_DetectedBreak_Type.
Document_PageAnchor_PageRef_LayoutType_name, Document_PageAnchor_PageRef_LayoutType_value
var (
Document_PageAnchor_PageRef_LayoutType_name = map[int32]string{
0: "LAYOUT_TYPE_UNSPECIFIED",
1: "BLOCK",
2: "PARAGRAPH",
3: "LINE",
4: "TOKEN",
5: "VISUAL_ELEMENT",
6: "TABLE",
7: "FORM_FIELD",
}
Document_PageAnchor_PageRef_LayoutType_value = map[string]int32{
"LAYOUT_TYPE_UNSPECIFIED": 0,
"BLOCK": 1,
"PARAGRAPH": 2,
"LINE": 3,
"TOKEN": 4,
"VISUAL_ELEMENT": 5,
"TABLE": 6,
"FORM_FIELD": 7,
}
)Enum value maps for Document_PageAnchor_PageRef_LayoutType.
Document_Provenance_OperationType_name, Document_Provenance_OperationType_value
var (
Document_Provenance_OperationType_name = map[int32]string{
0: "OPERATION_TYPE_UNSPECIFIED",
1: "ADD",
2: "REMOVE",
7: "UPDATE",
3: "REPLACE",
4: "EVAL_REQUESTED",
5: "EVAL_APPROVED",
6: "EVAL_SKIPPED",
}
Document_Provenance_OperationType_value = map[string]int32{
"OPERATION_TYPE_UNSPECIFIED": 0,
"ADD": 1,
"REMOVE": 2,
"UPDATE": 7,
"REPLACE": 3,
"EVAL_REQUESTED": 4,
"EVAL_APPROVED": 5,
"EVAL_SKIPPED": 6,
}
)Enum value maps for Document_Provenance_OperationType.
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.
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.
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.
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",
}
ProcessorVersion_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"DEPLOYED": 1,
"DEPLOYING": 2,
"UNDEPLOYED": 3,
"UNDEPLOYING": 4,
"CREATING": 5,
"DELETING": 6,
"FAILED": 7,
}
)Enum value maps for ProcessorVersion_State.
Processor_State_name, Processor_State_value
var (
Processor_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "ENABLED",
2: "DISABLED",
3: "ENABLING",
4: "DISABLING",
5: "CREATING",
6: "FAILED",
7: "DELETING",
}
Processor_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"ENABLED": 1,
"DISABLED": 2,
"ENABLING": 3,
"DISABLING": 4,
"CREATING": 5,
"FAILED": 6,
"DELETING": 7,
}
)Enum value maps for Processor_State.
File_google_cloud_documentai_v1beta3_barcode_proto
var File_google_cloud_documentai_v1beta3_barcode_proto protoreflect.FileDescriptorFile_google_cloud_documentai_v1beta3_document_io_proto
var File_google_cloud_documentai_v1beta3_document_io_proto protoreflect.FileDescriptorFile_google_cloud_documentai_v1beta3_document_processor_service_proto
var File_google_cloud_documentai_v1beta3_document_processor_service_proto protoreflect.FileDescriptorFile_google_cloud_documentai_v1beta3_document_proto
var File_google_cloud_documentai_v1beta3_document_proto protoreflect.FileDescriptorFile_google_cloud_documentai_v1beta3_document_schema_proto
var File_google_cloud_documentai_v1beta3_document_schema_proto protoreflect.FileDescriptorFile_google_cloud_documentai_v1beta3_evaluation_proto
var File_google_cloud_documentai_v1beta3_evaluation_proto protoreflect.FileDescriptorFile_google_cloud_documentai_v1beta3_geometry_proto
var File_google_cloud_documentai_v1beta3_geometry_proto protoreflect.FileDescriptorFile_google_cloud_documentai_v1beta3_operation_metadata_proto
var File_google_cloud_documentai_v1beta3_operation_metadata_proto protoreflect.FileDescriptorFile_google_cloud_documentai_v1beta3_processor_proto
var File_google_cloud_documentai_v1beta3_processor_proto protoreflect.FileDescriptorFile_google_cloud_documentai_v1beta3_processor_type_proto
var File_google_cloud_documentai_v1beta3_processor_type_proto protoreflect.FileDescriptorFunctions
func RegisterDocumentProcessorServiceServer
func RegisterDocumentProcessorServiceServer(s *grpc.Server, srv DocumentProcessorServiceServer)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
Deprecated: Use Barcode.ProtoReflect.Descriptor instead.
func (*Barcode) GetFormat
func (*Barcode) GetRawValue
func (*Barcode) GetValueFormat
func (*Barcode) ProtoMessage
func (*Barcode) ProtoMessage()func (*Barcode) ProtoReflect
func (x *Barcode) ProtoReflect() protoreflect.Messagefunc (*Barcode) Reset
func (x *Barcode) Reset()func (*Barcode) String
BatchDocumentsInputConfig
type BatchDocumentsInputConfig struct {
// The source.
//
// Types that are assignable to Source:
// *BatchDocumentsInputConfig_GcsPrefix
// *BatchDocumentsInputConfig_GcsDocuments
Source isBatchDocumentsInputConfig_Source `protobuf_oneof:"source"`
// contains filtered or unexported fields
}The common config to specify a set of documents used as input.
func (*BatchDocumentsInputConfig) Descriptor
func (*BatchDocumentsInputConfig) Descriptor() ([]byte, []int)Deprecated: Use BatchDocumentsInputConfig.ProtoReflect.Descriptor instead.
func (*BatchDocumentsInputConfig) GetGcsDocuments
func (x *BatchDocumentsInputConfig) GetGcsDocuments() *GcsDocumentsfunc (*BatchDocumentsInputConfig) GetGcsPrefix
func (x *BatchDocumentsInputConfig) GetGcsPrefix() *GcsPrefixfunc (*BatchDocumentsInputConfig) GetSource
func (m *BatchDocumentsInputConfig) GetSource() isBatchDocumentsInputConfig_Sourcefunc (*BatchDocumentsInputConfig) ProtoMessage
func (*BatchDocumentsInputConfig) ProtoMessage()func (*BatchDocumentsInputConfig) ProtoReflect
func (x *BatchDocumentsInputConfig) ProtoReflect() protoreflect.Messagefunc (*BatchDocumentsInputConfig) Reset
func (x *BatchDocumentsInputConfig) Reset()func (*BatchDocumentsInputConfig) String
func (x *BatchDocumentsInputConfig) String() stringBatchDocumentsInputConfig_GcsDocuments
type BatchDocumentsInputConfig_GcsDocuments struct {
// The set of documents individually specified on Cloud Storage.
GcsDocuments *GcsDocuments `protobuf:"bytes,2,opt,name=gcs_documents,json=gcsDocuments,proto3,oneof"`
}BatchDocumentsInputConfig_GcsPrefix
type BatchDocumentsInputConfig_GcsPrefix struct {
// The set of documents that match the specified Cloud Storage `gcs_prefix`.
GcsPrefix *GcsPrefix `protobuf:"bytes,1,opt,name=gcs_prefix,json=gcsPrefix,proto3,oneof"`
}BatchProcessMetadata
type BatchProcessMetadata struct {
State BatchProcessMetadata_State "" /* 128 byte string literal not displayed */
StateMessage string `protobuf:"bytes,2,opt,name=state_message,json=stateMessage,proto3" json:"state_message,omitempty"`
CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
IndividualProcessStatuses []*BatchProcessMetadata_IndividualProcessStatus "" /* 138 byte string literal not displayed */
}The long running operation metadata for batch process method.
func (*BatchProcessMetadata) Descriptor
func (*BatchProcessMetadata) Descriptor() ([]byte, []int)Deprecated: Use BatchProcessMetadata.ProtoReflect.Descriptor instead.
func (*BatchProcessMetadata) GetCreateTime
func (x *BatchProcessMetadata) GetCreateTime() *timestamppb.Timestampfunc (*BatchProcessMetadata) GetIndividualProcessStatuses
func (x *BatchProcessMetadata) GetIndividualProcessStatuses() []*BatchProcessMetadata_IndividualProcessStatusfunc (*BatchProcessMetadata) GetState
func (x *BatchProcessMetadata) GetState() BatchProcessMetadata_Statefunc (*BatchProcessMetadata) GetStateMessage
func (x *BatchProcessMetadata) GetStateMessage() stringfunc (*BatchProcessMetadata) GetUpdateTime
func (x *BatchProcessMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*BatchProcessMetadata) ProtoMessage
func (*BatchProcessMetadata) ProtoMessage()func (*BatchProcessMetadata) ProtoReflect
func (x *BatchProcessMetadata) ProtoReflect() protoreflect.Messagefunc (*BatchProcessMetadata) Reset
func (x *BatchProcessMetadata) Reset()func (*BatchProcessMetadata) String
func (x *BatchProcessMetadata) String() stringBatchProcessMetadata_IndividualProcessStatus
type BatchProcessMetadata_IndividualProcessStatus struct {
// The source of the document, same as the [input_gcs_source] field in the
// request when the batch process started. The batch process is started by
// take snapshot of that document, since a user can move or change that
// document during the process.
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 output_gcs_destination (in the request as `output_gcs_destination`)
// 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 is not triggered, this field will be empty. It has
// the same response type and metadata as the long running operation
// returned by 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() stringDeprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document_processor_service.proto.
func (*BatchProcessMetadata_IndividualProcessStatus) GetHumanReviewStatus
func (x *BatchProcessMetadata_IndividualProcessStatus) GetHumanReviewStatus() *HumanReviewStatusfunc (*BatchProcessMetadata_IndividualProcessStatus) GetInputGcsSource
func (x *BatchProcessMetadata_IndividualProcessStatus) GetInputGcsSource() stringfunc (*BatchProcessMetadata_IndividualProcessStatus) GetOutputGcsDestination
func (x *BatchProcessMetadata_IndividualProcessStatus) GetOutputGcsDestination() stringfunc (*BatchProcessMetadata_IndividualProcessStatus) GetStatus
func (x *BatchProcessMetadata_IndividualProcessStatus) GetStatus() *status.Statusfunc (*BatchProcessMetadata_IndividualProcessStatus) ProtoMessage
func (*BatchProcessMetadata_IndividualProcessStatus) ProtoMessage()func (*BatchProcessMetadata_IndividualProcessStatus) ProtoReflect
func (x *BatchProcessMetadata_IndividualProcessStatus) ProtoReflect() protoreflect.Messagefunc (*BatchProcessMetadata_IndividualProcessStatus) Reset
func (x *BatchProcessMetadata_IndividualProcessStatus) Reset()func (*BatchProcessMetadata_IndividualProcessStatus) String
func (x *BatchProcessMetadata_IndividualProcessStatus) String() stringBatchProcessMetadata_State
type BatchProcessMetadata_State int32Possible 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.EnumDescriptorfunc (BatchProcessMetadata_State) Enum
func (x BatchProcessMetadata_State) Enum() *BatchProcessMetadata_Statefunc (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.EnumNumberfunc (BatchProcessMetadata_State) String
func (x BatchProcessMetadata_State) String() stringfunc (BatchProcessMetadata_State) Type
func (BatchProcessMetadata_State) Type() protoreflect.EnumTypeBatchProcessRequest
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 batch process.
InputDocuments *BatchDocumentsInputConfig `protobuf:"bytes,5,opt,name=input_documents,json=inputDocuments,proto3" json:"input_documents,omitempty"`
// The overall output config for batch process.
DocumentOutputConfig *DocumentOutputConfig `protobuf:"bytes,6,opt,name=document_output_config,json=documentOutputConfig,proto3" json:"document_output_config,omitempty"`
// Whether Human Review feature should be skipped for this request. Default to
// false.
SkipHumanReview bool `protobuf:"varint,4,opt,name=skip_human_review,json=skipHumanReview,proto3" json:"skip_human_review,omitempty"`
// Inference-time options for the process API
ProcessOptions *ProcessOptions `protobuf:"bytes,7,opt,name=process_options,json=processOptions,proto3" json:"process_options,omitempty"`
// contains filtered or unexported fields
}Request message for batch process document method.
func (*BatchProcessRequest) Descriptor
func (*BatchProcessRequest) Descriptor() ([]byte, []int)Deprecated: Use BatchProcessRequest.ProtoReflect.Descriptor instead.
func (*BatchProcessRequest) GetDocumentOutputConfig
func (x *BatchProcessRequest) GetDocumentOutputConfig() *DocumentOutputConfigfunc (*BatchProcessRequest) GetInputConfigs
func (x *BatchProcessRequest) GetInputConfigs() []*BatchProcessRequest_BatchInputConfigDeprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document_processor_service.proto.
func (*BatchProcessRequest) GetInputDocuments
func (x *BatchProcessRequest) GetInputDocuments() *BatchDocumentsInputConfigfunc (*BatchProcessRequest) GetName
func (x *BatchProcessRequest) GetName() stringfunc (*BatchProcessRequest) GetOutputConfig
func (x *BatchProcessRequest) GetOutputConfig() *BatchProcessRequest_BatchOutputConfigDeprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document_processor_service.proto.
func (*BatchProcessRequest) GetProcessOptions
func (x *BatchProcessRequest) GetProcessOptions() *ProcessOptionsfunc (*BatchProcessRequest) GetSkipHumanReview
func (x *BatchProcessRequest) GetSkipHumanReview() boolfunc (*BatchProcessRequest) ProtoMessage
func (*BatchProcessRequest) ProtoMessage()func (*BatchProcessRequest) ProtoReflect
func (x *BatchProcessRequest) ProtoReflect() protoreflect.Messagefunc (*BatchProcessRequest) Reset
func (x *BatchProcessRequest) Reset()func (*BatchProcessRequest) String
func (x *BatchProcessRequest) String() stringBatchProcessRequest_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"`
// Mimetype of the input. If the input is a raw document, the supported
// mimetypes are application/pdf, image/tiff, and image/gif.
// If the input is a [Document] proto, 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() stringfunc (*BatchProcessRequest_BatchInputConfig) GetMimeType (deprecated)
func (x *BatchProcessRequest_BatchInputConfig) GetMimeType() stringfunc (*BatchProcessRequest_BatchInputConfig) ProtoMessage (deprecated)
func (*BatchProcessRequest_BatchInputConfig) ProtoMessage()func (*BatchProcessRequest_BatchInputConfig) ProtoReflect (deprecated)
func (x *BatchProcessRequest_BatchInputConfig) ProtoReflect() protoreflect.Messagefunc (*BatchProcessRequest_BatchInputConfig) Reset (deprecated)
func (x *BatchProcessRequest_BatchInputConfig) Reset()func (*BatchProcessRequest_BatchInputConfig) String (deprecated)
func (x *BatchProcessRequest_BatchInputConfig) String() stringBatchProcessRequest_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 message for output config in batch process.
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() stringfunc (*BatchProcessRequest_BatchOutputConfig) ProtoMessage (deprecated)
func (*BatchProcessRequest_BatchOutputConfig) ProtoMessage()func (*BatchProcessRequest_BatchOutputConfig) ProtoReflect (deprecated)
func (x *BatchProcessRequest_BatchOutputConfig) ProtoReflect() protoreflect.Messagefunc (*BatchProcessRequest_BatchOutputConfig) Reset (deprecated)
func (x *BatchProcessRequest_BatchOutputConfig) Reset()func (*BatchProcessRequest_BatchOutputConfig) String (deprecated)
func (x *BatchProcessRequest_BatchOutputConfig) String() stringBatchProcessResponse
type BatchProcessResponse struct {
// contains filtered or unexported fields
}Response message for batch process document method.
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.Messagefunc (*BatchProcessResponse) Reset
func (x *BatchProcessResponse) Reset()func (*BatchProcessResponse) String
func (x *BatchProcessResponse) String() stringBoundingPoly
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() []*NormalizedVertexfunc (*BoundingPoly) GetVertices
func (x *BoundingPoly) GetVertices() []*Vertexfunc (*BoundingPoly) ProtoMessage
func (*BoundingPoly) ProtoMessage()func (*BoundingPoly) ProtoReflect
func (x *BoundingPoly) ProtoReflect() protoreflect.Messagefunc (*BoundingPoly) Reset
func (x *BoundingPoly) Reset()func (*BoundingPoly) String
func (x *BoundingPoly) String() stringCommonOperationMetadata
type CommonOperationMetadata struct {
State CommonOperationMetadata_State "" /* 131 byte string literal not displayed */
StateMessage string `protobuf:"bytes,2,opt,name=state_message,json=stateMessage,proto3" json:"state_message,omitempty"`
Resource string `protobuf:"bytes,5,opt,name=resource,proto3" json:"resource,omitempty"`
CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
}The common metadata for long running operations.
func (*CommonOperationMetadata) Descriptor
func (*CommonOperationMetadata) Descriptor() ([]byte, []int)Deprecated: Use CommonOperationMetadata.ProtoReflect.Descriptor instead.
func (*CommonOperationMetadata) GetCreateTime
func (x *CommonOperationMetadata) GetCreateTime() *timestamppb.Timestampfunc (*CommonOperationMetadata) GetResource
func (x *CommonOperationMetadata) GetResource() stringfunc (*CommonOperationMetadata) GetState
func (x *CommonOperationMetadata) GetState() CommonOperationMetadata_Statefunc (*CommonOperationMetadata) GetStateMessage
func (x *CommonOperationMetadata) GetStateMessage() stringfunc (*CommonOperationMetadata) GetUpdateTime
func (x *CommonOperationMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*CommonOperationMetadata) ProtoMessage
func (*CommonOperationMetadata) ProtoMessage()func (*CommonOperationMetadata) ProtoReflect
func (x *CommonOperationMetadata) ProtoReflect() protoreflect.Messagefunc (*CommonOperationMetadata) Reset
func (x *CommonOperationMetadata) Reset()func (*CommonOperationMetadata) String
func (x *CommonOperationMetadata) String() stringCommonOperationMetadata_State
type CommonOperationMetadata_State int32State 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.EnumDescriptorfunc (CommonOperationMetadata_State) Enum
func (x CommonOperationMetadata_State) Enum() *CommonOperationMetadata_Statefunc (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.EnumNumberfunc (CommonOperationMetadata_State) String
func (x CommonOperationMetadata_State) String() stringfunc (CommonOperationMetadata_State) Type
func (CommonOperationMetadata_State) Type() protoreflect.EnumTypeCreateProcessorRequest
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] and
// [display_name] to be set. Also, the processor is under CMEK if CMEK fields
// are set.
Processor *Processor `protobuf:"bytes,2,opt,name=processor,proto3" json:"processor,omitempty"`
// contains filtered or unexported fields
}Request message for create a processor. Notice this request is sent to a regionalized backend service, and if the processor type is not available on that region, the creation will fail.
func (*CreateProcessorRequest) Descriptor
func (*CreateProcessorRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateProcessorRequest.ProtoReflect.Descriptor instead.
func (*CreateProcessorRequest) GetParent
func (x *CreateProcessorRequest) GetParent() stringfunc (*CreateProcessorRequest) GetProcessor
func (x *CreateProcessorRequest) GetProcessor() *Processorfunc (*CreateProcessorRequest) ProtoMessage
func (*CreateProcessorRequest) ProtoMessage()func (*CreateProcessorRequest) ProtoReflect
func (x *CreateProcessorRequest) ProtoReflect() protoreflect.Messagefunc (*CreateProcessorRequest) Reset
func (x *CreateProcessorRequest) Reset()func (*CreateProcessorRequest) String
func (x *CreateProcessorRequest) String() stringDeleteProcessorMetadata
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 delete processor method.
func (*DeleteProcessorMetadata) Descriptor
func (*DeleteProcessorMetadata) Descriptor() ([]byte, []int)Deprecated: Use DeleteProcessorMetadata.ProtoReflect.Descriptor instead.
func (*DeleteProcessorMetadata) GetCommonMetadata
func (x *DeleteProcessorMetadata) GetCommonMetadata() *CommonOperationMetadatafunc (*DeleteProcessorMetadata) ProtoMessage
func (*DeleteProcessorMetadata) ProtoMessage()func (*DeleteProcessorMetadata) ProtoReflect
func (x *DeleteProcessorMetadata) ProtoReflect() protoreflect.Messagefunc (*DeleteProcessorMetadata) Reset
func (x *DeleteProcessorMetadata) Reset()func (*DeleteProcessorMetadata) String
func (x *DeleteProcessorMetadata) String() stringDeleteProcessorRequest
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 delete processor method.
func (*DeleteProcessorRequest) Descriptor
func (*DeleteProcessorRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteProcessorRequest.ProtoReflect.Descriptor instead.
func (*DeleteProcessorRequest) GetName
func (x *DeleteProcessorRequest) GetName() stringfunc (*DeleteProcessorRequest) ProtoMessage
func (*DeleteProcessorRequest) ProtoMessage()func (*DeleteProcessorRequest) ProtoReflect
func (x *DeleteProcessorRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteProcessorRequest) Reset
func (x *DeleteProcessorRequest) Reset()func (*DeleteProcessorRequest) String
func (x *DeleteProcessorRequest) String() stringDeleteProcessorVersionMetadata
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 delete processor version method.
func (*DeleteProcessorVersionMetadata) Descriptor
func (*DeleteProcessorVersionMetadata) Descriptor() ([]byte, []int)Deprecated: Use DeleteProcessorVersionMetadata.ProtoReflect.Descriptor instead.
func (*DeleteProcessorVersionMetadata) GetCommonMetadata
func (x *DeleteProcessorVersionMetadata) GetCommonMetadata() *CommonOperationMetadatafunc (*DeleteProcessorVersionMetadata) ProtoMessage
func (*DeleteProcessorVersionMetadata) ProtoMessage()func (*DeleteProcessorVersionMetadata) ProtoReflect
func (x *DeleteProcessorVersionMetadata) ProtoReflect() protoreflect.Messagefunc (*DeleteProcessorVersionMetadata) Reset
func (x *DeleteProcessorVersionMetadata) Reset()func (*DeleteProcessorVersionMetadata) String
func (x *DeleteProcessorVersionMetadata) String() stringDeleteProcessorVersionRequest
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 delete processor version method.
func (*DeleteProcessorVersionRequest) Descriptor
func (*DeleteProcessorVersionRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteProcessorVersionRequest.ProtoReflect.Descriptor instead.
func (*DeleteProcessorVersionRequest) GetName
func (x *DeleteProcessorVersionRequest) GetName() stringfunc (*DeleteProcessorVersionRequest) ProtoMessage
func (*DeleteProcessorVersionRequest) ProtoMessage()func (*DeleteProcessorVersionRequest) ProtoReflect
func (x *DeleteProcessorVersionRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteProcessorVersionRequest) Reset
func (x *DeleteProcessorVersionRequest) Reset()func (*DeleteProcessorVersionRequest) String
func (x *DeleteProcessorVersionRequest) String() stringDeployProcessorVersionMetadata
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 deploy processor version method.
func (*DeployProcessorVersionMetadata) Descriptor
func (*DeployProcessorVersionMetadata) Descriptor() ([]byte, []int)Deprecated: Use DeployProcessorVersionMetadata.ProtoReflect.Descriptor instead.
func (*DeployProcessorVersionMetadata) GetCommonMetadata
func (x *DeployProcessorVersionMetadata) GetCommonMetadata() *CommonOperationMetadatafunc (*DeployProcessorVersionMetadata) ProtoMessage
func (*DeployProcessorVersionMetadata) ProtoMessage()func (*DeployProcessorVersionMetadata) ProtoReflect
func (x *DeployProcessorVersionMetadata) ProtoReflect() protoreflect.Messagefunc (*DeployProcessorVersionMetadata) Reset
func (x *DeployProcessorVersionMetadata) Reset()func (*DeployProcessorVersionMetadata) String
func (x *DeployProcessorVersionMetadata) String() stringDeployProcessorVersionRequest
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 deploy processor version method.
func (*DeployProcessorVersionRequest) Descriptor
func (*DeployProcessorVersionRequest) Descriptor() ([]byte, []int)Deprecated: Use DeployProcessorVersionRequest.ProtoReflect.Descriptor instead.
func (*DeployProcessorVersionRequest) GetName
func (x *DeployProcessorVersionRequest) GetName() stringfunc (*DeployProcessorVersionRequest) ProtoMessage
func (*DeployProcessorVersionRequest) ProtoMessage()func (*DeployProcessorVersionRequest) ProtoReflect
func (x *DeployProcessorVersionRequest) ProtoReflect() protoreflect.Messagefunc (*DeployProcessorVersionRequest) Reset
func (x *DeployProcessorVersionRequest) Reset()func (*DeployProcessorVersionRequest) String
func (x *DeployProcessorVersionRequest) String() stringDeployProcessorVersionResponse
type DeployProcessorVersionResponse struct {
// contains filtered or unexported fields
}Response message for the deploy processor version 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.Messagefunc (*DeployProcessorVersionResponse) Reset
func (x *DeployProcessorVersionResponse) Reset()func (*DeployProcessorVersionResponse) String
func (x *DeployProcessorVersionResponse) String() stringDisableProcessorMetadata
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 disable processor method.
func (*DisableProcessorMetadata) Descriptor
func (*DisableProcessorMetadata) Descriptor() ([]byte, []int)Deprecated: Use DisableProcessorMetadata.ProtoReflect.Descriptor instead.
func (*DisableProcessorMetadata) GetCommonMetadata
func (x *DisableProcessorMetadata) GetCommonMetadata() *CommonOperationMetadatafunc (*DisableProcessorMetadata) ProtoMessage
func (*DisableProcessorMetadata) ProtoMessage()func (*DisableProcessorMetadata) ProtoReflect
func (x *DisableProcessorMetadata) ProtoReflect() protoreflect.Messagefunc (*DisableProcessorMetadata) Reset
func (x *DisableProcessorMetadata) Reset()func (*DisableProcessorMetadata) String
func (x *DisableProcessorMetadata) String() stringDisableProcessorRequest
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 disable processor method.
func (*DisableProcessorRequest) Descriptor
func (*DisableProcessorRequest) Descriptor() ([]byte, []int)Deprecated: Use DisableProcessorRequest.ProtoReflect.Descriptor instead.
func (*DisableProcessorRequest) GetName
func (x *DisableProcessorRequest) GetName() stringfunc (*DisableProcessorRequest) ProtoMessage
func (*DisableProcessorRequest) ProtoMessage()func (*DisableProcessorRequest) ProtoReflect
func (x *DisableProcessorRequest) ProtoReflect() protoreflect.Messagefunc (*DisableProcessorRequest) Reset
func (x *DisableProcessorRequest) Reset()func (*DisableProcessorRequest) String
func (x *DisableProcessorRequest) String() stringDisableProcessorResponse
type DisableProcessorResponse struct {
// contains filtered or unexported fields
}Response message for the disable processor 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.Messagefunc (*DisableProcessorResponse) Reset
func (x *DisableProcessorResponse) Reset()func (*DisableProcessorResponse) String
func (x *DisableProcessorResponse) String() stringDocument
type Document struct {
// Original source document from the user.
//
// Types that are assignable to Source:
// *Document_Uri
// *Document_Content
Source isDocument_Source `protobuf_oneof:"source"`
// An IANA published MIME type (also referred to as media type). For more
// information, see
// https://www.iana.org/assignments/media-types/media-types.xhtml.
MimeType string `protobuf:"bytes,3,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
// Optional. UTF-8 encoded text in reading order from the document.
Text string `protobuf:"bytes,4,opt,name=text,proto3" json:"text,omitempty"`
// Styles for the
// [Document.text][google.cloud.documentai.v1beta3.Document.text].
//
// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.
TextStyles []*Document_Style `protobuf:"bytes,5,rep,name=text_styles,json=textStyles,proto3" json:"text_styles,omitempty"`
// Visual page layout for the
// [Document][google.cloud.documentai.v1beta3.Document].
Pages []*Document_Page `protobuf:"bytes,6,rep,name=pages,proto3" json:"pages,omitempty"`
// A list of entities detected on
// [Document.text][google.cloud.documentai.v1beta3.Document.text]. For
// document shards, entities in this list may cross shard boundaries.
Entities []*Document_Entity `protobuf:"bytes,7,rep,name=entities,proto3" json:"entities,omitempty"`
// Placeholder. Relationship among
// [Document.entities][google.cloud.documentai.v1beta3.Document.entities].
EntityRelations []*Document_EntityRelation `protobuf:"bytes,8,rep,name=entity_relations,json=entityRelations,proto3" json:"entity_relations,omitempty"`
// Placeholder. A list of text corrections made to
// [Document.text][google.cloud.documentai.v1beta3.Document.text]. This is
// usually used for annotating corrections to OCR mistakes. Text changes for
// a given revision may not overlap with each other.
TextChanges []*Document_TextChange `protobuf:"bytes,14,rep,name=text_changes,json=textChanges,proto3" json:"text_changes,omitempty"`
// Information about the sharding if this document is sharded part of a larger
// document. If the document is not sharded, this message is not specified.
ShardInfo *Document_ShardInfo `protobuf:"bytes,9,opt,name=shard_info,json=shardInfo,proto3" json:"shard_info,omitempty"`
// Any error that occurred while processing this document.
Error *status.Status `protobuf:"bytes,10,opt,name=error,proto3" json:"error,omitempty"`
// Placeholder. Revision history of this document.
Revisions []*Document_Revision `protobuf:"bytes,13,rep,name=revisions,proto3" json:"revisions,omitempty"`
// contains filtered or unexported fields
}Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality.
func (*Document) Descriptor
Deprecated: Use Document.ProtoReflect.Descriptor instead.
func (*Document) GetContent
func (*Document) GetEntities
func (x *Document) GetEntities() []*Document_Entityfunc (*Document) GetEntityRelations
func (x *Document) GetEntityRelations() []*Document_EntityRelationfunc (*Document) GetError
func (*Document) GetMimeType
func (*Document) GetPages
func (x *Document) GetPages() []*Document_Pagefunc (*Document) GetRevisions
func (x *Document) GetRevisions() []*Document_Revisionfunc (*Document) GetShardInfo
func (x *Document) GetShardInfo() *Document_ShardInfofunc (*Document) GetSource
func (m *Document) GetSource() isDocument_Sourcefunc (*Document) GetText
func (*Document) GetTextChanges
func (x *Document) GetTextChanges() []*Document_TextChangefunc (*Document) GetTextStyles
func (x *Document) GetTextStyles() []*Document_StyleDeprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.
func (*Document) GetUri
func (*Document) ProtoMessage
func (*Document) ProtoMessage()func (*Document) ProtoReflect
func (x *Document) ProtoReflect() protoreflect.Messagefunc (*Document) Reset
func (x *Document) Reset()func (*Document) 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_Destinationfunc (*DocumentOutputConfig) GetGcsOutputConfig
func (x *DocumentOutputConfig) GetGcsOutputConfig() *DocumentOutputConfig_GcsOutputConfigfunc (*DocumentOutputConfig) ProtoMessage
func (*DocumentOutputConfig) ProtoMessage()func (*DocumentOutputConfig) ProtoReflect
func (x *DocumentOutputConfig) ProtoReflect() protoreflect.Messagefunc (*DocumentOutputConfig) Reset
func (x *DocumentOutputConfig) Reset()func (*DocumentOutputConfig) String
func (x *DocumentOutputConfig) String() stringDocumentOutputConfig_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.FieldMaskfunc (*DocumentOutputConfig_GcsOutputConfig) GetGcsUri
func (x *DocumentOutputConfig_GcsOutputConfig) GetGcsUri() stringfunc (*DocumentOutputConfig_GcsOutputConfig) GetShardingConfig
func (x *DocumentOutputConfig_GcsOutputConfig) GetShardingConfig() *DocumentOutputConfig_GcsOutputConfig_ShardingConfigfunc (*DocumentOutputConfig_GcsOutputConfig) ProtoMessage
func (*DocumentOutputConfig_GcsOutputConfig) ProtoMessage()func (*DocumentOutputConfig_GcsOutputConfig) ProtoReflect
func (x *DocumentOutputConfig_GcsOutputConfig) ProtoReflect() protoreflect.Messagefunc (*DocumentOutputConfig_GcsOutputConfig) Reset
func (x *DocumentOutputConfig_GcsOutputConfig) Reset()func (*DocumentOutputConfig_GcsOutputConfig) String
func (x *DocumentOutputConfig_GcsOutputConfig) String() stringDocumentOutputConfig_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() int32func (*DocumentOutputConfig_GcsOutputConfig_ShardingConfig) GetPagesPerShard
func (x *DocumentOutputConfig_GcsOutputConfig_ShardingConfig) GetPagesPerShard() int32func (*DocumentOutputConfig_GcsOutputConfig_ShardingConfig) ProtoMessage
func (*DocumentOutputConfig_GcsOutputConfig_ShardingConfig) ProtoMessage()func (*DocumentOutputConfig_GcsOutputConfig_ShardingConfig) ProtoReflect
func (x *DocumentOutputConfig_GcsOutputConfig_ShardingConfig) ProtoReflect() protoreflect.Messagefunc (*DocumentOutputConfig_GcsOutputConfig_ShardingConfig) Reset
func (x *DocumentOutputConfig_GcsOutputConfig_ShardingConfig) Reset()func (*DocumentOutputConfig_GcsOutputConfig_ShardingConfig) String
func (x *DocumentOutputConfig_GcsOutputConfig_ShardingConfig) String() stringDocumentProcessorServiceClient
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 do not use ListProcessorTypes here
// because it is not 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
// cloud_documentai_core.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 type processor that the user chose.
// The processor will be at "ENABLED" state by default after its creation.
CreateProcessor(ctx context.Context, in *CreateProcessorRequest, opts ...grpc.CallOption) (*Processor, error)
// Deletes the processor, unloads all deployed model artifacts if it was
// enabled and then deletes all artifacts associated with this processor.
DeleteProcessor(ctx context.Context, in *DeleteProcessorRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Enables a processor
EnableProcessor(ctx context.Context, in *EnableProcessorRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Disables a processor
DisableProcessor(ctx context.Context, in *DisableProcessorRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Set the default (active) version of a
// [Processor][google.cloud.documentai.v1beta3.Processor] that will be used in
// [ProcessDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ProcessDocument]
// and
// [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments].
SetDefaultProcessorVersion(ctx context.Context, in *SetDefaultProcessorVersionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Send a document for Human Review. The input document should be processed by
// the specified processor.
ReviewDocument(ctx context.Context, in *ReviewDocumentRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Evaluates a ProcessorVersion against annotated documents, producing an
// Evaluation.
EvaluateProcessorVersion(ctx context.Context, in *EvaluateProcessorVersionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Retrieves a specific evaluation.
GetEvaluation(ctx context.Context, in *GetEvaluationRequest, opts ...grpc.CallOption) (*Evaluation, error)
// Retrieves a set of evaluations for a given processor version.
ListEvaluations(ctx context.Context, in *ListEvaluationsRequest, opts ...grpc.CallOption) (*ListEvaluationsResponse, error)
// Imports a processor version from source processor version.
ImportProcessorVersion(ctx context.Context, in *ImportProcessorVersionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}DocumentProcessorServiceClient is the client API for DocumentProcessorService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewDocumentProcessorServiceClient
func NewDocumentProcessorServiceClient(cc grpc.ClientConnInterface) DocumentProcessorServiceClientDocumentProcessorServiceServer
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 do not use ListProcessorTypes here
// because it is not 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
// cloud_documentai_core.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 type processor that the user chose.
// The processor will be at "ENABLED" state by default after its creation.
CreateProcessor(context.Context, *CreateProcessorRequest) (*Processor, error)
// Deletes the processor, unloads all deployed model artifacts if it was
// enabled and then deletes all artifacts associated with this processor.
DeleteProcessor(context.Context, *DeleteProcessorRequest) (*longrunningpb.Operation, error)
// Enables a processor
EnableProcessor(context.Context, *EnableProcessorRequest) (*longrunningpb.Operation, error)
// Disables a processor
DisableProcessor(context.Context, *DisableProcessorRequest) (*longrunningpb.Operation, error)
// Set the default (active) version of a
// [Processor][google.cloud.documentai.v1beta3.Processor] that will be used in
// [ProcessDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ProcessDocument]
// and
// [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments].
SetDefaultProcessorVersion(context.Context, *SetDefaultProcessorVersionRequest) (*longrunningpb.Operation, error)
// Send a document for Human Review. The input document should be processed by
// the specified processor.
ReviewDocument(context.Context, *ReviewDocumentRequest) (*longrunningpb.Operation, error)
// Evaluates a ProcessorVersion against annotated documents, producing an
// Evaluation.
EvaluateProcessorVersion(context.Context, *EvaluateProcessorVersionRequest) (*longrunningpb.Operation, error)
// Retrieves a specific evaluation.
GetEvaluation(context.Context, *GetEvaluationRequest) (*Evaluation, error)
// Retrieves a set of evaluations for a given processor version.
ListEvaluations(context.Context, *ListEvaluationsRequest) (*ListEvaluationsResponse, error)
// Imports a processor version from source processor version.
ImportProcessorVersion(context.Context, *ImportProcessorVersionRequest) (*longrunningpb.Operation, error)
}DocumentProcessorServiceServer is the server API for DocumentProcessorService service.
DocumentSchema
type DocumentSchema struct {
// Display name to show to users.
DisplayName string `protobuf:"bytes,1,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Description of the schema.
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// Entity types of the schema.
EntityTypes []*DocumentSchema_EntityType `protobuf:"bytes,3,rep,name=entity_types,json=entityTypes,proto3" json:"entity_types,omitempty"`
// Metadata of the schema.
Metadata *DocumentSchema_Metadata `protobuf:"bytes,4,opt,name=metadata,proto3" json:"metadata,omitempty"`
// contains filtered or unexported fields
}The schema defines the output of the processed document by a processor.
func (*DocumentSchema) Descriptor
func (*DocumentSchema) Descriptor() ([]byte, []int)Deprecated: Use DocumentSchema.ProtoReflect.Descriptor instead.
func (*DocumentSchema) GetDescription
func (x *DocumentSchema) GetDescription() stringfunc (*DocumentSchema) GetDisplayName
func (x *DocumentSchema) GetDisplayName() stringfunc (*DocumentSchema) GetEntityTypes
func (x *DocumentSchema) GetEntityTypes() []*DocumentSchema_EntityTypefunc (*DocumentSchema) GetMetadata
func (x *DocumentSchema) GetMetadata() *DocumentSchema_Metadatafunc (*DocumentSchema) ProtoMessage
func (*DocumentSchema) ProtoMessage()func (*DocumentSchema) ProtoReflect
func (x *DocumentSchema) ProtoReflect() protoreflect.Messagefunc (*DocumentSchema) Reset
func (x *DocumentSchema) Reset()func (*DocumentSchema) String
func (x *DocumentSchema) String() stringDocumentSchema_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'. Besides that we use the following naming
// conventions:
//
// - *use `snake_casing`*
// - name matching is case-sensitive
// - Maximum 64 characters.
// - Must start with a letter.
// - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward
// compatibility internal infrastructure and tooling can handle any ascii
// character)
// - The `/` is sometimes used to denote a property of a type. For example
// `line_item/amount`. This convention is deprecated, but will still be
// honored for backward compatibility.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The entity type that this type is derived from. For now, one and only
// one should be set.
BaseTypes []string `protobuf:"bytes,2,rep,name=base_types,json=baseTypes,proto3" json:"base_types,omitempty"`
// Describing the nested structure, or composition of an entity.
Properties []*DocumentSchema_EntityType_Property `protobuf:"bytes,6,rep,name=properties,proto3" json:"properties,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() []stringfunc (*DocumentSchema_EntityType) GetDisplayName
func (x *DocumentSchema_EntityType) GetDisplayName() stringfunc (*DocumentSchema_EntityType) GetEnumValues
func (x *DocumentSchema_EntityType) GetEnumValues() *DocumentSchema_EntityType_EnumValuesfunc (*DocumentSchema_EntityType) GetName
func (x *DocumentSchema_EntityType) GetName() stringfunc (*DocumentSchema_EntityType) GetProperties
func (x *DocumentSchema_EntityType) GetProperties() []*DocumentSchema_EntityType_Propertyfunc (*DocumentSchema_EntityType) GetValueSource
func (m *DocumentSchema_EntityType) GetValueSource() isDocumentSchema_EntityType_ValueSourcefunc (*DocumentSchema_EntityType) ProtoMessage
func (*DocumentSchema_EntityType) ProtoMessage()func (*DocumentSchema_EntityType) ProtoReflect
func (x *DocumentSchema_EntityType) ProtoReflect() protoreflect.Messagefunc (*DocumentSchema_EntityType) Reset
func (x *DocumentSchema_EntityType) Reset()func (*DocumentSchema_EntityType) String
func (x *DocumentSchema_EntityType) String() stringDocumentSchema_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() []stringfunc (*DocumentSchema_EntityType_EnumValues) ProtoMessage
func (*DocumentSchema_EntityType_EnumValues) ProtoMessage()func (*DocumentSchema_EntityType_EnumValues) ProtoReflect
func (x *DocumentSchema_EntityType_EnumValues) ProtoReflect() protoreflect.Messagefunc (*DocumentSchema_EntityType_EnumValues) Reset
func (x *DocumentSchema_EntityType_EnumValues) Reset()func (*DocumentSchema_EntityType_EnumValues) String
func (x *DocumentSchema_EntityType_EnumValues) String() stringDocumentSchema_EntityType_EnumValues_
type DocumentSchema_EntityType_EnumValues_ struct {
// If specified, lists all the possible values for this entity. This
// should not be more than a handful of values. If the number of values
// is >10 or could change frequently use the `EntityType.value_ontology`
// field and specify a list of all possible values in a value ontology
// file.
EnumValues *DocumentSchema_EntityType_EnumValues `protobuf:"bytes,14,opt,name=enum_values,json=enumValues,proto3,oneof"`
}DocumentSchema_EntityType_Property
type DocumentSchema_EntityType_Property struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
ValueType string `protobuf:"bytes,2,opt,name=value_type,json=valueType,proto3" json:"value_type,omitempty"`
OccurrenceType DocumentSchema_EntityType_Property_OccurrenceType "" /* 191 byte string literal not displayed */
}Defines properties that can be part of the entity type.
func (*DocumentSchema_EntityType_Property) Descriptor
func (*DocumentSchema_EntityType_Property) Descriptor() ([]byte, []int)Deprecated: Use DocumentSchema_EntityType_Property.ProtoReflect.Descriptor instead.
func (*DocumentSchema_EntityType_Property) GetName
func (x *DocumentSchema_EntityType_Property) GetName() stringfunc (*DocumentSchema_EntityType_Property) GetOccurrenceType
func (x *DocumentSchema_EntityType_Property) GetOccurrenceType() DocumentSchema_EntityType_Property_OccurrenceTypefunc (*DocumentSchema_EntityType_Property) GetValueType
func (x *DocumentSchema_EntityType_Property) GetValueType() stringfunc (*DocumentSchema_EntityType_Property) ProtoMessage
func (*DocumentSchema_EntityType_Property) ProtoMessage()func (*DocumentSchema_EntityType_Property) ProtoReflect
func (x *DocumentSchema_EntityType_Property) ProtoReflect() protoreflect.Messagefunc (*DocumentSchema_EntityType_Property) Reset
func (x *DocumentSchema_EntityType_Property) Reset()func (*DocumentSchema_EntityType_Property) String
func (x *DocumentSchema_EntityType_Property) String() stringDocumentSchema_EntityType_Property_OccurrenceType
type DocumentSchema_EntityType_Property_OccurrenceType int32Types of occurrences of the entity type in the document. Note: this represents the number of instances of an entity types, not number of mentions of a given entity instance.
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.
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.
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.EnumDescriptorfunc (DocumentSchema_EntityType_Property_OccurrenceType) Enum
func (x DocumentSchema_EntityType_Property_OccurrenceType) Enum() *DocumentSchema_EntityType_Property_OccurrenceTypefunc (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.EnumNumberfunc (DocumentSchema_EntityType_Property_OccurrenceType) String
func (x DocumentSchema_EntityType_Property_OccurrenceType) String() stringfunc (DocumentSchema_EntityType_Property_OccurrenceType) Type
DocumentSchema_Metadata
type DocumentSchema_Metadata struct {
DocumentSplitter bool `protobuf:"varint,1,opt,name=document_splitter,json=documentSplitter,proto3" json:"document_splitter,omitempty"`
DocumentAllowMultipleLabels bool "" /* 147 byte string literal not displayed */
PrefixedNamingOnProperties bool "" /* 144 byte string literal not displayed */
SkipNamingValidation bool `protobuf:"varint,7,opt,name=skip_naming_validation,json=skipNamingValidation,proto3" json:"skip_naming_validation,omitempty"`
}Metadata for global schema behavior.
func (*DocumentSchema_Metadata) Descriptor
func (*DocumentSchema_Metadata) Descriptor() ([]byte, []int)Deprecated: Use DocumentSchema_Metadata.ProtoReflect.Descriptor instead.
func (*DocumentSchema_Metadata) GetDocumentAllowMultipleLabels
func (x *DocumentSchema_Metadata) GetDocumentAllowMultipleLabels() boolfunc (*DocumentSchema_Metadata) GetDocumentSplitter
func (x *DocumentSchema_Metadata) GetDocumentSplitter() boolfunc (*DocumentSchema_Metadata) GetPrefixedNamingOnProperties
func (x *DocumentSchema_Metadata) GetPrefixedNamingOnProperties() boolfunc (*DocumentSchema_Metadata) GetSkipNamingValidation
func (x *DocumentSchema_Metadata) GetSkipNamingValidation() boolfunc (*DocumentSchema_Metadata) ProtoMessage
func (*DocumentSchema_Metadata) ProtoMessage()func (*DocumentSchema_Metadata) ProtoReflect
func (x *DocumentSchema_Metadata) ProtoReflect() protoreflect.Messagefunc (*DocumentSchema_Metadata) Reset
func (x *DocumentSchema_Metadata) Reset()func (*DocumentSchema_Metadata) String
func (x *DocumentSchema_Metadata) String() stringDocument_Content
type Document_Content struct {
// Optional. Inline document content, represented as a stream of bytes.
// Note: As with all `bytes` fields, protobuffers use a pure binary
// representation, whereas JSON representations use base64.
Content []byte `protobuf:"bytes,2,opt,name=content,proto3,oneof"`
}Document_Entity
type Document_Entity struct {
// Optional. Provenance of the entity.
// Text anchor indexing into the
// [Document.text][google.cloud.documentai.v1beta3.Document.text].
TextAnchor *Document_TextAnchor `protobuf:"bytes,1,opt,name=text_anchor,json=textAnchor,proto3" json:"text_anchor,omitempty"`
// Required. Entity type from a schema e.g. `Address`.
Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
// Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.
MentionText string `protobuf:"bytes,3,opt,name=mention_text,json=mentionText,proto3" json:"mention_text,omitempty"`
// Optional. Deprecated. Use `id` field instead.
MentionId string `protobuf:"bytes,4,opt,name=mention_id,json=mentionId,proto3" json:"mention_id,omitempty"`
// Optional. Confidence of detected Schema entity. Range `[0, 1]`.
Confidence float32 `protobuf:"fixed32,5,opt,name=confidence,proto3" json:"confidence,omitempty"`
// Optional. Represents the provenance of this entity wrt. the location on
// the page where it was found.
PageAnchor *Document_PageAnchor `protobuf:"bytes,6,opt,name=page_anchor,json=pageAnchor,proto3" json:"page_anchor,omitempty"`
// Optional. Canonical id. This will be a unique value in the entity list
// for this document.
Id string `protobuf:"bytes,7,opt,name=id,proto3" json:"id,omitempty"`
// Optional. Normalized entity value. Absent if the extracted value could
// not be converted or the type (e.g. address) is not supported for certain
// parsers. This field is also only populated for certain supported document
// types.
NormalizedValue *Document_Entity_NormalizedValue `protobuf:"bytes,9,opt,name=normalized_value,json=normalizedValue,proto3" json:"normalized_value,omitempty"`
// Optional. Entities can be nested to form a hierarchical data structure
// representing the content in the document.
Properties []*Document_Entity `protobuf:"bytes,10,rep,name=properties,proto3" json:"properties,omitempty"`
// Optional. The history of this annotation.
Provenance *Document_Provenance `protobuf:"bytes,11,opt,name=provenance,proto3" json:"provenance,omitempty"`
// Optional. Whether the entity will be redacted for de-identification
// purposes.
Redacted bool `protobuf:"varint,12,opt,name=redacted,proto3" json:"redacted,omitempty"`
// contains filtered or unexported fields
}An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.
func (*Document_Entity) Descriptor
func (*Document_Entity) Descriptor() ([]byte, []int)Deprecated: Use Document_Entity.ProtoReflect.Descriptor instead.
func (*Document_Entity) GetConfidence
func (x *Document_Entity) GetConfidence() float32func (*Document_Entity) GetId
func (x *Document_Entity) GetId() stringfunc (*Document_Entity) GetMentionId
func (x *Document_Entity) GetMentionId() stringfunc (*Document_Entity) GetMentionText
func (x *Document_Entity) GetMentionText() stringfunc (*Document_Entity) GetNormalizedValue
func (x *Document_Entity) GetNormalizedValue() *Document_Entity_NormalizedValuefunc (*Document_Entity) GetPageAnchor
func (x *Document_Entity) GetPageAnchor() *Document_PageAnchorfunc (*Document_Entity) GetProperties
func (x *Document_Entity) GetProperties() []*Document_Entityfunc (*Document_Entity) GetProvenance
func (x *Document_Entity) GetProvenance() *Document_Provenancefunc (*Document_Entity) GetRedacted
func (x *Document_Entity) GetRedacted() boolfunc (*Document_Entity) GetTextAnchor
func (x *Document_Entity) GetTextAnchor() *Document_TextAnchorfunc (*Document_Entity) GetType
func (x *Document_Entity) GetType() stringfunc (*Document_Entity) ProtoMessage
func (*Document_Entity) ProtoMessage()func (*Document_Entity) ProtoReflect
func (x *Document_Entity) ProtoReflect() protoreflect.Messagefunc (*Document_Entity) Reset
func (x *Document_Entity) Reset()func (*Document_Entity) String
func (x *Document_Entity) String() stringDocument_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() stringfunc (*Document_EntityRelation) GetRelation
func (x *Document_EntityRelation) GetRelation() stringfunc (*Document_EntityRelation) GetSubjectId
func (x *Document_EntityRelation) GetSubjectId() stringfunc (*Document_EntityRelation) ProtoMessage
func (*Document_EntityRelation) ProtoMessage()func (*Document_EntityRelation) ProtoReflect
func (x *Document_EntityRelation) ProtoReflect() protoreflect.Messagefunc (*Document_EntityRelation) Reset
func (x *Document_EntityRelation) Reset()func (*Document_EntityRelation) String
func (x *Document_EntityRelation) String() stringDocument_Entity_NormalizedValue
type Document_Entity_NormalizedValue struct {
// An optional structured entity value.
// Must match entity type defined in schema if
// known. If this field is present, the `text` field could also be
// populated.
//
// Types that are assignable to StructuredValue:
// *Document_Entity_NormalizedValue_MoneyValue
// *Document_Entity_NormalizedValue_DateValue
// *Document_Entity_NormalizedValue_DatetimeValue
// *Document_Entity_NormalizedValue_AddressValue
// *Document_Entity_NormalizedValue_BooleanValue
// *Document_Entity_NormalizedValue_IntegerValue
// *Document_Entity_NormalizedValue_FloatValue
StructuredValue isDocument_Entity_NormalizedValue_StructuredValue `protobuf_oneof:"structured_value"`
// Optional. An optional field to store a normalized string.
// For some entity types, one of respective `structured_value` fields may
// also be populated. Also not all the types of `structured_value` will be
// normalized. For example, some processors may not generate `float`
// or `integer` normalized text by default.
//
// Below are sample formats mapped to structured values.
//
// - Money/Currency type (`money_value`) is in the ISO 4217 text format.
// - Date type (`date_value`) is in the ISO 8601 text format.
// - Datetime type (`datetime_value`) is in the ISO 8601 text format.
Text string `protobuf:"bytes,1,opt,name=text,proto3" json:"text,omitempty"`
// contains filtered or unexported fields
}Parsed and normalized entity value.
func (*Document_Entity_NormalizedValue) Descriptor
func (*Document_Entity_NormalizedValue) Descriptor() ([]byte, []int)Deprecated: Use Document_Entity_NormalizedValue.ProtoReflect.Descriptor instead.
func (*Document_Entity_NormalizedValue) GetAddressValue
func (x *Document_Entity_NormalizedValue) GetAddressValue() *postaladdress.PostalAddressfunc (*Document_Entity_NormalizedValue) GetBooleanValue
func (x *Document_Entity_NormalizedValue) GetBooleanValue() boolfunc (*Document_Entity_NormalizedValue) GetDateValue
func (x *Document_Entity_NormalizedValue) GetDateValue() *date.Datefunc (*Document_Entity_NormalizedValue) GetDatetimeValue
func (x *Document_Entity_NormalizedValue) GetDatetimeValue() *datetime.DateTimefunc (*Document_Entity_NormalizedValue) GetFloatValue
func (x *Document_Entity_NormalizedValue) GetFloatValue() float32func (*Document_Entity_NormalizedValue) GetIntegerValue
func (x *Document_Entity_NormalizedValue) GetIntegerValue() int32func (*Document_Entity_NormalizedValue) GetMoneyValue
func (x *Document_Entity_NormalizedValue) GetMoneyValue() *money.Moneyfunc (*Document_Entity_NormalizedValue) GetStructuredValue
func (m *Document_Entity_NormalizedValue) GetStructuredValue() isDocument_Entity_NormalizedValue_StructuredValuefunc (*Document_Entity_NormalizedValue) GetText
func (x *Document_Entity_NormalizedValue) GetText() stringfunc (*Document_Entity_NormalizedValue) ProtoMessage
func (*Document_Entity_NormalizedValue) ProtoMessage()func (*Document_Entity_NormalizedValue) ProtoReflect
func (x *Document_Entity_NormalizedValue) ProtoReflect() protoreflect.Messagefunc (*Document_Entity_NormalizedValue) Reset
func (x *Document_Entity_NormalizedValue) Reset()func (*Document_Entity_NormalizedValue) String
func (x *Document_Entity_NormalizedValue) String() stringDocument_Entity_NormalizedValue_AddressValue
type Document_Entity_NormalizedValue_AddressValue struct {
// Postal address. See also:
// https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
AddressValue *postaladdress.PostalAddress `protobuf:"bytes,5,opt,name=address_value,json=addressValue,proto3,oneof"`
}Document_Entity_NormalizedValue_BooleanValue
type Document_Entity_NormalizedValue_BooleanValue struct {
// Boolean value. Can be used for entities with binary values, or for
// checkboxes.
BooleanValue bool `protobuf:"varint,6,opt,name=boolean_value,json=booleanValue,proto3,oneof"`
}Document_Entity_NormalizedValue_DateValue
type Document_Entity_NormalizedValue_DateValue struct {
// Date value. Includes year, month, day. See also:
// https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
DateValue *date.Date `protobuf:"bytes,3,opt,name=date_value,json=dateValue,proto3,oneof"`
}Document_Entity_NormalizedValue_DatetimeValue
type Document_Entity_NormalizedValue_DatetimeValue struct {
// DateTime value. Includes date, time, and timezone. See also:
// https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
DatetimeValue *datetime.DateTime `protobuf:"bytes,4,opt,name=datetime_value,json=datetimeValue,proto3,oneof"`
}Document_Entity_NormalizedValue_FloatValue
type Document_Entity_NormalizedValue_FloatValue struct {
// Float value.
FloatValue float32 `protobuf:"fixed32,8,opt,name=float_value,json=floatValue,proto3,oneof"`
}Document_Entity_NormalizedValue_IntegerValue
type Document_Entity_NormalizedValue_IntegerValue struct {
// Integer value.
IntegerValue int32 `protobuf:"varint,7,opt,name=integer_value,json=integerValue,proto3,oneof"`
}Document_Entity_NormalizedValue_MoneyValue
type Document_Entity_NormalizedValue_MoneyValue struct {
// Money value. See also:
// https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
MoneyValue *money.Money `protobuf:"bytes,2,opt,name=money_value,json=moneyValue,proto3,oneof"`
}Document_Page
type Document_Page struct {
// 1-based index for current
// [Page][google.cloud.documentai.v1beta3.Document.Page] in a parent
// [Document][google.cloud.documentai.v1beta3.Document]. Useful when a page
// is taken out of a [Document][google.cloud.documentai.v1beta3.Document]
// for individual processing.
PageNumber int32 `protobuf:"varint,1,opt,name=page_number,json=pageNumber,proto3" json:"page_number,omitempty"`
// Rendered image for this page. This image is preprocessed to remove any
// skew, rotation, and distortions such that the annotation bounding boxes
// can be upright and axis-aligned.
Image *Document_Page_Image `protobuf:"bytes,13,opt,name=image,proto3" json:"image,omitempty"`
// Transformation matrices that were applied to the original document image
// to produce
// [Page.image][google.cloud.documentai.v1beta3.Document.Page.image].
Transforms []*Document_Page_Matrix `protobuf:"bytes,14,rep,name=transforms,proto3" json:"transforms,omitempty"`
// Physical dimension of the page.
Dimension *Document_Page_Dimension `protobuf:"bytes,2,opt,name=dimension,proto3" json:"dimension,omitempty"`
// [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the
// page.
Layout *Document_Page_Layout `protobuf:"bytes,3,opt,name=layout,proto3" json:"layout,omitempty"`
// A list of detected languages together with confidence.
DetectedLanguages []*Document_Page_DetectedLanguage `protobuf:"bytes,4,rep,name=detected_languages,json=detectedLanguages,proto3" json:"detected_languages,omitempty"`
// A list of visually detected text blocks on the page.
// A block has a set of lines (collected into paragraphs) that have a common
// line-spacing and orientation.
Blocks []*Document_Page_Block `protobuf:"bytes,5,rep,name=blocks,proto3" json:"blocks,omitempty"`
// A list of visually detected text paragraphs on the page.
// A collection of lines that a human would perceive as a paragraph.
Paragraphs []*Document_Page_Paragraph `protobuf:"bytes,6,rep,name=paragraphs,proto3" json:"paragraphs,omitempty"`
// A list of visually detected text lines on the page.
// A collection of tokens that a human would perceive as a line.
Lines []*Document_Page_Line `protobuf:"bytes,7,rep,name=lines,proto3" json:"lines,omitempty"`
// A list of visually detected tokens on the page.
Tokens []*Document_Page_Token `protobuf:"bytes,8,rep,name=tokens,proto3" json:"tokens,omitempty"`
// A list of detected non-text visual elements e.g. checkbox,
// signature etc. on the page.
VisualElements []*Document_Page_VisualElement `protobuf:"bytes,9,rep,name=visual_elements,json=visualElements,proto3" json:"visual_elements,omitempty"`
// A list of visually detected tables on the page.
Tables []*Document_Page_Table `protobuf:"bytes,10,rep,name=tables,proto3" json:"tables,omitempty"`
// A list of visually detected form fields on the page.
FormFields []*Document_Page_FormField `protobuf:"bytes,11,rep,name=form_fields,json=formFields,proto3" json:"form_fields,omitempty"`
// A list of visually detected symbols on the page.
Symbols []*Document_Page_Symbol `protobuf:"bytes,12,rep,name=symbols,proto3" json:"symbols,omitempty"`
// A list of detected barcodes.
DetectedBarcodes []*Document_Page_DetectedBarcode `protobuf:"bytes,15,rep,name=detected_barcodes,json=detectedBarcodes,proto3" json:"detected_barcodes,omitempty"`
// Image Quality Scores.
ImageQualityScores *Document_Page_ImageQualityScores `protobuf:"bytes,17,opt,name=image_quality_scores,json=imageQualityScores,proto3" json:"image_quality_scores,omitempty"`
// The history of this page.
//
// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.
Provenance *Document_Provenance `protobuf:"bytes,16,opt,name=provenance,proto3" json:"provenance,omitempty"`
// contains filtered or unexported fields
}A page in a [Document][google.cloud.documentai.v1beta3.Document].
func (*Document_Page) Descriptor
func (*Document_Page) Descriptor() ([]byte, []int)Deprecated: Use Document_Page.ProtoReflect.Descriptor instead.
func (*Document_Page) GetBlocks
func (x *Document_Page) GetBlocks() []*Document_Page_Blockfunc (*Document_Page) GetDetectedBarcodes
func (x *Document_Page) GetDetectedBarcodes() []*Document_Page_DetectedBarcodefunc (*Document_Page) GetDetectedLanguages
func (x *Document_Page) GetDetectedLanguages() []*Document_Page_DetectedLanguagefunc (*Document_Page) GetDimension
func (x *Document_Page) GetDimension() *Document_Page_Dimensionfunc (*Document_Page) GetFormFields
func (x *Document_Page) GetFormFields() []*Document_Page_FormFieldfunc (*Document_Page) GetImage
func (x *Document_Page) GetImage() *Document_Page_Imagefunc (*Document_Page) GetImageQualityScores
func (x *Document_Page) GetImageQualityScores() *Document_Page_ImageQualityScoresfunc (*Document_Page) GetLayout
func (x *Document_Page) GetLayout() *Document_Page_Layoutfunc (*Document_Page) GetLines
func (x *Document_Page) GetLines() []*Document_Page_Linefunc (*Document_Page) GetPageNumber
func (x *Document_Page) GetPageNumber() int32func (*Document_Page) GetParagraphs
func (x *Document_Page) GetParagraphs() []*Document_Page_Paragraphfunc (*Document_Page) GetProvenance
func (x *Document_Page) GetProvenance() *Document_ProvenanceDeprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.
func (*Document_Page) GetSymbols
func (x *Document_Page) GetSymbols() []*Document_Page_Symbolfunc (*Document_Page) GetTables
func (x *Document_Page) GetTables() []*Document_Page_Tablefunc (*Document_Page) GetTokens
func (x *Document_Page) GetTokens() []*Document_Page_Tokenfunc (*Document_Page) GetTransforms
func (x *Document_Page) GetTransforms() []*Document_Page_Matrixfunc (*Document_Page) GetVisualElements
func (x *Document_Page) GetVisualElements() []*Document_Page_VisualElementfunc (*Document_Page) ProtoMessage
func (*Document_Page) ProtoMessage()func (*Document_Page) ProtoReflect
func (x *Document_Page) ProtoReflect() protoreflect.Messagefunc (*Document_Page) Reset
func (x *Document_Page) Reset()func (*Document_Page) String
func (x *Document_Page) String() stringDocument_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_PageReffunc (*Document_PageAnchor) ProtoMessage
func (*Document_PageAnchor) ProtoMessage()func (*Document_PageAnchor) ProtoReflect
func (x *Document_PageAnchor) ProtoReflect() protoreflect.Messagefunc (*Document_PageAnchor) Reset
func (x *Document_PageAnchor) Reset()func (*Document_PageAnchor) String
func (x *Document_PageAnchor) String() stringDocument_PageAnchor_PageRef
type Document_PageAnchor_PageRef struct {
Page int64 `protobuf:"varint,1,opt,name=page,proto3" json:"page,omitempty"`
LayoutType Document_PageAnchor_PageRef_LayoutType "" /* 168 byte string literal not displayed */
LayoutId string `protobuf:"bytes,3,opt,name=layout_id,json=layoutId,proto3" json:"layout_id,omitempty"`
BoundingPoly *BoundingPoly `protobuf:"bytes,4,opt,name=bounding_poly,json=boundingPoly,proto3" json:"bounding_poly,omitempty"`
Confidence float32 `protobuf:"fixed32,5,opt,name=confidence,proto3" json:"confidence,omitempty"`
}Represents a weak reference to a page element within a document.
func (*Document_PageAnchor_PageRef) Descriptor
func (*Document_PageAnchor_PageRef) Descriptor() ([]byte, []int)Deprecated: Use Document_PageAnchor_PageRef.ProtoReflect.Descriptor instead.
func (*Document_PageAnchor_PageRef) GetBoundingPoly
func (x *Document_PageAnchor_PageRef) GetBoundingPoly() *BoundingPolyfunc (*Document_PageAnchor_PageRef) GetConfidence
func (x *Document_PageAnchor_PageRef) GetConfidence() float32func (*Document_PageAnchor_PageRef) GetLayoutId
func (x *Document_PageAnchor_PageRef) GetLayoutId() stringDeprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.
func (*Document_PageAnchor_PageRef) GetLayoutType
func (x *Document_PageAnchor_PageRef) GetLayoutType() Document_PageAnchor_PageRef_LayoutTypefunc (*Document_PageAnchor_PageRef) GetPage
func (x *Document_PageAnchor_PageRef) GetPage() int64func (*Document_PageAnchor_PageRef) ProtoMessage
func (*Document_PageAnchor_PageRef) ProtoMessage()func (*Document_PageAnchor_PageRef) ProtoReflect
func (x *Document_PageAnchor_PageRef) ProtoReflect() protoreflect.Messagefunc (*Document_PageAnchor_PageRef) Reset
func (x *Document_PageAnchor_PageRef) Reset()func (*Document_PageAnchor_PageRef) String
func (x *Document_PageAnchor_PageRef) String() stringDocument_PageAnchor_PageRef_LayoutType
type Document_PageAnchor_PageRef_LayoutType int32The 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.EnumDescriptorfunc (Document_PageAnchor_PageRef_LayoutType) Enum
func (Document_PageAnchor_PageRef_LayoutType) EnumDescriptor
func (Document_PageAnchor_PageRef_LayoutType) EnumDescriptor() ([]byte, []int)Deprecated: Use Document_PageAnchor_PageRef_LayoutType.Descriptor instead.
func (Document_PageAnchor_PageRef_LayoutType) Number
func (x Document_PageAnchor_PageRef_LayoutType) Number() protoreflect.EnumNumberfunc (Document_PageAnchor_PageRef_LayoutType) String
func (x Document_PageAnchor_PageRef_LayoutType) String() stringfunc (Document_PageAnchor_PageRef_LayoutType) Type
func (Document_PageAnchor_PageRef_LayoutType) Type() protoreflect.EnumTypeDocument_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_DetectedLanguagefunc (*Document_Page_Block) GetLayout
func (x *Document_Page_Block) GetLayout() *Document_Page_Layoutfunc (*Document_Page_Block) GetProvenance
func (x *Document_Page_Block) GetProvenance() *Document_ProvenanceDeprecated: 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.Messagefunc (*Document_Page_Block) Reset
func (x *Document_Page_Block) Reset()func (*Document_Page_Block) String
func (x *Document_Page_Block) String() stringDocument_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() *Barcodefunc (*Document_Page_DetectedBarcode) GetLayout
func (x *Document_Page_DetectedBarcode) GetLayout() *Document_Page_Layoutfunc (*Document_Page_DetectedBarcode) ProtoMessage
func (*Document_Page_DetectedBarcode) ProtoMessage()func (*Document_Page_DetectedBarcode) ProtoReflect
func (x *Document_Page_DetectedBarcode) ProtoReflect() protoreflect.Messagefunc (*Document_Page_DetectedBarcode) Reset
func (x *Document_Page_DetectedBarcode) Reset()func (*Document_Page_DetectedBarcode) String
func (x *Document_Page_DetectedBarcode) String() stringDocument_Page_DetectedLanguage
type Document_Page_DetectedLanguage struct {
// The BCP-47 language code, such as `en-US` or `sr-Latn`. For more
// information, see
// https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
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() float32func (*Document_Page_DetectedLanguage) GetLanguageCode
func (x *Document_Page_DetectedLanguage) GetLanguageCode() stringfunc (*Document_Page_DetectedLanguage) ProtoMessage
func (*Document_Page_DetectedLanguage) ProtoMessage()func (*Document_Page_DetectedLanguage) ProtoReflect
func (x *Document_Page_DetectedLanguage) ProtoReflect() protoreflect.Messagefunc (*Document_Page_DetectedLanguage) Reset
func (x *Document_Page_DetectedLanguage) Reset()func (*Document_Page_DetectedLanguage) String
func (x *Document_Page_DetectedLanguage) String() stringDocument_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() float32func (*Document_Page_Dimension) GetUnit
func (x *Document_Page_Dimension) GetUnit() stringfunc (*Document_Page_Dimension) GetWidth
func (x *Document_Page_Dimension) GetWidth() float32func (*Document_Page_Dimension) ProtoMessage
func (*Document_Page_Dimension) ProtoMessage()func (*Document_Page_Dimension) ProtoReflect
func (x *Document_Page_Dimension) ProtoReflect() protoreflect.Messagefunc (*Document_Page_Dimension) Reset
func (x *Document_Page_Dimension) Reset()func (*Document_Page_Dimension) String
func (x *Document_Page_Dimension) String() stringDocument_Page_FormField
type Document_Page_FormField struct {
FieldName *Document_Page_Layout `protobuf:"bytes,1,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
FieldValue *Document_Page_Layout `protobuf:"bytes,2,opt,name=field_value,json=fieldValue,proto3" json:"field_value,omitempty"`
NameDetectedLanguages []*Document_Page_DetectedLanguage `protobuf:"bytes,3,rep,name=name_detected_languages,json=nameDetectedLanguages,proto3" json:"name_detected_languages,omitempty"`
ValueDetectedLanguages []*Document_Page_DetectedLanguage "" /* 129 byte string literal not displayed */
ValueType string `protobuf:"bytes,5,opt,name=value_type,json=valueType,proto3" json:"value_type,omitempty"`
CorrectedKeyText string `protobuf:"bytes,6,opt,name=corrected_key_text,json=correctedKeyText,proto3" json:"corrected_key_text,omitempty"`
CorrectedValueText string `protobuf:"bytes,7,opt,name=corrected_value_text,json=correctedValueText,proto3" json:"corrected_value_text,omitempty"`
Provenance *Document_Provenance `protobuf:"bytes,8,opt,name=provenance,proto3" json:"provenance,omitempty"`
}A form field detected on the page.
func (*Document_Page_FormField) Descriptor
func (*Document_Page_FormField) Descriptor() ([]byte, []int)Deprecated: Use Document_Page_FormField.ProtoReflect.Descriptor instead.
func (*Document_Page_FormField) GetCorrectedKeyText
func (x *Document_Page_FormField) GetCorrectedKeyText() stringfunc (*Document_Page_FormField) GetCorrectedValueText
func (x *Document_Page_FormField) GetCorrectedValueText() stringfunc (*Document_Page_FormField) GetFieldName
func (x *Document_Page_FormField) GetFieldName() *Document_Page_Layoutfunc (*Document_Page_FormField) GetFieldValue
func (x *Document_Page_FormField) GetFieldValue() *Document_Page_Layoutfunc (*Document_Page_FormField) GetNameDetectedLanguages
func (x *Document_Page_FormField) GetNameDetectedLanguages() []*Document_Page_DetectedLanguagefunc (*Document_Page_FormField) GetProvenance
func (x *Document_Page_FormField) GetProvenance() *Document_Provenancefunc (*Document_Page_FormField) GetValueDetectedLanguages
func (x *Document_Page_FormField) GetValueDetectedLanguages() []*Document_Page_DetectedLanguagefunc (*Document_Page_FormField) GetValueType
func (x *Document_Page_FormField) GetValueType() stringfunc (*Document_Page_FormField) ProtoMessage
func (*Document_Page_FormField) ProtoMessage()func (*Document_Page_FormField) ProtoReflect
func (x *Document_Page_FormField) ProtoReflect() protoreflect.Messagefunc (*Document_Page_FormField) Reset
func (x *Document_Page_FormField) Reset()func (*Document_Page_FormField) String
func (x *Document_Page_FormField) String() stringDocument_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 mime type 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() []bytefunc (*Document_Page_Image) GetHeight
func (x *Document_Page_Image) GetHeight() int32func (*Document_Page_Image) GetMimeType
func (x *Document_Page_Image) GetMimeType() stringfunc (*Document_Page_Image) GetWidth
func (x *Document_Page_Image) GetWidth() int32func (*Document_Page_Image) ProtoMessage
func (*Document_Page_Image) ProtoMessage()func (*Document_Page_Image) ProtoReflect
func (x *Document_Page_Image) ProtoReflect() protoreflect.Messagefunc (*Document_Page_Image) Reset
func (x *Document_Page_Image) Reset()func (*Document_Page_Image) String
func (x *Document_Page_Image) String() stringDocument_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_DetectedDefectfunc (*Document_Page_ImageQualityScores) GetQualityScore
func (x *Document_Page_ImageQualityScores) GetQualityScore() float32func (*Document_Page_ImageQualityScores) ProtoMessage
func (*Document_Page_ImageQualityScores) ProtoMessage()func (*Document_Page_ImageQualityScores) ProtoReflect
func (x *Document_Page_ImageQualityScores) ProtoReflect() protoreflect.Messagefunc (*Document_Page_ImageQualityScores) Reset
func (x *Document_Page_ImageQualityScores) Reset()func (*Document_Page_ImageQualityScores) String
func (x *Document_Page_ImageQualityScores) String() stringDocument_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 of 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() float32func (*Document_Page_ImageQualityScores_DetectedDefect) GetType
func (x *Document_Page_ImageQualityScores_DetectedDefect) GetType() stringfunc (*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.Messagefunc (*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() stringDocument_Page_Layout
type Document_Page_Layout struct {
TextAnchor *Document_TextAnchor `protobuf:"bytes,1,opt,name=text_anchor,json=textAnchor,proto3" json:"text_anchor,omitempty"`
Confidence float32 `protobuf:"fixed32,2,opt,name=confidence,proto3" json:"confidence,omitempty"`
BoundingPoly *BoundingPoly `protobuf:"bytes,3,opt,name=bounding_poly,json=boundingPoly,proto3" json:"bounding_poly,omitempty"`
Orientation Document_Page_Layout_Orientation "" /* 146 byte string literal not displayed */
}Visual element describing a layout unit on a page.
func (*Document_Page_Layout) Descriptor
func (*Document_Page_Layout) Descriptor() ([]byte, []int)Deprecated: Use Document_Page_Layout.ProtoReflect.Descriptor instead.
func (*Document_Page_Layout) GetBoundingPoly
func (x *Document_Page_Layout) GetBoundingPoly() *BoundingPolyfunc (*Document_Page_Layout) GetConfidence
func (x *Document_Page_Layout) GetConfidence() float32func (*Document_Page_Layout) GetOrientation
func (x *Document_Page_Layout) GetOrientation() Document_Page_Layout_Orientationfunc (*Document_Page_Layout) GetTextAnchor
func (x *Document_Page_Layout) GetTextAnchor() *Document_TextAnchorfunc (*Document_Page_Layout) ProtoMessage
func (*Document_Page_Layout) ProtoMessage()func (*Document_Page_Layout) ProtoReflect
func (x *Document_Page_Layout) ProtoReflect() protoreflect.Messagefunc (*Document_Page_Layout) Reset
func (x *Document_Page_Layout) Reset()func (*Document_Page_Layout) String
func (x *Document_Page_Layout) String() stringDocument_Page_Layout_Orientation
type Document_Page_Layout_Orientation int32Detected 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.EnumDescriptorfunc (Document_Page_Layout_Orientation) Enum
func (x Document_Page_Layout_Orientation) Enum() *Document_Page_Layout_Orientationfunc (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.EnumNumberfunc (Document_Page_Layout_Orientation) String
func (x Document_Page_Layout_Orientation) String() stringfunc (Document_Page_Layout_Orientation) Type
func (Document_Page_Layout_Orientation) Type() protoreflect.EnumTypeDocument_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_DetectedLanguagefunc (*Document_Page_Line) GetLayout
func (x *Document_Page_Line) GetLayout() *Document_Page_Layoutfunc (*Document_Page_Line) GetProvenance
func (x *Document_Page_Line) GetProvenance() *Document_ProvenanceDeprecated: 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.Messagefunc (*Document_Page_Line) Reset
func (x *Document_Page_Line) Reset()func (*Document_Page_Line) String
func (x *Document_Page_Line) String() stringDocument_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() int32func (*Document_Page_Matrix) GetData
func (x *Document_Page_Matrix) GetData() []bytefunc (*Document_Page_Matrix) GetRows
func (x *Document_Page_Matrix) GetRows() int32func (*Document_Page_Matrix) GetType
func (x *Document_Page_Matrix) GetType() int32func (*Document_Page_Matrix) ProtoMessage
func (*Document_Page_Matrix) ProtoMessage()func (*Document_Page_Matrix) ProtoReflect
func (x *Document_Page_Matrix) ProtoReflect() protoreflect.Messagefunc (*Document_Page_Matrix) Reset
func (x *Document_Page_Matrix) Reset()func (*Document_Page_Matrix) String
func (x *Document_Page_Matrix) String() stringDocument_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_DetectedLanguagefunc (*Document_Page_Paragraph) GetLayout
func (x *Document_Page_Paragraph) GetLayout() *Document_Page_Layoutfunc (*Document_Page_Paragraph) GetProvenance
func (x *Document_Page_Paragraph) GetProvenance() *Document_ProvenanceDeprecated: 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.Messagefunc (*Document_Page_Paragraph) Reset
func (x *Document_Page_Paragraph) Reset()func (*Document_Page_Paragraph) String
func (x *Document_Page_Paragraph) String() stringDocument_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_DetectedLanguagefunc (*Document_Page_Symbol) GetLayout
func (x *Document_Page_Symbol) GetLayout() *Document_Page_Layoutfunc (*Document_Page_Symbol) ProtoMessage
func (*Document_Page_Symbol) ProtoMessage()func (*Document_Page_Symbol) ProtoReflect
func (x *Document_Page_Symbol) ProtoReflect() protoreflect.Messagefunc (*Document_Page_Symbol) Reset
func (x *Document_Page_Symbol) Reset()func (*Document_Page_Symbol) String
func (x *Document_Page_Symbol) String() stringDocument_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.
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_TableRowfunc (*Document_Page_Table) GetDetectedLanguages
func (x *Document_Page_Table) GetDetectedLanguages() []*Document_Page_DetectedLanguagefunc (*Document_Page_Table) GetHeaderRows
func (x *Document_Page_Table) GetHeaderRows() []*Document_Page_Table_TableRowfunc (*Document_Page_Table) GetLayout
func (x *Document_Page_Table) GetLayout() *Document_Page_Layoutfunc (*Document_Page_Table) GetProvenance
func (x *Document_Page_Table) GetProvenance() *Document_Provenancefunc (*Document_Page_Table) ProtoMessage
func (*Document_Page_Table) ProtoMessage()func (*Document_Page_Table) ProtoReflect
func (x *Document_Page_Table) ProtoReflect() protoreflect.Messagefunc (*Document_Page_Table) Reset
func (x *Document_Page_Table) Reset()func (*Document_Page_Table) String
func (x *Document_Page_Table) String() stringDocument_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() int32func (*Document_Page_Table_TableCell) GetDetectedLanguages
func (x *Document_Page_Table_TableCell) GetDetectedLanguages() []*Document_Page_DetectedLanguagefunc (*Document_Page_Table_TableCell) GetLayout
func (x *Document_Page_Table_TableCell) GetLayout() *Document_Page_Layoutfunc (*Document_Page_Table_TableCell) GetRowSpan
func (x *Document_Page_Table_TableCell) GetRowSpan() int32func (*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.Messagefunc (*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() stringDocument_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_TableCellfunc (*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.Messagefunc (*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() stringDocument_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"`
// 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_DetectedBreakfunc (*Document_Page_Token) GetDetectedLanguages
func (x *Document_Page_Token) GetDetectedLanguages() []*Document_Page_DetectedLanguagefunc (*Document_Page_Token) GetLayout
func (x *Document_Page_Token) GetLayout() *Document_Page_Layoutfunc (*Document_Page_Token) GetProvenance
func (x *Document_Page_Token) GetProvenance() *Document_ProvenanceDeprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.
func (*Document_Page_Token) ProtoMessage
func (*Document_Page_Token) ProtoMessage()func (*Document_Page_Token) ProtoReflect
func (x *Document_Page_Token) ProtoReflect() protoreflect.Messagefunc (*Document_Page_Token) Reset
func (x *Document_Page_Token) Reset()func (*Document_Page_Token) String
func (x *Document_Page_Token) String() stringDocument_Page_Token_DetectedBreak
type Document_Page_Token_DetectedBreak struct {
Type Document_Page_Token_DetectedBreak_Type "" /* 138 byte string literal not displayed */
}Detected break at the end of a [Token][google.cloud.documentai.v1beta3.Document.Page.Token].
func (*Document_Page_Token_DetectedBreak) Descriptor
func (*Document_Page_Token_DetectedBreak) Descriptor() ([]byte, []int)Deprecated: Use Document_Page_Token_DetectedBreak.ProtoReflect.Descriptor instead.
func (*Document_Page_Token_DetectedBreak) GetType
func (x *Document_Page_Token_DetectedBreak) GetType() Document_Page_Token_DetectedBreak_Typefunc (*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.Messagefunc (*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() stringDocument_Page_Token_DetectedBreak_Type
type Document_Page_Token_DetectedBreak_Type int32Enum 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.EnumDescriptorfunc (Document_Page_Token_DetectedBreak_Type) Enum
func (Document_Page_Token_DetectedBreak_Type) EnumDescriptor
func (Document_Page_Token_DetectedBreak_Type) EnumDescriptor() ([]byte, []int)Deprecated: Use Document_Page_Token_DetectedBreak_Type.Descriptor instead.
func (Document_Page_Token_DetectedBreak_Type) Number
func (x Document_Page_Token_DetectedBreak_Type) Number() protoreflect.EnumNumberfunc (Document_Page_Token_DetectedBreak_Type) String
func (x Document_Page_Token_DetectedBreak_Type) String() stringfunc (Document_Page_Token_DetectedBreak_Type) Type
func (Document_Page_Token_DetectedBreak_Type) Type() protoreflect.EnumTypeDocument_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_DetectedLanguagefunc (*Document_Page_VisualElement) GetLayout
func (x *Document_Page_VisualElement) GetLayout() *Document_Page_Layoutfunc (*Document_Page_VisualElement) GetType
func (x *Document_Page_VisualElement) GetType() stringfunc (*Document_Page_VisualElement) ProtoMessage
func (*Document_Page_VisualElement) ProtoMessage()func (*Document_Page_VisualElement) ProtoReflect
func (x *Document_Page_VisualElement) ProtoReflect() protoreflect.Messagefunc (*Document_Page_VisualElement) Reset
func (x *Document_Page_VisualElement) Reset()func (*Document_Page_VisualElement) String
func (x *Document_Page_VisualElement) String() stringDocument_Provenance
type Document_Provenance struct {
Revision int32 `protobuf:"varint,1,opt,name=revision,proto3" json:"revision,omitempty"`
Id int32 `protobuf:"varint,2,opt,name=id,proto3" json:"id,omitempty"`
Parents []*Document_Provenance_Parent `protobuf:"bytes,3,rep,name=parents,proto3" json:"parents,omitempty"`
Type Document_Provenance_OperationType "" /* 133 byte string literal not displayed */
}Structure to identify provenance relationships between annotations in different revisions.
func (*Document_Provenance) Descriptor
func (*Document_Provenance) Descriptor() ([]byte, []int)Deprecated: Use Document_Provenance.ProtoReflect.Descriptor instead.
func (*Document_Provenance) GetId
func (x *Document_Provenance) GetId() int32Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.
func (*Document_Provenance) GetParents
func (x *Document_Provenance) GetParents() []*Document_Provenance_Parentfunc (*Document_Provenance) GetRevision
func (x *Document_Provenance) GetRevision() int32Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.
func (*Document_Provenance) GetType
func (x *Document_Provenance) GetType() Document_Provenance_OperationTypefunc (*Document_Provenance) ProtoMessage
func (*Document_Provenance) ProtoMessage()func (*Document_Provenance) ProtoReflect
func (x *Document_Provenance) ProtoReflect() protoreflect.Messagefunc (*Document_Provenance) Reset
func (x *Document_Provenance) Reset()func (*Document_Provenance) String
func (x *Document_Provenance) String() stringDocument_Provenance_OperationType
type Document_Provenance_OperationType int32If 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. This is
// especially relevant when we just want to update a field value of an
// entity without also affecting all the child properties.
Document_Provenance_UPDATE Document_Provenance_OperationType = 7
// Currently unused. Replace an element identified by `parent`.
//
// Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.
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.EnumDescriptorfunc (Document_Provenance_OperationType) Enum
func (x Document_Provenance_OperationType) Enum() *Document_Provenance_OperationTypefunc (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.EnumNumberfunc (Document_Provenance_OperationType) String
func (x Document_Provenance_OperationType) String() stringfunc (Document_Provenance_OperationType) Type
func (Document_Provenance_OperationType) Type() protoreflect.EnumTypeDocument_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() int32Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.
func (*Document_Provenance_Parent) GetIndex
func (x *Document_Provenance_Parent) GetIndex() int32func (*Document_Provenance_Parent) GetRevision
func (x *Document_Provenance_Parent) GetRevision() int32func (*Document_Provenance_Parent) ProtoMessage
func (*Document_Provenance_Parent) ProtoMessage()func (*Document_Provenance_Parent) ProtoReflect
func (x *Document_Provenance_Parent) ProtoReflect() protoreflect.Messagefunc (*Document_Provenance_Parent) Reset
func (x *Document_Provenance_Parent) Reset()func (*Document_Provenance_Parent) String
func (x *Document_Provenance_Parent) String() stringDocument_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() stringfunc (*Document_Revision) GetCreateTime
func (x *Document_Revision) GetCreateTime() *timestamppb.Timestampfunc (*Document_Revision) GetHumanReview
func (x *Document_Revision) GetHumanReview() *Document_Revision_HumanReviewfunc (*Document_Revision) GetId
func (x *Document_Revision) GetId() stringfunc (*Document_Revision) GetParent
func (x *Document_Revision) GetParent() []int32Deprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.
func (*Document_Revision) GetParentIds
func (x *Document_Revision) GetParentIds() []stringfunc (*Document_Revision) GetProcessor
func (x *Document_Revision) GetProcessor() stringfunc (*Document_Revision) GetSource
func (m *Document_Revision) GetSource() isDocument_Revision_Sourcefunc (*Document_Revision) ProtoMessage
func (*Document_Revision) ProtoMessage()func (*Document_Revision) ProtoReflect
func (x *Document_Revision) ProtoReflect() protoreflect.Messagefunc (*Document_Revision) Reset
func (x *Document_Revision) Reset()func (*Document_Revision) String
func (x *Document_Revision) String() stringDocument_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() stringfunc (*Document_Revision_HumanReview) GetStateMessage
func (x *Document_Revision_HumanReview) GetStateMessage() stringfunc (*Document_Revision_HumanReview) ProtoMessage
func (*Document_Revision_HumanReview) ProtoMessage()func (*Document_Revision_HumanReview) ProtoReflect
func (x *Document_Revision_HumanReview) ProtoReflect() protoreflect.Messagefunc (*Document_Revision_HumanReview) Reset
func (x *Document_Revision_HumanReview) Reset()func (*Document_Revision_HumanReview) String
func (x *Document_Revision_HumanReview) String() stringDocument_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() int64func (*Document_ShardInfo) GetShardIndex
func (x *Document_ShardInfo) GetShardIndex() int64func (*Document_ShardInfo) GetTextOffset
func (x *Document_ShardInfo) GetTextOffset() int64func (*Document_ShardInfo) ProtoMessage
func (*Document_ShardInfo) ProtoMessage()func (*Document_ShardInfo) ProtoReflect
func (x *Document_ShardInfo) ProtoReflect() protoreflect.Messagefunc (*Document_ShardInfo) Reset
func (x *Document_ShardInfo) Reset()func (*Document_ShardInfo) String
func (x *Document_ShardInfo) String() stringDocument_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. Possible values are normal, bold, bolder, and lighter.
// https://www.w3schools.com/cssref/pr_font_weight.asp
FontWeight string `protobuf:"bytes,4,opt,name=font_weight,json=fontWeight,proto3" json:"font_weight,omitempty"`
// Text style. Possible values are normal, italic, and oblique.
// https://www.w3schools.com/cssref/pr_font_font-style.asp
TextStyle string `protobuf:"bytes,5,opt,name=text_style,json=textStyle,proto3" json:"text_style,omitempty"`
// Text decoration. 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.Colorfunc (*Document_Style) GetColor
func (x *Document_Style) GetColor() *color.Colorfunc (*Document_Style) GetFontFamily
func (x *Document_Style) GetFontFamily() stringfunc (*Document_Style) GetFontSize
func (x *Document_Style) GetFontSize() *Document_Style_FontSizefunc (*Document_Style) GetFontWeight
func (x *Document_Style) GetFontWeight() stringfunc (*Document_Style) GetTextAnchor
func (x *Document_Style) GetTextAnchor() *Document_TextAnchorfunc (*Document_Style) GetTextDecoration
func (x *Document_Style) GetTextDecoration() stringfunc (*Document_Style) GetTextStyle
func (x *Document_Style) GetTextStyle() stringfunc (*Document_Style) ProtoMessage
func (*Document_Style) ProtoMessage()func (*Document_Style) ProtoReflect
func (x *Document_Style) ProtoReflect() protoreflect.Messagefunc (*Document_Style) Reset
func (x *Document_Style) Reset()func (*Document_Style) String
func (x *Document_Style) String() stringDocument_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 (in, px, pt, etc.).
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() float32func (*Document_Style_FontSize) GetUnit
func (x *Document_Style_FontSize) GetUnit() stringfunc (*Document_Style_FontSize) ProtoMessage
func (*Document_Style_FontSize) ProtoMessage()func (*Document_Style_FontSize) ProtoReflect
func (x *Document_Style_FontSize) ProtoReflect() protoreflect.Messagefunc (*Document_Style_FontSize) Reset
func (x *Document_Style_FontSize) Reset()func (*Document_Style_FontSize) String
func (x *Document_Style_FontSize) String() stringDocument_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() stringfunc (*Document_TextAnchor) GetTextSegments
func (x *Document_TextAnchor) GetTextSegments() []*Document_TextAnchor_TextSegmentfunc (*Document_TextAnchor) ProtoMessage
func (*Document_TextAnchor) ProtoMessage()func (*Document_TextAnchor) ProtoReflect
func (x *Document_TextAnchor) ProtoReflect() protoreflect.Messagefunc (*Document_TextAnchor) Reset
func (x *Document_TextAnchor) Reset()func (*Document_TextAnchor) String
func (x *Document_TextAnchor) String() stringDocument_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() int64func (*Document_TextAnchor_TextSegment) GetStartIndex
func (x *Document_TextAnchor_TextSegment) GetStartIndex() int64func (*Document_TextAnchor_TextSegment) ProtoMessage
func (*Document_TextAnchor_TextSegment) ProtoMessage()func (*Document_TextAnchor_TextSegment) ProtoReflect
func (x *Document_TextAnchor_TextSegment) ProtoReflect() protoreflect.Messagefunc (*Document_TextAnchor_TextSegment) Reset
func (x *Document_TextAnchor_TextSegment) Reset()func (*Document_TextAnchor_TextSegment) String
func (x *Document_TextAnchor_TextSegment) String() stringDocument_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() stringfunc (*Document_TextChange) GetProvenance
func (x *Document_TextChange) GetProvenance() []*Document_ProvenanceDeprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document.proto.
func (*Document_TextChange) GetTextAnchor
func (x *Document_TextChange) GetTextAnchor() *Document_TextAnchorfunc (*Document_TextChange) ProtoMessage
func (*Document_TextChange) ProtoMessage()func (*Document_TextChange) ProtoReflect
func (x *Document_TextChange) ProtoReflect() protoreflect.Messagefunc (*Document_TextChange) Reset
func (x *Document_TextChange) Reset()func (*Document_TextChange) String
func (x *Document_TextChange) String() stringDocument_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.
// See [Google Cloud Storage Request
// URIs](https://cloud.google.com/storage/docs/reference-uris) for more
// info.
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 enable processor method.
func (*EnableProcessorMetadata) Descriptor
func (*EnableProcessorMetadata) Descriptor() ([]byte, []int)Deprecated: Use EnableProcessorMetadata.ProtoReflect.Descriptor instead.
func (*EnableProcessorMetadata) GetCommonMetadata
func (x *EnableProcessorMetadata) GetCommonMetadata() *CommonOperationMetadatafunc (*EnableProcessorMetadata) ProtoMessage
func (*EnableProcessorMetadata) ProtoMessage()func (*EnableProcessorMetadata) ProtoReflect
func (x *EnableProcessorMetadata) ProtoReflect() protoreflect.Messagefunc (*EnableProcessorMetadata) Reset
func (x *EnableProcessorMetadata) Reset()func (*EnableProcessorMetadata) String
func (x *EnableProcessorMetadata) String() stringEnableProcessorRequest
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 enable processor method.
func (*EnableProcessorRequest) Descriptor
func (*EnableProcessorRequest) Descriptor() ([]byte, []int)Deprecated: Use EnableProcessorRequest.ProtoReflect.Descriptor instead.
func (*EnableProcessorRequest) GetName
func (x *EnableProcessorRequest) GetName() stringfunc (*EnableProcessorRequest) ProtoMessage
func (*EnableProcessorRequest) ProtoMessage()func (*EnableProcessorRequest) ProtoReflect
func (x *EnableProcessorRequest) ProtoReflect() protoreflect.Messagefunc (*EnableProcessorRequest) Reset
func (x *EnableProcessorRequest) Reset()func (*EnableProcessorRequest) String
func (x *EnableProcessorRequest) String() stringEnableProcessorResponse
type EnableProcessorResponse struct {
// contains filtered or unexported fields
}Response message for the enable processor 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.Messagefunc (*EnableProcessorResponse) Reset
func (x *EnableProcessorResponse) Reset()func (*EnableProcessorResponse) String
func (x *EnableProcessorResponse) String() stringEvaluateProcessorVersionMetadata
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 method.
func (*EvaluateProcessorVersionMetadata) Descriptor
func (*EvaluateProcessorVersionMetadata) Descriptor() ([]byte, []int)Deprecated: Use EvaluateProcessorVersionMetadata.ProtoReflect.Descriptor instead.
func (*EvaluateProcessorVersionMetadata) GetCommonMetadata
func (x *EvaluateProcessorVersionMetadata) GetCommonMetadata() *CommonOperationMetadatafunc (*EvaluateProcessorVersionMetadata) ProtoMessage
func (*EvaluateProcessorVersionMetadata) ProtoMessage()func (*EvaluateProcessorVersionMetadata) ProtoReflect
func (x *EvaluateProcessorVersionMetadata) ProtoReflect() protoreflect.Messagefunc (*EvaluateProcessorVersionMetadata) Reset
func (x *EvaluateProcessorVersionMetadata) Reset()func (*EvaluateProcessorVersionMetadata) String
func (x *EvaluateProcessorVersionMetadata) String() stringEvaluateProcessorVersionRequest
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 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() *BatchDocumentsInputConfigfunc (*EvaluateProcessorVersionRequest) GetProcessorVersion
func (x *EvaluateProcessorVersionRequest) GetProcessorVersion() stringfunc (*EvaluateProcessorVersionRequest) ProtoMessage
func (*EvaluateProcessorVersionRequest) ProtoMessage()func (*EvaluateProcessorVersionRequest) ProtoReflect
func (x *EvaluateProcessorVersionRequest) ProtoReflect() protoreflect.Messagefunc (*EvaluateProcessorVersionRequest) Reset
func (x *EvaluateProcessorVersionRequest) Reset()func (*EvaluateProcessorVersionRequest) String
func (x *EvaluateProcessorVersionRequest) String() stringEvaluateProcessorVersionResponse
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
}Metadata of the EvaluateProcessorVersion method.
func (*EvaluateProcessorVersionResponse) Descriptor
func (*EvaluateProcessorVersionResponse) Descriptor() ([]byte, []int)Deprecated: Use EvaluateProcessorVersionResponse.ProtoReflect.Descriptor instead.
func (*EvaluateProcessorVersionResponse) GetEvaluation
func (x *EvaluateProcessorVersionResponse) GetEvaluation() stringfunc (*EvaluateProcessorVersionResponse) ProtoMessage
func (*EvaluateProcessorVersionResponse) ProtoMessage()func (*EvaluateProcessorVersionResponse) ProtoReflect
func (x *EvaluateProcessorVersionResponse) ProtoReflect() protoreflect.Messagefunc (*EvaluateProcessorVersionResponse) Reset
func (x *EvaluateProcessorVersionResponse) Reset()func (*EvaluateProcessorVersionResponse) String
func (x *EvaluateProcessorVersionResponse) String() stringEvaluation
type Evaluation struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
DocumentCounters *Evaluation_Counters `protobuf:"bytes,5,opt,name=document_counters,json=documentCounters,proto3" json:"document_counters,omitempty"`
AllEntitiesMetrics *Evaluation_MultiConfidenceMetrics `protobuf:"bytes,3,opt,name=all_entities_metrics,json=allEntitiesMetrics,proto3" json:"all_entities_metrics,omitempty"`
EntityMetrics map[string]*Evaluation_MultiConfidenceMetrics "" /* 188 byte string literal not displayed */
KmsKeyName string `protobuf:"bytes,6,opt,name=kms_key_name,json=kmsKeyName,proto3" json:"kms_key_name,omitempty"`
KmsKeyVersionName string `protobuf:"bytes,7,opt,name=kms_key_version_name,json=kmsKeyVersionName,proto3" json:"kms_key_version_name,omitempty"`
}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_MultiConfidenceMetricsfunc (*Evaluation) GetCreateTime
func (x *Evaluation) GetCreateTime() *timestamppb.Timestampfunc (*Evaluation) GetDocumentCounters
func (x *Evaluation) GetDocumentCounters() *Evaluation_Countersfunc (*Evaluation) GetEntityMetrics
func (x *Evaluation) GetEntityMetrics() map[string]*Evaluation_MultiConfidenceMetricsfunc (*Evaluation) GetKmsKeyName
func (x *Evaluation) GetKmsKeyName() stringfunc (*Evaluation) GetKmsKeyVersionName
func (x *Evaluation) GetKmsKeyVersionName() stringfunc (*Evaluation) GetName
func (x *Evaluation) GetName() stringfunc (*Evaluation) ProtoMessage
func (*Evaluation) ProtoMessage()func (*Evaluation) ProtoReflect
func (x *Evaluation) ProtoReflect() protoreflect.Messagefunc (*Evaluation) Reset
func (x *Evaluation) Reset()func (*Evaluation) String
func (x *Evaluation) String() stringEvaluationReference
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_Metricsfunc (*EvaluationReference) GetAggregateMetricsExact
func (x *EvaluationReference) GetAggregateMetricsExact() *Evaluation_Metricsfunc (*EvaluationReference) GetEvaluation
func (x *EvaluationReference) GetEvaluation() stringfunc (*EvaluationReference) GetOperation
func (x *EvaluationReference) GetOperation() stringfunc (*EvaluationReference) ProtoMessage
func (*EvaluationReference) ProtoMessage()func (*EvaluationReference) ProtoReflect
func (x *EvaluationReference) ProtoReflect() protoreflect.Messagefunc (*EvaluationReference) Reset
func (x *EvaluationReference) Reset()func (*EvaluationReference) String
func (x *EvaluationReference) String() stringEvaluation_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() float32func (*Evaluation_ConfidenceLevelMetrics) GetMetrics
func (x *Evaluation_ConfidenceLevelMetrics) GetMetrics() *Evaluation_Metricsfunc (*Evaluation_ConfidenceLevelMetrics) ProtoMessage
func (*Evaluation_ConfidenceLevelMetrics) ProtoMessage()func (*Evaluation_ConfidenceLevelMetrics) ProtoReflect
func (x *Evaluation_ConfidenceLevelMetrics) ProtoReflect() protoreflect.Messagefunc (*Evaluation_ConfidenceLevelMetrics) Reset
func (x *Evaluation_ConfidenceLevelMetrics) Reset()func (*Evaluation_ConfidenceLevelMetrics) String
func (x *Evaluation_ConfidenceLevelMetrics) String() stringEvaluation_Counters
type Evaluation_Counters struct {
InputDocumentsCount int32 `protobuf:"varint,1,opt,name=input_documents_count,json=inputDocumentsCount,proto3" json:"input_documents_count,omitempty"`
InvalidDocumentsCount int32 "" /* 127 byte string literal not displayed */
FailedDocumentsCount int32 `protobuf:"varint,3,opt,name=failed_documents_count,json=failedDocumentsCount,proto3" json:"failed_documents_count,omitempty"`
EvaluatedDocumentsCount int32 "" /* 133 byte string literal not displayed */
}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() int32func (*Evaluation_Counters) GetFailedDocumentsCount
func (x *Evaluation_Counters) GetFailedDocumentsCount() int32func (*Evaluation_Counters) GetInputDocumentsCount
func (x *Evaluation_Counters) GetInputDocumentsCount() int32func (*Evaluation_Counters) GetInvalidDocumentsCount
func (x *Evaluation_Counters) GetInvalidDocumentsCount() int32func (*Evaluation_Counters) ProtoMessage
func (*Evaluation_Counters) ProtoMessage()func (*Evaluation_Counters) ProtoReflect
func (x *Evaluation_Counters) ProtoReflect() protoreflect.Messagefunc (*Evaluation_Counters) Reset
func (x *Evaluation_Counters) Reset()func (*Evaluation_Counters) String
func (x *Evaluation_Counters) String() stringEvaluation_Metrics
type Evaluation_Metrics struct {
Precision float32 `protobuf:"fixed32,1,opt,name=precision,proto3" json:"precision,omitempty"`
Recall float32 `protobuf:"fixed32,2,opt,name=recall,proto3" json:"recall,omitempty"`
F1Score float32 `protobuf:"fixed32,3,opt,name=f1_score,json=f1Score,proto3" json:"f1_score,omitempty"`
PredictedOccurrencesCount int32 "" /* 139 byte string literal not displayed */
GroundTruthOccurrencesCount int32 "" /* 147 byte string literal not displayed */
PredictedDocumentCount int32 "" /* 131 byte string literal not displayed */
GroundTruthDocumentCount int32 "" /* 139 byte string literal not displayed */
TruePositivesCount int32 `protobuf:"varint,6,opt,name=true_positives_count,json=truePositivesCount,proto3" json:"true_positives_count,omitempty"`
FalsePositivesCount int32 `protobuf:"varint,7,opt,name=false_positives_count,json=falsePositivesCount,proto3" json:"false_positives_count,omitempty"`
FalseNegativesCount int32 `protobuf:"varint,8,opt,name=false_negatives_count,json=falseNegativesCount,proto3" json:"false_negatives_count,omitempty"`
TotalDocumentsCount int32 `protobuf:"varint,9,opt,name=total_documents_count,json=totalDocumentsCount,proto3" json:"total_documents_count,omitempty"`
}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() float32func (*Evaluation_Metrics) GetFalseNegativesCount
func (x *Evaluation_Metrics) GetFalseNegativesCount() int32func (*Evaluation_Metrics) GetFalsePositivesCount
func (x *Evaluation_Metrics) GetFalsePositivesCount() int32func (*Evaluation_Metrics) GetGroundTruthDocumentCount
func (x *Evaluation_Metrics) GetGroundTruthDocumentCount() int32func (*Evaluation_Metrics) GetGroundTruthOccurrencesCount
func (x *Evaluation_Metrics) GetGroundTruthOccurrencesCount() int32func (*Evaluation_Metrics) GetPrecision
func (x *Evaluation_Metrics) GetPrecision() float32func (*Evaluation_Metrics) GetPredictedDocumentCount
func (x *Evaluation_Metrics) GetPredictedDocumentCount() int32func (*Evaluation_Metrics) GetPredictedOccurrencesCount
func (x *Evaluation_Metrics) GetPredictedOccurrencesCount() int32func (*Evaluation_Metrics) GetRecall
func (x *Evaluation_Metrics) GetRecall() float32func (*Evaluation_Metrics) GetTotalDocumentsCount
func (x *Evaluation_Metrics) GetTotalDocumentsCount() int32func (*Evaluation_Metrics) GetTruePositivesCount
func (x *Evaluation_Metrics) GetTruePositivesCount() int32func (*Evaluation_Metrics) ProtoMessage
func (*Evaluation_Metrics) ProtoMessage()func (*Evaluation_Metrics) ProtoReflect
func (x *Evaluation_Metrics) ProtoReflect() protoreflect.Messagefunc (*Evaluation_Metrics) Reset
func (x *Evaluation_Metrics) Reset()func (*Evaluation_Metrics) String
func (x *Evaluation_Metrics) String() stringEvaluation_MultiConfidenceMetrics
type Evaluation_MultiConfidenceMetrics struct {
ConfidenceLevelMetrics []*Evaluation_ConfidenceLevelMetrics "" /* 129 byte string literal not displayed */
ConfidenceLevelMetricsExact []*Evaluation_ConfidenceLevelMetrics "" /* 146 byte string literal not displayed */
Auprc float32 `protobuf:"fixed32,2,opt,name=auprc,proto3" json:"auprc,omitempty"`
EstimatedCalibrationError float32 "" /* 140 byte string literal not displayed */
AuprcExact float32 `protobuf:"fixed32,5,opt,name=auprc_exact,json=auprcExact,proto3" json:"auprc_exact,omitempty"`
EstimatedCalibrationErrorExact float32 "" /* 157 byte string literal not displayed */
MetricsType Evaluation_MultiConfidenceMetrics_MetricsType "" /* 178 byte string literal not displayed */
}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() float32func (*Evaluation_MultiConfidenceMetrics) GetAuprcExact
func (x *Evaluation_MultiConfidenceMetrics) GetAuprcExact() float32func (*Evaluation_MultiConfidenceMetrics) GetConfidenceLevelMetrics
func (x *Evaluation_MultiConfidenceMetrics) GetConfidenceLevelMetrics() []*Evaluation_ConfidenceLevelMetricsfunc (*Evaluation_MultiConfidenceMetrics) GetConfidenceLevelMetricsExact
func (x *Evaluation_MultiConfidenceMetrics) GetConfidenceLevelMetricsExact() []*Evaluation_ConfidenceLevelMetricsfunc (*Evaluation_MultiConfidenceMetrics) GetEstimatedCalibrationError
func (x *Evaluation_MultiConfidenceMetrics) GetEstimatedCalibrationError() float32func (*Evaluation_MultiConfidenceMetrics) GetEstimatedCalibrationErrorExact
func (x *Evaluation_MultiConfidenceMetrics) GetEstimatedCalibrationErrorExact() float32func (*Evaluation_MultiConfidenceMetrics) GetMetricsType
func (x *Evaluation_MultiConfidenceMetrics) GetMetricsType() Evaluation_MultiConfidenceMetrics_MetricsTypefunc (*Evaluation_MultiConfidenceMetrics) ProtoMessage
func (*Evaluation_MultiConfidenceMetrics) ProtoMessage()func (*Evaluation_MultiConfidenceMetrics) ProtoReflect
func (x *Evaluation_MultiConfidenceMetrics) ProtoReflect() protoreflect.Messagefunc (*Evaluation_MultiConfidenceMetrics) Reset
func (x *Evaluation_MultiConfidenceMetrics) Reset()func (*Evaluation_MultiConfidenceMetrics) String
func (x *Evaluation_MultiConfidenceMetrics) String() stringEvaluation_MultiConfidenceMetrics_MetricsType
type Evaluation_MultiConfidenceMetrics_MetricsType int32A 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.EnumDescriptorfunc (Evaluation_MultiConfidenceMetrics_MetricsType) Enum
func (x Evaluation_MultiConfidenceMetrics_MetricsType) Enum() *Evaluation_MultiConfidenceMetrics_MetricsTypefunc (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.EnumNumberfunc (Evaluation_MultiConfidenceMetrics_MetricsType) String
func (x Evaluation_MultiConfidenceMetrics_MetricsType) String() stringfunc (Evaluation_MultiConfidenceMetrics_MetricsType) Type
FetchProcessorTypesRequest
type FetchProcessorTypesRequest struct {
// Required. The project of processor type to list.
// The available processor types may depend on the allow-listing on projects.
// 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 fetch processor types.
func (*FetchProcessorTypesRequest) Descriptor
func (*FetchProcessorTypesRequest) Descriptor() ([]byte, []int)Deprecated: Use FetchProcessorTypesRequest.ProtoReflect.Descriptor instead.
func (*FetchProcessorTypesRequest) GetParent
func (x *FetchProcessorTypesRequest) GetParent() stringfunc (*FetchProcessorTypesRequest) ProtoMessage
func (*FetchProcessorTypesRequest) ProtoMessage()func (*FetchProcessorTypesRequest) ProtoReflect
func (x *FetchProcessorTypesRequest) ProtoReflect() protoreflect.Messagefunc (*FetchProcessorTypesRequest) Reset
func (x *FetchProcessorTypesRequest) Reset()func (*FetchProcessorTypesRequest) String
func (x *FetchProcessorTypesRequest) String() stringFetchProcessorTypesResponse
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 fetch processor types.
func (*FetchProcessorTypesResponse) Descriptor
func (*FetchProcessorTypesResponse) Descriptor() ([]byte, []int)Deprecated: Use FetchProcessorTypesResponse.ProtoReflect.Descriptor instead.
func (*FetchProcessorTypesResponse) GetProcessorTypes
func (x *FetchProcessorTypesResponse) GetProcessorTypes() []*ProcessorTypefunc (*FetchProcessorTypesResponse) ProtoMessage
func (*FetchProcessorTypesResponse) ProtoMessage()func (*FetchProcessorTypesResponse) ProtoReflect
func (x *FetchProcessorTypesResponse) ProtoReflect() protoreflect.Messagefunc (*FetchProcessorTypesResponse) Reset
func (x *FetchProcessorTypesResponse) Reset()func (*FetchProcessorTypesResponse) String
func (x *FetchProcessorTypesResponse) String() stringGcsDocument
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() stringfunc (*GcsDocument) GetMimeType
func (x *GcsDocument) GetMimeType() stringfunc (*GcsDocument) ProtoMessage
func (*GcsDocument) ProtoMessage()func (*GcsDocument) ProtoReflect
func (x *GcsDocument) ProtoReflect() protoreflect.Messagefunc (*GcsDocument) Reset
func (x *GcsDocument) Reset()func (*GcsDocument) String
func (x *GcsDocument) String() stringGcsDocuments
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() []*GcsDocumentfunc (*GcsDocuments) ProtoMessage
func (*GcsDocuments) ProtoMessage()func (*GcsDocuments) ProtoReflect
func (x *GcsDocuments) ProtoReflect() protoreflect.Messagefunc (*GcsDocuments) Reset
func (x *GcsDocuments) Reset()func (*GcsDocuments) String
func (x *GcsDocuments) String() stringGcsPrefix
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
Deprecated: Use GcsPrefix.ProtoReflect.Descriptor instead.
func (*GcsPrefix) GetGcsUriPrefix
func (*GcsPrefix) ProtoMessage
func (*GcsPrefix) ProtoMessage()func (*GcsPrefix) ProtoReflect
func (x *GcsPrefix) ProtoReflect() protoreflect.Messagefunc (*GcsPrefix) Reset
func (x *GcsPrefix) Reset()func (*GcsPrefix) 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() stringfunc (*GetEvaluationRequest) ProtoMessage
func (*GetEvaluationRequest) ProtoMessage()func (*GetEvaluationRequest) ProtoReflect
func (x *GetEvaluationRequest) ProtoReflect() protoreflect.Messagefunc (*GetEvaluationRequest) Reset
func (x *GetEvaluationRequest) Reset()func (*GetEvaluationRequest) String
func (x *GetEvaluationRequest) String() stringGetProcessorRequest
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 get processor.
func (*GetProcessorRequest) Descriptor
func (*GetProcessorRequest) Descriptor() ([]byte, []int)Deprecated: Use GetProcessorRequest.ProtoReflect.Descriptor instead.
func (*GetProcessorRequest) GetName
func (x *GetProcessorRequest) GetName() stringfunc (*GetProcessorRequest) ProtoMessage
func (*GetProcessorRequest) ProtoMessage()func (*GetProcessorRequest) ProtoReflect
func (x *GetProcessorRequest) ProtoReflect() protoreflect.Messagefunc (*GetProcessorRequest) Reset
func (x *GetProcessorRequest) Reset()func (*GetProcessorRequest) String
func (x *GetProcessorRequest) String() stringGetProcessorTypeRequest
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 get processor.
func (*GetProcessorTypeRequest) Descriptor
func (*GetProcessorTypeRequest) Descriptor() ([]byte, []int)Deprecated: Use GetProcessorTypeRequest.ProtoReflect.Descriptor instead.
func (*GetProcessorTypeRequest) GetName
func (x *GetProcessorTypeRequest) GetName() stringfunc (*GetProcessorTypeRequest) ProtoMessage
func (*GetProcessorTypeRequest) ProtoMessage()func (*GetProcessorTypeRequest) ProtoReflect
func (x *GetProcessorTypeRequest) ProtoReflect() protoreflect.Messagefunc (*GetProcessorTypeRequest) Reset
func (x *GetProcessorTypeRequest) Reset()func (*GetProcessorTypeRequest) String
func (x *GetProcessorTypeRequest) String() stringGetProcessorVersionRequest
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 get processor version.
func (*GetProcessorVersionRequest) Descriptor
func (*GetProcessorVersionRequest) Descriptor() ([]byte, []int)Deprecated: Use GetProcessorVersionRequest.ProtoReflect.Descriptor instead.
func (*GetProcessorVersionRequest) GetName
func (x *GetProcessorVersionRequest) GetName() stringfunc (*GetProcessorVersionRequest) ProtoMessage
func (*GetProcessorVersionRequest) ProtoMessage()func (*GetProcessorVersionRequest) ProtoReflect
func (x *GetProcessorVersionRequest) ProtoReflect() protoreflect.Messagefunc (*GetProcessorVersionRequest) Reset
func (x *GetProcessorVersionRequest) Reset()func (*GetProcessorVersionRequest) String
func (x *GetProcessorVersionRequest) String() stringHumanReviewStatus
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] is [HUMAN_REVIEW_IN_PROGRESS]. It has
// the same response type and metadata as the long running operation returned
// by [ReviewDocument] method.
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() stringfunc (*HumanReviewStatus) GetState
func (x *HumanReviewStatus) GetState() HumanReviewStatus_Statefunc (*HumanReviewStatus) GetStateMessage
func (x *HumanReviewStatus) GetStateMessage() stringfunc (*HumanReviewStatus) ProtoMessage
func (*HumanReviewStatus) ProtoMessage()func (*HumanReviewStatus) ProtoReflect
func (x *HumanReviewStatus) ProtoReflect() protoreflect.Messagefunc (*HumanReviewStatus) Reset
func (x *HumanReviewStatus) Reset()func (*HumanReviewStatus) String
func (x *HumanReviewStatus) String() stringHumanReviewStatus_State
type HumanReviewStatus_State int32The 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 is not 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] for details.
HumanReviewStatus_ERROR HumanReviewStatus_State = 4
)func (HumanReviewStatus_State) Descriptor
func (HumanReviewStatus_State) Descriptor() protoreflect.EnumDescriptorfunc (HumanReviewStatus_State) Enum
func (x HumanReviewStatus_State) Enum() *HumanReviewStatus_Statefunc (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.EnumNumberfunc (HumanReviewStatus_State) String
func (x HumanReviewStatus_State) String() stringfunc (HumanReviewStatus_State) Type
func (HumanReviewStatus_State) Type() protoreflect.EnumTypeImportProcessorVersionMetadata
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 method.
func (*ImportProcessorVersionMetadata) Descriptor
func (*ImportProcessorVersionMetadata) Descriptor() ([]byte, []int)Deprecated: Use ImportProcessorVersionMetadata.ProtoReflect.Descriptor instead.
func (*ImportProcessorVersionMetadata) GetCommonMetadata
func (x *ImportProcessorVersionMetadata) GetCommonMetadata() *CommonOperationMetadatafunc (*ImportProcessorVersionMetadata) ProtoMessage
func (*ImportProcessorVersionMetadata) ProtoMessage()func (*ImportProcessorVersionMetadata) ProtoReflect
func (x *ImportProcessorVersionMetadata) ProtoReflect() protoreflect.Messagefunc (*ImportProcessorVersionMetadata) Reset
func (x *ImportProcessorVersionMetadata) Reset()func (*ImportProcessorVersionMetadata) String
func (x *ImportProcessorVersionMetadata) String() stringImportProcessorVersionRequest
type ImportProcessorVersionRequest struct {
// Types that are assignable to Source:
// *ImportProcessorVersionRequest_ProcessorVersionSource
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 method. This method requires Document AI Service Agent of the destination project in the source project's IAM with Document AI Editor role.
The destination project is specified as part of the parent field.
The source project is specified as part of source field.
The Service Agent for Document AI can be found in https://cloud.google.com/iam/docs/service-agents.
func (*ImportProcessorVersionRequest) Descriptor
func (*ImportProcessorVersionRequest) Descriptor() ([]byte, []int)Deprecated: Use ImportProcessorVersionRequest.ProtoReflect.Descriptor instead.
func (*ImportProcessorVersionRequest) GetParent
func (x *ImportProcessorVersionRequest) GetParent() stringfunc (*ImportProcessorVersionRequest) GetProcessorVersionSource
func (x *ImportProcessorVersionRequest) GetProcessorVersionSource() stringfunc (*ImportProcessorVersionRequest) GetSource
func (m *ImportProcessorVersionRequest) GetSource() isImportProcessorVersionRequest_Sourcefunc (*ImportProcessorVersionRequest) ProtoMessage
func (*ImportProcessorVersionRequest) ProtoMessage()func (*ImportProcessorVersionRequest) ProtoReflect
func (x *ImportProcessorVersionRequest) ProtoReflect() protoreflect.Messagefunc (*ImportProcessorVersionRequest) Reset
func (x *ImportProcessorVersionRequest) Reset()func (*ImportProcessorVersionRequest) String
func (x *ImportProcessorVersionRequest) String() stringImportProcessorVersionRequest_ProcessorVersionSource
type ImportProcessorVersionRequest_ProcessorVersionSource struct {
// The source processor version to import from.
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 method.
func (*ImportProcessorVersionResponse) Descriptor
func (*ImportProcessorVersionResponse) Descriptor() ([]byte, []int)Deprecated: Use ImportProcessorVersionResponse.ProtoReflect.Descriptor instead.
func (*ImportProcessorVersionResponse) GetProcessorVersion
func (x *ImportProcessorVersionResponse) GetProcessorVersion() stringfunc (*ImportProcessorVersionResponse) ProtoMessage
func (*ImportProcessorVersionResponse) ProtoMessage()func (*ImportProcessorVersionResponse) ProtoReflect
func (x *ImportProcessorVersionResponse) ProtoReflect() protoreflect.Messagefunc (*ImportProcessorVersionResponse) Reset
func (x *ImportProcessorVersionResponse) Reset()func (*ImportProcessorVersionResponse) String
func (x *ImportProcessorVersionResponse) String() stringListEvaluationsRequest
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 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 `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.
func (*ListEvaluationsRequest) Descriptor
func (*ListEvaluationsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListEvaluationsRequest.ProtoReflect.Descriptor instead.
func (*ListEvaluationsRequest) GetPageSize
func (x *ListEvaluationsRequest) GetPageSize() int32func (*ListEvaluationsRequest) GetPageToken
func (x *ListEvaluationsRequest) GetPageToken() stringfunc (*ListEvaluationsRequest) GetParent
func (x *ListEvaluationsRequest) GetParent() stringfunc (*ListEvaluationsRequest) ProtoMessage
func (*ListEvaluationsRequest) ProtoMessage()func (*ListEvaluationsRequest) ProtoReflect
func (x *ListEvaluationsRequest) ProtoReflect() protoreflect.Messagefunc (*ListEvaluationsRequest) Reset
func (x *ListEvaluationsRequest) Reset()func (*ListEvaluationsRequest) String
func (x *ListEvaluationsRequest) String() stringListEvaluationsResponse
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() []*Evaluationfunc (*ListEvaluationsResponse) GetNextPageToken
func (x *ListEvaluationsResponse) GetNextPageToken() stringfunc (*ListEvaluationsResponse) ProtoMessage
func (*ListEvaluationsResponse) ProtoMessage()func (*ListEvaluationsResponse) ProtoReflect
func (x *ListEvaluationsResponse) ProtoReflect() protoreflect.Messagefunc (*ListEvaluationsResponse) Reset
func (x *ListEvaluationsResponse) Reset()func (*ListEvaluationsResponse) String
func (x *ListEvaluationsResponse) String() stringListProcessorTypesRequest
type ListProcessorTypesRequest struct {
// Required. The location of processor type to list.
// The available processor types may depend on the allow-listing on projects.
// 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 list processor types.
func (*ListProcessorTypesRequest) Descriptor
func (*ListProcessorTypesRequest) Descriptor() ([]byte, []int)Deprecated: Use ListProcessorTypesRequest.ProtoReflect.Descriptor instead.
func (*ListProcessorTypesRequest) GetPageSize
func (x *ListProcessorTypesRequest) GetPageSize() int32func (*ListProcessorTypesRequest) GetPageToken
func (x *ListProcessorTypesRequest) GetPageToken() stringfunc (*ListProcessorTypesRequest) GetParent
func (x *ListProcessorTypesRequest) GetParent() stringfunc (*ListProcessorTypesRequest) ProtoMessage
func (*ListProcessorTypesRequest) ProtoMessage()func (*ListProcessorTypesRequest) ProtoReflect
func (x *ListProcessorTypesRequest) ProtoReflect() protoreflect.Messagefunc (*ListProcessorTypesRequest) Reset
func (x *ListProcessorTypesRequest) Reset()func (*ListProcessorTypesRequest) String
func (x *ListProcessorTypesRequest) String() stringListProcessorTypesResponse
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 list processor types.
func (*ListProcessorTypesResponse) Descriptor
func (*ListProcessorTypesResponse) Descriptor() ([]byte, []int)Deprecated: Use ListProcessorTypesResponse.ProtoReflect.Descriptor instead.
func (*ListProcessorTypesResponse) GetNextPageToken
func (x *ListProcessorTypesResponse) GetNextPageToken() stringfunc (*ListProcessorTypesResponse) GetProcessorTypes
func (x *ListProcessorTypesResponse) GetProcessorTypes() []*ProcessorTypefunc (*ListProcessorTypesResponse) ProtoMessage
func (*ListProcessorTypesResponse) ProtoMessage()func (*ListProcessorTypesResponse) ProtoReflect
func (x *ListProcessorTypesResponse) ProtoReflect() protoreflect.Messagefunc (*ListProcessorTypesResponse) Reset
func (x *ListProcessorTypesResponse) Reset()func (*ListProcessorTypesResponse) String
func (x *ListProcessorTypesResponse) String() stringListProcessorVersionsRequest
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() int32func (*ListProcessorVersionsRequest) GetPageToken
func (x *ListProcessorVersionsRequest) GetPageToken() stringfunc (*ListProcessorVersionsRequest) GetParent
func (x *ListProcessorVersionsRequest) GetParent() stringfunc (*ListProcessorVersionsRequest) ProtoMessage
func (*ListProcessorVersionsRequest) ProtoMessage()func (*ListProcessorVersionsRequest) ProtoReflect
func (x *ListProcessorVersionsRequest) ProtoReflect() protoreflect.Messagefunc (*ListProcessorVersionsRequest) Reset
func (x *ListProcessorVersionsRequest) Reset()func (*ListProcessorVersionsRequest) String
func (x *ListProcessorVersionsRequest) String() stringListProcessorVersionsResponse
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 list processors.
func (*ListProcessorVersionsResponse) Descriptor
func (*ListProcessorVersionsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListProcessorVersionsResponse.ProtoReflect.Descriptor instead.
func (*ListProcessorVersionsResponse) GetNextPageToken
func (x *ListProcessorVersionsResponse) GetNextPageToken() stringfunc (*ListProcessorVersionsResponse) GetProcessorVersions
func (x *ListProcessorVersionsResponse) GetProcessorVersions() []*ProcessorVersionfunc (*ListProcessorVersionsResponse) ProtoMessage
func (*ListProcessorVersionsResponse) ProtoMessage()func (*ListProcessorVersionsResponse) ProtoReflect
func (x *ListProcessorVersionsResponse) ProtoReflect() protoreflect.Messagefunc (*ListProcessorVersionsResponse) Reset
func (x *ListProcessorVersionsResponse) Reset()func (*ListProcessorVersionsResponse) String
func (x *ListProcessorVersionsResponse) String() stringListProcessorsRequest
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() int32func (*ListProcessorsRequest) GetPageToken
func (x *ListProcessorsRequest) GetPageToken() stringfunc (*ListProcessorsRequest) GetParent
func (x *ListProcessorsRequest) GetParent() stringfunc (*ListProcessorsRequest) ProtoMessage
func (*ListProcessorsRequest) ProtoMessage()func (*ListProcessorsRequest) ProtoReflect
func (x *ListProcessorsRequest) ProtoReflect() protoreflect.Messagefunc (*ListProcessorsRequest) Reset
func (x *ListProcessorsRequest) Reset()func (*ListProcessorsRequest) String
func (x *ListProcessorsRequest) String() stringListProcessorsResponse
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 list processors.
func (*ListProcessorsResponse) Descriptor
func (*ListProcessorsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListProcessorsResponse.ProtoReflect.Descriptor instead.
func (*ListProcessorsResponse) GetNextPageToken
func (x *ListProcessorsResponse) GetNextPageToken() stringfunc (*ListProcessorsResponse) GetProcessors
func (x *ListProcessorsResponse) GetProcessors() []*Processorfunc (*ListProcessorsResponse) ProtoMessage
func (*ListProcessorsResponse) ProtoMessage()func (*ListProcessorsResponse) ProtoReflect
func (x *ListProcessorsResponse) ProtoReflect() protoreflect.Messagefunc (*ListProcessorsResponse) Reset
func (x *ListProcessorsResponse) Reset()func (*ListProcessorsResponse) String
func (x *ListProcessorsResponse) String() stringNormalizedVertex
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() float32func (*NormalizedVertex) GetY
func (x *NormalizedVertex) GetY() float32func (*NormalizedVertex) ProtoMessage
func (*NormalizedVertex) ProtoMessage()func (*NormalizedVertex) ProtoReflect
func (x *NormalizedVertex) ProtoReflect() protoreflect.Messagefunc (*NormalizedVertex) Reset
func (x *NormalizedVertex) Reset()func (*NormalizedVertex) String
func (x *NormalizedVertex) String() stringOcrConfig
type OcrConfig struct {
Hints *OcrConfig_Hints `protobuf:"bytes,2,opt,name=hints,proto3" json:"hints,omitempty"`
EnableNativePdfParsing bool "" /* 132 byte string literal not displayed */
EnableImageQualityScores bool "" /* 138 byte string literal not displayed */
AdvancedOcrOptions []string `protobuf:"bytes,5,rep,name=advanced_ocr_options,json=advancedOcrOptions,proto3" json:"advanced_ocr_options,omitempty"`
EnableSymbol bool `protobuf:"varint,6,opt,name=enable_symbol,json=enableSymbol,proto3" json:"enable_symbol,omitempty"`
}Config for Document OCR.
func (*OcrConfig) Descriptor
Deprecated: Use OcrConfig.ProtoReflect.Descriptor instead.
func (*OcrConfig) GetAdvancedOcrOptions
func (*OcrConfig) GetEnableImageQualityScores
func (*OcrConfig) GetEnableNativePdfParsing
func (*OcrConfig) GetEnableSymbol
func (*OcrConfig) GetHints
func (x *OcrConfig) GetHints() *OcrConfig_Hintsfunc (*OcrConfig) ProtoMessage
func (*OcrConfig) ProtoMessage()func (*OcrConfig) ProtoReflect
func (x *OcrConfig) ProtoReflect() protoreflect.Messagefunc (*OcrConfig) Reset
func (x *OcrConfig) Reset()func (*OcrConfig) 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() []stringfunc (*OcrConfig_Hints) ProtoMessage
func (*OcrConfig_Hints) ProtoMessage()func (*OcrConfig_Hints) ProtoReflect
func (x *OcrConfig_Hints) ProtoReflect() protoreflect.Messagefunc (*OcrConfig_Hints) Reset
func (x *OcrConfig_Hints) Reset()func (*OcrConfig_Hints) String
func (x *OcrConfig_Hints) String() stringProcessOptions
type ProcessOptions struct {
// Only applicable to "Document OCR 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"`
// 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) GetOcrConfig
func (x *ProcessOptions) GetOcrConfig() *OcrConfigfunc (*ProcessOptions) ProtoMessage
func (*ProcessOptions) ProtoMessage()func (*ProcessOptions) ProtoReflect
func (x *ProcessOptions) ProtoReflect() protoreflect.Messagefunc (*ProcessOptions) Reset
func (x *ProcessOptions) Reset()func (*ProcessOptions) String
func (x *ProcessOptions) String() stringProcessRequest
type ProcessRequest struct {
// The document payload.
//
// Types that are assignable to Source:
// *ProcessRequest_InlineDocument
// *ProcessRequest_RawDocument
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] and [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 feature 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 ProcessResponse's document.
// 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"`
// contains filtered or unexported fields
}Request message for the process document method.
func (*ProcessRequest) Descriptor
func (*ProcessRequest) Descriptor() ([]byte, []int)Deprecated: Use ProcessRequest.ProtoReflect.Descriptor instead.
func (*ProcessRequest) GetDocument
func (x *ProcessRequest) GetDocument() *DocumentDeprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document_processor_service.proto.
func (*ProcessRequest) GetFieldMask
func (x *ProcessRequest) GetFieldMask() *fieldmaskpb.FieldMaskfunc (*ProcessRequest) GetInlineDocument
func (x *ProcessRequest) GetInlineDocument() *Documentfunc (*ProcessRequest) GetName
func (x *ProcessRequest) GetName() stringfunc (*ProcessRequest) GetProcessOptions
func (x *ProcessRequest) GetProcessOptions() *ProcessOptionsfunc (*ProcessRequest) GetRawDocument
func (x *ProcessRequest) GetRawDocument() *RawDocumentfunc (*ProcessRequest) GetSkipHumanReview
func (x *ProcessRequest) GetSkipHumanReview() boolfunc (*ProcessRequest) GetSource
func (m *ProcessRequest) GetSource() isProcessRequest_Sourcefunc (*ProcessRequest) ProtoMessage
func (*ProcessRequest) ProtoMessage()func (*ProcessRequest) ProtoReflect
func (x *ProcessRequest) ProtoReflect() protoreflect.Messagefunc (*ProcessRequest) Reset
func (x *ProcessRequest) Reset()func (*ProcessRequest) String
func (x *ProcessRequest) String() stringProcessRequest_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 is not triggered, this field will be empty. It has the same
// response type and metadata as the long running operation returned by
// ReviewDocument method.
//
// 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 process document method.
func (*ProcessResponse) Descriptor
func (*ProcessResponse) Descriptor() ([]byte, []int)Deprecated: Use ProcessResponse.ProtoReflect.Descriptor instead.
func (*ProcessResponse) GetDocument
func (x *ProcessResponse) GetDocument() *Documentfunc (*ProcessResponse) GetHumanReviewOperation
func (x *ProcessResponse) GetHumanReviewOperation() stringDeprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document_processor_service.proto.
func (*ProcessResponse) GetHumanReviewStatus
func (x *ProcessResponse) GetHumanReviewStatus() *HumanReviewStatusfunc (*ProcessResponse) ProtoMessage
func (*ProcessResponse) ProtoMessage()func (*ProcessResponse) ProtoReflect
func (x *ProcessResponse) ProtoReflect() protoreflect.Messagefunc (*ProcessResponse) Reset
func (x *ProcessResponse) Reset()func (*ProcessResponse) String
func (x *ProcessResponse) String() stringProcessor
type Processor struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
State Processor_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.cloud.documentai.v1beta3.Processor_State" json:"state,omitempty"`
DefaultProcessorVersion string "" /* 132 byte string literal not displayed */
ProcessEndpoint string `protobuf:"bytes,6,opt,name=process_endpoint,json=processEndpoint,proto3" json:"process_endpoint,omitempty"`
CreateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
KmsKeyName string `protobuf:"bytes,8,opt,name=kms_key_name,json=kmsKeyName,proto3" json:"kms_key_name,omitempty"`
}The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.
func (*Processor) Descriptor
Deprecated: Use Processor.ProtoReflect.Descriptor instead.
func (*Processor) GetCreateTime
func (x *Processor) GetCreateTime() *timestamppb.Timestampfunc (*Processor) GetDefaultProcessorVersion
func (*Processor) GetDisplayName
func (*Processor) GetKmsKeyName
func (*Processor) GetName
func (*Processor) GetProcessEndpoint
func (*Processor) GetState
func (x *Processor) GetState() Processor_Statefunc (*Processor) GetType
func (*Processor) ProtoMessage
func (*Processor) ProtoMessage()func (*Processor) ProtoReflect
func (x *Processor) ProtoReflect() protoreflect.Messagefunc (*Processor) Reset
func (x *Processor) Reset()func (*Processor) 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, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc.
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() boolfunc (*ProcessorType) GetAvailableLocations
func (x *ProcessorType) GetAvailableLocations() []*ProcessorType_LocationInfofunc (*ProcessorType) GetCategory
func (x *ProcessorType) GetCategory() stringfunc (*ProcessorType) GetLaunchStage
func (x *ProcessorType) GetLaunchStage() api.LaunchStagefunc (*ProcessorType) GetName
func (x *ProcessorType) GetName() stringfunc (*ProcessorType) GetSampleDocumentUris
func (x *ProcessorType) GetSampleDocumentUris() []stringfunc (*ProcessorType) GetType
func (x *ProcessorType) GetType() stringfunc (*ProcessorType) ProtoMessage
func (*ProcessorType) ProtoMessage()func (*ProcessorType) ProtoReflect
func (x *ProcessorType) ProtoReflect() protoreflect.Messagefunc (*ProcessorType) Reset
func (x *ProcessorType) Reset()func (*ProcessorType) String
func (x *ProcessorType) String() stringProcessorType_LocationInfo
type ProcessorType_LocationInfo struct {
// The location id, currently must be one of [us, eu].
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() stringfunc (*ProcessorType_LocationInfo) ProtoMessage
func (*ProcessorType_LocationInfo) ProtoMessage()func (*ProcessorType_LocationInfo) ProtoReflect
func (x *ProcessorType_LocationInfo) ProtoReflect() protoreflect.Messagefunc (*ProcessorType_LocationInfo) Reset
func (x *ProcessorType_LocationInfo) Reset()func (*ProcessorType_LocationInfo) String
func (x *ProcessorType_LocationInfo) String() stringProcessorVersion
type ProcessorVersion struct {
// 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"`
// 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"`
// 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"`
// The time the processor version was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// 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"`
// 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"`
// 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"`
// Denotes that this ProcessorVersion is managed by google.
GoogleManaged bool `protobuf:"varint,11,opt,name=google_managed,json=googleManaged,proto3" json:"google_managed,omitempty"`
// 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"`
// contains filtered or unexported fields
}A processor version is an implementation of a processor. Each processor can have multiple versions, pre-trained by Google internally or up-trained by the customer. At a time, a processor can only have one default version version. So the processor's behavior (when processing documents) is defined by a default version
func (*ProcessorVersion) Descriptor
func (*ProcessorVersion) Descriptor() ([]byte, []int)Deprecated: Use ProcessorVersion.ProtoReflect.Descriptor instead.
func (*ProcessorVersion) GetCreateTime
func (x *ProcessorVersion) GetCreateTime() *timestamppb.Timestampfunc (*ProcessorVersion) GetDeprecationInfo
func (x *ProcessorVersion) GetDeprecationInfo() *ProcessorVersion_DeprecationInfofunc (*ProcessorVersion) GetDisplayName
func (x *ProcessorVersion) GetDisplayName() stringfunc (*ProcessorVersion) GetDocumentSchema
func (x *ProcessorVersion) GetDocumentSchema() *DocumentSchemafunc (*ProcessorVersion) GetGoogleManaged
func (x *ProcessorVersion) GetGoogleManaged() boolfunc (*ProcessorVersion) GetKmsKeyName
func (x *ProcessorVersion) GetKmsKeyName() stringfunc (*ProcessorVersion) GetKmsKeyVersionName
func (x *ProcessorVersion) GetKmsKeyVersionName() stringfunc (*ProcessorVersion) GetLatestEvaluation
func (x *ProcessorVersion) GetLatestEvaluation() *EvaluationReferencefunc (*ProcessorVersion) GetName
func (x *ProcessorVersion) GetName() stringfunc (*ProcessorVersion) GetState
func (x *ProcessorVersion) GetState() ProcessorVersion_Statefunc (*ProcessorVersion) ProtoMessage
func (*ProcessorVersion) ProtoMessage()func (*ProcessorVersion) ProtoReflect
func (x *ProcessorVersion) ProtoReflect() protoreflect.Messagefunc (*ProcessorVersion) Reset
func (x *ProcessorVersion) Reset()func (*ProcessorVersion) String
func (x *ProcessorVersion) String() stringProcessorVersion_DeprecationInfo
type ProcessorVersion_DeprecationInfo struct {
DeprecationTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=deprecation_time,json=deprecationTime,proto3" json:"deprecation_time,omitempty"`
ReplacementProcessorVersion string "" /* 144 byte string literal not displayed */
}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.Timestampfunc (*ProcessorVersion_DeprecationInfo) GetReplacementProcessorVersion
func (x *ProcessorVersion_DeprecationInfo) GetReplacementProcessorVersion() stringfunc (*ProcessorVersion_DeprecationInfo) ProtoMessage
func (*ProcessorVersion_DeprecationInfo) ProtoMessage()func (*ProcessorVersion_DeprecationInfo) ProtoReflect
func (x *ProcessorVersion_DeprecationInfo) ProtoReflect() protoreflect.Messagefunc (*ProcessorVersion_DeprecationInfo) Reset
func (x *ProcessorVersion_DeprecationInfo) Reset()func (*ProcessorVersion_DeprecationInfo) String
func (x *ProcessorVersion_DeprecationInfo) String() stringProcessorVersion_State
type ProcessorVersion_State int32The possible states of the processor version.
ProcessorVersion_STATE_UNSPECIFIED, ProcessorVersion_DEPLOYED, ProcessorVersion_DEPLOYING, ProcessorVersion_UNDEPLOYED, ProcessorVersion_UNDEPLOYING, ProcessorVersion_CREATING, ProcessorVersion_DELETING, ProcessorVersion_FAILED
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
)func (ProcessorVersion_State) Descriptor
func (ProcessorVersion_State) Descriptor() protoreflect.EnumDescriptorfunc (ProcessorVersion_State) Enum
func (x ProcessorVersion_State) Enum() *ProcessorVersion_Statefunc (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.EnumNumberfunc (ProcessorVersion_State) String
func (x ProcessorVersion_State) String() stringfunc (ProcessorVersion_State) Type
func (ProcessorVersion_State) Type() protoreflect.EnumTypeProcessor_State
type Processor_State int32The 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.EnumDescriptorfunc (Processor_State) Enum
func (x Processor_State) Enum() *Processor_Statefunc (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.EnumNumberfunc (Processor_State) String
func (x Processor_State) String() stringfunc (Processor_State) Type
func (Processor_State) Type() protoreflect.EnumTypeRawDocument
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"`
// 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() []bytefunc (*RawDocument) GetMimeType
func (x *RawDocument) GetMimeType() stringfunc (*RawDocument) ProtoMessage
func (*RawDocument) ProtoMessage()func (*RawDocument) ProtoReflect
func (x *RawDocument) ProtoReflect() protoreflect.Messagefunc (*RawDocument) Reset
func (x *RawDocument) Reset()func (*RawDocument) String
func (x *RawDocument) String() stringReviewDocumentOperationMetadata
type ReviewDocumentOperationMetadata struct {
State ReviewDocumentOperationMetadata_State "" /* 139 byte string literal not displayed */
StateMessage string `protobuf:"bytes,2,opt,name=state_message,json=stateMessage,proto3" json:"state_message,omitempty"`
CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
CommonMetadata *CommonOperationMetadata `protobuf:"bytes,5,opt,name=common_metadata,json=commonMetadata,proto3" json:"common_metadata,omitempty"`
QuestionId string `protobuf:"bytes,6,opt,name=question_id,json=questionId,proto3" json:"question_id,omitempty"`
}The long running operation metadata for review document method.
func (*ReviewDocumentOperationMetadata) Descriptor
func (*ReviewDocumentOperationMetadata) Descriptor() ([]byte, []int)Deprecated: Use ReviewDocumentOperationMetadata.ProtoReflect.Descriptor instead.
func (*ReviewDocumentOperationMetadata) GetCommonMetadata
func (x *ReviewDocumentOperationMetadata) GetCommonMetadata() *CommonOperationMetadatafunc (*ReviewDocumentOperationMetadata) GetCreateTime
func (x *ReviewDocumentOperationMetadata) GetCreateTime() *timestamppb.Timestampfunc (*ReviewDocumentOperationMetadata) GetQuestionId
func (x *ReviewDocumentOperationMetadata) GetQuestionId() stringfunc (*ReviewDocumentOperationMetadata) GetState
func (x *ReviewDocumentOperationMetadata) GetState() ReviewDocumentOperationMetadata_Statefunc (*ReviewDocumentOperationMetadata) GetStateMessage
func (x *ReviewDocumentOperationMetadata) GetStateMessage() stringfunc (*ReviewDocumentOperationMetadata) GetUpdateTime
func (x *ReviewDocumentOperationMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*ReviewDocumentOperationMetadata) ProtoMessage
func (*ReviewDocumentOperationMetadata) ProtoMessage()func (*ReviewDocumentOperationMetadata) ProtoReflect
func (x *ReviewDocumentOperationMetadata) ProtoReflect() protoreflect.Messagefunc (*ReviewDocumentOperationMetadata) Reset
func (x *ReviewDocumentOperationMetadata) Reset()func (*ReviewDocumentOperationMetadata) String
func (x *ReviewDocumentOperationMetadata) String() stringReviewDocumentOperationMetadata_State
type ReviewDocumentOperationMetadata_State int32State of the longrunning 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.EnumDescriptorfunc (ReviewDocumentOperationMetadata_State) Enum
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.EnumNumberfunc (ReviewDocumentOperationMetadata_State) String
func (x ReviewDocumentOperationMetadata_State) String() stringfunc (ReviewDocumentOperationMetadata_State) Type
func (ReviewDocumentOperationMetadata_State) Type() protoreflect.EnumTypeReviewDocumentRequest
type ReviewDocumentRequest struct {
Source isReviewDocumentRequest_Source `protobuf_oneof:"source"`
HumanReviewConfig string `protobuf:"bytes,1,opt,name=human_review_config,json=humanReviewConfig,proto3" json:"human_review_config,omitempty"`
Document *Document `protobuf:"bytes,2,opt,name=document,proto3" json:"document,omitempty"`
EnableSchemaValidation bool "" /* 130 byte string literal not displayed */
Priority ReviewDocumentRequest_Priority "" /* 138 byte string literal not displayed */
DocumentSchema *DocumentSchema `protobuf:"bytes,6,opt,name=document_schema,json=documentSchema,proto3" json:"document_schema,omitempty"`
}Request message for review document method.
func (*ReviewDocumentRequest) Descriptor
func (*ReviewDocumentRequest) Descriptor() ([]byte, []int)Deprecated: Use ReviewDocumentRequest.ProtoReflect.Descriptor instead.
func (*ReviewDocumentRequest) GetDocument
func (x *ReviewDocumentRequest) GetDocument() *DocumentDeprecated: Marked as deprecated in google/cloud/documentai/v1beta3/document_processor_service.proto.
func (*ReviewDocumentRequest) GetDocumentSchema
func (x *ReviewDocumentRequest) GetDocumentSchema() *DocumentSchemafunc (*ReviewDocumentRequest) GetEnableSchemaValidation
func (x *ReviewDocumentRequest) GetEnableSchemaValidation() boolfunc (*ReviewDocumentRequest) GetHumanReviewConfig
func (x *ReviewDocumentRequest) GetHumanReviewConfig() stringfunc (*ReviewDocumentRequest) GetInlineDocument
func (x *ReviewDocumentRequest) GetInlineDocument() *Documentfunc (*ReviewDocumentRequest) GetPriority
func (x *ReviewDocumentRequest) GetPriority() ReviewDocumentRequest_Priorityfunc (*ReviewDocumentRequest) GetSource
func (m *ReviewDocumentRequest) GetSource() isReviewDocumentRequest_Sourcefunc (*ReviewDocumentRequest) ProtoMessage
func (*ReviewDocumentRequest) ProtoMessage()func (*ReviewDocumentRequest) ProtoReflect
func (x *ReviewDocumentRequest) ProtoReflect() protoreflect.Messagefunc (*ReviewDocumentRequest) Reset
func (x *ReviewDocumentRequest) Reset()func (*ReviewDocumentRequest) String
func (x *ReviewDocumentRequest) String() stringReviewDocumentRequest_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 int32The 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.EnumDescriptorfunc (ReviewDocumentRequest_Priority) Enum
func (x ReviewDocumentRequest_Priority) Enum() *ReviewDocumentRequest_Priorityfunc (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.EnumNumberfunc (ReviewDocumentRequest_Priority) String
func (x ReviewDocumentRequest_Priority) String() stringfunc (ReviewDocumentRequest_Priority) Type
func (ReviewDocumentRequest_Priority) Type() protoreflect.EnumTypeReviewDocumentResponse
type ReviewDocumentResponse struct {
GcsDestination string `protobuf:"bytes,1,opt,name=gcs_destination,json=gcsDestination,proto3" json:"gcs_destination,omitempty"`
State ReviewDocumentResponse_State "" /* 130 byte string literal not displayed */
RejectionReason string `protobuf:"bytes,3,opt,name=rejection_reason,json=rejectionReason,proto3" json:"rejection_reason,omitempty"`
}Response message for review document method.
func (*ReviewDocumentResponse) Descriptor
func (*ReviewDocumentResponse) Descriptor() ([]byte, []int)Deprecated: Use ReviewDocumentResponse.ProtoReflect.Descriptor instead.
func (*ReviewDocumentResponse) GetGcsDestination
func (x *ReviewDocumentResponse) GetGcsDestination() stringfunc (*ReviewDocumentResponse) GetRejectionReason
func (x *ReviewDocumentResponse) GetRejectionReason() stringfunc (*ReviewDocumentResponse) GetState
func (x *ReviewDocumentResponse) GetState() ReviewDocumentResponse_Statefunc (*ReviewDocumentResponse) ProtoMessage
func (*ReviewDocumentResponse) ProtoMessage()func (*ReviewDocumentResponse) ProtoReflect
func (x *ReviewDocumentResponse) ProtoReflect() protoreflect.Messagefunc (*ReviewDocumentResponse) Reset
func (x *ReviewDocumentResponse) Reset()func (*ReviewDocumentResponse) String
func (x *ReviewDocumentResponse) String() stringReviewDocumentResponse_State
type ReviewDocumentResponse_State int32Possible 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.EnumDescriptorfunc (ReviewDocumentResponse_State) Enum
func (x ReviewDocumentResponse_State) Enum() *ReviewDocumentResponse_Statefunc (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.EnumNumberfunc (ReviewDocumentResponse_State) String
func (x ReviewDocumentResponse_State) String() stringfunc (ReviewDocumentResponse_State) Type
func (ReviewDocumentResponse_State) Type() protoreflect.EnumTypeSetDefaultProcessorVersionMetadata
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 set default processor version method.
func (*SetDefaultProcessorVersionMetadata) Descriptor
func (*SetDefaultProcessorVersionMetadata) Descriptor() ([]byte, []int)Deprecated: Use SetDefaultProcessorVersionMetadata.ProtoReflect.Descriptor instead.
func (*SetDefaultProcessorVersionMetadata) GetCommonMetadata
func (x *SetDefaultProcessorVersionMetadata) GetCommonMetadata() *CommonOperationMetadatafunc (*SetDefaultProcessorVersionMetadata) ProtoMessage
func (*SetDefaultProcessorVersionMetadata) ProtoMessage()func (*SetDefaultProcessorVersionMetadata) ProtoReflect
func (x *SetDefaultProcessorVersionMetadata) ProtoReflect() protoreflect.Messagefunc (*SetDefaultProcessorVersionMetadata) Reset
func (x *SetDefaultProcessorVersionMetadata) Reset()func (*SetDefaultProcessorVersionMetadata) String
func (x *SetDefaultProcessorVersionMetadata) String() stringSetDefaultProcessorVersionRequest
type SetDefaultProcessorVersionRequest struct {
Processor string `protobuf:"bytes,1,opt,name=processor,proto3" json:"processor,omitempty"`
DefaultProcessorVersion string "" /* 132 byte string literal not displayed */
}Request message for the set default processor version method.
func (*SetDefaultProcessorVersionRequest) Descriptor
func (*SetDefaultProcessorVersionRequest) Descriptor() ([]byte, []int)Deprecated: Use SetDefaultProcessorVersionRequest.ProtoReflect.Descriptor instead.
func (*SetDefaultProcessorVersionRequest) GetDefaultProcessorVersion
func (x *SetDefaultProcessorVersionRequest) GetDefaultProcessorVersion() stringfunc (*SetDefaultProcessorVersionRequest) GetProcessor
func (x *SetDefaultProcessorVersionRequest) GetProcessor() stringfunc (*SetDefaultProcessorVersionRequest) ProtoMessage
func (*SetDefaultProcessorVersionRequest) ProtoMessage()func (*SetDefaultProcessorVersionRequest) ProtoReflect
func (x *SetDefaultProcessorVersionRequest) ProtoReflect() protoreflect.Messagefunc (*SetDefaultProcessorVersionRequest) Reset
func (x *SetDefaultProcessorVersionRequest) Reset()func (*SetDefaultProcessorVersionRequest) String
func (x *SetDefaultProcessorVersionRequest) String() stringSetDefaultProcessorVersionResponse
type SetDefaultProcessorVersionResponse struct {
// contains filtered or unexported fields
}Response message for set default processor version 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.Messagefunc (*SetDefaultProcessorVersionResponse) Reset
func (x *SetDefaultProcessorVersionResponse) Reset()func (*SetDefaultProcessorVersionResponse) String
func (x *SetDefaultProcessorVersionResponse) String() stringTrainProcessorVersionMetadata
type TrainProcessorVersionMetadata struct {
CommonMetadata *CommonOperationMetadata `protobuf:"bytes,1,opt,name=common_metadata,json=commonMetadata,proto3" json:"common_metadata,omitempty"`
TrainingDatasetValidation *TrainProcessorVersionMetadata_DatasetValidation "" /* 138 byte string literal not displayed */
TestDatasetValidation *TrainProcessorVersionMetadata_DatasetValidation `protobuf:"bytes,3,opt,name=test_dataset_validation,json=testDatasetValidation,proto3" json:"test_dataset_validation,omitempty"`
}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() *CommonOperationMetadatafunc (*TrainProcessorVersionMetadata) GetTestDatasetValidation
func (x *TrainProcessorVersionMetadata) GetTestDatasetValidation() *TrainProcessorVersionMetadata_DatasetValidationfunc (*TrainProcessorVersionMetadata) GetTrainingDatasetValidation
func (x *TrainProcessorVersionMetadata) GetTrainingDatasetValidation() *TrainProcessorVersionMetadata_DatasetValidationfunc (*TrainProcessorVersionMetadata) ProtoMessage
func (*TrainProcessorVersionMetadata) ProtoMessage()func (*TrainProcessorVersionMetadata) ProtoReflect
func (x *TrainProcessorVersionMetadata) ProtoReflect() protoreflect.Messagefunc (*TrainProcessorVersionMetadata) Reset
func (x *TrainProcessorVersionMetadata) Reset()func (*TrainProcessorVersionMetadata) String
func (x *TrainProcessorVersionMetadata) String() stringTrainProcessorVersionMetadata_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() int32func (*TrainProcessorVersionMetadata_DatasetValidation) GetDatasetErrors
func (x *TrainProcessorVersionMetadata_DatasetValidation) GetDatasetErrors() []*status.Statusfunc (*TrainProcessorVersionMetadata_DatasetValidation) GetDocumentErrorCount
func (x *TrainProcessorVersionMetadata_DatasetValidation) GetDocumentErrorCount() int32func (*TrainProcessorVersionMetadata_DatasetValidation) GetDocumentErrors
func (x *TrainProcessorVersionMetadata_DatasetValidation) GetDocumentErrors() []*status.Statusfunc (*TrainProcessorVersionMetadata_DatasetValidation) ProtoMessage
func (*TrainProcessorVersionMetadata_DatasetValidation) ProtoMessage()func (*TrainProcessorVersionMetadata_DatasetValidation) ProtoReflect
func (x *TrainProcessorVersionMetadata_DatasetValidation) ProtoReflect() protoreflect.Messagefunc (*TrainProcessorVersionMetadata_DatasetValidation) Reset
func (x *TrainProcessorVersionMetadata_DatasetValidation) Reset()func (*TrainProcessorVersionMetadata_DatasetValidation) String
func (x *TrainProcessorVersionMetadata_DatasetValidation) String() stringTrainProcessorVersionRequest
type TrainProcessorVersionRequest struct {
// 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`.
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 create processor version method.
func (*TrainProcessorVersionRequest) Descriptor
func (*TrainProcessorVersionRequest) Descriptor() ([]byte, []int)Deprecated: Use TrainProcessorVersionRequest.ProtoReflect.Descriptor instead.
func (*TrainProcessorVersionRequest) GetBaseProcessorVersion
func (x *TrainProcessorVersionRequest) GetBaseProcessorVersion() stringfunc (*TrainProcessorVersionRequest) GetDocumentSchema
func (x *TrainProcessorVersionRequest) GetDocumentSchema() *DocumentSchemafunc (*TrainProcessorVersionRequest) GetInputData
func (x *TrainProcessorVersionRequest) GetInputData() *TrainProcessorVersionRequest_InputDatafunc (*TrainProcessorVersionRequest) GetParent
func (x *TrainProcessorVersionRequest) GetParent() stringfunc (*TrainProcessorVersionRequest) GetProcessorVersion
func (x *TrainProcessorVersionRequest) GetProcessorVersion() *ProcessorVersionfunc (*TrainProcessorVersionRequest) ProtoMessage
func (*TrainProcessorVersionRequest) ProtoMessage()func (*TrainProcessorVersionRequest) ProtoReflect
func (x *TrainProcessorVersionRequest) ProtoReflect() protoreflect.Messagefunc (*TrainProcessorVersionRequest) Reset
func (x *TrainProcessorVersionRequest) Reset()func (*TrainProcessorVersionRequest) String
func (x *TrainProcessorVersionRequest) String() stringTrainProcessorVersionRequest_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.
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() *BatchDocumentsInputConfigfunc (*TrainProcessorVersionRequest_InputData) GetTrainingDocuments
func (x *TrainProcessorVersionRequest_InputData) GetTrainingDocuments() *BatchDocumentsInputConfigfunc (*TrainProcessorVersionRequest_InputData) ProtoMessage
func (*TrainProcessorVersionRequest_InputData) ProtoMessage()func (*TrainProcessorVersionRequest_InputData) ProtoReflect
func (x *TrainProcessorVersionRequest_InputData) ProtoReflect() protoreflect.Messagefunc (*TrainProcessorVersionRequest_InputData) Reset
func (x *TrainProcessorVersionRequest_InputData) Reset()func (*TrainProcessorVersionRequest_InputData) String
func (x *TrainProcessorVersionRequest_InputData) String() stringTrainProcessorVersionResponse
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 the TrainProcessorVersion method.
func (*TrainProcessorVersionResponse) Descriptor
func (*TrainProcessorVersionResponse) Descriptor() ([]byte, []int)Deprecated: Use TrainProcessorVersionResponse.ProtoReflect.Descriptor instead.
func (*TrainProcessorVersionResponse) GetProcessorVersion
func (x *TrainProcessorVersionResponse) GetProcessorVersion() stringfunc (*TrainProcessorVersionResponse) ProtoMessage
func (*TrainProcessorVersionResponse) ProtoMessage()func (*TrainProcessorVersionResponse) ProtoReflect
func (x *TrainProcessorVersionResponse) ProtoReflect() protoreflect.Messagefunc (*TrainProcessorVersionResponse) Reset
func (x *TrainProcessorVersionResponse) Reset()func (*TrainProcessorVersionResponse) String
func (x *TrainProcessorVersionResponse) String() stringUndeployProcessorVersionMetadata
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 undeploy processor version method.
func (*UndeployProcessorVersionMetadata) Descriptor
func (*UndeployProcessorVersionMetadata) Descriptor() ([]byte, []int)Deprecated: Use UndeployProcessorVersionMetadata.ProtoReflect.Descriptor instead.
func (*UndeployProcessorVersionMetadata) GetCommonMetadata
func (x *UndeployProcessorVersionMetadata) GetCommonMetadata() *CommonOperationMetadatafunc (*UndeployProcessorVersionMetadata) ProtoMessage
func (*UndeployProcessorVersionMetadata) ProtoMessage()func (*UndeployProcessorVersionMetadata) ProtoReflect
func (x *UndeployProcessorVersionMetadata) ProtoReflect() protoreflect.Messagefunc (*UndeployProcessorVersionMetadata) Reset
func (x *UndeployProcessorVersionMetadata) Reset()func (*UndeployProcessorVersionMetadata) String
func (x *UndeployProcessorVersionMetadata) String() stringUndeployProcessorVersionRequest
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 undeploy processor version method.
func (*UndeployProcessorVersionRequest) Descriptor
func (*UndeployProcessorVersionRequest) Descriptor() ([]byte, []int)Deprecated: Use UndeployProcessorVersionRequest.ProtoReflect.Descriptor instead.
func (*UndeployProcessorVersionRequest) GetName
func (x *UndeployProcessorVersionRequest) GetName() stringfunc (*UndeployProcessorVersionRequest) ProtoMessage
func (*UndeployProcessorVersionRequest) ProtoMessage()func (*UndeployProcessorVersionRequest) ProtoReflect
func (x *UndeployProcessorVersionRequest) ProtoReflect() protoreflect.Messagefunc (*UndeployProcessorVersionRequest) Reset
func (x *UndeployProcessorVersionRequest) Reset()func (*UndeployProcessorVersionRequest) String
func (x *UndeployProcessorVersionRequest) String() stringUndeployProcessorVersionResponse
type UndeployProcessorVersionResponse struct {
// contains filtered or unexported fields
}Response message for the undeploy processor version 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.Messagefunc (*UndeployProcessorVersionResponse) Reset
func (x *UndeployProcessorVersionResponse) Reset()func (*UndeployProcessorVersionResponse) String
func (x *UndeployProcessorVersionResponse) String() stringUnimplementedDocumentProcessorServiceServer
type UnimplementedDocumentProcessorServiceServer struct {
}UnimplementedDocumentProcessorServiceServer can 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)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
Deprecated: Use Vertex.ProtoReflect.Descriptor instead.
func (*Vertex) GetX
func (*Vertex) GetY
func (*Vertex) ProtoMessage
func (*Vertex) ProtoMessage()func (*Vertex) ProtoReflect
func (x *Vertex) ProtoReflect() protoreflect.Messagefunc (*Vertex) Reset
func (x *Vertex) Reset()