Package cloud.google.com/go/documentai/apiv1/documentaipb (v1.35.1)

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

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

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

var (
	Document_Provenance_OperationType_name = map[int32]string{
		0: "OPERATION_TYPE_UNSPECIFIED",
		1: "ADD",
		2: "REMOVE",
		7: "UPDATE",
		3: "REPLACE",
		4: "EVAL_REQUESTED",
		5: "EVAL_APPROVED",
		6: "EVAL_SKIPPED",
	}
	Document_Provenance_OperationType_value = map[string]int32{
		"OPERATION_TYPE_UNSPECIFIED": 0,
		"ADD":                        1,
		"REMOVE":                     2,
		"UPDATE":                     7,
		"REPLACE":                    3,
		"EVAL_REQUESTED":             4,
		"EVAL_APPROVED":              5,
		"EVAL_SKIPPED":               6,
	}
)

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

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

var (
	TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TrainingMethod_name = map[int32]string{
		0: "TRAINING_METHOD_UNSPECIFIED",
		1: "MODEL_BASED",
		2: "TEMPLATE_BASED",
	}
	TrainProcessorVersionRequest_CustomDocumentExtractionOptions_TrainingMethod_value = map[string]int32{
		"TRAINING_METHOD_UNSPECIFIED": 0,
		"MODEL_BASED":                 1,
		"TEMPLATE_BASED":              2,
	}
)

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

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

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

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

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

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

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

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

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

var File_google_cloud_documentai_v1_barcode_proto protoreflect.FileDescriptor

var File_google_cloud_documentai_v1_document_io_proto protoreflect.FileDescriptor

var File_google_cloud_documentai_v1_document_processor_service_proto protoreflect.FileDescriptor

var File_google_cloud_documentai_v1_document_proto protoreflect.FileDescriptor

var File_google_cloud_documentai_v1_document_schema_proto protoreflect.FileDescriptor

var File_google_cloud_documentai_v1_evaluation_proto protoreflect.FileDescriptor

var File_google_cloud_documentai_v1_geometry_proto protoreflect.FileDescriptor

var File_google_cloud_documentai_v1_operation_metadata_proto protoreflect.FileDescriptor

var File_google_cloud_documentai_v1_processor_proto protoreflect.FileDescriptor

var File_google_cloud_documentai_v1_processor_type_proto protoreflect.FileDescriptor

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

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
}

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

func (x *Barcode) GetFormat() string

func (x *Barcode) GetRawValue() string

func (x *Barcode) GetValueFormat() string

func (*Barcode) ProtoMessage()

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

func (x *Barcode) Reset()

func (x *Barcode) String() string

type BatchDocumentsInputConfig struct {

	// The source. Make sure that the caller of the API has storage.objects.get
	// access to the buckets.
	//
	// Types that are assignable to Source:
	//
	//	*BatchDocumentsInputConfig_GcsPrefix
	//	*BatchDocumentsInputConfig_GcsDocuments
	Source isBatchDocumentsInputConfig_Source `protobuf_oneof:"source"`
	// contains filtered or unexported fields
}

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

func (x *BatchDocumentsInputConfig) GetGcsDocuments() *GcsDocuments

func (x *BatchDocumentsInputConfig) GetGcsPrefix() *GcsPrefix

func (m *BatchDocumentsInputConfig) GetSource() isBatchDocumentsInputConfig_Source

func (*BatchDocumentsInputConfig) ProtoMessage()

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

func (x *BatchDocumentsInputConfig) Reset()

func (x *BatchDocumentsInputConfig) String() string

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 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 struct {
	State BatchProcessMetadata_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.cloud.documentai.v1.BatchProcessMetadata_State" json:"state,omitempty"`

	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 */

}

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

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

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

func (x *BatchProcessMetadata) GetState() BatchProcessMetadata_State

func (x *BatchProcessMetadata) GetStateMessage() string

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

func (*BatchProcessMetadata) ProtoMessage()

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

func (x *BatchProcessMetadata) Reset()

func (x *BatchProcessMetadata) String() string

type BatchProcessMetadata_IndividualProcessStatus struct {

	// The source of the document, same as the
	// [input_gcs_source][google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus.input_gcs_source]
	// field in the request when the batch process started.
	InputGcsSource string `protobuf:"bytes,1,opt,name=input_gcs_source,json=inputGcsSource,proto3" json:"input_gcs_source,omitempty"`
	// The status processing the document.
	Status *status.Status `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// The Cloud Storage output destination (in the request as
	// [DocumentOutputConfig.GcsOutputConfig.gcs_uri][google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.gcs_uri])
	// of the processed document if it was successful, otherwise empty.
	OutputGcsDestination string `protobuf:"bytes,3,opt,name=output_gcs_destination,json=outputGcsDestination,proto3" json:"output_gcs_destination,omitempty"`
	// The 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
}

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

func (x *BatchProcessMetadata_IndividualProcessStatus) GetHumanReviewStatus() *HumanReviewStatus

func (x *BatchProcessMetadata_IndividualProcessStatus) GetInputGcsSource() string

func (x *BatchProcessMetadata_IndividualProcessStatus) GetOutputGcsDestination() string

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

func (*BatchProcessMetadata_IndividualProcessStatus) ProtoMessage()

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

func (x *BatchProcessMetadata_IndividualProcessStatus) Reset()

func (x *BatchProcessMetadata_IndividualProcessStatus) String() string

type BatchProcessMetadata_State int32

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

func (x BatchProcessMetadata_State) Enum() *BatchProcessMetadata_State

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

func (x BatchProcessMetadata_State) Number() protoreflect.EnumNumber

func (x BatchProcessMetadata_State) String() string

func (BatchProcessMetadata_State) Type() protoreflect.EnumType

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

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

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

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

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

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

}

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

func (x *BatchProcessRequest) GetDocumentOutputConfig() *DocumentOutputConfig

func (x *BatchProcessRequest) GetInputDocuments() *BatchDocumentsInputConfig

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

func (x *BatchProcessRequest) GetName() string

func (x *BatchProcessRequest) GetProcessOptions() *ProcessOptions

func (x *BatchProcessRequest) GetSkipHumanReview() bool

func (*BatchProcessRequest) ProtoMessage()

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

func (x *BatchProcessRequest) Reset()

func (x *BatchProcessRequest) String() string

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

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

func (*BatchProcessResponse) ProtoMessage()

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

func (x *BatchProcessResponse) Reset()

func (x *BatchProcessResponse) String() string

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
}

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

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

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

func (*BoundingPoly) ProtoMessage()

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

func (x *BoundingPoly) Reset()

func (x *BoundingPoly) String() string

type CommonOperationMetadata struct {

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

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

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

func (x *CommonOperationMetadata) GetResource() string

func (x *CommonOperationMetadata) GetState() CommonOperationMetadata_State

func (x *CommonOperationMetadata) GetStateMessage() string

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

func (*CommonOperationMetadata) ProtoMessage()

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

func (x *CommonOperationMetadata) Reset()

func (x *CommonOperationMetadata) String() string

type CommonOperationMetadata_State int32

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

func (x CommonOperationMetadata_State) Enum() *CommonOperationMetadata_State

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

func (x CommonOperationMetadata_State) Number() protoreflect.EnumNumber

func (x CommonOperationMetadata_State) String() string

func (CommonOperationMetadata_State) Type() protoreflect.EnumType

type CreateProcessorRequest struct {

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

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

func (x *CreateProcessorRequest) GetParent() string

func (x *CreateProcessorRequest) GetProcessor() *Processor

func (*CreateProcessorRequest) ProtoMessage()

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

func (x *CreateProcessorRequest) Reset()

func (x *CreateProcessorRequest) String() string

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
}

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

func (x *DeleteProcessorMetadata) GetCommonMetadata() *CommonOperationMetadata

func (*DeleteProcessorMetadata) ProtoMessage()

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

func (x *DeleteProcessorMetadata) Reset()

func (x *DeleteProcessorMetadata) String() string

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
}

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

func (x *DeleteProcessorRequest) GetName() string

func (*DeleteProcessorRequest) ProtoMessage()

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

func (x *DeleteProcessorRequest) Reset()

func (x *DeleteProcessorRequest) String() string

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
}

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

func (x *DeleteProcessorVersionMetadata) GetCommonMetadata() *CommonOperationMetadata

func (*DeleteProcessorVersionMetadata) ProtoMessage()

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

func (x *DeleteProcessorVersionMetadata) Reset()

func (x *DeleteProcessorVersionMetadata) String() string

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
}

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

func (x *DeleteProcessorVersionRequest) GetName() string

func (*DeleteProcessorVersionRequest) ProtoMessage()

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

func (x *DeleteProcessorVersionRequest) Reset()

func (x *DeleteProcessorVersionRequest) String() string

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
}

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

func (x *DeployProcessorVersionMetadata) GetCommonMetadata() *CommonOperationMetadata

func (*DeployProcessorVersionMetadata) ProtoMessage()

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

func (x *DeployProcessorVersionMetadata) Reset()

func (x *DeployProcessorVersionMetadata) String() string

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
}

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

func (x *DeployProcessorVersionRequest) GetName() string

func (*DeployProcessorVersionRequest) ProtoMessage()

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

func (x *DeployProcessorVersionRequest) Reset()

func (x *DeployProcessorVersionRequest) String() string

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

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

func (*DeployProcessorVersionResponse) ProtoMessage()

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

func (x *DeployProcessorVersionResponse) Reset()

func (x *DeployProcessorVersionResponse) String() string

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
}

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

func (x *DisableProcessorMetadata) GetCommonMetadata() *CommonOperationMetadata

func (*DisableProcessorMetadata) ProtoMessage()

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

func (x *DisableProcessorMetadata) Reset()

func (x *DisableProcessorMetadata) String() string

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
}

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

func (x *DisableProcessorRequest) GetName() string

func (*DisableProcessorRequest) ProtoMessage()

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

func (x *DisableProcessorRequest) Reset()

func (x *DisableProcessorRequest) String() string

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

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

func (*DisableProcessorResponse) ProtoMessage()

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

func (x *DisableProcessorResponse) Reset()

func (x *DisableProcessorResponse) String() string

type Document struct {

	// Original source document from the user.
	//
	// Types that are assignable to Source:
	//
	//	*Document_Uri
	//	*Document_Content
	Source isDocument_Source `protobuf_oneof:"source"`
	// An IANA published [media type (MIME
	// type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
	MimeType string `protobuf:"bytes,3,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// Optional. UTF-8 encoded text in reading order from the document.
	Text string `protobuf:"bytes,4,opt,name=text,proto3" json:"text,omitempty"`
	// Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
	//
	// Deprecated: Marked as deprecated in google/cloud/documentai/v1/document.proto.
	TextStyles []*Document_Style `protobuf:"bytes,5,rep,name=text_styles,json=textStyles,proto3" json:"text_styles,omitempty"`
	// Visual page layout for the [Document][google.cloud.documentai.v1.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.v1.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.v1.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.v1.Document.text].  This is usually
	// used for annotating corrections to OCR mistakes.  Text changes for a given
	// revision may not overlap with each other.
	TextChanges []*Document_TextChange `protobuf:"bytes,14,rep,name=text_changes,json=textChanges,proto3" json:"text_changes,omitempty"`
	// Information about the sharding if this document is sharded part of a larger
	// document. If the document is not sharded, this message is not specified.
	ShardInfo *Document_ShardInfo `protobuf:"bytes,9,opt,name=shard_info,json=shardInfo,proto3" json:"shard_info,omitempty"`
	// Any error that occurred while processing this document.
	Error *status.Status `protobuf:"bytes,10,opt,name=error,proto3" json:"error,omitempty"`
	// Placeholder. Revision history of this document.
	Revisions []*Document_Revision `protobuf:"bytes,13,rep,name=revisions,proto3" json:"revisions,omitempty"`
	// Parsed layout of the document.
	DocumentLayout *Document_DocumentLayout `protobuf:"bytes,17,opt,name=document_layout,json=documentLayout,proto3" json:"document_layout,omitempty"`
	// Document chunked based on chunking config.
	ChunkedDocument *Document_ChunkedDocument `protobuf:"bytes,18,opt,name=chunked_document,json=chunkedDocument,proto3" json:"chunked_document,omitempty"`
	// contains filtered or unexported fields
}

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

func (x *Document) GetChunkedDocument() *Document_ChunkedDocument

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

func (x *Document) GetDocumentLayout() *Document_DocumentLayout

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

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

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

func (x *Document) GetMimeType() string

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

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

func (x *Document) GetShardInfo() *Document_ShardInfo

func (m *Document) GetSource() isDocument_Source

func (x *Document) GetText() string

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

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

func (x *Document) GetUri() string

func (*Document) ProtoMessage()

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

func (x *Document) Reset()

func (x *Document) String() string

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
}

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

func (m *DocumentOutputConfig) GetDestination() isDocumentOutputConfig_Destination

func (x *DocumentOutputConfig) GetGcsOutputConfig() *DocumentOutputConfig_GcsOutputConfig

func (*DocumentOutputConfig) ProtoMessage()

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

func (x *DocumentOutputConfig) Reset()

func (x *DocumentOutputConfig) String() string

type DocumentOutputConfig_GcsOutputConfig struct {

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

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

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

func (x *DocumentOutputConfig_GcsOutputConfig) GetGcsUri() string

func (x *DocumentOutputConfig_GcsOutputConfig) GetShardingConfig() *DocumentOutputConfig_GcsOutputConfig_ShardingConfig

func (*DocumentOutputConfig_GcsOutputConfig) ProtoMessage()

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

func (x *DocumentOutputConfig_GcsOutputConfig) Reset()

func (x *DocumentOutputConfig_GcsOutputConfig) String() string

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 DocumentOutputConfig_GcsOutputConfig_ShardingConfig struct {

	// The number of pages per shard.
	PagesPerShard int32 `protobuf:"varint,1,opt,name=pages_per_shard,json=pagesPerShard,proto3" json:"pages_per_shard,omitempty"`
	// The number of overlapping pages between consecutive shards.
	PagesOverlap int32 `protobuf:"varint,2,opt,name=pages_overlap,json=pagesOverlap,proto3" json:"pages_overlap,omitempty"`
	// contains filtered or unexported fields
}

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

func (x *DocumentOutputConfig_GcsOutputConfig_ShardingConfig) GetPagesOverlap() int32

func (x *DocumentOutputConfig_GcsOutputConfig_ShardingConfig) GetPagesPerShard() int32

func (*DocumentOutputConfig_GcsOutputConfig_ShardingConfig) ProtoMessage()

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

func (x *DocumentOutputConfig_GcsOutputConfig_ShardingConfig) Reset()

func (x *DocumentOutputConfig_GcsOutputConfig_ShardingConfig) String() string

type DocumentProcessorServiceClient interface {
	// Processes a single document.
	ProcessDocument(ctx context.Context, in *ProcessRequest, opts ...grpc.CallOption) (*ProcessResponse, error)
	// LRO endpoint to batch process many documents. The output is written
	// to Cloud Storage as JSON in the [Document] format.
	BatchProcessDocuments(ctx context.Context, in *BatchProcessRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Fetches processor types. Note that we don't use
	// [ListProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.ListProcessorTypes]
	// here, because it isn't paginated.
	FetchProcessorTypes(ctx context.Context, in *FetchProcessorTypesRequest, opts ...grpc.CallOption) (*FetchProcessorTypesResponse, error)
	// Lists the processor types that exist.
	ListProcessorTypes(ctx context.Context, in *ListProcessorTypesRequest, opts ...grpc.CallOption) (*ListProcessorTypesResponse, error)
	// Gets a processor type detail.
	GetProcessorType(ctx context.Context, in *GetProcessorTypeRequest, opts ...grpc.CallOption) (*ProcessorType, error)
	// Lists all processors which belong to this project.
	ListProcessors(ctx context.Context, in *ListProcessorsRequest, opts ...grpc.CallOption) (*ListProcessorsResponse, error)
	// Gets a processor detail.
	GetProcessor(ctx context.Context, in *GetProcessorRequest, opts ...grpc.CallOption) (*Processor, error)
	// Trains a new processor version.
	// Operation metadata is returned as
	// [TrainProcessorVersionMetadata][google.cloud.documentai.v1.TrainProcessorVersionMetadata].
	TrainProcessorVersion(ctx context.Context, in *TrainProcessorVersionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets a processor version detail.
	GetProcessorVersion(ctx context.Context, in *GetProcessorVersionRequest, opts ...grpc.CallOption) (*ProcessorVersion, error)
	// Lists all versions of a processor.
	ListProcessorVersions(ctx context.Context, in *ListProcessorVersionsRequest, opts ...grpc.CallOption) (*ListProcessorVersionsResponse, error)
	// Deletes the processor version, all artifacts under the processor version
	// will be deleted.
	DeleteProcessorVersion(ctx context.Context, in *DeleteProcessorVersionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deploys the processor version.
	DeployProcessorVersion(ctx context.Context, in *DeployProcessorVersionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Undeploys the processor version.
	UndeployProcessorVersion(ctx context.Context, in *UndeployProcessorVersionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Creates a processor from the
	// [ProcessorType][google.cloud.documentai.v1.ProcessorType] provided. The
	// processor will be at `ENABLED` state by default after its creation. Note
	// that this method requires the `documentai.processors.create` permission on
	// the project, which is highly privileged. A user or service account with
	// this permission can create new processors that can interact with any gcs
	// bucket in your project.
	CreateProcessor(ctx context.Context, in *CreateProcessorRequest, opts ...grpc.CallOption) (*Processor, error)
	// Deletes the processor, unloads all deployed model artifacts if it was
	// enabled and then deletes all artifacts associated with this processor.
	DeleteProcessor(ctx context.Context, in *DeleteProcessorRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Enables a processor
	EnableProcessor(ctx context.Context, in *EnableProcessorRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Disables a processor
	DisableProcessor(ctx context.Context, in *DisableProcessorRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Set the default (active) version of a
	// [Processor][google.cloud.documentai.v1.Processor] that will be used in
	// [ProcessDocument][google.cloud.documentai.v1.DocumentProcessorService.ProcessDocument]
	// and
	// [BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments].
	SetDefaultProcessorVersion(ctx context.Context, in *SetDefaultProcessorVersionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Send a document for Human Review. The input document should be processed by
	// the specified processor.
	ReviewDocument(ctx context.Context, in *ReviewDocumentRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Evaluates a ProcessorVersion against annotated documents, producing an
	// Evaluation.
	EvaluateProcessorVersion(ctx context.Context, in *EvaluateProcessorVersionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Retrieves a specific evaluation.
	GetEvaluation(ctx context.Context, in *GetEvaluationRequest, opts ...grpc.CallOption) (*Evaluation, error)
	// Retrieves a set of evaluations for a given processor version.
	ListEvaluations(ctx context.Context, in *ListEvaluationsRequest, opts ...grpc.CallOption) (*ListEvaluationsResponse, error)
}