documentaipb

package
Version: v1.13.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 1, 2022 License: Apache-2.0 Imports: 19 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
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.

View Source 
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.

View Source 
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.

View Source 
var (
	Document_Provenance_OperationType_name = map[int32]string{
		0: "OPERATION_TYPE_UNSPECIFIED",
		1: "ADD",
		2: "REMOVE",
		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,
		"REPLACE":                    3,
		"EVAL_REQUESTED":             4,
		"EVAL_APPROVED":              5,
		"EVAL_SKIPPED":               6,
	}
)

Enum value maps for Document_Provenance_OperationType.

View Source 
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.

View Source 
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.

View Source 
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.

View Source 
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.

View Source 
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.

View Source 
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.

View Source 
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.

View Source 
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.

View Source 
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.

View Source 
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.

View Source 
var File_google_cloud_documentai_v1beta3_barcode_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_documentai_v1beta3_document_io_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_documentai_v1beta3_document_processor_service_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_documentai_v1beta3_document_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_documentai_v1beta3_document_schema_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_documentai_v1beta3_evaluation_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_documentai_v1beta3_geometry_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_documentai_v1beta3_operation_metadata_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_documentai_v1beta3_processor_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_documentai_v1beta3_processor_type_proto protoreflect.FileDescriptor

Functions

func RegisterDocumentProcessorServiceServer 

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

Types

type 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 

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

Deprecated: Use Barcode.ProtoReflect.Descriptor instead.

func (*Barcode) GetFormat 

func (x *Barcode) GetFormat() string

func (*Barcode) GetRawValue 

func (x *Barcode) GetRawValue() string

func (*Barcode) GetValueFormat 

func (x *Barcode) GetValueFormat() string

func (*Barcode) ProtoMessage 

func (*Barcode) ProtoMessage()

func (*Barcode) ProtoReflect 

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

func (*Barcode) Reset 

func (x *Barcode) Reset()

func (*Barcode) String 

func (x *Barcode) String() string

type 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 deprecated 

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

Deprecated: Use BatchDocumentsInputConfig.ProtoReflect.Descriptor instead.

func (*BatchDocumentsInputConfig) GetGcsDocuments 

func (x *BatchDocumentsInputConfig) GetGcsDocuments() *GcsDocuments

func (*BatchDocumentsInputConfig) GetGcsPrefix 

func (x *BatchDocumentsInputConfig) GetGcsPrefix() *GcsPrefix

func (*BatchDocumentsInputConfig) GetSource 

func (m *BatchDocumentsInputConfig) GetSource() isBatchDocumentsInputConfig_Source

func (*BatchDocumentsInputConfig) ProtoMessage 

func (*BatchDocumentsInputConfig) ProtoMessage()

func (*BatchDocumentsInputConfig) ProtoReflect 

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

func (*BatchDocumentsInputConfig) Reset 

func (x *BatchDocumentsInputConfig) Reset()

func (*BatchDocumentsInputConfig) String 

func (x *BatchDocumentsInputConfig) String() string

type BatchDocumentsInputConfig_GcsDocuments 

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

type 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"`
}

type BatchProcessMetadata 

type BatchProcessMetadata struct {

	// The state of the current batch processing.
	State BatchProcessMetadata_State `` /* 128-byte string literal not displayed */
	// A message providing more details about the current state of processing.
	// For example, the error message if the operation is failed.
	StateMessage string `protobuf:"bytes,2,opt,name=state_message,json=stateMessage,proto3" json:"state_message,omitempty"`
	// The creation time of the operation.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// The last update time of the operation.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// The list of response details of each document.
	IndividualProcessStatuses []*BatchProcessMetadata_IndividualProcessStatus `` /* 138-byte string literal not displayed */
	// contains filtered or unexported fields
}

The long running operation metadata for batch process method.

func (*BatchProcessMetadata) Descriptor deprecated 

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

Deprecated: Use BatchProcessMetadata.ProtoReflect.Descriptor instead.

func (*BatchProcessMetadata) GetCreateTime 

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

func (*BatchProcessMetadata) GetIndividualProcessStatuses 

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

func (*BatchProcessMetadata) GetState 

func (x *BatchProcessMetadata) GetState() BatchProcessMetadata_State

func (*BatchProcessMetadata) GetStateMessage 

func (x *BatchProcessMetadata) GetStateMessage() string

func (*BatchProcessMetadata) GetUpdateTime 

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

func (*BatchProcessMetadata) ProtoMessage 

func (*BatchProcessMetadata) ProtoMessage()

func (*BatchProcessMetadata) ProtoReflect 

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

func (*BatchProcessMetadata) Reset 

func (x *BatchProcessMetadata) Reset()

func (*BatchProcessMetadata) String 

func (x *BatchProcessMetadata) String() string

type BatchProcessMetadata_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: Do not use.
	HumanReviewOperation string `protobuf:"bytes,4,opt,name=human_review_operation,json=humanReviewOperation,proto3" json:"human_review_operation,omitempty"`
	// The status of human review on the processed document.
	HumanReviewStatus *HumanReviewStatus `protobuf:"bytes,5,opt,name=human_review_status,json=humanReviewStatus,proto3" json:"human_review_status,omitempty"`
	// contains filtered or unexported fields
}

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

func (*BatchProcessMetadata_IndividualProcessStatus) Descriptor deprecated 

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

Deprecated: Use BatchProcessMetadata_IndividualProcessStatus.ProtoReflect.Descriptor instead.

func (*BatchProcessMetadata_IndividualProcessStatus) GetHumanReviewOperation deprecated 

func (x *BatchProcessMetadata_IndividualProcessStatus) GetHumanReviewOperation() string

Deprecated: Do not use.

func (*BatchProcessMetadata_IndividualProcessStatus) GetHumanReviewStatus 

func (x *BatchProcessMetadata_IndividualProcessStatus) GetHumanReviewStatus() *HumanReviewStatus

func (*BatchProcessMetadata_IndividualProcessStatus) GetInputGcsSource 

func (x *BatchProcessMetadata_IndividualProcessStatus) GetInputGcsSource() string

func (*BatchProcessMetadata_IndividualProcessStatus) GetOutputGcsDestination 

func (x *BatchProcessMetadata_IndividualProcessStatus) GetOutputGcsDestination() string

func (*BatchProcessMetadata_IndividualProcessStatus) GetStatus 

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

func (*BatchProcessMetadata_IndividualProcessStatus) ProtoMessage 

func (*BatchProcessMetadata_IndividualProcessStatus) ProtoMessage()

func (*BatchProcessMetadata_IndividualProcessStatus) ProtoReflect 

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

func (*BatchProcessMetadata_IndividualProcessStatus) Reset 

func (x *BatchProcessMetadata_IndividualProcessStatus) Reset()

func (*BatchProcessMetadata_IndividualProcessStatus) String 

func (x *BatchProcessMetadata_IndividualProcessStatus) String() string

type BatchProcessMetadata_State 

type BatchProcessMetadata_State int32

Possible states of the batch processing operation. 

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

func (BatchProcessMetadata_State) Descriptor 

func (BatchProcessMetadata_State) Descriptor() protoreflect.EnumDescriptor

func (BatchProcessMetadata_State) Enum 

func (x BatchProcessMetadata_State) Enum() *BatchProcessMetadata_State

func (BatchProcessMetadata_State) EnumDescriptor deprecated 

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

Deprecated: Use BatchProcessMetadata_State.Descriptor instead.

func (BatchProcessMetadata_State) Number 

func (x BatchProcessMetadata_State) Number() protoreflect.EnumNumber

func (BatchProcessMetadata_State) String 

func (x BatchProcessMetadata_State) String() string

func (BatchProcessMetadata_State) Type 

func (BatchProcessMetadata_State) Type() protoreflect.EnumType

type BatchProcessRequest 

type BatchProcessRequest struct {

	// Required. The resource name of [Processor][google.cloud.documentai.v1beta3.Processor] or
	// [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion].
	// Format: `projects/{project}/locations/{location}/processors/{processor}`,
	// or
	// `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The input config for each single document in the batch process.
	//
	// Deprecated: Do not use.
	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: Do not use.
	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"`
	// contains filtered or unexported fields
}

Request message for batch process document method.

func (*BatchProcessRequest) Descriptor deprecated 

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

Deprecated: Use BatchProcessRequest.ProtoReflect.Descriptor instead.

func (*BatchProcessRequest) GetDocumentOutputConfig 

func (x *BatchProcessRequest) GetDocumentOutputConfig() *DocumentOutputConfig

func (*BatchProcessRequest) GetInputConfigs deprecated 

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

Deprecated: Do not use.

func (*BatchProcessRequest) GetInputDocuments 

func (x *BatchProcessRequest) GetInputDocuments() *BatchDocumentsInputConfig

func (*BatchProcessRequest) GetName 

func (x *BatchProcessRequest) GetName() string

func (*BatchProcessRequest) GetOutputConfig deprecated 

func (x *BatchProcessRequest) GetOutputConfig() *BatchProcessRequest_BatchOutputConfig

Deprecated: Do not use.

func (*BatchProcessRequest) GetSkipHumanReview 

func (x *BatchProcessRequest) GetSkipHumanReview() bool

func (*BatchProcessRequest) ProtoMessage 

func (*BatchProcessRequest) ProtoMessage()

func (*BatchProcessRequest) ProtoReflect 

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

func (*BatchProcessRequest) Reset 

func (x *BatchProcessRequest) Reset()

func (*BatchProcessRequest) String 

func (x *BatchProcessRequest) String() string

type BatchProcessRequest_BatchInputConfig deprecated 

