documentai

package
v0.0.0-...-8c6c420 Latest Latest
Warning

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

Go to latest
Published: Apr 15, 2024 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

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

Enum value maps for Document_Page_Layout_Orientation.

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

Enum value maps for Document_Page_Token_DetectedBreak_Type.

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

Enum value maps for Document_PageAnchor_PageRef_LayoutType.

View Source
var (
	OperationMetadata_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "ACCEPTED",
		2: "WAITING",
		3: "RUNNING",
		4: "SUCCEEDED",
		5: "CANCELLED",
		6: "FAILED",
	}
	OperationMetadata_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"ACCEPTED":          1,
		"WAITING":           2,
		"RUNNING":           3,
		"SUCCEEDED":         4,
		"CANCELLED":         5,
		"FAILED":            6,
	}
)

Enum value maps for OperationMetadata_State.

View Source
var File_google_cloud_documentai_v1beta2_document_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_documentai_v1beta2_document_understanding_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_documentai_v1beta2_geometry_proto protoreflect.FileDescriptor

Functions

func RegisterDocumentUnderstandingServiceServer

func RegisterDocumentUnderstandingServiceServer(s *grpc.Server, srv DocumentUnderstandingServiceServer)

Types

type AutoMlParams

type AutoMlParams struct {

	// Resource name of the AutoML model.
	//
	// Format: `projects/{project-id}/locations/{location-id}/models/{model-id}`.
	Model string `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
	// contains filtered or unexported fields
}

Parameters to control AutoML model prediction behavior.

func (*AutoMlParams) Descriptor deprecated

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

Deprecated: Use AutoMlParams.ProtoReflect.Descriptor instead.

func (*AutoMlParams) GetModel

func (x *AutoMlParams) GetModel() string

func (*AutoMlParams) ProtoMessage

func (*AutoMlParams) ProtoMessage()

func (*AutoMlParams) ProtoReflect

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

func (*AutoMlParams) Reset

func (x *AutoMlParams) Reset()

func (*AutoMlParams) String

func (x *AutoMlParams) String() string

type BatchProcessDocumentsRequest

type BatchProcessDocumentsRequest struct {

	// Required. Individual requests for each document.
	Requests []*ProcessDocumentRequest `protobuf:"bytes,1,rep,name=requests,proto3" json:"requests,omitempty"`
	// Target project and location to make a call.
	//
	// Format: `projects/{project-id}/locations/{location-id}`.
	//
	// If no location is specified, a region will be chosen automatically.
	Parent string `protobuf:"bytes,2,opt,name=parent,proto3" json:"parent,omitempty"`
	// contains filtered or unexported fields
}

Request to batch process documents as an asynchronous operation. The output is written to Cloud Storage as JSON in the Document format.

func (*BatchProcessDocumentsRequest) Descriptor deprecated

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

Deprecated: Use BatchProcessDocumentsRequest.ProtoReflect.Descriptor instead.

func (*BatchProcessDocumentsRequest) GetParent

func (x *BatchProcessDocumentsRequest) GetParent() string

func (*BatchProcessDocumentsRequest) GetRequests

func (*BatchProcessDocumentsRequest) ProtoMessage

func (*BatchProcessDocumentsRequest) ProtoMessage()

func (*BatchProcessDocumentsRequest) ProtoReflect

func (*BatchProcessDocumentsRequest) Reset

func (x *BatchProcessDocumentsRequest) Reset()

func (*BatchProcessDocumentsRequest) String

type BatchProcessDocumentsResponse

type BatchProcessDocumentsResponse struct {

	// Responses for each individual document.
	Responses []*ProcessDocumentResponse `protobuf:"bytes,1,rep,name=responses,proto3" json:"responses,omitempty"`
	// contains filtered or unexported fields
}

Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.

func (*BatchProcessDocumentsResponse) Descriptor deprecated

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

Deprecated: Use BatchProcessDocumentsResponse.ProtoReflect.Descriptor instead.

func (*BatchProcessDocumentsResponse) GetResponses

func (*BatchProcessDocumentsResponse) ProtoMessage

func (*BatchProcessDocumentsResponse) ProtoMessage()

func (*BatchProcessDocumentsResponse) ProtoReflect

func (*BatchProcessDocumentsResponse) Reset

func (x *BatchProcessDocumentsResponse) Reset()

func (*BatchProcessDocumentsResponse) String

type BoundingPoly

type BoundingPoly struct {

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

A bounding polygon for the detected image annotation.

func (*BoundingPoly) Descriptor deprecated

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

Deprecated: Use BoundingPoly.ProtoReflect.Descriptor instead.

func (*BoundingPoly) GetNormalizedVertices

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

func (*BoundingPoly) GetVertices

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

func (*BoundingPoly) ProtoMessage

func (*BoundingPoly) ProtoMessage()

func (*BoundingPoly) ProtoReflect

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

func (*BoundingPoly) Reset

func (x *BoundingPoly) Reset()

func (*BoundingPoly) String

func (x *BoundingPoly) String() string

type 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"`
	// 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.v1beta2.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.v1beta2.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.v1beta2.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"`
	// Relationship among [Document.entities][google.cloud.documentai.v1beta2.Document.entities].
	EntityRelations []*Document_EntityRelation `protobuf:"bytes,8,rep,name=entity_relations,json=entityRelations,proto3" json:"entity_relations,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"`
	// [Label][google.cloud.documentai.v1beta2.Document.Label]s for this document.
	Labels []*Document_Label `protobuf:"bytes,11,rep,name=labels,proto3" json:"labels,omitempty"`
	// Any error that occurred while processing this document.
	Error *status.Status `protobuf:"bytes,10,opt,name=error,proto3" json:"error,omitempty"`
	// contains filtered or unexported fields
}

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

func (*Document) Descriptor deprecated

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

Deprecated: Use Document.ProtoReflect.Descriptor instead.

func (*Document) GetContent

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

func (*Document) GetEntities

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

func (*Document) GetEntityRelations

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

func (*Document) GetError

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

func (*Document) GetLabels

func (x *Document) GetLabels() []*Document_Label

func (*Document) GetMimeType

func (x *Document) GetMimeType() string

func (*Document) GetPages

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

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) GetTextStyles

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

func (*Document) GetUri

func (x *Document) GetUri() string

func (*Document) ProtoMessage

func (*Document) ProtoMessage()

func (*Document) ProtoReflect

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

func (*Document) Reset

func (x *Document) Reset()

func (*Document) String

func (x *Document) String() string

type DocumentUnderstandingServiceClient

type DocumentUnderstandingServiceClient interface {
	// 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 *BatchProcessDocumentsRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Processes a single document.
	ProcessDocument(ctx context.Context, in *ProcessDocumentRequest, opts ...grpc.CallOption) (*Document, error)
}

DocumentUnderstandingServiceClient is the client API for DocumentUnderstandingService service.

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

type DocumentUnderstandingServiceServer

type DocumentUnderstandingServiceServer interface {
	// LRO endpoint to batch process many documents. The output is written
	// to Cloud Storage as JSON in the [Document] format.
	BatchProcessDocuments(context.Context, *BatchProcessDocumentsRequest) (*longrunning.Operation, error)
	// Processes a single document.
	ProcessDocument(context.Context, *ProcessDocumentRequest) (*Document, error)
}

DocumentUnderstandingServiceServer is the server API for DocumentUnderstandingService service.

type Document_Content

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

type Document_Entity

type Document_Entity struct {

	// Provenance of the entity.
	// Text anchor indexing into the [Document.text][google.cloud.documentai.v1beta2.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"`
	// Text value in the document e.g. `1600 Amphitheatre Pkwy`.
	MentionText string `protobuf:"bytes,3,opt,name=mention_text,json=mentionText,proto3" json:"mention_text,omitempty"`
	// 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"`
	// contains filtered or unexported fields
}

A phrase in the text that is a known entity type, such as a person, an organization, or location.

func (*Document_Entity) Descriptor deprecated

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

Deprecated: Use Document_Entity.ProtoReflect.Descriptor instead.

func (*Document_Entity) GetConfidence

