Movatterモバイル変換


[0]ホーム

URL:


documentai

package
v0.257.0Latest Latest
Warning

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

Go to latest
Published: Dec 2, 2025 License:BSD-3-ClauseImports:18Imported by:0

Details

Repository

github.com/googleapis/google-api-go-client

Links

Documentation

Overview

Package documentai provides access to the Cloud Document AI API.

For product documentation, see:https://cloud.google.com/document-ai/docs/

Library status

These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany new features.

When possible, we recommend using our newer[Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/documentai/v1"...ctx := context.Background()documentaiService, err := documentai.NewService(ctx)

In this example, Google Application Default Credentials are used forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.golang.org/api/option.WithAPIKey:

documentaiService, err := documentai.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}// ...token, err := config.Exchange(ctx, ...)documentaiService, err := documentai.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

Seegoogle.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (// See, edit, configure, and delete your Google Cloud data and see the email// address for your Google Account.CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform")

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

typeCloudAiDocumentaiLabHifiaToolsValidationValidatorInputadded inv0.249.0

type CloudAiDocumentaiLabHifiaToolsValidationValidatorInput struct {ValidationRules []*CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule `json:"validationRules,omitempty"`// ForceSendFields is a list of field names (e.g. "ValidationRules") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ValidationRules") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CloudAiDocumentaiLabHifiaToolsValidationValidatorInput: Definition of thevalidation rules. Those are the input to the validator logic and they areused to validate a document. Next ID: 3

func (CloudAiDocumentaiLabHifiaToolsValidationValidatorInput)MarshalJSONadded inv0.249.0

typeCloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleadded inv0.249.0

type CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule struct {ChildAlignmentRule *CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule `json:"childAlignmentRule,omitempty"`// Description: Description of the validation rule. This has no use but for// documentationDescriptionstring                                                                                   `json:"description,omitempty"`EntityAlignmentRule *CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRule `json:"entityAlignmentRule,omitempty"`FieldOccurrences    *CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldOccurrences    `json:"fieldOccurrences,omitempty"`FieldRegex          *CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldRegex          `json:"fieldRegex,omitempty"`FormValidation      *CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidation      `json:"formValidation,omitempty"`// Name: Name of the validation rule.Namestring `json:"name,omitempty"`// RuleId: Unique identifier of the rule. Optional.RuleIdstring `json:"ruleId,omitempty"`// ForceSendFields is a list of field names (e.g. "ChildAlignmentRule") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ChildAlignmentRule") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule: NextID: 9

func (CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule)MarshalJSONadded inv0.249.0

typeCloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRuleadded inv0.252.0

type CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule struct {// Possible values://   "ALIGNMENT_TYPE_UNSPECIFIED"//   "ALIGNMENT_TYPE_HORIZONTAL"//   "ALIGNMENT_TYPE_VERTICAL"AlignmentTypestring `json:"alignmentType,omitempty"`// Tolerance: The tolerance to use when comparing coordinates.Tolerancefloat64 `json:"tolerance,omitempty"`// ForceSendFields is a list of field names (e.g. "AlignmentType") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AlignmentType") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule: A rule for checking field alignment. Horizontal alignment checks iffields are on the same row by comparing y-coordinates of bounding boxcenters, while vertical alignment checks if fields are on the same column bycomparing x-coordinates of bounding box centers.

func (CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule)MarshalJSONadded inv0.252.0

func (*CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule)UnmarshalJSONadded inv0.252.0

typeCloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRuleadded inv0.252.0

type CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule struct {// AlignmentRule: The alignment rule to apply to the child fields.AlignmentRule *CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule `json:"alignmentRule,omitempty"`// ChildFields: The child fields to be aligned within the parent field.ChildFields []*CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField `json:"childFields,omitempty"`// ParentField: The full path of the parent field.ParentField *CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField `json:"parentField,omitempty"`// ForceSendFields is a list of field names (e.g. "AlignmentRule") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AlignmentRule") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule: A rule that aligns specified child fields with a parent field.

func (CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule)MarshalJSONadded inv0.252.0

typeCloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstantadded inv0.249.0

type CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant struct {FloatValuefloat64 `json:"floatValue,omitempty"`// ForceSendFields is a list of field names (e.g. "FloatValue") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FloatValue") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant:

The constant value used in the validation rules.

func (CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant)MarshalJSONadded inv0.249.0

func (*CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant)UnmarshalJSONadded inv0.249.0

typeCloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRuleadded inv0.252.0

type CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRule struct {// AlignmentRule: The alignment rule to apply to the fields.AlignmentRule *CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule `json:"alignmentRule,omitempty"`// Fields: The fields to be aligned.Fields []*CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField `json:"fields,omitempty"`// ForceSendFields is a list of field names (e.g. "AlignmentRule") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AlignmentRule") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRule: A rule that aligns specified fields with each other.

func (CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRule)MarshalJSONadded inv0.252.0

typeCloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldadded inv0.249.0

type CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField struct {// DefaultValue: Default value to use if the field is not present. If the field// is missing and the default value is not set, the validation run as if the// field is not present in the validation logic.DefaultValue *CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant `json:"defaultValue,omitempty"`// FieldName: The field name to validate. This can be a simple field name or a// nested field one using the ':' (meant as an aggregator) or '*' (meant as// foreach) operators.FieldNamestring `json:"fieldName,omitempty"`// ForceSendFields is a list of field names (e.g. "DefaultValue") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DefaultValue") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField)MarshalJSONadded inv0.249.0

typeCloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldOccurrencesadded inv0.249.0

type CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldOccurrences struct {Field          *CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField `json:"field,omitempty"`MaxOccurrencesint64                                                                      `json:"maxOccurrences,omitempty"`// MinOccurrences: Min and max occurrences of the field. If not set, there is// limit set. The defined interval is a closed-closed interval, i.e. [min,// max].MinOccurrencesint64 `json:"minOccurrences,omitempty"`// ForceSendFields is a list of field names (e.g. "Field") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Field") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldOccurrences)MarshalJSONadded inv0.249.0

typeCloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldRegexadded inv0.249.0

type CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldRegex struct {Field *CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField `json:"field,omitempty"`// Pattern: Python regex to validate the field values.Patternstring `json:"pattern,omitempty"`// ForceSendFields is a list of field names (e.g. "Field") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Field") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldRegex)MarshalJSONadded inv0.249.0

typeCloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidationadded inv0.249.0

type CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidation struct {LeftOperand  *CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidationOperation `json:"leftOperand,omitempty"`RightOperand *CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidationOperation `json:"rightOperand,omitempty"`// ValidationOperator: The relational operator to be applied to the operands.//// Possible values://   "OPERATION_TYPE_UNSPECIFIED"//   "OPERATION_TYPE_EQ"//   "OPERATION_TYPE_NE"//   "OPERATION_TYPE_LT"//   "OPERATION_TYPE_LE"//   "OPERATION_TYPE_GT"//   "OPERATION_TYPE_GE"ValidationOperatorstring `json:"validationOperator,omitempty"`// ForceSendFields is a list of field names (e.g. "LeftOperand") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "LeftOperand") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidation)MarshalJSONadded inv0.249.0

typeCloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidationOperationadded inv0.249.0

type CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidationOperation struct {// Constants: A list of constants to be used as operands.Constants []*CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant `json:"constants,omitempty"`// Fields: A list of fields to be used as operands.Fields []*CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField `json:"fields,omitempty"`// OperationType: The operation type to be applied to all the operands.//// Possible values://   "OPERATION_TYPE_UNSPECIFIED"//   "OPERATION_TYPE_SUM"//   "OPERATION_TYPE_SUB"//   "OPERATION_TYPE_MUL"//   "OPERATION_TYPE_DIV"//   "OPERATION_TYPE_MAX"//   "OPERATION_TYPE_MIN"//   "OPERATION_TYPE_ABS"//   "OPERATION_TYPE_UNIQUE"//   "OPERATION_TYPE_COUNT"OperationTypestring `json:"operationType,omitempty"`// Operations: A list of recursive operations to be used as operands.Operations []*CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidationOperation `json:"operations,omitempty"`// ForceSendFields is a list of field names (e.g. "Constants") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Constants") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidationOperation)MarshalJSONadded inv0.249.0

typeGoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataadded inv0.112.0

type GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// IndividualAutoLabelStatuses: The list of individual auto-labeling statuses// of the dataset documents.IndividualAutoLabelStatuses []*GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus `json:"individualAutoLabelStatuses,omitempty"`// TotalDocumentCount: Total number of the auto-labeling documents.TotalDocumentCountint64 `json:"totalDocumentCount,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata: Metadata of theauto-labeling documents operation.

func (GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata)MarshalJSONadded inv0.112.0

typeGoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatusadded inv0.112.0

type GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus struct {// DocumentId: The document id of the auto-labeled document. This will replace// the gcs_uri.DocumentId *GoogleCloudDocumentaiUiv1beta3DocumentId `json:"documentId,omitempty"`// Status: The status of the document auto-labeling.Status *GoogleRpcStatus `json:"status,omitempty"`// ForceSendFields is a list of field names (e.g. "DocumentId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DocumentId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus: The status of individual documents in the auto-labeling process.

func (GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus)MarshalJSONadded inv0.112.0

typeGoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsResponseadded inv0.112.0

type GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsResponse struct {}

GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsResponse: The response protoof AutoLabelDocuments method.

typeGoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataadded inv0.55.0

type GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ErrorDocumentCount: Total number of documents that failed to be deleted in// storage.ErrorDocumentCountint64 `json:"errorDocumentCount,omitempty"`// IndividualBatchDeleteStatuses: The list of response details of each// document.IndividualBatchDeleteStatuses []*GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus `json:"individualBatchDeleteStatuses,omitempty"`// TotalDocumentCount: Total number of documents deleting from dataset.TotalDocumentCountint64 `json:"totalDocumentCount,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata)MarshalJSONadded inv0.55.0

typeGoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatusadded inv0.76.0

type GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus struct {// DocumentId: The document id of the document.DocumentId *GoogleCloudDocumentaiUiv1beta3DocumentId `json:"documentId,omitempty"`// Status: The status of deleting the document in storage.Status *GoogleRpcStatus `json:"status,omitempty"`// ForceSendFields is a list of field names (e.g. "DocumentId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DocumentId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus: The status of each individual document in the batch deleteprocess.

func (GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus)MarshalJSONadded inv0.76.0

typeGoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponseadded inv0.55.0

type GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse struct {}

GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse: Response of thedelete documents operation.

typeGoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataadded inv0.55.0

type GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// DestDatasetType: The destination dataset split type.//// Possible values://   "DATASET_SPLIT_TYPE_UNSPECIFIED" - Default value if the enum is not set.//   "DATASET_SPLIT_TRAIN" - Identifies the train documents.//   "DATASET_SPLIT_TEST" - Identifies the test documents.//   "DATASET_SPLIT_UNASSIGNED" - Identifies the unassigned documents.DestDatasetTypestring `json:"destDatasetType,omitempty"`// DestSplitType: The destination dataset split type.//// Possible values://   "DATASET_SPLIT_TYPE_UNSPECIFIED" - Default value if the enum is not set.//   "DATASET_SPLIT_TRAIN" - Identifies the train documents.//   "DATASET_SPLIT_TEST" - Identifies the test documents.//   "DATASET_SPLIT_UNASSIGNED" - Identifies the unassigned documents.DestSplitTypestring `json:"destSplitType,omitempty"`// IndividualBatchMoveStatuses: The list of response details of each document.IndividualBatchMoveStatuses []*GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus `json:"individualBatchMoveStatuses,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata)MarshalJSONadded inv0.55.0

typeGoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatusadded inv0.61.0

type GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus struct {// DocumentId: The document id of the document.DocumentId *GoogleCloudDocumentaiUiv1beta3DocumentId `json:"documentId,omitempty"`// Status: The status of moving the document.Status *GoogleRpcStatus `json:"status,omitempty"`// ForceSendFields is a list of field names (e.g. "DocumentId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DocumentId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus: The status of each individual document in the batch move process.

func (GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus)MarshalJSONadded inv0.61.0

typeGoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponseadded inv0.55.0

type GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse struct {}

GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse: Response of thebatch move documents operation.

typeGoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataadded inv0.138.0

type GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// IndividualBatchUpdateStatuses: The list of response details of each// document.IndividualBatchUpdateStatuses []*GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus `json:"individualBatchUpdateStatuses,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadata)MarshalJSONadded inv0.138.0

typeGoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatusadded inv0.138.0

type GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus struct {// DocumentId: The document id of the document.DocumentId *GoogleCloudDocumentaiUiv1beta3DocumentId `json:"documentId,omitempty"`// Status: The status of updating the document in storage.Status *GoogleRpcStatus `json:"status,omitempty"`// ForceSendFields is a list of field names (e.g. "DocumentId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DocumentId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus: The status of each individual document in the batch updateprocess.

func (GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus)MarshalJSONadded inv0.138.0

typeGoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsResponseadded inv0.138.0

type GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsResponse struct {}

GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsResponse: Response of thebatch update documents operation.

typeGoogleCloudDocumentaiUiv1beta3CommonOperationMetadata

type GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata struct {// CreateTime: The creation time of the operation.CreateTimestring `json:"createTime,omitempty"`// Resource: A related resource to this operation.Resourcestring `json:"resource,omitempty"`// State: The state of the operation.//// Possible values://   "STATE_UNSPECIFIED" - Unspecified state.//   "RUNNING" - Operation is still running.//   "CANCELLING" - Operation is being cancelled.//   "SUCCEEDED" - Operation succeeded.//   "FAILED" - Operation failed.//   "CANCELLED" - Operation is cancelled.Statestring `json:"state,omitempty"`// StateMessage: A message providing more details about the current state of// processing.StateMessagestring `json:"stateMessage,omitempty"`// UpdateTime: The last update time of the operation.UpdateTimestring `json:"updateTime,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata: The common metadatafor long running operations.

func (GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata)MarshalJSON

typeGoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata

type GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata: Thelong-running operation metadata for the CreateLabelerPool method.

func (GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata)MarshalJSON

typeGoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata

type GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata: Thelong-running operation metadata for DeleteLabelerPool.

func (GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata)MarshalJSON

typeGoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata

type GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata: The long-runningoperation metadata for the DeleteProcessor method.

func (GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata)MarshalJSON

typeGoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata

type GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata: Thelong-running operation metadata for the DeleteProcessorVersion method.

func (GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata)MarshalJSON

typeGoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata

type GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata: Thelong-running operation metadata for the DeployProcessorVersion method.

func (GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata)MarshalJSON

typeGoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse

type GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse struct {}

GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse: Responsemessage for the DeployProcessorVersion method.

typeGoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata

type GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata: The long-runningoperation metadata for the DisableProcessor method.

func (GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata)MarshalJSON

typeGoogleCloudDocumentaiUiv1beta3DisableProcessorResponse

type GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse struct {}

GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse: Response message forthe DisableProcessor method. Intentionally empty proto for adding fields infuture.

typeGoogleCloudDocumentaiUiv1beta3DocumentIdadded inv0.61.0

type GoogleCloudDocumentaiUiv1beta3DocumentId struct {// GcsManagedDocId: A document id within user-managed Cloud Storage.GcsManagedDocId *GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId `json:"gcsManagedDocId,omitempty"`// RevisionRef: Points to a specific revision of the document if set.RevisionRef *GoogleCloudDocumentaiUiv1beta3RevisionRef `json:"revisionRef,omitempty"`// UnmanagedDocId: A document id within unmanaged dataset.UnmanagedDocId *GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId `json:"unmanagedDocId,omitempty"`// ForceSendFields is a list of field names (e.g. "GcsManagedDocId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GcsManagedDocId") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3DocumentId: Document Identifier.

func (GoogleCloudDocumentaiUiv1beta3DocumentId)MarshalJSONadded inv0.61.0

typeGoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentIdadded inv0.61.0

type GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId struct {// CwDocId: Id of the document (indexed) managed by Content Warehouse.CwDocIdstring `json:"cwDocId,omitempty"`// GcsUri: Required. The Cloud Storage URI where the actual document is stored.GcsUristring `json:"gcsUri,omitempty"`// ForceSendFields is a list of field names (e.g. "CwDocId") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CwDocId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId: Identifies adocument uniquely within the scope of a dataset in the user-managed CloudStorage option.

func (GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId)MarshalJSONadded inv0.61.0

typeGoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentIdadded inv0.125.0

type GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId struct {// DocId: Required. The id of the document.DocIdstring `json:"docId,omitempty"`// ForceSendFields is a list of field names (e.g. "DocId") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DocId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId: Identifies adocument uniquely within the scope of a dataset in unmanaged option.

func (GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId)MarshalJSONadded inv0.125.0

typeGoogleCloudDocumentaiUiv1beta3DocumentSchemaadded inv0.255.0

type GoogleCloudDocumentaiUiv1beta3DocumentSchema struct {// Description: Description of the schema.Descriptionstring `json:"description,omitempty"`// DisplayName: Display name to show to users.DisplayNamestring `json:"displayName,omitempty"`// EntityTypes: Entity types of the schema.EntityTypes []*GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType `json:"entityTypes,omitempty"`// Metadata: Metadata of the schema.Metadata *GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata `json:"metadata,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Description") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3DocumentSchema: The schema defines the outputof the processed document by a processor.

func (GoogleCloudDocumentaiUiv1beta3DocumentSchema)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeadded inv0.255.0

type GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType struct {// BaseTypes: The entity type that this type is derived from. For now, one and// only one should be set.BaseTypes []string `json:"baseTypes,omitempty"`// Description: The description of the entity type. Could be used to provide// more information about the entity type for model calls.Descriptionstring `json:"description,omitempty"`// DisplayName: User defined name for the type.DisplayNamestring `json:"displayName,omitempty"`// EntityTypeMetadata: Metadata for the entity type.EntityTypeMetadata *GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata `json:"entityTypeMetadata,omitempty"`// EnumValues: If specified, lists all the possible values for this entity.// This should not be more than a handful of values. If the number of values is// >10 or could change frequently use the `EntityType.value_ontology` field and// specify a list of all possible values in a value ontology file.EnumValues *GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues `json:"enumValues,omitempty"`// Name: Name of the type. It must be unique within the schema file and cannot// be a "Common Type". The following naming conventions are used: - Use// `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters.// - Must start with a letter. - Allowed characters: ASCII letters// `[a-z0-9_-]`. (For backward compatibility internal infrastructure and// tooling can handle any ascii character.) - The `/` is sometimes used to// denote a property of a type. For example `line_item/amount`. This convention// is deprecated, but will still be honored for backward compatibility.Namestring `json:"name,omitempty"`// Properties: Description the nested structure, or composition of an entity.Properties []*GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty `json:"properties,omitempty"`// ForceSendFields is a list of field names (e.g. "BaseTypes") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BaseTypes") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType: EntityType is thewrapper of a label of the corresponding model with detailed attributes andlimitations for entity-based processors. Multiple types can also compose adependency tree to represent nested types.

func (GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValuesadded inv0.255.0

type GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues struct {// Values: The individual values that this enum values type can include.Values []string `json:"values,omitempty"`// ForceSendFields is a list of field names (e.g. "Values") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Values") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues: Definesthe a list of enum values.

func (GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypePropertyadded inv0.255.0

type GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty struct {// Description: The description of the property. Could be used to provide more// information about the property for model calls.Descriptionstring `json:"description,omitempty"`// DisplayName: User defined name for the property.DisplayNamestring `json:"displayName,omitempty"`// Method: Specifies how the entity's value is obtained.//// Possible values://   "METHOD_UNSPECIFIED" - Unspecified method. It defaults to `EXTRACT`.//   "EXTRACT" - The entity's value is directly extracted as-is from the// document text.//   "DERIVE" - The entity's value is derived through inference and is not// necessarily an exact text extraction from the document.Methodstring `json:"method,omitempty"`// Name: The name of the property. Follows the same guidelines as the// EntityType name.Namestring `json:"name,omitempty"`// OccurrenceType: Occurrence type limits the number of instances an entity// type appears in the document.//// Possible values://   "OCCURRENCE_TYPE_UNSPECIFIED" - Unspecified occurrence type.//   "OPTIONAL_ONCE" - There will be zero or one instance of this entity type.// The same entity instance may be mentioned multiple times.//   "OPTIONAL_MULTIPLE" - The entity type will appear zero or multiple times.//   "REQUIRED_ONCE" - The entity type will only appear exactly once. The same// entity instance may be mentioned multiple times.//   "REQUIRED_MULTIPLE" - The entity type will appear once or more times.OccurrenceTypestring `json:"occurrenceType,omitempty"`// PropertyMetadata: Any additional metadata about the property can be added// here.PropertyMetadata *GoogleCloudDocumentaiUiv1beta3PropertyMetadata `json:"propertyMetadata,omitempty"`// ValueType: A reference to the value type of the property. This type is// subject to the same conventions as the `Entity.base_types` field.ValueTypestring `json:"valueType,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Description") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty: Definesproperties that can be part of the entity type.

func (GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadataadded inv0.255.0

type GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata struct {// DocumentAllowMultipleLabels: If true, on a given page, there can be multiple// `document` annotations covering it.DocumentAllowMultipleLabelsbool `json:"documentAllowMultipleLabels,omitempty"`// DocumentSplitter: If true, a `document` entity type can be applied to// subdocument (splitting). Otherwise, it can only be applied to the entire// document (classification).DocumentSplitterbool `json:"documentSplitter,omitempty"`// PrefixedNamingOnProperties: If set, all the nested entities must be prefixed// with the parents.PrefixedNamingOnPropertiesbool `json:"prefixedNamingOnProperties,omitempty"`// SkipNamingValidation: If set, we will skip the naming format validation in// the schema. So the string values in `DocumentSchema.EntityType.name` and// `DocumentSchema.EntityType.Property.name` will not be checked.SkipNamingValidationbool `json:"skipNamingValidation,omitempty"`// ForceSendFields is a list of field names (e.g.// "DocumentAllowMultipleLabels") to unconditionally include in API requests.// By default, fields with empty or default values are omitted from API// requests. Seehttps://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields// for more details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DocumentAllowMultipleLabels") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata: Metadata for globalschema behavior.

func (GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata

type GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata: The long-runningoperation metadata for the EnableProcessor method.

func (GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata)MarshalJSON

typeGoogleCloudDocumentaiUiv1beta3EnableProcessorResponse

type GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse struct {}

GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse: Response message forthe EnableProcessor method. Intentionally empty proto for adding fields infuture.

typeGoogleCloudDocumentaiUiv1beta3EntityTypeMetadataadded inv0.255.0

type GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata struct {// FieldTierMetadata: Field tier metadata on the propertyFieldTierMetadata *GoogleCloudDocumentaiUiv1beta3FieldTierMetadata `json:"fieldTierMetadata,omitempty"`// HumanReviewLabelingMetadata: Human review labeling config on the entity.HumanReviewLabelingMetadata *GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata `json:"humanReviewLabelingMetadata,omitempty"`// HumanReviewMetadata: Human review config on the entity.HumanReviewMetadata *GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata `json:"humanReviewMetadata,omitempty"`// Inactive: Whether the entity type should be considered inactive.Inactivebool `json:"inactive,omitempty"`// SchemaEditabilityMetadata: Schema editability metadata on the entity.SchemaEditabilityMetadata *GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata `json:"schemaEditabilityMetadata,omitempty"`// SchemaInferenceMetadata: Schema inference metadata on the entity.SchemaInferenceMetadata *GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata `json:"schemaInferenceMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "FieldTierMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FieldTierMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata: Metadata about an entitytype.

func (GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata

type GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata: Metadata ofthe EvaluateProcessorVersion method.

func (GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata)MarshalJSON

typeGoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse

type GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse struct {// Evaluation: The resource name of the created evaluation.Evaluationstring `json:"evaluation,omitempty"`// ForceSendFields is a list of field names (e.g. "Evaluation") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Evaluation") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse: Response ofthe EvaluateProcessorVersion method.

func (GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse)MarshalJSON

typeGoogleCloudDocumentaiUiv1beta3EvaluationMetricsadded inv0.255.0

type GoogleCloudDocumentaiUiv1beta3EvaluationMetrics struct {// F1Score: The calculated f1 score.F1Scorefloat64 `json:"f1Score,omitempty"`// FalseNegativesCount: The amount of false negatives.FalseNegativesCountint64 `json:"falseNegativesCount,omitempty"`// FalsePositivesCount: The amount of false positives.FalsePositivesCountint64 `json:"falsePositivesCount,omitempty"`// GroundTruthDocumentCount: The amount of documents with a ground truth// occurrence.GroundTruthDocumentCountint64 `json:"groundTruthDocumentCount,omitempty"`// GroundTruthOccurrencesCount: The amount of occurrences in ground truth// documents.GroundTruthOccurrencesCountint64 `json:"groundTruthOccurrencesCount,omitempty"`// Precision: The calculated precision.Precisionfloat64 `json:"precision,omitempty"`// PredictedDocumentCount: The amount of documents with a predicted occurrence.PredictedDocumentCountint64 `json:"predictedDocumentCount,omitempty"`// PredictedOccurrencesCount: The amount of occurrences in predicted documents.PredictedOccurrencesCountint64 `json:"predictedOccurrencesCount,omitempty"`// Recall: The calculated recall.Recallfloat64 `json:"recall,omitempty"`// TotalDocumentsCount: The amount of documents that had an occurrence of this// label.TotalDocumentsCountint64 `json:"totalDocumentsCount,omitempty"`// TruePositivesCount: The amount of true positives.TruePositivesCountint64 `json:"truePositivesCount,omitempty"`// ForceSendFields is a list of field names (e.g. "F1Score") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "F1Score") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3EvaluationMetrics: Evaluation metrics, eitherin aggregate or about a specific entity.

func (GoogleCloudDocumentaiUiv1beta3EvaluationMetrics)MarshalJSONadded inv0.255.0

func (*GoogleCloudDocumentaiUiv1beta3EvaluationMetrics)UnmarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiUiv1beta3EvaluationReferenceadded inv0.255.0

type GoogleCloudDocumentaiUiv1beta3EvaluationReference struct {// AggregateMetrics: An aggregate of the statistics for the evaluation with// fuzzy matching on.AggregateMetrics *GoogleCloudDocumentaiUiv1beta3EvaluationMetrics `json:"aggregateMetrics,omitempty"`// AggregateMetricsExact: An aggregate of the statistics for the evaluation// with fuzzy matching off.AggregateMetricsExact *GoogleCloudDocumentaiUiv1beta3EvaluationMetrics `json:"aggregateMetricsExact,omitempty"`// Evaluation: The resource name of the evaluation.Evaluationstring `json:"evaluation,omitempty"`// Operation: The resource name of the Long Running Operation for the// evaluation.Operationstring `json:"operation,omitempty"`// ForceSendFields is a list of field names (e.g. "AggregateMetrics") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AggregateMetrics") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3EvaluationReference: Gives a short summary ofan evaluation, and links to the evaluation itself.

func (GoogleCloudDocumentaiUiv1beta3EvaluationReference)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataadded inv0.96.0

type GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// IndividualExportStatuses: The list of response details of each document.IndividualExportStatuses []*GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus `json:"individualExportStatuses,omitempty"`// SplitExportStats: The list of statistics for each dataset split type.SplitExportStats []*GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat `json:"splitExportStats,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata: Metadata of the batchexport documents operation.

func (GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata)MarshalJSONadded inv0.96.0

typeGoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatusadded inv0.96.0

type GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus struct {// DocumentId: The path to source docproto of the document.DocumentId *GoogleCloudDocumentaiUiv1beta3DocumentId `json:"documentId,omitempty"`// OutputGcsDestination: The output_gcs_destination of the exported document if// it was successful, otherwise empty.OutputGcsDestinationstring `json:"outputGcsDestination,omitempty"`// Status: The status of the exporting of the document.Status *GoogleRpcStatus `json:"status,omitempty"`// ForceSendFields is a list of field names (e.g. "DocumentId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DocumentId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus:The status of each individual document in the export process.

func (GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus)MarshalJSONadded inv0.96.0

typeGoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStatadded inv0.96.0

type GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat struct {// SplitType: The dataset split type.//// Possible values://   "DATASET_SPLIT_TYPE_UNSPECIFIED" - Default value if the enum is not set.//   "DATASET_SPLIT_TRAIN" - Identifies the train documents.//   "DATASET_SPLIT_TEST" - Identifies the test documents.//   "DATASET_SPLIT_UNASSIGNED" - Identifies the unassigned documents.SplitTypestring `json:"splitType,omitempty"`// TotalDocumentCount: Total number of documents with the given dataset split// type to be exported.TotalDocumentCountint64 `json:"totalDocumentCount,omitempty"`// ForceSendFields is a list of field names (e.g. "SplitType") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "SplitType") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat: Thestatistic representing a dataset split type for this export.

func (GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat)MarshalJSONadded inv0.96.0

typeGoogleCloudDocumentaiUiv1beta3ExportDocumentsResponseadded inv0.96.0

type GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse struct {}

GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse: The response proto ofExportDocuments method.

typeGoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadataadded inv0.51.0

type GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata struct {// CommonMetadata: The common metadata about the operation.CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata: Metadatamessage associated with the ExportProcessorVersion operation.

func (GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata)MarshalJSONadded inv0.51.0

typeGoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponseadded inv0.51.0

type GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse struct {// GcsUri: The Cloud Storage URI containing the output artifacts.GcsUristring `json:"gcsUri,omitempty"`// ForceSendFields is a list of field names (e.g. "GcsUri") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GcsUri") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse: Responsemessage associated with the ExportProcessorVersion operation.

func (GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse)MarshalJSONadded inv0.51.0

typeGoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataadded inv0.255.0

type GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata struct {// EntityQuery: Entity query config.EntityQuery *GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery `json:"entityQuery,omitempty"`// SummaryOptions: Summary options config.SummaryOptions *GoogleCloudDocumentaiUiv1beta3SummaryOptions `json:"summaryOptions,omitempty"`// ForceSendFields is a list of field names (e.g. "EntityQuery") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "EntityQuery") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata: Metadata for how thisfield value is extracted.

func (GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQueryadded inv0.255.0

type GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery struct {// UserEntityQuery: The original entity query inputed by the user.UserEntityQuerystring `json:"userEntityQuery,omitempty"`// ForceSendFields is a list of field names (e.g. "UserEntityQuery") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "UserEntityQuery") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery: Messagefor entity query.

func (GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiUiv1beta3FieldTierMetadataadded inv0.255.0

type GoogleCloudDocumentaiUiv1beta3FieldTierMetadata struct {// TierLevel: Integer that indicates the tier of a property. e.g. Invoice has// entities that are classified as tier 1 which is the most important, while// tier 2 and tier 3 less so. This attribute can be used to filter schema// attributes before running eval. e.g. compute F1 score for only tier 1// entities. If not present this attribute should be inferred as 1.TierLevelint64 `json:"tierLevel,omitempty"`// ForceSendFields is a list of field names (e.g. "TierLevel") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "TierLevel") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3FieldTierMetadata: Metadata for the field tierof a property.

func (GoogleCloudDocumentaiUiv1beta3FieldTierMetadata)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadataadded inv0.255.0

type GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata struct {// EnableNormalizationEditing: Whether to enable normalization editing.EnableNormalizationEditingbool `json:"enableNormalizationEditing,omitempty"`// ForceSendFields is a list of field names (e.g. "EnableNormalizationEditing")// to unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "EnableNormalizationEditing") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata: Metadata forhuman review labeling config.

func (GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadataadded inv0.255.0

type GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata struct {// ConfidenceThreshold: The confidence threshold if human review validation is// enabled.ConfidenceThresholdfloat64 `json:"confidenceThreshold,omitempty"`// EnableValidation: Whether to enable human review validation.EnableValidationbool `json:"enableValidation,omitempty"`// ForceSendFields is a list of field names (e.g. "ConfidenceThreshold") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ConfidenceThreshold") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata: Metadata forHuman Review config.

func (GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata)MarshalJSONadded inv0.255.0

func (*GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata)UnmarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataadded inv0.55.0

type GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ImportConfigValidationResults: Validation statuses of the batch documents// import config.ImportConfigValidationResults []*GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult `json:"importConfigValidationResults,omitempty"`// IndividualImportStatuses: The list of response details of each document.IndividualImportStatuses []*GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus `json:"individualImportStatuses,omitempty"`// TotalDocumentCount: Total number of the documents that are qualified for// importing.TotalDocumentCountint64 `json:"totalDocumentCount,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata: Metadata of theimport document operation.

func (GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata)MarshalJSONadded inv0.55.0

typeGoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResultadded inv0.94.0

type GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult struct {// InputGcsSource: The source Cloud Storage URI specified in the import config.InputGcsSourcestring `json:"inputGcsSource,omitempty"`// Status: The validation status of import config.Status *GoogleRpcStatus `json:"status,omitempty"`// ForceSendFields is a list of field names (e.g. "InputGcsSource") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "InputGcsSource") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult: The validation status of each import config. Status is set to an errorif there are no documents to import in the `import_config`, or `OK` if theoperation will try to proceed with at least one document.

func (GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult)MarshalJSONadded inv0.94.0

typeGoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatusadded inv0.61.0

type GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus struct {// InputGcsSource: The source Cloud Storage URI of the document.InputGcsSourcestring `json:"inputGcsSource,omitempty"`// OutputDocumentId: The document id of imported document if it was successful,// otherwise empty.OutputDocumentId *GoogleCloudDocumentaiUiv1beta3DocumentId `json:"outputDocumentId,omitempty"`// OutputGcsDestination: The output_gcs_destination of the processed document// if it was successful, otherwise empty.OutputGcsDestinationstring `json:"outputGcsDestination,omitempty"`// Status: The status of the importing of the document.Status *GoogleRpcStatus `json:"status,omitempty"`// ForceSendFields is a list of field names (e.g. "InputGcsSource") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "InputGcsSource") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus:The status of each individual document in the import process.

func (GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus)MarshalJSONadded inv0.61.0

typeGoogleCloudDocumentaiUiv1beta3ImportDocumentsResponseadded inv0.55.0

type GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse struct {}

GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse: Response of theimport document operation.

typeGoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadataadded inv0.109.0

type GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata struct {// CommonMetadata: The basic metadata for the long-running operation.CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata: Thelong-running operation metadata for the ImportProcessorVersion method.

func (GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata)MarshalJSONadded inv0.109.0

typeGoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponseadded inv0.109.0

type GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse struct {// ProcessorVersion: The destination processor version name.ProcessorVersionstring `json:"processorVersion,omitempty"`// ForceSendFields is a list of field names (e.g. "ProcessorVersion") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ProcessorVersion") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse: The responsemessage for the ImportProcessorVersion method.

func (GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse)MarshalJSONadded inv0.109.0

typeGoogleCloudDocumentaiUiv1beta3Processoradded inv0.255.0

type GoogleCloudDocumentaiUiv1beta3Processor struct {// ActiveSchemaVersion: Optional. SchemaVersion used by the Processor. It is// the same as Processor's DatasetSchema.schema_version Format is// `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{sch// ema_version}ActiveSchemaVersionstring `json:"activeSchemaVersion,omitempty"`// CreateTime: Output only. The time the processor was created.CreateTimestring `json:"createTime,omitempty"`// DefaultProcessorVersion: The default processor version.DefaultProcessorVersionstring `json:"defaultProcessorVersion,omitempty"`// DisplayName: The display name of the processor.DisplayNamestring `json:"displayName,omitempty"`// KmsKeyName: The KMS key (https://cloud.google.com/security-key-management)// used for encryption and decryption in CMEK scenarios.KmsKeyNamestring `json:"kmsKeyName,omitempty"`// Name: Output only. Immutable. The resource name of the processor. Format:// `projects/{project}/locations/{location}/processors/{processor}`Namestring `json:"name,omitempty"`// ProcessEndpoint: Output only. Immutable. The http endpoint that can be// called to invoke processing.ProcessEndpointstring `json:"processEndpoint,omitempty"`// ProcessorVersionAliases: Output only. The processor version aliases.ProcessorVersionAliases []*GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias `json:"processorVersionAliases,omitempty"`// SatisfiesPzi: Output only. Reserved for future use.SatisfiesPzibool `json:"satisfiesPzi,omitempty"`// SatisfiesPzs: Output only. Reserved for future use.SatisfiesPzsbool `json:"satisfiesPzs,omitempty"`// State: Output only. The state of the processor.//// Possible values://   "STATE_UNSPECIFIED" - The processor is in an unspecified state.//   "ENABLED" - The processor is enabled, i.e., has an enabled version which// can currently serve processing requests and all the feature dependencies// have been successfully initialized.//   "DISABLED" - The processor is disabled.//   "ENABLING" - The processor is being enabled, will become `ENABLED` if// successful.//   "DISABLING" - The processor is being disabled, will become `DISABLED` if// successful.//   "CREATING" - The processor is being created, will become either `ENABLED`// (for successful creation) or `FAILED` (for failed ones). Once a processor is// in this state, it can then be used for document processing, but the feature// dependencies of the processor might not be fully created yet.//   "FAILED" - The processor failed during creation or initialization of// feature dependencies. The user should delete the processor and recreate one// as all the functionalities of the processor are disabled.//   "DELETING" - The processor is being deleted, will be removed if// successful.Statestring `json:"state,omitempty"`// Type: The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To// get a list of processor types, see FetchProcessorTypes.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "ActiveSchemaVersion") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ActiveSchemaVersion") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3Processor: The first-class citizen forDocument AI. Each processor defines how to extract structural informationfrom a document.

func (GoogleCloudDocumentaiUiv1beta3Processor)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiUiv1beta3ProcessorVersionadded inv0.255.0

type GoogleCloudDocumentaiUiv1beta3ProcessorVersion struct {// CreateTime: Output only. The time the processor version was created.CreateTimestring `json:"createTime,omitempty"`// DeploymentAllowed: Output only. Denotes that this `ProcessorVersion` can be// deployed and undeployed.DeploymentAllowedbool `json:"deploymentAllowed,omitempty"`// DeprecationInfo: Output only. If set, information about the eventual// deprecation of this version.DeprecationInfo *GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo `json:"deprecationInfo,omitempty"`// DisplayName: The display name of the processor version.DisplayNamestring `json:"displayName,omitempty"`// DocumentSchema: Output only. The schema of the processor version. Describes// the output.DocumentSchema *GoogleCloudDocumentaiUiv1beta3DocumentSchema `json:"documentSchema,omitempty"`// GenAiModelInfo: Output only. Information about Generative AI model-based// processor versions.GenAiModelInfo *GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo `json:"genAiModelInfo,omitempty"`// GoogleManaged: Output only. Denotes that this `ProcessorVersion` is managed// by Google.GoogleManagedbool `json:"googleManaged,omitempty"`// KmsKeyName: Output only. The KMS key name used for encryption.KmsKeyNamestring `json:"kmsKeyName,omitempty"`// KmsKeyVersionName: Output only. The KMS key version with which data is// encrypted.KmsKeyVersionNamestring `json:"kmsKeyVersionName,omitempty"`// LatestEvaluation: Output only. The most recently invoked evaluation for the// processor version.LatestEvaluation *GoogleCloudDocumentaiUiv1beta3EvaluationReference `json:"latestEvaluation,omitempty"`// ModelType: Output only. The model type of this processor version.//// Possible values://   "MODEL_TYPE_UNSPECIFIED" - The processor version has unspecified model// type.//   "MODEL_TYPE_GENERATIVE" - The processor version has generative model type.//   "MODEL_TYPE_CUSTOM" - The processor version has custom model type.ModelTypestring `json:"modelType,omitempty"`// Name: Identifier. The resource name of the processor version. Format:// `projects/{project}/locations/{location}/processors/{processor}/processorVers// ions/{processor_version}`Namestring `json:"name,omitempty"`// SatisfiesPzi: Output only. Reserved for future use.SatisfiesPzibool `json:"satisfiesPzi,omitempty"`// SatisfiesPzs: Output only. Reserved for future use.SatisfiesPzsbool `json:"satisfiesPzs,omitempty"`// Schema: The schema of the processor version. Describes the output.Schema *GoogleCloudDocumentaiUiv1beta3Schema `json:"schema,omitempty"`// State: Output only. The state of the processor version.//// Possible values://   "STATE_UNSPECIFIED" - The processor version is in an unspecified state.//   "DEPLOYED" - The processor version is deployed and can be used for// processing.//   "DEPLOYING" - The processor version is being deployed.//   "UNDEPLOYED" - The processor version is not deployed and cannot be used// for processing.//   "UNDEPLOYING" - The processor version is being undeployed.//   "CREATING" - The processor version is being created.//   "DELETING" - The processor version is being deleted.//   "FAILED" - The processor version failed and is in an indeterminate state.//   "IMPORTING" - The processor version is being imported.Statestring `json:"state,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3ProcessorVersion: A processor version is animplementation of a processor. Each processor can have multiple versions,pretrained by Google internally or uptrained by the customer. A processorcan only have one default version at a time. Its document-processingbehavior is defined by that version.

func (GoogleCloudDocumentaiUiv1beta3ProcessorVersion)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiUiv1beta3ProcessorVersionAliasadded inv0.255.0

type GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias struct {// Alias: The alias in the form of `processor_version` resource name.Aliasstring `json:"alias,omitempty"`// ProcessorVersion: The resource name of aliased processor version.ProcessorVersionstring `json:"processorVersion,omitempty"`// ForceSendFields is a list of field names (e.g. "Alias") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Alias") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias: Contains the alias andthe aliased resource name of processor version.

func (GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfoadded inv0.255.0

type GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo struct {// DeprecationTime: The time at which this processor version will be// deprecated.DeprecationTimestring `json:"deprecationTime,omitempty"`// ReplacementProcessorVersion: If set, the processor version that will be used// as a replacement.ReplacementProcessorVersionstring `json:"replacementProcessorVersion,omitempty"`// ForceSendFields is a list of field names (e.g. "DeprecationTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DeprecationTime") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo: Informationabout the upcoming deprecation of this processor version.

func (GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoadded inv0.255.0

type GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo struct {// CustomGenAiModelInfo: Information for a custom Generative AI model created// by the user.CustomGenAiModelInfo *GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo `json:"customGenAiModelInfo,omitempty"`// FoundationGenAiModelInfo: Information for a pretrained Google-managed// foundation model.FoundationGenAiModelInfo *GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo `json:"foundationGenAiModelInfo,omitempty"`// ForceSendFields is a list of field names (e.g. "CustomGenAiModelInfo") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CustomGenAiModelInfo") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo: Informationabout Generative AI model-based processor versions.

func (GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfoadded inv0.255.0

type GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo struct {// BaseProcessorVersionId: The base processor version ID for the custom model.BaseProcessorVersionIdstring `json:"baseProcessorVersionId,omitempty"`// CustomModelType: The type of custom model created by the user.//// Possible values://   "CUSTOM_MODEL_TYPE_UNSPECIFIED" - The model type is unspecified.//   "VERSIONED_FOUNDATION" - The model is a versioned foundation model.//   "FINE_TUNED" - The model is a finetuned foundation model.CustomModelTypestring `json:"customModelType,omitempty"`// ForceSendFields is a list of field names (e.g. "BaseProcessorVersionId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BaseProcessorVersionId") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo: Information for a custom Generative AI model created by the user. Theseare created with `Create New Version` in either the `Call foundation model`or `Fine tuning` tabs.

func (GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfoadded inv0.255.0

type GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo struct {// FinetuningAllowed: Whether finetuning is allowed for this base processor// version.FinetuningAllowedbool `json:"finetuningAllowed,omitempty"`// MinTrainLabeledDocuments: The minimum number of labeled documents in the// training dataset required for finetuning.MinTrainLabeledDocumentsint64 `json:"minTrainLabeledDocuments,omitempty"`// ForceSendFields is a list of field names (e.g. "FinetuningAllowed") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FinetuningAllowed") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo: Information for a pretrained Google-managed foundation model.

func (GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiUiv1beta3PropertyMetadataadded inv0.255.0

type GoogleCloudDocumentaiUiv1beta3PropertyMetadata struct {// FieldExtractionMetadata: Field extraction metadata on the property.FieldExtractionMetadata *GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata `json:"fieldExtractionMetadata,omitempty"`// FieldTierMetadata: Field tier metadata on the propertyFieldTierMetadata *GoogleCloudDocumentaiUiv1beta3FieldTierMetadata `json:"fieldTierMetadata,omitempty"`// HumanReviewLabelingMetadata: Human review labeling config on the property.HumanReviewLabelingMetadata *GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata `json:"humanReviewLabelingMetadata,omitempty"`// HumanReviewMetadata: Human review validation config on the property.HumanReviewMetadata *GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata `json:"humanReviewMetadata,omitempty"`// Inactive: Whether the property should be considered as "inactive".Inactivebool `json:"inactive,omitempty"`// SchemaEditabilityMetadata: Schema editability metadata on the property.SchemaEditabilityMetadata *GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata `json:"schemaEditabilityMetadata,omitempty"`// SchemaInferenceMetadata: Schema inference metadata on the property.SchemaInferenceMetadata *GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata `json:"schemaInferenceMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "FieldExtractionMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FieldExtractionMetadata") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3PropertyMetadata: Metadata about a property.

func (GoogleCloudDocumentaiUiv1beta3PropertyMetadata)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataadded inv0.69.0

type GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// DatasetResyncStatuses: The list of dataset resync statuses. Not checked when// ResyncDatasetRequest.dataset_documents is specified.DatasetResyncStatuses []*GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus `json:"datasetResyncStatuses,omitempty"`// IndividualDocumentResyncStatuses: The list of document resync statuses. The// same document could have multiple `individual_document_resync_statuses` if// it has multiple inconsistencies.IndividualDocumentResyncStatuses []*GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus `json:"individualDocumentResyncStatuses,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata: The metadata proto of`ResyncDataset` method.

func (GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata)MarshalJSONadded inv0.69.0

typeGoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatusadded inv0.94.0

type GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus struct {// DatasetInconsistencyType: The type of the inconsistency of the dataset.//// Possible values://   "DATASET_INCONSISTENCY_TYPE_UNSPECIFIED" - Default value.//   "DATASET_INCONSISTENCY_TYPE_NO_STORAGE_MARKER" - The marker file under the// dataset folder is not found.DatasetInconsistencyTypestring `json:"datasetInconsistencyType,omitempty"`// Status: The status of resyncing the dataset with regards to the detected// inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`.Status *GoogleRpcStatus `json:"status,omitempty"`// ForceSendFields is a list of field names (e.g. "DatasetInconsistencyType")// to unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DatasetInconsistencyType") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus:Resync status against inconsistency types on the dataset level.

func (GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus)MarshalJSONadded inv0.94.0

typeGoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatusadded inv0.94.0

type GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus struct {// DocumentId: The document identifier.DocumentId *GoogleCloudDocumentaiUiv1beta3DocumentId `json:"documentId,omitempty"`// DocumentInconsistencyType: The type of document inconsistency.//// Possible values://   "DOCUMENT_INCONSISTENCY_TYPE_UNSPECIFIED" - Default value.//   "DOCUMENT_INCONSISTENCY_TYPE_INVALID_DOCPROTO" - The document proto is// invalid.//   "DOCUMENT_INCONSISTENCY_TYPE_MISMATCHED_METADATA" - Indexed docproto// metadata is mismatched.//   "DOCUMENT_INCONSISTENCY_TYPE_NO_PAGE_IMAGE" - The page image or thumbnails// are missing.DocumentInconsistencyTypestring `json:"documentInconsistencyType,omitempty"`// Status: The status of resyncing the document with regards to the detected// inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`.Status *GoogleRpcStatus `json:"status,omitempty"`// ForceSendFields is a list of field names (e.g. "DocumentId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DocumentId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus: Resync status for each document per inconsistency type.

func (GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus)MarshalJSONadded inv0.94.0

typeGoogleCloudDocumentaiUiv1beta3ResyncDatasetResponseadded inv0.69.0

type GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse struct {}

GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse: The response proto ofResyncDataset method.

typeGoogleCloudDocumentaiUiv1beta3RevisionRefadded inv0.108.0

type GoogleCloudDocumentaiUiv1beta3RevisionRef struct {// LatestProcessorVersion: Reads the revision generated by the processor// version. The format takes the full resource name of processor version.// `projects/{project}/locations/{location}/processors/{processor}/processorVers// ions/{processorVersion}`LatestProcessorVersionstring `json:"latestProcessorVersion,omitempty"`// RevisionCase: Reads the revision by the predefined case.//// Possible values://   "REVISION_CASE_UNSPECIFIED" - Unspecified case, fall back to read the// `LATEST_HUMAN_REVIEW`.//   "LATEST_HUMAN_REVIEW" - The latest revision made by a human.//   "LATEST_TIMESTAMP" - The latest revision based on timestamp.//   "BASE_OCR_REVISION" - The first (OCR) revision.RevisionCasestring `json:"revisionCase,omitempty"`// RevisionId: Reads the revision given by the id.RevisionIdstring `json:"revisionId,omitempty"`// ForceSendFields is a list of field names (e.g. "LatestProcessorVersion") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "LatestProcessorVersion") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3RevisionRef: The revision reference specifieswhich revision on the document to read.

func (GoogleCloudDocumentaiUiv1beta3RevisionRef)MarshalJSONadded inv0.108.0

typeGoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadataadded inv0.122.0

type GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata: Metadata of thesample documents operation.

func (GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata)MarshalJSONadded inv0.122.0

typeGoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseadded inv0.122.0

type GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse struct {// SampleTestStatus: The status of sampling documents in test split.SampleTestStatus *GoogleRpcStatus `json:"sampleTestStatus,omitempty"`// SampleTrainingStatus: The status of sampling documents in training split.SampleTrainingStatus *GoogleRpcStatus `json:"sampleTrainingStatus,omitempty"`// SelectedDocuments: The result of the sampling process.SelectedDocuments []*GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument `json:"selectedDocuments,omitempty"`// ForceSendFields is a list of field names (e.g. "SampleTestStatus") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "SampleTestStatus") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse: Response of thesample documents operation.

func (GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse)MarshalJSONadded inv0.122.0

typeGoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocumentadded inv0.122.0

type GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument struct {// DocumentId: An internal identifier for document.DocumentIdstring `json:"documentId,omitempty"`// ForceSendFields is a list of field names (e.g. "DocumentId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DocumentId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument)MarshalJSONadded inv0.122.0

typeGoogleCloudDocumentaiUiv1beta3Schemaadded inv0.255.0

type GoogleCloudDocumentaiUiv1beta3Schema struct {// Description: Description of the schema.Descriptionstring `json:"description,omitempty"`// DisplayName: Display name to show to users.DisplayNamestring `json:"displayName,omitempty"`// EntityTypes: Entity types of the schema.EntityTypes []*GoogleCloudDocumentaiUiv1beta3SchemaEntityType `json:"entityTypes,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Description") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3Schema: The schema defines the output of theprocessed document by a processor.

func (GoogleCloudDocumentaiUiv1beta3Schema)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadataadded inv0.255.0

type GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata struct {// Editable: Explicit flag that controls whether the label is editable.Editablebool `json:"editable,omitempty"`// ProcessorVersions: Full resource name of processor versions that contain// this label. e.g.// `projects/{project}/locations/{location}/processors/{processor}/processorVers// ions/{processorVersion}`ProcessorVersions []string `json:"processorVersions,omitempty"`// ForceSendFields is a list of field names (e.g. "Editable") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Editable") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata: Metadata thatspecifies whether a label is editable and reasons why. These fields areread-only. Changing these fields has no impact on the backend.

func (GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiUiv1beta3SchemaEntityTypeadded inv0.255.0

type GoogleCloudDocumentaiUiv1beta3SchemaEntityType struct {BaseTypestring `json:"baseType,omitempty"`// Description: Description of the entity type.Descriptionstring `json:"description,omitempty"`// EnumValues: If specified, lists all the possible values for this entity.EnumValues []string `json:"enumValues,omitempty"`// Hide: If the entity type is hidden in the schema. This provides the// functionality to temporally "disable" an entity without deleting it.Hidebool `json:"hide,omitempty"`// Method: Specifies how the entity's value is obtained.//// Possible values://   "METHOD_UNSPECIFIED" - Unspecified method. It defaults to `EXTRACT`.//   "EXTRACT" - The entity's value is directly extracted as-is from the// document text.//   "DERIVE" - The entity's value is derived through inference and is not// necessarily an exact text extraction from the document.Methodstring `json:"method,omitempty"`// OccurrenceType: Occurrence type limits the number of times an entity type// appears in the document.//// Possible values://   "OCCURRENCE_TYPE_UNSPECIFIED" - Unspecified occurrence type.//   "OPTIONAL_ONCE" - The entity type will appear zero times or once.//   "OPTIONAL_MULTIPLE" - The entity type will appear zero or multiple times.//   "REQUIRED_ONCE" - The entity type will only appear exactly once.//   "REQUIRED_MULTIPLE" - The entity type will appear once or more times.OccurrenceTypestring `json:"occurrenceType,omitempty"`// Properties: Describing the nested structure of an entity. An EntityType may// consist of several other EntityTypes. For example, in a document there can// be an EntityType `ID`, which consists of EntityType `name` and `address`,// with corresponding attributes, such as TEXT for both types and ONCE for// occurrence types.Properties []*GoogleCloudDocumentaiUiv1beta3SchemaEntityType `json:"properties,omitempty"`// Source: Source of this entity type.//// Possible values://   "SOURCE_UNSPECIFIED" - Unspecified source.//   "PREDEFINED" - The entity type is in the predefined schema of a pretrained// version of a processor.//   "USER_INPUT" - The entity type is added by the users either: - during an// uptraining of an existing processor, or - during the process of creating a// customized processor.Sourcestring `json:"source,omitempty"`// Type: Name of the type. It must satisfy the following constraints: 1. Must// be unique within the set of same level types (with case-insensitive match).// 2. Maximum 64 characters. 3. Must start with a letter. 4. Allowed// characters: ASCII letters [a-zA-Z], ASCII digits [0-9], or one of the// following punctuation characters: * underscore '_' (recommended) * hyphen// '-' (allowed, not recommended) * colon ':' (allowed, not recommended) NOTE:// Whitespace characters are not allowed. 5. Cannot end with a punctuation// character. 6. Cannot contain the following restricted strings: "google",// "DocumentAI" (case-insensitive match). 7. A slash character '/' is reserved// as a separator in flattened representations of nested entity types (e.g.,// "line_item/amount") in which case each part (e.g., "line_item", "amount")// must comply with the rules defined above. We recommend using the snake case// ("snake_case") in entity type names.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "BaseType") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BaseType") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3SchemaEntityType: EntityType is the wrapper ofa label of the corresponding model with detailed attributes and limitationsfor entity-based processors. Multiple types can also compose a dependencytree to represent nested types.

func (GoogleCloudDocumentaiUiv1beta3SchemaEntityType)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadataadded inv0.255.0

type GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata struct {// Inferred: True if is inferred by schema inference.Inferredbool `json:"inferred,omitempty"`// ForceSendFields is a list of field names (e.g. "Inferred") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Inferred") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata: Metadata for schemainference. Only used on dataset.schema for schema inference, can be safelyignored elsewhere.

func (GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata

type GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata: Thelong-running operation metadata for the SetDefaultProcessorVersion method.

func (GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata)MarshalJSON

typeGoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse

type GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse struct {}

GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse: Responsemessage for the SetDefaultProcessorVersion method.

typeGoogleCloudDocumentaiUiv1beta3SummaryOptionsadded inv0.255.0

type GoogleCloudDocumentaiUiv1beta3SummaryOptions struct {// Format: The format the summary should be in.//// Possible values://   "FORMAT_UNSPECIFIED" - Default.//   "PARAGRAPH" - Format the output in paragraphs.//   "BULLETS" - Format the output in bullets.Formatstring `json:"format,omitempty"`// Length: How long the summary should be.//// Possible values://   "LENGTH_UNSPECIFIED" - Default.//   "BRIEF" - A brief summary of one or two sentences.//   "MODERATE" - A paragraph-length summary.//   "COMPREHENSIVE" - The longest option available.Lengthstring `json:"length,omitempty"`// ForceSendFields is a list of field names (e.g. "Format") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Format") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3SummaryOptions: Metadata for documentsummarization.

func (GoogleCloudDocumentaiUiv1beta3SummaryOptions)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata

type GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// TestDatasetValidation: The test dataset validation information.TestDatasetValidation *GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation `json:"testDatasetValidation,omitempty"`// TrainingDatasetValidation: The training dataset validation information.TrainingDatasetValidation *GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation `json:"trainingDatasetValidation,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata: The metadatathat represents a processor version being created.

func (GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata)MarshalJSON

typeGoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation

type GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation struct {// DatasetErrorCount: The total number of dataset errors.DatasetErrorCountint64 `json:"datasetErrorCount,omitempty"`// DatasetErrors: Error information for the dataset as a whole. A maximum of 10// dataset errors will be returned. A single dataset error is terminal for// training.DatasetErrors []*GoogleRpcStatus `json:"datasetErrors,omitempty"`// DocumentErrorCount: The total number of document errors.DocumentErrorCountint64 `json:"documentErrorCount,omitempty"`// DocumentErrors: Error information pertaining to specific documents. A// maximum of 10 document errors will be returned. Any document with errors// will not be used throughout training.DocumentErrors []*GoogleRpcStatus `json:"documentErrors,omitempty"`// ForceSendFields is a list of field names (e.g. "DatasetErrorCount") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DatasetErrorCount") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation:

The dataset validation information. This includes any and all errors with

documents and the dataset.

func (GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation)MarshalJSON

typeGoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse

type GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse struct {// ProcessorVersion: The resource name of the processor version produced by// training.ProcessorVersionstring `json:"processorVersion,omitempty"`// ForceSendFields is a list of field names (e.g. "ProcessorVersion") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ProcessorVersion") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse: The responsefor TrainProcessorVersion.

func (GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse)MarshalJSON

typeGoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata

type GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata: Thelong-running operation metadata for the UndeployProcessorVersion method.

func (GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata)MarshalJSON

typeGoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse

type GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse struct {}

GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse: Responsemessage for the UndeployProcessorVersion method.

typeGoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadataadded inv0.55.0

type GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata)MarshalJSONadded inv0.55.0

typeGoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata

type GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata: Thelong-running operation metadata for updating the human review configuration.

func (GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata)MarshalJSON

typeGoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata

type GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata: Thelong-running operation metadata for UpdateLabelerPool.

func (GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata)MarshalJSON

typeGoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadataadded inv0.255.0

type GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata struct {// CommonMetadata: The basic metadata for the long-running operation.CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata: Thelong-running operation metadata for the UpdateProcessorVersion method.

func (GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiV1Barcodeadded inv0.88.0

type GoogleCloudDocumentaiV1Barcode struct {// Format: Format of a barcode. The supported formats are: - `CODE_128`: Code// 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`:// Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. -// `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type.// - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. -// `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type.Formatstring `json:"format,omitempty"`// RawValue: Raw value encoded in the barcode. For example:// `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.RawValuestring `json:"rawValue,omitempty"`// ValueFormat: Value format describes the format of the value that a barcode// encodes. The supported formats are: - `CONTACT_INFO`: Contact information. -// `EMAIL`: Email address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number.// - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`:// URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization. -// `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license.ValueFormatstring `json:"valueFormat,omitempty"`// ForceSendFields is a list of field names (e.g. "Format") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Format") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1Barcode: Encodes the detailed information of abarcode.

func (GoogleCloudDocumentaiV1Barcode)MarshalJSONadded inv0.88.0

func (sGoogleCloudDocumentaiV1Barcode) MarshalJSON() ([]byte,error)

typeGoogleCloudDocumentaiV1BatchDocumentsInputConfig

type GoogleCloudDocumentaiV1BatchDocumentsInputConfig struct {// GcsDocuments: The set of documents individually specified on Cloud Storage.GcsDocuments *GoogleCloudDocumentaiV1GcsDocuments `json:"gcsDocuments,omitempty"`// GcsPrefix: The set of documents that match the specified Cloud Storage// `gcs_prefix`.GcsPrefix *GoogleCloudDocumentaiV1GcsPrefix `json:"gcsPrefix,omitempty"`// ForceSendFields is a list of field names (e.g. "GcsDocuments") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GcsDocuments") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1BatchDocumentsInputConfig: The common config tospecify a set of documents used as input.

func (GoogleCloudDocumentaiV1BatchDocumentsInputConfig)MarshalJSON

typeGoogleCloudDocumentaiV1BatchProcessMetadata

type GoogleCloudDocumentaiV1BatchProcessMetadata struct {// CreateTime: The creation time of the operation.CreateTimestring `json:"createTime,omitempty"`// IndividualProcessStatuses: The list of response details of each document.IndividualProcessStatuses []*GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus `json:"individualProcessStatuses,omitempty"`// State: The state of the current batch processing.//// Possible values://   "STATE_UNSPECIFIED" - The default value. This value is used if the state// is omitted.//   "WAITING" - Request operation is waiting for scheduling.//   "RUNNING" - Request is being processed.//   "SUCCEEDED" - The batch processing completed successfully.//   "CANCELLING" - The batch processing was being cancelled.//   "CANCELLED" - The batch processing was cancelled.//   "FAILED" - The batch processing has failed.Statestring `json:"state,omitempty"`// StateMessage: A message providing more details about the current state of// processing. For example, the error message if the operation is failed.StateMessagestring `json:"stateMessage,omitempty"`// UpdateTime: The last update time of the operation.UpdateTimestring `json:"updateTime,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1BatchProcessMetadata: The long-running operationmetadata for BatchProcessDocuments.

func (GoogleCloudDocumentaiV1BatchProcessMetadata)MarshalJSON

typeGoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus

type GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus struct {// HumanReviewStatus: The status of human review on the processed document.HumanReviewStatus *GoogleCloudDocumentaiV1HumanReviewStatus `json:"humanReviewStatus,omitempty"`// InputGcsSource: The source of the document, same as the input_gcs_source// field in the request when the batch process started.InputGcsSourcestring `json:"inputGcsSource,omitempty"`// OutputGcsDestination: The Cloud Storage output destination (in the request// as DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed document// if it was successful, otherwise empty.OutputGcsDestinationstring `json:"outputGcsDestination,omitempty"`// Status: The status processing the document.Status *GoogleRpcStatus `json:"status,omitempty"`// ForceSendFields is a list of field names (e.g. "HumanReviewStatus") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "HumanReviewStatus") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus: Thestatus of a each individual document in the batch process.

func (GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus)MarshalJSON

typeGoogleCloudDocumentaiV1BatchProcessRequest

type GoogleCloudDocumentaiV1BatchProcessRequest struct {// DocumentOutputConfig: The output configuration for the BatchProcessDocuments// method.DocumentOutputConfig *GoogleCloudDocumentaiV1DocumentOutputConfig `json:"documentOutputConfig,omitempty"`// InputDocuments: The input documents for the BatchProcessDocuments method.InputDocuments *GoogleCloudDocumentaiV1BatchDocumentsInputConfig `json:"inputDocuments,omitempty"`// Labels: Optional. The labels with user-defined metadata for the request.// Label keys and values can be no longer than 63 characters (Unicode// codepoints) and can only contain lowercase letters, numeric characters,// underscores, and dashes. International characters are allowed. Label values// are optional. Label keys must start with a letter.Labels map[string]string `json:"labels,omitempty"`// ProcessOptions: Inference-time options for the process APIProcessOptions *GoogleCloudDocumentaiV1ProcessOptions `json:"processOptions,omitempty"`// SkipHumanReview: Whether human review should be skipped for this request.// Default to `false`.SkipHumanReviewbool `json:"skipHumanReview,omitempty"`// ForceSendFields is a list of field names (e.g. "DocumentOutputConfig") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DocumentOutputConfig") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1BatchProcessRequest: Request message forBatchProcessDocuments.

func (GoogleCloudDocumentaiV1BatchProcessRequest)MarshalJSON

typeGoogleCloudDocumentaiV1BatchProcessResponse

type GoogleCloudDocumentaiV1BatchProcessResponse struct {}

GoogleCloudDocumentaiV1BatchProcessResponse: Response message forBatchProcessDocuments.

typeGoogleCloudDocumentaiV1BoundingPoly

type GoogleCloudDocumentaiV1BoundingPoly struct {// NormalizedVertices: The bounding polygon normalized vertices.NormalizedVertices []*GoogleCloudDocumentaiV1NormalizedVertex `json:"normalizedVertices,omitempty"`// Vertices: The bounding polygon vertices.Vertices []*GoogleCloudDocumentaiV1Vertex `json:"vertices,omitempty"`// ForceSendFields is a list of field names (e.g. "NormalizedVertices") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NormalizedVertices") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1BoundingPoly: A bounding polygon for the detectedimage annotation.

func (GoogleCloudDocumentaiV1BoundingPoly)MarshalJSON

typeGoogleCloudDocumentaiV1CommonOperationMetadata

type GoogleCloudDocumentaiV1CommonOperationMetadata struct {// CreateTime: The creation time of the operation.CreateTimestring `json:"createTime,omitempty"`// Resource: A related resource to this operation.Resourcestring `json:"resource,omitempty"`// State: The state of the operation.//// Possible values://   "STATE_UNSPECIFIED" - Unspecified state.//   "RUNNING" - Operation is still running.//   "CANCELLING" - Operation is being cancelled.//   "SUCCEEDED" - Operation succeeded.//   "FAILED" - Operation failed.//   "CANCELLED" - Operation is cancelled.Statestring `json:"state,omitempty"`// StateMessage: A message providing more details about the current state of// processing.StateMessagestring `json:"stateMessage,omitempty"`// UpdateTime: The last update time of the operation.UpdateTimestring `json:"updateTime,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1CommonOperationMetadata: The common metadata for longrunning operations.

func (GoogleCloudDocumentaiV1CommonOperationMetadata)MarshalJSON

typeGoogleCloudDocumentaiV1DeleteProcessorMetadataadded inv0.57.0

type GoogleCloudDocumentaiV1DeleteProcessorMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DeleteProcessorMetadata: The long-running operationmetadata for the DeleteProcessor method.

func (GoogleCloudDocumentaiV1DeleteProcessorMetadata)MarshalJSONadded inv0.57.0

typeGoogleCloudDocumentaiV1DeleteProcessorVersionMetadataadded inv0.57.0

type GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata: The long-runningoperation metadata for the DeleteProcessorVersion method.

func (GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata)MarshalJSONadded inv0.57.0

typeGoogleCloudDocumentaiV1DeployProcessorVersionMetadataadded inv0.57.0

type GoogleCloudDocumentaiV1DeployProcessorVersionMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DeployProcessorVersionMetadata: The long-runningoperation metadata for the DeployProcessorVersion method.

func (GoogleCloudDocumentaiV1DeployProcessorVersionMetadata)MarshalJSONadded inv0.57.0

typeGoogleCloudDocumentaiV1DeployProcessorVersionRequestadded inv0.57.0

type GoogleCloudDocumentaiV1DeployProcessorVersionRequest struct {}

GoogleCloudDocumentaiV1DeployProcessorVersionRequest: Request message forthe DeployProcessorVersion method.

typeGoogleCloudDocumentaiV1DeployProcessorVersionResponseadded inv0.57.0

type GoogleCloudDocumentaiV1DeployProcessorVersionResponse struct {}

GoogleCloudDocumentaiV1DeployProcessorVersionResponse: Response message forthe DeployProcessorVersion method.

typeGoogleCloudDocumentaiV1DisableProcessorMetadataadded inv0.57.0

type GoogleCloudDocumentaiV1DisableProcessorMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DisableProcessorMetadata: The long-running operationmetadata for the DisableProcessor method.

func (GoogleCloudDocumentaiV1DisableProcessorMetadata)MarshalJSONadded inv0.57.0

typeGoogleCloudDocumentaiV1DisableProcessorRequestadded inv0.57.0

type GoogleCloudDocumentaiV1DisableProcessorRequest struct {}

GoogleCloudDocumentaiV1DisableProcessorRequest: Request message for theDisableProcessor method.

typeGoogleCloudDocumentaiV1DisableProcessorResponseadded inv0.57.0

type GoogleCloudDocumentaiV1DisableProcessorResponse struct {}

GoogleCloudDocumentaiV1DisableProcessorResponse: Response message for theDisableProcessor method. Intentionally empty proto for adding fields infuture.

typeGoogleCloudDocumentaiV1Document

type GoogleCloudDocumentaiV1Document struct {// ChunkedDocument: Document chunked based on chunking config.ChunkedDocument *GoogleCloudDocumentaiV1DocumentChunkedDocument `json:"chunkedDocument,omitempty"`// Content: Optional. Inline document content, represented as a stream of// bytes. Note: As with all `bytes` fields, protobuffers use a pure binary// representation, whereas JSON representations use base64.Contentstring `json:"content,omitempty"`// Docid: Optional. An internal identifier for document. Should be loggable (no// PII).Docidstring `json:"docid,omitempty"`// DocumentLayout: Parsed layout of the document.DocumentLayout *GoogleCloudDocumentaiV1DocumentDocumentLayout `json:"documentLayout,omitempty"`// Entities: A list of entities detected on Document.text. For document shards,// entities in this list may cross shard boundaries.Entities []*GoogleCloudDocumentaiV1DocumentEntity `json:"entities,omitempty"`// EntitiesRevisionId: The entity revision id that `document.entities` field is// based on. If this field is set and `entities_revisions` is not empty, the// entities in `document.entities` field are the entities in the entity// revision with this id and `document.entity_validation_output` field is the// `entity_validation_output` field in this entity revision.EntitiesRevisionIdstring `json:"entitiesRevisionId,omitempty"`// EntitiesRevisions: A list of entity revisions. The entity revisions are// appended to the document in the processing order. This field can be used for// comparing the entity extraction results at different stages of the// processing.EntitiesRevisions []*GoogleCloudDocumentaiV1DocumentEntitiesRevision `json:"entitiesRevisions,omitempty"`// EntityRelations: Placeholder. Relationship among Document.entities.EntityRelations []*GoogleCloudDocumentaiV1DocumentEntityRelation `json:"entityRelations,omitempty"`// EntityValidationOutput: The entity validation output for the document. This// is the validation output for `document.entities` field.EntityValidationOutput *GoogleCloudDocumentaiV1DocumentEntityValidationOutput `json:"entityValidationOutput,omitempty"`// Error: Any error that occurred while processing this document.Error *GoogleRpcStatus `json:"error,omitempty"`// MimeType: An IANA published media type (MIME type)// (https://www.iana.org/assignments/media-types/media-types.xhtml).MimeTypestring `json:"mimeType,omitempty"`// Pages: Visual page layout for the Document.Pages []*GoogleCloudDocumentaiV1DocumentPage `json:"pages,omitempty"`// Revisions: Placeholder. Revision history of this document.Revisions []*GoogleCloudDocumentaiV1DocumentRevision `json:"revisions,omitempty"`// ShardInfo: 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 *GoogleCloudDocumentaiV1DocumentShardInfo `json:"shardInfo,omitempty"`// Text: Optional. UTF-8 encoded text in reading order from the document.Textstring `json:"text,omitempty"`// TextChanges: Placeholder. A list of text corrections made to Document.text.// This is usually used for annotating corrections to OCR mistakes. Text// changes for a given revision may not overlap with each other.TextChanges []*GoogleCloudDocumentaiV1DocumentTextChange `json:"textChanges,omitempty"`// TextStyles: Styles for the Document.text.TextStyles []*GoogleCloudDocumentaiV1DocumentStyle `json:"textStyles,omitempty"`// Uri: Optional. Currently supports Google Cloud Storage URI of the form// `gs://bucket_name/object_name`. Object versioning is not supported. For more// information, refer to Google Cloud Storage Request URIs// (https://cloud.google.com/storage/docs/reference-uris).Uristring `json:"uri,omitempty"`// ForceSendFields is a list of field names (e.g. "ChunkedDocument") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ChunkedDocument") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1Document: Document represents the canonical documentresource in Document AI. It is an interchange format that provides insightsinto documents and allows for collaboration between users and Document AI toiterate and optimize for quality.

func (GoogleCloudDocumentaiV1Document)MarshalJSON

func (sGoogleCloudDocumentaiV1Document) MarshalJSON() ([]byte,error)

typeGoogleCloudDocumentaiV1DocumentChunkedDocumentadded inv0.183.0

type GoogleCloudDocumentaiV1DocumentChunkedDocument struct {// Chunks: List of chunks.Chunks []*GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk `json:"chunks,omitempty"`// ForceSendFields is a list of field names (e.g. "Chunks") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Chunks") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentChunkedDocument: Represents the chunks thatthe document is divided into.

func (GoogleCloudDocumentaiV1DocumentChunkedDocument)MarshalJSONadded inv0.183.0

typeGoogleCloudDocumentaiV1DocumentChunkedDocumentChunkadded inv0.183.0

type GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk struct {// ChunkId: ID of the chunk.ChunkIdstring `json:"chunkId,omitempty"`// Content: Text content of the chunk.Contentstring `json:"content,omitempty"`// PageFooters: Page footers associated with the chunk.PageFooters []*GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter `json:"pageFooters,omitempty"`// PageHeaders: Page headers associated with the chunk.PageHeaders []*GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader `json:"pageHeaders,omitempty"`// PageSpan: Page span of the chunk.PageSpan *GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan `json:"pageSpan,omitempty"`// SourceBlockIds: Unused.SourceBlockIds []string `json:"sourceBlockIds,omitempty"`// ForceSendFields is a list of field names (e.g. "ChunkId") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ChunkId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk: Represents a chunk.

func (GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk)MarshalJSONadded inv0.183.0

typeGoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooteradded inv0.183.0

type GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter struct {// PageSpan: Page span of the footer.PageSpan *GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan `json:"pageSpan,omitempty"`// Text: Footer in text format.Textstring `json:"text,omitempty"`// ForceSendFields is a list of field names (e.g. "PageSpan") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PageSpan") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter:Represents the page footer associated with the chunk.

func (GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter)MarshalJSONadded inv0.183.0

typeGoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeaderadded inv0.183.0

type GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader struct {// PageSpan: Page span of the header.PageSpan *GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan `json:"pageSpan,omitempty"`// Text: Header in text format.Textstring `json:"text,omitempty"`// ForceSendFields is a list of field names (e.g. "PageSpan") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PageSpan") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader:Represents the page header associated with the chunk.

func (GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader)MarshalJSONadded inv0.183.0

typeGoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpanadded inv0.183.0

type GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan struct {// PageEnd: Page where chunk ends in the document.PageEndint64 `json:"pageEnd,omitempty"`// PageStart: Page where chunk starts in the document.PageStartint64 `json:"pageStart,omitempty"`// ForceSendFields is a list of field names (e.g. "PageEnd") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PageEnd") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan: Representswhere the chunk starts and ends in the document.

func (GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan)MarshalJSONadded inv0.183.0

typeGoogleCloudDocumentaiV1DocumentDocumentLayoutadded inv0.183.0

type GoogleCloudDocumentaiV1DocumentDocumentLayout struct {// Blocks: List of blocks in the document.Blocks []*GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock `json:"blocks,omitempty"`// ForceSendFields is a list of field names (e.g. "Blocks") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Blocks") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentDocumentLayout: Represents the parsed layoutof a document as a collection of blocks that the document is divided into.

func (GoogleCloudDocumentaiV1DocumentDocumentLayout)MarshalJSONadded inv0.183.0

typeGoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockadded inv0.183.0

type GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock struct {// BlockId: ID of the block.BlockIdstring `json:"blockId,omitempty"`// BoundingBox: Identifies the bounding box for the block.BoundingBox *GoogleCloudDocumentaiV1BoundingPoly `json:"boundingBox,omitempty"`// ListBlock: Block consisting of list content/structure.ListBlock *GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock `json:"listBlock,omitempty"`// PageSpan: Page span of the block.PageSpan *GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan `json:"pageSpan,omitempty"`// TableBlock: Block consisting of table content/structure.TableBlock *GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock `json:"tableBlock,omitempty"`// TextBlock: Block consisting of text content.TextBlock *GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock `json:"textBlock,omitempty"`// ForceSendFields is a list of field names (e.g. "BlockId") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BlockId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock: Representsa block. A block could be one of the various types (text, table, list)supported.

func (GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock)MarshalJSONadded inv0.183.0

typeGoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlockadded inv0.183.0

type GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock struct {// ListEntries: List entries that constitute a list block.ListEntries []*GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry `json:"listEntries,omitempty"`// Type: Type of the list_entries (if exist). Available options are `ordered`// and `unordered`.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "ListEntries") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ListEntries") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock: Represents a list type block.

func (GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock)MarshalJSONadded inv0.183.0

typeGoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntryadded inv0.183.0

type GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry struct {// Blocks: A list entry is a list of blocks. Repeated blocks support further// hierarchies and nested blocks.Blocks []*GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock `json:"blocks,omitempty"`// ForceSendFields is a list of field names (e.g. "Blocks") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Blocks") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry: Represents an entry in the list.

func (GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry)MarshalJSONadded inv0.183.0

typeGoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpanadded inv0.183.0

type GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan struct {// PageEnd: Page where block ends in the document.PageEndint64 `json:"pageEnd,omitempty"`// PageStart: Page where block starts in the document.PageStartint64 `json:"pageStart,omitempty"`// ForceSendFields is a list of field names (e.g. "PageEnd") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PageEnd") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan: Represents where the block starts and ends in the document.

func (GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan)MarshalJSONadded inv0.183.0

typeGoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlockadded inv0.183.0

type GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock struct {// BodyRows: Body rows containing main table content.BodyRows []*GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow `json:"bodyRows,omitempty"`// Caption: Table caption/title.Captionstring `json:"caption,omitempty"`// HeaderRows: Header rows at the top of the table.HeaderRows []*GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow `json:"headerRows,omitempty"`// ForceSendFields is a list of field names (e.g. "BodyRows") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BodyRows") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock: Represents a table type block.

func (GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock)MarshalJSONadded inv0.183.0

typeGoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCelladded inv0.183.0

type GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell struct {// Blocks: A table cell is a list of blocks. Repeated blocks support further// hierarchies and nested blocks.Blocks []*GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock `json:"blocks,omitempty"`// ColSpan: How many columns this cell spans.ColSpanint64 `json:"colSpan,omitempty"`// RowSpan: How many rows this cell spans.RowSpanint64 `json:"rowSpan,omitempty"`// ForceSendFields is a list of field names (e.g. "Blocks") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Blocks") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell: Represents a cell in a table row.

func (GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell)MarshalJSONadded inv0.183.0

typeGoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRowadded inv0.183.0

type GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow struct {// Cells: A table row is a list of table cells.Cells []*GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell `json:"cells,omitempty"`// ForceSendFields is a list of field names (e.g. "Cells") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Cells") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow: Represents a row in a table.

func (GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow)MarshalJSONadded inv0.183.0

typeGoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlockadded inv0.183.0

type GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock struct {// Blocks: A text block could further have child blocks. Repeated blocks// support further hierarchies and nested blocks.Blocks []*GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock `json:"blocks,omitempty"`// Text: Text content stored in the block.Textstring `json:"text,omitempty"`// Type: Type of the text in the block. Available options are: `paragraph`,// `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`,// `header`, `footer`.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "Blocks") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Blocks") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock: Represents a text type block.

func (GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock)MarshalJSONadded inv0.183.0

typeGoogleCloudDocumentaiV1DocumentEntitiesRevisionadded inv0.253.0

type GoogleCloudDocumentaiV1DocumentEntitiesRevision struct {// Entities: The entities in this revision.Entities []*GoogleCloudDocumentaiV1DocumentEntity `json:"entities,omitempty"`// EntityValidationOutput: The entity validation output for this revision.EntityValidationOutput *GoogleCloudDocumentaiV1DocumentEntityValidationOutput `json:"entityValidationOutput,omitempty"`// RevisionId: The revision id.RevisionIdstring `json:"revisionId,omitempty"`// ForceSendFields is a list of field names (e.g. "Entities") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Entities") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentEntitiesRevision: Entity revision.

func (GoogleCloudDocumentaiV1DocumentEntitiesRevision)MarshalJSONadded inv0.253.0

typeGoogleCloudDocumentaiV1DocumentEntity

type GoogleCloudDocumentaiV1DocumentEntity struct {// Confidence: Optional. Confidence of detected Schema entity. Range `[0, 1]`.Confidencefloat64 `json:"confidence,omitempty"`// Id: Optional. Canonical id. This will be a unique value in the entity list// for this document.Idstring `json:"id,omitempty"`// MentionId: Optional. Deprecated. Use `id` field instead.MentionIdstring `json:"mentionId,omitempty"`// MentionText: Optional. Text value of the entity e.g. `1600 Amphitheatre// Pkwy`.MentionTextstring `json:"mentionText,omitempty"`// Method: Optional. Specifies how the entity's value is obtained.//// Possible values://   "METHOD_UNSPECIFIED" - When the method is not specified, it should be// treated as `EXTRACT`.//   "EXTRACT" - The entity's value is directly extracted as-is from the// document text.//   "DERIVE" - The entity's value is derived through inference and is not// necessarily an exact text extraction from the document.Methodstring `json:"method,omitempty"`// NormalizedValue: 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 *GoogleCloudDocumentaiV1DocumentEntityNormalizedValue `json:"normalizedValue,omitempty"`// PageAnchor: Optional. Represents the provenance of this entity wrt. the// location on the page where it was found.PageAnchor *GoogleCloudDocumentaiV1DocumentPageAnchor `json:"pageAnchor,omitempty"`// Properties: Optional. Entities can be nested to form a hierarchical data// structure representing the content in the document.Properties []*GoogleCloudDocumentaiV1DocumentEntity `json:"properties,omitempty"`// Provenance: Optional. The history of this annotation.Provenance *GoogleCloudDocumentaiV1DocumentProvenance `json:"provenance,omitempty"`// Redacted: Optional. Whether the entity will be redacted for// de-identification purposes.Redactedbool `json:"redacted,omitempty"`// TextAnchor: Optional. Provenance of the entity. Text anchor indexing into// the Document.text.TextAnchor *GoogleCloudDocumentaiV1DocumentTextAnchor `json:"textAnchor,omitempty"`// Type: Required. Entity type from a schema e.g. `Address`.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "Confidence") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Confidence") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (GoogleCloudDocumentaiV1DocumentEntity)MarshalJSON

func (*GoogleCloudDocumentaiV1DocumentEntity)UnmarshalJSON

func (s *GoogleCloudDocumentaiV1DocumentEntity) UnmarshalJSON(data []byte)error

typeGoogleCloudDocumentaiV1DocumentEntityNormalizedValue

type GoogleCloudDocumentaiV1DocumentEntityNormalizedValue struct {// AddressValue: Postal address. See also://https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.protoAddressValue *GoogleTypePostalAddress `json:"addressValue,omitempty"`// BooleanValue: Boolean value. Can be used for entities with binary values, or// for checkboxes.BooleanValuebool `json:"booleanValue,omitempty"`// DateValue: Date value. Includes year, month, day. See also://https://github.com/googleapis/googleapis/blob/master/google/type/date.protoDateValue *GoogleTypeDate `json:"dateValue,omitempty"`// DatetimeValue: DateTime value. Includes date, time, and timezone. See also://https://github.com/googleapis/googleapis/blob/master/google/type/datetime.protoDatetimeValue *GoogleTypeDateTime `json:"datetimeValue,omitempty"`// FloatValue: Float value.FloatValuefloat64 `json:"floatValue,omitempty"`// IntegerValue: Integer value.IntegerValueint64 `json:"integerValue,omitempty"`// MoneyValue: Money value. See also://https://github.com/googleapis/googleapis/blob/master/google/type/money.protoMoneyValue *GoogleTypeMoney `json:"moneyValue,omitempty"`// SignatureValue: A signature - a graphical representation of a person's name,// often used to sign a document.SignatureValuebool `json:"signatureValue,omitempty"`// Text: Optional. An optional field to store a normalized string. For some// entity types, one of respective `structured_value` fields may also be// populated. Also not all the types of `structured_value` will be normalized.// For example, some processors may not generate `float` or `integer`// normalized text by default. Below are sample formats mapped to structured// values. - Money/Currency type (`money_value`) is in the ISO 4217 text// format. - Date type (`date_value`) is in the ISO 8601 text format. -// Datetime type (`datetime_value`) is in the ISO 8601 text format.Textstring `json:"text,omitempty"`// ForceSendFields is a list of field names (e.g. "AddressValue") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AddressValue") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentEntityNormalizedValue: Parsed and normalizedentity value.

func (GoogleCloudDocumentaiV1DocumentEntityNormalizedValue)MarshalJSON

func (*GoogleCloudDocumentaiV1DocumentEntityNormalizedValue)UnmarshalJSONadded inv0.55.0

typeGoogleCloudDocumentaiV1DocumentEntityRelation

type GoogleCloudDocumentaiV1DocumentEntityRelation struct {// ObjectId: Object entity id.ObjectIdstring `json:"objectId,omitempty"`// Relation: Relationship description.Relationstring `json:"relation,omitempty"`// SubjectId: Subject entity id.SubjectIdstring `json:"subjectId,omitempty"`// ForceSendFields is a list of field names (e.g. "ObjectId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ObjectId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentEntityRelation: Relationship betweenEntities.

func (GoogleCloudDocumentaiV1DocumentEntityRelation)MarshalJSON

typeGoogleCloudDocumentaiV1DocumentEntityValidationOutputadded inv0.253.0

type GoogleCloudDocumentaiV1DocumentEntityValidationOutput struct {// PassAllRules: The overall result of the validation, true if all applicable// rules are valid.PassAllRulesbool `json:"passAllRules,omitempty"`// ValidationResults: The result of each validation rule.ValidationResults []*GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult `json:"validationResults,omitempty"`// ForceSendFields is a list of field names (e.g. "PassAllRules") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PassAllRules") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentEntityValidationOutput: The output of thevalidation given the document and the validation rules.

func (GoogleCloudDocumentaiV1DocumentEntityValidationOutput)MarshalJSONadded inv0.253.0

typeGoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResultadded inv0.253.0

type GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult struct {// Rule: Optional. The name of the rule resource that is used for validation.// Format: `projects/{project}/locations/{location}/rules/{rule}`Rulestring `json:"rule,omitempty"`// RuleDescription: The description of the validation rule.RuleDescriptionstring `json:"ruleDescription,omitempty"`// RuleName: The display name of the validation rule.RuleNamestring `json:"ruleName,omitempty"`// ValidationDetails: The detailed information of the running the validation// process using the entity from the document based on the validation rule.ValidationDetailsstring `json:"validationDetails,omitempty"`// ValidationResultType: The result of the validation rule.//// Possible values://   "VALIDATION_RESULT_TYPE_UNSPECIFIED" - The validation result type is// unspecified.//   "VALIDATION_RESULT_TYPE_VALID" - The validation is valid.//   "VALIDATION_RESULT_TYPE_INVALID" - The validation is invalid.//   "VALIDATION_RESULT_TYPE_SKIPPED" - The validation is skipped.//   "VALIDATION_RESULT_TYPE_NOT_APPLICABLE" - The validation is not// applicable.ValidationResultTypestring `json:"validationResultType,omitempty"`// ForceSendFields is a list of field names (e.g. "Rule") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Rule") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult:Validation result for a single validation rule.

func (GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult)MarshalJSONadded inv0.253.0

typeGoogleCloudDocumentaiV1DocumentOutputConfig

type GoogleCloudDocumentaiV1DocumentOutputConfig struct {// GcsOutputConfig: Output config to write the results to Cloud Storage.GcsOutputConfig *GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig `json:"gcsOutputConfig,omitempty"`// ForceSendFields is a list of field names (e.g. "GcsOutputConfig") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GcsOutputConfig") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentOutputConfig: Config that controls the outputof documents. All documents will be written as a JSON file.

func (GoogleCloudDocumentaiV1DocumentOutputConfig)MarshalJSON

typeGoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig

type GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig struct {// FieldMask: Specifies which fields to include in the output documents. Only// supports top level document and pages field so it must be in the form of// `{document_field_name}` or `pages.{page_field_name}`.FieldMaskstring `json:"fieldMask,omitempty"`// GcsUri: The Cloud Storage uri (a directory) of the output.GcsUristring `json:"gcsUri,omitempty"`// ShardingConfig: Specifies the sharding config for the output document.ShardingConfig *GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig `json:"shardingConfig,omitempty"`// ForceSendFields is a list of field names (e.g. "FieldMask") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FieldMask") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig: Theconfiguration used when outputting documents.

func (GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig)MarshalJSON

typeGoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfigadded inv0.105.0

type GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig struct {// PagesOverlap: The number of overlapping pages between consecutive shards.PagesOverlapint64 `json:"pagesOverlap,omitempty"`// PagesPerShard: The number of pages per shard.PagesPerShardint64 `json:"pagesPerShard,omitempty"`// ForceSendFields is a list of field names (e.g. "PagesOverlap") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PagesOverlap") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig:The sharding config for the output document.

func (GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig)MarshalJSONadded inv0.105.0

typeGoogleCloudDocumentaiV1DocumentPage

type GoogleCloudDocumentaiV1DocumentPage struct {// Blocks: 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 []*GoogleCloudDocumentaiV1DocumentPageBlock `json:"blocks,omitempty"`// DetectedBarcodes: A list of detected barcodes.DetectedBarcodes []*GoogleCloudDocumentaiV1DocumentPageDetectedBarcode `json:"detectedBarcodes,omitempty"`// DetectedLanguages: A list of detected languages together with confidence.DetectedLanguages []*GoogleCloudDocumentaiV1DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"`// Dimension: Physical dimension of the page.Dimension *GoogleCloudDocumentaiV1DocumentPageDimension `json:"dimension,omitempty"`// FormFields: A list of visually detected form fields on the page.FormFields []*GoogleCloudDocumentaiV1DocumentPageFormField `json:"formFields,omitempty"`// Image: 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 *GoogleCloudDocumentaiV1DocumentPageImage `json:"image,omitempty"`// ImageQualityScores: Image quality scores.ImageQualityScores *GoogleCloudDocumentaiV1DocumentPageImageQualityScores `json:"imageQualityScores,omitempty"`// Layout: Layout for the page.Layout *GoogleCloudDocumentaiV1DocumentPageLayout `json:"layout,omitempty"`// Lines: A list of visually detected text lines on the page. A collection of// tokens that a human would perceive as a line.Lines []*GoogleCloudDocumentaiV1DocumentPageLine `json:"lines,omitempty"`// PageNumber: 1-based index for current Page in a parent Document. Useful when// a page is taken out of a Document for individual processing.PageNumberint64 `json:"pageNumber,omitempty"`// Paragraphs: A list of visually detected text paragraphs on the page. A// collection of lines that a human would perceive as a paragraph.Paragraphs []*GoogleCloudDocumentaiV1DocumentPageParagraph `json:"paragraphs,omitempty"`// Provenance: The history of this page.Provenance *GoogleCloudDocumentaiV1DocumentProvenance `json:"provenance,omitempty"`// Symbols: A list of visually detected symbols on the page.Symbols []*GoogleCloudDocumentaiV1DocumentPageSymbol `json:"symbols,omitempty"`// Tables: A list of visually detected tables on the page.Tables []*GoogleCloudDocumentaiV1DocumentPageTable `json:"tables,omitempty"`// Tokens: A list of visually detected tokens on the page.Tokens []*GoogleCloudDocumentaiV1DocumentPageToken `json:"tokens,omitempty"`// Transforms: Transformation matrices that were applied to the original// document image to produce Page.image.Transforms []*GoogleCloudDocumentaiV1DocumentPageMatrix `json:"transforms,omitempty"`// VisualElements: A list of detected non-text visual elements e.g. checkbox,// signature etc. on the page.VisualElements []*GoogleCloudDocumentaiV1DocumentPageVisualElement `json:"visualElements,omitempty"`// ForceSendFields is a list of field names (e.g. "Blocks") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Blocks") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentPage: A page in a Document.

func (GoogleCloudDocumentaiV1DocumentPage)MarshalJSON

typeGoogleCloudDocumentaiV1DocumentPageAnchor

type GoogleCloudDocumentaiV1DocumentPageAnchor struct {// PageRefs: One or more references to visual page elementsPageRefs []*GoogleCloudDocumentaiV1DocumentPageAnchorPageRef `json:"pageRefs,omitempty"`// ForceSendFields is a list of field names (e.g. "PageRefs") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PageRefs") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentPageAnchor: Referencing the visual context ofthe entity in the Document.pages. Page anchors can be cross-page, consist ofmultiple bounding polygons and optionally reference specific layout elementtypes.

func (GoogleCloudDocumentaiV1DocumentPageAnchor)MarshalJSON

typeGoogleCloudDocumentaiV1DocumentPageAnchorPageRef

type GoogleCloudDocumentaiV1DocumentPageAnchorPageRef struct {// BoundingPoly: Optional. Identifies the bounding polygon of a layout element// on the page. If `layout_type` is set, the bounding polygon must be exactly// the same to the layout element it's referring to.BoundingPoly *GoogleCloudDocumentaiV1BoundingPoly `json:"boundingPoly,omitempty"`// Confidence: Optional. Confidence of detected page element, if applicable.// Range `[0, 1]`.Confidencefloat64 `json:"confidence,omitempty"`// LayoutId: Optional. Deprecated. Use PageRef.bounding_poly instead.LayoutIdstring `json:"layoutId,omitempty"`// LayoutType: Optional. The type of the layout element that is being// referenced if any.//// Possible values://   "LAYOUT_TYPE_UNSPECIFIED" - Layout Unspecified.//   "BLOCK" - References a Page.blocks element.//   "PARAGRAPH" - References a Page.paragraphs element.//   "LINE" - References a Page.lines element.//   "TOKEN" - References a Page.tokens element.//   "VISUAL_ELEMENT" - References a Page.visual_elements element.//   "TABLE" - Refrrences a Page.tables element.//   "FORM_FIELD" - References a Page.form_fields element.LayoutTypestring `json:"layoutType,omitempty"`// Page: Required. Index into the Document.pages element, for example using// `Document.pages` to locate the related page element. This field is skipped// when its value is the default `0`. See//https://developers.google.com/protocol-buffers/docs/proto3#json.Pageint64 `json:"page,omitempty,string"`// ForceSendFields is a list of field names (e.g. "BoundingPoly") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BoundingPoly") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentPageAnchorPageRef: Represents a weakreference to a page element within a document.

func (GoogleCloudDocumentaiV1DocumentPageAnchorPageRef)MarshalJSON

func (*GoogleCloudDocumentaiV1DocumentPageAnchorPageRef)UnmarshalJSONadded inv0.47.0

typeGoogleCloudDocumentaiV1DocumentPageBlock

type GoogleCloudDocumentaiV1DocumentPageBlock struct {// DetectedLanguages: A list of detected languages together with confidence.DetectedLanguages []*GoogleCloudDocumentaiV1DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"`// Layout: Layout for Block.Layout *GoogleCloudDocumentaiV1DocumentPageLayout `json:"layout,omitempty"`// Provenance: The history of this annotation.Provenance *GoogleCloudDocumentaiV1DocumentProvenance `json:"provenance,omitempty"`// ForceSendFields is a list of field names (e.g. "DetectedLanguages") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DetectedLanguages") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (GoogleCloudDocumentaiV1DocumentPageBlock)MarshalJSON

typeGoogleCloudDocumentaiV1DocumentPageDetectedBarcodeadded inv0.88.0

type GoogleCloudDocumentaiV1DocumentPageDetectedBarcode struct {// Barcode: Detailed barcode information of the DetectedBarcode.Barcode *GoogleCloudDocumentaiV1Barcode `json:"barcode,omitempty"`// Layout: Layout for DetectedBarcode.Layout *GoogleCloudDocumentaiV1DocumentPageLayout `json:"layout,omitempty"`// ForceSendFields is a list of field names (e.g. "Barcode") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Barcode") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentPageDetectedBarcode: A detected barcode.

func (GoogleCloudDocumentaiV1DocumentPageDetectedBarcode)MarshalJSONadded inv0.88.0

typeGoogleCloudDocumentaiV1DocumentPageDetectedLanguage

type GoogleCloudDocumentaiV1DocumentPageDetectedLanguage struct {// Confidence: Confidence of detected language. Range `[0, 1]`.Confidencefloat64 `json:"confidence,omitempty"`// LanguageCode: The BCP-47 language code// (https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as// `en-US` or `sr-Latn`.LanguageCodestring `json:"languageCode,omitempty"`// ForceSendFields is a list of field names (e.g. "Confidence") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Confidence") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentPageDetectedLanguage: Detected language for astructural component.

func (GoogleCloudDocumentaiV1DocumentPageDetectedLanguage)MarshalJSON

func (*GoogleCloudDocumentaiV1DocumentPageDetectedLanguage)UnmarshalJSON

typeGoogleCloudDocumentaiV1DocumentPageDimension

type GoogleCloudDocumentaiV1DocumentPageDimension struct {// Height: Page height.Heightfloat64 `json:"height,omitempty"`// Unit: Dimension unit.Unitstring `json:"unit,omitempty"`// Width: Page width.Widthfloat64 `json:"width,omitempty"`// ForceSendFields is a list of field names (e.g. "Height") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Height") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentPageDimension: Dimension for the page.

func (GoogleCloudDocumentaiV1DocumentPageDimension)MarshalJSON

func (*GoogleCloudDocumentaiV1DocumentPageDimension)UnmarshalJSON

typeGoogleCloudDocumentaiV1DocumentPageFormField

type GoogleCloudDocumentaiV1DocumentPageFormField struct {// CorrectedKeyText: Created for Labeling UI to export key text. If corrections// were made to the text identified by the `field_name.text_anchor`, this field// will contain the correction.CorrectedKeyTextstring `json:"correctedKeyText,omitempty"`// CorrectedValueText: Created for Labeling UI to export value text. If// corrections were made to the text identified by the// `field_value.text_anchor`, this field will contain the correction.CorrectedValueTextstring `json:"correctedValueText,omitempty"`// FieldName: Layout for the FormField name. e.g. `Address`, `Email`, `Grand// total`, `Phone number`, etc.FieldName *GoogleCloudDocumentaiV1DocumentPageLayout `json:"fieldName,omitempty"`// FieldValue: Layout for the FormField value.FieldValue *GoogleCloudDocumentaiV1DocumentPageLayout `json:"fieldValue,omitempty"`// NameDetectedLanguages: A list of detected languages for name together with// confidence.NameDetectedLanguages []*GoogleCloudDocumentaiV1DocumentPageDetectedLanguage `json:"nameDetectedLanguages,omitempty"`// Provenance: The history of this annotation.Provenance *GoogleCloudDocumentaiV1DocumentProvenance `json:"provenance,omitempty"`// ValueDetectedLanguages: A list of detected languages for value together with// confidence.ValueDetectedLanguages []*GoogleCloudDocumentaiV1DocumentPageDetectedLanguage `json:"valueDetectedLanguages,omitempty"`// ValueType: 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`ValueTypestring `json:"valueType,omitempty"`// ForceSendFields is a list of field names (e.g. "CorrectedKeyText") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CorrectedKeyText") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentPageFormField: A form field detected on thepage.

func (GoogleCloudDocumentaiV1DocumentPageFormField)MarshalJSON

typeGoogleCloudDocumentaiV1DocumentPageImage

type GoogleCloudDocumentaiV1DocumentPageImage struct {// Content: Raw byte content of the image.Contentstring `json:"content,omitempty"`// Height: Height of the image in pixels.Heightint64 `json:"height,omitempty"`// MimeType: Encoding media type (MIME type)// (https://www.iana.org/assignments/media-types/media-types.xhtml) for the// image.MimeTypestring `json:"mimeType,omitempty"`// Width: Width of the image in pixels.Widthint64 `json:"width,omitempty"`// ForceSendFields is a list of field names (e.g. "Content") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Content") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentPageImage: Rendered image contents for thispage.

func (GoogleCloudDocumentaiV1DocumentPageImage)MarshalJSON

typeGoogleCloudDocumentaiV1DocumentPageImageQualityScoresadded inv0.98.0

type GoogleCloudDocumentaiV1DocumentPageImageQualityScores struct {// DetectedDefects: A list of detected defects.DetectedDefects []*GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect `json:"detectedDefects,omitempty"`// QualityScore: The overall quality score. Range `[0, 1]` where `1` is perfect// quality.QualityScorefloat64 `json:"qualityScore,omitempty"`// ForceSendFields is a list of field names (e.g. "DetectedDefects") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DetectedDefects") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentPageImageQualityScores: Image quality scoresfor the page image.

func (GoogleCloudDocumentaiV1DocumentPageImageQualityScores)MarshalJSONadded inv0.98.0

func (*GoogleCloudDocumentaiV1DocumentPageImageQualityScores)UnmarshalJSONadded inv0.98.0

typeGoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefectadded inv0.98.0

type GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect struct {// Confidence: Confidence of detected defect. Range `[0, 1]` where `1`// indicates strong confidence that the defect exists.Confidencefloat64 `json:"confidence,omitempty"`// Type: Name of the defect type. Supported values are: -// `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` -// `quality/defect_faint` - `quality/defect_text_too_small` -// `quality/defect_document_cutoff` - `quality/defect_text_cutoff` -// `quality/defect_glare`Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "Confidence") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Confidence") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect: ImageQuality Defects

func (GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect)MarshalJSONadded inv0.98.0

func (*GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect)UnmarshalJSONadded inv0.98.0

typeGoogleCloudDocumentaiV1DocumentPageLayout

type GoogleCloudDocumentaiV1DocumentPageLayout struct {// BoundingPoly: The bounding polygon for the Layout.BoundingPoly *GoogleCloudDocumentaiV1BoundingPoly `json:"boundingPoly,omitempty"`// Confidence: Confidence of the current 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]`.Confidencefloat64 `json:"confidence,omitempty"`// Orientation: Detected orientation for the Layout.//// Possible values://   "ORIENTATION_UNSPECIFIED" - Unspecified orientation.//   "PAGE_UP" - Orientation is aligned with page up.//   "PAGE_RIGHT" - Orientation is aligned with page right. Turn the head 90// degrees clockwise from upright to read.//   "PAGE_DOWN" - Orientation is aligned with page down. Turn the head 180// degrees from upright to read.//   "PAGE_LEFT" - Orientation is aligned with page left. Turn the head 90// degrees counterclockwise from upright to read.Orientationstring `json:"orientation,omitempty"`// TextAnchor: Text anchor indexing into the Document.text.TextAnchor *GoogleCloudDocumentaiV1DocumentTextAnchor `json:"textAnchor,omitempty"`// ForceSendFields is a list of field names (e.g. "BoundingPoly") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BoundingPoly") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentPageLayout: Visual element describing alayout unit on a page.

func (GoogleCloudDocumentaiV1DocumentPageLayout)MarshalJSON

func (*GoogleCloudDocumentaiV1DocumentPageLayout)UnmarshalJSON

typeGoogleCloudDocumentaiV1DocumentPageLine

type GoogleCloudDocumentaiV1DocumentPageLine struct {// DetectedLanguages: A list of detected languages together with confidence.DetectedLanguages []*GoogleCloudDocumentaiV1DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"`// Layout: Layout for Line.Layout *GoogleCloudDocumentaiV1DocumentPageLayout `json:"layout,omitempty"`// Provenance: The history of this annotation.Provenance *GoogleCloudDocumentaiV1DocumentProvenance `json:"provenance,omitempty"`// ForceSendFields is a list of field names (e.g. "DetectedLanguages") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DetectedLanguages") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentPageLine: A collection of tokens that a humanwould perceive as a line. Does not cross column boundaries, can behorizontal, vertical, etc.

func (GoogleCloudDocumentaiV1DocumentPageLine)MarshalJSON

typeGoogleCloudDocumentaiV1DocumentPageMatrix

type GoogleCloudDocumentaiV1DocumentPageMatrix struct {// Cols: Number of columns in the matrix.Colsint64 `json:"cols,omitempty"`// Data: The matrix data.Datastring `json:"data,omitempty"`// Rows: Number of rows in the matrix.Rowsint64 `json:"rows,omitempty"`// Type: 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.htmlTypeint64 `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "Cols") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Cols") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentPageMatrix: Representation for transformationmatrix, intended to be compatible and used with OpenCV format for imagemanipulation.

func (GoogleCloudDocumentaiV1DocumentPageMatrix)MarshalJSON

typeGoogleCloudDocumentaiV1DocumentPageParagraph

type GoogleCloudDocumentaiV1DocumentPageParagraph struct {// DetectedLanguages: A list of detected languages together with confidence.DetectedLanguages []*GoogleCloudDocumentaiV1DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"`// Layout: Layout for Paragraph.Layout *GoogleCloudDocumentaiV1DocumentPageLayout `json:"layout,omitempty"`// Provenance: The history of this annotation.Provenance *GoogleCloudDocumentaiV1DocumentProvenance `json:"provenance,omitempty"`// ForceSendFields is a list of field names (e.g. "DetectedLanguages") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DetectedLanguages") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentPageParagraph: A collection of lines that ahuman would perceive as a paragraph.

func (GoogleCloudDocumentaiV1DocumentPageParagraph)MarshalJSON

typeGoogleCloudDocumentaiV1DocumentPageSymboladded inv0.69.0

type GoogleCloudDocumentaiV1DocumentPageSymbol struct {// DetectedLanguages: A list of detected languages together with confidence.DetectedLanguages []*GoogleCloudDocumentaiV1DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"`// Layout: Layout for Symbol.Layout *GoogleCloudDocumentaiV1DocumentPageLayout `json:"layout,omitempty"`// ForceSendFields is a list of field names (e.g. "DetectedLanguages") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DetectedLanguages") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentPageSymbol: A detected symbol.

func (GoogleCloudDocumentaiV1DocumentPageSymbol)MarshalJSONadded inv0.69.0

typeGoogleCloudDocumentaiV1DocumentPageTable

type GoogleCloudDocumentaiV1DocumentPageTable struct {// BodyRows: Body rows of the table.BodyRows []*GoogleCloudDocumentaiV1DocumentPageTableTableRow `json:"bodyRows,omitempty"`// DetectedLanguages: A list of detected languages together with confidence.DetectedLanguages []*GoogleCloudDocumentaiV1DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"`// HeaderRows: Header rows of the table.HeaderRows []*GoogleCloudDocumentaiV1DocumentPageTableTableRow `json:"headerRows,omitempty"`// Layout: Layout for Table.Layout *GoogleCloudDocumentaiV1DocumentPageLayout `json:"layout,omitempty"`// Provenance: The history of this table.Provenance *GoogleCloudDocumentaiV1DocumentProvenance `json:"provenance,omitempty"`// ForceSendFields is a list of field names (e.g. "BodyRows") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BodyRows") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentPageTable: A table representation similar toHTML table structure.

func (GoogleCloudDocumentaiV1DocumentPageTable)MarshalJSON

typeGoogleCloudDocumentaiV1DocumentPageTableTableCell

type GoogleCloudDocumentaiV1DocumentPageTableTableCell struct {// ColSpan: How many columns this cell spans.ColSpanint64 `json:"colSpan,omitempty"`// DetectedLanguages: A list of detected languages together with confidence.DetectedLanguages []*GoogleCloudDocumentaiV1DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"`// Layout: Layout for TableCell.Layout *GoogleCloudDocumentaiV1DocumentPageLayout `json:"layout,omitempty"`// RowSpan: How many rows this cell spans.RowSpanint64 `json:"rowSpan,omitempty"`// ForceSendFields is a list of field names (e.g. "ColSpan") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ColSpan") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentPageTableTableCell: A cell representationinside the table.

func (GoogleCloudDocumentaiV1DocumentPageTableTableCell)MarshalJSON

typeGoogleCloudDocumentaiV1DocumentPageTableTableRow

type GoogleCloudDocumentaiV1DocumentPageTableTableRow struct {// Cells: Cells that make up this row.Cells []*GoogleCloudDocumentaiV1DocumentPageTableTableCell `json:"cells,omitempty"`// ForceSendFields is a list of field names (e.g. "Cells") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Cells") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentPageTableTableRow: A row of table cells.

func (GoogleCloudDocumentaiV1DocumentPageTableTableRow)MarshalJSON

typeGoogleCloudDocumentaiV1DocumentPageToken

type GoogleCloudDocumentaiV1DocumentPageToken struct {// DetectedBreak: Detected break at the end of a Token.DetectedBreak *GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak `json:"detectedBreak,omitempty"`// DetectedLanguages: A list of detected languages together with confidence.DetectedLanguages []*GoogleCloudDocumentaiV1DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"`// Layout: Layout for Token.Layout *GoogleCloudDocumentaiV1DocumentPageLayout `json:"layout,omitempty"`// Provenance: The history of this annotation.Provenance *GoogleCloudDocumentaiV1DocumentProvenance `json:"provenance,omitempty"`// StyleInfo: Text style attributes.StyleInfo *GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo `json:"styleInfo,omitempty"`// ForceSendFields is a list of field names (e.g. "DetectedBreak") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DetectedBreak") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentPageToken: A detected token.

func (GoogleCloudDocumentaiV1DocumentPageToken)MarshalJSON

typeGoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak

type GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak struct {// Type: Detected break type.//// Possible values://   "TYPE_UNSPECIFIED" - Unspecified break type.//   "SPACE" - A single whitespace.//   "WIDE_SPACE" - A wider whitespace.//   "HYPHEN" - A hyphen that indicates that a token has been split across// lines.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "Type") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Type") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak: Detected break at theend of a Token.

func (GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak)MarshalJSON

typeGoogleCloudDocumentaiV1DocumentPageTokenStyleInfoadded inv0.121.0

type GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo struct {// BackgroundColor: Color of the background.BackgroundColor *GoogleTypeColor `json:"backgroundColor,omitempty"`// Bold: Whether the text is bold (equivalent to font_weight is at least// `700`).Boldbool `json:"bold,omitempty"`// FontSize: Font size in points (`1` point is `¹⁄₇₂` inches).FontSizeint64 `json:"fontSize,omitempty"`// FontType: Name or style of the font.FontTypestring `json:"fontType,omitempty"`// FontWeight: TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy).// Normal is `400`, bold is `700`.FontWeightint64 `json:"fontWeight,omitempty"`// Handwritten: Whether the text is handwritten.Handwrittenbool `json:"handwritten,omitempty"`// Italic: Whether the text is italic.Italicbool `json:"italic,omitempty"`// LetterSpacing: Letter spacing in points.LetterSpacingfloat64 `json:"letterSpacing,omitempty"`// PixelFontSize: Font size in pixels, equal to _unrounded font_size_ *// _resolution_ ÷ `72.0`.PixelFontSizefloat64 `json:"pixelFontSize,omitempty"`// Smallcaps: Whether the text is in small caps. This feature is not supported// yet.Smallcapsbool `json:"smallcaps,omitempty"`// Strikeout: Whether the text is strikethrough. This feature is not supported// yet.Strikeoutbool `json:"strikeout,omitempty"`// Subscript: Whether the text is a subscript. This feature is not supported// yet.Subscriptbool `json:"subscript,omitempty"`// Superscript: Whether the text is a superscript. This feature is not// supported yet.Superscriptbool `json:"superscript,omitempty"`// TextColor: Color of the text.TextColor *GoogleTypeColor `json:"textColor,omitempty"`// Underlined: Whether the text is underlined.Underlinedbool `json:"underlined,omitempty"`// ForceSendFields is a list of field names (e.g. "BackgroundColor") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BackgroundColor") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo: Font and other text styleattributes.

func (GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo)MarshalJSONadded inv0.121.0

func (*GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo)UnmarshalJSONadded inv0.121.0

typeGoogleCloudDocumentaiV1DocumentPageVisualElement

type GoogleCloudDocumentaiV1DocumentPageVisualElement struct {// DetectedLanguages: A list of detected languages together with confidence.DetectedLanguages []*GoogleCloudDocumentaiV1DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"`// Layout: Layout for VisualElement.Layout *GoogleCloudDocumentaiV1DocumentPageLayout `json:"layout,omitempty"`// Type: Type of the VisualElement.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "DetectedLanguages") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DetectedLanguages") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentPageVisualElement: Detected non-text visualelements e.g. checkbox, signature etc. on the page.

func (GoogleCloudDocumentaiV1DocumentPageVisualElement)MarshalJSON

typeGoogleCloudDocumentaiV1DocumentProvenance

type GoogleCloudDocumentaiV1DocumentProvenance struct {// Id: The Id of this operation. Needs to be unique within the scope of the// revision.Idint64 `json:"id,omitempty"`// Parents: References to the original elements that are replaced.Parents []*GoogleCloudDocumentaiV1DocumentProvenanceParent `json:"parents,omitempty"`// Revision: The index of the revision that produced this element.Revisionint64 `json:"revision,omitempty"`// Type: The type of provenance operation.//// Possible values://   "OPERATION_TYPE_UNSPECIFIED" - Operation type unspecified. If no operation// is specified a provenance entry is simply used to match against a `parent`.//   "ADD" - Add an element.//   "REMOVE" - Remove an element identified by `parent`.//   "UPDATE" - Updates any fields within the given provenance scope of the// message. It overwrites the fields rather than replacing them. Use this when// you want to update a field value of an entity without also updating all the// child properties.//   "REPLACE" - Currently unused. Replace an element identified by `parent`.//   "EVAL_REQUESTED" - Deprecated. Request human review for the element// identified by `parent`.//   "EVAL_APPROVED" - Deprecated. Element is reviewed and approved at human// review, confidence will be set to 1.0.//   "EVAL_SKIPPED" - Deprecated. Element is skipped in the validation process.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "Id") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Id") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentProvenance: Structure to identify provenancerelationships between annotations in different revisions.

func (GoogleCloudDocumentaiV1DocumentProvenance)MarshalJSON

typeGoogleCloudDocumentaiV1DocumentProvenanceParent

type GoogleCloudDocumentaiV1DocumentProvenanceParent struct {// Id: The id of the parent provenance.Idint64 `json:"id,omitempty"`// Index: The index of the parent item in the corresponding item list (eg. list// of entities, properties within entities, etc.) in the parent revision.Indexint64 `json:"index,omitempty"`// Revision: The index of the index into current revision's parent_ids list.Revisionint64 `json:"revision,omitempty"`// ForceSendFields is a list of field names (e.g. "Id") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Id") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentProvenanceParent: The parent element thecurrent element is based on. Used for referencing/aligning, removal andreplacement operations.

func (GoogleCloudDocumentaiV1DocumentProvenanceParent)MarshalJSON

typeGoogleCloudDocumentaiV1DocumentRevision

type GoogleCloudDocumentaiV1DocumentRevision struct {// Agent: If the change was made by a person specify the name or id of that// person.Agentstring `json:"agent,omitempty"`// CreateTime: The time that the revision was created, internally generated by// doc proto storage at the time of create.CreateTimestring `json:"createTime,omitempty"`// HumanReview: Human Review information of this revision.HumanReview *GoogleCloudDocumentaiV1DocumentRevisionHumanReview `json:"humanReview,omitempty"`// Id: Id of the revision, internally generated by doc proto storage. Unique// within the context of the document.Idstring `json:"id,omitempty"`// Parent: 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 []int64 `json:"parent,omitempty"`// ParentIds: The revisions that this revision is based on. Must include all// the ids that have anything to do with this revision - eg. there are// `provenance.parent.revision` fields that index into this field.ParentIds []string `json:"parentIds,omitempty"`// Processor: If the annotation was made by processor identify the processor by// its resource name.Processorstring `json:"processor,omitempty"`// ForceSendFields is a list of field names (e.g. "Agent") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Agent") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentRevision: Contains past or forward revisionsof this document.

func (GoogleCloudDocumentaiV1DocumentRevision)MarshalJSON

typeGoogleCloudDocumentaiV1DocumentRevisionHumanReview

type GoogleCloudDocumentaiV1DocumentRevisionHumanReview struct {// State: Human review state. e.g. `requested`, `succeeded`, `rejected`.Statestring `json:"state,omitempty"`// StateMessage: A message providing more details about the current state of// processing. For example, the rejection reason when the state is `rejected`.StateMessagestring `json:"stateMessage,omitempty"`// ForceSendFields is a list of field names (e.g. "State") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "State") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentRevisionHumanReview: Human Review informationof the document.

func (GoogleCloudDocumentaiV1DocumentRevisionHumanReview)MarshalJSON

typeGoogleCloudDocumentaiV1DocumentSchemaadded inv0.85.0

type GoogleCloudDocumentaiV1DocumentSchema struct {// Description: Description of the schema.Descriptionstring `json:"description,omitempty"`// DisplayName: Display name to show to users.DisplayNamestring `json:"displayName,omitempty"`// EntityTypes: Entity types of the schema.EntityTypes []*GoogleCloudDocumentaiV1DocumentSchemaEntityType `json:"entityTypes,omitempty"`// Metadata: Metadata of the schema.Metadata *GoogleCloudDocumentaiV1DocumentSchemaMetadata `json:"metadata,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Description") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentSchema: The schema defines the output of theprocessed document by a processor.

func (GoogleCloudDocumentaiV1DocumentSchema)MarshalJSONadded inv0.85.0

typeGoogleCloudDocumentaiV1DocumentSchemaEntityTypeadded inv0.85.0

type GoogleCloudDocumentaiV1DocumentSchemaEntityType struct {// BaseTypes: The entity type that this type is derived from. For now, one and// only one should be set.BaseTypes []string `json:"baseTypes,omitempty"`// DisplayName: User defined name for the type.DisplayNamestring `json:"displayName,omitempty"`// EnumValues: If specified, lists all the possible values for this entity.// This should not be more than a handful of values. If the number of values is// >10 or could change frequently use the `EntityType.value_ontology` field and// specify a list of all possible values in a value ontology file.EnumValues *GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues `json:"enumValues,omitempty"`// Name: Name of the type. It must be unique within the schema file and cannot// be a "Common Type". The following naming conventions are used: - Use// `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters.// - Must start with a letter. - Allowed characters: ASCII letters// `[a-z0-9_-]`. (For backward compatibility internal infrastructure and// tooling can handle any ascii character.) - The `/` is sometimes used to// denote a property of a type. For example `line_item/amount`. This convention// is deprecated, but will still be honored for backward compatibility.Namestring `json:"name,omitempty"`// Properties: Description the nested structure, or composition of an entity.Properties []*GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty `json:"properties,omitempty"`// ForceSendFields is a list of field names (e.g. "BaseTypes") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BaseTypes") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentSchemaEntityType: EntityType is the wrapperof a label of the corresponding model with detailed attributes andlimitations for entity-based processors. Multiple types can also compose adependency tree to represent nested types.

func (GoogleCloudDocumentaiV1DocumentSchemaEntityType)MarshalJSONadded inv0.85.0

typeGoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValuesadded inv0.85.0

type GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues struct {// Values: The individual values that this enum values type can include.Values []string `json:"values,omitempty"`// ForceSendFields is a list of field names (e.g. "Values") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Values") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues: Defines the alist of enum values.

func (GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues)MarshalJSONadded inv0.85.0

typeGoogleCloudDocumentaiV1DocumentSchemaEntityTypePropertyadded inv0.85.0

type GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty struct {// DisplayName: User defined name for the property.DisplayNamestring `json:"displayName,omitempty"`// Method: Specifies how the entity's value is obtained.//// Possible values://   "METHOD_UNSPECIFIED" - Unspecified method. It defaults to `EXTRACT`.//   "EXTRACT" - The entity's value is directly extracted as-is from the// document text.//   "DERIVE" - The entity's value is derived through inference and is not// necessarily an exact text extraction from the document.Methodstring `json:"method,omitempty"`// Name: The name of the property. Follows the same guidelines as the// EntityType name.Namestring `json:"name,omitempty"`// OccurrenceType: Occurrence type limits the number of instances an entity// type appears in the document.//// Possible values://   "OCCURRENCE_TYPE_UNSPECIFIED" - Unspecified occurrence type.//   "OPTIONAL_ONCE" - There will be zero or one instance of this entity type.// The same entity instance may be mentioned multiple times.//   "OPTIONAL_MULTIPLE" - The entity type will appear zero or multiple times.//   "REQUIRED_ONCE" - The entity type will only appear exactly once. The same// entity instance may be mentioned multiple times.//   "REQUIRED_MULTIPLE" - The entity type will appear once or more times.OccurrenceTypestring `json:"occurrenceType,omitempty"`// ValueType: A reference to the value type of the property. This type is// subject to the same conventions as the `Entity.base_types` field.ValueTypestring `json:"valueType,omitempty"`// ForceSendFields is a list of field names (e.g. "DisplayName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DisplayName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty: Defines propertiesthat can be part of the entity type.

func (GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty)MarshalJSONadded inv0.85.0

typeGoogleCloudDocumentaiV1DocumentSchemaMetadataadded inv0.85.0

type GoogleCloudDocumentaiV1DocumentSchemaMetadata struct {// DocumentAllowMultipleLabels: If true, on a given page, there can be multiple// `document` annotations covering it.DocumentAllowMultipleLabelsbool `json:"documentAllowMultipleLabels,omitempty"`// DocumentSplitter: If true, a `document` entity type can be applied to// subdocument (splitting). Otherwise, it can only be applied to the entire// document (classification).DocumentSplitterbool `json:"documentSplitter,omitempty"`// PrefixedNamingOnProperties: If set, all the nested entities must be prefixed// with the parents.PrefixedNamingOnPropertiesbool `json:"prefixedNamingOnProperties,omitempty"`// SkipNamingValidation: If set, we will skip the naming format validation in// the schema. So the string values in `DocumentSchema.EntityType.name` and// `DocumentSchema.EntityType.Property.name` will not be checked.SkipNamingValidationbool `json:"skipNamingValidation,omitempty"`// ForceSendFields is a list of field names (e.g.// "DocumentAllowMultipleLabels") to unconditionally include in API requests.// By default, fields with empty or default values are omitted from API// requests. Seehttps://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields// for more details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DocumentAllowMultipleLabels") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentSchemaMetadata: Metadata for global schemabehavior.

func (GoogleCloudDocumentaiV1DocumentSchemaMetadata)MarshalJSONadded inv0.85.0

typeGoogleCloudDocumentaiV1DocumentShardInfo

type GoogleCloudDocumentaiV1DocumentShardInfo struct {// ShardCount: Total number of shards.ShardCountint64 `json:"shardCount,omitempty,string"`// ShardIndex: The 0-based index of this shard.ShardIndexint64 `json:"shardIndex,omitempty,string"`// TextOffset: The index of the first character in Document.text in the overall// document global text.TextOffsetint64 `json:"textOffset,omitempty,string"`// ForceSendFields is a list of field names (e.g. "ShardCount") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ShardCount") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentShardInfo: For a large document, sharding maybe performed to produce several document shards. Each document shardcontains this field to detail which shard it is.

func (GoogleCloudDocumentaiV1DocumentShardInfo)MarshalJSON

typeGoogleCloudDocumentaiV1DocumentStyle

type GoogleCloudDocumentaiV1DocumentStyle struct {// BackgroundColor: Text background color.BackgroundColor *GoogleTypeColor `json:"backgroundColor,omitempty"`// Color: Text color.Color *GoogleTypeColor `json:"color,omitempty"`// FontFamily: Font family such as `Arial`, `Times New Roman`.//https://www.w3schools.com/cssref/pr_font_font-family.aspFontFamilystring `json:"fontFamily,omitempty"`// FontSize: Font size.FontSize *GoogleCloudDocumentaiV1DocumentStyleFontSize `json:"fontSize,omitempty"`// FontWeight: Font weight// (https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are// `normal`, `bold`, `bolder`, and `lighter`.FontWeightstring `json:"fontWeight,omitempty"`// TextAnchor: Text anchor indexing into the Document.text.TextAnchor *GoogleCloudDocumentaiV1DocumentTextAnchor `json:"textAnchor,omitempty"`// TextDecoration: Text decoration// (https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS// standard.TextDecorationstring `json:"textDecoration,omitempty"`// TextStyle: Text style// (https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values// are `normal`, `italic`, and `oblique`.TextStylestring `json:"textStyle,omitempty"`// ForceSendFields is a list of field names (e.g. "BackgroundColor") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BackgroundColor") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentStyle: Annotation for common text styleattributes. This adheres to CSS conventions as much as possible.

func (GoogleCloudDocumentaiV1DocumentStyle)MarshalJSON

typeGoogleCloudDocumentaiV1DocumentStyleFontSize

type GoogleCloudDocumentaiV1DocumentStyleFontSize struct {// Size: Font size for the text.Sizefloat64 `json:"size,omitempty"`// Unit: Unit for the font size. Follows CSS naming (such as `in`, `px`, and// `pt`).Unitstring `json:"unit,omitempty"`// ForceSendFields is a list of field names (e.g. "Size") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Size") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentStyleFontSize: Font size with unit.

func (GoogleCloudDocumentaiV1DocumentStyleFontSize)MarshalJSON

func (*GoogleCloudDocumentaiV1DocumentStyleFontSize)UnmarshalJSON

typeGoogleCloudDocumentaiV1DocumentTextAnchor

type GoogleCloudDocumentaiV1DocumentTextAnchor struct {// Content: Contains the content of the text span so that users do not have to// look it up in the text_segments. It is always populated for formFields.Contentstring `json:"content,omitempty"`// TextSegments: The text segments from the Document.text.TextSegments []*GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment `json:"textSegments,omitempty"`// ForceSendFields is a list of field names (e.g. "Content") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Content") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentTextAnchor: Text reference indexing into theDocument.text.

func (GoogleCloudDocumentaiV1DocumentTextAnchor)MarshalJSON

typeGoogleCloudDocumentaiV1DocumentTextAnchorTextSegment

type GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment struct {// EndIndex: TextSegment half open end UTF-8 char index in the Document.text.EndIndexint64 `json:"endIndex,omitempty,string"`// StartIndex: TextSegment start UTF-8 char index in the Document.text.StartIndexint64 `json:"startIndex,omitempty,string"`// ForceSendFields is a list of field names (e.g. "EndIndex") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "EndIndex") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment: A text segment in theDocument.text. The indices may be out of bounds which indicate that the textextends into another document shard for large sharded documents. SeeShardInfo.text_offset

func (GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment)MarshalJSON

typeGoogleCloudDocumentaiV1DocumentTextChange

type GoogleCloudDocumentaiV1DocumentTextChange struct {// ChangedText: The text that replaces the text identified in the// `text_anchor`.ChangedTextstring `json:"changedText,omitempty"`// Provenance: The history of this annotation.Provenance []*GoogleCloudDocumentaiV1DocumentProvenance `json:"provenance,omitempty"`// TextAnchor: Provenance of the correction. Text anchor indexing into the// 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 *GoogleCloudDocumentaiV1DocumentTextAnchor `json:"textAnchor,omitempty"`// ForceSendFields is a list of field names (e.g. "ChangedText") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ChangedText") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1DocumentTextChange: This message is used for textchanges aka. OCR corrections.

func (GoogleCloudDocumentaiV1DocumentTextChange)MarshalJSON

typeGoogleCloudDocumentaiV1Documentsadded inv0.255.0

type GoogleCloudDocumentaiV1Documents struct {// Documents: The list of documents.Documents []*GoogleCloudDocumentaiV1Document `json:"documents,omitempty"`// ForceSendFields is a list of field names (e.g. "Documents") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Documents") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1Documents: A set of inline documents.

func (GoogleCloudDocumentaiV1Documents)MarshalJSONadded inv0.255.0

func (sGoogleCloudDocumentaiV1Documents) MarshalJSON() ([]byte,error)

typeGoogleCloudDocumentaiV1EnableProcessorMetadataadded inv0.57.0

type GoogleCloudDocumentaiV1EnableProcessorMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1EnableProcessorMetadata: The long-running operationmetadata for the EnableProcessor method.

func (GoogleCloudDocumentaiV1EnableProcessorMetadata)MarshalJSONadded inv0.57.0

typeGoogleCloudDocumentaiV1EnableProcessorRequestadded inv0.57.0

type GoogleCloudDocumentaiV1EnableProcessorRequest struct {}

GoogleCloudDocumentaiV1EnableProcessorRequest: Request message for theEnableProcessor method.

typeGoogleCloudDocumentaiV1EnableProcessorResponseadded inv0.57.0

type GoogleCloudDocumentaiV1EnableProcessorResponse struct {}

GoogleCloudDocumentaiV1EnableProcessorResponse: Response message for theEnableProcessor method. Intentionally empty proto for adding fields infuture.

typeGoogleCloudDocumentaiV1EvaluateProcessorVersionMetadataadded inv0.110.0

type GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata: Metadata of theEvaluateProcessorVersion method.

func (GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata)MarshalJSONadded inv0.110.0

typeGoogleCloudDocumentaiV1EvaluateProcessorVersionRequestadded inv0.108.0

type GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest struct {// EvaluationDocuments: Optional. The documents used in the evaluation. If// unspecified, use the processor's dataset as evaluation input.EvaluationDocuments *GoogleCloudDocumentaiV1BatchDocumentsInputConfig `json:"evaluationDocuments,omitempty"`// ForceSendFields is a list of field names (e.g. "EvaluationDocuments") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "EvaluationDocuments") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest: Evaluates the givenProcessorVersion against the supplied documents.

func (GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest)MarshalJSONadded inv0.108.0

typeGoogleCloudDocumentaiV1EvaluateProcessorVersionResponseadded inv0.110.0

type GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse struct {// Evaluation: The resource name of the created evaluation.Evaluationstring `json:"evaluation,omitempty"`// ForceSendFields is a list of field names (e.g. "Evaluation") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Evaluation") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse: Response of theEvaluateProcessorVersion method.

func (GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse)MarshalJSONadded inv0.110.0

typeGoogleCloudDocumentaiV1Evaluationadded inv0.108.0

type GoogleCloudDocumentaiV1Evaluation struct {// AllEntitiesMetrics: Metrics for all the entities in aggregate.AllEntitiesMetrics *GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics `json:"allEntitiesMetrics,omitempty"`// CreateTime: The time that the evaluation was created.CreateTimestring `json:"createTime,omitempty"`// DocumentCounters: Counters for the documents used in the evaluation.DocumentCounters *GoogleCloudDocumentaiV1EvaluationCounters `json:"documentCounters,omitempty"`// EntityMetrics: Metrics across confidence levels, for different entities.EntityMetrics map[string]GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics `json:"entityMetrics,omitempty"`// KmsKeyName: The KMS key name used for encryption.KmsKeyNamestring `json:"kmsKeyName,omitempty"`// KmsKeyVersionName: The KMS key version with which data is encrypted.KmsKeyVersionNamestring `json:"kmsKeyVersionName,omitempty"`// Name: The resource name of the evaluation. Format:// `projects/{project}/locations/{location}/processors/{processor}/processorVers// ions/{processor_version}/evaluations/{evaluation}`Namestring `json:"name,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AllEntitiesMetrics") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AllEntitiesMetrics") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1Evaluation: An evaluation of a ProcessorVersion'sperformance.

func (GoogleCloudDocumentaiV1Evaluation)MarshalJSONadded inv0.108.0

func (sGoogleCloudDocumentaiV1Evaluation) MarshalJSON() ([]byte,error)

typeGoogleCloudDocumentaiV1EvaluationConfidenceLevelMetricsadded inv0.108.0

type GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics struct {// ConfidenceLevel: The confidence level.ConfidenceLevelfloat64 `json:"confidenceLevel,omitempty"`// Metrics: The metrics at the specific confidence level.Metrics *GoogleCloudDocumentaiV1EvaluationMetrics `json:"metrics,omitempty"`// ForceSendFields is a list of field names (e.g. "ConfidenceLevel") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ConfidenceLevel") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics: Evaluationsmetrics, at a specific confidence level.

func (GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics)MarshalJSONadded inv0.108.0

func (*GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics)UnmarshalJSONadded inv0.108.0

typeGoogleCloudDocumentaiV1EvaluationCountersadded inv0.108.0

type GoogleCloudDocumentaiV1EvaluationCounters struct {// EvaluatedDocumentsCount: How many documents were used in the evaluation.EvaluatedDocumentsCountint64 `json:"evaluatedDocumentsCount,omitempty"`// FailedDocumentsCount: How many documents were not included in the evaluation// as Document AI failed to process them.FailedDocumentsCountint64 `json:"failedDocumentsCount,omitempty"`// InputDocumentsCount: How many documents were sent for evaluation.InputDocumentsCountint64 `json:"inputDocumentsCount,omitempty"`// InvalidDocumentsCount: How many documents were not included in the// evaluation as they didn't pass validation.InvalidDocumentsCountint64 `json:"invalidDocumentsCount,omitempty"`// ForceSendFields is a list of field names (e.g. "EvaluatedDocumentsCount") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "EvaluatedDocumentsCount") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1EvaluationCounters: Evaluation counters for thedocuments that were used.

func (GoogleCloudDocumentaiV1EvaluationCounters)MarshalJSONadded inv0.108.0

typeGoogleCloudDocumentaiV1EvaluationMetricsadded inv0.57.0

type GoogleCloudDocumentaiV1EvaluationMetrics struct {// F1Score: The calculated f1 score.F1Scorefloat64 `json:"f1Score,omitempty"`// FalseNegativesCount: The amount of false negatives.FalseNegativesCountint64 `json:"falseNegativesCount,omitempty"`// FalsePositivesCount: The amount of false positives.FalsePositivesCountint64 `json:"falsePositivesCount,omitempty"`// GroundTruthDocumentCount: The amount of documents with a ground truth// occurrence.GroundTruthDocumentCountint64 `json:"groundTruthDocumentCount,omitempty"`// GroundTruthOccurrencesCount: The amount of occurrences in ground truth// documents.GroundTruthOccurrencesCountint64 `json:"groundTruthOccurrencesCount,omitempty"`// Precision: The calculated precision.Precisionfloat64 `json:"precision,omitempty"`// PredictedDocumentCount: The amount of documents with a predicted occurrence.PredictedDocumentCountint64 `json:"predictedDocumentCount,omitempty"`// PredictedOccurrencesCount: The amount of occurrences in predicted documents.PredictedOccurrencesCountint64 `json:"predictedOccurrencesCount,omitempty"`// Recall: The calculated recall.Recallfloat64 `json:"recall,omitempty"`// TotalDocumentsCount: The amount of documents that had an occurrence of this// label.TotalDocumentsCountint64 `json:"totalDocumentsCount,omitempty"`// TruePositivesCount: The amount of true positives.TruePositivesCountint64 `json:"truePositivesCount,omitempty"`// ForceSendFields is a list of field names (e.g. "F1Score") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "F1Score") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1EvaluationMetrics: Evaluation metrics, either inaggregate or about a specific entity.

func (GoogleCloudDocumentaiV1EvaluationMetrics)MarshalJSONadded inv0.57.0

func (*GoogleCloudDocumentaiV1EvaluationMetrics)UnmarshalJSONadded inv0.57.0

func (s *GoogleCloudDocumentaiV1EvaluationMetrics) UnmarshalJSON(data []byte)error

typeGoogleCloudDocumentaiV1EvaluationMultiConfidenceMetricsadded inv0.108.0

type GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics struct {// Auprc: The calculated area under the precision recall curve (AUPRC),// computed by integrating over all confidence thresholds.Auprcfloat64 `json:"auprc,omitempty"`// AuprcExact: The AUPRC for metrics with fuzzy matching disabled, i.e., exact// matching only.AuprcExactfloat64 `json:"auprcExact,omitempty"`// ConfidenceLevelMetrics: Metrics across confidence levels with fuzzy matching// enabled.ConfidenceLevelMetrics []*GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics `json:"confidenceLevelMetrics,omitempty"`// ConfidenceLevelMetricsExact: Metrics across confidence levels with only// exact matching.ConfidenceLevelMetricsExact []*GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics `json:"confidenceLevelMetricsExact,omitempty"`// EstimatedCalibrationError: The Estimated Calibration Error (ECE) of the// confidence of the predicted entities.EstimatedCalibrationErrorfloat64 `json:"estimatedCalibrationError,omitempty"`// EstimatedCalibrationErrorExact: The ECE for the predicted entities with// fuzzy matching disabled, i.e., exact matching only.EstimatedCalibrationErrorExactfloat64 `json:"estimatedCalibrationErrorExact,omitempty"`// MetricsType: The metrics type for the label.//// Possible values://   "METRICS_TYPE_UNSPECIFIED" - The metrics type is unspecified. By default,// metrics without a particular specification are for leaf entity types (i.e.,// top-level entity types without child types, or child types which are not// parent types themselves).//   "AGGREGATE" - Indicates whether metrics for this particular label type// represent an aggregate of metrics for other types instead of being based on// actual TP/FP/FN values for the label type. Metrics for parent (i.e.,// non-leaf) entity types are an aggregate of metrics for their children.MetricsTypestring `json:"metricsType,omitempty"`// ForceSendFields is a list of field names (e.g. "Auprc") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Auprc") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics: Metrics acrossmultiple confidence levels.

func (GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics)MarshalJSONadded inv0.108.0

func (*GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics)UnmarshalJSONadded inv0.108.0

typeGoogleCloudDocumentaiV1EvaluationReferenceadded inv0.57.0

type GoogleCloudDocumentaiV1EvaluationReference struct {// AggregateMetrics: An aggregate of the statistics for the evaluation with// fuzzy matching on.AggregateMetrics *GoogleCloudDocumentaiV1EvaluationMetrics `json:"aggregateMetrics,omitempty"`// AggregateMetricsExact: An aggregate of the statistics for the evaluation// with fuzzy matching off.AggregateMetricsExact *GoogleCloudDocumentaiV1EvaluationMetrics `json:"aggregateMetricsExact,omitempty"`// Evaluation: The resource name of the evaluation.Evaluationstring `json:"evaluation,omitempty"`// Operation: The resource name of the Long Running Operation for the// evaluation.Operationstring `json:"operation,omitempty"`// ForceSendFields is a list of field names (e.g. "AggregateMetrics") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AggregateMetrics") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1EvaluationReference: Gives a short summary of anevaluation, and links to the evaluation itself.

func (GoogleCloudDocumentaiV1EvaluationReference)MarshalJSONadded inv0.57.0

typeGoogleCloudDocumentaiV1FetchProcessorTypesResponseadded inv0.57.0

type GoogleCloudDocumentaiV1FetchProcessorTypesResponse struct {// ProcessorTypes: The list of processor types.ProcessorTypes []*GoogleCloudDocumentaiV1ProcessorType `json:"processorTypes,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "ProcessorTypes") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ProcessorTypes") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1FetchProcessorTypesResponse: Response message for theFetchProcessorTypes method.

func (GoogleCloudDocumentaiV1FetchProcessorTypesResponse)MarshalJSONadded inv0.57.0

typeGoogleCloudDocumentaiV1GcsDocument

type GoogleCloudDocumentaiV1GcsDocument struct {// GcsUri: The Cloud Storage object uri.GcsUristring `json:"gcsUri,omitempty"`// MimeType: An IANA MIME type (RFC6838) of the content.MimeTypestring `json:"mimeType,omitempty"`// ForceSendFields is a list of field names (e.g. "GcsUri") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GcsUri") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1GcsDocument: Specifies a document stored on CloudStorage.

func (GoogleCloudDocumentaiV1GcsDocument)MarshalJSON

typeGoogleCloudDocumentaiV1GcsDocuments

type GoogleCloudDocumentaiV1GcsDocuments struct {// Documents: The list of documents.Documents []*GoogleCloudDocumentaiV1GcsDocument `json:"documents,omitempty"`// ForceSendFields is a list of field names (e.g. "Documents") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Documents") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1GcsDocuments: Specifies a set of documents on CloudStorage.

func (GoogleCloudDocumentaiV1GcsDocuments)MarshalJSON

typeGoogleCloudDocumentaiV1GcsPrefix

type GoogleCloudDocumentaiV1GcsPrefix struct {// GcsUriPrefix: The URI prefix.GcsUriPrefixstring `json:"gcsUriPrefix,omitempty"`// ForceSendFields is a list of field names (e.g. "GcsUriPrefix") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GcsUriPrefix") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1GcsPrefix: Specifies all documents on Cloud Storagewith a common prefix.

func (GoogleCloudDocumentaiV1GcsPrefix)MarshalJSON

func (sGoogleCloudDocumentaiV1GcsPrefix) MarshalJSON() ([]byte,error)

typeGoogleCloudDocumentaiV1GenerateSchemaVersionRequestadded inv0.255.0

type GoogleCloudDocumentaiV1GenerateSchemaVersionRequest struct {// BaseSchemaVersion: The base schema version name to use for the schema// generation. Format:// `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{sch// ema_version}`BaseSchemaVersionstring `json:"baseSchemaVersion,omitempty"`// GcsDocuments: The set of documents placed on Cloud Storage.GcsDocuments *GoogleCloudDocumentaiV1GcsDocuments `json:"gcsDocuments,omitempty"`// GcsPrefix: The common prefix of documents placed on Cloud Storage.GcsPrefix *GoogleCloudDocumentaiV1GcsPrefix `json:"gcsPrefix,omitempty"`// GenerateSchemaVersionParams: Optional. User specified parameters for the// schema generation.GenerateSchemaVersionParams *GoogleCloudDocumentaiV1GenerateSchemaVersionRequestGenerateSchemaVersionParams `json:"generateSchemaVersionParams,omitempty"`// InlineDocuments: The set of documents specified inline.InlineDocuments *GoogleCloudDocumentaiV1Documents `json:"inlineDocuments,omitempty"`// RawDocuments: The set of raw documents.RawDocuments *GoogleCloudDocumentaiV1RawDocuments `json:"rawDocuments,omitempty"`// ForceSendFields is a list of field names (e.g. "BaseSchemaVersion") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BaseSchemaVersion") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1GenerateSchemaVersionRequest: Request message forGenerateSchemaVersion.

func (GoogleCloudDocumentaiV1GenerateSchemaVersionRequest)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiV1GenerateSchemaVersionRequestGenerateSchemaVersionParamsadded inv0.255.0

type GoogleCloudDocumentaiV1GenerateSchemaVersionRequestGenerateSchemaVersionParams struct {// History: Optional. Previous prompt-answers in a chronological order.History *GoogleCloudDocumentaiV1SchemaGenerationHistory `json:"history,omitempty"`// Prompt: Optional. The prompt used for the schema generation.Promptstring `json:"prompt,omitempty"`// ForceSendFields is a list of field names (e.g. "History") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "History") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1GenerateSchemaVersionRequestGenerateSchemaVersionParams: The parameters for the schema generation.

func (GoogleCloudDocumentaiV1GenerateSchemaVersionRequestGenerateSchemaVersionParams)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiV1GenerateSchemaVersionResponseadded inv0.255.0

type GoogleCloudDocumentaiV1GenerateSchemaVersionResponse struct {// SchemaVersion: The schema version generated by the model.SchemaVersion *GoogleCloudDocumentaiV1SchemaVersion `json:"schemaVersion,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "SchemaVersion") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "SchemaVersion") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1GenerateSchemaVersionResponse: Response message forGenerateSchemaVersion.

func (GoogleCloudDocumentaiV1GenerateSchemaVersionResponse)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiV1HumanReviewStatus

type GoogleCloudDocumentaiV1HumanReviewStatus struct {// HumanReviewOperation: The name of the operation triggered by the processed// document. This field is populated only when the state is// `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as// the long-running operation returned by ReviewDocument.HumanReviewOperationstring `json:"humanReviewOperation,omitempty"`// State: The state of human review on the processing request.//// Possible values://   "STATE_UNSPECIFIED" - Human review state is unspecified. Most likely due// to an internal error.//   "SKIPPED" - Human review is skipped for the document. This can happen// because human review isn't enabled on the processor or the processing// request has been set to skip this document.//   "VALIDATION_PASSED" - Human review validation is triggered and passed, so// no review is needed.//   "IN_PROGRESS" - Human review validation is triggered and the document is// under review.//   "ERROR" - Some error happened during triggering human review, see the// state_message for details.Statestring `json:"state,omitempty"`// StateMessage: A message providing more details about the human review state.StateMessagestring `json:"stateMessage,omitempty"`// ForceSendFields is a list of field names (e.g. "HumanReviewOperation") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "HumanReviewOperation") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1HumanReviewStatus: The status of human review on aprocessed document.

func (GoogleCloudDocumentaiV1HumanReviewStatus)MarshalJSON

typeGoogleCloudDocumentaiV1ListEvaluationsResponseadded inv0.108.0

type GoogleCloudDocumentaiV1ListEvaluationsResponse struct {// Evaluations: The evaluations requested.Evaluations []*GoogleCloudDocumentaiV1Evaluation `json:"evaluations,omitempty"`// NextPageToken: A token, which can be sent as `page_token` to retrieve the// next page. If this field is omitted, there are no subsequent pages.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Evaluations") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Evaluations") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1ListEvaluationsResponse: The response from`ListEvaluations`.

func (GoogleCloudDocumentaiV1ListEvaluationsResponse)MarshalJSONadded inv0.108.0

typeGoogleCloudDocumentaiV1ListProcessorTypesResponseadded inv0.88.0

type GoogleCloudDocumentaiV1ListProcessorTypesResponse struct {// NextPageToken: Points to the next page, otherwise empty.NextPageTokenstring `json:"nextPageToken,omitempty"`// ProcessorTypes: The processor types.ProcessorTypes []*GoogleCloudDocumentaiV1ProcessorType `json:"processorTypes,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1ListProcessorTypesResponse: Response message for theListProcessorTypes method.

func (GoogleCloudDocumentaiV1ListProcessorTypesResponse)MarshalJSONadded inv0.88.0

typeGoogleCloudDocumentaiV1ListProcessorVersionsResponseadded inv0.57.0

type GoogleCloudDocumentaiV1ListProcessorVersionsResponse struct {// NextPageToken: Points to the next processor, otherwise empty.NextPageTokenstring `json:"nextPageToken,omitempty"`// ProcessorVersions: The list of processors.ProcessorVersions []*GoogleCloudDocumentaiV1ProcessorVersion `json:"processorVersions,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1ListProcessorVersionsResponse: Response message forthe ListProcessorVersions method.

func (GoogleCloudDocumentaiV1ListProcessorVersionsResponse)MarshalJSONadded inv0.57.0

typeGoogleCloudDocumentaiV1ListProcessorsResponseadded inv0.57.0

type GoogleCloudDocumentaiV1ListProcessorsResponse struct {// NextPageToken: Points to the next processor, otherwise empty.NextPageTokenstring `json:"nextPageToken,omitempty"`// Processors: The list of processors.Processors []*GoogleCloudDocumentaiV1Processor `json:"processors,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1ListProcessorsResponse: Response message for theListProcessors method.

func (GoogleCloudDocumentaiV1ListProcessorsResponse)MarshalJSONadded inv0.57.0

typeGoogleCloudDocumentaiV1ListSchemaVersionsResponseadded inv0.255.0

type GoogleCloudDocumentaiV1ListSchemaVersionsResponse struct {// NextPageToken: Points to the next SchemaVersion, otherwise empty.NextPageTokenstring `json:"nextPageToken,omitempty"`// SchemaVersions: The list of SchemaVersions.SchemaVersions []*GoogleCloudDocumentaiV1SchemaVersion `json:"schemaVersions,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1ListSchemaVersionsResponse: Response message forListSchemaVersions.

func (GoogleCloudDocumentaiV1ListSchemaVersionsResponse)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiV1ListSchemasResponseadded inv0.255.0

type GoogleCloudDocumentaiV1ListSchemasResponse struct {// NextPageToken: Points to the next Schema, otherwise empty.NextPageTokenstring `json:"nextPageToken,omitempty"`// Schemas: The list of Schemas.Schemas []*GoogleCloudDocumentaiV1NextSchema `json:"schemas,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1ListSchemasResponse: Response message forListSchemas.

func (GoogleCloudDocumentaiV1ListSchemasResponse)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiV1NextSchemaadded inv0.255.0

type GoogleCloudDocumentaiV1NextSchema struct {// CreateTime: Output only. The time when the Schema was created.CreateTimestring `json:"createTime,omitempty"`// DisplayName: Optional. The user-defined name of the Schema.DisplayNamestring `json:"displayName,omitempty"`// Labels: Optional. The GCP labels for the Schema.Labels map[string]string `json:"labels,omitempty"`// Name: Identifier. The resource name of the Schema. Format:// `projects/{project}/locations/{location}/schemas/{schema}`Namestring `json:"name,omitempty"`// UpdateTime: Output only. The time when the Schema was last updated.UpdateTimestring `json:"updateTime,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1NextSchema: NextSchema is a collection ofSchemaVersions.

func (GoogleCloudDocumentaiV1NextSchema)MarshalJSONadded inv0.255.0

func (sGoogleCloudDocumentaiV1NextSchema) MarshalJSON() ([]byte,error)

typeGoogleCloudDocumentaiV1NormalizedVertex

type GoogleCloudDocumentaiV1NormalizedVertex struct {// X: X coordinate.Xfloat64 `json:"x,omitempty"`// Y: Y coordinate (starts from the top of the image).Yfloat64 `json:"y,omitempty"`// ForceSendFields is a list of field names (e.g. "X") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "X") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (GoogleCloudDocumentaiV1NormalizedVertex)MarshalJSON

func (*GoogleCloudDocumentaiV1NormalizedVertex)UnmarshalJSON

func (s *GoogleCloudDocumentaiV1NormalizedVertex) UnmarshalJSON(data []byte)error

typeGoogleCloudDocumentaiV1OcrConfigadded inv0.132.0

type GoogleCloudDocumentaiV1OcrConfig struct {// AdvancedOcrOptions: A list of advanced OCR options to further fine-tune OCR// behavior. Current valid values are: - `legacy_layout`: a heuristics layout// detection algorithm, which serves as an alternative to the current ML-based// layout detection algorithm. Customers can choose the best suitable layout// algorithm based on their situation.AdvancedOcrOptions []string `json:"advancedOcrOptions,omitempty"`// ComputeStyleInfo: Turn on font identification model and return font style// information. Deprecated, use PremiumFeatures.compute_style_info instead.ComputeStyleInfobool `json:"computeStyleInfo,omitempty"`// DisableCharacterBoxesDetection: Turn off character box detector in OCR// engine. Character box detection is enabled by default in OCR 2.0 (and later)// processors.DisableCharacterBoxesDetectionbool `json:"disableCharacterBoxesDetection,omitempty"`// EnableImageQualityScores: Enables intelligent document quality scores after// OCR. Can help with diagnosing why OCR responses are of poor quality for a// given input. Adds additional latency comparable to regular OCR to the// process call.EnableImageQualityScoresbool `json:"enableImageQualityScores,omitempty"`// EnableNativePdfParsing: Enables special handling for PDFs with existing text// information. Results in better text extraction quality in such PDF inputs.EnableNativePdfParsingbool `json:"enableNativePdfParsing,omitempty"`// EnableSymbol: Includes symbol level OCR information if set to true.EnableSymbolbool `json:"enableSymbol,omitempty"`// Hints: Hints for the OCR model.Hints *GoogleCloudDocumentaiV1OcrConfigHints `json:"hints,omitempty"`// PremiumFeatures: Configurations for premium OCR features.PremiumFeatures *GoogleCloudDocumentaiV1OcrConfigPremiumFeatures `json:"premiumFeatures,omitempty"`// ForceSendFields is a list of field names (e.g. "AdvancedOcrOptions") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AdvancedOcrOptions") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1OcrConfig: Config for Document OCR.

func (GoogleCloudDocumentaiV1OcrConfig)MarshalJSONadded inv0.132.0

func (sGoogleCloudDocumentaiV1OcrConfig) MarshalJSON() ([]byte,error)

typeGoogleCloudDocumentaiV1OcrConfigHintsadded inv0.132.0

type GoogleCloudDocumentaiV1OcrConfigHints struct {// LanguageHints: List of BCP-47 language codes to use for OCR. In most cases,// not specifying it yields the best results since it enables automatic// language detection. For languages based on the Latin alphabet, setting hints// is not needed. In rare cases, when the language of the text in the image is// known, setting a hint will help get better results (although it will be a// significant hindrance if the hint is wrong).LanguageHints []string `json:"languageHints,omitempty"`// ForceSendFields is a list of field names (e.g. "LanguageHints") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "LanguageHints") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1OcrConfigHints: Hints for OCR Engine

func (GoogleCloudDocumentaiV1OcrConfigHints)MarshalJSONadded inv0.132.0

typeGoogleCloudDocumentaiV1OcrConfigPremiumFeaturesadded inv0.143.0

type GoogleCloudDocumentaiV1OcrConfigPremiumFeatures struct {// ComputeStyleInfo: Turn on font identification model and return font style// information.ComputeStyleInfobool `json:"computeStyleInfo,omitempty"`// EnableMathOcr: Turn on the model that can extract LaTeX math formulas.EnableMathOcrbool `json:"enableMathOcr,omitempty"`// EnableSelectionMarkDetection: Turn on selection mark detector in OCR engine.// Only available in OCR 2.0 (and later) processors.EnableSelectionMarkDetectionbool `json:"enableSelectionMarkDetection,omitempty"`// ForceSendFields is a list of field names (e.g. "ComputeStyleInfo") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ComputeStyleInfo") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1OcrConfigPremiumFeatures: Configurations for premiumOCR features.

func (GoogleCloudDocumentaiV1OcrConfigPremiumFeatures)MarshalJSONadded inv0.143.0

typeGoogleCloudDocumentaiV1ProcessOptionsadded inv0.132.0

type GoogleCloudDocumentaiV1ProcessOptions struct {// FromEnd: Only process certain pages from the end, same as above.FromEndint64 `json:"fromEnd,omitempty"`// FromStart: Only process certain pages from the start. Process all if the// document has fewer pages.FromStartint64 `json:"fromStart,omitempty"`// IndividualPageSelector: Which pages to process (1-indexed).IndividualPageSelector *GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector `json:"individualPageSelector,omitempty"`// LayoutConfig: Optional. Only applicable to `LAYOUT_PARSER_PROCESSOR`.// Returns error if set on other processor types.LayoutConfig *GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig `json:"layoutConfig,omitempty"`// OcrConfig: Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`.// Returns error if set on other processor types.OcrConfig *GoogleCloudDocumentaiV1OcrConfig `json:"ocrConfig,omitempty"`// SchemaOverride: Optional. Override the schema of the ProcessorVersion. Will// return an Invalid Argument error if this field is set when the underlying// ProcessorVersion doesn't support schema override.SchemaOverride *GoogleCloudDocumentaiV1DocumentSchema `json:"schemaOverride,omitempty"`// ForceSendFields is a list of field names (e.g. "FromEnd") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FromEnd") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1ProcessOptions: Options for Process API

func (GoogleCloudDocumentaiV1ProcessOptions)MarshalJSONadded inv0.132.0

typeGoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelectoradded inv0.143.0

type GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector struct {// Pages: Optional. Indices of the pages (starting from 1).Pages []int64 `json:"pages,omitempty"`// ForceSendFields is a list of field names (e.g. "Pages") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Pages") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector: A list ofindividual page numbers.

func (GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector)MarshalJSONadded inv0.143.0

typeGoogleCloudDocumentaiV1ProcessOptionsLayoutConfigadded inv0.183.0

type GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig struct {// ChunkingConfig: Optional. Config for chunking in layout parser processor.ChunkingConfig *GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig `json:"chunkingConfig,omitempty"`// EnableImageAnnotation: Optional. Whether to include image annotations in// layout parser response.EnableImageAnnotationbool `json:"enableImageAnnotation,omitempty"`// EnableTableAnnotation: Optional. Whether to include table annotations in// layout parser response.EnableTableAnnotationbool `json:"enableTableAnnotation,omitempty"`// ReturnBoundingBoxes: Optional. Whether to include bounding boxes in layout// parser processor response.ReturnBoundingBoxesbool `json:"returnBoundingBoxes,omitempty"`// ReturnImages: Optional. Whether to include images in layout parser processor// response.ReturnImagesbool `json:"returnImages,omitempty"`// ForceSendFields is a list of field names (e.g. "ChunkingConfig") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ChunkingConfig") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig: Serving config for layoutparser processor.

func (GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig)MarshalJSONadded inv0.183.0

typeGoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfigadded inv0.183.0

type GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig struct {// ChunkSize: Optional. The chunk sizes to use when splitting documents, in// order of level.ChunkSizeint64 `json:"chunkSize,omitempty"`// IncludeAncestorHeadings: Optional. Whether or not to include ancestor// headings when splitting.IncludeAncestorHeadingsbool `json:"includeAncestorHeadings,omitempty"`// ForceSendFields is a list of field names (e.g. "ChunkSize") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ChunkSize") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig: Servingconfig for chunking.

func (GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig)MarshalJSONadded inv0.183.0

typeGoogleCloudDocumentaiV1ProcessRequest

type GoogleCloudDocumentaiV1ProcessRequest struct {// FieldMask: Specifies which fields to include in the ProcessResponse.document// output. Only supports top-level document and pages field, so it must be in// the form of `{document_field_name}` or `pages.{page_field_name}`.FieldMaskstring `json:"fieldMask,omitempty"`// GcsDocument: A raw document on Google Cloud Storage.GcsDocument *GoogleCloudDocumentaiV1GcsDocument `json:"gcsDocument,omitempty"`// ImagelessMode: Optional. Option to remove images from the document.ImagelessModebool `json:"imagelessMode,omitempty"`// InlineDocument: An inline document proto.InlineDocument *GoogleCloudDocumentaiV1Document `json:"inlineDocument,omitempty"`// Labels: Optional. The labels with user-defined metadata for the request.// Label keys and values can be no longer than 63 characters (Unicode// codepoints) and can only contain lowercase letters, numeric characters,// underscores, and dashes. International characters are allowed. Label values// are optional. Label keys must start with a letter.Labels map[string]string `json:"labels,omitempty"`// ProcessOptions: Inference-time options for the process APIProcessOptions *GoogleCloudDocumentaiV1ProcessOptions `json:"processOptions,omitempty"`// RawDocument: A raw document content (bytes).RawDocument *GoogleCloudDocumentaiV1RawDocument `json:"rawDocument,omitempty"`// SkipHumanReview: Whether human review should be skipped for this request.// Default to `false`.SkipHumanReviewbool `json:"skipHumanReview,omitempty"`// ForceSendFields is a list of field names (e.g. "FieldMask") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FieldMask") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1ProcessRequest: Request message for theProcessDocument method.

func (GoogleCloudDocumentaiV1ProcessRequest)MarshalJSON

typeGoogleCloudDocumentaiV1ProcessResponse

type GoogleCloudDocumentaiV1ProcessResponse struct {// Document: The document payload, will populate fields based on the// processor's behavior.Document *GoogleCloudDocumentaiV1Document `json:"document,omitempty"`// HumanReviewStatus: The status of human review on the processed document.HumanReviewStatus *GoogleCloudDocumentaiV1HumanReviewStatus `json:"humanReviewStatus,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Document") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Document") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1ProcessResponse: Response message for theProcessDocument method.

func (GoogleCloudDocumentaiV1ProcessResponse)MarshalJSON

typeGoogleCloudDocumentaiV1Processoradded inv0.57.0

type GoogleCloudDocumentaiV1Processor struct {// ActiveSchemaVersion: Optional. SchemaVersion used by the Processor. It is// the same as Processor's DatasetSchema.schema_version Format is// `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{sch// ema_version}ActiveSchemaVersionstring `json:"activeSchemaVersion,omitempty"`// CreateTime: Output only. The time the processor was created.CreateTimestring `json:"createTime,omitempty"`// DefaultProcessorVersion: The default processor version.DefaultProcessorVersionstring `json:"defaultProcessorVersion,omitempty"`// DisplayName: The display name of the processor.DisplayNamestring `json:"displayName,omitempty"`// KmsKeyName: The KMS key (https://cloud.google.com/security-key-management)// used for encryption and decryption in CMEK scenarios.KmsKeyNamestring `json:"kmsKeyName,omitempty"`// Name: Output only. Immutable. The resource name of the processor. Format:// `projects/{project}/locations/{location}/processors/{processor}`Namestring `json:"name,omitempty"`// ProcessEndpoint: Output only. Immutable. The http endpoint that can be// called to invoke processing.ProcessEndpointstring `json:"processEndpoint,omitempty"`// ProcessorVersionAliases: Output only. The processor version aliases.ProcessorVersionAliases []*GoogleCloudDocumentaiV1ProcessorVersionAlias `json:"processorVersionAliases,omitempty"`// SatisfiesPzi: Output only. Reserved for future use.SatisfiesPzibool `json:"satisfiesPzi,omitempty"`// SatisfiesPzs: Output only. Reserved for future use.SatisfiesPzsbool `json:"satisfiesPzs,omitempty"`// State: Output only. The state of the processor.//// Possible values://   "STATE_UNSPECIFIED" - The processor is in an unspecified state.//   "ENABLED" - The processor is enabled, i.e., has an enabled version which// can currently serve processing requests and all the feature dependencies// have been successfully initialized.//   "DISABLED" - The processor is disabled.//   "ENABLING" - The processor is being enabled, will become `ENABLED` if// successful.//   "DISABLING" - The processor is being disabled, will become `DISABLED` if// successful.//   "CREATING" - The processor is being created, will become either `ENABLED`// (for successful creation) or `FAILED` (for failed ones). Once a processor is// in this state, it can then be used for document processing, but the feature// dependencies of the processor might not be fully created yet.//   "FAILED" - The processor failed during creation or initialization of// feature dependencies. The user should delete the processor and recreate one// as all the functionalities of the processor are disabled.//   "DELETING" - The processor is being deleted, will be removed if// successful.Statestring `json:"state,omitempty"`// Type: The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To// get a list of processor types, see FetchProcessorTypes.Typestring `json:"type,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "ActiveSchemaVersion") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ActiveSchemaVersion") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1Processor: The first-class citizen for Document AI.Each processor defines how to extract structural information from adocument.

func (GoogleCloudDocumentaiV1Processor)MarshalJSONadded inv0.57.0

func (sGoogleCloudDocumentaiV1Processor) MarshalJSON() ([]byte,error)

typeGoogleCloudDocumentaiV1ProcessorTypeadded inv0.57.0

type GoogleCloudDocumentaiV1ProcessorType struct {// AllowCreation: Whether the processor type allows creation. If true, users// can create a processor of this processor type. Otherwise, users need to// request access.AllowCreationbool `json:"allowCreation,omitempty"`// AvailableLocations: The locations in which this processor is available.AvailableLocations []*GoogleCloudDocumentaiV1ProcessorTypeLocationInfo `json:"availableLocations,omitempty"`// Category: The processor category, used by UI to group processor types.Categorystring `json:"category,omitempty"`// LaunchStage: Launch stage of the processor type//// Possible values://   "LAUNCH_STAGE_UNSPECIFIED" - Do not use this default value.//   "UNIMPLEMENTED" - The feature is not yet implemented. Users can not use// it.//   "PRELAUNCH" - Prelaunch features are hidden from users and are only// visible internally.//   "EARLY_ACCESS" - Early Access features are limited to a closed group of// testers. To use these features, you must sign up in advance and sign a// Trusted Tester agreement (which includes confidentiality provisions). These// features may be unstable, changed in backward-incompatible ways, and are not// guaranteed to be released.//   "ALPHA" - Alpha is a limited availability test for releases before they// are cleared for widespread use. By Alpha, all significant design issues are// resolved and we are in the process of verifying functionality. Alpha// customers need to apply for access, agree to applicable terms, and have// their projects allowlisted. Alpha releases don't have to be feature// complete, no SLAs are provided, and there are no technical support// obligations, but they will be far enough along that customers can actually// use them in test environments or for limited-use tests -- just like they// would in normal production cases.//   "BETA" - Beta is the point at which we are ready to open a release for any// customer to use. There are no SLA or technical support obligations in a Beta// release. Products will be complete from a feature perspective, but may have// some open outstanding issues. Beta releases are suitable for limited// production use cases.//   "GA" - GA features are open to all developers and are considered stable// and fully qualified for production use.//   "DEPRECATED" - Deprecated features are scheduled to be shut down and// removed. For more information, see the "Deprecation Policy" section of our// [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud// Platform Subject to the Deprecation// Policy](https://cloud.google.com/terms/deprecation) documentation.LaunchStagestring `json:"launchStage,omitempty"`// Name: The resource name of the processor type. Format:// `projects/{project}/processorTypes/{processor_type}`Namestring `json:"name,omitempty"`// SampleDocumentUris: A set of Cloud Storage URIs of sample documents for this// processor.SampleDocumentUris []string `json:"sampleDocumentUris,omitempty"`// Type: The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.Typestring `json:"type,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AllowCreation") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AllowCreation") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1ProcessorType: A processor type is responsible forperforming a certain document understanding task on a certain type ofdocument.

func (GoogleCloudDocumentaiV1ProcessorType)MarshalJSONadded inv0.57.0

typeGoogleCloudDocumentaiV1ProcessorTypeLocationInfoadded inv0.57.0

type GoogleCloudDocumentaiV1ProcessorTypeLocationInfo struct {// LocationId: The location ID. For supported locations, refer to regional and// multi-regional support (/document-ai/docs/regions).LocationIdstring `json:"locationId,omitempty"`// ForceSendFields is a list of field names (e.g. "LocationId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "LocationId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1ProcessorTypeLocationInfo: The location informationabout where the processor is available.

func (GoogleCloudDocumentaiV1ProcessorTypeLocationInfo)MarshalJSONadded inv0.57.0

typeGoogleCloudDocumentaiV1ProcessorVersionadded inv0.57.0

type GoogleCloudDocumentaiV1ProcessorVersion struct {// CreateTime: Output only. The time the processor version was created.CreateTimestring `json:"createTime,omitempty"`// DeprecationInfo: Output only. If set, information about the eventual// deprecation of this version.DeprecationInfo *GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo `json:"deprecationInfo,omitempty"`// DisplayName: The display name of the processor version.DisplayNamestring `json:"displayName,omitempty"`// DocumentSchema: Output only. The schema of the processor version. Describes// the output.DocumentSchema *GoogleCloudDocumentaiV1DocumentSchema `json:"documentSchema,omitempty"`// GenAiModelInfo: Output only. Information about Generative AI model-based// processor versions.GenAiModelInfo *GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo `json:"genAiModelInfo,omitempty"`// GoogleManaged: Output only. Denotes that this `ProcessorVersion` is managed// by Google.GoogleManagedbool `json:"googleManaged,omitempty"`// KmsKeyName: Output only. The KMS key name used for encryption.KmsKeyNamestring `json:"kmsKeyName,omitempty"`// KmsKeyVersionName: Output only. The KMS key version with which data is// encrypted.KmsKeyVersionNamestring `json:"kmsKeyVersionName,omitempty"`// LatestEvaluation: Output only. The most recently invoked evaluation for the// processor version.LatestEvaluation *GoogleCloudDocumentaiV1EvaluationReference `json:"latestEvaluation,omitempty"`// ModelType: Output only. The model type of this processor version.//// Possible values://   "MODEL_TYPE_UNSPECIFIED" - The processor version has unspecified model// type.//   "MODEL_TYPE_GENERATIVE" - The processor version has generative model type.//   "MODEL_TYPE_CUSTOM" - The processor version has custom model type.ModelTypestring `json:"modelType,omitempty"`// Name: Identifier. The resource name of the processor version. Format:// `projects/{project}/locations/{location}/processors/{processor}/processorVers// ions/{processor_version}`Namestring `json:"name,omitempty"`// SatisfiesPzi: Output only. Reserved for future use.SatisfiesPzibool `json:"satisfiesPzi,omitempty"`// SatisfiesPzs: Output only. Reserved for future use.SatisfiesPzsbool `json:"satisfiesPzs,omitempty"`// State: Output only. The state of the processor version.//// Possible values://   "STATE_UNSPECIFIED" - The processor version is in an unspecified state.//   "DEPLOYED" - The processor version is deployed and can be used for// processing.//   "DEPLOYING" - The processor version is being deployed.//   "UNDEPLOYED" - The processor version is not deployed and cannot be used// for processing.//   "UNDEPLOYING" - The processor version is being undeployed.//   "CREATING" - The processor version is being created.//   "DELETING" - The processor version is being deleted.//   "FAILED" - The processor version failed and is in an indeterminate state.//   "IMPORTING" - The processor version is being imported.Statestring `json:"state,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1ProcessorVersion: A processor version is animplementation of a processor. Each processor can have multiple versions,pretrained by Google internally or uptrained by the customer. A processorcan only have one default version at a time. Its document-processingbehavior is defined by that version.

func (GoogleCloudDocumentaiV1ProcessorVersion)MarshalJSONadded inv0.57.0

typeGoogleCloudDocumentaiV1ProcessorVersionAliasadded inv0.134.0

type GoogleCloudDocumentaiV1ProcessorVersionAlias struct {// Alias: The alias in the form of `processor_version` resource name.Aliasstring `json:"alias,omitempty"`// ProcessorVersion: The resource name of aliased processor version.ProcessorVersionstring `json:"processorVersion,omitempty"`// ForceSendFields is a list of field names (e.g. "Alias") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Alias") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1ProcessorVersionAlias: Contains the alias and thealiased resource name of processor version.

func (GoogleCloudDocumentaiV1ProcessorVersionAlias)MarshalJSONadded inv0.134.0

typeGoogleCloudDocumentaiV1ProcessorVersionDeprecationInfoadded inv0.75.0

type GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo struct {// DeprecationTime: The time at which this processor version will be// deprecated.DeprecationTimestring `json:"deprecationTime,omitempty"`// ReplacementProcessorVersion: If set, the processor version that will be used// as a replacement.ReplacementProcessorVersionstring `json:"replacementProcessorVersion,omitempty"`// ForceSendFields is a list of field names (e.g. "DeprecationTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DeprecationTime") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo: Information aboutthe upcoming deprecation of this processor version.

func (GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo)MarshalJSONadded inv0.75.0

typeGoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoadded inv0.190.0

type GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo struct {// CustomGenAiModelInfo: Information for a custom Generative AI model created// by the user.CustomGenAiModelInfo *GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo `json:"customGenAiModelInfo,omitempty"`// FoundationGenAiModelInfo: Information for a pretrained Google-managed// foundation model.FoundationGenAiModelInfo *GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo `json:"foundationGenAiModelInfo,omitempty"`// ForceSendFields is a list of field names (e.g. "CustomGenAiModelInfo") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CustomGenAiModelInfo") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo: Information aboutGenerative AI model-based processor versions.

func (GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo)MarshalJSONadded inv0.190.0

typeGoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfoadded inv0.190.0

type GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo struct {// BaseProcessorVersionId: The base processor version ID for the custom model.BaseProcessorVersionIdstring `json:"baseProcessorVersionId,omitempty"`// CustomModelType: The type of custom model created by the user.//// Possible values://   "CUSTOM_MODEL_TYPE_UNSPECIFIED" - The model type is unspecified.//   "VERSIONED_FOUNDATION" - The model is a versioned foundation model.//   "FINE_TUNED" - The model is a finetuned foundation model.CustomModelTypestring `json:"customModelType,omitempty"`// ForceSendFields is a list of field names (e.g. "BaseProcessorVersionId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BaseProcessorVersionId") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo:Information for a custom Generative AI model created by the user. These arecreated with `Create New Version` in either the `Call foundation model` or`Fine tuning` tabs.

func (GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo)MarshalJSONadded inv0.190.0

typeGoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfoadded inv0.190.0

type GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo struct {// FinetuningAllowed: Whether finetuning is allowed for this base processor// version.FinetuningAllowedbool `json:"finetuningAllowed,omitempty"`// MinTrainLabeledDocuments: The minimum number of labeled documents in the// training dataset required for finetuning.MinTrainLabeledDocumentsint64 `json:"minTrainLabeledDocuments,omitempty"`// ForceSendFields is a list of field names (e.g. "FinetuningAllowed") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FinetuningAllowed") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo: Information for a pretrained Google-managed foundation model.

func (GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo)MarshalJSONadded inv0.190.0

typeGoogleCloudDocumentaiV1RawDocument

type GoogleCloudDocumentaiV1RawDocument struct {// Content: Inline document content.Contentstring `json:"content,omitempty"`// DisplayName: The display name of the document, it supports all Unicode// characters except the following: `*`, `?`, `[`, `]`, `%`, `{`, `}`,`'`,// `\", `,` `~`, `=` and `:` are reserved. If not specified, a default ID is// generated.DisplayNamestring `json:"displayName,omitempty"`// MimeType: An IANA MIME type (RFC6838) indicating the nature and format of// the content.MimeTypestring `json:"mimeType,omitempty"`// ForceSendFields is a list of field names (e.g. "Content") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Content") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1RawDocument: Payload message of raw document content(bytes).

func (GoogleCloudDocumentaiV1RawDocument)MarshalJSON

typeGoogleCloudDocumentaiV1RawDocumentsadded inv0.133.0

type GoogleCloudDocumentaiV1RawDocuments struct {// Documents: Specifies raw document content and mime type.Documents []*GoogleCloudDocumentaiV1RawDocument `json:"documents,omitempty"`// ForceSendFields is a list of field names (e.g. "Documents") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Documents") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1RawDocuments: Specifies a set of raw documents.

func (GoogleCloudDocumentaiV1RawDocuments)MarshalJSONadded inv0.133.0

typeGoogleCloudDocumentaiV1ReviewDocumentOperationMetadata

type GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"`// QuestionId: The Crowd Compute question ID.QuestionIdstring `json:"questionId,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata: The long-runningoperation metadata for the ReviewDocument method.

func (GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata)MarshalJSON

typeGoogleCloudDocumentaiV1ReviewDocumentRequest

type GoogleCloudDocumentaiV1ReviewDocumentRequest struct {// DocumentSchema: The document schema of the human review task.DocumentSchema *GoogleCloudDocumentaiV1DocumentSchema `json:"documentSchema,omitempty"`// EnableSchemaValidation: Whether the validation should be performed on the// ad-hoc review request.EnableSchemaValidationbool `json:"enableSchemaValidation,omitempty"`// InlineDocument: An inline document proto.InlineDocument *GoogleCloudDocumentaiV1Document `json:"inlineDocument,omitempty"`// Priority: The priority of the human review task.//// Possible values://   "DEFAULT" - The default priority level.//   "URGENT" - The urgent priority level. The labeling manager should allocate// labeler resource to the urgent task queue to respect this priority level.Prioritystring `json:"priority,omitempty"`// ForceSendFields is a list of field names (e.g. "DocumentSchema") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DocumentSchema") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1ReviewDocumentRequest: Request message for theReviewDocument method.

func (GoogleCloudDocumentaiV1ReviewDocumentRequest)MarshalJSON

typeGoogleCloudDocumentaiV1ReviewDocumentResponse

type GoogleCloudDocumentaiV1ReviewDocumentResponse struct {// GcsDestination: The Cloud Storage uri for the human reviewed document if the// review is succeeded.GcsDestinationstring `json:"gcsDestination,omitempty"`// RejectionReason: The reason why the review is rejected by reviewer.RejectionReasonstring `json:"rejectionReason,omitempty"`// State: The state of the review operation.//// Possible values://   "STATE_UNSPECIFIED" - The default value. This value is used if the state// is omitted.//   "REJECTED" - The review operation is rejected by the reviewer.//   "SUCCEEDED" - The review operation is succeeded.Statestring `json:"state,omitempty"`// ForceSendFields is a list of field names (e.g. "GcsDestination") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GcsDestination") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1ReviewDocumentResponse: Response message for theReviewDocument method.

func (GoogleCloudDocumentaiV1ReviewDocumentResponse)MarshalJSON

typeGoogleCloudDocumentaiV1SchemaGenerationHistoryadded inv0.255.0

type GoogleCloudDocumentaiV1SchemaGenerationHistory struct {// Iterations: Required. Previous prompt-answers in a chronological order.Iterations []*GoogleCloudDocumentaiV1SchemaGenerationIteration `json:"iterations,omitempty"`// ForceSendFields is a list of field names (e.g. "Iterations") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Iterations") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1SchemaGenerationHistory: The history of schemageneration iterations.

func (GoogleCloudDocumentaiV1SchemaGenerationHistory)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiV1SchemaGenerationIterationadded inv0.255.0

type GoogleCloudDocumentaiV1SchemaGenerationIteration struct {// AdjustedSchema: Optional. The previous schema version adjusted by the model.AdjustedSchema *GoogleCloudDocumentaiV1SchemaVersion `json:"adjustedSchema,omitempty"`// GeneratedSchema: Required. The schema version generated by the model.GeneratedSchema *GoogleCloudDocumentaiV1SchemaVersion `json:"generatedSchema,omitempty"`// Prompt: Optional. The prompt used for the iteration.Promptstring `json:"prompt,omitempty"`// ForceSendFields is a list of field names (e.g. "AdjustedSchema") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AdjustedSchema") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1SchemaGenerationIteration: A single iteration of theschema generation.

func (GoogleCloudDocumentaiV1SchemaGenerationIteration)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiV1SchemaVersionadded inv0.255.0

type GoogleCloudDocumentaiV1SchemaVersion struct {// CreateTime: Output only. The time when the SchemaVersion was created.CreateTimestring `json:"createTime,omitempty"`// DisplayName: Optional. The user-defined name of the SchemaVersion.DisplayNamestring `json:"displayName,omitempty"`// Labels: Optional. The GCP labels for the SchemaVersion.Labels map[string]string `json:"labels,omitempty"`// Name: Identifier. The resource name of the SchemaVersion. Format:// `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{sch// ema_version}`Namestring `json:"name,omitempty"`// Schema: Required. The schema of the SchemaVersion.Schema *GoogleCloudDocumentaiV1DocumentSchema `json:"schema,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1SchemaVersion: SchemaVersion is a version of theSchema which is created in SchemaGroup.

func (GoogleCloudDocumentaiV1SchemaVersion)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadataadded inv0.57.0

type GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata: The long-runningoperation metadata for the SetDefaultProcessorVersion method.

func (GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata)MarshalJSONadded inv0.57.0

typeGoogleCloudDocumentaiV1SetDefaultProcessorVersionRequestadded inv0.57.0

type GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest struct {// DefaultProcessorVersion: Required. The resource name of child// ProcessorVersion to use as default. Format:// `projects/{project}/locations/{location}/processors/{processor}/processorVers// ions/{version}`DefaultProcessorVersionstring `json:"defaultProcessorVersion,omitempty"`// ForceSendFields is a list of field names (e.g. "DefaultProcessorVersion") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DefaultProcessorVersion") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest: Request messagefor the SetDefaultProcessorVersion method.

func (GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest)MarshalJSONadded inv0.57.0

typeGoogleCloudDocumentaiV1SetDefaultProcessorVersionResponseadded inv0.57.0

type GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse struct {}

GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse: Response messagefor the SetDefaultProcessorVersion method.

typeGoogleCloudDocumentaiV1TrainProcessorVersionMetadataadded inv0.110.0

type GoogleCloudDocumentaiV1TrainProcessorVersionMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"`// TestDatasetValidation: The test dataset validation information.TestDatasetValidation *GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation `json:"testDatasetValidation,omitempty"`// TrainingDatasetValidation: The training dataset validation information.TrainingDatasetValidation *GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation `json:"trainingDatasetValidation,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1TrainProcessorVersionMetadata: The metadata thatrepresents a processor version being created.

func (GoogleCloudDocumentaiV1TrainProcessorVersionMetadata)MarshalJSONadded inv0.110.0

typeGoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidationadded inv0.110.0

type GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation struct {// DatasetErrorCount: The total number of dataset errors.DatasetErrorCountint64 `json:"datasetErrorCount,omitempty"`// DatasetErrors: Error information for the dataset as a whole. A maximum of 10// dataset errors will be returned. A single dataset error is terminal for// training.DatasetErrors []*GoogleRpcStatus `json:"datasetErrors,omitempty"`// DocumentErrorCount: The total number of document errors.DocumentErrorCountint64 `json:"documentErrorCount,omitempty"`// DocumentErrors: Error information pertaining to specific documents. A// maximum of 10 document errors will be returned. Any document with errors// will not be used throughout training.DocumentErrors []*GoogleRpcStatus `json:"documentErrors,omitempty"`// ForceSendFields is a list of field names (e.g. "DatasetErrorCount") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DatasetErrorCount") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation: Thedataset validation information. This includes any and all errors withdocuments and the dataset.

func (GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation)MarshalJSONadded inv0.110.0

typeGoogleCloudDocumentaiV1TrainProcessorVersionRequestadded inv0.108.0

type GoogleCloudDocumentaiV1TrainProcessorVersionRequest struct {// BaseProcessorVersion: Optional. The processor version to use as a base for// training. This processor version must be a child of `parent`. Format:// `projects/{project}/locations/{location}/processors/{processor}/processorVers// ions/{processorVersion}`.BaseProcessorVersionstring `json:"baseProcessorVersion,omitempty"`// CustomDocumentExtractionOptions: Options to control Custom Document// Extraction (CDE) Processor.CustomDocumentExtractionOptions *GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions `json:"customDocumentExtractionOptions,omitempty"`// DocumentSchema: Optional. The schema the processor version will be trained// with.DocumentSchema *GoogleCloudDocumentaiV1DocumentSchema `json:"documentSchema,omitempty"`// FoundationModelTuningOptions: Options to control foundation model tuning of// a processor.FoundationModelTuningOptions *GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions `json:"foundationModelTuningOptions,omitempty"`// InputData: Optional. The input data used to train the ProcessorVersion.InputData *GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData `json:"inputData,omitempty"`// ProcessorVersion: Required. The processor version to be created.ProcessorVersion *GoogleCloudDocumentaiV1ProcessorVersion `json:"processorVersion,omitempty"`// ForceSendFields is a list of field names (e.g. "BaseProcessorVersion") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BaseProcessorVersion") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1TrainProcessorVersionRequest: Request message for theTrainProcessorVersion method.

func (GoogleCloudDocumentaiV1TrainProcessorVersionRequest)MarshalJSONadded inv0.108.0

typeGoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptionsadded inv0.129.0

type GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions struct {// TrainingMethod: Optional. Training method to use for CDE training.//// Possible values://   "TRAINING_METHOD_UNSPECIFIED"//   "MODEL_BASED"//   "TEMPLATE_BASED"TrainingMethodstring `json:"trainingMethod,omitempty"`// ForceSendFields is a list of field names (e.g. "TrainingMethod") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "TrainingMethod") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions: Options to control the training of the Custom Document Extraction(CDE) Processor.

func (GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions)MarshalJSONadded inv0.129.0

typeGoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptionsadded inv0.170.0

type GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions struct {// LearningRateMultiplier: Optional. The multiplier to apply to the recommended// learning rate. Valid values are between 0.1 and 10. If not provided,// recommended learning rate will be used.LearningRateMultiplierfloat64 `json:"learningRateMultiplier,omitempty"`// TrainSteps: Optional. The number of steps to run for model tuning. Valid// values are between 1 and 400. If not provided, recommended steps will be// used.TrainStepsint64 `json:"trainSteps,omitempty"`// ForceSendFields is a list of field names (e.g. "LearningRateMultiplier") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "LearningRateMultiplier") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions: Options to control foundation model tuning of the processor.

func (GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions)MarshalJSONadded inv0.170.0

func (*GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions)UnmarshalJSONadded inv0.170.0

typeGoogleCloudDocumentaiV1TrainProcessorVersionRequestInputDataadded inv0.108.0

type GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData struct {// TestDocuments: The documents used for testing the trained version.TestDocuments *GoogleCloudDocumentaiV1BatchDocumentsInputConfig `json:"testDocuments,omitempty"`// TrainingDocuments: The documents used for training the new version.TrainingDocuments *GoogleCloudDocumentaiV1BatchDocumentsInputConfig `json:"trainingDocuments,omitempty"`// ForceSendFields is a list of field names (e.g. "TestDocuments") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "TestDocuments") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData: The input dataused to train a new ProcessorVersion.

func (GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData)MarshalJSONadded inv0.108.0

typeGoogleCloudDocumentaiV1TrainProcessorVersionResponseadded inv0.110.0

type GoogleCloudDocumentaiV1TrainProcessorVersionResponse struct {// ProcessorVersion: The resource name of the processor version produced by// training.ProcessorVersionstring `json:"processorVersion,omitempty"`// ForceSendFields is a list of field names (e.g. "ProcessorVersion") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ProcessorVersion") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1TrainProcessorVersionResponse: The response forTrainProcessorVersion.

func (GoogleCloudDocumentaiV1TrainProcessorVersionResponse)MarshalJSONadded inv0.110.0

typeGoogleCloudDocumentaiV1UndeployProcessorVersionMetadataadded inv0.57.0

type GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata: The long-runningoperation metadata for the UndeployProcessorVersion method.

func (GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata)MarshalJSONadded inv0.57.0

typeGoogleCloudDocumentaiV1UndeployProcessorVersionRequestadded inv0.57.0

type GoogleCloudDocumentaiV1UndeployProcessorVersionRequest struct {}

GoogleCloudDocumentaiV1UndeployProcessorVersionRequest: Request message forthe UndeployProcessorVersion method.

typeGoogleCloudDocumentaiV1UndeployProcessorVersionResponseadded inv0.57.0

type GoogleCloudDocumentaiV1UndeployProcessorVersionResponse struct {}

GoogleCloudDocumentaiV1UndeployProcessorVersionResponse: Response messagefor the UndeployProcessorVersion method.

typeGoogleCloudDocumentaiV1Vertex

type GoogleCloudDocumentaiV1Vertex struct {// X: X coordinate.Xint64 `json:"x,omitempty"`// Y: Y coordinate (starts from the top of the image).Yint64 `json:"y,omitempty"`// ForceSendFields is a list of field names (e.g. "X") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "X") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (GoogleCloudDocumentaiV1Vertex)MarshalJSON

func (sGoogleCloudDocumentaiV1Vertex) MarshalJSON() ([]byte,error)

typeGoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataadded inv0.132.0

type GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ErrorDocumentCount: Total number of documents that failed to be deleted in// storage.ErrorDocumentCountint64 `json:"errorDocumentCount,omitempty"`// IndividualBatchDeleteStatuses: The list of response details of each// document.IndividualBatchDeleteStatuses []*GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus `json:"individualBatchDeleteStatuses,omitempty"`// TotalDocumentCount: Total number of documents deleting from dataset.TotalDocumentCountint64 `json:"totalDocumentCount,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata)MarshalJSONadded inv0.132.0

typeGoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatusadded inv0.132.0

type GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus struct {// DocumentId: The document id of the document.DocumentId *GoogleCloudDocumentaiV1beta3DocumentId `json:"documentId,omitempty"`// Status: The status of deleting the document in storage.Status *GoogleRpcStatus `json:"status,omitempty"`// ForceSendFields is a list of field names (e.g. "DocumentId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DocumentId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus: The status of each individual document in the batch delete process.

func (GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus)MarshalJSONadded inv0.132.0

typeGoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponseadded inv0.132.0

type GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse struct {}

GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse: Response of thedelete documents operation.

typeGoogleCloudDocumentaiV1beta3BatchProcessMetadata

type GoogleCloudDocumentaiV1beta3BatchProcessMetadata struct {// CreateTime: The creation time of the operation.CreateTimestring `json:"createTime,omitempty"`// IndividualProcessStatuses: The list of response details of each document.IndividualProcessStatuses []*GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus `json:"individualProcessStatuses,omitempty"`// State: The state of the current batch processing.//// Possible values://   "STATE_UNSPECIFIED" - The default value. This value is used if the state// is omitted.//   "WAITING" - Request operation is waiting for scheduling.//   "RUNNING" - Request is being processed.//   "SUCCEEDED" - The batch processing completed successfully.//   "CANCELLING" - The batch processing was being cancelled.//   "CANCELLED" - The batch processing was cancelled.//   "FAILED" - The batch processing has failed.Statestring `json:"state,omitempty"`// StateMessage: A message providing more details about the current state of// processing. For example, the error message if the operation is failed.StateMessagestring `json:"stateMessage,omitempty"`// UpdateTime: The last update time of the operation.UpdateTimestring `json:"updateTime,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3BatchProcessMetadata: The long-running operationmetadata for BatchProcessDocuments.

func (GoogleCloudDocumentaiV1beta3BatchProcessMetadata)MarshalJSON

typeGoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus

type GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus struct {// HumanReviewOperation: The name of the operation triggered by the processed// document. If the human review process isn't triggered, this field will be// empty. It has the same response type and metadata as the long-running// operation returned by the ReviewDocument method.HumanReviewOperationstring `json:"humanReviewOperation,omitempty"`// HumanReviewStatus: The status of human review on the processed document.HumanReviewStatus *GoogleCloudDocumentaiV1beta3HumanReviewStatus `json:"humanReviewStatus,omitempty"`// InputGcsSource: The source of the document, same as the input_gcs_source// field in the request when the batch process started.InputGcsSourcestring `json:"inputGcsSource,omitempty"`// OutputGcsDestination: The Cloud Storage output destination (in the request// as DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed document// if it was successful, otherwise empty.OutputGcsDestinationstring `json:"outputGcsDestination,omitempty"`// Status: The status processing the document.Status *GoogleRpcStatus `json:"status,omitempty"`// ForceSendFields is a list of field names (e.g. "HumanReviewOperation") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "HumanReviewOperation") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus: Thestatus of a each individual document in the batch process.

func (GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus)MarshalJSON

typeGoogleCloudDocumentaiV1beta3BatchProcessResponse

type GoogleCloudDocumentaiV1beta3BatchProcessResponse struct {}

GoogleCloudDocumentaiV1beta3BatchProcessResponse: Response message forBatchProcessDocuments.

typeGoogleCloudDocumentaiV1beta3CommonOperationMetadata

type GoogleCloudDocumentaiV1beta3CommonOperationMetadata struct {// CreateTime: The creation time of the operation.CreateTimestring `json:"createTime,omitempty"`// Resource: A related resource to this operation.Resourcestring `json:"resource,omitempty"`// State: The state of the operation.//// Possible values://   "STATE_UNSPECIFIED" - Unspecified state.//   "RUNNING" - Operation is still running.//   "CANCELLING" - Operation is being cancelled.//   "SUCCEEDED" - Operation succeeded.//   "FAILED" - Operation failed.//   "CANCELLED" - Operation is cancelled.Statestring `json:"state,omitempty"`// StateMessage: A message providing more details about the current state of// processing.StateMessagestring `json:"stateMessage,omitempty"`// UpdateTime: The last update time of the operation.UpdateTimestring `json:"updateTime,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3CommonOperationMetadata: The common metadata forlong running operations.

func (GoogleCloudDocumentaiV1beta3CommonOperationMetadata)MarshalJSON

typeGoogleCloudDocumentaiV1beta3Datasetadded inv0.132.0

type GoogleCloudDocumentaiV1beta3Dataset struct {// DocumentWarehouseConfig: Optional. Deprecated. Warehouse-based dataset// configuration is not supported.DocumentWarehouseConfig *GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig `json:"documentWarehouseConfig,omitempty"`// GcsManagedConfig: Optional. User-managed Cloud Storage dataset// configuration. Use this configuration if the dataset documents are stored// under a user-managed Cloud Storage location.GcsManagedConfig *GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig `json:"gcsManagedConfig,omitempty"`// Name: Dataset resource name. Format:// `projects/{project}/locations/{location}/processors/{processor}/dataset`Namestring `json:"name,omitempty"`// SatisfiesPzi: Output only. Reserved for future use.SatisfiesPzibool `json:"satisfiesPzi,omitempty"`// SatisfiesPzs: Output only. Reserved for future use.SatisfiesPzsbool `json:"satisfiesPzs,omitempty"`// SpannerIndexingConfig: Optional. A lightweight indexing source with low// latency and high reliability, but lacking advanced features like CMEK and// content-based search.SpannerIndexingConfig *GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig `json:"spannerIndexingConfig,omitempty"`// State: Required. State of the dataset. Ignored when updating dataset.//// Possible values://   "STATE_UNSPECIFIED" - Default unspecified enum, should not be used.//   "UNINITIALIZED" - Dataset has not been initialized.//   "INITIALIZING" - Dataset is being initialized.//   "INITIALIZED" - Dataset has been initialized.Statestring `json:"state,omitempty"`// UnmanagedDatasetConfig: Optional. Unmanaged dataset configuration. Use this// configuration if the dataset documents are managed by the document service// internally (not user-managed).UnmanagedDatasetConfig *GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig `json:"unmanagedDatasetConfig,omitempty"`// ForceSendFields is a list of field names (e.g. "DocumentWarehouseConfig") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DocumentWarehouseConfig") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3Dataset: A singleton resource under a Processorwhich configures a collection of documents.

func (GoogleCloudDocumentaiV1beta3Dataset)MarshalJSONadded inv0.132.0

typeGoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfigadded inv0.132.0

type GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig struct {// Collection: Output only. The collection in Document AI Warehouse associated// with the dataset.Collectionstring `json:"collection,omitempty"`// Schema: Output only. The schema in Document AI Warehouse associated with the// dataset.Schemastring `json:"schema,omitempty"`// ForceSendFields is a list of field names (e.g. "Collection") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Collection") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig: Configurationspecific to the Document AI Warehouse-based implementation.

func (GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig)MarshalJSONadded inv0.132.0

typeGoogleCloudDocumentaiV1beta3DatasetGCSManagedConfigadded inv0.132.0

type GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig struct {// GcsPrefix: Required. The Cloud Storage URI (a directory) where the documents// belonging to the dataset must be stored.GcsPrefix *GoogleCloudDocumentaiV1beta3GcsPrefix `json:"gcsPrefix,omitempty"`// ForceSendFields is a list of field names (e.g. "GcsPrefix") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GcsPrefix") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig: Configuration specificto the Cloud Storage-based implementation.

func (GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig)MarshalJSONadded inv0.132.0

typeGoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfigadded inv0.132.0

type GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig struct {}

GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig: Configurationspecific to spanner-based indexing.

typeGoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfigadded inv0.132.0

type GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig struct {}

GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig: Configurationspecific to an unmanaged dataset.

typeGoogleCloudDocumentaiV1beta3DeleteProcessorMetadataadded inv0.48.0

type GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata: The long-runningoperation metadata for the DeleteProcessor method.

func (GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata)MarshalJSONadded inv0.48.0

typeGoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadataadded inv0.57.0

type GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata: The long-runningoperation metadata for the DeleteProcessorVersion method.

func (GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata)MarshalJSONadded inv0.57.0

typeGoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadataadded inv0.57.0

type GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata: The long-runningoperation metadata for the DeployProcessorVersion method.

func (GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata)MarshalJSONadded inv0.57.0

typeGoogleCloudDocumentaiV1beta3DeployProcessorVersionResponseadded inv0.57.0

type GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse struct {}

GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse: Response messagefor the DeployProcessorVersion method.

typeGoogleCloudDocumentaiV1beta3DisableProcessorMetadataadded inv0.48.0

type GoogleCloudDocumentaiV1beta3DisableProcessorMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3DisableProcessorMetadata: The long-runningoperation metadata for the DisableProcessor method.

func (GoogleCloudDocumentaiV1beta3DisableProcessorMetadata)MarshalJSONadded inv0.48.0

typeGoogleCloudDocumentaiV1beta3DisableProcessorResponseadded inv0.48.0

type GoogleCloudDocumentaiV1beta3DisableProcessorResponse struct {}

GoogleCloudDocumentaiV1beta3DisableProcessorResponse: Response message forthe DisableProcessor method. Intentionally empty proto for adding fields infuture.

typeGoogleCloudDocumentaiV1beta3DocumentIdadded inv0.132.0

type GoogleCloudDocumentaiV1beta3DocumentId struct {// GcsManagedDocId: A document id within user-managed Cloud Storage.GcsManagedDocId *GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId `json:"gcsManagedDocId,omitempty"`// RevisionRef: Points to a specific revision of the document if set.RevisionRef *GoogleCloudDocumentaiV1beta3RevisionRef `json:"revisionRef,omitempty"`// UnmanagedDocId: A document id within unmanaged dataset.UnmanagedDocId *GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId `json:"unmanagedDocId,omitempty"`// ForceSendFields is a list of field names (e.g. "GcsManagedDocId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GcsManagedDocId") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3DocumentId: Document Identifier.

func (GoogleCloudDocumentaiV1beta3DocumentId)MarshalJSONadded inv0.132.0

typeGoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentIdadded inv0.132.0

type GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId struct {// CwDocId: Id of the document (indexed) managed by Content Warehouse.CwDocIdstring `json:"cwDocId,omitempty"`// GcsUri: Required. The Cloud Storage URI where the actual document is stored.GcsUristring `json:"gcsUri,omitempty"`// ForceSendFields is a list of field names (e.g. "CwDocId") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CwDocId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId: Identifies adocument uniquely within the scope of a dataset in the user-managed CloudStorage option.

func (GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId)MarshalJSONadded inv0.132.0

typeGoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentIdadded inv0.132.0

type GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId struct {// DocId: Required. The id of the document.DocIdstring `json:"docId,omitempty"`// ForceSendFields is a list of field names (e.g. "DocId") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DocId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId: Identifies adocument uniquely within the scope of a dataset in unmanaged option.

func (GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId)MarshalJSONadded inv0.132.0

typeGoogleCloudDocumentaiV1beta3DocumentSchemaadded inv0.255.0

type GoogleCloudDocumentaiV1beta3DocumentSchema struct {// Description: Description of the schema.Descriptionstring `json:"description,omitempty"`// DisplayName: Display name to show to users.DisplayNamestring `json:"displayName,omitempty"`// EntityTypes: Entity types of the schema.EntityTypes []*GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType `json:"entityTypes,omitempty"`// Metadata: Metadata of the schema.Metadata *GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata `json:"metadata,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Description") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3DocumentSchema: The schema defines the output ofthe processed document by a processor.

func (GoogleCloudDocumentaiV1beta3DocumentSchema)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeadded inv0.255.0

type GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType struct {// BaseTypes: The entity type that this type is derived from. For now, one and// only one should be set.BaseTypes []string `json:"baseTypes,omitempty"`// Description: The description of the entity type. Could be used to provide// more information about the entity type for model calls.Descriptionstring `json:"description,omitempty"`// DisplayName: User defined name for the type.DisplayNamestring `json:"displayName,omitempty"`// EntityTypeMetadata: Metadata for the entity type.EntityTypeMetadata *GoogleCloudDocumentaiV1beta3EntityTypeMetadata `json:"entityTypeMetadata,omitempty"`// EnumValues: If specified, lists all the possible values for this entity.// This should not be more than a handful of values. If the number of values is// >10 or could change frequently use the `EntityType.value_ontology` field and// specify a list of all possible values in a value ontology file.EnumValues *GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues `json:"enumValues,omitempty"`// Name: Name of the type. It must be unique within the schema file and cannot// be a "Common Type". The following naming conventions are used: - Use// `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters.// - Must start with a letter. - Allowed characters: ASCII letters// `[a-z0-9_-]`. (For backward compatibility internal infrastructure and// tooling can handle any ascii character.) - The `/` is sometimes used to// denote a property of a type. For example `line_item/amount`. This convention// is deprecated, but will still be honored for backward compatibility.Namestring `json:"name,omitempty"`// Properties: Description the nested structure, or composition of an entity.Properties []*GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty `json:"properties,omitempty"`// ForceSendFields is a list of field names (e.g. "BaseTypes") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BaseTypes") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType: EntityType is thewrapper of a label of the corresponding model with detailed attributes andlimitations for entity-based processors. Multiple types can also compose adependency tree to represent nested types.

func (GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValuesadded inv0.255.0

type GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues struct {// Values: The individual values that this enum values type can include.Values []string `json:"values,omitempty"`// ForceSendFields is a list of field names (e.g. "Values") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Values") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues: Defines thea list of enum values.

func (GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypePropertyadded inv0.255.0

type GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty struct {// Description: The description of the property. Could be used to provide more// information about the property for model calls.Descriptionstring `json:"description,omitempty"`// DisplayName: User defined name for the property.DisplayNamestring `json:"displayName,omitempty"`// Method: Specifies how the entity's value is obtained.//// Possible values://   "METHOD_UNSPECIFIED" - Unspecified method. It defaults to `EXTRACT`.//   "EXTRACT" - The entity's value is directly extracted as-is from the// document text.//   "DERIVE" - The entity's value is derived through inference and is not// necessarily an exact text extraction from the document.Methodstring `json:"method,omitempty"`// Name: The name of the property. Follows the same guidelines as the// EntityType name.Namestring `json:"name,omitempty"`// OccurrenceType: Occurrence type limits the number of instances an entity// type appears in the document.//// Possible values://   "OCCURRENCE_TYPE_UNSPECIFIED" - Unspecified occurrence type.//   "OPTIONAL_ONCE" - There will be zero or one instance of this entity type.// The same entity instance may be mentioned multiple times.//   "OPTIONAL_MULTIPLE" - The entity type will appear zero or multiple times.//   "REQUIRED_ONCE" - The entity type will only appear exactly once. The same// entity instance may be mentioned multiple times.//   "REQUIRED_MULTIPLE" - The entity type will appear once or more times.OccurrenceTypestring `json:"occurrenceType,omitempty"`// PropertyMetadata: Any additional metadata about the property can be added// here.PropertyMetadata *GoogleCloudDocumentaiV1beta3PropertyMetadata `json:"propertyMetadata,omitempty"`// ValueType: A reference to the value type of the property. This type is// subject to the same conventions as the `Entity.base_types` field.ValueTypestring `json:"valueType,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Description") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty: Definesproperties that can be part of the entity type.

func (GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiV1beta3DocumentSchemaMetadataadded inv0.255.0

type GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata struct {// DocumentAllowMultipleLabels: If true, on a given page, there can be multiple// `document` annotations covering it.DocumentAllowMultipleLabelsbool `json:"documentAllowMultipleLabels,omitempty"`// DocumentSplitter: If true, a `document` entity type can be applied to// subdocument (splitting). Otherwise, it can only be applied to the entire// document (classification).DocumentSplitterbool `json:"documentSplitter,omitempty"`// PrefixedNamingOnProperties: If set, all the nested entities must be prefixed// with the parents.PrefixedNamingOnPropertiesbool `json:"prefixedNamingOnProperties,omitempty"`// SkipNamingValidation: If set, we will skip the naming format validation in// the schema. So the string values in `DocumentSchema.EntityType.name` and// `DocumentSchema.EntityType.Property.name` will not be checked.SkipNamingValidationbool `json:"skipNamingValidation,omitempty"`// ForceSendFields is a list of field names (e.g.// "DocumentAllowMultipleLabels") to unconditionally include in API requests.// By default, fields with empty or default values are omitted from API// requests. Seehttps://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields// for more details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DocumentAllowMultipleLabels") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata: Metadata for globalschema behavior.

func (GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiV1beta3EnableProcessorMetadataadded inv0.48.0

type GoogleCloudDocumentaiV1beta3EnableProcessorMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3EnableProcessorMetadata: The long-runningoperation metadata for the EnableProcessor method.

func (GoogleCloudDocumentaiV1beta3EnableProcessorMetadata)MarshalJSONadded inv0.48.0

typeGoogleCloudDocumentaiV1beta3EnableProcessorResponseadded inv0.48.0

type GoogleCloudDocumentaiV1beta3EnableProcessorResponse struct {}

GoogleCloudDocumentaiV1beta3EnableProcessorResponse: Response message forthe EnableProcessor method. Intentionally empty proto for adding fields infuture.

typeGoogleCloudDocumentaiV1beta3EntityTypeMetadataadded inv0.255.0

type GoogleCloudDocumentaiV1beta3EntityTypeMetadata struct {// Inactive: Whether the entity type should be considered inactive.Inactivebool `json:"inactive,omitempty"`// ForceSendFields is a list of field names (e.g. "Inactive") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Inactive") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3EntityTypeMetadata: Metadata about an entitytype.

func (GoogleCloudDocumentaiV1beta3EntityTypeMetadata)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadataadded inv0.104.0

type GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata: Metadata ofthe EvaluateProcessorVersion method.

func (GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata)MarshalJSONadded inv0.104.0

typeGoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponseadded inv0.104.0

type GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse struct {// Evaluation: The resource name of the created evaluation.Evaluationstring `json:"evaluation,omitempty"`// ForceSendFields is a list of field names (e.g. "Evaluation") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Evaluation") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse: Response ofthe EvaluateProcessorVersion method.

func (GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse)MarshalJSONadded inv0.104.0

typeGoogleCloudDocumentaiV1beta3EvaluationMetricsadded inv0.255.0

type GoogleCloudDocumentaiV1beta3EvaluationMetrics struct {// F1Score: The calculated f1 score.F1Scorefloat64 `json:"f1Score,omitempty"`// FalseNegativesCount: The amount of false negatives.FalseNegativesCountint64 `json:"falseNegativesCount,omitempty"`// FalsePositivesCount: The amount of false positives.FalsePositivesCountint64 `json:"falsePositivesCount,omitempty"`// GroundTruthDocumentCount: The amount of documents with a ground truth// occurrence.GroundTruthDocumentCountint64 `json:"groundTruthDocumentCount,omitempty"`// GroundTruthOccurrencesCount: The amount of occurrences in ground truth// documents.GroundTruthOccurrencesCountint64 `json:"groundTruthOccurrencesCount,omitempty"`// Precision: The calculated precision.Precisionfloat64 `json:"precision,omitempty"`// PredictedDocumentCount: The amount of documents with a predicted occurrence.PredictedDocumentCountint64 `json:"predictedDocumentCount,omitempty"`// PredictedOccurrencesCount: The amount of occurrences in predicted documents.PredictedOccurrencesCountint64 `json:"predictedOccurrencesCount,omitempty"`// Recall: The calculated recall.Recallfloat64 `json:"recall,omitempty"`// TotalDocumentsCount: The amount of documents that had an occurrence of this// label.TotalDocumentsCountint64 `json:"totalDocumentsCount,omitempty"`// TruePositivesCount: The amount of true positives.TruePositivesCountint64 `json:"truePositivesCount,omitempty"`// ForceSendFields is a list of field names (e.g. "F1Score") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "F1Score") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3EvaluationMetrics: Evaluation metrics, either inaggregate or about a specific entity.

func (GoogleCloudDocumentaiV1beta3EvaluationMetrics)MarshalJSONadded inv0.255.0

func (*GoogleCloudDocumentaiV1beta3EvaluationMetrics)UnmarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiV1beta3EvaluationReferenceadded inv0.255.0

type GoogleCloudDocumentaiV1beta3EvaluationReference struct {// AggregateMetrics: An aggregate of the statistics for the evaluation with// fuzzy matching on.AggregateMetrics *GoogleCloudDocumentaiV1beta3EvaluationMetrics `json:"aggregateMetrics,omitempty"`// AggregateMetricsExact: An aggregate of the statistics for the evaluation// with fuzzy matching off.AggregateMetricsExact *GoogleCloudDocumentaiV1beta3EvaluationMetrics `json:"aggregateMetricsExact,omitempty"`// Evaluation: The resource name of the evaluation.Evaluationstring `json:"evaluation,omitempty"`// Operation: The resource name of the Long Running Operation for the// evaluation.Operationstring `json:"operation,omitempty"`// ForceSendFields is a list of field names (e.g. "AggregateMetrics") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AggregateMetrics") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3EvaluationReference: Gives a short summary of anevaluation, and links to the evaluation itself.

func (GoogleCloudDocumentaiV1beta3EvaluationReference)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiV1beta3FieldExtractionMetadataadded inv0.255.0

type GoogleCloudDocumentaiV1beta3FieldExtractionMetadata struct {// SummaryOptions: Summary options config.SummaryOptions *GoogleCloudDocumentaiV1beta3SummaryOptions `json:"summaryOptions,omitempty"`// ForceSendFields is a list of field names (e.g. "SummaryOptions") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "SummaryOptions") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3FieldExtractionMetadata: Metadata for how thisfield value is extracted.

func (GoogleCloudDocumentaiV1beta3FieldExtractionMetadata)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiV1beta3GcsPrefixadded inv0.132.0

type GoogleCloudDocumentaiV1beta3GcsPrefix struct {// GcsUriPrefix: The URI prefix.GcsUriPrefixstring `json:"gcsUriPrefix,omitempty"`// ForceSendFields is a list of field names (e.g. "GcsUriPrefix") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GcsUriPrefix") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3GcsPrefix: Specifies all documents on CloudStorage with a common prefix.

func (GoogleCloudDocumentaiV1beta3GcsPrefix)MarshalJSONadded inv0.132.0

typeGoogleCloudDocumentaiV1beta3HumanReviewStatus

type GoogleCloudDocumentaiV1beta3HumanReviewStatus struct {// HumanReviewOperation: The name of the operation triggered by the processed// document. This field is populated only when the state is// `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as// the long-running operation returned by ReviewDocument.HumanReviewOperationstring `json:"humanReviewOperation,omitempty"`// State: The state of human review on the processing request.//// Possible values://   "STATE_UNSPECIFIED" - Human review state is unspecified. Most likely due// to an internal error.//   "SKIPPED" - Human review is skipped for the document. This can happen// because human review isn't enabled on the processor or the processing// request has been set to skip this document.//   "VALIDATION_PASSED" - Human review validation is triggered and passed, so// no review is needed.//   "IN_PROGRESS" - Human review validation is triggered and the document is// under review.//   "ERROR" - Some error happened during triggering human review, see the// state_message for details.Statestring `json:"state,omitempty"`// StateMessage: A message providing more details about the human review state.StateMessagestring `json:"stateMessage,omitempty"`// ForceSendFields is a list of field names (e.g. "HumanReviewOperation") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "HumanReviewOperation") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3HumanReviewStatus: The status of human review ona processed document.

func (GoogleCloudDocumentaiV1beta3HumanReviewStatus)MarshalJSON

typeGoogleCloudDocumentaiV1beta3ImportDocumentsMetadataadded inv0.132.0

type GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ImportConfigValidationResults: Validation statuses of the batch documents// import config.ImportConfigValidationResults []*GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult `json:"importConfigValidationResults,omitempty"`// IndividualImportStatuses: The list of response details of each document.IndividualImportStatuses []*GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus `json:"individualImportStatuses,omitempty"`// TotalDocumentCount: Total number of the documents that are qualified for// importing.TotalDocumentCountint64 `json:"totalDocumentCount,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata: Metadata of the importdocument operation.

func (GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata)MarshalJSONadded inv0.132.0

typeGoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResultadded inv0.132.0

type GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult struct {// InputGcsSource: The source Cloud Storage URI specified in the import config.InputGcsSourcestring `json:"inputGcsSource,omitempty"`// Status: The validation status of import config.Status *GoogleRpcStatus `json:"status,omitempty"`// ForceSendFields is a list of field names (e.g. "InputGcsSource") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "InputGcsSource") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult: The validation status of each import config. Status is set to an errorif there are no documents to import in the `import_config`, or `OK` if theoperation will try to proceed with at least one document.

func (GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult)MarshalJSONadded inv0.132.0

typeGoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatusadded inv0.132.0

type GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus struct {// InputGcsSource: The source Cloud Storage URI of the document.InputGcsSourcestring `json:"inputGcsSource,omitempty"`// OutputDocumentId: The document id of imported document if it was successful,// otherwise empty.OutputDocumentId *GoogleCloudDocumentaiV1beta3DocumentId `json:"outputDocumentId,omitempty"`// Status: The status of the importing of the document.Status *GoogleRpcStatus `json:"status,omitempty"`// ForceSendFields is a list of field names (e.g. "InputGcsSource") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "InputGcsSource") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus:The status of each individual document in the import process.

func (GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus)MarshalJSONadded inv0.132.0

typeGoogleCloudDocumentaiV1beta3ImportDocumentsResponseadded inv0.132.0

type GoogleCloudDocumentaiV1beta3ImportDocumentsResponse struct {}

GoogleCloudDocumentaiV1beta3ImportDocumentsResponse: Response of the importdocument operation.

typeGoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadataadded inv0.114.0

type GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata struct {// CommonMetadata: The basic metadata for the long-running operation.CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata: The long-runningoperation metadata for the ImportProcessorVersion method.

func (GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata)MarshalJSONadded inv0.114.0

typeGoogleCloudDocumentaiV1beta3ImportProcessorVersionResponseadded inv0.114.0

type GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse struct {// ProcessorVersion: The destination processor version name.ProcessorVersionstring `json:"processorVersion,omitempty"`// ForceSendFields is a list of field names (e.g. "ProcessorVersion") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ProcessorVersion") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse: The responsemessage for the ImportProcessorVersion method.

func (GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse)MarshalJSONadded inv0.114.0

typeGoogleCloudDocumentaiV1beta3Processoradded inv0.255.0

type GoogleCloudDocumentaiV1beta3Processor struct {// ActiveSchemaVersion: Optional. SchemaVersion used by the Processor. It is// the same as Processor's DatasetSchema.schema_version Format is// `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{sch// ema_version}ActiveSchemaVersionstring `json:"activeSchemaVersion,omitempty"`// CreateTime: Output only. The time the processor was created.CreateTimestring `json:"createTime,omitempty"`// DefaultProcessorVersion: The default processor version.DefaultProcessorVersionstring `json:"defaultProcessorVersion,omitempty"`// DisplayName: The display name of the processor.DisplayNamestring `json:"displayName,omitempty"`// KmsKeyName: The KMS key (https://cloud.google.com/security-key-management)// used for encryption and decryption in CMEK scenarios.KmsKeyNamestring `json:"kmsKeyName,omitempty"`// Name: Output only. Immutable. The resource name of the processor. Format:// `projects/{project}/locations/{location}/processors/{processor}`Namestring `json:"name,omitempty"`// ProcessEndpoint: Output only. Immutable. The http endpoint that can be// called to invoke processing.ProcessEndpointstring `json:"processEndpoint,omitempty"`// ProcessorVersionAliases: Output only. The processor version aliases.ProcessorVersionAliases []*GoogleCloudDocumentaiV1beta3ProcessorVersionAlias `json:"processorVersionAliases,omitempty"`// SatisfiesPzi: Output only. Reserved for future use.SatisfiesPzibool `json:"satisfiesPzi,omitempty"`// SatisfiesPzs: Output only. Reserved for future use.SatisfiesPzsbool `json:"satisfiesPzs,omitempty"`// State: Output only. The state of the processor.//// Possible values://   "STATE_UNSPECIFIED" - The processor is in an unspecified state.//   "ENABLED" - The processor is enabled, i.e., has an enabled version which// can currently serve processing requests and all the feature dependencies// have been successfully initialized.//   "DISABLED" - The processor is disabled.//   "ENABLING" - The processor is being enabled, will become `ENABLED` if// successful.//   "DISABLING" - The processor is being disabled, will become `DISABLED` if// successful.//   "CREATING" - The processor is being created, will become either `ENABLED`// (for successful creation) or `FAILED` (for failed ones). Once a processor is// in this state, it can then be used for document processing, but the feature// dependencies of the processor might not be fully created yet.//   "FAILED" - The processor failed during creation or initialization of// feature dependencies. The user should delete the processor and recreate one// as all the functionalities of the processor are disabled.//   "DELETING" - The processor is being deleted, will be removed if// successful.Statestring `json:"state,omitempty"`// Type: The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To// get a list of processor types, see FetchProcessorTypes.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "ActiveSchemaVersion") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ActiveSchemaVersion") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3Processor: The first-class citizen for DocumentAI. Each processor defines how to extract structural information from adocument.

func (GoogleCloudDocumentaiV1beta3Processor)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiV1beta3ProcessorVersionadded inv0.255.0

type GoogleCloudDocumentaiV1beta3ProcessorVersion struct {// CreateTime: Output only. The time the processor version was created.CreateTimestring `json:"createTime,omitempty"`// DeprecationInfo: Output only. If set, information about the eventual// deprecation of this version.DeprecationInfo *GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo `json:"deprecationInfo,omitempty"`// DisplayName: The display name of the processor version.DisplayNamestring `json:"displayName,omitempty"`// DocumentSchema: Output only. The schema of the processor version. Describes// the output.DocumentSchema *GoogleCloudDocumentaiV1beta3DocumentSchema `json:"documentSchema,omitempty"`// GenAiModelInfo: Output only. Information about Generative AI model-based// processor versions.GenAiModelInfo *GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo `json:"genAiModelInfo,omitempty"`// GoogleManaged: Output only. Denotes that this `ProcessorVersion` is managed// by Google.GoogleManagedbool `json:"googleManaged,omitempty"`// KmsKeyName: Output only. The KMS key name used for encryption.KmsKeyNamestring `json:"kmsKeyName,omitempty"`// KmsKeyVersionName: Output only. The KMS key version with which data is// encrypted.KmsKeyVersionNamestring `json:"kmsKeyVersionName,omitempty"`// LatestEvaluation: Output only. The most recently invoked evaluation for the// processor version.LatestEvaluation *GoogleCloudDocumentaiV1beta3EvaluationReference `json:"latestEvaluation,omitempty"`// ModelType: Output only. The model type of this processor version.//// Possible values://   "MODEL_TYPE_UNSPECIFIED" - The processor version has unspecified model// type.//   "MODEL_TYPE_GENERATIVE" - The processor version has generative model type.//   "MODEL_TYPE_CUSTOM" - The processor version has custom model type.ModelTypestring `json:"modelType,omitempty"`// Name: Identifier. The resource name of the processor version. Format:// `projects/{project}/locations/{location}/processors/{processor}/processorVers// ions/{processor_version}`Namestring `json:"name,omitempty"`// SatisfiesPzi: Output only. Reserved for future use.SatisfiesPzibool `json:"satisfiesPzi,omitempty"`// SatisfiesPzs: Output only. Reserved for future use.SatisfiesPzsbool `json:"satisfiesPzs,omitempty"`// State: Output only. The state of the processor version.//// Possible values://   "STATE_UNSPECIFIED" - The processor version is in an unspecified state.//   "DEPLOYED" - The processor version is deployed and can be used for// processing.//   "DEPLOYING" - The processor version is being deployed.//   "UNDEPLOYED" - The processor version is not deployed and cannot be used// for processing.//   "UNDEPLOYING" - The processor version is being undeployed.//   "CREATING" - The processor version is being created.//   "DELETING" - The processor version is being deleted.//   "FAILED" - The processor version failed and is in an indeterminate state.//   "IMPORTING" - The processor version is being imported.Statestring `json:"state,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3ProcessorVersion: A processor version is animplementation of a processor. Each processor can have multiple versions,pretrained by Google internally or uptrained by the customer. A processorcan only have one default version at a time. Its document-processingbehavior is defined by that version.

func (GoogleCloudDocumentaiV1beta3ProcessorVersion)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiV1beta3ProcessorVersionAliasadded inv0.255.0

type GoogleCloudDocumentaiV1beta3ProcessorVersionAlias struct {// Alias: The alias in the form of `processor_version` resource name.Aliasstring `json:"alias,omitempty"`// ProcessorVersion: The resource name of aliased processor version.ProcessorVersionstring `json:"processorVersion,omitempty"`// ForceSendFields is a list of field names (e.g. "Alias") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Alias") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3ProcessorVersionAlias: Contains the alias andthe aliased resource name of processor version.

func (GoogleCloudDocumentaiV1beta3ProcessorVersionAlias)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfoadded inv0.255.0

type GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo struct {// DeprecationTime: The time at which this processor version will be// deprecated.DeprecationTimestring `json:"deprecationTime,omitempty"`// ReplacementProcessorVersion: If set, the processor version that will be used// as a replacement.ReplacementProcessorVersionstring `json:"replacementProcessorVersion,omitempty"`// ForceSendFields is a list of field names (e.g. "DeprecationTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DeprecationTime") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo: Informationabout the upcoming deprecation of this processor version.

func (GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoadded inv0.255.0

type GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo struct {// CustomGenAiModelInfo: Information for a custom Generative AI model created// by the user.CustomGenAiModelInfo *GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo `json:"customGenAiModelInfo,omitempty"`// FoundationGenAiModelInfo: Information for a pretrained Google-managed// foundation model.FoundationGenAiModelInfo *GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo `json:"foundationGenAiModelInfo,omitempty"`// ForceSendFields is a list of field names (e.g. "CustomGenAiModelInfo") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CustomGenAiModelInfo") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo: Informationabout Generative AI model-based processor versions.

func (GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfoadded inv0.255.0

type GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo struct {// BaseProcessorVersionId: The base processor version ID for the custom model.BaseProcessorVersionIdstring `json:"baseProcessorVersionId,omitempty"`// CustomModelType: The type of custom model created by the user.//// Possible values://   "CUSTOM_MODEL_TYPE_UNSPECIFIED" - The model type is unspecified.//   "VERSIONED_FOUNDATION" - The model is a versioned foundation model.//   "FINE_TUNED" - The model is a finetuned foundation model.CustomModelTypestring `json:"customModelType,omitempty"`// ForceSendFields is a list of field names (e.g. "BaseProcessorVersionId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BaseProcessorVersionId") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo: Information for a custom Generative AI model created by the user. Theseare created with `Create New Version` in either the `Call foundation model`or `Fine tuning` tabs.

func (GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfoadded inv0.255.0

type GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo struct {// FinetuningAllowed: Whether finetuning is allowed for this base processor// version.FinetuningAllowedbool `json:"finetuningAllowed,omitempty"`// MinTrainLabeledDocuments: The minimum number of labeled documents in the// training dataset required for finetuning.MinTrainLabeledDocumentsint64 `json:"minTrainLabeledDocuments,omitempty"`// ForceSendFields is a list of field names (e.g. "FinetuningAllowed") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FinetuningAllowed") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo: Information for a pretrained Google-managed foundation model.

func (GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiV1beta3PropertyMetadataadded inv0.255.0

type GoogleCloudDocumentaiV1beta3PropertyMetadata struct {// FieldExtractionMetadata: Field extraction metadata on the property.FieldExtractionMetadata *GoogleCloudDocumentaiV1beta3FieldExtractionMetadata `json:"fieldExtractionMetadata,omitempty"`// Inactive: Whether the property should be considered as "inactive".Inactivebool `json:"inactive,omitempty"`// ForceSendFields is a list of field names (e.g. "FieldExtractionMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FieldExtractionMetadata") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3PropertyMetadata: Metadata about a property.

func (GoogleCloudDocumentaiV1beta3PropertyMetadata)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata

type GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// CreateTime: The creation time of the operation.CreateTimestring `json:"createTime,omitempty"`// QuestionId: The Crowd Compute question ID.QuestionIdstring `json:"questionId,omitempty"`// State: Used only when Operation.done is false.//// Possible values://   "STATE_UNSPECIFIED" - Unspecified state.//   "RUNNING" - Operation is still running.//   "CANCELLING" - Operation is being cancelled.//   "SUCCEEDED" - Operation succeeded.//   "FAILED" - Operation failed.//   "CANCELLED" - Operation is cancelled.Statestring `json:"state,omitempty"`// StateMessage: A message providing more details about the current state of// processing. For example, the error message if the operation is failed.StateMessagestring `json:"stateMessage,omitempty"`// UpdateTime: The last update time of the operation.UpdateTimestring `json:"updateTime,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata: Thelong-running operation metadata for the ReviewDocument method.

func (GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata)MarshalJSON

typeGoogleCloudDocumentaiV1beta3ReviewDocumentResponse

type GoogleCloudDocumentaiV1beta3ReviewDocumentResponse struct {// GcsDestination: The Cloud Storage uri for the human reviewed document if the// review is succeeded.GcsDestinationstring `json:"gcsDestination,omitempty"`// RejectionReason: The reason why the review is rejected by reviewer.RejectionReasonstring `json:"rejectionReason,omitempty"`// State: The state of the review operation.//// Possible values://   "STATE_UNSPECIFIED" - The default value. This value is used if the state// is omitted.//   "REJECTED" - The review operation is rejected by the reviewer.//   "SUCCEEDED" - The review operation is succeeded.Statestring `json:"state,omitempty"`// ForceSendFields is a list of field names (e.g. "GcsDestination") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GcsDestination") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3ReviewDocumentResponse: Response message for theReviewDocument method.

func (GoogleCloudDocumentaiV1beta3ReviewDocumentResponse)MarshalJSON

typeGoogleCloudDocumentaiV1beta3RevisionRefadded inv0.132.0

type GoogleCloudDocumentaiV1beta3RevisionRef struct {// LatestProcessorVersion: Reads the revision generated by the processor// version. The format takes the full resource name of processor version.// `projects/{project}/locations/{location}/processors/{processor}/processorVers// ions/{processorVersion}`LatestProcessorVersionstring `json:"latestProcessorVersion,omitempty"`// RevisionCase: Reads the revision by the predefined case.//// Possible values://   "REVISION_CASE_UNSPECIFIED" - Unspecified case, fall back to read the// `LATEST_HUMAN_REVIEW`.//   "LATEST_HUMAN_REVIEW" - The latest revision made by a human.//   "LATEST_TIMESTAMP" - The latest revision based on timestamp.//   "BASE_OCR_REVISION" - The first (OCR) revision.RevisionCasestring `json:"revisionCase,omitempty"`// RevisionId: Reads the revision given by the id.RevisionIdstring `json:"revisionId,omitempty"`// ForceSendFields is a list of field names (e.g. "LatestProcessorVersion") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "LatestProcessorVersion") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3RevisionRef: The revision reference specifieswhich revision on the document to read.

func (GoogleCloudDocumentaiV1beta3RevisionRef)MarshalJSONadded inv0.132.0

typeGoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadataadded inv0.57.0

type GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata: Thelong-running operation metadata for the SetDefaultProcessorVersion method.

func (GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata)MarshalJSONadded inv0.57.0

typeGoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponseadded inv0.57.0

type GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse struct {}

GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse: Responsemessage for the SetDefaultProcessorVersion method.

typeGoogleCloudDocumentaiV1beta3SummaryOptionsadded inv0.255.0

type GoogleCloudDocumentaiV1beta3SummaryOptions struct {// Format: The format the summary should be in.//// Possible values://   "FORMAT_UNSPECIFIED" - Default.//   "PARAGRAPH" - Format the output in paragraphs.//   "BULLETS" - Format the output in bullets.Formatstring `json:"format,omitempty"`// Length: How long the summary should be.//// Possible values://   "LENGTH_UNSPECIFIED" - Default.//   "BRIEF" - A brief summary of one or two sentences.//   "MODERATE" - A paragraph-length summary.//   "COMPREHENSIVE" - The longest option available.Lengthstring `json:"length,omitempty"`// ForceSendFields is a list of field names (e.g. "Format") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Format") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3SummaryOptions: Metadata for documentsummarization.

func (GoogleCloudDocumentaiV1beta3SummaryOptions)MarshalJSONadded inv0.255.0

typeGoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataadded inv0.104.0

type GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// TestDatasetValidation: The test dataset validation information.TestDatasetValidation *GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation `json:"testDatasetValidation,omitempty"`// TrainingDatasetValidation: The training dataset validation information.TrainingDatasetValidation *GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation `json:"trainingDatasetValidation,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata: The metadata thatrepresents a processor version being created.

func (GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata)MarshalJSONadded inv0.104.0

typeGoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidationadded inv0.104.0

type GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation struct {// DatasetErrorCount: The total number of dataset errors.DatasetErrorCountint64 `json:"datasetErrorCount,omitempty"`// DatasetErrors: Error information for the dataset as a whole. A maximum of 10// dataset errors will be returned. A single dataset error is terminal for// training.DatasetErrors []*GoogleRpcStatus `json:"datasetErrors,omitempty"`// DocumentErrorCount: The total number of document errors.DocumentErrorCountint64 `json:"documentErrorCount,omitempty"`// DocumentErrors: Error information pertaining to specific documents. A// maximum of 10 document errors will be returned. Any document with errors// will not be used throughout training.DocumentErrors []*GoogleRpcStatus `json:"documentErrors,omitempty"`// ForceSendFields is a list of field names (e.g. "DatasetErrorCount") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DatasetErrorCount") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation:The dataset validation information. This includes any and all errors withdocuments and the dataset.

func (GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation)MarshalJSONadded inv0.104.0

typeGoogleCloudDocumentaiV1beta3TrainProcessorVersionResponseadded inv0.104.0

type GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse struct {// ProcessorVersion: The resource name of the processor version produced by// training.ProcessorVersionstring `json:"processorVersion,omitempty"`// ForceSendFields is a list of field names (e.g. "ProcessorVersion") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ProcessorVersion") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse: The response forTrainProcessorVersion.

func (GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse)MarshalJSONadded inv0.104.0

typeGoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadataadded inv0.57.0

type GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata: Thelong-running operation metadata for the UndeployProcessorVersion method.

func (GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata)MarshalJSONadded inv0.57.0

typeGoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponseadded inv0.57.0

type GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse struct {}

GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse: Responsemessage for the UndeployProcessorVersion method.

typeGoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadataadded inv0.132.0

type GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata struct {// CommonMetadata: The basic metadata of the long-running operation.CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata)MarshalJSONadded inv0.132.0

typeGoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadataadded inv0.255.0

type GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata struct {// CommonMetadata: The basic metadata for the long-running operation.CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "CommonMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommonMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata: The long-runningoperation metadata for the UpdateProcessorVersion method.

func (GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata)MarshalJSONadded inv0.255.0

typeGoogleCloudLocationListLocationsResponse

type GoogleCloudLocationListLocationsResponse struct {// Locations: A list of locations that matches the specified filter in the// request.Locations []*GoogleCloudLocationLocation `json:"locations,omitempty"`// NextPageToken: The standard List next-page token.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Locations") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Locations") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudLocationListLocationsResponse: The response message forLocations.ListLocations.

func (GoogleCloudLocationListLocationsResponse)MarshalJSON

typeGoogleCloudLocationLocation

type GoogleCloudLocationLocation struct {// DisplayName: The friendly name for this location, typically a nearby city// name. For example, "Tokyo".DisplayNamestring `json:"displayName,omitempty"`// Labels: Cross-service attributes for the location. For example// {"cloud.googleapis.com/region": "us-east1"}Labels map[string]string `json:"labels,omitempty"`// LocationId: The canonical id for this location. For example: "us-east1".LocationIdstring `json:"locationId,omitempty"`// Metadata: Service-specific metadata. For example the available capacity at// the given location.Metadatagoogleapi.RawMessage `json:"metadata,omitempty"`// Name: Resource name for the location, which may vary between// implementations. For example:// "projects/example-project/locations/us-east1"Namestring `json:"name,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "DisplayName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DisplayName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudLocationLocation: A resource that represents a Google Cloudlocation.

func (GoogleCloudLocationLocation)MarshalJSON

func (sGoogleCloudLocationLocation) MarshalJSON() ([]byte,error)

typeGoogleLongrunningListOperationsResponse

type GoogleLongrunningListOperationsResponse struct {// NextPageToken: The standard List next-page token.NextPageTokenstring `json:"nextPageToken,omitempty"`// Operations: A list of operations that matches the specified filter in the// request.Operations []*GoogleLongrunningOperation `json:"operations,omitempty"`// Unreachable: Unordered list. Unreachable resources. Populated when the// request sets `ListOperationsRequest.return_partial_success` and reads across// collections e.g. when attempting to list all resources across all supported// locations.Unreachable []string `json:"unreachable,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleLongrunningListOperationsResponse: The response message forOperations.ListOperations.

func (GoogleLongrunningListOperationsResponse)MarshalJSON

typeGoogleLongrunningOperation

type GoogleLongrunningOperation struct {// Done: If the value is `false`, it means the operation is still in progress.// If `true`, the operation is completed, and either `error` or `response` is// available.Donebool `json:"done,omitempty"`// Error: The error result of the operation in case of failure or cancellation.Error *GoogleRpcStatus `json:"error,omitempty"`// Metadata: Service-specific metadata associated with the operation. It// typically contains progress information and common metadata such as create// time. Some services might not provide such metadata. Any method that returns// a long-running operation should document the metadata type, if any.Metadatagoogleapi.RawMessage `json:"metadata,omitempty"`// Name: The server-assigned name, which is only unique within the same service// that originally returns it. If you use the default HTTP mapping, the `name`// should be a resource name ending with `operations/{unique_id}`.Namestring `json:"name,omitempty"`// Response: The normal, successful response of the operation. If the original// method returns no data on success, such as `Delete`, the response is// `google.protobuf.Empty`. If the original method is standard// `Get`/`Create`/`Update`, the response should be the resource. For other// methods, the response should have the type `XxxResponse`, where `Xxx` is the// original method name. For example, if the original method name is// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.Responsegoogleapi.RawMessage `json:"response,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Done") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Done") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleLongrunningOperation: This resource represents a long-runningoperation that is the result of a network API call.

func (GoogleLongrunningOperation)MarshalJSON

func (sGoogleLongrunningOperation) MarshalJSON() ([]byte,error)

typeGoogleProtobufEmpty

type GoogleProtobufEmpty struct {// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`}

GoogleProtobufEmpty: A generic empty message that you can re-use to avoiddefining duplicated empty messages in your APIs. A typical example is to useit as the request or the response type of an API method. For instance:service Foo { rpc Bar(google.protobuf.Empty) returns(google.protobuf.Empty); }

typeGoogleRpcStatus

type GoogleRpcStatus struct {// Code: The status code, which should be an enum value of google.rpc.Code.Codeint64 `json:"code,omitempty"`// Details: A list of messages that carry the error details. There is a common// set of message types for APIs to use.Details []googleapi.RawMessage `json:"details,omitempty"`// Message: A developer-facing error message, which should be in English. Any// user-facing error message should be localized and sent in the// google.rpc.Status.details field, or localized by the client.Messagestring `json:"message,omitempty"`// ForceSendFields is a list of field names (e.g. "Code") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Code") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleRpcStatus: The `Status` type defines a logical error model that issuitable for different programming environments, including REST APIs and RPCAPIs. It is used by gRPC (https://github.com/grpc). Each `Status` messagecontains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in theAPI Design Guide (https://cloud.google.com/apis/design/errors).

func (GoogleRpcStatus)MarshalJSON

func (sGoogleRpcStatus) MarshalJSON() ([]byte,error)

typeGoogleTypeColor

type GoogleTypeColor struct {// Alpha: The fraction of this color that should be applied to the pixel. That// is, the final pixel color is defined by the equation: `pixel color = alpha *// (this color) + (1.0 - alpha) * (background color)` This means that a value// of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a// completely transparent color. This uses a wrapper message rather than a// simple float scalar so that it is possible to distinguish between a default// value and the value being unset. If omitted, this color object is rendered// as a solid color (as if the alpha value had been explicitly given a value of// 1.0).Alphafloat64 `json:"alpha,omitempty"`// Blue: The amount of blue in the color as a value in the interval [0, 1].Bluefloat64 `json:"blue,omitempty"`// Green: The amount of green in the color as a value in the interval [0, 1].Greenfloat64 `json:"green,omitempty"`// Red: The amount of red in the color as a value in the interval [0, 1].Redfloat64 `json:"red,omitempty"`// ForceSendFields is a list of field names (e.g. "Alpha") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Alpha") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleTypeColor: Represents a color in the RGBA color space. Thisrepresentation is designed for simplicity of conversion to and from colorrepresentations in various languages over compactness. For example, thefields of this representation can be trivially provided to the constructorof `java.awt.Color` in Java; it can also be trivially provided to UIColor's`+colorWithRed:green:blue:alpha` method in iOS; and, with just a littlework, it can be easily formatted into a CSS `rgba()` string in JavaScript.This reference page doesn't have information about the absolute color spacethat should be used to interpret the RGB value—for example, sRGB, AdobeRGB, DCI-P3, and BT.2020. By default, applications should assume the sRGBcolor space. When color equality needs to be decided, implementations,unless documented otherwise, treat two colors as equal if all their red,green, blue, and alpha values each differ by at most `1e-5`. Example (Java):import com.google.type.Color; // ... public static java.awt.ColorfromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ?protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color(protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); }public static Color toProto(java.awt.Color color) { float red = (float)color.getRed(); float green = (float) color.getGreen(); float blue = (float)color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder =Color .newBuilder() .setRed(red / denominator) .setGreen(green /denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if(alpha != 255) { result.setAlpha( FloatValue .newBuilder().setValue(((float) alpha) / denominator) .build()); } returnresultBuilder.build(); } // ... Example (iOS / Obj-C): // ... staticUIColor* fromProto(Color* protocolor) { float red = [protocolor red]; floatgreen = [protocolor green]; float blue = [protocolor blue]; FloatValue*alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper !=nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:redgreen:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color){ CGFloat red, green, blue, alpha; if (![color getRed:&red green:&greenblue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc]init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue];if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; }[result autorelease]; return result; } // ... Example (JavaScript): // ...var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red ||0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue|| 0.0; var red = Math.floor(redFrac * 255); var green =Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if(!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } varalphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green,blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(”);}; var rgbToCssColor = function(red, green, blue) { var rgbNumber = newNumber((red << 16) | (green << 8) | blue); var hexString =rgbNumber.toString(16); var missingZeros = 6 - hexString.length; varresultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) {resultBuilder.push('0'); } resultBuilder.push(hexString); returnresultBuilder.join(”); }; // ...

func (GoogleTypeColor)MarshalJSON

func (sGoogleTypeColor) MarshalJSON() ([]byte,error)

func (*GoogleTypeColor)UnmarshalJSON

func (s *GoogleTypeColor) UnmarshalJSON(data []byte)error

typeGoogleTypeDate

type GoogleTypeDate struct {// Day: Day of a month. Must be from 1 to 31 and valid for the year and month,// or 0 to specify a year by itself or a year and month where the day isn't// significant.Dayint64 `json:"day,omitempty"`// Month: Month of a year. Must be from 1 to 12, or 0 to specify a year without// a month and day.Monthint64 `json:"month,omitempty"`// Year: Year of the date. Must be from 1 to 9999, or 0 to specify a date// without a year.Yearint64 `json:"year,omitempty"`// ForceSendFields is a list of field names (e.g. "Day") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Day") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleTypeDate: Represents a whole or partial calendar date, such as abirthday. The time of day and time zone are either specified elsewhere orare insignificant. The date is relative to the Gregorian Calendar. This canrepresent one of the following: * A full date, with non-zero year, month,and day values. * A month and day, with a zero year (for example, ananniversary). * A year on its own, with a zero month and a zero day. * Ayear and month, with a zero day (for example, a credit card expirationdate). Related types: * google.type.TimeOfDay * google.type.DateTime *google.protobuf.Timestamp

func (GoogleTypeDate)MarshalJSON

func (sGoogleTypeDate) MarshalJSON() ([]byte,error)

typeGoogleTypeDateTime

type GoogleTypeDateTime struct {// Day: Optional. Day of month. Must be from 1 to 31 and valid for the year and// month, or 0 if specifying a datetime without a day.Dayint64 `json:"day,omitempty"`// Hours: Optional. Hours of day in 24 hour format. Should be from 0 to 23,// defaults to 0 (midnight). An API may choose to allow the value "24:00:00"// for scenarios like business closing time.Hoursint64 `json:"hours,omitempty"`// Minutes: Optional. Minutes of hour of day. Must be from 0 to 59, defaults to// 0.Minutesint64 `json:"minutes,omitempty"`// Month: Optional. Month of year. Must be from 1 to 12, or 0 if specifying a// datetime without a month.Monthint64 `json:"month,omitempty"`// Nanos: Optional. Fractions of seconds in nanoseconds. Must be from 0 to// 999,999,999, defaults to 0.Nanosint64 `json:"nanos,omitempty"`// Seconds: Optional. Seconds of minutes of the time. Must normally be from 0// to 59, defaults to 0. An API may allow the value 60 if it allows// leap-seconds.Secondsint64 `json:"seconds,omitempty"`// TimeZone: Time zone.TimeZone *GoogleTypeTimeZone `json:"timeZone,omitempty"`// UtcOffset: UTC offset. Must be whole seconds, between -18 hours and +18// hours. For example, a UTC offset of -4:00 would be represented as { seconds:// -14400 }.UtcOffsetstring `json:"utcOffset,omitempty"`// Year: Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a// datetime without a year.Yearint64 `json:"year,omitempty"`// ForceSendFields is a list of field names (e.g. "Day") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Day") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleTypeDateTime: Represents civil time (or occasionally physical time).This type can represent a civil time in one of a few possible ways: * Whenutc_offset is set and time_zone is unset: a civil time on a calendar daywith a particular offset from UTC. * When time_zone is set and utc_offset isunset: a civil time on a calendar day in a particular time zone. * Whenneither time_zone nor utc_offset is set: a civil time on a calendar day inlocal time. The date is relative to the Proleptic Gregorian Calendar. Ifyear, month, or day are 0, the DateTime is considered not to have a specificyear, month, or day respectively. This type may also be used to represent aphysical time if all the date and time fields are set and either case of the`time_offset` oneof is set. Consider using `Timestamp` message for physicaltime instead. If your use case also would like to store the user's timezone,that can be done in another field. This type is more flexible than someapplications may want. Make sure to document and validate your application'slimitations.

func (GoogleTypeDateTime)MarshalJSON

func (sGoogleTypeDateTime) MarshalJSON() ([]byte,error)

typeGoogleTypeMoney

type GoogleTypeMoney struct {// CurrencyCode: The three-letter currency code defined in ISO 4217.CurrencyCodestring `json:"currencyCode,omitempty"`// Nanos: Number of nano (10^-9) units of the amount. The value must be between// -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos`// must be positive or zero. If `units` is zero, `nanos` can be positive, zero,// or negative. If `units` is negative, `nanos` must be negative or zero. For// example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.Nanosint64 `json:"nanos,omitempty"`// Units: The whole units of the amount. For example if `currencyCode` is// "USD", then 1 unit is one US dollar.Unitsint64 `json:"units,omitempty,string"`// ForceSendFields is a list of field names (e.g. "CurrencyCode") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CurrencyCode") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleTypeMoney: Represents an amount of money with its currency type.

func (GoogleTypeMoney)MarshalJSON

func (sGoogleTypeMoney) MarshalJSON() ([]byte,error)

typeGoogleTypePostalAddress

type GoogleTypePostalAddress struct {// AddressLines: Unstructured address lines describing the lower levels of an// address. Because values in `address_lines` do not have type information and// may sometimes contain multiple values in a single field (for example,// "Austin, TX"), it is important that the line order is clear. The order of// address lines should be "envelope order" for the country or region of the// address. In places where this can vary (for example, Japan),// `address_language` is used to make it explicit (for example, "ja" for// large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this// way, the most specific line of an address can be selected based on the// language. The minimum permitted structural representation of an address// consists of a `region_code` with all remaining information placed in the// `address_lines`. It would be possible to format such an address very// approximately without geocoding, but no semantic reasoning could be made// about any of the address components until it was at least partially// resolved. Creating an address only containing a `region_code` and// `address_lines` and then geocoding is the recommended way to handle// completely unstructured addresses (as opposed to guessing which parts of the// address should be localities or administrative areas).AddressLines []string `json:"addressLines,omitempty"`// AdministrativeArea: Optional. Highest administrative subdivision which is// used for postal addresses of a country or region. For example, this can be a// state, a province, an oblast, or a prefecture. For Spain, this is the// province and not the autonomous community (for example, "Barcelona" and not// "Catalonia"). Many countries don't use an administrative area in postal// addresses. For example, in Switzerland, this should be left unpopulated.AdministrativeAreastring `json:"administrativeArea,omitempty"`// LanguageCode: Optional. BCP-47 language code of the contents of this address// (if known). This is often the UI language of the input form or is expected// to match one of the languages used in the address' country/region, or their// transliterated equivalents. This can affect formatting in certain countries,// but is not critical to the correctness of the data and will never affect any// validation or other non-formatting related operations. If this value is not// known, it should be omitted (rather than specifying a possibly incorrect// default). Examples: "zh-Hant", "ja", "ja-Latn", "en".LanguageCodestring `json:"languageCode,omitempty"`// Locality: Optional. Generally refers to the city or town portion of the// address. Examples: US city, IT comune, UK post town. In regions of the world// where localities are not well defined or do not fit into this structure// well, leave `locality` empty and use `address_lines`.Localitystring `json:"locality,omitempty"`// Organization: Optional. The name of the organization at the address.Organizationstring `json:"organization,omitempty"`// PostalCode: Optional. Postal code of the address. Not all countries use or// require postal codes to be present, but where they are used, they may// trigger additional validation with other parts of the address (for example,// state or zip code validation in the United States).PostalCodestring `json:"postalCode,omitempty"`// Recipients: Optional. The recipient at the address. This field may, under// certain circumstances, contain multiline information. For example, it might// contain "care of" information.Recipients []string `json:"recipients,omitempty"`// RegionCode: Required. CLDR region code of the country/region of the address.// This is never inferred and it is up to the user to ensure the value is// correct. Seehttps://cldr.unicode.org/ and//https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html// for details. Example: "CH" for Switzerland.RegionCodestring `json:"regionCode,omitempty"`// Revision: The schema revision of the `PostalAddress`. This must be set to 0,// which is the latest revision. All new revisions **must** be backward// compatible with old revisions.Revisionint64 `json:"revision,omitempty"`// SortingCode: Optional. Additional, country-specific, sorting code. This is// not used in most regions. Where it is used, the value is either a string// like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or// just a number alone, representing the "sector code" (Jamaica), "delivery// area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).SortingCodestring `json:"sortingCode,omitempty"`// Sublocality: Optional. Sublocality of the address. For example, this can be// a neighborhood, borough, or district.Sublocalitystring `json:"sublocality,omitempty"`// ForceSendFields is a list of field names (e.g. "AddressLines") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AddressLines") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleTypePostalAddress: Represents a postal address, such as for postaldelivery or payments addresses. With a postal address, a postal service candeliver items to a premise, P.O. box, or similar. A postal address is notintended to model geographical locations like roads, towns, or mountains. Intypical usage, an address would be created by user input or from importingexisting data, depending on the type of process. Advice on address input orediting: - Use an internationalization-ready address widget such ashttps://github.com/google/libaddressinput. - Users should not be presentedwith UI elements for input or editing of fields outside countries where thatfield is used. For more guidance on how to use this schema, see:https://support.google.com/business/answer/6397478.

func (GoogleTypePostalAddress)MarshalJSON

func (sGoogleTypePostalAddress) MarshalJSON() ([]byte,error)

typeGoogleTypeTimeZone

type GoogleTypeTimeZone struct {// Id: IANA Time Zone Database time zone. For example "America/New_York".Idstring `json:"id,omitempty"`// Version: Optional. IANA Time Zone Database version number. For example// "2019a".Versionstring `json:"version,omitempty"`// ForceSendFields is a list of field names (e.g. "Id") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Id") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleTypeTimeZone: Represents a time zone from the IANA Time Zone Database(https://www.iana.org/time-zones).

func (GoogleTypeTimeZone)MarshalJSON

func (sGoogleTypeTimeZone) MarshalJSON() ([]byte,error)

typeOperationsDeleteCall

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

func (*OperationsDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*OperationsDeleteCall)Do

Do executes the "documentai.operations.delete" call.Any non-2xx status code is an error. Response headers are in either*GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*OperationsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*OperationsDeleteCall)Header

func (c *OperationsDeleteCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeOperationsService

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

funcNewOperationsService

func NewOperationsService(s *Service) *OperationsService

func (*OperationsService)Delete

Delete: Deletes a long-running operation. This method indicates that theclient is no longer interested in the operation result. It does not cancelthe operation. If the server doesn't support this method, it returns`google.rpc.Code.UNIMPLEMENTED`.

- name: The name of the operation resource to be deleted.

typeProjectsLocationsFetchProcessorTypesCalladded inv0.57.0

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

func (*ProjectsLocationsFetchProcessorTypesCall)Contextadded inv0.57.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsFetchProcessorTypesCall)Doadded inv0.57.0

Do executes the "documentai.projects.locations.fetchProcessorTypes" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudDocumentaiV1FetchProcessorTypesResponse.ServerResponse.Header or(if a response was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsFetchProcessorTypesCall)Fieldsadded inv0.57.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsFetchProcessorTypesCall)Headeradded inv0.57.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsFetchProcessorTypesCall)IfNoneMatchadded inv0.57.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsGetCall

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

func (*ProjectsLocationsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsGetCall)Do

Do executes the "documentai.projects.locations.get" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudLocationLocation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsListCall

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

func (*ProjectsLocationsListCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsListCall)Do

Do executes the "documentai.projects.locations.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudLocationListLocationsResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsListCall)ExtraLocationTypesadded inv0.228.0

func (c *ProjectsLocationsListCall) ExtraLocationTypes(extraLocationTypes ...string) *ProjectsLocationsListCall

ExtraLocationTypes sets the optional parameter "extraLocationTypes": Do notuse this field. It is unsupported and is ignored unless explicitlydocumented otherwise. This is primarily for internal usage.

func (*ProjectsLocationsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsListCall)Filter

Filter sets the optional parameter "filter": A filter to narrow down resultsto a preferred subset. The filtering language accepts strings like"displayName=tokyo", and is documented in more detail in AIP-160(https://google.aip.dev/160).

func (*ProjectsLocationsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsListCall)PageSize

PageSize sets the optional parameter "pageSize": The maximum number ofresults to return. If not set, the service selects a default.

func (*ProjectsLocationsListCall)PageToken

PageToken sets the optional parameter "pageToken": A page token receivedfrom the `next_page_token` field in the response. Send that page token toreceive the subsequent page.

func (*ProjectsLocationsListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsLocationsOperationsCancelCalladded inv0.55.0

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

func (*ProjectsLocationsOperationsCancelCall)Contextadded inv0.55.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsCancelCall)Doadded inv0.55.0

Do executes the "documentai.projects.locations.operations.cancel" call.Any non-2xx status code is an error. Response headers are in either*GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsOperationsCancelCall)Fieldsadded inv0.55.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsOperationsCancelCall)Headeradded inv0.55.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsOperationsGetCall

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

func (*ProjectsLocationsOperationsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsGetCall)Do

Do executes the "documentai.projects.locations.operations.get" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsOperationsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsOperationsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsOperationsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsOperationsListCalladded inv0.48.0

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

func (*ProjectsLocationsOperationsListCall)Contextadded inv0.48.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsListCall)Doadded inv0.48.0

Do executes the "documentai.projects.locations.operations.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningListOperationsResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsOperationsListCall)Fieldsadded inv0.48.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsOperationsListCall)Filteradded inv0.48.0

Filter sets the optional parameter "filter": The standard list filter.

func (*ProjectsLocationsOperationsListCall)Headeradded inv0.48.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsOperationsListCall)IfNoneMatchadded inv0.48.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsOperationsListCall)PageSizeadded inv0.48.0

PageSize sets the optional parameter "pageSize": The standard list pagesize.

func (*ProjectsLocationsOperationsListCall)PageTokenadded inv0.48.0

PageToken sets the optional parameter "pageToken": The standard list pagetoken.

func (*ProjectsLocationsOperationsListCall)Pagesadded inv0.48.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

func (*ProjectsLocationsOperationsListCall)ReturnPartialSuccessadded inv0.252.0

func (c *ProjectsLocationsOperationsListCall) ReturnPartialSuccess(returnPartialSuccessbool) *ProjectsLocationsOperationsListCall

ReturnPartialSuccess sets the optional parameter "returnPartialSuccess":When set to `true`, operations that are reachable are returned as normal,and those that are unreachable are returned in the[ListOperationsResponse.unreachable] field. This can only be `true` whenreading across collections e.g. when `parent` is set to"projects/example/locations/-". This field is not by default supported andwill result in an `UNIMPLEMENTED` error if set unless explicitly documentedotherwise in service or product specific documentation.

typeProjectsLocationsOperationsService

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

func (*ProjectsLocationsOperationsService)Canceladded inv0.55.0

Cancel: Starts asynchronous cancellation on a long-running operation. Theserver makes a best effort to cancel the operation, but success is notguaranteed. If the server doesn't support this method, it returns`google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation orother methods to check whether the cancellation succeeded or whether theoperation completed despite cancellation. On successful cancellation, theoperation is not deleted; instead, it becomes an operation with anOperation.error value with a google.rpc.Status.code of `1`, corresponding to`Code.CANCELLED`.

- name: The name of the operation resource to be cancelled.

func (*ProjectsLocationsOperationsService)Get

Get: Gets the latest state of a long-running operation. Clients can use thismethod to poll the operation result at intervals as recommended by the APIservice.

- name: The name of the operation resource.

func (*ProjectsLocationsOperationsService)Listadded inv0.48.0

List: Lists operations that match the specified filter in the request. Ifthe server doesn't support this method, it returns `UNIMPLEMENTED`.

- name: The name of the operation's parent resource.

typeProjectsLocationsProcessorTypesGetCalladded inv0.107.0

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

func (*ProjectsLocationsProcessorTypesGetCall)Contextadded inv0.107.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsProcessorTypesGetCall)Doadded inv0.107.0

Do executes the "documentai.projects.locations.processorTypes.get" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudDocumentaiV1ProcessorType.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsProcessorTypesGetCall)Fieldsadded inv0.107.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsProcessorTypesGetCall)Headeradded inv0.107.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsProcessorTypesGetCall)IfNoneMatchadded inv0.107.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsProcessorTypesListCalladded inv0.88.0

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

func (*ProjectsLocationsProcessorTypesListCall)Contextadded inv0.88.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsProcessorTypesListCall)Doadded inv0.88.0

Do executes the "documentai.projects.locations.processorTypes.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudDocumentaiV1ListProcessorTypesResponse.ServerResponse.Header or(if a response was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsProcessorTypesListCall)Fieldsadded inv0.88.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsProcessorTypesListCall)Headeradded inv0.88.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsProcessorTypesListCall)IfNoneMatchadded inv0.88.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsProcessorTypesListCall)PageSizeadded inv0.88.0

PageSize sets the optional parameter "pageSize": The maximum number ofprocessor types to return. If unspecified, at most `100` processor typeswill be returned. The maximum value is `500`. Values above `500` will becoerced to `500`.

func (*ProjectsLocationsProcessorTypesListCall)PageTokenadded inv0.88.0

PageToken sets the optional parameter "pageToken": Used to retrieve the nextpage of results, empty if at the end of the list.

func (*ProjectsLocationsProcessorTypesListCall)Pagesadded inv0.88.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsLocationsProcessorTypesServiceadded inv0.88.0

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

funcNewProjectsLocationsProcessorTypesServiceadded inv0.88.0

func NewProjectsLocationsProcessorTypesService(s *Service) *ProjectsLocationsProcessorTypesService

func (*ProjectsLocationsProcessorTypesService)Getadded inv0.107.0

Get: Gets a processor type detail.

- name: The processor type resource name.

func (*ProjectsLocationsProcessorTypesService)Listadded inv0.88.0

List: Lists the processor types that exist.

  • parent: The location of processor types to list. Format:`projects/{project}/locations/{location}`.

typeProjectsLocationsProcessorsBatchProcessCall

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

func (*ProjectsLocationsProcessorsBatchProcessCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsProcessorsBatchProcessCall)Do

Do executes the "documentai.projects.locations.processors.batchProcess" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsProcessorsBatchProcessCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsProcessorsBatchProcessCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsProcessorsCreateCalladded inv0.57.0

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

func (*ProjectsLocationsProcessorsCreateCall)Contextadded inv0.57.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsProcessorsCreateCall)Doadded inv0.57.0

Do executes the "documentai.projects.locations.processors.create" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudDocumentaiV1Processor.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsProcessorsCreateCall)Fieldsadded inv0.57.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsProcessorsCreateCall)Headeradded inv0.57.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsProcessorsDeleteCalladded inv0.57.0

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

func (*ProjectsLocationsProcessorsDeleteCall)Contextadded inv0.57.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsProcessorsDeleteCall)Doadded inv0.57.0

Do executes the "documentai.projects.locations.processors.delete" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsProcessorsDeleteCall)Fieldsadded inv0.57.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsProcessorsDeleteCall)Headeradded inv0.57.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsProcessorsDisableCalladded inv0.57.0

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

func (*ProjectsLocationsProcessorsDisableCall)Contextadded inv0.57.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsProcessorsDisableCall)Doadded inv0.57.0

Do executes the "documentai.projects.locations.processors.disable" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsProcessorsDisableCall)Fieldsadded inv0.57.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsProcessorsDisableCall)Headeradded inv0.57.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsProcessorsEnableCalladded inv0.57.0

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

func (*ProjectsLocationsProcessorsEnableCall)Contextadded inv0.57.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsProcessorsEnableCall)Doadded inv0.57.0

Do executes the "documentai.projects.locations.processors.enable" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsProcessorsEnableCall)Fieldsadded inv0.57.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsProcessorsEnableCall)Headeradded inv0.57.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsProcessorsGetCalladded inv0.57.0

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

func (*ProjectsLocationsProcessorsGetCall)Contextadded inv0.57.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsProcessorsGetCall)Doadded inv0.57.0

Do executes the "documentai.projects.locations.processors.get" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudDocumentaiV1Processor.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsProcessorsGetCall)Fieldsadded inv0.57.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsProcessorsGetCall)Headeradded inv0.57.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsProcessorsGetCall)IfNoneMatchadded inv0.57.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsProcessorsHumanReviewConfigReviewDocumentCall

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

func (*ProjectsLocationsProcessorsHumanReviewConfigReviewDocumentCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsProcessorsHumanReviewConfigReviewDocumentCall)Do

Do executes the "documentai.projects.locations.processors.humanReviewConfig.reviewDocument" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsProcessorsHumanReviewConfigReviewDocumentCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsProcessorsHumanReviewConfigReviewDocumentCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsProcessorsHumanReviewConfigService

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

func (*ProjectsLocationsProcessorsHumanReviewConfigService)ReviewDocument

ReviewDocument: Send a document for Human Review. The input document shouldbe processed by the specified processor.

  • humanReviewConfig: The resource name of the HumanReviewConfig that thedocument will be reviewed with.

typeProjectsLocationsProcessorsListCalladded inv0.57.0

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

func (*ProjectsLocationsProcessorsListCall)Contextadded inv0.57.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsProcessorsListCall)Doadded inv0.57.0

Do executes the "documentai.projects.locations.processors.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudDocumentaiV1ListProcessorsResponse.ServerResponse.Header or (ifa response was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsProcessorsListCall)Fieldsadded inv0.57.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsProcessorsListCall)Headeradded inv0.57.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsProcessorsListCall)IfNoneMatchadded inv0.57.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsProcessorsListCall)PageSizeadded inv0.57.0

PageSize sets the optional parameter "pageSize": The maximum number ofprocessors to return. If unspecified, at most `50` processors will bereturned. The maximum value is `100`. Values above `100` will be coerced to`100`.

func (*ProjectsLocationsProcessorsListCall)PageTokenadded inv0.57.0

PageToken sets the optional parameter "pageToken": We will return theprocessors sorted by creation time. The page token will point to the nextprocessor.

func (*ProjectsLocationsProcessorsListCall)Pagesadded inv0.57.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsLocationsProcessorsProcessCall

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

func (*ProjectsLocationsProcessorsProcessCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsProcessorsProcessCall)Do

Do executes the "documentai.projects.locations.processors.process" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudDocumentaiV1ProcessResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsProcessorsProcessCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsProcessorsProcessCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsProcessorsProcessorVersionsBatchProcessCall

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

func (*ProjectsLocationsProcessorsProcessorVersionsBatchProcessCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsProcessorsProcessorVersionsBatchProcessCall)Do

Do executes the "documentai.projects.locations.processors.processorVersions.batchProcess" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsProcessorsProcessorVersionsBatchProcessCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsProcessorsProcessorVersionsBatchProcessCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsProcessorsProcessorVersionsDeleteCalladded inv0.57.0

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

func (*ProjectsLocationsProcessorsProcessorVersionsDeleteCall)Contextadded inv0.57.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsProcessorsProcessorVersionsDeleteCall)Doadded inv0.57.0

Do executes the "documentai.projects.locations.processors.processorVersions.delete" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsProcessorsProcessorVersionsDeleteCall)Fieldsadded inv0.57.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsProcessorsProcessorVersionsDeleteCall)Headeradded inv0.57.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsProcessorsProcessorVersionsDeployCalladded inv0.57.0

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

func (*ProjectsLocationsProcessorsProcessorVersionsDeployCall)Contextadded inv0.57.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsProcessorsProcessorVersionsDeployCall)Doadded inv0.57.0

Do executes the "documentai.projects.locations.processors.processorVersions.deploy" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsProcessorsProcessorVersionsDeployCall)Fieldsadded inv0.57.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsProcessorsProcessorVersionsDeployCall)Headeradded inv0.57.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsProcessorsProcessorVersionsEvaluateProcessorVersionCalladded inv0.108.0

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

func (*ProjectsLocationsProcessorsProcessorVersionsEvaluateProcessorVersionCall)Contextadded inv0.108.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsProcessorsProcessorVersionsEvaluateProcessorVersionCall)Doadded inv0.108.0

Do executes the "documentai.projects.locations.processors.processorVersions.evaluateProcessorVersion" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsProcessorsProcessorVersionsEvaluateProcessorVersionCall)Fieldsadded inv0.108.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsProcessorsProcessorVersionsEvaluateProcessorVersionCall)Headeradded inv0.108.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsProcessorsProcessorVersionsEvaluationsGetCalladded inv0.108.0

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

func (*ProjectsLocationsProcessorsProcessorVersionsEvaluationsGetCall)Contextadded inv0.108.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsProcessorsProcessorVersionsEvaluationsGetCall)Doadded inv0.108.0

Do executes the "documentai.projects.locations.processors.processorVersions.evaluations.get" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudDocumentaiV1Evaluation.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsProcessorsProcessorVersionsEvaluationsGetCall)Fieldsadded inv0.108.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsProcessorsProcessorVersionsEvaluationsGetCall)Headeradded inv0.108.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsProcessorsProcessorVersionsEvaluationsGetCall)IfNoneMatchadded inv0.108.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsProcessorsProcessorVersionsEvaluationsListCalladded inv0.108.0

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

func (*ProjectsLocationsProcessorsProcessorVersionsEvaluationsListCall)Contextadded inv0.108.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsProcessorsProcessorVersionsEvaluationsListCall)Doadded inv0.108.0

Do executes the "documentai.projects.locations.processors.processorVersions.evaluations.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudDocumentaiV1ListEvaluationsResponse.ServerResponse.Header or (ifa response was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsProcessorsProcessorVersionsEvaluationsListCall)Fieldsadded inv0.108.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsProcessorsProcessorVersionsEvaluationsListCall)Headeradded inv0.108.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsProcessorsProcessorVersionsEvaluationsListCall)IfNoneMatchadded inv0.108.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsProcessorsProcessorVersionsEvaluationsListCall)PageSizeadded inv0.108.0

PageSize sets the optional parameter "pageSize": The standard list pagesize. If unspecified, at most `5` evaluations are returned. The maximumvalue is `100`. Values above `100` are coerced to `100`.

func (*ProjectsLocationsProcessorsProcessorVersionsEvaluationsListCall)PageTokenadded inv0.108.0

PageToken sets the optional parameter "pageToken": A page token, receivedfrom a previous `ListEvaluations` call. Provide this to retrieve thesubsequent page.

func (*ProjectsLocationsProcessorsProcessorVersionsEvaluationsListCall)Pagesadded inv0.108.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsLocationsProcessorsProcessorVersionsEvaluationsServiceadded inv0.108.0

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

funcNewProjectsLocationsProcessorsProcessorVersionsEvaluationsServiceadded inv0.108.0

func NewProjectsLocationsProcessorsProcessorVersionsEvaluationsService(s *Service) *ProjectsLocationsProcessorsProcessorVersionsEvaluationsService

func (*ProjectsLocationsProcessorsProcessorVersionsEvaluationsService)Getadded inv0.108.0

Get: Retrieves a specific evaluation.

  • name: The resource name of the Evaluation to get.`projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}`.

func (*ProjectsLocationsProcessorsProcessorVersionsEvaluationsService)Listadded inv0.108.0

List: Retrieves a set of evaluations for a given processor version.

  • parent: The resource name of the ProcessorVersion to list evaluations for.`projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.

typeProjectsLocationsProcessorsProcessorVersionsGetCalladded inv0.57.0

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

func (*ProjectsLocationsProcessorsProcessorVersionsGetCall)Contextadded inv0.57.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsProcessorsProcessorVersionsGetCall)Doadded inv0.57.0

Do executes the "documentai.projects.locations.processors.processorVersions.get" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudDocumentaiV1ProcessorVersion.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsProcessorsProcessorVersionsGetCall)Fieldsadded inv0.57.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsProcessorsProcessorVersionsGetCall)Headeradded inv0.57.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsProcessorsProcessorVersionsGetCall)IfNoneMatchadded inv0.57.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsProcessorsProcessorVersionsListCalladded inv0.57.0

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

func (*ProjectsLocationsProcessorsProcessorVersionsListCall)Contextadded inv0.57.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsProcessorsProcessorVersionsListCall)Doadded inv0.57.0

Do executes the "documentai.projects.locations.processors.processorVersions.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudDocumentaiV1ListProcessorVersionsResponse.ServerResponse.Headeror (if a response was returned at all) in error.(*googleapi.Error).Header.Use googleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsProcessorsProcessorVersionsListCall)Fieldsadded inv0.57.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsProcessorsProcessorVersionsListCall)Headeradded inv0.57.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsProcessorsProcessorVersionsListCall)IfNoneMatchadded inv0.57.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsProcessorsProcessorVersionsListCall)PageSizeadded inv0.57.0

PageSize sets the optional parameter "pageSize": The maximum number ofprocessor versions to return. If unspecified, at most `10` processorversions will be returned. The maximum value is `20`. Values above `20` willbe coerced to `20`.

func (*ProjectsLocationsProcessorsProcessorVersionsListCall)PageTokenadded inv0.57.0

PageToken sets the optional parameter "pageToken": We will return theprocessor versions sorted by creation time. The page token will point to thenext processor version.

func (*ProjectsLocationsProcessorsProcessorVersionsListCall)Pagesadded inv0.57.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsLocationsProcessorsProcessorVersionsProcessCall

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

func (*ProjectsLocationsProcessorsProcessorVersionsProcessCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsProcessorsProcessorVersionsProcessCall)Do

Do executes the "documentai.projects.locations.processors.processorVersions.process" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudDocumentaiV1ProcessResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsProcessorsProcessorVersionsProcessCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsProcessorsProcessorVersionsProcessCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsProcessorsProcessorVersionsService

type ProjectsLocationsProcessorsProcessorVersionsService struct {Evaluations *ProjectsLocationsProcessorsProcessorVersionsEvaluationsService// contains filtered or unexported fields}

func (*ProjectsLocationsProcessorsProcessorVersionsService)BatchProcess

BatchProcess: LRO endpoint to batch process many documents. The output iswritten to Cloud Storage as JSON in the [Document] format.

  • name: The resource name of Processor or ProcessorVersion. Format:`projects/{project}/locations/{location}/processors/{processor}`, or`projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.

func (*ProjectsLocationsProcessorsProcessorVersionsService)Deleteadded inv0.57.0

Delete: Deletes the processor version, all artifacts under the processorversion will be deleted.

- name: The processor version resource name to be deleted.

func (*ProjectsLocationsProcessorsProcessorVersionsService)Deployadded inv0.57.0

Deploy: Deploys the processor version.

- name: The processor version resource name to be deployed.

func (*ProjectsLocationsProcessorsProcessorVersionsService)EvaluateProcessorVersionadded inv0.108.0

EvaluateProcessorVersion: Evaluates a ProcessorVersion against annotateddocuments, producing an Evaluation.

  • processorVersion: The resource name of the ProcessorVersion to evaluate.`projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.

func (*ProjectsLocationsProcessorsProcessorVersionsService)Getadded inv0.57.0

Get: Gets a processor version detail.

- name: The processor resource name.

func (*ProjectsLocationsProcessorsProcessorVersionsService)Listadded inv0.57.0

List: Lists all versions of a processor.

  • parent: The parent (project, location and processor) to list all versions.Format: `projects/{project}/locations/{location}/processors/{processor}`.

func (*ProjectsLocationsProcessorsProcessorVersionsService)Process

Process: Processes a single document.

  • name: The resource name of the Processor or ProcessorVersion to use forprocessing. If a Processor is specified, the server will use its defaultversion. Format:`projects/{project}/locations/{location}/processors/{processor}`, or`projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.

func (*ProjectsLocationsProcessorsProcessorVersionsService)Trainadded inv0.108.0

Train: Trains a new processor version. Operation metadata is returned asTrainProcessorVersionMetadata.

  • parent: The parent (project, location and processor) to create the newversion for. Format:`projects/{project}/locations/{location}/processors/{processor}`.

func (*ProjectsLocationsProcessorsProcessorVersionsService)Undeployadded inv0.57.0

Undeploy: Undeploys the processor version.

- name: The processor version resource name to be undeployed.

typeProjectsLocationsProcessorsProcessorVersionsTrainCalladded inv0.108.0

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

func (*ProjectsLocationsProcessorsProcessorVersionsTrainCall)Contextadded inv0.108.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsProcessorsProcessorVersionsTrainCall)Doadded inv0.108.0

Do executes the "documentai.projects.locations.processors.processorVersions.train" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsProcessorsProcessorVersionsTrainCall)Fieldsadded inv0.108.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsProcessorsProcessorVersionsTrainCall)Headeradded inv0.108.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsProcessorsProcessorVersionsUndeployCalladded inv0.57.0

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

func (*ProjectsLocationsProcessorsProcessorVersionsUndeployCall)Contextadded inv0.57.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsProcessorsProcessorVersionsUndeployCall)Doadded inv0.57.0

Do executes the "documentai.projects.locations.processors.processorVersions.undeploy" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsProcessorsProcessorVersionsUndeployCall)Fieldsadded inv0.57.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsProcessorsProcessorVersionsUndeployCall)Headeradded inv0.57.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsProcessorsService

type ProjectsLocationsProcessorsService struct {HumanReviewConfig *ProjectsLocationsProcessorsHumanReviewConfigServiceProcessorVersions *ProjectsLocationsProcessorsProcessorVersionsService// contains filtered or unexported fields}

func (*ProjectsLocationsProcessorsService)BatchProcess

BatchProcess: LRO endpoint to batch process many documents. The output iswritten to Cloud Storage as JSON in the [Document] format.

  • name: The resource name of Processor or ProcessorVersion. Format:`projects/{project}/locations/{location}/processors/{processor}`, or`projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.

func (*ProjectsLocationsProcessorsService)Createadded inv0.57.0

Create: Creates a processor from the ProcessorType provided. The processorwill be at `ENABLED` state by default after its creation. Note that thismethod requires the `documentai.processors.create` permission on theproject, which is highly privileged. A user or service account with thispermission can create new processors that can interact with any gcs bucketin your project.

  • parent: The parent (project and location) under which to create theprocessor. Format: `projects/{project}/locations/{location}`.

func (*ProjectsLocationsProcessorsService)Deleteadded inv0.57.0

Delete: Deletes the processor, unloads all deployed model artifacts if itwas enabled and then deletes all artifacts associated with this processor.

- name: The processor resource name to be deleted.

func (*ProjectsLocationsProcessorsService)Disableadded inv0.57.0

Disable: Disables a processor

- name: The processor resource name to be disabled.

func (*ProjectsLocationsProcessorsService)Enableadded inv0.57.0

Enable: Enables a processor

- name: The processor resource name to be enabled.

func (*ProjectsLocationsProcessorsService)Getadded inv0.57.0

Get: Gets a processor detail.

- name: The processor resource name.

func (*ProjectsLocationsProcessorsService)Listadded inv0.57.0

List: Lists all processors which belong to this project.

  • parent: The parent (project and location) which owns this collection ofProcessors. Format: `projects/{project}/locations/{location}`.

func (*ProjectsLocationsProcessorsService)Process

Process: Processes a single document.

  • name: The resource name of the Processor or ProcessorVersion to use forprocessing. If a Processor is specified, the server will use its defaultversion. Format:`projects/{project}/locations/{location}/processors/{processor}`, or`projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.

func (*ProjectsLocationsProcessorsService)SetDefaultProcessorVersionadded inv0.57.0

func (r *ProjectsLocationsProcessorsService) SetDefaultProcessorVersion(processorstring, googleclouddocumentaiv1setdefaultprocessorversionrequest *GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest) *ProjectsLocationsProcessorsSetDefaultProcessorVersionCall

SetDefaultProcessorVersion: Set the default (active) version of a Processorthat will be used in ProcessDocument and BatchProcessDocuments.

- processor: The resource name of the Processor to change default version.

typeProjectsLocationsProcessorsSetDefaultProcessorVersionCalladded inv0.57.0

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

func (*ProjectsLocationsProcessorsSetDefaultProcessorVersionCall)Contextadded inv0.57.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsProcessorsSetDefaultProcessorVersionCall)Doadded inv0.57.0

Do executes the "documentai.projects.locations.processors.setDefaultProcessorVersion" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsProcessorsSetDefaultProcessorVersionCall)Fieldsadded inv0.57.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsProcessorsSetDefaultProcessorVersionCall)Headeradded inv0.57.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsSchemasCreateCalladded inv0.255.0

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

func (*ProjectsLocationsSchemasCreateCall)Contextadded inv0.255.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsSchemasCreateCall)Doadded inv0.255.0

Do executes the "documentai.projects.locations.schemas.create" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudDocumentaiV1NextSchema.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsSchemasCreateCall)Fieldsadded inv0.255.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsSchemasCreateCall)Headeradded inv0.255.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsSchemasDeleteCalladded inv0.255.0

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

func (*ProjectsLocationsSchemasDeleteCall)Contextadded inv0.255.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsSchemasDeleteCall)Doadded inv0.255.0

Do executes the "documentai.projects.locations.schemas.delete" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsSchemasDeleteCall)Fieldsadded inv0.255.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsSchemasDeleteCall)Forceadded inv0.255.0

Force sets the optional parameter "force": If set to true, any childresources of this Schema will also be deleted. (Otherwise, the request willonly work if the Schema has no child resources.)

func (*ProjectsLocationsSchemasDeleteCall)Headeradded inv0.255.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsSchemasGetCalladded inv0.255.0

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

func (*ProjectsLocationsSchemasGetCall)Contextadded inv0.255.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsSchemasGetCall)Doadded inv0.255.0

Do executes the "documentai.projects.locations.schemas.get" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudDocumentaiV1NextSchema.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsSchemasGetCall)Fieldsadded inv0.255.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsSchemasGetCall)Headeradded inv0.255.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsSchemasGetCall)IfNoneMatchadded inv0.255.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsSchemasListCalladded inv0.255.0

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

func (*ProjectsLocationsSchemasListCall)Contextadded inv0.255.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsSchemasListCall)Doadded inv0.255.0

Do executes the "documentai.projects.locations.schemas.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudDocumentaiV1ListSchemasResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsSchemasListCall)Fieldsadded inv0.255.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsSchemasListCall)Headeradded inv0.255.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsSchemasListCall)IfNoneMatchadded inv0.255.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsSchemasListCall)PageSizeadded inv0.255.0

PageSize sets the optional parameter "pageSize": The maximum number ofschema groups to return. If unspecified, at most `10` Schema will bereturned. The maximum value is `20`. Values above `20` will be coerced to`20`.

func (*ProjectsLocationsSchemasListCall)PageTokenadded inv0.255.0

PageToken sets the optional parameter "pageToken": We will return the schemagroups sorted by creation time. The page token will point to the nextSchema.

func (*ProjectsLocationsSchemasListCall)Pagesadded inv0.255.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsLocationsSchemasPatchCalladded inv0.255.0

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

func (*ProjectsLocationsSchemasPatchCall)Contextadded inv0.255.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsSchemasPatchCall)Doadded inv0.255.0

Do executes the "documentai.projects.locations.schemas.patch" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudDocumentaiV1NextSchema.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsSchemasPatchCall)Fieldsadded inv0.255.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsSchemasPatchCall)Headeradded inv0.255.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsSchemasPatchCall)UpdateMaskadded inv0.255.0

UpdateMask sets the optional parameter "updateMask": The update mask toapply to the resource. **Note:** Only the following fields can be updated: -display_name. - labels.

typeProjectsLocationsSchemasSchemaVersionsCreateCalladded inv0.255.0

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

func (*ProjectsLocationsSchemasSchemaVersionsCreateCall)Contextadded inv0.255.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsSchemasSchemaVersionsCreateCall)Doadded inv0.255.0

Do executes the "documentai.projects.locations.schemas.schemaVersions.create" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudDocumentaiV1SchemaVersion.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsSchemasSchemaVersionsCreateCall)Fieldsadded inv0.255.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsSchemasSchemaVersionsCreateCall)Headeradded inv0.255.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsSchemasSchemaVersionsDeleteCalladded inv0.255.0

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

func (*ProjectsLocationsSchemasSchemaVersionsDeleteCall)Contextadded inv0.255.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsSchemasSchemaVersionsDeleteCall)Doadded inv0.255.0

Do executes the "documentai.projects.locations.schemas.schemaVersions.delete" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsSchemasSchemaVersionsDeleteCall)Fieldsadded inv0.255.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsSchemasSchemaVersionsDeleteCall)Headeradded inv0.255.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsSchemasSchemaVersionsGenerateCalladded inv0.255.0

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

func (*ProjectsLocationsSchemasSchemaVersionsGenerateCall)Contextadded inv0.255.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsSchemasSchemaVersionsGenerateCall)Doadded inv0.255.0

Do executes the "documentai.projects.locations.schemas.schemaVersions.generate" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudDocumentaiV1GenerateSchemaVersionResponse.ServerResponse.Headeror (if a response was returned at all) in error.(*googleapi.Error).Header.Use googleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsSchemasSchemaVersionsGenerateCall)Fieldsadded inv0.255.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsSchemasSchemaVersionsGenerateCall)Headeradded inv0.255.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsSchemasSchemaVersionsGetCalladded inv0.255.0

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

func (*ProjectsLocationsSchemasSchemaVersionsGetCall)Contextadded inv0.255.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsSchemasSchemaVersionsGetCall)Doadded inv0.255.0

Do executes the "documentai.projects.locations.schemas.schemaVersions.get" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudDocumentaiV1SchemaVersion.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsSchemasSchemaVersionsGetCall)Fieldsadded inv0.255.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsSchemasSchemaVersionsGetCall)Headeradded inv0.255.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsSchemasSchemaVersionsGetCall)IfNoneMatchadded inv0.255.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsSchemasSchemaVersionsListCalladded inv0.255.0

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

func (*ProjectsLocationsSchemasSchemaVersionsListCall)Contextadded inv0.255.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsSchemasSchemaVersionsListCall)Doadded inv0.255.0

Do executes the "documentai.projects.locations.schemas.schemaVersions.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudDocumentaiV1ListSchemaVersionsResponse.ServerResponse.Header or(if a response was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsSchemasSchemaVersionsListCall)Fieldsadded inv0.255.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsSchemasSchemaVersionsListCall)Headeradded inv0.255.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsSchemasSchemaVersionsListCall)IfNoneMatchadded inv0.255.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsSchemasSchemaVersionsListCall)PageSizeadded inv0.255.0

PageSize sets the optional parameter "pageSize": The maximum number ofSchemaVersion to return. If unspecified, at most `10` SchemaVersion will bereturned. The maximum value is `20`. Values above `20` will be coerced to`20`.

func (*ProjectsLocationsSchemasSchemaVersionsListCall)PageTokenadded inv0.255.0

PageToken sets the optional parameter "pageToken": We will return theSchemaVersion sorted by creation time. The page token will point to the nextSchemaVersion.

func (*ProjectsLocationsSchemasSchemaVersionsListCall)Pagesadded inv0.255.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsLocationsSchemasSchemaVersionsPatchCalladded inv0.255.0

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

func (*ProjectsLocationsSchemasSchemaVersionsPatchCall)Contextadded inv0.255.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsSchemasSchemaVersionsPatchCall)Doadded inv0.255.0

Do executes the "documentai.projects.locations.schemas.schemaVersions.patch" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudDocumentaiV1SchemaVersion.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsSchemasSchemaVersionsPatchCall)Fieldsadded inv0.255.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsSchemasSchemaVersionsPatchCall)Headeradded inv0.255.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsSchemasSchemaVersionsPatchCall)UpdateMaskadded inv0.255.0

UpdateMask sets the optional parameter "updateMask": The update mask toapply to the resource. **Note:** Only the following fields can be updated: -display_name. - labels.

typeProjectsLocationsSchemasSchemaVersionsServiceadded inv0.255.0

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

funcNewProjectsLocationsSchemasSchemaVersionsServiceadded inv0.255.0

func NewProjectsLocationsSchemasSchemaVersionsService(s *Service) *ProjectsLocationsSchemasSchemaVersionsService

func (*ProjectsLocationsSchemasSchemaVersionsService)Createadded inv0.255.0

Create: Creates a schema version.

  • parent: The parent (project and location) under which to create theSchemaVersion. Format:`projects/{project}/locations/{location}/schemas/{schema}`.

func (*ProjectsLocationsSchemasSchemaVersionsService)Deleteadded inv0.255.0

Delete: Deletes a schema version.

  • name: The name of the SchemaVersion to delete. Format:`projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`.

func (*ProjectsLocationsSchemasSchemaVersionsService)Generateadded inv0.255.0

Generate: Generates a schema version.

  • parent: The parent (project, location and schema) under which to generatethe SchemaVersion. Format:`projects/{project}/locations/{location}/schemas/{schema}`.

func (*ProjectsLocationsSchemasSchemaVersionsService)Getadded inv0.255.0

Get: Gets a schema version.

  • name: The name of the SchemaVersion to get. Format:`projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`.

func (*ProjectsLocationsSchemasSchemaVersionsService)Listadded inv0.255.0

List: Lists SchemaVersions.

- parent: Format: `projects/{project}/locations/{location}/schemas/{schema}`.

func (*ProjectsLocationsSchemasSchemaVersionsService)Patchadded inv0.255.0

Patch: Updates a schema version. Editable fields are: - `display_name` -`labels`

  • name: Identifier. The resource name of the SchemaVersion. Format:`projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`.

typeProjectsLocationsSchemasServiceadded inv0.255.0

type ProjectsLocationsSchemasService struct {SchemaVersions *ProjectsLocationsSchemasSchemaVersionsService// contains filtered or unexported fields}

funcNewProjectsLocationsSchemasServiceadded inv0.255.0

func NewProjectsLocationsSchemasService(s *Service) *ProjectsLocationsSchemasService

func (*ProjectsLocationsSchemasService)Createadded inv0.255.0

Create: Creates a schema.

  • parent: The parent (project and location) under which to create theSchema. Format: `projects/{project}/locations/{location}`.

func (*ProjectsLocationsSchemasService)Deleteadded inv0.255.0

Delete: Deletes a schema.

  • name: The name of the Schema to be deleted. Format:`projects/{project}/locations/{location}/schemas/{schema}`.

func (*ProjectsLocationsSchemasService)Getadded inv0.255.0

Get: Gets a schema.

  • name: The name of the Schema to get. Format:`projects/{project}/locations/{location}/schemas/{schema}`.

func (*ProjectsLocationsSchemasService)Listadded inv0.255.0

List: Lists Schemas.

- parent: Format: `projects/{project}/locations/{location}`.

func (*ProjectsLocationsSchemasService)Patchadded inv0.255.0

Patch: Updates a schema. Editable fields are: - `display_name` - `labels`

  • name: Identifier. The resource name of the Schema. Format:`projects/{project}/locations/{location}/schemas/{schema}`.

typeProjectsLocationsService

type ProjectsLocationsService struct {Operations *ProjectsLocationsOperationsServiceProcessorTypes *ProjectsLocationsProcessorTypesServiceProcessors *ProjectsLocationsProcessorsServiceSchemas *ProjectsLocationsSchemasService// contains filtered or unexported fields}

funcNewProjectsLocationsService

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService)FetchProcessorTypesadded inv0.57.0

FetchProcessorTypes: Fetches processor types. Note that we don't useListProcessorTypes here, because it isn't paginated.

  • parent: The location of processor types to list. Format:`projects/{project}/locations/{location}`.

func (*ProjectsLocationsService)Get

Get: Gets information about a location.

- name: Resource name for the location.

func (*ProjectsLocationsService)List

List: Lists information about the supported locations for this service.

- name: The resource that owns the locations collection, if applicable.

typeProjectsOperationsGetCall

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

func (*ProjectsOperationsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsOperationsGetCall)Do

Do executes the "documentai.projects.operations.get" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsOperationsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsOperationsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsOperationsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsOperationsService

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

funcNewProjectsOperationsService

func NewProjectsOperationsService(s *Service) *ProjectsOperationsService

func (*ProjectsOperationsService)Get

Get: Gets the latest state of a long-running operation. Clients can use thismethod to poll the operation result at intervals as recommended by the APIservice.

- name: The name of the operation resource.

typeProjectsService

type ProjectsService struct {Locations *ProjectsLocationsServiceOperations *ProjectsOperationsService// contains filtered or unexported fields}

funcNewProjectsService

func NewProjectsService(s *Service) *ProjectsService

typeService

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentOperations *OperationsServiceProjects *ProjectsService// contains filtered or unexported fields}

funcNewdeprecated

func New(client *http.Client) (*Service,error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead.To provide a custom HTTP client, use option.WithHTTPClient.If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

funcNewService

func NewService(ctxcontext.Context, opts ...option.ClientOption) (*Service,error)

NewService creates a new Service.

Source Files

View all Source files

Jump to

Keyboard shortcuts

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

[8]ページ先頭

©2009-2025 Movatter.jp