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

Stay organized with collections Save and categorize content based on your preferences.

Variables

Document_Page_Layout_Orientation_name, Document_Page_Layout_Orientation_value

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

Enum value maps for Document_Page_Layout_Orientation.

Document_Page_Token_DetectedBreak_Type_name, Document_Page_Token_DetectedBreak_Type_value

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

Enum value maps for Document_Page_Token_DetectedBreak_Type.

Document_PageAnchor_PageRef_LayoutType_name, Document_PageAnchor_PageRef_LayoutType_value

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

Enum value maps for Document_PageAnchor_PageRef_LayoutType.

Document_Provenance_OperationType_name, Document_Provenance_OperationType_value

var (
	Document_Provenance_OperationType_name = map[int32]string{
		0: "OPERATION_TYPE_UNSPECIFIED",
		1: "ADD",
		2: "REMOVE",
		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.

HumanReviewStatus_State_name, HumanReviewStatus_State_value

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

Enum value maps for HumanReviewStatus_State.

BatchProcessMetadata_State_name, BatchProcessMetadata_State_value

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

Enum value maps for BatchProcessMetadata_State.

ReviewDocumentRequest_Priority_name, ReviewDocumentRequest_Priority_value

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

Enum value maps for ReviewDocumentRequest_Priority.

ReviewDocumentResponse_State_name, ReviewDocumentResponse_State_value

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

Enum value maps for ReviewDocumentResponse_State.

ReviewDocumentOperationMetadata_State_name, ReviewDocumentOperationMetadata_State_value

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

Enum value maps for ReviewDocumentOperationMetadata_State.

DocumentSchema_EntityType_Property_OccurrenceType_name, DocumentSchema_EntityType_Property_OccurrenceType_value

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

Enum value maps for DocumentSchema_EntityType_Property_OccurrenceType.

CommonOperationMetadata_State_name, CommonOperationMetadata_State_value

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

Enum value maps for CommonOperationMetadata_State.

ProcessorVersion_State_name, ProcessorVersion_State_value

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

Enum value maps for ProcessorVersion_State.

Processor_State_name, Processor_State_value

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

Enum value maps for Processor_State.

File_google_cloud_documentai_v1beta3_barcode_proto

var File_google_cloud_documentai_v1beta3_barcode_proto protoreflect.FileDescriptor

File_google_cloud_documentai_v1beta3_document_io_proto

var File_google_cloud_documentai_v1beta3_document_io_proto protoreflect.FileDescriptor

File_google_cloud_documentai_v1beta3_document_processor_service_proto

var File_google_cloud_documentai_v1beta3_document_processor_service_proto protoreflect.FileDescriptor

File_google_cloud_documentai_v1beta3_document_proto

var File_google_cloud_documentai_v1beta3_document_proto protoreflect.FileDescriptor

File_google_cloud_documentai_v1beta3_document_schema_proto

var File_google_cloud_documentai_v1beta3_document_schema_proto protoreflect.FileDescriptor

File_google_cloud_documentai_v1beta3_geometry_proto

var File_google_cloud_documentai_v1beta3_geometry_proto protoreflect.FileDescriptor

File_google_cloud_documentai_v1beta3_operation_metadata_proto

var File_google_cloud_documentai_v1beta3_operation_metadata_proto protoreflect.FileDescriptor

File_google_cloud_documentai_v1beta3_processor_proto

var File_google_cloud_documentai_v1beta3_processor_proto protoreflect.FileDescriptor

File_google_cloud_documentai_v1beta3_processor_type_proto

var File_google_cloud_documentai_v1beta3_processor_type_proto protoreflect.FileDescriptor

Functions

func RegisterDocumentProcessorServiceServer

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

Barcode

type Barcode struct {

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

Encodes the detailed information of a barcode.

func (*Barcode) Descriptor

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

Deprecated: Use Barcode.ProtoReflect.Descriptor instead.

func (*Barcode) GetFormat

func (x *Barcode) GetFormat() string

func (*Barcode) GetRawValue

func (x *Barcode) GetRawValue() string

func (*Barcode) GetValueFormat

func (x *Barcode) GetValueFormat() string

func (*Barcode) ProtoMessage

func (*Barcode) ProtoMessage()

func (*Barcode) ProtoReflect

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

func (*Barcode) Reset

func (x *Barcode) Reset()

func (*Barcode) String

func (x *Barcode) String() string

BatchDocumentsInputConfig

type BatchDocumentsInputConfig struct {

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

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

func (*BatchDocumentsInputConfig) Descriptor

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

Deprecated: Use BatchDocumentsInputConfig.ProtoReflect.Descriptor instead.

func (*BatchDocumentsInputConfig) GetGcsDocuments

func (x *BatchDocumentsInputConfig) GetGcsDocuments() *GcsDocuments

func (*BatchDocumentsInputConfig) GetGcsPrefix

func (x *BatchDocumentsInputConfig) GetGcsPrefix() *GcsPrefix

func (*BatchDocumentsInputConfig) GetSource

func (m *BatchDocumentsInputConfig) GetSource() isBatchDocumentsInputConfig_Source

func (*BatchDocumentsInputConfig) ProtoMessage

func (*BatchDocumentsInputConfig) ProtoMessage()

func (*BatchDocumentsInputConfig) ProtoReflect

func (*BatchDocumentsInputConfig) Reset

func (x *BatchDocumentsInputConfig) Reset()

func (*BatchDocumentsInputConfig) String

func (x *BatchDocumentsInputConfig) String() string

BatchDocumentsInputConfig_GcsDocuments

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

BatchDocumentsInputConfig_GcsPrefix

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

BatchProcessMetadata

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

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

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

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

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

}

The long running operation metadata for batch process method.

func (*BatchProcessMetadata) Descriptor

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

Deprecated: Use BatchProcessMetadata.ProtoReflect.Descriptor instead.

func (*BatchProcessMetadata) GetCreateTime

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

func (*BatchProcessMetadata) GetIndividualProcessStatuses

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

func (*BatchProcessMetadata) GetState

func (*BatchProcessMetadata) GetStateMessage

func (x *BatchProcessMetadata) GetStateMessage() string

func (*BatchProcessMetadata) GetUpdateTime

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

func (*BatchProcessMetadata) ProtoMessage

func (*BatchProcessMetadata) ProtoMessage()

func (*BatchProcessMetadata) ProtoReflect

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

func (*BatchProcessMetadata) Reset

func (x *BatchProcessMetadata) Reset()

func (*BatchProcessMetadata) String

func (x *BatchProcessMetadata) String() string

BatchProcessMetadata_IndividualProcessStatus

type BatchProcessMetadata_IndividualProcessStatus struct {

	// The source of the document, same as the [input_gcs_source] 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: Use BatchProcessMetadata_IndividualProcessStatus.ProtoReflect.Descriptor instead.

func (*BatchProcessMetadata_IndividualProcessStatus) GetHumanReviewOperation

func (x *BatchProcessMetadata_IndividualProcessStatus) GetHumanReviewOperation() string

Deprecated: Do not use.

func (*BatchProcessMetadata_IndividualProcessStatus) GetHumanReviewStatus

func (*BatchProcessMetadata_IndividualProcessStatus) GetInputGcsSource

func (*BatchProcessMetadata_IndividualProcessStatus) GetOutputGcsDestination

func (x *BatchProcessMetadata_IndividualProcessStatus) GetOutputGcsDestination() string

func (*BatchProcessMetadata_IndividualProcessStatus) GetStatus

func (*BatchProcessMetadata_IndividualProcessStatus) ProtoMessage

func (*BatchProcessMetadata_IndividualProcessStatus) ProtoReflect

func (*BatchProcessMetadata_IndividualProcessStatus) Reset

func (*BatchProcessMetadata_IndividualProcessStatus) String

BatchProcessMetadata_State

type BatchProcessMetadata_State int32

Possible states of the batch processing operation.

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

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

func (BatchProcessMetadata_State) Descriptor

func (BatchProcessMetadata_State) Enum

func (BatchProcessMetadata_State) EnumDescriptor

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

Deprecated: Use BatchProcessMetadata_State.Descriptor instead.

func (BatchProcessMetadata_State) Number

func (BatchProcessMetadata_State) String

func (BatchProcessMetadata_State) Type

BatchProcessRequest

type BatchProcessRequest struct {

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

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

Deprecated: Use BatchProcessRequest.ProtoReflect.Descriptor instead.

func (*BatchProcessRequest) GetDocumentOutputConfig

func (x *BatchProcessRequest) GetDocumentOutputConfig() *DocumentOutputConfig

func (*BatchProcessRequest) GetInputConfigs

Deprecated: Do not use.

func (*BatchProcessRequest) GetInputDocuments

func (x *BatchProcessRequest) GetInputDocuments() *BatchDocumentsInputConfig

func (*BatchProcessRequest) GetName

func (x *BatchProcessRequest) GetName() string

func (*BatchProcessRequest) GetOutputConfig

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

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

func (x *BatchProcessRequest_BatchInputConfig) GetGcsSource() string

func (*BatchProcessRequest_BatchInputConfig) GetMimeType (deprecated)

func (*BatchProcessRequest_BatchInputConfig) ProtoMessage (deprecated)

func (*BatchProcessRequest_BatchInputConfig) ProtoMessage()

func (*BatchProcessRequest_BatchInputConfig) ProtoReflect (deprecated)

func (*BatchProcessRequest_BatchInputConfig) Reset (deprecated)

func (*BatchProcessRequest_BatchInputConfig) String (deprecated)

BatchProcessRequest_BatchOutputConfig (deprecated)

type BatchProcessRequest_BatchOutputConfig struct {

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

The 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 (deprecated)

func (x *BatchProcessRequest_BatchOutputConfig) GetGcsDestination() string

func (*BatchProcessRequest_BatchOutputConfig) ProtoMessage (deprecated)

func (*BatchProcessRequest_BatchOutputConfig) ProtoMessage()

func (*BatchProcessRequest_BatchOutputConfig) ProtoReflect (deprecated)

func (*BatchProcessRequest_BatchOutputConfig) Reset (deprecated)

func (*BatchProcessRequest_BatchOutputConfig) String (deprecated)

BatchProcessResponse

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

Response message for batch process document method.

func (*BatchProcessResponse) Descriptor

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

Deprecated: Use BatchProcessResponse.ProtoReflect.Descriptor instead.

func (*BatchProcessResponse) ProtoMessage

func (*BatchProcessResponse) ProtoMessage()

func (*BatchProcessResponse) ProtoReflect

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

func (*BatchProcessResponse) Reset

func (x *BatchProcessResponse) Reset()

func (*BatchProcessResponse) String

func (x *BatchProcessResponse) String() string

BoundingPoly

type BoundingPoly struct {

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

A bounding polygon for the detected image annotation.

func (*BoundingPoly) Descriptor

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

Deprecated: Use BoundingPoly.ProtoReflect.Descriptor instead.

func (*BoundingPoly) GetNormalizedVertices

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

func (*BoundingPoly) GetVertices

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

func (*BoundingPoly) ProtoMessage

func (*BoundingPoly) ProtoMessage()

func (*BoundingPoly) ProtoReflect

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

func (*BoundingPoly) Reset

func (x *BoundingPoly) Reset()

func (*BoundingPoly) String

func (x *BoundingPoly) String() string

CommonOperationMetadata

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

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

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

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

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

}

The common metadata for long running operations.

func (*CommonOperationMetadata) Descriptor

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

Deprecated: Use CommonOperationMetadata.ProtoReflect.Descriptor instead.

func (*CommonOperationMetadata) GetCreateTime

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

func (*CommonOperationMetadata) GetResource

func (x *CommonOperationMetadata) GetResource() string

func (*CommonOperationMetadata) GetState

func (*CommonOperationMetadata) GetStateMessage

func (x *CommonOperationMetadata) GetStateMessage() string

func (*CommonOperationMetadata) GetUpdateTime

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

func (*CommonOperationMetadata) ProtoMessage

func (*CommonOperationMetadata) ProtoMessage()

func (*CommonOperationMetadata) ProtoReflect

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

func (*CommonOperationMetadata) Reset

func (x *CommonOperationMetadata) Reset()

func (*CommonOperationMetadata) String

func (x *CommonOperationMetadata) String() string

CommonOperationMetadata_State

type CommonOperationMetadata_State int32

State of the longrunning operation.

CommonOperationMetadata_STATE_UNSPECIFIED, CommonOperationMetadata_RUNNING, CommonOperationMetadata_CANCELLING, CommonOperationMetadata_SUCCEEDED, CommonOperationMetadata_FAILED, CommonOperationMetadata_CANCELLED

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

func (CommonOperationMetadata_State) Descriptor

func (CommonOperationMetadata_State) Enum

func (CommonOperationMetadata_State) EnumDescriptor

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

Deprecated: Use CommonOperationMetadata_State.Descriptor instead.

func (CommonOperationMetadata_State) Number

func (CommonOperationMetadata_State) String

func (CommonOperationMetadata_State) Type

CreateProcessorRequest

type CreateProcessorRequest struct {

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

Request message for create a processor. Notice this request is sent to a regionalized backend service, and if the processor type is not available on that region, the creation will fail.

func (*CreateProcessorRequest) Descriptor

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

Deprecated: Use CreateProcessorRequest.ProtoReflect.Descriptor instead.

func (*CreateProcessorRequest) GetParent

func (x *CreateProcessorRequest) GetParent() 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

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

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

Deprecated: Use DeleteProcessorMetadata.ProtoReflect.Descriptor instead.

func (*DeleteProcessorMetadata) GetCommonMetadata

func (x *DeleteProcessorMetadata) GetCommonMetadata() *CommonOperationMetadata

func (*DeleteProcessorMetadata) ProtoMessage

func (*DeleteProcessorMetadata) ProtoMessage()

func (*DeleteProcessorMetadata) ProtoReflect

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

func (*DeleteProcessorMetadata) Reset

func (x *DeleteProcessorMetadata) Reset()

func (*DeleteProcessorMetadata) String

func (x *DeleteProcessorMetadata) String() string

DeleteProcessorRequest

type DeleteProcessorRequest struct {

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

Request message for the delete processor method.

func (*DeleteProcessorRequest) Descriptor

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

Deprecated: Use DeleteProcessorRequest.ProtoReflect.Descriptor instead.

func (*DeleteProcessorRequest) GetName

func (x *DeleteProcessorRequest) GetName() string

func (*DeleteProcessorRequest) ProtoMessage

func (*DeleteProcessorRequest) ProtoMessage()

func (*DeleteProcessorRequest) ProtoReflect

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

func (*DeleteProcessorRequest) Reset

func (x *DeleteProcessorRequest) Reset()

func (*DeleteProcessorRequest) String

func (x *DeleteProcessorRequest) String() string

DeleteProcessorVersionMetadata

type DeleteProcessorVersionMetadata struct {

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

The long running operation metadata for delete processor version method.

func (*DeleteProcessorVersionMetadata) Descriptor

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

Deprecated: Use DeleteProcessorVersionMetadata.ProtoReflect.Descriptor instead.

func (*DeleteProcessorVersionMetadata) GetCommonMetadata

func (*DeleteProcessorVersionMetadata) ProtoMessage

func (*DeleteProcessorVersionMetadata) ProtoMessage()

func (*DeleteProcessorVersionMetadata) ProtoReflect

func (*DeleteProcessorVersionMetadata) Reset

func (x *DeleteProcessorVersionMetadata) Reset()

func (*DeleteProcessorVersionMetadata) String

DeleteProcessorVersionRequest

type DeleteProcessorVersionRequest struct {

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

Request message for the delete processor version method.

func (*DeleteProcessorVersionRequest) Descriptor

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

Deprecated: Use DeleteProcessorVersionRequest.ProtoReflect.Descriptor instead.

func (*DeleteProcessorVersionRequest) GetName

func (*DeleteProcessorVersionRequest) ProtoMessage

func (*DeleteProcessorVersionRequest) ProtoMessage()

func (*DeleteProcessorVersionRequest) ProtoReflect

func (*DeleteProcessorVersionRequest) Reset

func (x *DeleteProcessorVersionRequest) Reset()

func (*DeleteProcessorVersionRequest) String

DeployProcessorVersionMetadata

type DeployProcessorVersionMetadata struct {

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

The long running operation metadata for deploy processor version method.

func (*DeployProcessorVersionMetadata) Descriptor

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

Deprecated: Use DeployProcessorVersionMetadata.ProtoReflect.Descriptor instead.

func (*DeployProcessorVersionMetadata) GetCommonMetadata

func (*DeployProcessorVersionMetadata) ProtoMessage

func (*DeployProcessorVersionMetadata) ProtoMessage()

func (*DeployProcessorVersionMetadata) ProtoReflect

func (*DeployProcessorVersionMetadata) Reset

func (x *DeployProcessorVersionMetadata) Reset()

func (*DeployProcessorVersionMetadata) String

DeployProcessorVersionRequest

type DeployProcessorVersionRequest struct {

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

Request message for the deploy processor version method.

func (*DeployProcessorVersionRequest) Descriptor

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

Deprecated: Use DeployProcessorVersionRequest.ProtoReflect.Descriptor instead.

func (*DeployProcessorVersionRequest) GetName

func (*DeployProcessorVersionRequest) ProtoMessage

func (*DeployProcessorVersionRequest) ProtoMessage()

func (*DeployProcessorVersionRequest) ProtoReflect

func (*DeployProcessorVersionRequest) Reset

func (x *DeployProcessorVersionRequest) Reset()

func (*DeployProcessorVersionRequest) String

DeployProcessorVersionResponse

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

Response message for the deploy processor version method.

func (*DeployProcessorVersionResponse) Descriptor

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

Deprecated: Use DeployProcessorVersionResponse.ProtoReflect.Descriptor instead.

func (*DeployProcessorVersionResponse) ProtoMessage

func (*DeployProcessorVersionResponse) ProtoMessage()

func (*DeployProcessorVersionResponse) ProtoReflect

func (*DeployProcessorVersionResponse) Reset

func (x *DeployProcessorVersionResponse) Reset()

func (*DeployProcessorVersionResponse) String

DisableProcessorMetadata

type DisableProcessorMetadata struct {

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

The long running operation metadata for disable processor method.

func (*DisableProcessorMetadata) Descriptor

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

Deprecated: Use DisableProcessorMetadata.ProtoReflect.Descriptor instead.

func (*DisableProcessorMetadata) GetCommonMetadata

func (x *DisableProcessorMetadata) GetCommonMetadata() *CommonOperationMetadata

func (*DisableProcessorMetadata) ProtoMessage

func (*DisableProcessorMetadata) ProtoMessage()

func (*DisableProcessorMetadata) ProtoReflect

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

func (*DisableProcessorMetadata) Reset

func (x *DisableProcessorMetadata) Reset()

func (*DisableProcessorMetadata) String

func (x *DisableProcessorMetadata) String() string

DisableProcessorRequest

type DisableProcessorRequest struct {

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

Request message for the disable processor method.

func (*DisableProcessorRequest) Descriptor

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

Deprecated: Use DisableProcessorRequest.ProtoReflect.Descriptor instead.

func (*DisableProcessorRequest) GetName

func (x *DisableProcessorRequest) GetName() string

func (*DisableProcessorRequest) ProtoMessage

func (*DisableProcessorRequest) ProtoMessage()

func (*DisableProcessorRequest) ProtoReflect

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

func (*DisableProcessorRequest) Reset

func (x *DisableProcessorRequest) Reset()

func (*DisableProcessorRequest) String

func (x *DisableProcessorRequest) String() string

DisableProcessorResponse

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

Response message for the disable processor method. Intentionally empty proto for adding fields in future.

func (*DisableProcessorResponse) Descriptor

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

Deprecated: Use DisableProcessorResponse.ProtoReflect.Descriptor instead.

func (*DisableProcessorResponse) ProtoMessage

func (*DisableProcessorResponse) ProtoMessage()

func (*DisableProcessorResponse) ProtoReflect

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

func (*DisableProcessorResponse) Reset

func (x *DisableProcessorResponse) Reset()

func (*DisableProcessorResponse) String

func (x *DisableProcessorResponse) String() string

Document

type Document struct {

	// Original source document from the user.
	//
	// Types that are assignable to Source:
	//
	//	*Document_Uri
	//	*Document_Content
	Source isDocument_Source `protobuf_oneof:"source"`
	// An IANA published 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].  This is
	// usually used for annotating corrections to OCR mistakes.  Text changes for
	// a given revision may not overlap with each other.
	TextChanges []*Document_TextChange `protobuf:"bytes,14,rep,name=text_changes,json=textChanges,proto3" json:"text_changes,omitempty"`
	// Information about the sharding if this document is sharded part of a larger
	// document. If the document is not sharded, this message is not specified.
	ShardInfo *Document_ShardInfo `protobuf:"bytes,9,opt,name=shard_info,json=shardInfo,proto3" json:"shard_info,omitempty"`
	// Any error that occurred while processing this document.
	Error *status.Status `protobuf:"bytes,10,opt,name=error,proto3" json:"error,omitempty"`
	// Placeholder. Revision history of this document.
	Revisions []*Document_Revision `protobuf:"bytes,13,rep,name=revisions,proto3" json:"revisions,omitempty"`
	// contains filtered or unexported fields
}

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

func (*Document) Descriptor

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

Deprecated: Use Document.ProtoReflect.Descriptor instead.

func (*Document) GetContent

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

func (*Document) GetEntities

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

func (*Document) GetEntityRelations

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

func (*Document) GetError

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

func (*Document) GetMimeType

func (x *Document) GetMimeType() string

func (*Document) GetPages

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

func (*Document) GetRevisions

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

func (*Document) GetShardInfo

func (x *Document) GetShardInfo() *Document_ShardInfo

func (*Document) GetSource

func (m *Document) GetSource() isDocument_Source

func (*Document) GetText

func (x *Document) GetText() string

func (*Document) GetTextChanges

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

func (*Document) GetTextStyles

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

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

DocumentOutputConfig

type DocumentOutputConfig struct {

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

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

func (*DocumentOutputConfig) Descriptor

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

Deprecated: Use DocumentOutputConfig.ProtoReflect.Descriptor instead.

func (*DocumentOutputConfig) GetDestination

func (m *DocumentOutputConfig) GetDestination() isDocumentOutputConfig_Destination

func (*DocumentOutputConfig) GetGcsOutputConfig

func (*DocumentOutputConfig) ProtoMessage

func (*DocumentOutputConfig) ProtoMessage()

func (*DocumentOutputConfig) ProtoReflect

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

func (*DocumentOutputConfig) Reset

func (x *DocumentOutputConfig) Reset()

func (*DocumentOutputConfig) String

func (x *DocumentOutputConfig) String() string

DocumentOutputConfig_GcsOutputConfig

type DocumentOutputConfig_GcsOutputConfig struct {

	// The Cloud Storage uri (a directory) of the output.
	GcsUri string `protobuf:"bytes,1,opt,name=gcs_uri,json=gcsUri,proto3" json:"gcs_uri,omitempty"`
	// contains filtered or unexported fields
}

The configuration used when outputting documents.

func (*DocumentOutputConfig_GcsOutputConfig) Descriptor

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

Deprecated: Use DocumentOutputConfig_GcsOutputConfig.ProtoReflect.Descriptor instead.

func (*DocumentOutputConfig_GcsOutputConfig) GetGcsUri

func (*DocumentOutputConfig_GcsOutputConfig) ProtoMessage

func (*DocumentOutputConfig_GcsOutputConfig) ProtoMessage()

func (*DocumentOutputConfig_GcsOutputConfig) ProtoReflect

func (*DocumentOutputConfig_GcsOutputConfig) Reset

func (*DocumentOutputConfig_GcsOutputConfig) String

DocumentOutputConfig_GcsOutputConfig_

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

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)
	// 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)
}

DocumentProcessorServiceClient is the client API for DocumentProcessorService service.

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

func NewDocumentProcessorServiceClient

func NewDocumentProcessorServiceClient(cc grpc.ClientConnInterface) DocumentProcessorServiceClient

DocumentProcessorServiceServer

type DocumentProcessorServiceServer interface {
	// Processes a single document.
	ProcessDocument(context.Context, *ProcessRequest) (*ProcessResponse, error)
	// LRO endpoint to batch process many documents. The output is written
	// to Cloud Storage as JSON in the [Document] format.
	BatchProcessDocuments(context.Context, *BatchProcessRequest) (*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)
	// 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)
}

DocumentProcessorServiceServer is the server API for DocumentProcessorService service.

DocumentSchema

type DocumentSchema struct {

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

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

func (*DocumentSchema) Descriptor

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

Deprecated: Use DocumentSchema.ProtoReflect.Descriptor instead.

func (*DocumentSchema) GetDescription

func (x *DocumentSchema) GetDescription() string

func (*DocumentSchema) GetDisplayName

func (x *DocumentSchema) GetDisplayName() string

func (*DocumentSchema) GetEntityTypes

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

func (*DocumentSchema) GetMetadata

func (x *DocumentSchema) GetMetadata() *DocumentSchema_Metadata

func (*DocumentSchema) ProtoMessage

func (*DocumentSchema) ProtoMessage()

func (*DocumentSchema) ProtoReflect

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

func (*DocumentSchema) Reset

func (x *DocumentSchema) Reset()

func (*DocumentSchema) String

func (x *DocumentSchema) String() string

DocumentSchema_EntityType

type DocumentSchema_EntityType struct {

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

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 (*DocumentSchema_EntityType) GetName

func (x *DocumentSchema_EntityType) GetName() string

func (*DocumentSchema_EntityType) GetProperties

func (*DocumentSchema_EntityType) GetValueSource

func (m *DocumentSchema_EntityType) GetValueSource() isDocumentSchema_EntityType_ValueSource

func (*DocumentSchema_EntityType) ProtoMessage

func (*DocumentSchema_EntityType) ProtoMessage()

func (*DocumentSchema_EntityType) ProtoReflect

func (*DocumentSchema_EntityType) Reset

func (x *DocumentSchema_EntityType) Reset()

func (*DocumentSchema_EntityType) String

func (x *DocumentSchema_EntityType) String() string

DocumentSchema_EntityType_EnumValues

type DocumentSchema_EntityType_EnumValues struct {

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

Defines the a list of enum values.

func (*DocumentSchema_EntityType_EnumValues) Descriptor

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

Deprecated: Use DocumentSchema_EntityType_EnumValues.ProtoReflect.Descriptor instead.

func (*DocumentSchema_EntityType_EnumValues) GetValues

func (*DocumentSchema_EntityType_EnumValues) ProtoMessage

func (*DocumentSchema_EntityType_EnumValues) ProtoMessage()

func (*DocumentSchema_EntityType_EnumValues) ProtoReflect

func (*DocumentSchema_EntityType_EnumValues) Reset

func (*DocumentSchema_EntityType_EnumValues) String

DocumentSchema_EntityType_EnumValues_

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

DocumentSchema_EntityType_Property

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

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

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

}

Defines properties that can be part of the entity type.

func (*DocumentSchema_EntityType_Property) Descriptor

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

Deprecated: Use DocumentSchema_EntityType_Property.ProtoReflect.Descriptor instead.

func (*DocumentSchema_EntityType_Property) GetName

func (*DocumentSchema_EntityType_Property) GetOccurrenceType

func (*DocumentSchema_EntityType_Property) GetValueType

func (x *DocumentSchema_EntityType_Property) GetValueType() string

func (*DocumentSchema_EntityType_Property) ProtoMessage

func (*DocumentSchema_EntityType_Property) ProtoMessage()

func (*DocumentSchema_EntityType_Property) ProtoReflect

func (*DocumentSchema_EntityType_Property) Reset

func (*DocumentSchema_EntityType_Property) String

DocumentSchema_EntityType_Property_OccurrenceType

type DocumentSchema_EntityType_Property_OccurrenceType int32

Types of occurrences of the entity type in the document. Note: this represents the number of instances of an entity types, not number of mentions of a given entity instance.

DocumentSchema_EntityType_Property_OCCURRENCE_TYPE_UNSPECIFIED, DocumentSchema_EntityType_Property_OPTIONAL_ONCE, DocumentSchema_EntityType_Property_OPTIONAL_MULTIPLE, DocumentSchema_EntityType_Property_REQUIRED_ONCE, DocumentSchema_EntityType_Property_REQUIRED_MULTIPLE

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

func (DocumentSchema_EntityType_Property_OccurrenceType) Descriptor

func (DocumentSchema_EntityType_Property_OccurrenceType) Enum

func (DocumentSchema_EntityType_Property_OccurrenceType) EnumDescriptor

Deprecated: Use DocumentSchema_EntityType_Property_OccurrenceType.Descriptor instead.

func (DocumentSchema_EntityType_Property_OccurrenceType) Number

func (DocumentSchema_EntityType_Property_OccurrenceType) String

func (DocumentSchema_EntityType_Property_OccurrenceType) Type

DocumentSchema_Metadata

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

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

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

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

}

Metadata for global schema behavior.

func (*DocumentSchema_Metadata) Descriptor

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

Deprecated: Use DocumentSchema_Metadata.ProtoReflect.Descriptor instead.

func (*DocumentSchema_Metadata) GetDocumentAllowMultipleLabels

func (x *DocumentSchema_Metadata) GetDocumentAllowMultipleLabels() bool

func (*DocumentSchema_Metadata) GetDocumentSplitter

func (x *DocumentSchema_Metadata) GetDocumentSplitter() bool

func (*DocumentSchema_Metadata) GetPrefixedNamingOnProperties

func (x *DocumentSchema_Metadata) GetPrefixedNamingOnProperties() bool

func (*DocumentSchema_Metadata) GetSkipNamingValidation

func (x *DocumentSchema_Metadata) GetSkipNamingValidation() bool

func (*DocumentSchema_Metadata) ProtoMessage

func (*DocumentSchema_Metadata) ProtoMessage()

func (*DocumentSchema_Metadata) ProtoReflect

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

func (*DocumentSchema_Metadata) Reset

func (x *DocumentSchema_Metadata) Reset()

func (*DocumentSchema_Metadata) String

func (x *DocumentSchema_Metadata) String() string

Document_Content

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

Document_Entity

type Document_Entity struct {

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

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

func (*Document_Entity) Descriptor

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

Deprecated: Use Document_Entity.ProtoReflect.Descriptor instead.

func (*Document_Entity) GetConfidence

func (x *Document_Entity) GetConfidence() float32

func (*Document_Entity) GetId

func (x *Document_Entity) GetId() string

func (*Document_Entity) GetMentionId

func (x *Document_Entity) GetMentionId() string

func (*Document_Entity) GetMentionText

func (x *Document_Entity) GetMentionText() string

func (*Document_Entity) GetNormalizedValue

func (x *Document_Entity) GetNormalizedValue() *Document_Entity_NormalizedValue

func (*Document_Entity) GetPageAnchor

func (x *Document_Entity) GetPageAnchor() *Document_PageAnchor

func (*Document_Entity) GetProperties

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

func (*Document_Entity) GetProvenance

func (x *Document_Entity) GetProvenance() *Document_Provenance

func (*Document_Entity) GetRedacted

func (x *Document_Entity) GetRedacted() bool

func (*Document_Entity) GetTextAnchor

func (x *Document_Entity) GetTextAnchor() *Document_TextAnchor

func (*Document_Entity) GetType

func (x *Document_Entity) GetType() string

func (*Document_Entity) ProtoMessage

func (*Document_Entity) ProtoMessage()

func (*Document_Entity) ProtoReflect

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

func (*Document_Entity) Reset

func (x *Document_Entity) Reset()

func (*Document_Entity) String

func (x *Document_Entity) String() string

Document_EntityRelation

type Document_EntityRelation struct {

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

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

func (*Document_EntityRelation) Descriptor

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

Deprecated: Use Document_EntityRelation.ProtoReflect.Descriptor instead.

func (*Document_EntityRelation) GetObjectId

func (x *Document_EntityRelation) GetObjectId() string

func (*Document_EntityRelation) GetRelation

func (x *Document_EntityRelation) GetRelation() string

func (*Document_EntityRelation) GetSubjectId

func (x *Document_EntityRelation) GetSubjectId() string

func (*Document_EntityRelation) ProtoMessage

func (*Document_EntityRelation) ProtoMessage()

func (*Document_EntityRelation) ProtoReflect

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

func (*Document_EntityRelation) Reset

func (x *Document_EntityRelation) Reset()

func (*Document_EntityRelation) String

func (x *Document_EntityRelation) String() string

Document_Entity_NormalizedValue

type Document_Entity_NormalizedValue struct {

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

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

Deprecated: Use Document_Entity_NormalizedValue.ProtoReflect.Descriptor instead.

func (*Document_Entity_NormalizedValue) GetAddressValue