genproto: google.golang.org/genproto/googleapis/cloud/documentai/v1beta3 Index | Files

package documentai

import "google.golang.org/genproto/googleapis/cloud/documentai/v1beta3"

Index

Package Files

document.pb.go document_processor_service.pb.go geometry.pb.go

Variables

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

Enum value maps for Document_Page_Layout_Orientation.

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

Enum value maps for Document_Page_Token_DetectedBreak_Type.

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

Enum value maps for Document_PageAnchor_PageRef_LayoutType.

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

Enum value maps for Document_Provenance_OperationType.

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

Enum value maps for BatchProcessMetadata_State.

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

Enum value maps for ReviewDocumentOperationMetadata_State.

var File_google_cloud_documentai_v1beta3_document_processor_service_proto protoreflect.FileDescriptor
var File_google_cloud_documentai_v1beta3_document_proto protoreflect.FileDescriptor
var File_google_cloud_documentai_v1beta3_geometry_proto protoreflect.FileDescriptor

func RegisterDocumentProcessorServiceServer Uses

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

type BatchProcessMetadata Uses

type BatchProcessMetadata struct {

    // The state of the current batch processing.
    State BatchProcessMetadata_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.cloud.documentai.v1beta3.BatchProcessMetadata_State" json:"state,omitempty"`
    // A message providing more details about the current state of processing.
    // For example, the error message if the operation is failed.
    StateMessage string `protobuf:"bytes,2,opt,name=state_message,json=stateMessage,proto3" json:"state_message,omitempty"`
    // The creation time of the operation.
    CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
    // The last update time of the operation.
    UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
    // The list of response details of each document.
    IndividualProcessStatuses []*BatchProcessMetadata_IndividualProcessStatus `protobuf:"bytes,5,rep,name=individual_process_statuses,json=individualProcessStatuses,proto3" json:"individual_process_statuses,omitempty"`
    // contains filtered or unexported fields
}

The long running operation metadata for batch process method.

func (*BatchProcessMetadata) Descriptor Uses

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

Deprecated: Use BatchProcessMetadata.ProtoReflect.Descriptor instead.

func (*BatchProcessMetadata) GetCreateTime Uses

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

func (*BatchProcessMetadata) GetIndividualProcessStatuses Uses

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

func (*BatchProcessMetadata) GetState Uses

func (x *BatchProcessMetadata) GetState() BatchProcessMetadata_State

func (*BatchProcessMetadata) GetStateMessage Uses

func (x *BatchProcessMetadata) GetStateMessage() string

func (*BatchProcessMetadata) GetUpdateTime Uses

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

func (*BatchProcessMetadata) ProtoMessage Uses

func (*BatchProcessMetadata) ProtoMessage()

func (*BatchProcessMetadata) ProtoReflect Uses

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

func (*BatchProcessMetadata) Reset Uses

func (x *BatchProcessMetadata) Reset()

func (*BatchProcessMetadata) String Uses

func (x *BatchProcessMetadata) String() string

type BatchProcessMetadata_IndividualProcessStatus Uses

type BatchProcessMetadata_IndividualProcessStatus struct {

    // The source of the document, same as the [input_gcs_source] field in the
    // request when the batch process started. The batch process is started by
    // take snapshot of that document, since a user can move or change that
    // document during the process.
    InputGcsSource string `protobuf:"bytes,1,opt,name=input_gcs_source,json=inputGcsSource,proto3" json:"input_gcs_source,omitempty"`
    // The status of the processing of the document.
    Status *status.Status `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
    // The output_gcs_destination (in the request as 'output_gcs_destination')
    // of the processed document if it was successful, otherwise empty.
    OutputGcsDestination string `protobuf:"bytes,3,opt,name=output_gcs_destination,json=outputGcsDestination,proto3" json:"output_gcs_destination,omitempty"`
    // The name of the operation triggered by the processed document. If the
    // human review process is not triggered, this field will be empty. It has
    // the same response type and metadata as the long running operation
    // returned by ReviewDocument method.
    HumanReviewOperation string `protobuf:"bytes,4,opt,name=human_review_operation,json=humanReviewOperation,proto3" json:"human_review_operation,omitempty"`
    // contains filtered or unexported fields
}

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

func (*BatchProcessMetadata_IndividualProcessStatus) Descriptor Uses

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

Deprecated: Use BatchProcessMetadata_IndividualProcessStatus.ProtoReflect.Descriptor instead.

func (*BatchProcessMetadata_IndividualProcessStatus) GetHumanReviewOperation Uses

func (x *BatchProcessMetadata_IndividualProcessStatus) GetHumanReviewOperation() string

func (*BatchProcessMetadata_IndividualProcessStatus) GetInputGcsSource Uses

func (x *BatchProcessMetadata_IndividualProcessStatus) GetInputGcsSource() string

func (*BatchProcessMetadata_IndividualProcessStatus) GetOutputGcsDestination Uses

func (x *BatchProcessMetadata_IndividualProcessStatus) GetOutputGcsDestination() string

func (*BatchProcessMetadata_IndividualProcessStatus) GetStatus Uses

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

func (*BatchProcessMetadata_IndividualProcessStatus) ProtoMessage Uses

func (*BatchProcessMetadata_IndividualProcessStatus) ProtoMessage()

func (*BatchProcessMetadata_IndividualProcessStatus) ProtoReflect Uses

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

func (*BatchProcessMetadata_IndividualProcessStatus) Reset Uses

func (x *BatchProcessMetadata_IndividualProcessStatus) Reset()

func (*BatchProcessMetadata_IndividualProcessStatus) String Uses

func (x *BatchProcessMetadata_IndividualProcessStatus) String() string

type BatchProcessMetadata_State Uses

type BatchProcessMetadata_State int32

Possible states of the batch processing operation.

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

func (BatchProcessMetadata_State) Descriptor Uses

func (BatchProcessMetadata_State) Descriptor() protoreflect.EnumDescriptor

func (BatchProcessMetadata_State) Enum Uses

func (x BatchProcessMetadata_State) Enum() *BatchProcessMetadata_State

func (BatchProcessMetadata_State) EnumDescriptor Uses

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

Deprecated: Use BatchProcessMetadata_State.Descriptor instead.

func (BatchProcessMetadata_State) Number Uses

func (x BatchProcessMetadata_State) Number() protoreflect.EnumNumber

func (BatchProcessMetadata_State) String Uses

func (x BatchProcessMetadata_State) String() string

func (BatchProcessMetadata_State) Type Uses

func (BatchProcessMetadata_State) Type() protoreflect.EnumType

type BatchProcessRequest Uses

type BatchProcessRequest struct {

    // Required. The processor resource name.
    Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
    // The input config for each single document in the batch process.
    InputConfigs []*BatchProcessRequest_BatchInputConfig `protobuf:"bytes,2,rep,name=input_configs,json=inputConfigs,proto3" json:"input_configs,omitempty"`
    // The overall output config for batch process.
    OutputConfig *BatchProcessRequest_BatchOutputConfig `protobuf:"bytes,3,opt,name=output_config,json=outputConfig,proto3" json:"output_config,omitempty"`
    // contains filtered or unexported fields
}

Request message for batch process document method.

func (*BatchProcessRequest) Descriptor Uses

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

Deprecated: Use BatchProcessRequest.ProtoReflect.Descriptor instead.

func (*BatchProcessRequest) GetInputConfigs Uses

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

func (*BatchProcessRequest) GetName Uses

func (x *BatchProcessRequest) GetName() string

func (*BatchProcessRequest) GetOutputConfig Uses

func (x *BatchProcessRequest) GetOutputConfig() *BatchProcessRequest_BatchOutputConfig

func (*BatchProcessRequest) ProtoMessage Uses

func (*BatchProcessRequest) ProtoMessage()

func (*BatchProcessRequest) ProtoReflect Uses

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

func (*BatchProcessRequest) Reset Uses

func (x *BatchProcessRequest) Reset()

func (*BatchProcessRequest) String Uses

func (x *BatchProcessRequest) String() string

type BatchProcessRequest_BatchInputConfig Uses

type BatchProcessRequest_BatchInputConfig struct {

    // The Cloud Storage location as the source of the document.
    GcsSource string `protobuf:"bytes,1,opt,name=gcs_source,json=gcsSource,proto3" json:"gcs_source,omitempty"`
    // Mimetype of the input. If the input is a raw document, the supported
    // mimetypes are application/pdf, image/tiff, and image/gif.
    // If the input is a [Document] proto, the type should be application/json.
    MimeType string `protobuf:"bytes,2,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
    // contains filtered or unexported fields
}

The message for input config in batch process.

func (*BatchProcessRequest_BatchInputConfig) Descriptor Uses

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

Deprecated: Use BatchProcessRequest_BatchInputConfig.ProtoReflect.Descriptor instead.

func (*BatchProcessRequest_BatchInputConfig) GetGcsSource Uses

func (x *BatchProcessRequest_BatchInputConfig) GetGcsSource() string

func (*BatchProcessRequest_BatchInputConfig) GetMimeType Uses

func (x *BatchProcessRequest_BatchInputConfig) GetMimeType() string

func (*BatchProcessRequest_BatchInputConfig) ProtoMessage Uses

func (*BatchProcessRequest_BatchInputConfig) ProtoMessage()

func (*BatchProcessRequest_BatchInputConfig) ProtoReflect Uses

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

func (*BatchProcessRequest_BatchInputConfig) Reset Uses

func (x *BatchProcessRequest_BatchInputConfig) Reset()

func (*BatchProcessRequest_BatchInputConfig) String Uses

func (x *BatchProcessRequest_BatchInputConfig) String() string

type BatchProcessRequest_BatchOutputConfig Uses

