documentai

package
v0.0.0-...-e165f0f Latest Latest
Warning

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

 Go to latest Published: Sep 1, 2020 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

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",
}
View Source 
var 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,
}
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",
}
View Source 
var Document_Page_Layout_Orientation_value = map[string]int32{
	"ORIENTATION_UNSPECIFIED": 0,
	"PAGE_UP":                 1,
	"PAGE_RIGHT":              2,
	"PAGE_DOWN":               3,
	"PAGE_LEFT":               4,
}
View Source 
var Document_Page_Token_DetectedBreak_Type_name = map[int32]string{
	0: "TYPE_UNSPECIFIED",
	1: "SPACE",
	2: "WIDE_SPACE",
	3: "HYPHEN",
}
View Source 
var Document_Page_Token_DetectedBreak_Type_value = map[string]int32{
	"TYPE_UNSPECIFIED": 0,
	"SPACE":            1,
	"WIDE_SPACE":       2,
	"HYPHEN":           3,
}
View Source 
var OperationMetadata_State_name = map[int32]string{
	0: "STATE_UNSPECIFIED",
	1: "ACCEPTED",
	2: "WAITING",
	3: "RUNNING",
	4: "SUCCEEDED",
	5: "CANCELLED",
	6: "FAILED",
}
View Source 
var OperationMetadata_State_value = map[string]int32{
	"STATE_UNSPECIFIED": 0,
	"ACCEPTED":          1,
	"WAITING":           2,
	"RUNNING":           3,
	"SUCCEEDED":         4,
	"CANCELLED":         5,
	"FAILED":            6,
}

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Parameters to control AutoML model prediction behavior.

func (*AutoMlParams) Descriptor 

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

func (*AutoMlParams) GetModel 

func (m *AutoMlParams) GetModel() string

func (*AutoMlParams) ProtoMessage 

func (*AutoMlParams) ProtoMessage()

func (*AutoMlParams) Reset 

func (m *AutoMlParams) Reset()

func (*AutoMlParams) String 

func (m *AutoMlParams) String() string

func (*AutoMlParams) XXX_DiscardUnknown 

func (m *AutoMlParams) XXX_DiscardUnknown()

func (*AutoMlParams) XXX_Marshal 

func (m *AutoMlParams) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*AutoMlParams) XXX_Merge 

func (m *AutoMlParams) XXX_Merge(src proto.Message)

func (*AutoMlParams) XXX_Size 

func (m *AutoMlParams) XXX_Size() int

func (*AutoMlParams) XXX_Unmarshal 

func (m *AutoMlParams) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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 

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

func (*BatchProcessDocumentsRequest) GetParent 

func (m *BatchProcessDocumentsRequest) GetParent() string

func (*BatchProcessDocumentsRequest) GetRequests 

func (m *BatchProcessDocumentsRequest) GetRequests() []*ProcessDocumentRequest

func (*BatchProcessDocumentsRequest) ProtoMessage 

func (*BatchProcessDocumentsRequest) ProtoMessage()

func (*BatchProcessDocumentsRequest) Reset 

func (m *BatchProcessDocumentsRequest) Reset()

func (*BatchProcessDocumentsRequest) String 

func (m *BatchProcessDocumentsRequest) String() string

func (*BatchProcessDocumentsRequest) XXX_DiscardUnknown 

func (m *BatchProcessDocumentsRequest) XXX_DiscardUnknown()

func (*BatchProcessDocumentsRequest) XXX_Marshal 

func (m *BatchProcessDocumentsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*BatchProcessDocumentsRequest) XXX_Merge 

func (m *BatchProcessDocumentsRequest) XXX_Merge(src proto.Message)

func (*BatchProcessDocumentsRequest) XXX_Size 

func (m *BatchProcessDocumentsRequest) XXX_Size() int

func (*BatchProcessDocumentsRequest) XXX_Unmarshal 

func (m *BatchProcessDocumentsRequest) XXX_Unmarshal(b []byte) error

type BatchProcessDocumentsResponse 

type BatchProcessDocumentsResponse struct {
	// Responses for each individual document.
	Responses            []*ProcessDocumentResponse `protobuf:"bytes,1,rep,name=responses,proto3" json:"responses,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                   `json:"-"`
	XXX_unrecognized     []byte                     `json:"-"`
	XXX_sizecache        int32                      `json:"-"`
}

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

func (*BatchProcessDocumentsResponse) Descriptor 

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

func (*BatchProcessDocumentsResponse) GetResponses 

func (m *BatchProcessDocumentsResponse) GetResponses() []*ProcessDocumentResponse

func (*BatchProcessDocumentsResponse) ProtoMessage 

func (*BatchProcessDocumentsResponse) ProtoMessage()

func (*BatchProcessDocumentsResponse) Reset 

func (m *BatchProcessDocumentsResponse) Reset()

func (*BatchProcessDocumentsResponse) String 

func (m *BatchProcessDocumentsResponse) String() string

func (*BatchProcessDocumentsResponse) XXX_DiscardUnknown 

func (m *BatchProcessDocumentsResponse) XXX_DiscardUnknown()

func (*BatchProcessDocumentsResponse) XXX_Marshal 

func (m *BatchProcessDocumentsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*BatchProcessDocumentsResponse) XXX_Merge 

func (m *BatchProcessDocumentsResponse) XXX_Merge(src proto.Message)

func (*BatchProcessDocumentsResponse) XXX_Size 

func (m *BatchProcessDocumentsResponse) XXX_Size() int

func (*BatchProcessDocumentsResponse) XXX_Unmarshal 

func (m *BatchProcessDocumentsResponse) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{}            `json:"-"`
	XXX_unrecognized     []byte              `json:"-"`
	XXX_sizecache        int32               `json:"-"`
}

A bounding polygon for the detected image annotation.

func (*BoundingPoly) Descriptor 

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

func (*BoundingPoly) GetNormalizedVertices 

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

func (*BoundingPoly) GetVertices 

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

func (*BoundingPoly) ProtoMessage 

func (*BoundingPoly) ProtoMessage()

func (*BoundingPoly) Reset 

func (m *BoundingPoly) Reset()

func (*BoundingPoly) String 

func (m *BoundingPoly) String() string

func (*BoundingPoly) XXX_DiscardUnknown 

func (m *BoundingPoly) XXX_DiscardUnknown()

func (*BoundingPoly) XXX_Marshal 

func (m *BoundingPoly) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*BoundingPoly) XXX_Merge 

func (m *BoundingPoly) XXX_Merge(src proto.Message)

func (*BoundingPoly) XXX_Size 

func (m *BoundingPoly) XXX_Size() int

func (*BoundingPoly) XXX_Unmarshal 

func (m *BoundingPoly) XXX_Unmarshal(b []byte) error

type Document 

type Document struct {
	// Original source document from the user.
	//
	// Types that are valid to be assigned 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"`
	XXX_NoUnkeyedLiteral struct{}       `json:"-"`
	XXX_unrecognized     []byte         `json:"-"`
	XXX_sizecache        int32          `json:"-"`
}

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 

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

func (*Document) GetContent 

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

func (*Document) GetEntities 

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

func (*Document) GetEntityRelations 

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

func (*Document) GetError 

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

func (*Document) GetLabels 

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

func (*Document) GetMimeType 

func (m *Document) GetMimeType() string

func (*Document) GetPages 

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

func (*Document) GetShardInfo 

func (m *Document) GetShardInfo() *Document_ShardInfo

func (*Document) GetSource 

func (m *Document) GetSource() isDocument_Source

func (*Document) GetText 

func (m *Document) GetText() string

func (*Document) GetTextStyles 

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

func (*Document) GetUri 

func (m *Document) GetUri() string

func (*Document) ProtoMessage 

func (*Document) ProtoMessage()

func (*Document) Reset 

func (m *Document) Reset()

func (*Document) String 

func (m *Document) String() string

func (*Document) XXX_DiscardUnknown 

func (m *Document) XXX_DiscardUnknown()