type BatchProcessRequest_BatchInputConfig struct {

	// The Cloud Storage location as the source of the document.
	GcsSource string `protobuf:"bytes,1,opt,name=gcs_source,json=gcsSource,proto3" json:"gcs_source,omitempty"`
	// 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: Do not use.

func (*BatchProcessRequest_BatchInputConfig) Descriptor deprecated 

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

Deprecated: Use BatchProcessRequest_BatchInputConfig.ProtoReflect.Descriptor instead.

func (*BatchProcessRequest_BatchInputConfig) GetGcsSource 

func (x *BatchProcessRequest_BatchInputConfig) GetGcsSource() string

func (*BatchProcessRequest_BatchInputConfig) GetMimeType 

func (x *BatchProcessRequest_BatchInputConfig) GetMimeType() string

func (*BatchProcessRequest_BatchInputConfig) ProtoMessage 

func (*BatchProcessRequest_BatchInputConfig) ProtoMessage()

func (*BatchProcessRequest_BatchInputConfig) ProtoReflect 

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

func (*BatchProcessRequest_BatchInputConfig) Reset 

func (x *BatchProcessRequest_BatchInputConfig) Reset()

func (*BatchProcessRequest_BatchInputConfig) String 

func (x *BatchProcessRequest_BatchInputConfig) String() string

type BatchProcessRequest_BatchOutputConfig deprecated 

type BatchProcessRequest_BatchOutputConfig struct {

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

The message for output config in batch process.

Deprecated: Do not use.

func (*BatchProcessRequest_BatchOutputConfig) Descriptor deprecated 

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

Deprecated: Use BatchProcessRequest_BatchOutputConfig.ProtoReflect.Descriptor instead.

func (*BatchProcessRequest_BatchOutputConfig) GetGcsDestination 

func (x *BatchProcessRequest_BatchOutputConfig) GetGcsDestination() string

func (*BatchProcessRequest_BatchOutputConfig) ProtoMessage 

func (*BatchProcessRequest_BatchOutputConfig) ProtoMessage()

func (*BatchProcessRequest_BatchOutputConfig) ProtoReflect 

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

func (*BatchProcessRequest_BatchOutputConfig) Reset 

func (x *BatchProcessRequest_BatchOutputConfig) Reset()

func (*BatchProcessRequest_BatchOutputConfig) String 

func (x *BatchProcessRequest_BatchOutputConfig) String() string

type BatchProcessResponse 

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

Response message for batch process document method.

func (*BatchProcessResponse) Descriptor deprecated 

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

Deprecated: Use BatchProcessResponse.ProtoReflect.Descriptor instead.

func (*BatchProcessResponse) ProtoMessage 

func (*BatchProcessResponse) ProtoMessage()

func (*BatchProcessResponse) ProtoReflect 

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

func (*BatchProcessResponse) Reset 

func (x *BatchProcessResponse) Reset()

func (*BatchProcessResponse) String 

func (x *BatchProcessResponse) String() string

type BoundingPoly 

type BoundingPoly struct {

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

A bounding polygon for the detected image annotation.

func (*BoundingPoly) Descriptor deprecated 

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

Deprecated: Use BoundingPoly.ProtoReflect.Descriptor instead.

func (*BoundingPoly) GetNormalizedVertices 

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

func (*BoundingPoly) GetVertices 

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

func (*BoundingPoly) ProtoMessage 

func (*BoundingPoly) ProtoMessage()

func (*BoundingPoly) ProtoReflect 

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

func (*BoundingPoly) Reset 

func (x *BoundingPoly) Reset()

func (*BoundingPoly) String 

func (x *BoundingPoly) String() string

type CommonOperationMetadata 

type CommonOperationMetadata struct {

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

The common metadata for long running operations.

func (*CommonOperationMetadata) Descriptor deprecated 

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

Deprecated: Use CommonOperationMetadata.ProtoReflect.Descriptor instead.

func (*CommonOperationMetadata) GetCreateTime 

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

func (*CommonOperationMetadata) GetResource 

func (x *CommonOperationMetadata) GetResource() string

func (*CommonOperationMetadata) GetState 

func (x *CommonOperationMetadata) GetState() CommonOperationMetadata_State

func (*CommonOperationMetadata) GetStateMessage 

func (x *CommonOperationMetadata) GetStateMessage() string

func (*CommonOperationMetadata) GetUpdateTime 

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

func (*CommonOperationMetadata) ProtoMessage 

func (*CommonOperationMetadata) ProtoMessage()

func (*CommonOperationMetadata) ProtoReflect 

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

func (*CommonOperationMetadata) Reset 

func (x *CommonOperationMetadata) Reset()

func (*CommonOperationMetadata) String 

func (x *CommonOperationMetadata) String() string

type CommonOperationMetadata_State 

type CommonOperationMetadata_State int32

State of the longrunning operation. 

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

func (CommonOperationMetadata_State) Descriptor 

func (CommonOperationMetadata_State) Descriptor() protoreflect.EnumDescriptor

func (CommonOperationMetadata_State) Enum 

func (x CommonOperationMetadata_State) Enum() *CommonOperationMetadata_State

func (CommonOperationMetadata_State) EnumDescriptor deprecated 

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

Deprecated: Use CommonOperationMetadata_State.Descriptor instead.

func (CommonOperationMetadata_State) Number 

func (x CommonOperationMetadata_State) Number() protoreflect.EnumNumber

func (CommonOperationMetadata_State) String 

func (x CommonOperationMetadata_State) String() string

func (CommonOperationMetadata_State) Type 

func (CommonOperationMetadata_State) Type() protoreflect.EnumType

type CreateProcessorRequest 

type CreateProcessorRequest struct {

	// Required. The parent (project and location) under which to create the processor.
	// Format: `projects/{project}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The processor to be created, requires [processor_type] 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 deprecated 

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

Deprecated: Use CreateProcessorRequest.ProtoReflect.Descriptor instead.

func (*CreateProcessorRequest) GetParent 

func (x *CreateProcessorRequest) GetParent() string

func (*CreateProcessorRequest) GetProcessor 

func (x *CreateProcessorRequest) GetProcessor() *Processor

func (*CreateProcessorRequest) ProtoMessage 

func (*CreateProcessorRequest) ProtoMessage()

func (*CreateProcessorRequest) ProtoReflect 

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

func (*CreateProcessorRequest) Reset 

func (x *CreateProcessorRequest) Reset()

func (*CreateProcessorRequest) String 

func (x *CreateProcessorRequest) String() string

type DeleteProcessorMetadata 

type DeleteProcessorMetadata struct {

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

The long running operation metadata for delete processor method.

func (*DeleteProcessorMetadata) Descriptor deprecated 

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

Deprecated: Use DeleteProcessorMetadata.ProtoReflect.Descriptor instead.

func (*DeleteProcessorMetadata) GetCommonMetadata 

func (x *DeleteProcessorMetadata) GetCommonMetadata() *CommonOperationMetadata

func (*DeleteProcessorMetadata) ProtoMessage 

func (*DeleteProcessorMetadata) ProtoMessage()

func (*DeleteProcessorMetadata) ProtoReflect 

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

func (*DeleteProcessorMetadata) Reset 

func (x *DeleteProcessorMetadata) Reset()

func (*DeleteProcessorMetadata) String 

func (x *DeleteProcessorMetadata) String() string

type DeleteProcessorRequest 

type DeleteProcessorRequest struct {

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

Request message for the delete processor method.

func (*DeleteProcessorRequest) Descriptor deprecated 

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

Deprecated: Use DeleteProcessorRequest.ProtoReflect.Descriptor instead.

func (*DeleteProcessorRequest) GetName 

func (x *DeleteProcessorRequest) GetName() string

func (*DeleteProcessorRequest) ProtoMessage 

func (*DeleteProcessorRequest) ProtoMessage()

func (*DeleteProcessorRequest) ProtoReflect 

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

func (*DeleteProcessorRequest) Reset 

func (x *DeleteProcessorRequest) Reset()

func (*DeleteProcessorRequest) String 

func (x *DeleteProcessorRequest) String() string

type DeleteProcessorVersionMetadata 

type DeleteProcessorVersionMetadata struct {

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

The long running operation metadata for delete processor version method.

func (*DeleteProcessorVersionMetadata) Descriptor deprecated 

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

Deprecated: Use DeleteProcessorVersionMetadata.ProtoReflect.Descriptor instead.

func (*DeleteProcessorVersionMetadata) GetCommonMetadata 

func (x *DeleteProcessorVersionMetadata) GetCommonMetadata() *CommonOperationMetadata

func (*DeleteProcessorVersionMetadata) ProtoMessage 

func (*DeleteProcessorVersionMetadata) ProtoMessage()

func (*DeleteProcessorVersionMetadata) ProtoReflect 

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

func (*DeleteProcessorVersionMetadata) Reset 

func (x *DeleteProcessorVersionMetadata) Reset()

func (*DeleteProcessorVersionMetadata) String 

func (x *DeleteProcessorVersionMetadata) String() string

type DeleteProcessorVersionRequest 

type DeleteProcessorVersionRequest struct {

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

Request message for the delete processor version method.

func (*DeleteProcessorVersionRequest) Descriptor deprecated 

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

Deprecated: Use DeleteProcessorVersionRequest.ProtoReflect.Descriptor instead.

func (*DeleteProcessorVersionRequest) GetName 

func (x *DeleteProcessorVersionRequest) GetName() string

func (*DeleteProcessorVersionRequest) ProtoMessage 

func (*DeleteProcessorVersionRequest) ProtoMessage()

func (*DeleteProcessorVersionRequest) ProtoReflect 

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

func (*DeleteProcessorVersionRequest) Reset 

func (x *DeleteProcessorVersionRequest) Reset()

func (*DeleteProcessorVersionRequest) String 

func (x *DeleteProcessorVersionRequest) String() string

type DeployProcessorVersionMetadata 

type DeployProcessorVersionMetadata struct {

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

The long running operation metadata for deploy processor version method.

func (*DeployProcessorVersionMetadata) Descriptor deprecated 

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

Deprecated: Use DeployProcessorVersionMetadata.ProtoReflect.Descriptor instead.

func (*DeployProcessorVersionMetadata) GetCommonMetadata 

func (x *DeployProcessorVersionMetadata) GetCommonMetadata() *CommonOperationMetadata

func (*DeployProcessorVersionMetadata) ProtoMessage 

func (*DeployProcessorVersionMetadata) ProtoMessage()

func (*DeployProcessorVersionMetadata) ProtoReflect 

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

func (*DeployProcessorVersionMetadata) Reset 

func (x *DeployProcessorVersionMetadata) Reset()

func (*DeployProcessorVersionMetadata) String 

func (x *DeployProcessorVersionMetadata) String() string

type DeployProcessorVersionRequest 

type DeployProcessorVersionRequest struct {

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

Request message for the deploy processor version method.

func (*DeployProcessorVersionRequest) Descriptor deprecated 

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

Deprecated: Use DeployProcessorVersionRequest.ProtoReflect.Descriptor instead.

func (*DeployProcessorVersionRequest) GetName 

func (x *DeployProcessorVersionRequest) GetName() string

func (*DeployProcessorVersionRequest) ProtoMessage 

func (*DeployProcessorVersionRequest) ProtoMessage()

func (*DeployProcessorVersionRequest) ProtoReflect 

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

func (*DeployProcessorVersionRequest) Reset 

func (x *DeployProcessorVersionRequest) Reset()

func (*DeployProcessorVersionRequest) String 

func (x *DeployProcessorVersionRequest) String() string

type DeployProcessorVersionResponse 

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

Response message for the deploy processor version method.

func (*DeployProcessorVersionResponse) Descriptor deprecated 

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

Deprecated: Use DeployProcessorVersionResponse.ProtoReflect.Descriptor instead.

func (*DeployProcessorVersionResponse) ProtoMessage 

func (*DeployProcessorVersionResponse) ProtoMessage()

func (*DeployProcessorVersionResponse) ProtoReflect 

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

func (*DeployProcessorVersionResponse) Reset 

func (x *DeployProcessorVersionResponse) Reset()

func (*DeployProcessorVersionResponse) String 

func (x *DeployProcessorVersionResponse) String() string

type DisableProcessorMetadata 

type DisableProcessorMetadata struct {

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

The long running operation metadata for disable processor method.

func (*DisableProcessorMetadata) Descriptor deprecated 

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

Deprecated: Use DisableProcessorMetadata.ProtoReflect.Descriptor instead.

func (*DisableProcessorMetadata) GetCommonMetadata 

func (x *DisableProcessorMetadata) GetCommonMetadata() *CommonOperationMetadata

func (*DisableProcessorMetadata) ProtoMessage 

func (*DisableProcessorMetadata) ProtoMessage()

func (*DisableProcessorMetadata) ProtoReflect 

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

func (*DisableProcessorMetadata) Reset 

func (x *DisableProcessorMetadata) Reset()

func (*DisableProcessorMetadata) String 

func (x *DisableProcessorMetadata) String() string

type DisableProcessorRequest 

type DisableProcessorRequest struct {

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

Request message for the disable processor method.

func (*DisableProcessorRequest) Descriptor deprecated 

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

Deprecated: Use DisableProcessorRequest.ProtoReflect.Descriptor instead.

func (*DisableProcessorRequest) GetName 

func (x *DisableProcessorRequest) GetName() string

func (*DisableProcessorRequest) ProtoMessage 

func (*DisableProcessorRequest) ProtoMessage()

func (*DisableProcessorRequest) ProtoReflect 

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

func (*DisableProcessorRequest) Reset 

func (x *DisableProcessorRequest) Reset()

func (*DisableProcessorRequest) String 

func (x *DisableProcessorRequest) String() string

type DisableProcessorResponse 

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 deprecated 

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

Deprecated: Use DisableProcessorResponse.ProtoReflect.Descriptor instead.

func (*DisableProcessorResponse) ProtoMessage 

func (*DisableProcessorResponse) ProtoMessage()

func (*DisableProcessorResponse) ProtoReflect 

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

func (*DisableProcessorResponse) Reset 

func (x *DisableProcessorResponse) Reset()

func (*DisableProcessorResponse) String 

func (x *DisableProcessorResponse) String() string

type Document 

type Document struct {

	// Original source document from the user.
	//
	// Types that are assignable to Source:
	//
	//	*Document_Uri
	//	*Document_Content
	Source isDocument_Source `protobuf_oneof:"source"`
	// An IANA published 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"`
	// Placeholder.  Styles for the [Document.text][google.cloud.documentai.v1beta3.Document.text].
	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 

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

Deprecated: Use Document.ProtoReflect.Descriptor instead.

func (*Document) GetContent 

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

func (*Document) GetEntities 

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

func (*Document) GetEntityRelations 

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

func (*Document) GetError 

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

func (*Document) GetMimeType 

func (x *Document) GetMimeType() string

func (*Document) GetPages 

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

func (*Document) GetRevisions 

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

func (*Document) GetShardInfo 

func (x *Document) GetShardInfo() *Document_ShardInfo

func (*Document) GetSource 

func (m *Document) GetSource() isDocument_Source

func (*Document) GetText 

func (x *Document) GetText() string

func (*Document) GetTextChanges 

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

func (*Document) GetTextStyles 

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

func (*Document) GetUri 

func (x *Document) GetUri() string

func (*Document) ProtoMessage 

func (*Document) ProtoMessage()

func (*Document) ProtoReflect 

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

func (*Document) Reset 

func (x *Document) Reset()

func (*Document) String 

func (x *Document) String() string

type 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 deprecated 

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

Deprecated: Use DocumentOutputConfig.ProtoReflect.Descriptor instead.

func (*DocumentOutputConfig) GetDestination 

func (m *DocumentOutputConfig) GetDestination() isDocumentOutputConfig_Destination

func (*DocumentOutputConfig) GetGcsOutputConfig 

func (x *DocumentOutputConfig) GetGcsOutputConfig() *DocumentOutputConfig_GcsOutputConfig

func (*DocumentOutputConfig) ProtoMessage 

func (*DocumentOutputConfig) ProtoMessage()

func (*DocumentOutputConfig) ProtoReflect 

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

func (*DocumentOutputConfig) Reset 

func (x *DocumentOutputConfig) Reset()

func (*DocumentOutputConfig) String 

func (x *DocumentOutputConfig) String() string

type DocumentOutputConfig_GcsOutputConfig 

type DocumentOutputConfig_GcsOutputConfig struct {

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

The configuration used when outputting documents.

func (*DocumentOutputConfig_GcsOutputConfig) Descriptor deprecated 

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

Deprecated: Use DocumentOutputConfig_GcsOutputConfig.ProtoReflect.Descriptor instead.

func (*DocumentOutputConfig_GcsOutputConfig) GetFieldMask added in v1.13.0 

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

func (*DocumentOutputConfig_GcsOutputConfig) GetGcsUri 

func (x *DocumentOutputConfig_GcsOutputConfig) GetGcsUri() string

func (*DocumentOutputConfig_GcsOutputConfig) ProtoMessage 

func (*DocumentOutputConfig_GcsOutputConfig) ProtoMessage()

func (*DocumentOutputConfig_GcsOutputConfig) ProtoReflect 

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

func (*DocumentOutputConfig_GcsOutputConfig) Reset 

func (x *DocumentOutputConfig_GcsOutputConfig) Reset()

func (*DocumentOutputConfig_GcsOutputConfig) String 

func (x *DocumentOutputConfig_GcsOutputConfig) String() string

type DocumentOutputConfig_GcsOutputConfig_ 

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

type DocumentProcessorServiceClient 

type DocumentProcessorServiceClient interface {
	// Processes a single document.
	ProcessDocument(ctx context.Context, in *ProcessRequest, opts ...grpc.CallOption) (*ProcessResponse, error)
	// LRO endpoint to batch process many documents. The output is written
	// to Cloud Storage as JSON in the [Document] format.
	BatchProcessDocuments(ctx context.Context, in *BatchProcessRequest, opts ...grpc.CallOption) (*longrunning.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)
	// 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) (*longrunning.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) (*longrunning.Operation, error)
	// Deploys the processor version.
	DeployProcessorVersion(ctx context.Context, in *DeployProcessorVersionRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Undeploys the processor version.
	UndeployProcessorVersion(ctx context.Context, in *UndeployProcessorVersionRequest, opts ...grpc.CallOption) (*longrunning.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) (*longrunning.Operation, error)
	// Enables a processor
	EnableProcessor(ctx context.Context, in *EnableProcessorRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Disables a processor
	DisableProcessor(ctx context.Context, in *DisableProcessorRequest, opts ...grpc.CallOption) (*longrunning.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) (*longrunning.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) (*longrunning.Operation, error)
	// Evaluates a ProcessorVersion against annotated documents, producing an
	// Evaluation.
	EvaluateProcessorVersion(ctx context.Context, in *EvaluateProcessorVersionRequest, opts ...grpc.CallOption) (*longrunning.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)
}

DocumentProcessorServiceClient is the client API for DocumentProcessorService service.

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

func NewDocumentProcessorServiceClient 

func NewDocumentProcessorServiceClient(cc grpc.ClientConnInterface) DocumentProcessorServiceClient

type DocumentProcessorServiceServer 

type DocumentProcessorServiceServer interface {
	// Processes a single document.
	ProcessDocument(context.Context, *ProcessRequest) (*ProcessResponse, error)
	// LRO endpoint to batch process many documents. The output is written
	// to Cloud Storage as JSON in the [Document] format.
	BatchProcessDocuments(context.Context, *BatchProcessRequest) (*longrunning.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)
	// 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) (*longrunning.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) (*longrunning.Operation, error)
	// Deploys the processor version.
	DeployProcessorVersion(context.Context, *DeployProcessorVersionRequest) (*longrunning.Operation, error)
	// Undeploys the processor version.
	UndeployProcessorVersion(context.Context, *UndeployProcessorVersionRequest) (*longrunning.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) (*longrunning.Operation, error)
	// Enables a processor
	EnableProcessor(context.Context, *EnableProcessorRequest) (*longrunning.Operation, error)
	// Disables a processor
	DisableProcessor(context.Context, *DisableProcessorRequest) (*longrunning.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) (*longrunning.Operation, error)
	// Send a document for Human Review. The input document should be processed by
	// the specified processor.
	ReviewDocument(context.Context, *ReviewDocumentRequest) (*longrunning.Operation, error)
	// Evaluates a ProcessorVersion against annotated documents, producing an
	// Evaluation.
	EvaluateProcessorVersion(context.Context, *EvaluateProcessorVersionRequest) (*longrunning.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)
}

DocumentProcessorServiceServer is the server API for DocumentProcessorService service.

type 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 deprecated 

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

Deprecated: Use DocumentSchema.ProtoReflect.Descriptor instead.

func (*DocumentSchema) GetDescription 

func (x *DocumentSchema) GetDescription() string

func (*DocumentSchema) GetDisplayName 

func (x *DocumentSchema) GetDisplayName() string

func (*DocumentSchema) GetEntityTypes 

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

func (*DocumentSchema) GetMetadata 

func (x *DocumentSchema) GetMetadata() *DocumentSchema_Metadata

func (*DocumentSchema) ProtoMessage 

func (*DocumentSchema) ProtoMessage()

func (*DocumentSchema) ProtoReflect 

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

func (*DocumentSchema) Reset 

func (x *DocumentSchema) Reset()

func (*DocumentSchema) String 

func (x *DocumentSchema) String() string

type DocumentSchema_EntityType 

type DocumentSchema_EntityType struct {

	// Types that are assignable to ValueSource:
	//
	//	*DocumentSchema_EntityType_EnumValues_
	ValueSource isDocumentSchema_EntityType_ValueSource `protobuf_oneof:"value_source"`
	// User defined name for the type.
	DisplayName string `protobuf:"bytes,13,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Name of the type. It must be unique within the schema file and
	// cannot be a 'Common Type'.  Besides that we use the following naming
	// conventions:
	//
	//   - *use `snake_casing`*
	//   - name matching is case-insensitive
	//   - 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 deprecated 

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

Deprecated: Use DocumentSchema_EntityType.ProtoReflect.Descriptor instead.

func (*DocumentSchema_EntityType) GetBaseTypes 

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

func (*DocumentSchema_EntityType) GetDisplayName 

func (x *DocumentSchema_EntityType) GetDisplayName() string

func (*DocumentSchema_EntityType) GetEnumValues 

func (x *DocumentSchema_EntityType) GetEnumValues() *DocumentSchema_EntityType_EnumValues

func (*DocumentSchema_EntityType) GetName 

func (x *DocumentSchema_EntityType) GetName() string

func (*DocumentSchema_EntityType) GetProperties 

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

func (*DocumentSchema_EntityType) GetValueSource 

func (m *DocumentSchema_EntityType) GetValueSource() isDocumentSchema_EntityType_ValueSource

func (*DocumentSchema_EntityType) ProtoMessage 

func (*DocumentSchema_EntityType) ProtoMessage()

func (*DocumentSchema_EntityType) ProtoReflect 

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

func (*DocumentSchema_EntityType) Reset 

func (x *DocumentSchema_EntityType) Reset()

func (*DocumentSchema_EntityType) String 

func (x *DocumentSchema_EntityType) String() string

type DocumentSchema_EntityType_EnumValues 

type DocumentSchema_EntityType_EnumValues struct {

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

Defines the a list of enum values.

func (*DocumentSchema_EntityType_EnumValues) Descriptor deprecated 

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

Deprecated: Use DocumentSchema_EntityType_EnumValues.ProtoReflect.Descriptor instead.

func (*DocumentSchema_EntityType_EnumValues) GetValues 

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

func (*DocumentSchema_EntityType_EnumValues) ProtoMessage 

func (*DocumentSchema_EntityType_EnumValues) ProtoMessage()

func (*DocumentSchema_EntityType_EnumValues) ProtoReflect 

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

func (*DocumentSchema_EntityType_EnumValues) Reset 

func (x *DocumentSchema_EntityType_EnumValues) Reset()

func (*DocumentSchema_EntityType_EnumValues) String 

func (x *DocumentSchema_EntityType_EnumValues) String() string

type DocumentSchema_EntityType_EnumValues_ 

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

type DocumentSchema_EntityType_Property 

type DocumentSchema_EntityType_Property struct {

	// The name of the property.  Follows the same guidelines as the
	// EntityType name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// A reference to the value type of the property.  This type is subject
	// to the same conventions as the `Entity.base_types` field.
	ValueType string `protobuf:"bytes,2,opt,name=value_type,json=valueType,proto3" json:"value_type,omitempty"`
	// Occurrence type limits the number of instances an entity type appears
	// in the document.
	OccurrenceType DocumentSchema_EntityType_Property_OccurrenceType `` /* 191-byte string literal not displayed */
	// contains filtered or unexported fields
}

Defines properties that can be part of the entity type.

func (*DocumentSchema_EntityType_Property) Descriptor deprecated 

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() string

func (*DocumentSchema_EntityType_Property) GetOccurrenceType 

func (x *DocumentSchema_EntityType_Property) GetOccurrenceType() DocumentSchema_EntityType_Property_OccurrenceType

func (*DocumentSchema_EntityType_Property) GetValueType 

func (x *DocumentSchema_EntityType_Property) GetValueType() string

func (*DocumentSchema_EntityType_Property) ProtoMessage 

func (*DocumentSchema_EntityType_Property) ProtoMessage()

func (*DocumentSchema_EntityType_Property) ProtoReflect 

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

func (*DocumentSchema_EntityType_Property) Reset 

func (x *DocumentSchema_EntityType_Property) Reset()

func (*DocumentSchema_EntityType_Property) String 

func (x *DocumentSchema_EntityType_Property) String() string

type DocumentSchema_EntityType_Property_OccurrenceType 

type DocumentSchema_EntityType_Property_OccurrenceType int32

Types 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. 

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.EnumDescriptor

func (DocumentSchema_EntityType_Property_OccurrenceType) Enum 

func (x DocumentSchema_EntityType_Property_OccurrenceType) Enum() *DocumentSchema_EntityType_Property_OccurrenceType

func (DocumentSchema_EntityType_Property_OccurrenceType) EnumDescriptor deprecated 

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

Deprecated: Use DocumentSchema_EntityType_Property_OccurrenceType.Descriptor instead.

func (DocumentSchema_EntityType_Property_OccurrenceType) Number 

func (x DocumentSchema_EntityType_Property_OccurrenceType) Number() protoreflect.EnumNumber

func (DocumentSchema_EntityType_Property_OccurrenceType) String 

func (x DocumentSchema_EntityType_Property_OccurrenceType) String() string

func (DocumentSchema_EntityType_Property_OccurrenceType) Type 

func (DocumentSchema_EntityType_Property_OccurrenceType) Type() protoreflect.EnumType

type DocumentSchema_Metadata 

type DocumentSchema_Metadata struct {

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

Metadata for global schema behavior.

func (*DocumentSchema_Metadata) Descriptor deprecated 

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

Deprecated: Use DocumentSchema_Metadata.ProtoReflect.Descriptor instead.

func (*DocumentSchema_Metadata) GetDocumentAllowMultipleLabels 

func (x *DocumentSchema_Metadata) GetDocumentAllowMultipleLabels() bool

func (*DocumentSchema_Metadata) GetDocumentSplitter 

func (x *DocumentSchema_Metadata) GetDocumentSplitter() bool

func (*DocumentSchema_Metadata) GetPrefixedNamingOnProperties 

func (x *DocumentSchema_Metadata) GetPrefixedNamingOnProperties() bool

func (*DocumentSchema_Metadata) GetSkipNamingValidation 

func (x *DocumentSchema_Metadata) GetSkipNamingValidation() bool

func (*DocumentSchema_Metadata) ProtoMessage 

func (*DocumentSchema_Metadata) ProtoMessage()

func (*DocumentSchema_Metadata) ProtoReflect 

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

func (*DocumentSchema_Metadata) Reset 

func (x *DocumentSchema_Metadata) Reset()

func (*DocumentSchema_Metadata) String 

func (x *DocumentSchema_Metadata) String() string

type Document_Content 

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

type 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 deprecated 

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

Deprecated: Use Document_Entity.ProtoReflect.Descriptor instead.

func (*Document_Entity) GetConfidence 

func (x *Document_Entity) GetConfidence() float32

func (*Document_Entity) GetId 

func (x *Document_Entity) GetId() string

func (*Document_Entity) GetMentionId 

func (x *Document_Entity) GetMentionId() string

func (*Document_Entity) GetMentionText 

func (x *Document_Entity) GetMentionText() string

func (*Document_Entity) GetNormalizedValue 

func (x *Document_Entity) GetNormalizedValue() *Document_Entity_NormalizedValue

func (*Document_Entity) GetPageAnchor 

func (x *Document_Entity) GetPageAnchor() *Document_PageAnchor

func (*Document_Entity) GetProperties 

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

func (*Document_Entity) GetProvenance 

func (x *Document_Entity) GetProvenance() *Document_Provenance

func (*Document_Entity) GetRedacted 

func (x *Document_Entity) GetRedacted() bool

func (*Document_Entity) GetTextAnchor 

func (x *Document_Entity) GetTextAnchor() *Document_TextAnchor

func (*Document_Entity) GetType 

func (x *Document_Entity) GetType() string

func (*Document_Entity) ProtoMessage 

func (*Document_Entity) ProtoMessage()

func (*Document_Entity) ProtoReflect 

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

func (*Document_Entity) Reset 

func (x *Document_Entity) Reset()

func (*Document_Entity) String 

func (x *Document_Entity) String() string

type Document_EntityRelation 

type Document_EntityRelation struct {

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

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

func (*Document_EntityRelation) Descriptor deprecated 

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

Deprecated: Use Document_EntityRelation.ProtoReflect.Descriptor instead.

func (*Document_EntityRelation) GetObjectId 

func (x *Document_EntityRelation) GetObjectId() string

func (*Document_EntityRelation) GetRelation 

func (x *Document_EntityRelation) GetRelation() string

func (*Document_EntityRelation) GetSubjectId 

func (x *Document_EntityRelation) GetSubjectId() string

func (*Document_EntityRelation) ProtoMessage 

func (*Document_EntityRelation) ProtoMessage()

func (*Document_EntityRelation) ProtoReflect 

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

func (*Document_EntityRelation) Reset 

func (x *Document_EntityRelation) Reset()

func (*Document_EntityRelation) String 

func (x *Document_EntityRelation) String() string

type Document_Entity_NormalizedValue 

type Document_Entity_NormalizedValue struct {

	// An optional structured entity value.
	// Must match entity type defined in schema if
	// known. If this field is present, the `text` field could also be
	// populated.
	//
	// Types that are assignable to StructuredValue:
	//
	//	*Document_Entity_NormalizedValue_MoneyValue
	//	*Document_Entity_NormalizedValue_DateValue
	//	*Document_Entity_NormalizedValue_DatetimeValue
	//	*Document_Entity_NormalizedValue_AddressValue
	//	*Document_Entity_NormalizedValue_BooleanValue
	//	*Document_Entity_NormalizedValue_IntegerValue
	//	*Document_Entity_NormalizedValue_FloatValue
	StructuredValue isDocument_Entity_NormalizedValue_StructuredValue `protobuf_oneof:"structured_value"`
	// Optional. An optional field to store a normalized string.
	// For some entity types, one of respective `structured_value` fields may
	// also be populated. Also not all the types of `structured_value` will be
	// normalized. For example, some processors may not generate float
	// or int 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 deprecated 

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

Deprecated: Use Document_Entity_NormalizedValue.ProtoReflect.Descriptor instead.

func (*Document_Entity_NormalizedValue) GetAddressValue 

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

func (*Document_Entity_NormalizedValue) GetBooleanValue 

func (x *Document_Entity_NormalizedValue) GetBooleanValue() bool

func (*Document_Entity_NormalizedValue) GetDateValue 

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

func (*Document_Entity_NormalizedValue) GetDatetimeValue 

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

func (*Document_Entity_NormalizedValue) GetFloatValue 

func (x *Document_Entity_NormalizedValue) GetFloatValue() float32

func (*Document_Entity_NormalizedValue) GetIntegerValue 

func (x *Document_Entity_NormalizedValue) GetIntegerValue() int32

func (*Document_Entity_NormalizedValue) GetMoneyValue 

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

func (*Document_Entity_NormalizedValue) GetStructuredValue 

func (m *Document_Entity_NormalizedValue) GetStructuredValue() isDocument_Entity_NormalizedValue_StructuredValue

func (*Document_Entity_NormalizedValue) GetText 

func (x *Document_Entity_NormalizedValue) GetText() string

func (*Document_Entity_NormalizedValue) ProtoMessage 

func (*Document_Entity_NormalizedValue) ProtoMessage()

func (*Document_Entity_NormalizedValue) ProtoReflect 

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

func (*Document_Entity_NormalizedValue) Reset 

func (x *Document_Entity_NormalizedValue) Reset()

func (*Document_Entity_NormalizedValue) String 

func (x *Document_Entity_NormalizedValue) String() string

type Document_Entity_NormalizedValue_AddressValue 

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

type 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"`
}

type 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"`
}

type 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"`
}

type 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"`
}

type 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"`
}

type 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"`
}

type 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: Do not use.
	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 deprecated 

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

Deprecated: Use Document_Page.ProtoReflect.Descriptor instead.

func (*Document_Page) GetBlocks 

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

func (*Document_Page) GetDetectedBarcodes 

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

func (*Document_Page) GetDetectedLanguages 

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

func (*Document_Page) GetDimension 

func (x *Document_Page) GetDimension() *Document_Page_Dimension

func (*Document_Page) GetFormFields 

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

func (*Document_Page) GetImage 

func (x *Document_Page) GetImage() *Document_Page_Image

func (*Document_Page) GetImageQualityScores added in v1.12.0 

func (x *Document_Page) GetImageQualityScores() *Document_Page_ImageQualityScores

func (*Document_Page) GetLayout 

func (x *Document_Page) GetLayout() *Document_Page_Layout

func (*Document_Page) GetLines 

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

func (*Document_Page) GetPageNumber 

func (x *Document_Page) GetPageNumber() int32

func (*Document_Page) GetParagraphs 

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

func (*Document_Page) GetProvenance deprecated 

func (x *Document_Page) GetProvenance() *Document_Provenance

Deprecated: Do not use.

func (*Document_Page) GetSymbols 

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

func (*Document_Page) GetTables 

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

func (*Document_Page) GetTokens 

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

func (*Document_Page) GetTransforms 

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

func (*Document_Page) GetVisualElements 

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

func (*Document_Page) ProtoMessage 

func (*Document_Page) ProtoMessage()

func (*Document_Page) ProtoReflect 

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

func (*Document_Page) Reset 

func (x *Document_Page) Reset()

func (*Document_Page) String 

func (x *Document_Page) String() string

type Document_PageAnchor 

type Document_PageAnchor struct {

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

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

func (*Document_PageAnchor) Descriptor deprecated 

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

Deprecated: Use Document_PageAnchor.ProtoReflect.Descriptor instead.

func (*Document_PageAnchor) GetPageRefs 

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

func (*Document_PageAnchor) ProtoMessage 

func (*Document_PageAnchor) ProtoMessage()

func (*Document_PageAnchor) ProtoReflect 

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

func (*Document_PageAnchor) Reset 

func (x *Document_PageAnchor) Reset()

func (*Document_PageAnchor) String 

func (x *Document_PageAnchor) String() string

type Document_PageAnchor_PageRef 

type Document_PageAnchor_PageRef struct {

	// Required. Index into the [Document.pages][google.cloud.documentai.v1beta3.Document.pages] element, for example using
	// [Document.pages][page_refs.page] to locate the related page element.
	// This field is skipped when its value is the default 0. See
	// https://developers.google.com/protocol-buffers/docs/proto3#json.
	Page int64 `protobuf:"varint,1,opt,name=page,proto3" json:"page,omitempty"`
	// Optional. The type of the layout element that is being referenced if any.
	LayoutType Document_PageAnchor_PageRef_LayoutType `` /* 168-byte string literal not displayed */
	// Optional. Deprecated.  Use [PageRef.bounding_poly][google.cloud.documentai.v1beta3.Document.PageAnchor.PageRef.bounding_poly] instead.
	//
	// Deprecated: Do not use.
	LayoutId string `protobuf:"bytes,3,opt,name=layout_id,json=layoutId,proto3" json:"layout_id,omitempty"`
	// Optional. Identifies the bounding polygon of a layout element on the page.
	BoundingPoly *BoundingPoly `protobuf:"bytes,4,opt,name=bounding_poly,json=boundingPoly,proto3" json:"bounding_poly,omitempty"`
	// Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
	Confidence float32 `protobuf:"fixed32,5,opt,name=confidence,proto3" json:"confidence,omitempty"`
	// contains filtered or unexported fields
}

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

func (*Document_PageAnchor_PageRef) Descriptor deprecated 

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

Deprecated: Use Document_PageAnchor_PageRef.ProtoReflect.Descriptor instead.

func (*Document_PageAnchor_PageRef) GetBoundingPoly 

func (x *Document_PageAnchor_PageRef) GetBoundingPoly() *BoundingPoly

func (*Document_PageAnchor_PageRef) GetConfidence 

func (x *Document_PageAnchor_PageRef) GetConfidence() float32

func (*Document_PageAnchor_PageRef) GetLayoutId deprecated 

func (x *Document_PageAnchor_PageRef) GetLayoutId() string

Deprecated: Do not use.

func (*Document_PageAnchor_PageRef) GetLayoutType 

func (x *Document_PageAnchor_PageRef) GetLayoutType() Document_PageAnchor_PageRef_LayoutType

func (*Document_PageAnchor_PageRef) GetPage 

func (x *Document_PageAnchor_PageRef) GetPage() int64

func (*Document_PageAnchor_PageRef) ProtoMessage 

func (*Document_PageAnchor_PageRef) ProtoMessage()

func (*Document_PageAnchor_PageRef) ProtoReflect 

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

func (*Document_PageAnchor_PageRef) Reset 

func (x *Document_PageAnchor_PageRef) Reset()

func (*Document_PageAnchor_PageRef) String 

func (x *Document_PageAnchor_PageRef) String() string

type Document_PageAnchor_PageRef_LayoutType 

type Document_PageAnchor_PageRef_LayoutType int32

The type of layout that is being referenced. 

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

func (Document_PageAnchor_PageRef_LayoutType) Descriptor 

func (Document_PageAnchor_PageRef_LayoutType) Descriptor() protoreflect.EnumDescriptor

func (Document_PageAnchor_PageRef_LayoutType) Enum 

func (x Document_PageAnchor_PageRef_LayoutType) Enum() *Document_PageAnchor_PageRef_LayoutType

func (Document_PageAnchor_PageRef_LayoutType) EnumDescriptor deprecated 

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

Deprecated: Use Document_PageAnchor_PageRef_LayoutType.Descriptor instead.

func (Document_PageAnchor_PageRef_LayoutType) Number 

func (x Document_PageAnchor_PageRef_LayoutType) Number() protoreflect.EnumNumber

func (Document_PageAnchor_PageRef_LayoutType) String 

func (x Document_PageAnchor_PageRef_LayoutType) String() string

func (Document_PageAnchor_PageRef_LayoutType) Type 

func (Document_PageAnchor_PageRef_LayoutType) Type() protoreflect.EnumType

type Document_Page_Block 

type Document_Page_Block struct {

	// [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for [Block][google.cloud.documentai.v1beta3.Document.Page.Block].
	Layout *Document_Page_Layout `protobuf:"bytes,1,opt,name=layout,proto3" json:"layout,omitempty"`
	// A list of detected languages together with confidence.
	DetectedLanguages []*Document_Page_DetectedLanguage `protobuf:"bytes,2,rep,name=detected_languages,json=detectedLanguages,proto3" json:"detected_languages,omitempty"`
	// The history of this annotation.
	//
	// Deprecated: Do not use.
	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 deprecated 

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

Deprecated: Use Document_Page_Block.ProtoReflect.Descriptor instead.

func (*Document_Page_Block) GetDetectedLanguages 

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

func (*Document_Page_Block) GetLayout 

func (x *Document_Page_Block) GetLayout() *Document_Page_Layout

func (*Document_Page_Block) GetProvenance deprecated 

func (x *Document_Page_Block) GetProvenance() *Document_Provenance

Deprecated: Do not use.

func (*Document_Page_Block) ProtoMessage 

func (*Document_Page_Block) ProtoMessage()

func (*Document_Page_Block) ProtoReflect 

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

func (*Document_Page_Block) Reset 

func (x *Document_Page_Block) Reset()

func (*Document_Page_Block) String 

func (x *Document_Page_Block) String() string

type Document_Page_DetectedBarcode 

type Document_Page_DetectedBarcode struct {

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

A detected barcode.

func (*Document_Page_DetectedBarcode) Descriptor deprecated 

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

Deprecated: Use Document_Page_DetectedBarcode.ProtoReflect.Descriptor instead.

func (*Document_Page_DetectedBarcode) GetBarcode 

func (x *Document_Page_DetectedBarcode) GetBarcode() *Barcode

func (*Document_Page_DetectedBarcode) GetLayout 

func (x *Document_Page_DetectedBarcode) GetLayout() *Document_Page_Layout

func (*Document_Page_DetectedBarcode) ProtoMessage 

func (*Document_Page_DetectedBarcode) ProtoMessage()

func (*Document_Page_DetectedBarcode) ProtoReflect 

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

func (*Document_Page_DetectedBarcode) Reset 

func (x *Document_Page_DetectedBarcode) Reset()

func (*Document_Page_DetectedBarcode) String 

func (x *Document_Page_DetectedBarcode) String() string

type Document_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 deprecated 

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

Deprecated: Use Document_Page_DetectedLanguage.ProtoReflect.Descriptor instead.

func (*Document_Page_DetectedLanguage) GetConfidence 

func (x *Document_Page_DetectedLanguage) GetConfidence() float32

func (*Document_Page_DetectedLanguage) GetLanguageCode 

func (x *Document_Page_DetectedLanguage) GetLanguageCode() string

func (*Document_Page_DetectedLanguage) ProtoMessage 

func (*Document_Page_DetectedLanguage) ProtoMessage()

func (*Document_Page_DetectedLanguage) ProtoReflect 

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

func (*Document_Page_DetectedLanguage) Reset 

func (x *Document_Page_DetectedLanguage) Reset()

func (*Document_Page_DetectedLanguage) String 

func (x *Document_Page_DetectedLanguage) String() string

type Document_Page_Dimension 

type Document_Page_Dimension struct {

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

Dimension for the page.

func (*Document_Page_Dimension) Descriptor deprecated 

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

Deprecated: Use Document_Page_Dimension.ProtoReflect.Descriptor instead.

func (*Document_Page_Dimension) GetHeight 

func (x *Document_Page_Dimension) GetHeight() float32

func (*Document_Page_Dimension) GetUnit 

func (x *Document_Page_Dimension) GetUnit() string

func (*Document_Page_Dimension) GetWidth 

func (x *Document_Page_Dimension) GetWidth() float32

func (*Document_Page_Dimension) ProtoMessage 

func (*Document_Page_Dimension) ProtoMessage()

func (*Document_Page_Dimension) ProtoReflect 

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

func (*Document_Page_Dimension) Reset 

func (x *Document_Page_Dimension) Reset()

func (*Document_Page_Dimension) String 

func (x *Document_Page_Dimension) String() string

type Document_Page_FormField 

type Document_Page_FormField struct {

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

A form field detected on the page.

func (*Document_Page_FormField) Descriptor deprecated 

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

Deprecated: Use Document_Page_FormField.ProtoReflect.Descriptor instead.

func (*Document_Page_FormField) GetCorrectedKeyText 

func (x *Document_Page_FormField) GetCorrectedKeyText() string

func (*Document_Page_FormField) GetCorrectedValueText 

func (x *Document_Page_FormField) GetCorrectedValueText() string

func (*Document_Page_FormField) GetFieldName 

func (x *Document_Page_FormField) GetFieldName() *Document_Page_Layout

func (*Document_Page_FormField) GetFieldValue 

func (x *Document_Page_FormField) GetFieldValue() *Document_Page_Layout

func (*Document_Page_FormField) GetNameDetectedLanguages 

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

func (*Document_Page_FormField) GetProvenance 

func (x *Document_Page_FormField) GetProvenance() *Document_Provenance

func (*Document_Page_FormField) GetValueDetectedLanguages 

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

func (*Document_Page_FormField) GetValueType 

func (x *Document_Page_FormField) GetValueType() string

func (*Document_Page_FormField) ProtoMessage 

func (*Document_Page_FormField) ProtoMessage()

func (*Document_Page_FormField) ProtoReflect 

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

func (*Document_Page_FormField) Reset 

func (x *Document_Page_FormField) Reset()

func (*Document_Page_FormField) String 

func (x *Document_Page_FormField) String() string

type Document_Page_Image 

type Document_Page_Image struct {

	// Raw byte content of the image.
	Content []byte `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"`
	// Encoding 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 deprecated 

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

Deprecated: Use Document_Page_Image.ProtoReflect.Descriptor instead.

func (*Document_Page_Image) GetContent 

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

func (*Document_Page_Image) GetHeight 

func (x *Document_Page_Image) GetHeight() int32

func (*Document_Page_Image) GetMimeType 

func (x *Document_Page_Image) GetMimeType() string

func (*Document_Page_Image) GetWidth 

func (x *Document_Page_Image) GetWidth() int32

func (*Document_Page_Image) ProtoMessage 

func (*Document_Page_Image) ProtoMessage()

func (*Document_Page_Image) ProtoReflect 

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

func (*Document_Page_Image) Reset 

func (x *Document_Page_Image) Reset()

func (*Document_Page_Image) String 

func (x *Document_Page_Image) String() string

type Document_Page_ImageQualityScores added in v1.12.0 

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 deprecated added in v1.12.0 

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

Deprecated: Use Document_Page_ImageQualityScores.ProtoReflect.Descriptor instead.

func (*Document_Page_ImageQualityScores) GetDetectedDefects added in v1.12.0 

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

func (*Document_Page_ImageQualityScores) GetQualityScore added in v1.12.0 

func (x *Document_Page_ImageQualityScores) GetQualityScore() float32

func (*Document_Page_ImageQualityScores) ProtoMessage added in