type BatchProcessRequest_BatchOutputConfig struct {

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

The message for output config in batch process.

func (*BatchProcessRequest_BatchOutputConfig) Descriptor Uses

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

Deprecated: Use BatchProcessRequest_BatchOutputConfig.ProtoReflect.Descriptor instead.

func (*BatchProcessRequest_BatchOutputConfig) GetGcsDestination Uses

func (x *BatchProcessRequest_BatchOutputConfig) GetGcsDestination() string

func (*BatchProcessRequest_BatchOutputConfig) ProtoMessage Uses

func (*BatchProcessRequest_BatchOutputConfig) ProtoMessage()

func (*BatchProcessRequest_BatchOutputConfig) ProtoReflect Uses

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

func (*BatchProcessRequest_BatchOutputConfig) Reset Uses

func (x *BatchProcessRequest_BatchOutputConfig) Reset()

func (*BatchProcessRequest_BatchOutputConfig) String Uses

func (x *BatchProcessRequest_BatchOutputConfig) String() string

type BatchProcessResponse Uses

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

Response message for batch process document method.

func (*BatchProcessResponse) Descriptor Uses

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

Deprecated: Use BatchProcessResponse.ProtoReflect.Descriptor instead.

func (*BatchProcessResponse) ProtoMessage Uses

func (*BatchProcessResponse) ProtoMessage()

func (*BatchProcessResponse) ProtoReflect Uses

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

func (*BatchProcessResponse) Reset Uses

func (x *BatchProcessResponse) Reset()

func (*BatchProcessResponse) String Uses

func (x *BatchProcessResponse) String() string

type BoundingPoly Uses

type BoundingPoly struct {

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

A bounding polygon for the detected image annotation.

func (*BoundingPoly) Descriptor Uses

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

Deprecated: Use BoundingPoly.ProtoReflect.Descriptor instead.

func (*BoundingPoly) GetNormalizedVertices Uses

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

func (*BoundingPoly) GetVertices Uses

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

func (*BoundingPoly) ProtoMessage Uses

func (*BoundingPoly) ProtoMessage()

func (*BoundingPoly) ProtoReflect Uses

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

func (*BoundingPoly) Reset Uses

func (x *BoundingPoly) Reset()

func (*BoundingPoly) String Uses

func (x *BoundingPoly) String() string

type Document Uses

type Document struct {

    // Original source document from the user.
    //
    // Types that are assignable to Source:
    //	*Document_Uri
    //	*Document_Content
    Source isDocument_Source `protobuf_oneof:"source"`
    // An IANA published MIME type (also referred to as media type). For more
    // information, see
    // https://www.iana.org/assignments/media-types/media-types.xhtml.
    MimeType string `protobuf:"bytes,3,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
    // UTF-8 encoded text in reading order from the document.
    Text string `protobuf:"bytes,4,opt,name=text,proto3" json:"text,omitempty"`
    // Styles for the [Document.text][google.cloud.documentai.v1beta3.Document.text].
    TextStyles []*Document_Style `protobuf:"bytes,5,rep,name=text_styles,json=textStyles,proto3" json:"text_styles,omitempty"`
    // Visual page layout for the [Document][google.cloud.documentai.v1beta3.Document].
    Pages []*Document_Page `protobuf:"bytes,6,rep,name=pages,proto3" json:"pages,omitempty"`
    // A list of entities detected on [Document.text][google.cloud.documentai.v1beta3.Document.text]. For document shards,
    // entities in this list may cross shard boundaries.
    Entities []*Document_Entity `protobuf:"bytes,7,rep,name=entities,proto3" json:"entities,omitempty"`
    // Relationship among [Document.entities][google.cloud.documentai.v1beta3.Document.entities].
    EntityRelations []*Document_EntityRelation `protobuf:"bytes,8,rep,name=entity_relations,json=entityRelations,proto3" json:"entity_relations,omitempty"`
    // A list of translations on [Document.text][google.cloud.documentai.v1beta3.Document.text]. For document shards,
    // translations in this list may cross shard boundaries.
    Translations []*Document_Translation `protobuf:"bytes,12,rep,name=translations,proto3" json:"translations,omitempty"`
    // A list of text corrections made to [Document.text].  This is usually
    // used for annotating corrections to OCR mistakes.  Text changes for a given
    // revision may not overlap with each other.
    TextChanges []*Document_TextChange `protobuf:"bytes,14,rep,name=text_changes,json=textChanges,proto3" json:"text_changes,omitempty"`
    // Information about the sharding if this document is sharded part of a larger
    // document. If the document is not sharded, this message is not specified.
    ShardInfo *Document_ShardInfo `protobuf:"bytes,9,opt,name=shard_info,json=shardInfo,proto3" json:"shard_info,omitempty"`
    // Any error that occurred while processing this document.
    Error *status.Status `protobuf:"bytes,10,opt,name=error,proto3" json:"error,omitempty"`
    // Revision history of this document.
    Revisions []*Document_Revision `protobuf:"bytes,13,rep,name=revisions,proto3" json:"revisions,omitempty"`
    // contains filtered or unexported fields
}

Document represents the canonical document resource in Document 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 Uses

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

Deprecated: Use Document.ProtoReflect.Descriptor instead.

func (*Document) GetContent Uses

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

func (*Document) GetEntities Uses

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

func (*Document) GetEntityRelations Uses

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

func (*Document) GetError Uses

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

func (*Document) GetMimeType Uses

func (x *Document) GetMimeType() string

func (*Document) GetPages Uses

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

func (*Document) GetRevisions Uses

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

func (*Document) GetShardInfo Uses

func (x *Document) GetShardInfo() *Document_ShardInfo

func (*Document) GetSource Uses

func (m *Document) GetSource() isDocument_Source

func (*Document) GetText Uses

func (x *Document) GetText() string

func (*Document) GetTextChanges Uses

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

func (*Document) GetTextStyles Uses

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

func (*Document) GetTranslations Uses

func (x *Document) GetTranslations() []*Document_Translation

func (*Document) GetUri Uses

func (x *Document) GetUri() string

func (*Document) ProtoMessage Uses

func (*Document) ProtoMessage()

func (*Document) ProtoReflect Uses

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

func (*Document) Reset Uses

func (x *Document) Reset()

func (*Document) String Uses

func (x *Document) String() string

type DocumentProcessorServiceClient Uses

type DocumentProcessorServiceClient interface {
    // Processes a single document.
    ProcessDocument(ctx context.Context, in *ProcessRequest, opts ...grpc.CallOption) (*ProcessResponse, error)
    // LRO endpoint to batch process many documents. The output is written
    // to Cloud Storage as JSON in the [Document] format.
    BatchProcessDocuments(ctx context.Context, in *BatchProcessRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
    // Send a document for Human Review. The input document should be processed by
    // the specified processor.
    ReviewDocument(ctx context.Context, in *ReviewDocumentRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
}

DocumentProcessorServiceClient is the client API for DocumentProcessorService service.

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

func NewDocumentProcessorServiceClient Uses

func NewDocumentProcessorServiceClient(cc grpc.ClientConnInterface) DocumentProcessorServiceClient

type DocumentProcessorServiceServer Uses

type DocumentProcessorServiceServer interface {
    // Processes a single document.
    ProcessDocument(context.Context, *ProcessRequest) (*ProcessResponse, error)
    // LRO endpoint to batch process many documents. The output is written
    // to Cloud Storage as JSON in the [Document] format.
    BatchProcessDocuments(context.Context, *BatchProcessRequest) (*longrunning.Operation, error)
    // Send a document for Human Review. The input document should be processed by
    // the specified processor.
    ReviewDocument(context.Context, *ReviewDocumentRequest) (*longrunning.Operation, error)
}

DocumentProcessorServiceServer is the server API for DocumentProcessorService service.

type Document_Content Uses

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

type Document_Entity Uses

type Document_Entity struct {

    // Provenance of the entity.
    // Text anchor indexing into the [Document.text][google.cloud.documentai.v1beta3.Document.text].
    TextAnchor *Document_TextAnchor `protobuf:"bytes,1,opt,name=text_anchor,json=textAnchor,proto3" json:"text_anchor,omitempty"`
    // 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"`
    // Canonical id. This will be a unique value in the entity list
    // for this document.
    Id  string `protobuf:"bytes,7,opt,name=id,proto3" json:"id,omitempty"`
    // Optional. Normalized entity value. Absent if the extracted value could not be
    // converted or the type (e.g. address) is not supported for certain
    // parsers. This field is also only populated for certain supported document
    // types.
    NormalizedValue *Document_Entity_NormalizedValue `protobuf:"bytes,9,opt,name=normalized_value,json=normalizedValue,proto3" json:"normalized_value,omitempty"`
    // Optional. Entities can be nested to form a hierarchical data structure representing
    // the content in the document.
    Properties []*Document_Entity `protobuf:"bytes,10,rep,name=properties,proto3" json:"properties,omitempty"`
    // Optional. The history of this annotation.
    Provenance *Document_Provenance `protobuf:"bytes,11,opt,name=provenance,proto3" json:"provenance,omitempty"`
    // Optional. Whether the entity will be redacted for de-identification purposes.
    Redacted bool `protobuf:"varint,12,opt,name=redacted,proto3" json:"redacted,omitempty"`
    // contains filtered or unexported fields
}

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

func (*Document_Entity) Descriptor Uses

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

Deprecated: Use Document_Entity.ProtoReflect.Descriptor instead.

func (*Document_Entity) GetConfidence Uses

func (x *Document_Entity) GetConfidence() float32

func (*Document_Entity) GetId Uses

func (x *Document_Entity) GetId() string

func (*Document_Entity) GetMentionId Uses

func (x *Document_Entity) GetMentionId() string

func (*Document_Entity) GetMentionText Uses

func (x *Document_Entity) GetMentionText() string

func (*Document_Entity) GetNormalizedValue Uses

func (x *Document_Entity) GetNormalizedValue() *Document_Entity_NormalizedValue

func (*Document_Entity) GetPageAnchor Uses

func (x *Document_Entity) GetPageAnchor() *Document_PageAnchor

func (*Document_Entity) GetProperties Uses

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

func (*Document_Entity) GetProvenance Uses

func (x *Document_Entity) GetProvenance() *Document_Provenance

func (*Document_Entity) GetRedacted Uses

func (x *Document_Entity) GetRedacted() bool

func (*Document_Entity) GetTextAnchor Uses

func (x *Document_Entity) GetTextAnchor() *Document_TextAnchor

func (*Document_Entity) GetType Uses

func (x *Document_Entity) GetType() string

func (*Document_Entity) ProtoMessage Uses

func (*Document_Entity) ProtoMessage()

func (*Document_Entity) ProtoReflect Uses

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

func (*Document_Entity) Reset Uses

func (x *Document_Entity) Reset()

func (*Document_Entity) String Uses

func (x *Document_Entity) String() string

type Document_EntityRelation Uses

type Document_EntityRelation struct {

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

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

func (*Document_EntityRelation) Descriptor Uses

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

Deprecated: Use Document_EntityRelation.ProtoReflect.Descriptor instead.

func (*Document_EntityRelation) GetObjectId Uses

func (x *Document_EntityRelation) GetObjectId() string

func (*Document_EntityRelation) GetRelation Uses

func (x *Document_EntityRelation) GetRelation() string

func (*Document_EntityRelation) GetSubjectId Uses

func (x *Document_EntityRelation) GetSubjectId() string

func (*Document_EntityRelation) ProtoMessage Uses

func (*Document_EntityRelation) ProtoMessage()

func (*Document_EntityRelation) ProtoReflect Uses

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

func (*Document_EntityRelation) Reset Uses

func (x *Document_EntityRelation) Reset()

func (*Document_EntityRelation) String Uses

func (x *Document_EntityRelation) String() string

type Document_Entity_NormalizedValue Uses

type Document_Entity_NormalizedValue struct {

    // Structured entity value. Must match entity type defined in schema if
    // known. If this field is present, the 'text' field is still populated.
    //
    // Types that are assignable to StructuredValue:
    //	*Document_Entity_NormalizedValue_MoneyValue
    //	*Document_Entity_NormalizedValue_DateValue
    //	*Document_Entity_NormalizedValue_DatetimeValue
    //	*Document_Entity_NormalizedValue_AddressValue
    StructuredValue isDocument_Entity_NormalizedValue_StructuredValue `protobuf_oneof:"structured_value"`
    // Required. Normalized entity value stored as a string. This field is populated for
    // supported document type (e.g. Invoice). For some entity types, one of
    // respective 'structured_value' fields may also be populated.
    //
    // - Money/Currency type (`money_value`) is in the ISO 4217 text format.
    // - Date type (`date_value`) is in the ISO 8601 text format.
    // - Datetime type (`datetime_value`) is in the ISO 8601 text format.
    Text string `protobuf:"bytes,1,opt,name=text,proto3" json:"text,omitempty"`
    // contains filtered or unexported fields
}

Parsed and normalized entity value.

func (*Document_Entity_NormalizedValue) Descriptor Uses

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

Deprecated: Use Document_Entity_NormalizedValue.ProtoReflect.Descriptor instead.

func (*Document_Entity_NormalizedValue) GetAddressValue Uses

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

func (*Document_Entity_NormalizedValue) GetDateValue Uses

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

func (*Document_Entity_NormalizedValue) GetDatetimeValue Uses

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

func (*Document_Entity_NormalizedValue) GetMoneyValue Uses

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

func (*Document_Entity_NormalizedValue) GetStructuredValue Uses

func (m *Document_Entity_NormalizedValue) GetStructuredValue() isDocument_Entity_NormalizedValue_StructuredValue

func (*Document_Entity_NormalizedValue) GetText Uses

func (x *Document_Entity_NormalizedValue) GetText() string

func (*Document_Entity_NormalizedValue) ProtoMessage Uses

func (*Document_Entity_NormalizedValue) ProtoMessage()

func (*Document_Entity_NormalizedValue) ProtoReflect Uses

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

func (*Document_Entity_NormalizedValue) Reset Uses

func (x *Document_Entity_NormalizedValue) Reset()

func (*Document_Entity_NormalizedValue) String Uses

func (x *Document_Entity_NormalizedValue) String() string

type Document_Entity_NormalizedValue_AddressValue Uses

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

type Document_Entity_NormalizedValue_DateValue Uses

type Document_Entity_NormalizedValue_DateValue struct {
    // Date value. Includes year, month, day. See also:
    //
    // https:
    // github.com/googleapis/googleapis/blob/master/google/type/date.proto
    DateValue *date.Date `protobuf:"bytes,3,opt,name=date_value,json=dateValue,proto3,oneof"`
}

type Document_Entity_NormalizedValue_DatetimeValue Uses

type Document_Entity_NormalizedValue_DatetimeValue struct {
    // DateTime value. Includes date, time, and timezone. See also:
    //
    // https:
    // github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
    DatetimeValue *datetime.DateTime `protobuf:"bytes,4,opt,name=datetime_value,json=datetimeValue,proto3,oneof"`
}

type Document_Entity_NormalizedValue_MoneyValue Uses

type Document_Entity_NormalizedValue_MoneyValue struct {
    // Money value. See also:
    //
    // https:
    // github.com/googleapis/googleapis/blob/master/google/type/money.proto
    MoneyValue *money.Money `protobuf:"bytes,2,opt,name=money_value,json=moneyValue,proto3,oneof"`
}

type Document_Page Uses

type Document_Page struct {

    // 1-based index for current [Page][google.cloud.documentai.v1beta3.Document.Page] in a parent [Document][google.cloud.documentai.v1beta3.Document].
    // Useful when a page is taken out of a [Document][google.cloud.documentai.v1beta3.Document] for individual
    // processing.
    PageNumber int32 `protobuf:"varint,1,opt,name=page_number,json=pageNumber,proto3" json:"page_number,omitempty"`
    // Rendered image for this page. This image is preprocessed to remove any
    // skew, rotation, and distortions such that the annotation bounding boxes
    // can be upright and axis-aligned.
    Image *Document_Page_Image `protobuf:"bytes,13,opt,name=image,proto3" json:"image,omitempty"`
    // Transformation matrices that were applied to the original document image
    // to produce [Page.image][google.cloud.documentai.v1beta3.Document.Page.image].
    Transforms []*Document_Page_Matrix `protobuf:"bytes,14,rep,name=transforms,proto3" json:"transforms,omitempty"`
    // Physical dimension of the page.
    Dimension *Document_Page_Dimension `protobuf:"bytes,2,opt,name=dimension,proto3" json:"dimension,omitempty"`
    // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the page.
    Layout *Document_Page_Layout `protobuf:"bytes,3,opt,name=layout,proto3" json:"layout,omitempty"`
    // A list of detected languages together with confidence.
    DetectedLanguages []*Document_Page_DetectedLanguage `protobuf:"bytes,4,rep,name=detected_languages,json=detectedLanguages,proto3" json:"detected_languages,omitempty"`
    // A list of visually detected text blocks on the page.
    // A block has a set of lines (collected into paragraphs) that have a common
    // line-spacing and orientation.
    Blocks []*Document_Page_Block `protobuf:"bytes,5,rep,name=blocks,proto3" json:"blocks,omitempty"`
    // A list of visually detected text paragraphs on the page.
    // A collection of lines that a human would perceive as a paragraph.
    Paragraphs []*Document_Page_Paragraph `protobuf:"bytes,6,rep,name=paragraphs,proto3" json:"paragraphs,omitempty"`
    // A list of visually detected text lines on the page.
    // A collection of tokens that a human would perceive as a line.
    Lines []*Document_Page_Line `protobuf:"bytes,7,rep,name=lines,proto3" json:"lines,omitempty"`
    // A list of visually detected tokens on the page.
    Tokens []*Document_Page_Token `protobuf:"bytes,8,rep,name=tokens,proto3" json:"tokens,omitempty"`
    // A list of detected non-text visual elements e.g. checkbox,
    // signature etc. on the page.
    VisualElements []*Document_Page_VisualElement `protobuf:"bytes,9,rep,name=visual_elements,json=visualElements,proto3" json:"visual_elements,omitempty"`
    // A list of visually detected tables on the page.
    Tables []*Document_Page_Table `protobuf:"bytes,10,rep,name=tables,proto3" json:"tables,omitempty"`
    // A list of visually detected form fields on the page.
    FormFields []*Document_Page_FormField `protobuf:"bytes,11,rep,name=form_fields,json=formFields,proto3" json:"form_fields,omitempty"`
    // contains filtered or unexported fields
}

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

func (*Document_Page) Descriptor Uses

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

Deprecated: Use Document_Page.ProtoReflect.Descriptor instead.

func (*Document_Page) GetBlocks Uses

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

func (*Document_Page) GetDetectedLanguages Uses

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

func (*Document_Page) GetDimension Uses

func (x *Document_Page) GetDimension() *Document_Page_Dimension

func (*Document_Page) GetFormFields Uses

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

func (*Document_Page) GetImage Uses

func (x *Document_Page) GetImage() *Document_Page_Image

func (*Document_Page) GetLayout Uses

func (x *Document_Page) GetLayout() *Document_Page_Layout

func (*Document_Page) GetLines Uses

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

func (*Document_Page) GetPageNumber Uses

func (x *Document_Page) GetPageNumber() int32

func (*Document_Page) GetParagraphs Uses

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

func (*Document_Page) GetTables Uses

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

func (*Document_Page) GetTokens Uses

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

func (*Document_Page) GetTransforms Uses

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

func (*Document_Page) GetVisualElements Uses

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

func (*Document_Page) ProtoMessage Uses

func (*Document_Page) ProtoMessage()

func (*Document_Page) ProtoReflect Uses

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

func (*Document_Page) Reset Uses

func (x *Document_Page) Reset()

func (*Document_Page) String Uses

func (x *Document_Page) String() string

type Document_PageAnchor Uses

type Document_PageAnchor struct {

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

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

func (*Document_PageAnchor) Descriptor Uses

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

Deprecated: Use Document_PageAnchor.ProtoReflect.Descriptor instead.

func (*Document_PageAnchor) GetPageRefs Uses

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

func (*Document_PageAnchor) ProtoMessage Uses

func (*Document_PageAnchor) ProtoMessage()

func (*Document_PageAnchor) ProtoReflect Uses

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

func (*Document_PageAnchor) Reset Uses

func (x *Document_PageAnchor) Reset()

func (*Document_PageAnchor) String Uses

func (x *Document_PageAnchor) String() string

type Document_PageAnchor_PageRef Uses

type Document_PageAnchor_PageRef struct {

    // Required. Index into the [Document.pages][google.cloud.documentai.v1beta3.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 any.
    LayoutType Document_PageAnchor_PageRef_LayoutType `protobuf:"varint,2,opt,name=layout_type,json=layoutType,proto3,enum=google.cloud.documentai.v1beta3.Document_PageAnchor_PageRef_LayoutType" json:"layout_type,omitempty"`
    // Optional. Deprecated.  Use [PageRef.bounding_poly][google.cloud.documentai.v1beta3.Document.PageAnchor.PageRef.bounding_poly] instead.
    //
    // Deprecated: Do not use.
    LayoutId string `protobuf:"bytes,3,opt,name=layout_id,json=layoutId,proto3" json:"layout_id,omitempty"`
    // Optional. Identifies the bounding polygon of a layout element on the page.
    BoundingPoly *BoundingPoly `protobuf:"bytes,4,opt,name=bounding_poly,json=boundingPoly,proto3" json:"bounding_poly,omitempty"`
    // contains filtered or unexported fields
}

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

func (*Document_PageAnchor_PageRef) Descriptor Uses

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

Deprecated: Use Document_PageAnchor_PageRef.ProtoReflect.Descriptor instead.

func (*Document_PageAnchor_PageRef) GetBoundingPoly Uses

func (x *Document_PageAnchor_PageRef) GetBoundingPoly() *BoundingPoly

func (*Document_PageAnchor_PageRef) GetLayoutId Uses

func (x *Document_PageAnchor_PageRef) GetLayoutId() string

Deprecated: Do not use.

func (*Document_PageAnchor_PageRef) GetLayoutType Uses

func (x *Document_PageAnchor_PageRef) GetLayoutType() Document_PageAnchor_PageRef_LayoutType

func (*Document_PageAnchor_PageRef) GetPage Uses

func (x *Document_PageAnchor_PageRef) GetPage() int64

func (*Document_PageAnchor_PageRef) ProtoMessage Uses

func (*Document_PageAnchor_PageRef) ProtoMessage()

func (*Document_PageAnchor_PageRef) ProtoReflect Uses

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

func (*Document_PageAnchor_PageRef) Reset Uses

func (x *Document_PageAnchor_PageRef) Reset()

func (*Document_PageAnchor_PageRef) String Uses

func (x *Document_PageAnchor_PageRef) String() string

type Document_PageAnchor_PageRef_LayoutType Uses

type Document_PageAnchor_PageRef_LayoutType int32

The type of layout that is being referenced.

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

func (Document_PageAnchor_PageRef_LayoutType) Descriptor Uses

func (Document_PageAnchor_PageRef_LayoutType) Descriptor() protoreflect.EnumDescriptor

func (Document_PageAnchor_PageRef_LayoutType) Enum Uses

func (x Document_PageAnchor_PageRef_LayoutType) Enum() *Document_PageAnchor_PageRef_LayoutType

func (Document_PageAnchor_PageRef_LayoutType) EnumDescriptor Uses

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

Deprecated: Use Document_PageAnchor_PageRef_LayoutType.Descriptor instead.

func (Document_PageAnchor_PageRef_LayoutType) Number Uses

func (x Document_PageAnchor_PageRef_LayoutType) Number() protoreflect.EnumNumber

func (Document_PageAnchor_PageRef_LayoutType) String Uses

func (x Document_PageAnchor_PageRef_LayoutType) String() string

func (Document_PageAnchor_PageRef_LayoutType) Type Uses

func (Document_PageAnchor_PageRef_LayoutType) Type() protoreflect.EnumType

type Document_Page_Block Uses

type Document_Page_Block struct {

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

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

func (*Document_Page_Block) Descriptor Uses

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

Deprecated: Use Document_Page_Block.ProtoReflect.Descriptor instead.

func (*Document_Page_Block) GetDetectedLanguages Uses

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

func (*Document_Page_Block) GetLayout Uses

func (x *Document_Page_Block) GetLayout() *Document_Page_Layout

func (*Document_Page_Block) GetProvenance Uses

func (x *Document_Page_Block) GetProvenance() *Document_Provenance

func (*Document_Page_Block) ProtoMessage Uses

func (*Document_Page_Block) ProtoMessage()

func (*Document_Page_Block) ProtoReflect Uses

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

func (*Document_Page_Block) Reset Uses

func (x *Document_Page_Block) Reset()

func (*Document_Page_Block) String Uses

func (x *Document_Page_Block) String() string

type Document_Page_DetectedLanguage Uses

type Document_Page_DetectedLanguage struct {

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

Detected language for a structural component.

func (*Document_Page_DetectedLanguage) Descriptor Uses

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

Deprecated: Use Document_Page_DetectedLanguage.ProtoReflect.Descriptor instead.

func (*Document_Page_DetectedLanguage) GetConfidence Uses

func (x *Document_Page_DetectedLanguage) GetConfidence() float32

func (*Document_Page_DetectedLanguage) GetLanguageCode Uses

func (x *Document_Page_DetectedLanguage) GetLanguageCode() string

func (*Document_Page_DetectedLanguage) ProtoMessage Uses

func (*Document_Page_DetectedLanguage) ProtoMessage()

func (*Document_Page_DetectedLanguage) ProtoReflect Uses

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

func (*Document_Page_DetectedLanguage) Reset Uses

func (x *Document_Page_DetectedLanguage) Reset()

func (*Document_Page_DetectedLanguage) String Uses

func (x *Document_Page_DetectedLanguage) String() string

type Document_Page_Dimension Uses

type Document_Page_Dimension struct {

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

Dimension for the page.

func (*Document_Page_Dimension) Descriptor Uses

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

Deprecated: Use Document_Page_Dimension.ProtoReflect.Descriptor instead.

func (*Document_Page_Dimension) GetHeight Uses

func (x *Document_Page_Dimension) GetHeight() float32

func (*Document_Page_Dimension) GetUnit Uses

func (x *Document_Page_Dimension) GetUnit() string

func (*Document_Page_Dimension) GetWidth Uses

func (x *Document_Page_Dimension) GetWidth() float32

func (*Document_Page_Dimension) ProtoMessage Uses

func (*Document_Page_Dimension) ProtoMessage()

func (*Document_Page_Dimension) ProtoReflect Uses

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

func (*Document_Page_Dimension) Reset Uses

func (x *Document_Page_Dimension) Reset()

func (*Document_Page_Dimension) String Uses

func (x *Document_Page_Dimension) String() string

type Document_Page_FormField Uses

type Document_Page_FormField struct {

    // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1beta3.Document.Page.FormField] name. e.g. `Address`, `Email`,
    // `Grand total`, `Phone number`, etc.
    FieldName *Document_Page_Layout `protobuf:"bytes,1,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
    // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1beta3.Document.Page.FormField] value.
    FieldValue *Document_Page_Layout `protobuf:"bytes,2,opt,name=field_value,json=fieldValue,proto3" json:"field_value,omitempty"`
    // A list of detected languages for name together with confidence.
    NameDetectedLanguages []*Document_Page_DetectedLanguage `protobuf:"bytes,3,rep,name=name_detected_languages,json=nameDetectedLanguages,proto3" json:"name_detected_languages,omitempty"`
    // A list of detected languages for value together with confidence.
    ValueDetectedLanguages []*Document_Page_DetectedLanguage `protobuf:"bytes,4,rep,name=value_detected_languages,json=valueDetectedLanguages,proto3" json:"value_detected_languages,omitempty"`
    // 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"`
    // contains filtered or unexported fields
}

A form field detected on the page.

func (*Document_Page_FormField) Descriptor Uses

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

Deprecated: Use Document_Page_FormField.ProtoReflect.Descriptor instead.

func (*Document_Page_FormField) GetFieldName Uses

func (x *Document_Page_FormField) GetFieldName() *Document_Page_Layout

func (*Document_Page_FormField) GetFieldValue Uses

func (x *Document_Page_FormField) GetFieldValue() *Document_Page_Layout

func (*Document_Page_FormField) GetNameDetectedLanguages Uses

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

func (*Document_Page_FormField) GetValueDetectedLanguages Uses

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

func (*Document_Page_FormField) GetValueType Uses

func (x *Document_Page_FormField) GetValueType() string

func (*Document_Page_FormField) ProtoMessage Uses

func (*Document_Page_FormField) ProtoMessage()

func (*Document_Page_FormField) ProtoReflect Uses

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

func (*Document_Page_FormField) Reset Uses

func (x *Document_Page_FormField) Reset()

func (*Document_Page_FormField) String Uses

func (x *Document_Page_FormField) String() string

type Document_Page_Image Uses

type Document_Page_Image struct {

    // Raw byte content of the image.
    Content []byte `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"`
    // Encoding mime type for the image.
    MimeType string `protobuf:"bytes,2,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
    // Width of the image in pixels.
    Width int32 `protobuf:"varint,3,opt,name=width,proto3" json:"width,omitempty"`
    // Height of the image in pixels.
    Height int32 `protobuf:"varint,4,opt,name=height,proto3" json:"height,omitempty"`
    // contains filtered or unexported fields
}

Rendered image contents for this page.

func (*Document_Page_Image) Descriptor Uses

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

Deprecated: Use Document_Page_Image.ProtoReflect.Descriptor instead.

func (*Document_Page_Image) GetContent Uses

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

func (*Document_Page_Image) GetHeight Uses

func (x *Document_Page_Image) GetHeight() int32

func (*Document_Page_Image) GetMimeType Uses

func (x *Document_Page_Image) GetMimeType() string

func (*Document_Page_Image) GetWidth Uses

func (x *Document_Page_Image) GetWidth() int32

func (*Document_Page_Image) ProtoMessage Uses

func (*Document_Page_Image) ProtoMessage()

func (*Document_Page_Image) ProtoReflect Uses

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

func (*Document_Page_Image) Reset Uses

func (x *Document_Page_Image) Reset()

func (*Document_Page_Image) String Uses

func (x *Document_Page_Image) String() string

type Document_Page_Layout Uses

type Document_Page_Layout struct {

    // Text anchor indexing into the [Document.text][google.cloud.documentai.v1beta3.Document.text].
    TextAnchor *Document_TextAnchor `protobuf:"bytes,1,opt,name=text_anchor,json=textAnchor,proto3" json:"text_anchor,omitempty"`
    // Confidence of the current [Layout][google.cloud.documentai.v1beta3.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.v1beta3.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.v1beta3.Document.Page.Layout].
    Orientation Document_Page_Layout_Orientation `protobuf:"varint,4,opt,name=orientation,proto3,enum=google.cloud.documentai.v1beta3.Document_Page_Layout_Orientation" json:"orientation,omitempty"`
    // contains filtered or unexported fields
}

Visual element describing a layout unit on a page.

func (*Document_Page_Layout) Descriptor Uses

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

Deprecated: Use Document_Page_Layout.ProtoReflect.Descriptor instead.

func (*Document_Page_Layout) GetBoundingPoly Uses

func (x *Document_Page_Layout) GetBoundingPoly() *BoundingPoly

func (*Document_Page_Layout) GetConfidence Uses

func (x *Document_Page_Layout) GetConfidence() float32

func (*Document_Page_Layout) GetOrientation Uses

func (x *Document_Page_Layout) GetOrientation() Document_Page_Layout_Orientation

func (*Document_Page_Layout) GetTextAnchor Uses

func (x *Document_Page_Layout) GetTextAnchor() *Document_TextAnchor

func (*Document_Page_Layout) ProtoMessage Uses

func (*Document_Page_Layout) ProtoMessage()

func (*Document_Page_Layout) ProtoReflect Uses

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

func (*Document_Page_Layout) Reset Uses

func (x *Document_Page_Layout) Reset()

func (*Document_Page_Layout) String Uses

func (x *Document_Page_Layout) String() string

type Document_Page_Layout_Orientation Uses

type Document_Page_Layout_Orientation int32

Detected human reading orientation.

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

func (Document_Page_Layout_Orientation) Descriptor Uses

func (Document_Page_Layout_Orientation) Descriptor() protoreflect.EnumDescriptor

func (Document_Page_Layout_Orientation) Enum Uses

func (x Document_Page_Layout_Orientation) Enum() *Document_Page_Layout_Orientation

func (Document_Page_Layout_Orientation) EnumDescriptor Uses

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

Deprecated: Use Document_Page_Layout_Orientation.Descriptor instead.

func (Document_Page_Layout_Orientation) Number Uses

func (x Document_Page_Layout_Orientation) Number() protoreflect.EnumNumber

func (Document_Page_Layout_Orientation) String Uses

func (x Document_Page_Layout_Orientation) String() string

func (Document_Page_Layout_Orientation) Type Uses

func (Document_Page_Layout_Orientation) Type() protoreflect.EnumType

type Document_Page_Line Uses

type Document_Page_Line struct {

    // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for [Line][google.cloud.documentai.v1beta3.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"`
    // The  history of this annotation.
    Provenance *Document_Provenance `protobuf:"bytes,3,opt,name=provenance,proto3" json:"provenance,omitempty"`
    // contains filtered or unexported fields
}

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

func (*Document_Page_Line) Descriptor Uses

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

Deprecated: Use Document_Page_Line.ProtoReflect.Descriptor instead.

func (*Document_Page_Line) GetDetectedLanguages Uses

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

func (*Document_Page_Line) GetLayout Uses

func (x *Document_Page_Line) GetLayout() *Document_Page_Layout

func (*Document_Page_Line) GetProvenance Uses

func (x *Document_Page_Line) GetProvenance() *Document_Provenance

func (*Document_Page_Line) ProtoMessage Uses

func (*Document_Page_Line) ProtoMessage()

func (*Document_Page_Line) ProtoReflect Uses

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

func (*Document_Page_Line) Reset Uses

func (x *Document_Page_Line) Reset()

func (*Document_Page_Line) String Uses

func (x *Document_Page_Line) String() string

type Document_Page_Matrix Uses

type Document_Page_Matrix struct {

    // Number of rows in the matrix.
    Rows int32 `protobuf:"varint,1,opt,name=rows,proto3" json:"rows,omitempty"`
    // Number of columns in the matrix.
    Cols int32 `protobuf:"varint,2,opt,name=cols,proto3" json:"cols,omitempty"`
    // This encodes information about what data type the matrix uses.
    // For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list
    // of OpenCV primitive data types, please refer to
    // https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html
    Type int32 `protobuf:"varint,3,opt,name=type,proto3" json:"type,omitempty"`
    // The matrix data.
    Data []byte `protobuf:"bytes,4,opt,name=data,proto3" json:"data,omitempty"`
    // contains filtered or unexported fields
}

Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.

func (*Document_Page_Matrix) Descriptor Uses

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

Deprecated: Use Document_Page_Matrix.ProtoReflect.Descriptor instead.

func (*Document_Page_Matrix) GetCols Uses

func (x *Document_Page_Matrix) GetCols() int32

func (*Document_Page_Matrix) GetData Uses

func (x *Document_Page_Matrix) GetData() []byte

func (*Document_Page_Matrix) GetRows Uses

func (x *Document_Page_Matrix) GetRows() int32

func (*Document_Page_Matrix) GetType Uses

func (x *Document_Page_Matrix) GetType() int32

func (*Document_Page_Matrix) ProtoMessage Uses

func (*Document_Page_Matrix) ProtoMessage()

func (*Document_Page_Matrix) ProtoReflect Uses

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

func (*Document_Page_Matrix) Reset Uses

func (x *Document_Page_Matrix) Reset()

func (*Document_Page_Matrix) String Uses

func (x *Document_Page_Matrix) String() string

type Document_Page_Paragraph Uses

type Document_Page_Paragraph struct {

    // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for [Paragraph][google.cloud.documentai.v1beta3.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"`
    // The  history of this annotation.
    Provenance *Document_Provenance `protobuf:"bytes,3,opt,name=provenance,proto3" json:"provenance,omitempty"`
    // contains filtered or unexported fields
}

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

func (*Document_Page_Paragraph) Descriptor Uses

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

Deprecated: Use Document_Page_Paragraph.ProtoReflect.Descriptor instead.

func (*Document_Page_Paragraph) GetDetectedLanguages Uses

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

func (*Document_Page_Paragraph) GetLayout Uses

func (x *Document_Page_Paragraph) GetLayout() *Document_Page_Layout

func (*Document_Page_Paragraph) GetProvenance Uses

func (x *Document_Page_Paragraph) GetProvenance() *Document_Provenance

func (*Document_Page_Paragraph) ProtoMessage Uses

func (*Document_Page_Paragraph) ProtoMessage()

func (*Document_Page_Paragraph) ProtoReflect Uses

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

func (*Document_Page_Paragraph) Reset Uses

func (x *Document_Page_Paragraph) Reset()

func (*Document_Page_Paragraph) String Uses

func (x *Document_Page_Paragraph) String() string

type Document_Page_Table Uses

type Document_Page_Table struct {

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

A table representation similar to HTML table structure.

func (*Document_Page_Table) Descriptor Uses

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

Deprecated: Use Document_Page_Table.ProtoReflect.Descriptor instead.

func (*Document_Page_Table) GetBodyRows Uses

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

func (*Document_Page_Table) GetDetectedLanguages Uses

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

func (*Document_Page_Table) GetHeaderRows Uses

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

func (*Document_Page_Table) GetLayout Uses

func (x *Document_Page_Table) GetLayout() *Document_Page_Layout

func (*Document_Page_Table) ProtoMessage Uses

func (*Document_Page_Table) ProtoMessage()

func (*Document_Page_Table) ProtoReflect Uses

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

func (*Document_Page_Table) Reset Uses

func (x *Document_Page_Table) Reset()

func (*Document_Page_Table) String Uses

func (x *Document_Page_Table) String() string

type Document_Page_Table_TableCell Uses

type Document_Page_Table_TableCell struct {

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

A cell representation inside the table.

func (*Document_Page_Table_TableCell) Descriptor Uses

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

Deprecated: Use Document_Page_Table_TableCell.ProtoReflect.Descriptor instead.

func (*Document_Page_Table_TableCell) GetColSpan Uses

func (x *Document_Page_Table_TableCell) GetColSpan() int32

func (*Document_Page_Table_TableCell) GetDetectedLanguages Uses

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

func (*Document_Page_Table_TableCell) GetLayout Uses

func (x *Document_Page_Table_TableCell) GetLayout() *Document_Page_Layout

func (*Document_Page_Table_TableCell) GetRowSpan Uses

func (x *Document_Page_Table_TableCell) GetRowSpan() int32

func (*Document_Page_Table_TableCell) ProtoMessage Uses

func (*Document_Page_Table_TableCell) ProtoMessage()

func (*Document_Page_Table_TableCell) ProtoReflect Uses

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

func (*Document_Page_Table_TableCell) Reset Uses

func (x *Document_Page_Table_TableCell) Reset()

func (*Document_Page_Table_TableCell) String Uses

func (x *Document_Page_Table_TableCell) String() string

type Document_Page_Table_TableRow Uses

type Document_Page_Table_TableRow struct {

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

A row of table cells.

func (*Document_Page_Table_TableRow) Descriptor Uses

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

Deprecated: Use Document_Page_Table_TableRow.ProtoReflect.Descriptor instead.

func (*Document_Page_Table_TableRow) GetCells Uses

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

func (*Document_Page_Table_TableRow) ProtoMessage Uses

func (*Document_Page_Table_TableRow) ProtoMessage()

func (*Document_Page_Table_TableRow) ProtoReflect Uses

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

func (*Document_Page_Table_TableRow) Reset Uses

func (x *Document_Page_Table_TableRow) Reset()

func (*Document_Page_Table_TableRow) String Uses

func (x *Document_Page_Table_TableRow) String() string

type Document_Page_Token Uses

type Document_Page_Token struct {

    // [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for [Token][google.cloud.documentai.v1beta3.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.v1beta3.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"`
    // The  history of this annotation.
    Provenance *Document_Provenance `protobuf:"bytes,4,opt,name=provenance,proto3" json:"provenance,omitempty"`
    // contains filtered or unexported fields
}

A detected token.

func (*Document_Page_Token) Descriptor Uses

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

Deprecated: Use Document_Page_Token.ProtoReflect.Descriptor instead.

func (*Document_Page_Token) GetDetectedBreak Uses

func (x *Document_Page_Token) GetDetectedBreak() *Document_Page_Token_DetectedBreak

func (*Document_Page_Token) GetDetectedLanguages Uses

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

func (*Document_Page_Token) GetLayout Uses

func (x *Document_Page_Token) GetLayout() *Document_Page_Layout

func (*Document_Page_Token) GetProvenance Uses

func (x *Document_Page_Token) GetProvenance() *Document_Provenance

func (*Document_Page_Token) ProtoMessage Uses

func (*Document_Page_Token) ProtoMessage()

func (*Document_Page_Token) ProtoReflect Uses

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

func (*Document_Page_Token) Reset Uses

func (x *Document_Page_Token) Reset()

func (*Document_Page_Token) String Uses

func (x *Document_Page_Token) String() string

type Document_Page_Token_DetectedBreak Uses

type Document_Page_Token_DetectedBreak struct {

    // Detected break type.
    Type Document_Page_Token_DetectedBreak_Type `protobuf:"varint,1,opt,name=type,proto3,enum=google.cloud.documentai.v1beta3.Document_Page_Token_DetectedBreak_Type" json:"type,omitempty"`
    // contains filtered or unexported fields
}

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

func (*Document_Page_Token_DetectedBreak) Descriptor Uses

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

Deprecated: Use Document_Page_Token_DetectedBreak.ProtoReflect.Descriptor instead.

func (*Document_Page_Token_DetectedBreak) GetType Uses

func (x *Document_Page_Token_DetectedBreak) GetType() Document_Page_Token_DetectedBreak_Type

func (*Document_Page_Token_DetectedBreak) ProtoMessage Uses

func (*Document_Page_Token_DetectedBreak) ProtoMessage()

func (*Document_Page_Token_DetectedBreak) ProtoReflect Uses

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

func (*Document_Page_Token_DetectedBreak) Reset Uses

func (x *Document_Page_Token_DetectedBreak) Reset()

func (*Document_Page_Token_DetectedBreak) String Uses

func (x *Document_Page_Token_DetectedBreak) String() string

type Document_Page_Token_DetectedBreak_Type Uses

type Document_Page_Token_DetectedBreak_Type int32

Enum to denote the type of break found.

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

func (Document_Page_Token_DetectedBreak_Type) Descriptor Uses

func (Document_Page_Token_DetectedBreak_Type) Descriptor() protoreflect.EnumDescriptor

func (Document_Page_Token_DetectedBreak_Type) Enum Uses

func (x Document_Page_Token_DetectedBreak_Type) Enum() *Document_Page_Token_DetectedBreak_Type

func (Document_Page_Token_DetectedBreak_Type) EnumDescriptor Uses

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

Deprecated: Use Document_Page_Token_DetectedBreak_Type.Descriptor instead.

func (Document_Page_Token_DetectedBreak_Type) Number Uses

func (x Document_Page_Token_DetectedBreak_Type) Number() protoreflect.EnumNumber

func (Document_Page_Token_DetectedBreak_Type) String Uses

func (x Document_Page_Token_DetectedBreak_Type) String() string

func (Document_Page_Token_DetectedBreak_Type) Type Uses

func (Document_Page_Token_DetectedBreak_Type) Type() protoreflect.EnumType

type Document_Page_VisualElement Uses

type Document_Page_VisualElement struct {

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

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

func (*Document_Page_VisualElement) Descriptor Uses

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

Deprecated: Use Document_Page_VisualElement.ProtoReflect.Descriptor instead.

func (*Document_Page_VisualElement) GetDetectedLanguages Uses

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

func (*Document_Page_VisualElement) GetLayout Uses

func (x *Document_Page_VisualElement) GetLayout() *Document_Page_Layout

func (*Document_Page_VisualElement) GetType Uses

func (x *Document_Page_VisualElement) GetType() string

func (*Document_Page_VisualElement) ProtoMessage Uses

func (*Document_Page_VisualElement) ProtoMessage()

func (*Document_Page_VisualElement) ProtoReflect Uses

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

func (*Document_Page_VisualElement) Reset Uses

func (x *Document_Page_VisualElement) Reset()

func (*Document_Page_VisualElement) String Uses

func (x *Document_Page_VisualElement) String() string

type Document_Provenance Uses

type Document_Provenance struct {

    // The index of the revision that produced this element.
    Revision int32 `protobuf:"varint,1,opt,name=revision,proto3" json:"revision,omitempty"`
    // The Id of this operation.  Needs to be unique within the scope of the
    // revision.
    Id  int32 `protobuf:"varint,2,opt,name=id,proto3" json:"id,omitempty"`
    // References to the original elements that are replaced.
    Parents []*Document_Provenance_Parent `protobuf:"bytes,3,rep,name=parents,proto3" json:"parents,omitempty"`
    // The type of provenance operation.
    Type Document_Provenance_OperationType `protobuf:"varint,4,opt,name=type,proto3,enum=google.cloud.documentai.v1beta3.Document_Provenance_OperationType" json:"type,omitempty"`
    // contains filtered or unexported fields
}

Structure to identify provenance relationships between annotations in different revisions.

func (*Document_Provenance) Descriptor Uses

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

Deprecated: Use Document_Provenance.ProtoReflect.Descriptor instead.

func (*Document_Provenance) GetId Uses

func (x *Document_Provenance) GetId() int32

func (*Document_Provenance) GetParents Uses

func (x *Document_Provenance) GetParents() []*Document_Provenance_Parent

func (*Document_Provenance) GetRevision Uses

func (x *Document_Provenance) GetRevision() int32

func (*Document_Provenance) GetType Uses

func (x *Document_Provenance) GetType() Document_Provenance_OperationType

func (*Document_Provenance) ProtoMessage Uses

func (*Document_Provenance) ProtoMessage()

func (*Document_Provenance) ProtoReflect Uses

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

func (*Document_Provenance) Reset Uses

func (x *Document_Provenance) Reset()

func (*Document_Provenance) String Uses

func (x *Document_Provenance) String() string

type Document_Provenance_OperationType Uses

type Document_Provenance_OperationType int32

If a processor or agent does an explicit operation on existing elements.

const (
    // Operation type unspecified.
    Document_Provenance_OPERATION_TYPE_UNSPECIFIED Document_Provenance_OperationType = 0
    // Add an element.  Implicit if no `parents` are set for the provenance.
    Document_Provenance_ADD Document_Provenance_OperationType = 1
    // The element is removed.  No `parents` should be set.
    Document_Provenance_REMOVE Document_Provenance_OperationType = 2
    // Explicitly replaces the element(s) identified by `parents`.
    Document_Provenance_REPLACE Document_Provenance_OperationType = 3
    // Element is requested for human review.
    Document_Provenance_EVAL_REQUESTED Document_Provenance_OperationType = 4
    // Element is review and approved at human review, confidence will be set
    // to 1.0
    Document_Provenance_EVAL_APPROVED Document_Provenance_OperationType = 5
)

func (Document_Provenance_OperationType) Descriptor Uses

func (Document_Provenance_OperationType) Descriptor() protoreflect.EnumDescriptor

func (Document_Provenance_OperationType) Enum Uses

func (x Document_Provenance_OperationType) Enum() *Document_Provenance_OperationType

func (Document_Provenance_OperationType) EnumDescriptor Uses

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

Deprecated: Use Document_Provenance_OperationType.Descriptor instead.

func (Document_Provenance_OperationType) Number Uses

func (x Document_Provenance_OperationType) Number() protoreflect.EnumNumber

func (Document_Provenance_OperationType) String Uses

func (x Document_Provenance_OperationType) String() string

func (Document_Provenance_OperationType) Type Uses

func (Document_Provenance_OperationType) Type() protoreflect.EnumType

type Document_Provenance_Parent Uses

type Document_Provenance_Parent struct {

    // The index of the [Document.revisions] identifying the parent revision.
    Revision int32 `protobuf:"varint,1,opt,name=revision,proto3" json:"revision,omitempty"`
    // The id of the parent provenance.
    Id  int32 `protobuf:"varint,2,opt,name=id,proto3" json:"id,omitempty"`
    // contains filtered or unexported fields
}

Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced.

func (*Document_Provenance_Parent) Descriptor Uses

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

Deprecated: Use Document_Provenance_Parent.ProtoReflect.Descriptor instead.

func (*Document_Provenance_Parent) GetId Uses

func (x *Document_Provenance_Parent) GetId() int32

func (*Document_Provenance_Parent) GetRevision Uses

func (x *Document_Provenance_Parent) GetRevision() int32

func (*Document_Provenance_Parent) ProtoMessage Uses

func (*Document_Provenance_Parent) ProtoMessage()

func (*Document_Provenance_Parent) ProtoReflect Uses

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

func (*Document_Provenance_Parent) Reset Uses

func (x *Document_Provenance_Parent) Reset()

func (*Document_Provenance_Parent) String Uses

func (x *Document_Provenance_Parent) String() string

type Document_Revision Uses

type Document_Revision struct {

    // Who/what made the change
    //
    // Types that are assignable to Source:
    //	*Document_Revision_Agent
    //	*Document_Revision_Processor
    Source isDocument_Revision_Source `protobuf_oneof:"source"`
    // Id of the revision.  Unique within the context of the document.
    Id  string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
    // The revisions that this revision is based on.  This can include one or
    // more parent (when documents are merged.)  This field represents the
    // index into the `revisions` field.
    Parent []int32 `protobuf:"varint,2,rep,packed,name=parent,proto3" json:"parent,omitempty"`
    // The time that the revision was created.
    CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
    // Human Review information of this revision.
    HumanReview *Document_Revision_HumanReview `protobuf:"bytes,6,opt,name=human_review,json=humanReview,proto3" json:"human_review,omitempty"`
    // contains filtered or unexported fields
}

Contains past or forward revisions of this document.

func (*Document_Revision) Descriptor Uses

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

Deprecated: Use Document_Revision.ProtoReflect.Descriptor instead.

func (*Document_Revision) GetAgent Uses

func (x *Document_Revision) GetAgent() string

func (*Document_Revision) GetCreateTime Uses

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

func (*Document_Revision) GetHumanReview Uses

func (x *Document_Revision) GetHumanReview() *Document_Revision_HumanReview

func (*Document_Revision) GetId Uses

func (x *Document_Revision) GetId() string

func (*Document_Revision) GetParent Uses

func (x *Document_Revision) GetParent() []int32

func (*Document_Revision) GetProcessor Uses

func (x *Document_Revision) GetProcessor() string

func (*Document_Revision) GetSource Uses

func (m *Document_Revision) GetSource() isDocument_Revision_Source

func (*Document_Revision) ProtoMessage Uses

func (*Document_Revision) ProtoMessage()

func (*Document_Revision) ProtoReflect Uses

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

func (*Document_Revision) Reset Uses

func (x *Document_Revision) Reset()

func (*Document_Revision) String Uses

func (x *Document_Revision) String() string

type Document_Revision_Agent Uses

type Document_Revision_Agent struct {
    // If the change was made by a person specify the name or id of that
    // person.
    Agent string `protobuf:"bytes,4,opt,name=agent,proto3,oneof"`
}

type Document_Revision_HumanReview Uses

type Document_Revision_HumanReview struct {

    // Human review state. e.g. `requested`, `succeeded`, `rejected`.
    State string `protobuf:"bytes,1,opt,name=state,proto3" json:"state,omitempty"`
    // A message providing more details about the current state of processing.
    // For example, the rejection reason when the state is `rejected`.
    StateMessage string `protobuf:"bytes,2,opt,name=state_message,json=stateMessage,proto3" json:"state_message,omitempty"`
    // contains filtered or unexported fields
}

Human Review information of the document.

func (*Document_Revision_HumanReview) Descriptor Uses

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

Deprecated: Use Document_Revision_HumanReview.ProtoReflect.Descriptor instead.

func (*Document_Revision_HumanReview) GetState Uses

func (x *Document_Revision_HumanReview) GetState() string

func (*Document_Revision_HumanReview) GetStateMessage Uses

func (x *Document_Revision_HumanReview) GetStateMessage() string

func (*Document_Revision_HumanReview) ProtoMessage Uses

func (*Document_Revision_HumanReview) ProtoMessage()

func (*Document_Revision_HumanReview) ProtoReflect Uses

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

func (*Document_Revision_HumanReview) Reset Uses

func (x *Document_Revision_HumanReview) Reset()

func (*Document_Revision_HumanReview) String Uses

func (x *Document_Revision_HumanReview) String() string

type Document_Revision_Processor Uses

type Document_Revision_Processor struct {
    // If the annotation was made by processor identify the processor by its
    // resource name.
    Processor string `protobuf:"bytes,5,opt,name=processor,proto3,oneof"`
}

type Document_ShardInfo Uses

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.v1beta3.Document.text] in the overall
    // document global text.
    TextOffset int64 `protobuf:"varint,3,opt,name=text_offset,json=textOffset,proto3" json:"text_offset,omitempty"`
    // contains filtered or unexported fields
}

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

func (*Document_ShardInfo) Descriptor Uses

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

Deprecated: Use Document_ShardInfo.ProtoReflect.Descriptor instead.

func (*Document_ShardInfo) GetShardCount Uses

func (x *Document_ShardInfo) GetShardCount() int64

func (*Document_ShardInfo) GetShardIndex Uses

func (x *Document_ShardInfo) GetShardIndex() int64

func (*Document_ShardInfo) GetTextOffset Uses

func (x *Document_ShardInfo) GetTextOffset() int64

func (*Document_ShardInfo) ProtoMessage Uses

func (*Document_ShardInfo) ProtoMessage()

func (*Document_ShardInfo) ProtoReflect Uses

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

func (*Document_ShardInfo) Reset Uses

func (x *Document_ShardInfo) Reset()

func (*Document_ShardInfo) String Uses

func (x *Document_ShardInfo) String() string

type Document_Style Uses

type Document_Style struct {

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

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

func (*Document_Style) Descriptor Uses

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

Deprecated: Use Document_Style.ProtoReflect.Descriptor instead.

func (*Document_Style) GetBackgroundColor Uses

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

func (*Document_Style) GetColor Uses

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

func (*Document_Style) GetFontSize Uses

func (x *Document_Style) GetFontSize() *Document_Style_FontSize

func (*Document_Style) GetFontWeight Uses

func (x *Document_Style) GetFontWeight() string

func (*Document_Style) GetTextAnchor Uses

func (x *Document_Style) GetTextAnchor() *Document_TextAnchor

func (*Document_Style) GetTextDecoration Uses

func (x *Document_Style) GetTextDecoration() string

func (*Document_Style) GetTextStyle Uses

func (x *Document_Style) GetTextStyle() string

func (*Document_Style) ProtoMessage Uses

func (*Document_Style) ProtoMessage()

func (*Document_Style) ProtoReflect Uses

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

func (*Document_Style) Reset Uses

func (x *Document_Style) Reset()

func (*Document_Style) String Uses

func (x *Document_Style) String() string

type Document_Style_FontSize Uses

type Document_Style_FontSize struct {

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

Font size with unit.

func (*Document_Style_FontSize) Descriptor Uses

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

Deprecated: Use Document_Style_FontSize.ProtoReflect.Descriptor instead.

func (*Document_Style_FontSize) GetSize Uses

func (x *Document_Style_FontSize) GetSize() float32

func (*Document_Style_FontSize) GetUnit Uses

func (x *Document_Style_FontSize) GetUnit() string

func (*Document_Style_FontSize) ProtoMessage Uses

func (*Document_Style_FontSize) ProtoMessage()

func (*Document_Style_FontSize) ProtoReflect Uses

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

func (*Document_Style_FontSize) Reset Uses

func (x *Document_Style_FontSize) Reset()

func (*Document_Style_FontSize) String Uses

func (x *Document_Style_FontSize) String() string

type Document_TextAnchor Uses

type Document_TextAnchor struct {

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

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

func (*Document_TextAnchor) Descriptor Uses

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

Deprecated: Use Document_TextAnchor.ProtoReflect.Descriptor instead.

func (*Document_TextAnchor) GetContent Uses

func (x *Document_TextAnchor) GetContent() string

func (*Document_TextAnchor) GetTextSegments Uses

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

func (*Document_TextAnchor) ProtoMessage Uses

func (*Document_TextAnchor) ProtoMessage()

func (*Document_TextAnchor) ProtoReflect Uses

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

func (*Document_TextAnchor) Reset Uses

func (x *Document_TextAnchor) Reset()

func (*Document_TextAnchor) String Uses

func (x *Document_TextAnchor) String() string

type Document_TextAnchor_TextSegment Uses

type Document_TextAnchor_TextSegment struct {

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

A text segment in the [Document.text][google.cloud.documentai.v1beta3.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.v1beta3.Document.ShardInfo.text_offset]

func (*Document_TextAnchor_TextSegment) Descriptor Uses

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

Deprecated: Use Document_TextAnchor_TextSegment.ProtoReflect.Descriptor instead.

func (*Document_TextAnchor_TextSegment) GetEndIndex Uses

func (x *Document_TextAnchor_TextSegment) GetEndIndex() int64

func (*Document_TextAnchor_TextSegment) GetStartIndex Uses

func (x *Document_TextAnchor_TextSegment) GetStartIndex() int64

func (*Document_TextAnchor_TextSegment) ProtoMessage Uses

func (*Document_TextAnchor_TextSegment) ProtoMessage()

func (*Document_TextAnchor_TextSegment) ProtoReflect Uses

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

func (*Document_TextAnchor_TextSegment) Reset Uses

func (x *Document_TextAnchor_TextSegment) Reset()

func (*Document_TextAnchor_TextSegment) String Uses

func (x *Document_TextAnchor_TextSegment) String() string

type Document_TextChange Uses

type Document_TextChange struct {

    // Provenance of the correction.
    // Text anchor indexing into the [Document.text][google.cloud.documentai.v1beta3.Document.text].  There can only be a
    // single `TextAnchor.text_segments` element.  If the start and
    // end index of the text segment are the same, the text change is inserted
    // before that index.
    TextAnchor *Document_TextAnchor `protobuf:"bytes,1,opt,name=text_anchor,json=textAnchor,proto3" json:"text_anchor,omitempty"`
    // The text that replaces the text identified in the `text_anchor`.
    ChangedText string `protobuf:"bytes,2,opt,name=changed_text,json=changedText,proto3" json:"changed_text,omitempty"`
    // The history of this annotation.
    Provenance []*Document_Provenance `protobuf:"bytes,3,rep,name=provenance,proto3" json:"provenance,omitempty"`
    // contains filtered or unexported fields
}

This message is used for text changes aka. OCR corrections.

func (*Document_TextChange) Descriptor Uses

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

Deprecated: Use Document_TextChange.ProtoReflect.Descriptor instead.

func (*Document_TextChange) GetChangedText Uses

func (x *Document_TextChange) GetChangedText() string

func (*Document_TextChange) GetProvenance Uses

func (x *Document_TextChange) GetProvenance() []*Document_Provenance

func (*Document_TextChange) GetTextAnchor Uses

func (x *Document_TextChange) GetTextAnchor() *Document_TextAnchor

func (*Document_TextChange) ProtoMessage Uses

func (*Document_TextChange) ProtoMessage()

func (*Document_TextChange) ProtoReflect Uses

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

func (*Document_TextChange) Reset Uses

func (x *Document_TextChange) Reset()

func (*Document_TextChange) String Uses

func (x *Document_TextChange) String() string

type Document_Translation Uses

type Document_Translation struct {

    // Provenance of the translation.
    // Text anchor indexing into the [Document.text][google.cloud.documentai.v1beta3.Document.text].  There can only be a
    // single `TextAnchor.text_segments` element.  If the start and
    // end index of the text segment are the same, the text change is inserted
    // before that index.
    TextAnchor *Document_TextAnchor `protobuf:"bytes,1,opt,name=text_anchor,json=textAnchor,proto3" json:"text_anchor,omitempty"`
    // 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,2,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
    // Text translated into the target language.
    TranslatedText string `protobuf:"bytes,3,opt,name=translated_text,json=translatedText,proto3" json:"translated_text,omitempty"`
    // The history of this annotation.
    Provenance []*Document_Provenance `protobuf:"bytes,4,rep,name=provenance,proto3" json:"provenance,omitempty"`
    // contains filtered or unexported fields
}

A translation of the text segment.

func (*Document_Translation) Descriptor Uses

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

Deprecated: Use Document_Translation.ProtoReflect.Descriptor instead.

func (*Document_Translation) GetLanguageCode Uses

func (x *Document_Translation) GetLanguageCode() string

func (*Document_Translation) GetProvenance Uses

func (x *Document_Translation) GetProvenance() []*Document_Provenance

func (*Document_Translation) GetTextAnchor Uses

func (x *Document_Translation) GetTextAnchor() *Document_TextAnchor

func (*Document_Translation) GetTranslatedText Uses

func (x *Document_Translation) GetTranslatedText() string

func (*Document_Translation) ProtoMessage Uses

func (*Document_Translation) ProtoMessage()

func (*Document_Translation) ProtoReflect Uses

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

func (*Document_Translation) Reset Uses

func (x *Document_Translation) Reset()

func (*Document_Translation) String Uses

func (x *Document_Translation) String() string

type Document_Uri Uses

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

type NormalizedVertex Uses

type NormalizedVertex struct {

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

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

func (*NormalizedVertex) Descriptor Uses

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

Deprecated: Use NormalizedVertex.ProtoReflect.Descriptor instead.

func (*NormalizedVertex) GetX Uses

func (x *NormalizedVertex) GetX() float32

func (*NormalizedVertex) GetY Uses

func (x *NormalizedVertex) GetY() float32

func (*NormalizedVertex) ProtoMessage Uses

func (*NormalizedVertex) ProtoMessage()

func (*NormalizedVertex) ProtoReflect Uses

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

func (*NormalizedVertex) Reset Uses

func (x *NormalizedVertex) Reset()

func (*NormalizedVertex) String Uses

func (x *NormalizedVertex) String() string

type ProcessRequest Uses

type ProcessRequest struct {

    // Required. The processor resource name.
    Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
    // The document payload, the [content] and [mime_type] fields must be set.
    Document *Document `protobuf:"bytes,2,opt,name=document,proto3" json:"document,omitempty"`
    // Whether Human Review feature should be skipped for this request. Default to
    // false.
    SkipHumanReview bool `protobuf:"varint,3,opt,name=skip_human_review,json=skipHumanReview,proto3" json:"skip_human_review,omitempty"`
    // contains filtered or unexported fields
}

Request message for the process document method.

func (*ProcessRequest) Descriptor Uses

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

Deprecated: Use ProcessRequest.ProtoReflect.Descriptor instead.

func (*ProcessRequest) GetDocument Uses

func (x *ProcessRequest) GetDocument() *Document

func (*ProcessRequest) GetName Uses

func (x *ProcessRequest) GetName() string

func (*ProcessRequest) GetSkipHumanReview Uses

func (x *ProcessRequest) GetSkipHumanReview() bool

func (*ProcessRequest) ProtoMessage Uses

func (*ProcessRequest) ProtoMessage()

func (*ProcessRequest) ProtoReflect Uses

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

func (*ProcessRequest) Reset Uses

func (x *ProcessRequest) Reset()

func (*ProcessRequest) String Uses

func (x *ProcessRequest) String() string

type ProcessResponse Uses

type ProcessResponse struct {

    // The document payload, will populate fields based on the processor's
    // behavior.
    Document *Document `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
    // The name of the operation triggered by the processed document. If the human
    // review process is not triggered, this field will be empty. It has the same
    // response type and metadata as the long running operation returned by
    // ReviewDocument method.
    HumanReviewOperation string `protobuf:"bytes,2,opt,name=human_review_operation,json=humanReviewOperation,proto3" json:"human_review_operation,omitempty"`
    // contains filtered or unexported fields
}

Response message for the process document method.

func (*ProcessResponse) Descriptor Uses

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

Deprecated: Use ProcessResponse.ProtoReflect.Descriptor instead.

func (*ProcessResponse) GetDocument Uses

func (x *ProcessResponse) GetDocument() *Document

func (*ProcessResponse) GetHumanReviewOperation Uses

func (x *ProcessResponse) GetHumanReviewOperation() string

func (*ProcessResponse) ProtoMessage Uses

func (*ProcessResponse) ProtoMessage()

func (*ProcessResponse) ProtoReflect Uses

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

func (*ProcessResponse) Reset Uses

func (x *ProcessResponse) Reset()

func (*ProcessResponse) String Uses

func (x *ProcessResponse) String() string

type ReviewDocumentOperationMetadata Uses

type ReviewDocumentOperationMetadata struct {

    // Used only when Operation.done is false.
    State ReviewDocumentOperationMetadata_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.cloud.documentai.v1beta3.ReviewDocumentOperationMetadata_State" json:"state,omitempty"`
    // A message providing more details about the current state of processing.
    // For example, the error message if the operation is failed.
    StateMessage string `protobuf:"bytes,2,opt,name=state_message,json=stateMessage,proto3" json:"state_message,omitempty"`
    // The creation time of the operation.
    CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
    // The last update time of the operation.
    UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
    // contains filtered or unexported fields
}

The long running operation metadata for review document method.

func (*ReviewDocumentOperationMetadata) Descriptor Uses

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

Deprecated: Use ReviewDocumentOperationMetadata.ProtoReflect.Descriptor instead.

func (*ReviewDocumentOperationMetadata) GetCreateTime Uses

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

func (*ReviewDocumentOperationMetadata) GetState Uses

func (x *ReviewDocumentOperationMetadata) GetState() ReviewDocumentOperationMetadata_State

func (*ReviewDocumentOperationMetadata) GetStateMessage Uses

func (x *ReviewDocumentOperationMetadata) GetStateMessage() string

func (*ReviewDocumentOperationMetadata) GetUpdateTime Uses

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

func (*ReviewDocumentOperationMetadata) ProtoMessage Uses

func (*ReviewDocumentOperationMetadata) ProtoMessage()

func (*ReviewDocumentOperationMetadata) ProtoReflect Uses

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

func (*ReviewDocumentOperationMetadata) Reset Uses

func (x *ReviewDocumentOperationMetadata) Reset()

func (*ReviewDocumentOperationMetadata) String Uses

func (x *ReviewDocumentOperationMetadata) String() string

type ReviewDocumentOperationMetadata_State Uses

type ReviewDocumentOperationMetadata_State int32

State of the longrunning operation.

const (
    // Unspecified state.
    ReviewDocumentOperationMetadata_STATE_UNSPECIFIED ReviewDocumentOperationMetadata_State = 0
    // Operation is still running.
    ReviewDocumentOperationMetadata_RUNNING ReviewDocumentOperationMetadata_State = 1
    // Operation is being cancelled.
    ReviewDocumentOperationMetadata_CANCELLING ReviewDocumentOperationMetadata_State = 2
    // Operation succeeded.
    ReviewDocumentOperationMetadata_SUCCEEDED ReviewDocumentOperationMetadata_State = 3
    // Operation failed.
    ReviewDocumentOperationMetadata_FAILED ReviewDocumentOperationMetadata_State = 4
    // Operation is cancelled.
    ReviewDocumentOperationMetadata_CANCELLED ReviewDocumentOperationMetadata_State = 5
)

func (ReviewDocumentOperationMetadata_State) Descriptor Uses

func (ReviewDocumentOperationMetadata_State) Descriptor() protoreflect.EnumDescriptor

func (ReviewDocumentOperationMetadata_State) Enum Uses

func (x ReviewDocumentOperationMetadata_State) Enum() *ReviewDocumentOperationMetadata_State

func (ReviewDocumentOperationMetadata_State) EnumDescriptor Uses

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

Deprecated: Use ReviewDocumentOperationMetadata_State.Descriptor instead.

func (ReviewDocumentOperationMetadata_State) Number Uses

func (x ReviewDocumentOperationMetadata_State) Number() protoreflect.EnumNumber

func (ReviewDocumentOperationMetadata_State) String Uses

func (x ReviewDocumentOperationMetadata_State) String() string

func (ReviewDocumentOperationMetadata_State) Type Uses

func (ReviewDocumentOperationMetadata_State) Type() protoreflect.EnumType

type ReviewDocumentRequest Uses

type ReviewDocumentRequest struct {

    // Required. The resource name of the HumanReviewConfig that the document will be
    // reviewed with.
    HumanReviewConfig string `protobuf:"bytes,1,opt,name=human_review_config,json=humanReviewConfig,proto3" json:"human_review_config,omitempty"`
    // The document that needs human review.
    Document *Document `protobuf:"bytes,2,opt,name=document,proto3" json:"document,omitempty"`
    // contains filtered or unexported fields
}

Request message for review document method.

func (*ReviewDocumentRequest) Descriptor Uses

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

Deprecated: Use ReviewDocumentRequest.ProtoReflect.Descriptor instead.

func (*ReviewDocumentRequest) GetDocument Uses

func (x *ReviewDocumentRequest) GetDocument() *Document

func (*ReviewDocumentRequest) GetHumanReviewConfig Uses

func (x *ReviewDocumentRequest) GetHumanReviewConfig() string

func (*ReviewDocumentRequest) ProtoMessage Uses

func (*ReviewDocumentRequest) ProtoMessage()

func (*ReviewDocumentRequest) ProtoReflect Uses

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

func (*ReviewDocumentRequest) Reset Uses

func (x *ReviewDocumentRequest) Reset()

func (*ReviewDocumentRequest) String Uses

func (x *ReviewDocumentRequest) String() string

type ReviewDocumentResponse Uses

type ReviewDocumentResponse struct {

    // The Cloud Storage uri for the human reviewed document.
    GcsDestination string `protobuf:"bytes,1,opt,name=gcs_destination,json=gcsDestination,proto3" json:"gcs_destination,omitempty"`
    // contains filtered or unexported fields
}

Response message for review document method.

func (*ReviewDocumentResponse) Descriptor Uses

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

Deprecated: Use ReviewDocumentResponse.ProtoReflect.Descriptor instead.

func (*ReviewDocumentResponse) GetGcsDestination Uses

func (x *ReviewDocumentResponse) GetGcsDestination() string

func (*ReviewDocumentResponse) ProtoMessage Uses

func (*ReviewDocumentResponse) ProtoMessage()

func (*ReviewDocumentResponse) ProtoReflect Uses

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

func (*ReviewDocumentResponse) Reset Uses

func (x *ReviewDocumentResponse) Reset()

func (*ReviewDocumentResponse) String Uses

func (x *ReviewDocumentResponse) String() string

type UnimplementedDocumentProcessorServiceServer Uses

type UnimplementedDocumentProcessorServiceServer struct {
}

UnimplementedDocumentProcessorServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedDocumentProcessorServiceServer) BatchProcessDocuments Uses

func (*UnimplementedDocumentProcessorServiceServer) BatchProcessDocuments(context.Context, *BatchProcessRequest) (*longrunning.Operation, error)

func (*UnimplementedDocumentProcessorServiceServer) ProcessDocument Uses

func (*UnimplementedDocumentProcessorServiceServer) ProcessDocument(context.Context, *ProcessRequest) (*ProcessResponse, error)

func (*UnimplementedDocumentProcessorServiceServer) ReviewDocument Uses

func (*UnimplementedDocumentProcessorServiceServer) ReviewDocument(context.Context, *ReviewDocumentRequest) (*longrunning.Operation, error)

type Vertex Uses

type Vertex struct {

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

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

func (*Vertex) Descriptor Uses

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

Deprecated: Use Vertex.ProtoReflect.Descriptor instead.

func (*Vertex) GetX Uses

func (x *Vertex) GetX() int32

func (*Vertex) GetY Uses

func (x *Vertex) GetY() int32

func (*Vertex) ProtoMessage Uses

func (*Vertex) ProtoMessage()

func (*Vertex) ProtoReflect Uses

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

func (*Vertex) Reset Uses

func (x *Vertex) Reset()

func (*Vertex) String Uses

func (x *Vertex) String() string

Package documentai imports 19 packages (graph). Updated 2020-11-06. Refresh now. Tools for package owners.