func (*Document) XXX_Marshal 

func (m *Document) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Document) XXX_Merge 

func (m *Document) XXX_Merge(src proto.Message)

func (*Document) XXX_OneofWrappers 

func (*Document) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*Document) XXX_Size 

func (m *Document) XXX_Size() int

func (*Document) XXX_Unmarshal 

func (m *Document) XXX_Unmarshal(b []byte) error

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.

func NewDocumentUnderstandingServiceClient 

func NewDocumentUnderstandingServiceClient(cc grpc.ClientConnInterface) DocumentUnderstandingServiceClient

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 {
	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"`
	// 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"`
	// Optional. Temporary field to store the bounding poly for short-term POCs. Used by
	// the frontend only. Do not use before you talk to ybo@ and lukasr@.
	BoundingPolyForDemoFrontend *BoundingPoly `` /* 148-byte string literal not displayed */
	XXX_NoUnkeyedLiteral        struct{}      `json:"-"`
	XXX_unrecognized            []byte        `json:"-"`
	XXX_sizecache               int32         `json:"-"`
}

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

func (*Document_Entity) Descriptor 

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

func (*Document_Entity) GetBoundingPolyForDemoFrontend 

func (m *Document_Entity) GetBoundingPolyForDemoFrontend() *BoundingPoly

func (*Document_Entity) GetConfidence 

func (m *Document_Entity) GetConfidence() float32

func (*Document_Entity) GetId 

func (m *Document_Entity) GetId() string

func (*Document_Entity) GetMentionId 

func (m *Document_Entity) GetMentionId() string

func (*Document_Entity) GetMentionText 

func (m *Document_Entity) GetMentionText() string

func (*Document_Entity) GetPageAnchor 

func (m *Document_Entity) GetPageAnchor() *Document_PageAnchor

func (*Document_Entity) GetTextAnchor 

func (m *Document_Entity) GetTextAnchor() *Document_TextAnchor

func (*Document_Entity) GetType 

func (m *Document_Entity) GetType() string

func (*Document_Entity) ProtoMessage 

func (*Document_Entity) ProtoMessage()

func (*Document_Entity) Reset 

func (m *Document_Entity) Reset()

func (*Document_Entity) String 

func (m *Document_Entity) String() string

func (*Document_Entity) XXX_DiscardUnknown 

func (m *Document_Entity) XXX_DiscardUnknown()

func (*Document_Entity) XXX_Marshal 

func (m *Document_Entity) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Document_Entity) XXX_Merge 

func (m *Document_Entity) XXX_Merge(src proto.Message)

func (*Document_Entity) XXX_Size 

func (m *Document_Entity) XXX_Size() int

func (*Document_Entity) XXX_Unmarshal 

func (m *Document_Entity) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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

func (*Document_EntityRelation) Descriptor 

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

func (*Document_EntityRelation) GetObjectId 

func (m *Document_EntityRelation) GetObjectId() string

func (*Document_EntityRelation) GetRelation 

func (m *Document_EntityRelation) GetRelation() string

func (*Document_EntityRelation) GetSubjectId 

func (m *Document_EntityRelation) GetSubjectId() string

func (*Document_EntityRelation) ProtoMessage 

func (*Document_EntityRelation) ProtoMessage()

func (*Document_EntityRelation) Reset 

func (m *Document_EntityRelation) Reset()

func (*Document_EntityRelation) String 

func (m *Document_EntityRelation) String() string

func (*Document_EntityRelation) XXX_DiscardUnknown 

func (m *Document_EntityRelation) XXX_DiscardUnknown()

func (*Document_EntityRelation) XXX_Marshal 

func (m *Document_EntityRelation) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Document_EntityRelation) XXX_Merge 

func (m *Document_EntityRelation) XXX_Merge(src proto.Message)

func (*Document_EntityRelation) XXX_Size 

func (m *Document_EntityRelation) XXX_Size() int

func (*Document_EntityRelation) XXX_Unmarshal 

func (m *Document_EntityRelation) XXX_Unmarshal(b []byte) error

type Document_Label 

type Document_Label struct {
	// Provenance of the label.
	//
	// Types that are valid to be assigned 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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 

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

func (*Document_Label) GetAutomlModel 

func (m *Document_Label) GetAutomlModel() string

func (*Document_Label) GetConfidence 

func (m *Document_Label) GetConfidence() float32

func (*Document_Label) GetName 

func (m *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) Reset 

func (m *Document_Label) Reset()

func (*Document_Label) String 

func (m *Document_Label) String() string

func (*Document_Label) XXX_DiscardUnknown 

func (m *Document_Label) XXX_DiscardUnknown()

func (*Document_Label) XXX_Marshal 

func (m *Document_Label) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Document_Label) XXX_Merge 

func (m *Document_Label) XXX_Merge(src proto.Message)

func (*Document_Label) XXX_OneofWrappers 

func (*Document_Label) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*Document_Label) XXX_Size 

func (m *Document_Label) XXX_Size() int

func (*Document_Label) XXX_Unmarshal 

func (m *Document_Label) XXX_Unmarshal(b []byte) error

type Document_Label_AutomlModel 

type Document_Label_AutomlModel struct {
	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"`
	XXX_NoUnkeyedLiteral struct{}                   `json:"-"`
	XXX_unrecognized     []byte                     `json:"-"`
	XXX_sizecache        int32                      `json:"-"`
}

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

func (*Document_Page) Descriptor 

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

func (*Document_Page) GetBlocks 

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

func (*Document_Page) GetDetectedLanguages 

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

func (*Document_Page) GetDimension 

func (m *Document_Page) GetDimension() *Document_Page_Dimension

func (*Document_Page) GetFormFields 

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

func (*Document_Page) GetLayout 

func (m *Document_Page) GetLayout() *Document_Page_Layout

func (*Document_Page) GetLines 

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

func (*Document_Page) GetPageNumber 

func (m *Document_Page) GetPageNumber() int32

func (*Document_Page) GetParagraphs 

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

func (*Document_Page) GetTables 

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

func (*Document_Page) GetTokens 

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

func (*Document_Page) GetVisualElements 

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

func (*Document_Page) ProtoMessage 

func (*Document_Page) ProtoMessage()

func (*Document_Page) Reset 

func (m *Document_Page) Reset()

func (*Document_Page) String 

func (m *Document_Page) String() string

func (*Document_Page) XXX_DiscardUnknown 

func (m *Document_Page) XXX_DiscardUnknown()

func (*Document_Page) XXX_Marshal 

func (m *Document_Page) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Document_Page) XXX_Merge 

func (m *Document_Page) XXX_Merge(src proto.Message)

func (*Document_Page) XXX_Size 

func (m *Document_Page) XXX_Size() int

func (*Document_Page) XXX_Unmarshal 

func (m *Document_Page) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{}                       `json:"-"`
	XXX_unrecognized     []byte                         `json:"-"`
	XXX_sizecache        int32                          `json:"-"`
}

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

func (*Document_PageAnchor) Descriptor 

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

func (*Document_PageAnchor) GetPageRefs 

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

func (*Document_PageAnchor) ProtoMessage 

func (*Document_PageAnchor) ProtoMessage()

func (*Document_PageAnchor) Reset 

func (m *Document_PageAnchor) Reset()

func (*Document_PageAnchor) String 

func (m *Document_PageAnchor) String() string

func (*Document_PageAnchor) XXX_DiscardUnknown 

func (m *Document_PageAnchor) XXX_DiscardUnknown()

func (*Document_PageAnchor) XXX_Marshal 

func (m *Document_PageAnchor) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Document_PageAnchor) XXX_Merge 

func (m *Document_PageAnchor) XXX_Merge(src proto.Message)

func (*Document_PageAnchor) XXX_Size 

func (m *Document_PageAnchor) XXX_Size() int

func (*Document_PageAnchor) XXX_Unmarshal 

func (m *Document_PageAnchor) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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

func (*Document_PageAnchor_PageRef) Descriptor 

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

func (*Document_PageAnchor_PageRef) GetLayoutId 

func (m *Document_PageAnchor_PageRef) GetLayoutId() string

func (*Document_PageAnchor_PageRef) GetLayoutType 

func (m *Document_PageAnchor_PageRef) GetLayoutType() Document_PageAnchor_PageRef_LayoutType

func (*Document_PageAnchor_PageRef) GetPage 

func (m *Document_PageAnchor_PageRef) GetPage() int64

func (*Document_PageAnchor_PageRef) ProtoMessage 

func (*Document_PageAnchor_PageRef) ProtoMessage()

func (*Document_PageAnchor_PageRef) Reset 

func (m *Document_PageAnchor_PageRef) Reset()

func (*Document_PageAnchor_PageRef) String 

func (m *Document_PageAnchor_PageRef) String() string

func (*Document_PageAnchor_PageRef) XXX_DiscardUnknown 

func (m *Document_PageAnchor_PageRef) XXX_DiscardUnknown()

func (*Document_PageAnchor_PageRef) XXX_Marshal 

func (m *Document_PageAnchor_PageRef) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Document_PageAnchor_PageRef) XXX_Merge 

func (m *Document_PageAnchor_PageRef) XXX_Merge(src proto.Message)

func (*Document_PageAnchor_PageRef) XXX_Size 

func (m *Document_PageAnchor_PageRef) XXX_Size() int

func (*Document_PageAnchor_PageRef) XXX_Unmarshal 

func (m *Document_PageAnchor_PageRef) XXX_Unmarshal(b []byte) error

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

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

func (Document_PageAnchor_PageRef_LayoutType) String 

func (x Document_PageAnchor_PageRef_LayoutType) String() string

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"`
	XXX_NoUnkeyedLiteral struct{}                          `json:"-"`
	XXX_unrecognized     []byte                            `json:"-"`
	XXX_sizecache        int32                             `json:"-"`
}

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

func (*Document_Page_Block) Descriptor 

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

func (*Document_Page_Block) GetDetectedLanguages 

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

func (*Document_Page_Block) GetLayout 

func (m *Document_Page_Block) GetLayout() *Document_Page_Layout

func (*Document_Page_Block) ProtoMessage 

func (*Document_Page_Block) ProtoMessage()

func (*Document_Page_Block) Reset 

func (m *Document_Page_Block) Reset()

func (*Document_Page_Block) String 

func (m *Document_Page_Block) String() string

func (*Document_Page_Block) XXX_DiscardUnknown 

func (m *Document_Page_Block) XXX_DiscardUnknown()

func (*Document_Page_Block) XXX_Marshal 

func (m *Document_Page_Block) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Document_Page_Block) XXX_Merge 

func (m *Document_Page_Block) XXX_Merge(src proto.Message)

func (*Document_Page_Block) XXX_Size 

func (m *Document_Page_Block) XXX_Size() int

func (*Document_Page_Block) XXX_Unmarshal 

func (m *Document_Page_Block) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Detected language for a structural component.

func (*Document_Page_DetectedLanguage) Descriptor 

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

func (*Document_Page_DetectedLanguage) GetConfidence 

func (m *Document_Page_DetectedLanguage) GetConfidence() float32

func (*Document_Page_DetectedLanguage) GetLanguageCode 

func (m *Document_Page_DetectedLanguage) GetLanguageCode() string

func (*Document_Page_DetectedLanguage) ProtoMessage 

func (*Document_Page_DetectedLanguage) ProtoMessage()

func (*Document_Page_DetectedLanguage) Reset 

func (m *Document_Page_DetectedLanguage) Reset()

func (*Document_Page_DetectedLanguage) String 

func (m *Document_Page_DetectedLanguage) String() string

func (*Document_Page_DetectedLanguage) XXX_DiscardUnknown 

func (m *Document_Page_DetectedLanguage) XXX_DiscardUnknown()

func (*Document_Page_DetectedLanguage) XXX_Marshal 

func (m *Document_Page_DetectedLanguage) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Document_Page_DetectedLanguage) XXX_Merge 

func (m *Document_Page_DetectedLanguage) XXX_Merge(src proto.Message)

func (*Document_Page_DetectedLanguage) XXX_Size 

func (m *Document_Page_DetectedLanguage) XXX_Size() int

func (*Document_Page_DetectedLanguage) XXX_Unmarshal 

func (m *Document_Page_DetectedLanguage) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Dimension for the page.

func (*Document_Page_Dimension) Descriptor 

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

func (*Document_Page_Dimension) GetHeight 

func (m *Document_Page_Dimension) GetHeight() float32

func (*Document_Page_Dimension) GetUnit 

func (m *Document_Page_Dimension) GetUnit() string

func (*Document_Page_Dimension) GetWidth 

func (m *Document_Page_Dimension) GetWidth() float32

func (*Document_Page_Dimension) ProtoMessage 

func (*Document_Page_Dimension) ProtoMessage()

func (*Document_Page_Dimension) Reset 

func (m *Document_Page_Dimension) Reset()

func (*Document_Page_Dimension) String 

func (m *Document_Page_Dimension) String() string

func (*Document_Page_Dimension) XXX_DiscardUnknown 

func (m *Document_Page_Dimension) XXX_DiscardUnknown()

func (*Document_Page_Dimension) XXX_Marshal 

func (m *Document_Page_Dimension) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Document_Page_Dimension) XXX_Merge 

func (m *Document_Page_Dimension) XXX_Merge(src proto.Message)

func (*Document_Page_Dimension) XXX_Size 

func (m *Document_Page_Dimension) XXX_Size() int

func (*Document_Page_Dimension) XXX_Unmarshal 

func (m *Document_Page_Dimension) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

A form field detected on the page.

func (*Document_Page_FormField) Descriptor 

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

func (*Document_Page_FormField) GetCorrectedKeyText 

func (m *Document_Page_FormField) GetCorrectedKeyText() string

func (*Document_Page_FormField) GetCorrectedValueText 

func (m *Document_Page_FormField) GetCorrectedValueText() string

func (*Document_Page_FormField) GetFieldName 

func (m *Document_Page_FormField) GetFieldName() *Document_Page_Layout

func (*Document_Page_FormField) GetFieldValue 

func (m *Document_Page_FormField) GetFieldValue() *Document_Page_Layout

func (*Document_Page_FormField) GetNameDetectedLanguages 

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

func (*Document_Page_FormField) GetValueDetectedLanguages 

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

func (*Document_Page_FormField) GetValueType 

func (m *Document_Page_FormField) GetValueType() string

func (*Document_Page_FormField) ProtoMessage 

func (*Document_Page_FormField) ProtoMessage()

func (*Document_Page_FormField) Reset 

func (m *Document_Page_FormField) Reset()

func (*Document_Page_FormField) String 

func (m *Document_Page_FormField) String() string

func (*Document_Page_FormField) XXX_DiscardUnknown 

func (m *Document_Page_FormField) XXX_DiscardUnknown()

func (*Document_Page_FormField) XXX_Marshal 

func (m *Document_Page_FormField) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Document_Page_FormField) XXX_Merge 

func (m *Document_Page_FormField) XXX_Merge(src proto.Message)

func (*Document_Page_FormField) XXX_Size 

func (m *Document_Page_FormField) XXX_Size() int

func (*Document_Page_FormField) XXX_Unmarshal 

func (m *Document_Page_FormField) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Visual element describing a layout unit on a page.

func (*Document_Page_Layout) Descriptor 

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

func (*Document_Page_Layout) GetBoundingPoly 

func (m *Document_Page_Layout) GetBoundingPoly() *BoundingPoly

func (*Document_Page_Layout) GetConfidence 

func (m *Document_Page_Layout) GetConfidence() float32

func (*Document_Page_Layout) GetId 

func (m *Document_Page_Layout) GetId() string

func (*Document_Page_Layout) GetOrientation 

func (m *Document_Page_Layout) GetOrientation() Document_Page_Layout_Orientation

func (*Document_Page_Layout) GetTextAnchor 

func (m *Document_Page_Layout) GetTextAnchor() *Document_TextAnchor

func (*Document_Page_Layout) ProtoMessage 

func (*Document_Page_Layout) ProtoMessage()

func (*Document_Page_Layout) Reset 

func (m *Document_Page_Layout) Reset()

func (*Document_Page_Layout) String 

func (m *Document_Page_Layout) String() string

func (*Document_Page_Layout) XXX_DiscardUnknown 

func (m *Document_Page_Layout) XXX_DiscardUnknown()

func (*Document_Page_Layout) XXX_Marshal 

func (m *Document_Page_Layout) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Document_Page_Layout) XXX_Merge 

func (m *Document_Page_Layout) XXX_Merge(src proto.Message)

func (*Document_Page_Layout) XXX_Size 

func (m *Document_Page_Layout) XXX_Size() int

func (*Document_Page_Layout) XXX_Unmarshal 

func (m *Document_Page_Layout) XXX_Unmarshal(b []byte) error

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

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

func (Document_Page_Layout_Orientation) String 

func (x Document_Page_Layout_Orientation) String() string

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"`
	XXX_NoUnkeyedLiteral struct{}                          `json:"-"`
	XXX_unrecognized     []byte                            `json:"-"`
	XXX_sizecache        int32                             `json:"-"`
}

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

func (*Document_Page_Line) Descriptor 

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

func (*Document_Page_Line) GetDetectedLanguages 

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

func (*Document_Page_Line) GetLayout 

func (m *Document_Page_Line) GetLayout() *Document_Page_Layout

func (*Document_Page_Line) ProtoMessage 

func (*Document_Page_Line) ProtoMessage()

func (*Document_Page_Line) Reset 

func (m *Document_Page_Line) Reset()

func (*Document_Page_Line) String 

func (m *Document_Page_Line) String() string

func (*Document_Page_Line) XXX_DiscardUnknown 

func (m *Document_Page_Line) XXX_DiscardUnknown()

func (*Document_Page_Line) XXX_Marshal 

func (m *Document_Page_Line) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Document_Page_Line) XXX_Merge 

func (m *Document_Page_Line) XXX_Merge(src proto.Message)

func (*Document_Page_Line) XXX_Size 

func (m *Document_Page_Line) XXX_Size() int

func (*Document_Page_Line) XXX_Unmarshal 

func (m *Document_Page_Line) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{}                          `json:"-"`
	XXX_unrecognized     []byte                            `json:"-"`
	XXX_sizecache        int32                             `json:"-"`
}

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

func (*Document_Page_Paragraph) Descriptor 

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

func (*Document_Page_Paragraph) GetDetectedLanguages 

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

func (*Document_Page_Paragraph) GetLayout 

func (m *Document_Page_Paragraph) GetLayout() *Document_Page_Layout

func (*Document_Page_Paragraph) ProtoMessage 

func (*Document_Page_Paragraph) ProtoMessage()

func (*Document_Page_Paragraph) Reset 

func (m *Document_Page_Paragraph) Reset()

func (*Document_Page_Paragraph) String 

func (m *Document_Page_Paragraph) String() string

func (*Document_Page_Paragraph) XXX_DiscardUnknown 

func (m *Document_Page_Paragraph) XXX_DiscardUnknown()

func (*Document_Page_Paragraph) XXX_Marshal 

func (m *Document_Page_Paragraph) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Document_Page_Paragraph) XXX_Merge 

func (m *Document_Page_Paragraph) XXX_Merge(src proto.Message)

func (*Document_Page_Paragraph) XXX_Size 

func (m *Document_Page_Paragraph) XXX_Size() int

func (*Document_Page_Paragraph) XXX_Unmarshal 

func (m *Document_Page_Paragraph) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{}                          `json:"-"`
	XXX_unrecognized     []byte                            `json:"-"`
	XXX_sizecache        int32                             `json:"-"`
}

A table representation similar to HTML table structure.

func (*Document_Page_Table) Descriptor 

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

func (*Document_Page_Table) GetBodyRows 

func (m *Document_Page_Table) GetBodyRows() []*Document_Page_Table_TableRow

func (*Document_Page_Table) GetDetectedLanguages 

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

func (*Document_Page_Table) GetHeaderRows 

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

func (*Document_Page_Table) GetLayout 

func (m *Document_Page_Table) GetLayout() *Document_Page_Layout

func (*Document_Page_Table) ProtoMessage 

func (*Document_Page_Table) ProtoMessage()

func (*Document_Page_Table) Reset 

func (m *Document_Page_Table) Reset()

func (*Document_Page_Table) String 

func (m *Document_Page_Table) String() string

func (*Document_Page_Table) XXX_DiscardUnknown 

func (m *Document_Page_Table) XXX_DiscardUnknown()

func (*Document_Page_Table) XXX_Marshal 

func (m *Document_Page_Table) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Document_Page_Table) XXX_Merge 

func (m *Document_Page_Table) XXX_Merge(src proto.Message)

func (*Document_Page_Table) XXX_Size 

func (m *Document_Page_Table) XXX_Size() int

func (*Document_Page_Table) XXX_Unmarshal 

func (m *Document_Page_Table) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{}                          `json:"-"`
	XXX_unrecognized     []byte                            `json:"-"`
	XXX_sizecache        int32                             `json:"-"`
}

A cell representation inside the table.

func (*Document_Page_Table_TableCell) Descriptor 

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

func (*Document_Page_Table_TableCell) GetColSpan 

func (m *Document_Page_Table_TableCell) GetColSpan() int32

func (*Document_Page_Table_TableCell) GetDetectedLanguages 

func (m *Document_Page_Table_TableCell) GetDetectedLanguages() []*Document_Page_DetectedLanguage

func (*Document_Page_Table_TableCell) GetLayout 

func (m *Document_Page_Table_TableCell) GetLayout() *Document_Page_Layout

func (*Document_Page_Table_TableCell) GetRowSpan 

func (m *Document_Page_Table_TableCell) GetRowSpan() int32

func (*Document_Page_Table_TableCell) ProtoMessage 

func (*Document_Page_Table_TableCell) ProtoMessage()

func (*Document_Page_Table_TableCell) Reset 

func (m *Document_Page_Table_TableCell) Reset()

func (*Document_Page_Table_TableCell) String 

func (m *Document_Page_Table_TableCell) String() string

func (*Document_Page_Table_TableCell) XXX_DiscardUnknown 

func (m *Document_Page_Table_TableCell) XXX_DiscardUnknown()

func (*Document_Page_Table_TableCell) XXX_Marshal 

func (m *Document_Page_Table_TableCell) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Document_Page_Table_TableCell) XXX_Merge 

func (m *Document_Page_Table_TableCell) XXX_Merge(src proto.Message)

func (*Document_Page_Table_TableCell) XXX_Size 

func (m *Document_Page_Table_TableCell) XXX_Size() int

func (*Document_Page_Table_TableCell) XXX_Unmarshal 

func (m *Document_Page_Table_TableCell) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{}                         `json:"-"`
	XXX_unrecognized     []byte                           `json:"-"`
	XXX_sizecache        int32                            `json:"-"`
}

A row of table cells.

func (*Document_Page_Table_TableRow) Descriptor 

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

func (*Document_Page_Table_TableRow) GetCells 

func (m *Document_Page_Table_TableRow) GetCells() []*Document_Page_Table_TableCell

func (*Document_Page_Table_TableRow) ProtoMessage 

func (*Document_Page_Table_TableRow) ProtoMessage()

func (*Document_Page_Table_TableRow) Reset 

func (m *Document_Page_Table_TableRow) Reset()

func (*Document_Page_Table_TableRow) String 

func (m *Document_Page_Table_TableRow) String() string

func (*Document_Page_Table_TableRow) XXX_DiscardUnknown 

func (m *Document_Page_Table_TableRow) XXX_DiscardUnknown()

func (*Document_Page_Table_TableRow) XXX_Marshal 

func (m *Document_Page_Table_TableRow) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Document_Page_Table_TableRow) XXX_Merge 

func (m *Document_Page_Table_TableRow) XXX_Merge(src proto.Message)

func (*Document_Page_Table_TableRow) XXX_Size 

func (m *Document_Page_Table_TableRow) XXX_Size() int

func (*Document_Page_Table_TableRow) XXX_Unmarshal 

func (m *Document_Page_Table_TableRow) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{}                          `json:"-"`
	XXX_unrecognized     []byte                            `json:"-"`
	XXX_sizecache        int32                             `json:"-"`
}

A detected token.

func (*Document_Page_Token) Descriptor 

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

func (*Document_Page_Token) GetDetectedBreak 

func (m *Document_Page_Token) GetDetectedBreak() *Document_Page_Token_DetectedBreak

func (*Document_Page_Token) GetDetectedLanguages 

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

func (*Document_Page_Token) GetLayout 

func (m *Document_Page_Token) GetLayout() *Document_Page_Layout

func (*Document_Page_Token) ProtoMessage 

func (*Document_Page_Token) ProtoMessage()

func (*Document_Page_Token) Reset 

func (m *Document_Page_Token) Reset()

func (*Document_Page_Token) String 

func (m *Document_Page_Token) String() string

func (*Document_Page_Token) XXX_DiscardUnknown 

func (m *Document_Page_Token) XXX_DiscardUnknown()

func (*Document_Page_Token) XXX_Marshal 

func (m *Document_Page_Token) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Document_Page_Token) XXX_Merge 

func (m *Document_Page_Token) XXX_Merge(src proto.Message)

func (*Document_Page_Token) XXX_Size 

func (m *Document_Page_Token) XXX_Size() int

func (*Document_Page_Token) XXX_Unmarshal 

func (m *Document_Page_Token) XXX_Unmarshal(b []byte) error

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 */
	XXX_NoUnkeyedLiteral struct{}                               `json:"-"`
	XXX_unrecognized     []byte                                 `json:"-"`
	XXX_sizecache        int32                                  `json:"-"`
}

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

func (*Document_Page_Token_DetectedBreak) Descriptor 

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

func (*Document_Page_Token_DetectedBreak) GetType 

func (m *Document_Page_Token_DetectedBreak) GetType() Document_Page_Token_DetectedBreak_Type

func (*Document_Page_Token_DetectedBreak) ProtoMessage 

func (*Document_Page_Token_DetectedBreak) ProtoMessage()

func (*Document_Page_Token_DetectedBreak) Reset 

func (m *Document_Page_Token_DetectedBreak) Reset()

func (*Document_Page_Token_DetectedBreak) String 

func (m *Document_Page_Token_DetectedBreak) String() string

func (*Document_Page_Token_DetectedBreak) XXX_DiscardUnknown 

func (m *Document_Page_Token_DetectedBreak) XXX_DiscardUnknown()

func (*Document_Page_Token_DetectedBreak) XXX_Marshal 

func (m *Document_Page_Token_DetectedBreak) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Document_Page_Token_DetectedBreak) XXX_Merge 

func (m *Document_Page_Token_DetectedBreak) XXX_Merge(src proto.Message)

func (*Document_Page_Token_DetectedBreak) XXX_Size 

func (m *Document_Page_Token_DetectedBreak) XXX_Size() int

func (*Document_Page_Token_DetectedBreak) XXX_Unmarshal 

func (m *Document_Page_Token_DetectedBreak) XXX_Unmarshal(b []byte) error

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

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

func (Document_Page_Token_DetectedBreak_Type) String 

func (x Document_Page_Token_DetectedBreak_Type) String() string

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"`
	XXX_NoUnkeyedLiteral struct{}                          `json:"-"`
	XXX_unrecognized     []byte                            `json:"-"`
	XXX_sizecache        int32                             `json:"-"`
}

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

func (*Document_Page_VisualElement) Descriptor 

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

func (*Document_Page_VisualElement) GetDetectedLanguages 

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

func (*Document_Page_VisualElement) GetLayout 

func (m *Document_Page_VisualElement) GetLayout() *Document_Page_Layout

func (*Document_Page_VisualElement) GetType 

func (m *Document_Page_VisualElement) GetType() string

func (*Document_Page_VisualElement) ProtoMessage 

func (*Document_Page_VisualElement) ProtoMessage()

func (*Document_Page_VisualElement) Reset 

func (m *Document_Page_VisualElement) Reset()

func (*Document_Page_VisualElement) String 

func (m *Document_Page_VisualElement) String() string

func (*Document_Page_VisualElement) XXX_DiscardUnknown 

func (m *Document_Page_VisualElement) XXX_DiscardUnknown()

func (*Document_Page_VisualElement) XXX_Marshal 

func (m *Document_Page_VisualElement) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Document_Page_VisualElement) XXX_Merge 

func (m *Document_Page_VisualElement) XXX_Merge(src proto.Message)

func (*Document_Page_VisualElement) XXX_Size 

func (m *Document_Page_VisualElement) XXX_Size() int

func (*Document_Page_VisualElement) XXX_Unmarshal 

func (m *Document_Page_VisualElement) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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

func (*Document_ShardInfo) Descriptor 

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

func (*Document_ShardInfo) GetShardCount 

func (m *Document_ShardInfo) GetShardCount() int64

func (*Document_ShardInfo) GetShardIndex 

func (m *Document_ShardInfo) GetShardIndex() int64

func (*Document_ShardInfo) GetTextOffset 

func (m *Document_ShardInfo) GetTextOffset() int64

func (*Document_ShardInfo) ProtoMessage 

func (*Document_ShardInfo) ProtoMessage()

func (*Document_ShardInfo) Reset 

func (m *Document_ShardInfo) Reset()

func (*Document_ShardInfo) String 

func (m *Document_ShardInfo) String() string

func (*Document_ShardInfo) XXX_DiscardUnknown 

func (m *Document_ShardInfo) XXX_DiscardUnknown()

func (*Document_ShardInfo) XXX_Marshal 

func (m *Document_ShardInfo) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Document_ShardInfo) XXX_Merge 

func (m *Document_ShardInfo) XXX_Merge(src proto.Message)

func (*Document_ShardInfo) XXX_Size 

func (m *Document_ShardInfo) XXX_Size() int

func (*Document_ShardInfo) XXX_Unmarshal 

func (m *Document_ShardInfo) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{}                 `json:"-"`
	XXX_unrecognized     []byte                   `json:"-"`
	XXX_sizecache        int32                    `json:"-"`
}

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

func (*Document_Style) Descriptor 

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

func (*Document_Style) GetBackgroundColor 

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

func (*Document_Style) GetColor 

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

func (*Document_Style) GetFontSize 

func (m *Document_Style) GetFontSize() *Document_Style_FontSize

func (*Document_Style) GetFontWeight 

func (m *Document_Style) GetFontWeight() string

func (*Document_Style) GetTextAnchor 

func (m *Document_Style) GetTextAnchor() *Document_TextAnchor

func (*Document_Style) GetTextDecoration 

func (m *Document_Style) GetTextDecoration() string

func (*Document_Style) GetTextStyle 

func (m *Document_Style) GetTextStyle() string

func (*Document_Style) ProtoMessage 

func (*Document_Style) ProtoMessage()

func (*Document_Style) Reset 

func (m *Document_Style) Reset()

func (*Document_Style) String 

func (m *Document_Style) String() string

func (*Document_Style) XXX_DiscardUnknown 

func (m *Document_Style) XXX_DiscardUnknown()

func (*Document_Style) XXX_Marshal 

func (m *Document_Style) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Document_Style) XXX_Merge 

func (m *Document_Style) XXX_Merge(src proto.Message)

func (*Document_Style) XXX_Size 

func (m *Document_Style) XXX_Size() int

func (*Document_Style) XXX_Unmarshal 

func (m *Document_Style) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Font size with unit.

func (*Document_Style_FontSize) Descriptor 

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

func (*Document_Style_FontSize) GetSize 

func (m *Document_Style_FontSize) GetSize() float32

func (*Document_Style_FontSize) GetUnit 

func (m *Document_Style_FontSize) GetUnit() string

func (*Document_Style_FontSize) ProtoMessage 

func (*Document_Style_FontSize) ProtoMessage()

func (*Document_Style_FontSize) Reset 

func (m *Document_Style_FontSize) Reset()

func (*Document_Style_FontSize) String 

func (m *Document_Style_FontSize) String() string

func (*Document_Style_FontSize) XXX_DiscardUnknown 

func (m *Document_Style_FontSize) XXX_DiscardUnknown()

func (*Document_Style_FontSize) XXX_Marshal 

func (m *Document_Style_FontSize) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Document_Style_FontSize) XXX_Merge 

func (m *Document_Style_FontSize) XXX_Merge(src proto.Message)

func (*Document_Style_FontSize) XXX_Size 

func (m *Document_Style_FontSize) XXX_Size() int

func (*Document_Style_FontSize) XXX_Unmarshal 

func (m *Document_Style_FontSize) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{}                           `json:"-"`
	XXX_unrecognized     []byte                             `json:"-"`
	XXX_sizecache        int32                              `json:"-"`
}

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

func (*Document_TextAnchor) Descriptor 

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

func (*Document_TextAnchor) GetTextSegments 

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

func (*Document_TextAnchor) ProtoMessage 

func (*Document_TextAnchor) ProtoMessage()

func (*Document_TextAnchor) Reset 

func (m *Document_TextAnchor) Reset()

func (*Document_TextAnchor) String 

func (m *Document_TextAnchor) String() string

func (*Document_TextAnchor) XXX_DiscardUnknown 

func (m *Document_TextAnchor) XXX_DiscardUnknown()

func (*Document_TextAnchor) XXX_Marshal 

func (m *Document_TextAnchor) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Document_TextAnchor) XXX_Merge 

func (m *Document_TextAnchor) XXX_Merge(src proto.Message)

func (*Document_TextAnchor) XXX_Size 

func (m *Document_TextAnchor) XXX_Size() int

func (*Document_TextAnchor) XXX_Unmarshal 

func (m *Document_TextAnchor) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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 

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

func (*Document_TextAnchor_TextSegment) GetEndIndex 

func (m *Document_TextAnchor_TextSegment) GetEndIndex() int64

func (*Document_TextAnchor_TextSegment) GetStartIndex 

func (m *Document_TextAnchor_TextSegment) GetStartIndex() int64

func (*Document_TextAnchor_TextSegment) ProtoMessage 

func (*Document_TextAnchor_TextSegment) ProtoMessage()

func (*Document_TextAnchor_TextSegment) Reset 

func (m *Document_TextAnchor_TextSegment) Reset()

func (*Document_TextAnchor_TextSegment) String 

func (m *Document_TextAnchor_TextSegment) String() string

func (*Document_TextAnchor_TextSegment) XXX_DiscardUnknown 

func (m *Document_TextAnchor_TextSegment) XXX_DiscardUnknown()

func (*Document_TextAnchor_TextSegment) XXX_Marshal 

func (m *Document_TextAnchor_TextSegment) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Document_TextAnchor_TextSegment) XXX_Merge 

func (m *Document_TextAnchor_TextSegment) XXX_Merge(src proto.Message)

func (*Document_TextAnchor_TextSegment) XXX_Size 

func (m *Document_TextAnchor_TextSegment) XXX_Size() int

func (*Document_TextAnchor_TextSegment) XXX_Unmarshal 

func (m *Document_TextAnchor_TextSegment) XXX_Unmarshal(b []byte) error

type Document_Uri 

type Document_Uri struct {
	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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Parameters to control entity extraction behavior.

func (*EntityExtractionParams) Descriptor 

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

func (*EntityExtractionParams) GetEnabled 

func (m *EntityExtractionParams) GetEnabled() bool

func (*EntityExtractionParams) GetModelVersion 

func (m *EntityExtractionParams) GetModelVersion() string

func (*EntityExtractionParams) ProtoMessage 

func (*EntityExtractionParams) ProtoMessage()

func (*EntityExtractionParams) Reset 

func (m *EntityExtractionParams) Reset()

func (*EntityExtractionParams) String 

func (m *EntityExtractionParams) String() string

func (*EntityExtractionParams) XXX_DiscardUnknown 

func (m *EntityExtractionParams) XXX_DiscardUnknown()

func (*EntityExtractionParams) XXX_Marshal 

func (m *EntityExtractionParams) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*EntityExtractionParams) XXX_Merge 

func (m *EntityExtractionParams) XXX_Merge(src proto.Message)

func (*EntityExtractionParams) XXX_Size 

func (m *EntityExtractionParams) XXX_Size() int

func (*EntityExtractionParams) XXX_Unmarshal 

func (m *EntityExtractionParams) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Parameters to control form extraction behavior.

func (*FormExtractionParams) Descriptor 

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

func (*FormExtractionParams) GetEnabled 

func (m *FormExtractionParams) GetEnabled() bool

func (*FormExtractionParams) GetKeyValuePairHints 

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

func (*FormExtractionParams) GetModelVersion 

func (m *FormExtractionParams) GetModelVersion() string

func (*FormExtractionParams) ProtoMessage 

func (*FormExtractionParams) ProtoMessage()

func (*FormExtractionParams) Reset 

func (m *FormExtractionParams) Reset()

func (*FormExtractionParams) String 

func (m *FormExtractionParams) String() string

func (*FormExtractionParams) XXX_DiscardUnknown 

func (m *FormExtractionParams) XXX_DiscardUnknown()

func (*FormExtractionParams) XXX_Marshal 

func (m *FormExtractionParams) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*FormExtractionParams) XXX_Merge 

func (m *FormExtractionParams) XXX_Merge(src proto.Message)

func (*FormExtractionParams) XXX_Size 

func (m *FormExtractionParams) XXX_Size() int

func (*FormExtractionParams) XXX_Unmarshal 

func (m *FormExtractionParams) XXX_Unmarshal(b []byte) error

type GcsDestination 

type GcsDestination struct {
	Uri                  string   `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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

func (*GcsDestination) Descriptor 

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

func (*GcsDestination) GetUri 

func (m *GcsDestination) GetUri() string

func (*GcsDestination) ProtoMessage 

func (*GcsDestination) ProtoMessage()

func (*GcsDestination) Reset 

func (m *GcsDestination) Reset()

func (*GcsDestination) String 

func (m *GcsDestination) String() string

func (*GcsDestination) XXX_DiscardUnknown 

func (m *GcsDestination) XXX_DiscardUnknown()

func (*GcsDestination) XXX_Marshal 

func (m *GcsDestination) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GcsDestination) XXX_Merge 

func (m *GcsDestination) XXX_Merge(src proto.Message)

func (*GcsDestination) XXX_Size 

func (m *GcsDestination) XXX_Size() int

func (*GcsDestination) XXX_Unmarshal 

func (m *GcsDestination) XXX_Unmarshal(b []byte) error

type GcsSource 

type GcsSource struct {
	Uri                  string   `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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

func (*GcsSource) Descriptor 

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

func (*GcsSource) GetUri 

func (m *GcsSource) GetUri() string

func (*GcsSource) ProtoMessage 

func (*GcsSource) ProtoMessage()

func (*GcsSource) Reset 

func (m *GcsSource) Reset()

func (*GcsSource) String 

func (m *GcsSource) String() string

func (*GcsSource) XXX_DiscardUnknown 

func (m *GcsSource) XXX_DiscardUnknown()

func (*GcsSource) XXX_Marshal 

func (m *GcsSource) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GcsSource) XXX_Merge 

func (m *GcsSource) XXX_Merge(src proto.Message)

func (*GcsSource) XXX_Size 

func (m *GcsSource) XXX_Size() int

func (*GcsSource) XXX_Unmarshal 

func (m *GcsSource) XXX_Unmarshal(b []byte) error

type InputConfig 

type InputConfig struct {
	// Required.
	//
	// Types that are valid to be assigned 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

The desired input location and metadata.

func (*InputConfig) Descriptor 

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

func (*InputConfig) GetContents 

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

func (*InputConfig) GetGcsSource 

func (m *InputConfig) GetGcsSource() *GcsSource

func (*InputConfig) GetMimeType 

func (m *InputConfig) GetMimeType() string

func (*InputConfig) GetSource 

func (m *InputConfig) GetSource() isInputConfig_Source

func (*InputConfig) ProtoMessage 

func (*InputConfig) ProtoMessage()

func (*InputConfig) Reset 

func (m *InputConfig) Reset()

func (*InputConfig) String 

func (m *InputConfig) String() string

func (*InputConfig) XXX_DiscardUnknown 

func (m *InputConfig) XXX_DiscardUnknown()

func (*InputConfig) XXX_Marshal 

func (m *InputConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*InputConfig) XXX_Merge 

func (m *InputConfig) XXX_Merge(src proto.Message)

func (*InputConfig) XXX_OneofWrappers 

func (*InputConfig) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*InputConfig) XXX_Size 

func (m *InputConfig) XXX_Size() int

func (*InputConfig) XXX_Unmarshal 

func (m *InputConfig) XXX_Unmarshal(b []byte) error

type InputConfig_Contents 

type InputConfig_Contents struct {
	Contents []byte `protobuf:"bytes,3,opt,name=contents,proto3,oneof"`
}

type InputConfig_GcsSource 

type InputConfig_GcsSource struct {
	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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

User-provided hint for key value pair.

func (*KeyValuePairHint) Descriptor 

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

func (*KeyValuePairHint) GetKey 

func (m *KeyValuePairHint) GetKey() string

func (*KeyValuePairHint) GetValueTypes 

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

func (*KeyValuePairHint) ProtoMessage 

func (*KeyValuePairHint) ProtoMessage()

func (*KeyValuePairHint) Reset 

func (m *KeyValuePairHint) Reset()

func (*KeyValuePairHint) String 

func (m *KeyValuePairHint) String() string

func (*KeyValuePairHint) XXX_DiscardUnknown 

func (m *KeyValuePairHint) XXX_DiscardUnknown()

func (*KeyValuePairHint) XXX_Marshal 

func (m *KeyValuePairHint) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*KeyValuePairHint) XXX_Merge 

func (m *KeyValuePairHint) XXX_Merge(src proto.Message)

func (*KeyValuePairHint) XXX_Size 

func (m *KeyValuePairHint) XXX_Size() int

func (*KeyValuePairHint) XXX_Unmarshal 

func (m *KeyValuePairHint) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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

func (*NormalizedVertex) Descriptor 

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

func (*NormalizedVertex) GetX 

func (m *NormalizedVertex) GetX() float32

func (*NormalizedVertex) GetY 

func (m *NormalizedVertex) GetY() float32

func (*NormalizedVertex) ProtoMessage 

func (*NormalizedVertex) ProtoMessage()

func (*NormalizedVertex) Reset 

func (m *NormalizedVertex) Reset()

func (*NormalizedVertex) String 

func (m *NormalizedVertex) String() string

func (*NormalizedVertex) XXX_DiscardUnknown 

func (m *NormalizedVertex) XXX_DiscardUnknown()

func (*NormalizedVertex) XXX_Marshal 

func (m *NormalizedVertex) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*NormalizedVertex) XXX_Merge 

func (m *NormalizedVertex) XXX_Merge(src proto.Message)

func (*NormalizedVertex) XXX_Size 

func (m *NormalizedVertex) XXX_Size() int

func (*NormalizedVertex) XXX_Unmarshal 

func (m *NormalizedVertex) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Parameters to control Optical Character Recognition (OCR) behavior.

func (*OcrParams) Descriptor 

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

func (*OcrParams) GetLanguageHints 

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

func (*OcrParams) ProtoMessage 

func (*OcrParams) ProtoMessage()

func (*OcrParams) Reset 

func (m *OcrParams) Reset()

func (*OcrParams) String 

func (m *OcrParams) String() string

func (*OcrParams) XXX_DiscardUnknown 

func (m *OcrParams) XXX_DiscardUnknown()

func (*OcrParams) XXX_Marshal 

func (m *OcrParams) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*OcrParams) XXX_Merge 

func (m *OcrParams) XXX_Merge(src proto.Message)

func (*OcrParams) XXX_Size 

func (m *OcrParams) XXX_Size() int

func (*OcrParams) XXX_Unmarshal 

func (m *OcrParams) XXX_Unmarshal(b []byte) error

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 *timestamp.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// The last update time of the operation.
	UpdateTime           *timestamp.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	XXX_NoUnkeyedLiteral struct{}             `json:"-"`
	XXX_unrecognized     []byte               `json:"-"`
	XXX_sizecache        int32                `json:"-"`
}

Contains metadata for the BatchProcessDocuments operation.

func (*OperationMetadata) Descriptor 

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

func (*OperationMetadata) GetCreateTime 

func (m *OperationMetadata) GetCreateTime() *timestamp.Timestamp

func (*OperationMetadata) GetState 

func (m *OperationMetadata) GetState() OperationMetadata_State

func (*OperationMetadata) GetStateMessage 

func (m *OperationMetadata) GetStateMessage() string

func (*OperationMetadata) GetUpdateTime 

func (m *OperationMetadata) GetUpdateTime() *timestamp.Timestamp

func (*OperationMetadata) ProtoMessage 

func (*OperationMetadata) ProtoMessage()

func (*OperationMetadata) Reset 

func (m *OperationMetadata) Reset()

func (*OperationMetadata) String 

func (m *OperationMetadata) String() string

func (*OperationMetadata) XXX_DiscardUnknown 

func (m *OperationMetadata) XXX_DiscardUnknown()

func (*OperationMetadata) XXX_Marshal 

func (m *OperationMetadata) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*OperationMetadata) XXX_Merge 

func (m *OperationMetadata) XXX_Merge(src proto.Message)

func (*OperationMetadata) XXX_Size 

func (m *OperationMetadata) XXX_Size() int

func (*OperationMetadata) XXX_Unmarshal 

func (m *OperationMetadata) XXX_Unmarshal(b []byte) error

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

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

func (OperationMetadata_State) String 

func (x OperationMetadata_State) String() string

type OutputConfig 

type OutputConfig struct {
	// Required.
	//
	// Types that are valid to be assigned 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

The desired output location and metadata.

func (*OutputConfig) Descriptor 

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

func (*OutputConfig) GetDestination 

func (m *OutputConfig) GetDestination() isOutputConfig_Destination

func (*OutputConfig) GetGcsDestination 

func (m *OutputConfig) GetGcsDestination() *GcsDestination

func (*OutputConfig) GetPagesPerShard 

func (m *OutputConfig) GetPagesPerShard() int32

func (*OutputConfig) ProtoMessage 

func (*OutputConfig) ProtoMessage()

func (*OutputConfig) Reset 

func (m *OutputConfig) Reset()

func (*OutputConfig) String 

func (m *OutputConfig) String() string

func (*OutputConfig) XXX_DiscardUnknown 

func (m *OutputConfig) XXX_DiscardUnknown()

func (*OutputConfig) XXX_Marshal 

func (m *OutputConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*OutputConfig) XXX_Merge 

func (m *OutputConfig) XXX_Merge(src proto.Message)

func (*OutputConfig) XXX_OneofWrappers 

func (*OutputConfig) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*OutputConfig) XXX_Size 

func (m *OutputConfig) XXX_Size() int

func (*OutputConfig) XXX_Unmarshal 

func (m *OutputConfig) XXX_Unmarshal(b []byte) error

type OutputConfig_GcsDestination 

type OutputConfig_GcsDestination struct {
	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"`
	XXX_NoUnkeyedLiteral struct{}      `json:"-"`
	XXX_unrecognized     []byte        `json:"-"`
	XXX_sizecache        int32         `json:"-"`
}

Request to process one document.

func (*ProcessDocumentRequest) Descriptor 

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

func (*ProcessDocumentRequest) GetAutomlParams 

func (m *ProcessDocumentRequest) GetAutomlParams() *AutoMlParams

func (*ProcessDocumentRequest) GetDocumentType 

func (m *ProcessDocumentRequest) GetDocumentType() string

func (*ProcessDocumentRequest) GetEntityExtractionParams 

func (m *ProcessDocumentRequest) GetEntityExtractionParams() *EntityExtractionParams

func (*ProcessDocumentRequest) GetFormExtractionParams 

func (m *ProcessDocumentRequest) GetFormExtractionParams() *FormExtractionParams

func (*ProcessDocumentRequest) GetInputConfig 

func (m *ProcessDocumentRequest) GetInputConfig() *InputConfig

func (*ProcessDocumentRequest) GetOcrParams 

func (m *ProcessDocumentRequest) GetOcrParams() *OcrParams

func (*ProcessDocumentRequest) GetOutputConfig 

func (m *ProcessDocumentRequest) GetOutputConfig() *OutputConfig

func (*ProcessDocumentRequest) GetParent 

func (m *ProcessDocumentRequest) GetParent() string

func (*ProcessDocumentRequest) GetTableExtractionParams 

func (m *ProcessDocumentRequest) GetTableExtractionParams() *TableExtractionParams

func (*ProcessDocumentRequest) ProtoMessage 

func (*ProcessDocumentRequest) ProtoMessage()

func (*ProcessDocumentRequest) Reset 

func (m *ProcessDocumentRequest) Reset()

func (*ProcessDocumentRequest) String 

func (m *ProcessDocumentRequest) String() string

func (*ProcessDocumentRequest) XXX_DiscardUnknown 

func (m *ProcessDocumentRequest) XXX_DiscardUnknown()

func (*ProcessDocumentRequest) XXX_Marshal 

func (m *ProcessDocumentRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ProcessDocumentRequest) XXX_Merge 

func (m *ProcessDocumentRequest) XXX_Merge(src proto.Message)

func (*ProcessDocumentRequest) XXX_Size 

func (m *ProcessDocumentRequest) XXX_Size() int

func (*ProcessDocumentRequest) XXX_Unmarshal 

func (m *ProcessDocumentRequest) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{}      `json:"-"`
	XXX_unrecognized     []byte        `json:"-"`
	XXX_sizecache        int32         `json:"-"`
}

Response to a single document processing request.

func (*ProcessDocumentResponse) Descriptor 

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

func (*ProcessDocumentResponse) GetInputConfig 

func (m *ProcessDocumentResponse) GetInputConfig() *InputConfig

func (*ProcessDocumentResponse) GetOutputConfig 

func (m *ProcessDocumentResponse) GetOutputConfig() *OutputConfig

func (*ProcessDocumentResponse) ProtoMessage 

func (*ProcessDocumentResponse) ProtoMessage()

func (*ProcessDocumentResponse) Reset 

func (m *ProcessDocumentResponse) Reset()

func (*ProcessDocumentResponse) String 

func (m *ProcessDocumentResponse) String() string

func (*ProcessDocumentResponse) XXX_DiscardUnknown 

func (m *ProcessDocumentResponse) XXX_DiscardUnknown()

func (*ProcessDocumentResponse) XXX_Marshal 

func (m *ProcessDocumentResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ProcessDocumentResponse) XXX_Merge 

func (m *ProcessDocumentResponse) XXX_Merge(src proto.Message)

func (*ProcessDocumentResponse) XXX_Size 

func (m *ProcessDocumentResponse) XXX_Size() int

func (*ProcessDocumentResponse) XXX_Unmarshal 

func (m *ProcessDocumentResponse) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{}      `json:"-"`
	XXX_unrecognized     []byte        `json:"-"`
	XXX_sizecache        int32         `json:"-"`
}

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

func (*TableBoundHint) Descriptor 

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

func (*TableBoundHint) GetBoundingBox 

func (m *TableBoundHint) GetBoundingBox() *BoundingPoly

func (*TableBoundHint) GetPageNumber 

func (m *TableBoundHint) GetPageNumber() int32

func (*TableBoundHint) ProtoMessage 

func (*TableBoundHint) ProtoMessage()

func (*TableBoundHint) Reset 

func (m *TableBoundHint) Reset()

func (*TableBoundHint) String 

func (m *TableBoundHint) String() string

func (*TableBoundHint) XXX_DiscardUnknown 

func (m *TableBoundHint) XXX_DiscardUnknown()

func (*TableBoundHint) XXX_Marshal 

func (m *TableBoundHint) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TableBoundHint) XXX_Merge 

func (m *TableBoundHint) XXX_Merge(src proto.Message)

func (*TableBoundHint) XXX_Size 

func (m *TableBoundHint) XXX_Size() int

func (*TableBoundHint) XXX_Unmarshal 

func (m *TableBoundHint) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Parameters to control table extraction behavior.

func (*TableExtractionParams) Descriptor 

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

func (*TableExtractionParams) GetEnabled 

func (m *TableExtractionParams) GetEnabled() bool

func (*TableExtractionParams) GetHeaderHints 

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

func (*TableExtractionParams) GetModelVersion 

func (m *TableExtractionParams) GetModelVersion() string

func (*TableExtractionParams) GetTableBoundHints 

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

func (*TableExtractionParams) ProtoMessage 

func (*TableExtractionParams) ProtoMessage()

func (*TableExtractionParams) Reset 

func (m *TableExtractionParams) Reset()

func (*TableExtractionParams) String 

func (m *TableExtractionParams) String() string

func (*TableExtractionParams) XXX_DiscardUnknown 

func (m *TableExtractionParams) XXX_DiscardUnknown()

func (*TableExtractionParams) XXX_Marshal 

func (m *TableExtractionParams) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TableExtractionParams) XXX_Merge 

func (m *TableExtractionParams) XXX_Merge(src proto.Message)

func (*TableExtractionParams) XXX_Size 

func (m *TableExtractionParams) XXX_Size() int

func (*TableExtractionParams) XXX_Unmarshal 

func (m *TableExtractionParams) XXX_Unmarshal(b []byte) error

type UnimplementedDocumentUnderstandingServiceServer 

type UnimplementedDocumentUnderstandingServiceServer struct {
}

UnimplementedDocumentUnderstandingServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedDocumentUnderstandingServiceServer) BatchProcessDocuments 

func (*UnimplementedDocumentUnderstandingServiceServer) BatchProcessDocuments(ctx context.Context, req *BatchProcessDocumentsRequest) (*longrunning.Operation, error)

func (*UnimplementedDocumentUnderstandingServiceServer) ProcessDocument 

func (*UnimplementedDocumentUnderstandingServiceServer) ProcessDocument(ctx context.Context, req *ProcessDocumentRequest) (*Document, error)

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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 

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

func (*Vertex) GetX 

func (m *Vertex) GetX() int32

func (*Vertex) GetY 

func (m *Vertex) GetY() int32

func (*Vertex) ProtoMessage 

func (*Vertex) ProtoMessage()

func (*Vertex) Reset 

func (m *Vertex) Reset()

func (*Vertex) String 

func (m *Vertex) String() string

func (*Vertex) XXX_DiscardUnknown 

func (m *Vertex) XXX_DiscardUnknown()

func (*Vertex) XXX_Marshal 

func (m *Vertex) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Vertex) XXX_Merge 

func (m *Vertex) XXX_Merge(src proto.Message)

func (*Vertex) XXX_Size 

func (m *Vertex) XXX_Size() int

func (*Vertex) XXX_Unmarshal 

func (m *Vertex) XXX_Unmarshal(b []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.