func (x *Document_Entity) GetConfidence() float32

func (*Document_Entity) GetId

func (x *Document_Entity) GetId() string

func (*Document_Entity) GetMentionId

func (x *Document_Entity) GetMentionId() string

func (*Document_Entity) GetMentionText

func (x *Document_Entity) GetMentionText() string

func (*Document_Entity) GetPageAnchor

func (x *Document_Entity) GetPageAnchor() *Document_PageAnchor

func (*Document_Entity) GetTextAnchor

func (x *Document_Entity) GetTextAnchor() *Document_TextAnchor

func (*Document_Entity) GetType

func (x *Document_Entity) GetType() string

func (*Document_Entity) ProtoMessage

func (*Document_Entity) ProtoMessage()

func (*Document_Entity) ProtoReflect

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

func (*Document_Entity) Reset

func (x *Document_Entity) Reset()

func (*Document_Entity) String

func (x *Document_Entity) String() string

type Document_EntityRelation

type Document_EntityRelation struct {

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

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

func (*Document_EntityRelation) Descriptor deprecated

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

Deprecated: Use Document_EntityRelation.ProtoReflect.Descriptor instead.

func (*Document_EntityRelation) GetObjectId

func (x *Document_EntityRelation) GetObjectId() string

func (*Document_EntityRelation) GetRelation

func (x *Document_EntityRelation) GetRelation() string

func (*Document_EntityRelation) GetSubjectId

func (x *Document_EntityRelation) GetSubjectId() string

func (*Document_EntityRelation) ProtoMessage

func (*Document_EntityRelation) ProtoMessage()

func (*Document_EntityRelation) ProtoReflect

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

func (*Document_EntityRelation) Reset

func (x *Document_EntityRelation) Reset()

func (*Document_EntityRelation) String

func (x *Document_EntityRelation) String() string

type Document_Label

type Document_Label struct {

	// Provenance of the label.
	//
	// Types that are assignable to Source:
	//
	//	*Document_Label_AutomlModel
	Source isDocument_Label_Source `protobuf_oneof:"source"`
	// Name of the label.
	//
	// When the label is generated from AutoML Text Classification model, this
	// field represents the name of the category.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Confidence score between 0 and 1 for label assignment.
	Confidence float32 `protobuf:"fixed32,3,opt,name=confidence,proto3" json:"confidence,omitempty"`
	// contains filtered or unexported fields
}

Label attaches schema information and/or other metadata to segments within a Document[google.cloud.documentai.v1beta2.Document]. Multiple [Label][google.cloud.documentai.v1beta2.Document.Label]s on a single field can denote either different labels, different instances of the same label created at different times, or some combination of both.

func (*Document_Label) Descriptor deprecated

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

Deprecated: Use Document_Label.ProtoReflect.Descriptor instead.

func (*Document_Label) GetAutomlModel

func (x *Document_Label) GetAutomlModel() string

func (*Document_Label) GetConfidence

func (x *Document_Label) GetConfidence() float32

func (*Document_Label) GetName

func (x *Document_Label) GetName() string

func (*Document_Label) GetSource

func (m *Document_Label) GetSource() isDocument_Label_Source

func (*Document_Label) ProtoMessage

func (*Document_Label) ProtoMessage()

func (*Document_Label) ProtoReflect

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

func (*Document_Label) Reset

func (x *Document_Label) Reset()

func (*Document_Label) String

func (x *Document_Label) String() string

type Document_Label_AutomlModel

type Document_Label_AutomlModel struct {
	// Label is generated AutoML model. This field stores the full resource
	// name of the AutoML model.
	//
	// Format:
	// `projects/{project-id}/locations/{location-id}/models/{model-id}`
	AutomlModel string `protobuf:"bytes,2,opt,name=automl_model,json=automlModel,proto3,oneof"`
}

type Document_Page

type Document_Page struct {

	// 1-based index for current [Page][google.cloud.documentai.v1beta2.Document.Page] in a parent [Document][google.cloud.documentai.v1beta2.Document].
	// Useful when a page is taken out of a [Document][google.cloud.documentai.v1beta2.Document] for individual
	// processing.
	PageNumber int32 `protobuf:"varint,1,opt,name=page_number,json=pageNumber,proto3" json:"page_number,omitempty"`
	// Physical dimension of the page.
	Dimension *Document_Page_Dimension `protobuf:"bytes,2,opt,name=dimension,proto3" json:"dimension,omitempty"`
	// [Layout][google.cloud.documentai.v1beta2.Document.Page.Layout] for the page.
	Layout *Document_Page_Layout `protobuf:"bytes,3,opt,name=layout,proto3" json:"layout,omitempty"`
	// A list of detected languages together with confidence.
	DetectedLanguages []*Document_Page_DetectedLanguage `protobuf:"bytes,4,rep,name=detected_languages,json=detectedLanguages,proto3" json:"detected_languages,omitempty"`
	// A list of visually detected text blocks on the page.
	// A block has a set of lines (collected into paragraphs) that have a common
	// line-spacing and orientation.
	Blocks []*Document_Page_Block `protobuf:"bytes,5,rep,name=blocks,proto3" json:"blocks,omitempty"`
	// A list of visually detected text paragraphs on the page.
	// A collection of lines that a human would perceive as a paragraph.
	Paragraphs []*Document_Page_Paragraph `protobuf:"bytes,6,rep,name=paragraphs,proto3" json:"paragraphs,omitempty"`
	// A list of visually detected text lines on the page.
	// A collection of tokens that a human would perceive as a line.
	Lines []*Document_Page_Line `protobuf:"bytes,7,rep,name=lines,proto3" json:"lines,omitempty"`
	// A list of visually detected tokens on the page.
	Tokens []*Document_Page_Token `protobuf:"bytes,8,rep,name=tokens,proto3" json:"tokens,omitempty"`
	// A list of detected non-text visual elements e.g. checkbox,
	// signature etc. on the page.
	VisualElements []*Document_Page_VisualElement `protobuf:"bytes,9,rep,name=visual_elements,json=visualElements,proto3" json:"visual_elements,omitempty"`
	// A list of visually detected tables on the page.
	Tables []*Document_Page_Table `protobuf:"bytes,10,rep,name=tables,proto3" json:"tables,omitempty"`
	// A list of visually detected form fields on the page.
	FormFields []*Document_Page_FormField `protobuf:"bytes,11,rep,name=form_fields,json=formFields,proto3" json:"form_fields,omitempty"`
	// contains filtered or unexported fields
}

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

func (*Document_Page) Descriptor deprecated

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

Deprecated: Use Document_Page.ProtoReflect.Descriptor instead.

func (*Document_Page) GetBlocks

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

func (*Document_Page) GetDetectedLanguages

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

func (*Document_Page) GetDimension

func (x *Document_Page) GetDimension() *Document_Page_Dimension

func (*Document_Page) GetFormFields

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

func (*Document_Page) GetLayout

func (x *Document_Page) GetLayout() *Document_Page_Layout

func (*Document_Page) GetLines

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

func (*Document_Page) GetPageNumber

func (x *Document_Page) GetPageNumber() int32

func (*Document_Page) GetParagraphs

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

func (*Document_Page) GetTables

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

func (*Document_Page) GetTokens

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

func (*Document_Page) GetVisualElements

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

func (*Document_Page) ProtoMessage

func (*Document_Page) ProtoMessage()

func (*Document_Page) ProtoReflect

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

func (*Document_Page) Reset

func (x *Document_Page) Reset()

func (*Document_Page) String

func (x *Document_Page) String() string

type Document_PageAnchor

type Document_PageAnchor struct {

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

Referencing elements in [Document.pages][google.cloud.documentai.v1beta2.Document.pages].

func (*Document_PageAnchor) Descriptor deprecated

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

Deprecated: Use Document_PageAnchor.ProtoReflect.Descriptor instead.

func (*Document_PageAnchor) GetPageRefs

func (*Document_PageAnchor) ProtoMessage

func (*Document_PageAnchor) ProtoMessage()

func (*Document_PageAnchor) ProtoReflect

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

func (*Document_PageAnchor) Reset

func (x *Document_PageAnchor) Reset()

func (*Document_PageAnchor) String

func (x *Document_PageAnchor) String() string

type Document_PageAnchor_PageRef

type Document_PageAnchor_PageRef struct {

	// Required. Index into the [Document.pages][google.cloud.documentai.v1beta2.Document.pages] element
	Page int64 `protobuf:"varint,1,opt,name=page,proto3" json:"page,omitempty"`
	// Optional. The type of the layout element that is being referenced.  If not
	// specified the whole page is assumed to be referenced.
	LayoutType Document_PageAnchor_PageRef_LayoutType `` /* 168-byte string literal not displayed */
	// Optional. The [Page.Layout.id][google.cloud.documentai.v1beta2.Document.Page.Layout.id] on the page that this element
	// references.  If [LayoutRef.type][] is specified this id must also be
	// specified.
	LayoutId string `protobuf:"bytes,3,opt,name=layout_id,json=layoutId,proto3" json:"layout_id,omitempty"`
	// contains filtered or unexported fields
}

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

func (*Document_PageAnchor_PageRef) Descriptor deprecated

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

Deprecated: Use Document_PageAnchor_PageRef.ProtoReflect.Descriptor instead.

func (*Document_PageAnchor_PageRef) GetLayoutId

func (x *Document_PageAnchor_PageRef) GetLayoutId() string

func (*Document_PageAnchor_PageRef) GetLayoutType

func (*Document_PageAnchor_PageRef) GetPage

func (x *Document_PageAnchor_PageRef) GetPage() int64

func (*Document_PageAnchor_PageRef) ProtoMessage

func (*Document_PageAnchor_PageRef) ProtoMessage()

func (*Document_PageAnchor_PageRef) ProtoReflect

func (*Document_PageAnchor_PageRef) Reset

func (x *Document_PageAnchor_PageRef) Reset()

func (*Document_PageAnchor_PageRef) String

func (x *Document_PageAnchor_PageRef) String() string

type Document_PageAnchor_PageRef_LayoutType

type Document_PageAnchor_PageRef_LayoutType int32

The type of layout that is being referenced.

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

func (Document_PageAnchor_PageRef_LayoutType) Descriptor

func (Document_PageAnchor_PageRef_LayoutType) Enum

func (Document_PageAnchor_PageRef_LayoutType) EnumDescriptor deprecated

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

Deprecated: Use Document_PageAnchor_PageRef_LayoutType.Descriptor instead.

func (Document_PageAnchor_PageRef_LayoutType) Number

func (Document_PageAnchor_PageRef_LayoutType) String

func (Document_PageAnchor_PageRef_LayoutType) Type

type Document_Page_Block

type Document_Page_Block struct {

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

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

func (*Document_Page_Block) Descriptor deprecated

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

Deprecated: Use Document_Page_Block.ProtoReflect.Descriptor instead.

func (*Document_Page_Block) GetDetectedLanguages

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

func (*Document_Page_Block) GetLayout

func (x *Document_Page_Block) GetLayout() *Document_Page_Layout

func (*Document_Page_Block) ProtoMessage

func (*Document_Page_Block) ProtoMessage()

func (*Document_Page_Block) ProtoReflect

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

func (*Document_Page_Block) Reset

func (x *Document_Page_Block) Reset()

func (*Document_Page_Block) String

func (x *Document_Page_Block) String() string

type Document_Page_DetectedLanguage

type Document_Page_DetectedLanguage struct {

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

Detected language for a structural component.

func (*Document_Page_DetectedLanguage) Descriptor deprecated

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

Deprecated: Use Document_Page_DetectedLanguage.ProtoReflect.Descriptor instead.

func (*Document_Page_DetectedLanguage) GetConfidence

func (x *Document_Page_DetectedLanguage) GetConfidence() float32

func (*Document_Page_DetectedLanguage) GetLanguageCode

func (x *Document_Page_DetectedLanguage) GetLanguageCode() string

func (*Document_Page_DetectedLanguage) ProtoMessage

func (*Document_Page_DetectedLanguage) ProtoMessage()

func (*Document_Page_DetectedLanguage) ProtoReflect

func (*Document_Page_DetectedLanguage) Reset

func (x *Document_Page_DetectedLanguage) Reset()

func (*Document_Page_DetectedLanguage) String

type Document_Page_Dimension

type Document_Page_Dimension struct {

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

Dimension for the page.

func (*Document_Page_Dimension) Descriptor deprecated

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

Deprecated: Use Document_Page_Dimension.ProtoReflect.Descriptor instead.

func (*Document_Page_Dimension) GetHeight

func (x *Document_Page_Dimension) GetHeight() float32

func (*Document_Page_Dimension) GetUnit

func (x *Document_Page_Dimension) GetUnit() string

func (*Document_Page_Dimension) GetWidth

func (x *Document_Page_Dimension) GetWidth() float32

func (*Document_Page_Dimension) ProtoMessage

func (*Document_Page_Dimension) ProtoMessage()

func (*Document_Page_Dimension) ProtoReflect

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

func (*Document_Page_Dimension) Reset

func (x *Document_Page_Dimension) Reset()

func (*Document_Page_Dimension) String

func (x *Document_Page_Dimension) String() string

type Document_Page_FormField

type Document_Page_FormField struct {

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

A form field detected on the page.

func (*Document_Page_FormField) Descriptor deprecated

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

Deprecated: Use Document_Page_FormField.ProtoReflect.Descriptor instead.

func (*Document_Page_FormField) GetCorrectedKeyText

func (x *Document_Page_FormField) GetCorrectedKeyText() string

func (*Document_Page_FormField) GetCorrectedValueText

func (x *Document_Page_FormField) GetCorrectedValueText() string

func (*Document_Page_FormField) GetFieldName

func (x *Document_Page_FormField) GetFieldName() *Document_Page_Layout

func (*Document_Page_FormField) GetFieldValue

func (x *Document_Page_FormField) GetFieldValue() *Document_Page_Layout

func (*Document_Page_FormField) GetNameDetectedLanguages

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

func (*Document_Page_FormField) GetValueDetectedLanguages

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

func (*Document_Page_FormField) GetValueType

func (x *Document_Page_FormField) GetValueType() string

func (*Document_Page_FormField) ProtoMessage

func (*Document_Page_FormField) ProtoMessage()

func (*Document_Page_FormField) ProtoReflect

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

func (*Document_Page_FormField) Reset

func (x *Document_Page_FormField) Reset()

func (*Document_Page_FormField) String

func (x *Document_Page_FormField) String() string

type Document_Page_Layout

type Document_Page_Layout struct {

	// Text anchor indexing into the [Document.text][google.cloud.documentai.v1beta2.Document.text].
	TextAnchor *Document_TextAnchor `protobuf:"bytes,1,opt,name=text_anchor,json=textAnchor,proto3" json:"text_anchor,omitempty"`
	// Confidence of the current [Layout][google.cloud.documentai.v1beta2.Document.Page.Layout] within context of the object this
	// layout is for. e.g. confidence can be for a single token, a table,
	// a visual element, etc. depending on context. Range [0, 1].
	Confidence float32 `protobuf:"fixed32,2,opt,name=confidence,proto3" json:"confidence,omitempty"`
	// The bounding polygon for the [Layout][google.cloud.documentai.v1beta2.Document.Page.Layout].
	BoundingPoly *BoundingPoly `protobuf:"bytes,3,opt,name=bounding_poly,json=boundingPoly,proto3" json:"bounding_poly,omitempty"`
	// Detected orientation for the [Layout][google.cloud.documentai.v1beta2.Document.Page.Layout].
	Orientation Document_Page_Layout_Orientation `` /* 146-byte string literal not displayed */
	// Optional. This is the identifier used by referencing [PageAnchor][google.cloud.documentai.v1beta2.Document.PageAnchor]s.
	Id string `protobuf:"bytes,5,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

Visual element describing a layout unit on a page.

func (*Document_Page_Layout) Descriptor deprecated

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

Deprecated: Use Document_Page_Layout.ProtoReflect.Descriptor instead.

func (*Document_Page_Layout) GetBoundingPoly

func (x *Document_Page_Layout) GetBoundingPoly() *BoundingPoly

func (*Document_Page_Layout) GetConfidence

func (x *Document_Page_Layout) GetConfidence() float32

func (*Document_Page_Layout) GetId

func (x *Document_Page_Layout) GetId() string

func (*Document_Page_Layout) GetOrientation

func (*Document_Page_Layout) GetTextAnchor

func (x *Document_Page_Layout) GetTextAnchor() *Document_TextAnchor

func (*Document_Page_Layout) ProtoMessage

func (*Document_Page_Layout) ProtoMessage()

func (*Document_Page_Layout) ProtoReflect

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

func (*Document_Page_Layout) Reset

func (x *Document_Page_Layout) Reset()

func (*Document_Page_Layout) String

func (x *Document_Page_Layout) String() string

type Document_Page_Layout_Orientation

type Document_Page_Layout_Orientation int32

Detected human reading orientation.

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

func (Document_Page_Layout_Orientation) Descriptor

func (Document_Page_Layout_Orientation) Enum

func (Document_Page_Layout_Orientation) EnumDescriptor deprecated

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

Deprecated: Use Document_Page_Layout_Orientation.Descriptor instead.

func (Document_Page_Layout_Orientation) Number

func (Document_Page_Layout_Orientation) String

func (Document_Page_Layout_Orientation) Type

type Document_Page_Line

type Document_Page_Line struct {

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

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

func (*Document_Page_Line) Descriptor deprecated

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

Deprecated: Use Document_Page_Line.ProtoReflect.Descriptor instead.

func (*Document_Page_Line) GetDetectedLanguages

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

func (*Document_Page_Line) GetLayout

func (x *Document_Page_Line) GetLayout() *Document_Page_Layout

func (*Document_Page_Line) ProtoMessage

func (*Document_Page_Line) ProtoMessage()

func (*Document_Page_Line) ProtoReflect

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

func (*Document_Page_Line) Reset

func (x *Document_Page_Line) Reset()

func (*Document_Page_Line) String

func (x *Document_Page_Line) String() string

type Document_Page_Paragraph

type Document_Page_Paragraph struct {

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

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

func (*Document_Page_Paragraph) Descriptor deprecated

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

Deprecated: Use Document_Page_Paragraph.ProtoReflect.Descriptor instead.

func (*Document_Page_Paragraph) GetDetectedLanguages

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

func (*Document_Page_Paragraph) GetLayout

func (*Document_Page_Paragraph) ProtoMessage

func (*Document_Page_Paragraph) ProtoMessage()

func (*Document_Page_Paragraph) ProtoReflect

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

func (*Document_Page_Paragraph) Reset

func (x *Document_Page_Paragraph) Reset()

func (*Document_Page_Paragraph) String

func (x *Document_Page_Paragraph) String() string

type Document_Page_Table

type Document_Page_Table struct {

	// [Layout][google.cloud.documentai.v1beta2.Document.Page.Layout] for [Table][google.cloud.documentai.v1beta2.Document.Page.Table].
	Layout *Document_Page_Layout `protobuf:"bytes,1,opt,name=layout,proto3" json:"layout,omitempty"`
	// Header rows of the table.
	HeaderRows []*Document_Page_Table_TableRow `protobuf:"bytes,2,rep,name=header_rows,json=headerRows,proto3" json:"header_rows,omitempty"`
	// Body rows of the table.
	BodyRows []*Document_Page_Table_TableRow `protobuf:"bytes,3,rep,name=body_rows,json=bodyRows,proto3" json:"body_rows,omitempty"`
	// A list of detected languages together with confidence.
	DetectedLanguages []*Document_Page_DetectedLanguage `protobuf:"bytes,4,rep,name=detected_languages,json=detectedLanguages,proto3" json:"detected_languages,omitempty"`
	// contains filtered or unexported fields
}

A table representation similar to HTML table structure.

func (*Document_Page_Table) Descriptor deprecated

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

Deprecated: Use Document_Page_Table.ProtoReflect.Descriptor instead.

func (*Document_Page_Table) GetBodyRows

func (*Document_Page_Table) GetDetectedLanguages

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

func (*Document_Page_Table) GetHeaderRows

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

func (*Document_Page_Table) GetLayout

func (x *Document_Page_Table) GetLayout() *Document_Page_Layout

func (*Document_Page_Table) ProtoMessage

func (*Document_Page_Table) ProtoMessage()

func (*Document_Page_Table) ProtoReflect

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

func (*Document_Page_Table) Reset

func (x *Document_Page_Table) Reset()

func (*Document_Page_Table) String

func (x *Document_Page_Table) String() string

type Document_Page_Table_TableCell

type Document_Page_Table_TableCell struct {

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

A cell representation inside the table.

func (*Document_Page_Table_TableCell) Descriptor deprecated

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

Deprecated: Use Document_Page_Table_TableCell.ProtoReflect.Descriptor instead.

func (*Document_Page_Table_TableCell) GetColSpan

func (x *Document_Page_Table_TableCell) GetColSpan() int32

func (*Document_Page_Table_TableCell) GetDetectedLanguages

func (*Document_Page_Table_TableCell) GetLayout

func (*Document_Page_Table_TableCell) GetRowSpan

func (x *Document_Page_Table_TableCell) GetRowSpan() int32

func (*Document_Page_Table_TableCell) ProtoMessage

func (*Document_Page_Table_TableCell) ProtoMessage()

func (*Document_Page_Table_TableCell) ProtoReflect

func (*Document_Page_Table_TableCell) Reset

func (x *Document_Page_Table_TableCell) Reset()

func (*Document_Page_Table_TableCell) String

type Document_Page_Table_TableRow

type Document_Page_Table_TableRow struct {

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

A row of table cells.

func (*Document_Page_Table_TableRow) Descriptor deprecated

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

Deprecated: Use Document_Page_Table_TableRow.ProtoReflect.Descriptor instead.

func (*Document_Page_Table_TableRow) GetCells

func (*Document_Page_Table_TableRow) ProtoMessage

func (*Document_Page_Table_TableRow) ProtoMessage()

func (*Document_Page_Table_TableRow) ProtoReflect

func (*Document_Page_Table_TableRow) Reset

func (x *Document_Page_Table_TableRow) Reset()

func (*Document_Page_Table_TableRow) String

type Document_Page_Token

type Document_Page_Token struct {

	// [Layout][google.cloud.documentai.v1beta2.Document.Page.Layout] for [Token][google.cloud.documentai.v1beta2.Document.Page.Token].
	Layout *Document_Page_Layout `protobuf:"bytes,1,opt,name=layout,proto3" json:"layout,omitempty"`
	// Detected break at the end of a [Token][google.cloud.documentai.v1beta2.Document.Page.Token].
	DetectedBreak *Document_Page_Token_DetectedBreak `protobuf:"bytes,2,opt,name=detected_break,json=detectedBreak,proto3" json:"detected_break,omitempty"`
	// A list of detected languages together with confidence.
	DetectedLanguages []*Document_Page_DetectedLanguage `protobuf:"bytes,3,rep,name=detected_languages,json=detectedLanguages,proto3" json:"detected_languages,omitempty"`
	// contains filtered or unexported fields
}

A detected token.

func (*Document_Page_Token) Descriptor deprecated

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

Deprecated: Use Document_Page_Token.ProtoReflect.Descriptor instead.

func (*Document_Page_Token) GetDetectedBreak

func (*Document_Page_Token) GetDetectedLanguages

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

func (*Document_Page_Token) GetLayout

func (x *Document_Page_Token) GetLayout() *Document_Page_Layout

func (*Document_Page_Token) ProtoMessage

func (*Document_Page_Token) ProtoMessage()

func (*Document_Page_Token) ProtoReflect

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

func (*Document_Page_Token) Reset

func (x *Document_Page_Token) Reset()

func (*Document_Page_Token) String

func (x *Document_Page_Token) String() string

type Document_Page_Token_DetectedBreak

type Document_Page_Token_DetectedBreak struct {

	// Detected break type.
	Type Document_Page_Token_DetectedBreak_Type `` /* 138-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

func (*Document_Page_Token_DetectedBreak) Descriptor deprecated

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

Deprecated: Use Document_Page_Token_DetectedBreak.ProtoReflect.Descriptor instead.

func (*Document_Page_Token_DetectedBreak) GetType

func (*Document_Page_Token_DetectedBreak) ProtoMessage

func (*Document_Page_Token_DetectedBreak) ProtoMessage()

func (*Document_Page_Token_DetectedBreak) ProtoReflect

func (*Document_Page_Token_DetectedBreak) Reset

func (*Document_Page_Token_DetectedBreak) String

type Document_Page_Token_DetectedBreak_Type

type Document_Page_Token_DetectedBreak_Type int32

Enum to denote the type of break found.

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

func (Document_Page_Token_DetectedBreak_Type) Descriptor

func (Document_Page_Token_DetectedBreak_Type) Enum

func (Document_Page_Token_DetectedBreak_Type) EnumDescriptor deprecated

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

Deprecated: Use Document_Page_Token_DetectedBreak_Type.Descriptor instead.

func (Document_Page_Token_DetectedBreak_Type) Number

func (Document_Page_Token_DetectedBreak_Type) String

func (Document_Page_Token_DetectedBreak_Type) Type

type Document_Page_VisualElement

type Document_Page_VisualElement struct {

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

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

func (*Document_Page_VisualElement) Descriptor deprecated

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

Deprecated: Use Document_Page_VisualElement.ProtoReflect.Descriptor instead.

func (*Document_Page_VisualElement) GetDetectedLanguages

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

func (*Document_Page_VisualElement) GetLayout

func (*Document_Page_VisualElement) GetType

func (x *Document_Page_VisualElement) GetType() string

func (*Document_Page_VisualElement) ProtoMessage

func (*Document_Page_VisualElement) ProtoMessage()

func (*Document_Page_VisualElement) ProtoReflect

func (*Document_Page_VisualElement) Reset

func (x *Document_Page_VisualElement) Reset()

func (*Document_Page_VisualElement) String

func (x *Document_Page_VisualElement) String() string

type Document_ShardInfo

type Document_ShardInfo struct {

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

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

func (*Document_ShardInfo) Descriptor deprecated

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

Deprecated: Use Document_ShardInfo.ProtoReflect.Descriptor instead.

func (*Document_ShardInfo) GetShardCount

func (x *Document_ShardInfo) GetShardCount() int64

func (*Document_ShardInfo) GetShardIndex

func (x *Document_ShardInfo) GetShardIndex() int64

func (*Document_ShardInfo) GetTextOffset

func (x *Document_ShardInfo) GetTextOffset() int64

func (*Document_ShardInfo) ProtoMessage

func (*Document_ShardInfo) ProtoMessage()

func (*Document_ShardInfo) ProtoReflect

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

func (*Document_ShardInfo) Reset

func (x *Document_ShardInfo) Reset()

func (*Document_ShardInfo) String

func (x *Document_ShardInfo) String() string

type Document_Style

type Document_Style struct {

	// Text anchor indexing into the [Document.text][google.cloud.documentai.v1beta2.Document.text].
	TextAnchor *Document_TextAnchor `protobuf:"bytes,1,opt,name=text_anchor,json=textAnchor,proto3" json:"text_anchor,omitempty"`
	// Text color.
	Color *color.Color `protobuf:"bytes,2,opt,name=color,proto3" json:"color,omitempty"`
	// Text background color.
	BackgroundColor *color.Color `protobuf:"bytes,3,opt,name=background_color,json=backgroundColor,proto3" json:"background_color,omitempty"`
	// Font weight. Possible values are normal, bold, bolder, and lighter.
	// https://www.w3schools.com/cssref/pr_font_weight.asp
	FontWeight string `protobuf:"bytes,4,opt,name=font_weight,json=fontWeight,proto3" json:"font_weight,omitempty"`
	// Text style. Possible values are normal, italic, and oblique.
	// https://www.w3schools.com/cssref/pr_font_font-style.asp
	TextStyle string `protobuf:"bytes,5,opt,name=text_style,json=textStyle,proto3" json:"text_style,omitempty"`
	// Text decoration. Follows CSS standard.
	// <text-decoration-line> <text-decoration-color> <text-decoration-style>
	// https://www.w3schools.com/cssref/pr_text_text-decoration.asp
	TextDecoration string `protobuf:"bytes,6,opt,name=text_decoration,json=textDecoration,proto3" json:"text_decoration,omitempty"`
	// Font size.
	FontSize *Document_Style_FontSize `protobuf:"bytes,7,opt,name=font_size,json=fontSize,proto3" json:"font_size,omitempty"`
	// contains filtered or unexported fields
}

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

func (*Document_Style) Descriptor deprecated

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

Deprecated: Use Document_Style.ProtoReflect.Descriptor instead.

func (*Document_Style) GetBackgroundColor

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

func (*Document_Style) GetColor

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

func (*Document_Style) GetFontSize

func (x *Document_Style) GetFontSize() *Document_Style_FontSize

func (*Document_Style) GetFontWeight

func (x *Document_Style) GetFontWeight() string

func (*Document_Style) GetTextAnchor

func (x *Document_Style) GetTextAnchor() *Document_TextAnchor

func (*Document_Style) GetTextDecoration

func (x *Document_Style) GetTextDecoration() string

func (*Document_Style) GetTextStyle

func (x *Document_Style) GetTextStyle() string

func (*Document_Style) ProtoMessage

func (*Document_Style) ProtoMessage()

func (*Document_Style) ProtoReflect

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

func (*Document_Style) Reset

func (x *Document_Style) Reset()

func (*Document_Style) String

func (x *Document_Style) String() string

type Document_Style_FontSize

type Document_Style_FontSize struct {

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

Font size with unit.

func (*Document_Style_FontSize) Descriptor deprecated

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

Deprecated: Use Document_Style_FontSize.ProtoReflect.Descriptor instead.

func (*Document_Style_FontSize) GetSize

func (x *Document_Style_FontSize) GetSize() float32

func (*Document_Style_FontSize) GetUnit

func (x *Document_Style_FontSize) GetUnit() string

func (*Document_Style_FontSize) ProtoMessage

func (*Document_Style_FontSize) ProtoMessage()

func (*Document_Style_FontSize) ProtoReflect

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

func (*Document_Style_FontSize) Reset

func (x *Document_Style_FontSize) Reset()

func (*Document_Style_FontSize) String

func (x *Document_Style_FontSize) String() string

type Document_TextAnchor

type Document_TextAnchor struct {

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

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

func (*Document_TextAnchor) Descriptor deprecated

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

Deprecated: Use Document_TextAnchor.ProtoReflect.Descriptor instead.

func (*Document_TextAnchor) GetContent

func (x *Document_TextAnchor) GetContent() string

func (*Document_TextAnchor) GetTextSegments

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

func (*Document_TextAnchor) ProtoMessage

func (*Document_TextAnchor) ProtoMessage()

func (*Document_TextAnchor) ProtoReflect

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

func (*Document_TextAnchor) Reset

func (x *Document_TextAnchor) Reset()

func (*Document_TextAnchor) String

func (x *Document_TextAnchor) String() string

type Document_TextAnchor_TextSegment

type Document_TextAnchor_TextSegment struct {

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

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

func (*Document_TextAnchor_TextSegment) Descriptor deprecated

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

Deprecated: Use Document_TextAnchor_TextSegment.ProtoReflect.Descriptor instead.

func (*Document_TextAnchor_TextSegment) GetEndIndex

func (x *Document_TextAnchor_TextSegment) GetEndIndex() int64

func (*Document_TextAnchor_TextSegment) GetStartIndex

func (x *Document_TextAnchor_TextSegment) GetStartIndex() int64

func (*Document_TextAnchor_TextSegment) ProtoMessage

func (*Document_TextAnchor_TextSegment) ProtoMessage()

func (*Document_TextAnchor_TextSegment) ProtoReflect

func (*Document_TextAnchor_TextSegment) Reset

func (*Document_TextAnchor_TextSegment) String

type Document_Uri

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

type EntityExtractionParams

type EntityExtractionParams struct {

	// Whether to enable entity extraction.
	Enabled bool `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"`
	// Model version of the entity extraction. Default is
	// "builtin/stable". Specify "builtin/latest" for the latest model.
	ModelVersion string `protobuf:"bytes,2,opt,name=model_version,json=modelVersion,proto3" json:"model_version,omitempty"`
	// contains filtered or unexported fields
}

Parameters to control entity extraction behavior.

func (*EntityExtractionParams) Descriptor deprecated

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

Deprecated: Use EntityExtractionParams.ProtoReflect.Descriptor instead.

func (*EntityExtractionParams) GetEnabled

func (x *EntityExtractionParams) GetEnabled() bool

func (*EntityExtractionParams) GetModelVersion

func (x *EntityExtractionParams) GetModelVersion() string

func (*EntityExtractionParams) ProtoMessage

func (*EntityExtractionParams) ProtoMessage()

func (*EntityExtractionParams) ProtoReflect

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

func (*EntityExtractionParams) Reset

func (x *EntityExtractionParams) Reset()

func (*EntityExtractionParams) String

func (x *EntityExtractionParams) String() string

type FormExtractionParams

type FormExtractionParams struct {

	// Whether to enable form extraction.
	Enabled bool `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"`
	// User can provide pairs of (key text, value type) to improve the parsing
	// result.
	//
	// For example, if a document has a field called "Date" that holds a date
	// value and a field called "Amount" that may hold either a currency value
	// (e.g., "$500.00") or a simple number value (e.g., "20"), you could use the
	// following hints: [ {"key": "Date", value_types: [ "DATE"]}, {"key":
	// "Amount", "value_types": [ "PRICE", "NUMBER" ]} ]
	//
	// If the value type is unknown, but you want to provide hints for the keys,
	// you can leave the value_types field blank. e.g. {"key": "Date",
	// "value_types": []}
	KeyValuePairHints []*KeyValuePairHint `protobuf:"bytes,2,rep,name=key_value_pair_hints,json=keyValuePairHints,proto3" json:"key_value_pair_hints,omitempty"`
	// Model version of the form extraction system. Default is
	// "builtin/stable". Specify "builtin/latest" for the latest model.
	// For custom form models, specify: “custom/{model_name}". Model name
	// format is "bucket_name/path/to/modeldir" corresponding to
	// "gs://bucket_name/path/to/modeldir" where annotated examples are stored.
	ModelVersion string `protobuf:"bytes,3,opt,name=model_version,json=modelVersion,proto3" json:"model_version,omitempty"`
	// contains filtered or unexported fields
}

Parameters to control form extraction behavior.

func (*FormExtractionParams) Descriptor deprecated

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

Deprecated: Use FormExtractionParams.ProtoReflect.Descriptor instead.

func (*FormExtractionParams) GetEnabled

func (x *FormExtractionParams) GetEnabled() bool

func (*FormExtractionParams) GetKeyValuePairHints

func (x *FormExtractionParams) GetKeyValuePairHints() []*KeyValuePairHint

func (*FormExtractionParams) GetModelVersion

func (x *FormExtractionParams) GetModelVersion() string

func (*FormExtractionParams) ProtoMessage

func (*FormExtractionParams) ProtoMessage()

func (*FormExtractionParams) ProtoReflect

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

func (*FormExtractionParams) Reset

func (x *FormExtractionParams) Reset()

func (*FormExtractionParams) String

func (x *FormExtractionParams) String() string

type GcsDestination

type GcsDestination struct {
	Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
	// contains filtered or unexported fields
}

The Google Cloud Storage location where the output file will be written to.

func (*GcsDestination) Descriptor deprecated

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

Deprecated: Use GcsDestination.ProtoReflect.Descriptor instead.

func (*GcsDestination) GetUri

func (x *GcsDestination) GetUri() string

func (*GcsDestination) ProtoMessage

func (*GcsDestination) ProtoMessage()

func (*GcsDestination) ProtoReflect

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

func (*GcsDestination) Reset

func (x *GcsDestination) Reset()

func (*GcsDestination) String

func (x *GcsDestination) String() string

type GcsSource

type GcsSource struct {
	Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
	// contains filtered or unexported fields
}

The Google Cloud Storage location where the input file will be read from.

func (*GcsSource) Descriptor deprecated

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

Deprecated: Use GcsSource.ProtoReflect.Descriptor instead.

func (*GcsSource) GetUri

func (x *GcsSource) GetUri() string

func (*GcsSource) ProtoMessage

func (*GcsSource) ProtoMessage()

func (*GcsSource) ProtoReflect

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

func (*GcsSource) Reset

func (x *GcsSource) Reset()

func (*GcsSource) String

func (x *GcsSource) String() string

type InputConfig

type InputConfig struct {

	// Required.
	//
	// Types that are assignable to Source:
	//	*InputConfig_GcsSource
	//	*InputConfig_Contents
	Source isInputConfig_Source `protobuf_oneof:"source"`
	// Required. Mimetype of the input. Current supported mimetypes are application/pdf,
	// image/tiff, and image/gif.
	// In addition, application/json type is supported for requests with
	// [ProcessDocumentRequest.automl_params][google.cloud.documentai.v1beta2.ProcessDocumentRequest.automl_params] field set. The JSON file needs to
	// be in [Document][google.cloud.documentai.v1beta2.Document] format.
	MimeType string `protobuf:"bytes,2,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// contains filtered or unexported fields
}

The desired input location and metadata.

func (*InputConfig) Descriptor deprecated

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

Deprecated: Use InputConfig.ProtoReflect.Descriptor instead.

func (*InputConfig) GetContents

func (x *InputConfig) GetContents() []byte

func (*InputConfig) GetGcsSource

func (x *InputConfig) GetGcsSource() *GcsSource

func (*InputConfig) GetMimeType

func (x *InputConfig) GetMimeType() string

func (*InputConfig) GetSource

func (m *InputConfig) GetSource() isInputConfig_Source

func (*InputConfig) ProtoMessage

func (*InputConfig) ProtoMessage()

func (*InputConfig) ProtoReflect

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

func (*InputConfig) Reset

func (x *InputConfig) Reset()

func (*InputConfig) String

func (x *InputConfig) String() string

type InputConfig_Contents

type InputConfig_Contents struct {
	// Content in bytes, represented as a stream of bytes.
	// Note: As with all `bytes` fields, proto buffer messages use a pure binary
	// representation, whereas JSON representations use base64.
	//
	// This field only works for synchronous ProcessDocument method.
	Contents []byte `protobuf:"bytes,3,opt,name=contents,proto3,oneof"`
}

type InputConfig_GcsSource

type InputConfig_GcsSource struct {
	// The Google Cloud Storage location to read the input from. This must be a
	// single file.
	GcsSource *GcsSource `protobuf:"bytes,1,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}

type KeyValuePairHint

type KeyValuePairHint struct {

	// The key text for the hint.
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// Type of the value. This is case-insensitive, and could be one of:
	// ADDRESS, LOCATION, ORGANIZATION, PERSON, PHONE_NUMBER,
	// ID, NUMBER, EMAIL, PRICE, TERMS, DATE, NAME. Types not in this list will
	// be ignored.
	ValueTypes []string `protobuf:"bytes,2,rep,name=value_types,json=valueTypes,proto3" json:"value_types,omitempty"`
	// contains filtered or unexported fields
}

User-provided hint for key value pair.

func (*KeyValuePairHint) Descriptor deprecated

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

Deprecated: Use KeyValuePairHint.ProtoReflect.Descriptor instead.

func (*KeyValuePairHint) GetKey

func (x *KeyValuePairHint) GetKey() string

func (*KeyValuePairHint) GetValueTypes

func (x *KeyValuePairHint) GetValueTypes() []string

func (*KeyValuePairHint) ProtoMessage

func (*KeyValuePairHint) ProtoMessage()

func (*KeyValuePairHint) ProtoReflect

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

func (*KeyValuePairHint) Reset

func (x *KeyValuePairHint) Reset()

func (*KeyValuePairHint) String

func (x *KeyValuePairHint) String() string

type NormalizedVertex

type NormalizedVertex struct {

	// X coordinate.
	X float32 `protobuf:"fixed32,1,opt,name=x,proto3" json:"x,omitempty"`
	// Y coordinate.
	Y float32 `protobuf:"fixed32,2,opt,name=y,proto3" json:"y,omitempty"`
	// contains filtered or unexported fields
}

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

func (*NormalizedVertex) Descriptor deprecated

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

Deprecated: Use NormalizedVertex.ProtoReflect.Descriptor instead.

func (*NormalizedVertex) GetX

func (x *NormalizedVertex) GetX() float32

func (*NormalizedVertex) GetY

func (x *NormalizedVertex) GetY() float32

func (*NormalizedVertex) ProtoMessage

func (*NormalizedVertex) ProtoMessage()

func (*NormalizedVertex) ProtoReflect

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

func (*NormalizedVertex) Reset

func (x *NormalizedVertex) Reset()

func (*NormalizedVertex) String

func (x *NormalizedVertex) String() string

type OcrParams

type OcrParams struct {

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

Parameters to control Optical Character Recognition (OCR) behavior.

func (*OcrParams) Descriptor deprecated

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

Deprecated: Use OcrParams.ProtoReflect.Descriptor instead.

func (*OcrParams) GetLanguageHints

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

func (*OcrParams) ProtoMessage

func (*OcrParams) ProtoMessage()

func (*OcrParams) ProtoReflect

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

func (*OcrParams) Reset

func (x *OcrParams) Reset()

func (*OcrParams) String

func (x *OcrParams) String() string

type OperationMetadata

type OperationMetadata struct {

	// The state of the current batch processing.
	State OperationMetadata_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.cloud.documentai.v1beta2.OperationMetadata_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"`
	// 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
}

Contains metadata for the BatchProcessDocuments operation.

func (*OperationMetadata) Descriptor deprecated

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

Deprecated: Use OperationMetadata.ProtoReflect.Descriptor instead.

func (*OperationMetadata) GetCreateTime

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

func (*OperationMetadata) GetState

func (*OperationMetadata) GetStateMessage

func (x *OperationMetadata) GetStateMessage() string

func (*OperationMetadata) GetUpdateTime

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

func (*OperationMetadata) ProtoMessage

func (*OperationMetadata) ProtoMessage()

func (*OperationMetadata) ProtoReflect

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

func (*OperationMetadata) Reset

func (x *OperationMetadata) Reset()

func (*OperationMetadata) String

func (x *OperationMetadata) String() string

type OperationMetadata_State

type OperationMetadata_State int32
const (
	// The default value. This value is used if the state is omitted.
	OperationMetadata_STATE_UNSPECIFIED OperationMetadata_State = 0
	// Request is received.
	OperationMetadata_ACCEPTED OperationMetadata_State = 1
	// Request operation is waiting for scheduling.
	OperationMetadata_WAITING OperationMetadata_State = 2
	// Request is being processed.
	OperationMetadata_RUNNING OperationMetadata_State = 3
	// The batch processing completed successfully.
	OperationMetadata_SUCCEEDED OperationMetadata_State = 4
	// The batch processing was cancelled.
	OperationMetadata_CANCELLED OperationMetadata_State = 5
	// The batch processing has failed.
	OperationMetadata_FAILED OperationMetadata_State = 6
)

func (OperationMetadata_State) Descriptor

func (OperationMetadata_State) Enum

func (OperationMetadata_State) EnumDescriptor deprecated

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

Deprecated: Use OperationMetadata_State.Descriptor instead.

func (OperationMetadata_State) Number

func (OperationMetadata_State) String

func (x OperationMetadata_State) String() string

func (OperationMetadata_State) Type

type OutputConfig

type OutputConfig struct {

	// Required.
	//
	// Types that are assignable to Destination:
	//	*OutputConfig_GcsDestination
	Destination isOutputConfig_Destination `protobuf_oneof:"destination"`
	// The max number of pages to include into each output Document shard JSON on
	// Google Cloud Storage.
	//
	// The valid range is [1, 100]. If not specified, the default value is 20.
	//
	// For example, for one pdf file with 100 pages, 100 parsed pages will be
	// produced. If `pages_per_shard` = 20, then 5 Document shard JSON files each
	// containing 20 parsed pages will be written under the prefix
	// [OutputConfig.gcs_destination.uri][] and suffix pages-x-to-y.json where
	// x and y are 1-indexed page numbers.
	//
	// Example GCS outputs with 157 pages and pages_per_shard = 50:
	//
	// <prefix>pages-001-to-050.json
	// <prefix>pages-051-to-100.json
	// <prefix>pages-101-to-150.json
	// <prefix>pages-151-to-157.json
	PagesPerShard int32 `protobuf:"varint,2,opt,name=pages_per_shard,json=pagesPerShard,proto3" json:"pages_per_shard,omitempty"`
	// contains filtered or unexported fields
}

The desired output location and metadata.

func (*OutputConfig) Descriptor deprecated

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

Deprecated: Use OutputConfig.ProtoReflect.Descriptor instead.

func (*OutputConfig) GetDestination

func (m *OutputConfig) GetDestination() isOutputConfig_Destination

func (*OutputConfig) GetGcsDestination

func (x *OutputConfig) GetGcsDestination() *GcsDestination

func (*OutputConfig) GetPagesPerShard

func (x *OutputConfig) GetPagesPerShard() int32

func (*OutputConfig) ProtoMessage

func (*OutputConfig) ProtoMessage()

func (*OutputConfig) ProtoReflect

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

func (*OutputConfig) Reset

func (x *OutputConfig) Reset()

func (*OutputConfig) String

func (x *OutputConfig) String() string

type OutputConfig_GcsDestination

type OutputConfig_GcsDestination struct {
	// The Google Cloud Storage location to write the output to.
	GcsDestination *GcsDestination `protobuf:"bytes,1,opt,name=gcs_destination,json=gcsDestination,proto3,oneof"`
}

type ProcessDocumentRequest

type ProcessDocumentRequest struct {

	// Target project and location to make a call.
	//
	// Format: `projects/{project-id}/locations/{location-id}`.
	//
	// If no location is specified, a region will be chosen automatically.
	// This field is only populated when used in ProcessDocument method.
	Parent string `protobuf:"bytes,9,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. Information about the input file.
	InputConfig *InputConfig `protobuf:"bytes,1,opt,name=input_config,json=inputConfig,proto3" json:"input_config,omitempty"`
	// Optional. The desired output location. This field is only needed in
	// BatchProcessDocumentsRequest.
	OutputConfig *OutputConfig `protobuf:"bytes,2,opt,name=output_config,json=outputConfig,proto3" json:"output_config,omitempty"`
	// Specifies a known document type for deeper structure detection. Valid
	// values are currently "general" and "invoice". If not provided, "general"\
	// is used as default. If any other value is given, the request is rejected.
	DocumentType string `protobuf:"bytes,3,opt,name=document_type,json=documentType,proto3" json:"document_type,omitempty"`
	// Controls table extraction behavior. If not specified, the system will
	// decide reasonable defaults.
	TableExtractionParams *TableExtractionParams `` /* 126-byte string literal not displayed */
	// Controls form extraction behavior. If not specified, the system will
	// decide reasonable defaults.
	FormExtractionParams *FormExtractionParams `protobuf:"bytes,5,opt,name=form_extraction_params,json=formExtractionParams,proto3" json:"form_extraction_params,omitempty"`
	// Controls entity extraction behavior. If not specified, the system will
	// decide reasonable defaults.
	EntityExtractionParams *EntityExtractionParams `` /* 129-byte string literal not displayed */
	// Controls OCR behavior. If not specified, the system will decide reasonable
	// defaults.
	OcrParams *OcrParams `protobuf:"bytes,7,opt,name=ocr_params,json=ocrParams,proto3" json:"ocr_params,omitempty"`
	// Controls AutoML model prediction behavior. AutoMlParams cannot be used
	// together with other Params.
	AutomlParams *AutoMlParams `protobuf:"bytes,8,opt,name=automl_params,json=automlParams,proto3" json:"automl_params,omitempty"`
	// contains filtered or unexported fields
}

Request to process one document.

func (*ProcessDocumentRequest) Descriptor deprecated

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

Deprecated: Use ProcessDocumentRequest.ProtoReflect.Descriptor instead.

func (*ProcessDocumentRequest) GetAutomlParams

func (x *ProcessDocumentRequest) GetAutomlParams() *AutoMlParams

func (*ProcessDocumentRequest) GetDocumentType

func (x *ProcessDocumentRequest) GetDocumentType() string

func (*ProcessDocumentRequest) GetEntityExtractionParams

func (x *ProcessDocumentRequest) GetEntityExtractionParams() *EntityExtractionParams

func (*ProcessDocumentRequest) GetFormExtractionParams

func (x *ProcessDocumentRequest) GetFormExtractionParams() *FormExtractionParams

func (*ProcessDocumentRequest) GetInputConfig

func (x *ProcessDocumentRequest) GetInputConfig() *InputConfig

func (*ProcessDocumentRequest) GetOcrParams

func (x *ProcessDocumentRequest) GetOcrParams() *OcrParams

func (*ProcessDocumentRequest) GetOutputConfig

func (x *ProcessDocumentRequest) GetOutputConfig() *OutputConfig

func (*ProcessDocumentRequest) GetParent

func (x *ProcessDocumentRequest) GetParent() string

func (*ProcessDocumentRequest) GetTableExtractionParams

func (x *ProcessDocumentRequest) GetTableExtractionParams() *TableExtractionParams

func (*ProcessDocumentRequest) ProtoMessage

func (*ProcessDocumentRequest) ProtoMessage()

func (*ProcessDocumentRequest) ProtoReflect

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

func (*ProcessDocumentRequest) Reset

func (x *ProcessDocumentRequest) Reset()

func (*ProcessDocumentRequest) String

func (x *ProcessDocumentRequest) String() string

type ProcessDocumentResponse

type ProcessDocumentResponse struct {

	// Information about the input file. This is the same as the corresponding
	// input config in the request.
	InputConfig *InputConfig `protobuf:"bytes,1,opt,name=input_config,json=inputConfig,proto3" json:"input_config,omitempty"`
	// The output location of the parsed responses. The responses are written to
	// this location as JSON-serialized `Document` objects.
	OutputConfig *OutputConfig `protobuf:"bytes,2,opt,name=output_config,json=outputConfig,proto3" json:"output_config,omitempty"`
	// contains filtered or unexported fields
}

Response to a single document processing request.

func (*ProcessDocumentResponse) Descriptor deprecated

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

Deprecated: Use ProcessDocumentResponse.ProtoReflect.Descriptor instead.

func (*ProcessDocumentResponse) GetInputConfig

func (x *ProcessDocumentResponse) GetInputConfig() *InputConfig

func (*ProcessDocumentResponse) GetOutputConfig

func (x *ProcessDocumentResponse) GetOutputConfig() *OutputConfig

func (*ProcessDocumentResponse) ProtoMessage

func (*ProcessDocumentResponse) ProtoMessage()

func (*ProcessDocumentResponse) ProtoReflect

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

func (*ProcessDocumentResponse) Reset

func (x *ProcessDocumentResponse) Reset()

func (*ProcessDocumentResponse) String

func (x *ProcessDocumentResponse) String() string

type TableBoundHint

type TableBoundHint struct {

	// Optional. Page number for multi-paged inputs this hint applies to. If not
	// provided, this hint will apply to all pages by default. This value is
	// 1-based.
	PageNumber int32 `protobuf:"varint,1,opt,name=page_number,json=pageNumber,proto3" json:"page_number,omitempty"`
	// Bounding box hint for a table on this page. The coordinates must be
	// normalized to [0,1] and the bounding box must be an axis-aligned rectangle.
	BoundingBox *BoundingPoly `protobuf:"bytes,2,opt,name=bounding_box,json=boundingBox,proto3" json:"bounding_box,omitempty"`
	// contains filtered or unexported fields
}

A hint for a table bounding box on the page for table parsing.

func (*TableBoundHint) Descriptor deprecated

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

Deprecated: Use TableBoundHint.ProtoReflect.Descriptor instead.

func (*TableBoundHint) GetBoundingBox

func (x *TableBoundHint) GetBoundingBox() *BoundingPoly

func (*TableBoundHint) GetPageNumber

func (x *TableBoundHint) GetPageNumber() int32

func (*TableBoundHint) ProtoMessage

func (*TableBoundHint) ProtoMessage()

func (*TableBoundHint) ProtoReflect

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

func (*TableBoundHint) Reset

func (x *TableBoundHint) Reset()

func (*TableBoundHint) String

func (x *TableBoundHint) String() string

type TableExtractionParams

type TableExtractionParams struct {

	// Whether to enable table extraction.
	Enabled bool `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"`
	// Optional. Table bounding box hints that can be provided to complex cases
	// which our algorithm cannot locate the table(s) in.
	TableBoundHints []*TableBoundHint `protobuf:"bytes,2,rep,name=table_bound_hints,json=tableBoundHints,proto3" json:"table_bound_hints,omitempty"`
	// Optional. Table header hints. The extraction will bias towards producing
	// these terms as table headers, which may improve accuracy.
	HeaderHints []string `protobuf:"bytes,3,rep,name=header_hints,json=headerHints,proto3" json:"header_hints,omitempty"`
	// Model version of the table extraction system. Default is "builtin/stable".
	// Specify "builtin/latest" for the latest model.
	ModelVersion string `protobuf:"bytes,4,opt,name=model_version,json=modelVersion,proto3" json:"model_version,omitempty"`
	// contains filtered or unexported fields
}

Parameters to control table extraction behavior.

func (*TableExtractionParams) Descriptor deprecated

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

Deprecated: Use TableExtractionParams.ProtoReflect.Descriptor instead.

func (*TableExtractionParams) GetEnabled

func (x *TableExtractionParams) GetEnabled() bool

func (*TableExtractionParams) GetHeaderHints

func (x *TableExtractionParams) GetHeaderHints() []string

func (*TableExtractionParams) GetModelVersion

func (x *TableExtractionParams) GetModelVersion() string

func (*TableExtractionParams) GetTableBoundHints

func (x *TableExtractionParams) GetTableBoundHints() []*TableBoundHint

func (*TableExtractionParams) ProtoMessage

func (*TableExtractionParams) ProtoMessage()

func (*TableExtractionParams) ProtoReflect

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

func (*TableExtractionParams) Reset

func (x *TableExtractionParams) Reset()

func (*TableExtractionParams) String

func (x *TableExtractionParams) String() string

type UnimplementedDocumentUnderstandingServiceServer

type UnimplementedDocumentUnderstandingServiceServer struct {
}

UnimplementedDocumentUnderstandingServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedDocumentUnderstandingServiceServer) BatchProcessDocuments

func (*UnimplementedDocumentUnderstandingServiceServer) ProcessDocument

type Vertex

type Vertex struct {

	// X coordinate.
	X int32 `protobuf:"varint,1,opt,name=x,proto3" json:"x,omitempty"`
	// Y coordinate.
	Y int32 `protobuf:"varint,2,opt,name=y,proto3" json:"y,omitempty"`
	// contains filtered or unexported fields
}

A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

func (*Vertex) Descriptor deprecated

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

Deprecated: Use Vertex.ProtoReflect.Descriptor instead.

func (*Vertex) GetX

func (x *Vertex) GetX() int32

func (*Vertex) GetY

func (x *Vertex) GetY() int32

func (*Vertex) ProtoMessage

func (*Vertex) ProtoMessage()

func (*Vertex) ProtoReflect

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

func (*Vertex) Reset

func (x *Vertex) Reset()

func (*Vertex) String

func (x *Vertex) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL