Documentation
¶
Overview ¶
Package documentai provides access to the Cloud Document AI API.
For product documentation, see: https://cloud.google.com/document-ai/docs/
Creating a client ¶
Usage example:
import "google.golang.org/api/documentai/v1beta3" ... ctx := context.Background() documentaiService, err := documentai.NewService(ctx)
In this example, Google Application Default Credentials are used for authentication.
For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.
Other authentication options ¶
To use an API key for authentication (note: some APIs do not support API keys), use 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 OAuth flow), use option.WithTokenSource:
config := &oauth2.Config{...} // ... token, err := config.Exchange(ctx, ...) documentaiService, err := documentai.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
See https://godoc.org/google.golang.org/api/option/ for details on options.
Index ¶
- Constants
- type GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata
- type GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata
- type GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata
- type GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata
- type GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata
- type GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata
- type GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse
- type GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata
- type GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse
- type GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata
- type GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse
- type GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata
- type GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse
- type GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata
- type GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse
- type GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata
- type GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation
- type GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse
- type GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata
- type GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse
- type GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata
- type GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata
- type GoogleCloudDocumentaiV1BatchProcessMetadata
- type GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus
- type GoogleCloudDocumentaiV1BatchProcessResponse
- type GoogleCloudDocumentaiV1CommonOperationMetadata
- type GoogleCloudDocumentaiV1HumanReviewStatus
- type GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata
- type GoogleCloudDocumentaiV1ReviewDocumentResponse
- type GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse
- type GoogleCloudDocumentaiV1beta1BoundingPoly
- type GoogleCloudDocumentaiV1beta1Document
- type GoogleCloudDocumentaiV1beta1DocumentEntity
- type GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue
- type GoogleCloudDocumentaiV1beta1DocumentEntityRelation
- type GoogleCloudDocumentaiV1beta1DocumentPage
- type GoogleCloudDocumentaiV1beta1DocumentPageAnchor
- type GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef
- type GoogleCloudDocumentaiV1beta1DocumentPageBlock
- type GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage
- type GoogleCloudDocumentaiV1beta1DocumentPageDimension
- type GoogleCloudDocumentaiV1beta1DocumentPageFormField
- type GoogleCloudDocumentaiV1beta1DocumentPageImage
- type GoogleCloudDocumentaiV1beta1DocumentPageLayout
- type GoogleCloudDocumentaiV1beta1DocumentPageLine
- type GoogleCloudDocumentaiV1beta1DocumentPageMatrix
- type GoogleCloudDocumentaiV1beta1DocumentPageParagraph
- type GoogleCloudDocumentaiV1beta1DocumentPageTable
- type GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell
- type GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow
- type GoogleCloudDocumentaiV1beta1DocumentPageToken
- type GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak
- type GoogleCloudDocumentaiV1beta1DocumentPageVisualElement
- type GoogleCloudDocumentaiV1beta1DocumentProvenance
- type GoogleCloudDocumentaiV1beta1DocumentProvenanceParent
- type GoogleCloudDocumentaiV1beta1DocumentRevision
- type GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview
- type GoogleCloudDocumentaiV1beta1DocumentShardInfo
- type GoogleCloudDocumentaiV1beta1DocumentStyle
- type GoogleCloudDocumentaiV1beta1DocumentStyleFontSize
- type GoogleCloudDocumentaiV1beta1DocumentTextAnchor
- type GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment
- type GoogleCloudDocumentaiV1beta1DocumentTextChange
- type GoogleCloudDocumentaiV1beta1GcsDestination
- type GoogleCloudDocumentaiV1beta1GcsSource
- type GoogleCloudDocumentaiV1beta1InputConfig
- type GoogleCloudDocumentaiV1beta1NormalizedVertex
- type GoogleCloudDocumentaiV1beta1OperationMetadata
- type GoogleCloudDocumentaiV1beta1OutputConfig
- type GoogleCloudDocumentaiV1beta1ProcessDocumentResponse
- type GoogleCloudDocumentaiV1beta1Vertex
- type GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse
- type GoogleCloudDocumentaiV1beta2BoundingPoly
- type GoogleCloudDocumentaiV1beta2Document
- type GoogleCloudDocumentaiV1beta2DocumentEntity
- type GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue
- type GoogleCloudDocumentaiV1beta2DocumentEntityRelation
- type GoogleCloudDocumentaiV1beta2DocumentLabel
- type GoogleCloudDocumentaiV1beta2DocumentPage
- type GoogleCloudDocumentaiV1beta2DocumentPageAnchor
- type GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef
- type GoogleCloudDocumentaiV1beta2DocumentPageBlock
- type GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage
- type GoogleCloudDocumentaiV1beta2DocumentPageDimension
- type GoogleCloudDocumentaiV1beta2DocumentPageFormField
- type GoogleCloudDocumentaiV1beta2DocumentPageImage
- type GoogleCloudDocumentaiV1beta2DocumentPageLayout
- type GoogleCloudDocumentaiV1beta2DocumentPageLine
- type GoogleCloudDocumentaiV1beta2DocumentPageMatrix
- type GoogleCloudDocumentaiV1beta2DocumentPageParagraph
- type GoogleCloudDocumentaiV1beta2DocumentPageTable
- type GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell
- type GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow
- type GoogleCloudDocumentaiV1beta2DocumentPageToken
- type GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak
- type GoogleCloudDocumentaiV1beta2DocumentPageVisualElement
- type GoogleCloudDocumentaiV1beta2DocumentProvenance
- type GoogleCloudDocumentaiV1beta2DocumentProvenanceParent
- type GoogleCloudDocumentaiV1beta2DocumentRevision
- type GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview
- type GoogleCloudDocumentaiV1beta2DocumentShardInfo
- type GoogleCloudDocumentaiV1beta2DocumentStyle
- type GoogleCloudDocumentaiV1beta2DocumentStyleFontSize
- type GoogleCloudDocumentaiV1beta2DocumentTextAnchor
- type GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment
- type GoogleCloudDocumentaiV1beta2DocumentTextChange
- type GoogleCloudDocumentaiV1beta2GcsDestination
- type GoogleCloudDocumentaiV1beta2GcsSource
- type GoogleCloudDocumentaiV1beta2InputConfig
- type GoogleCloudDocumentaiV1beta2NormalizedVertex
- type GoogleCloudDocumentaiV1beta2OperationMetadata
- type GoogleCloudDocumentaiV1beta2OutputConfig
- type GoogleCloudDocumentaiV1beta2ProcessDocumentResponse
- type GoogleCloudDocumentaiV1beta2Vertex
- type GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig
- type GoogleCloudDocumentaiV1beta3BatchProcessMetadata
- type GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus
- type GoogleCloudDocumentaiV1beta3BatchProcessRequest
- type GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig
- type GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig
- type GoogleCloudDocumentaiV1beta3BatchProcessResponse
- type GoogleCloudDocumentaiV1beta3BoundingPoly
- type GoogleCloudDocumentaiV1beta3CommonOperationMetadata
- type GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata
- type GoogleCloudDocumentaiV1beta3DisableProcessorMetadata
- type GoogleCloudDocumentaiV1beta3DisableProcessorRequest
- type GoogleCloudDocumentaiV1beta3DisableProcessorResponse
- type GoogleCloudDocumentaiV1beta3Document
- type GoogleCloudDocumentaiV1beta3DocumentEntity
- type GoogleCloudDocumentaiV1beta3DocumentEntityNormalizedValue
- type GoogleCloudDocumentaiV1beta3DocumentEntityRelation
- type GoogleCloudDocumentaiV1beta3DocumentOutputConfig
- type GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfig
- type GoogleCloudDocumentaiV1beta3DocumentPage
- type GoogleCloudDocumentaiV1beta3DocumentPageAnchor
- type GoogleCloudDocumentaiV1beta3DocumentPageAnchorPageRef
- type GoogleCloudDocumentaiV1beta3DocumentPageBlock
- type GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage
- type GoogleCloudDocumentaiV1beta3DocumentPageDimension
- type GoogleCloudDocumentaiV1beta3DocumentPageFormField
- type GoogleCloudDocumentaiV1beta3DocumentPageImage
- type GoogleCloudDocumentaiV1beta3DocumentPageLayout
- type GoogleCloudDocumentaiV1beta3DocumentPageLine
- type GoogleCloudDocumentaiV1beta3DocumentPageMatrix
- type GoogleCloudDocumentaiV1beta3DocumentPageParagraph
- type GoogleCloudDocumentaiV1beta3DocumentPageTable
- type GoogleCloudDocumentaiV1beta3DocumentPageTableTableCell
- type GoogleCloudDocumentaiV1beta3DocumentPageTableTableRow
- type GoogleCloudDocumentaiV1beta3DocumentPageToken
- type GoogleCloudDocumentaiV1beta3DocumentPageTokenDetectedBreak
- type GoogleCloudDocumentaiV1beta3DocumentPageVisualElement
- type GoogleCloudDocumentaiV1beta3DocumentProvenance
- type GoogleCloudDocumentaiV1beta3DocumentProvenanceParent
- type GoogleCloudDocumentaiV1beta3DocumentRevision
- type GoogleCloudDocumentaiV1beta3DocumentRevisionHumanReview
- type GoogleCloudDocumentaiV1beta3DocumentShardInfo
- type GoogleCloudDocumentaiV1beta3DocumentStyle
- type GoogleCloudDocumentaiV1beta3DocumentStyleFontSize
- type GoogleCloudDocumentaiV1beta3DocumentTextAnchor
- type GoogleCloudDocumentaiV1beta3DocumentTextAnchorTextSegment
- type GoogleCloudDocumentaiV1beta3DocumentTextChange
- type GoogleCloudDocumentaiV1beta3EnableProcessorMetadata
- type GoogleCloudDocumentaiV1beta3EnableProcessorRequest
- type GoogleCloudDocumentaiV1beta3EnableProcessorResponse
- type GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse
- type GoogleCloudDocumentaiV1beta3GcsDocument
- type GoogleCloudDocumentaiV1beta3GcsDocuments
- type GoogleCloudDocumentaiV1beta3GcsPrefix
- type GoogleCloudDocumentaiV1beta3HumanReviewStatus
- type GoogleCloudDocumentaiV1beta3ListProcessorsResponse
- type GoogleCloudDocumentaiV1beta3NormalizedVertex
- type GoogleCloudDocumentaiV1beta3ProcessRequest
- type GoogleCloudDocumentaiV1beta3ProcessResponse
- type GoogleCloudDocumentaiV1beta3Processor
- type GoogleCloudDocumentaiV1beta3ProcessorType
- type GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo
- type GoogleCloudDocumentaiV1beta3RawDocument
- type GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata
- type GoogleCloudDocumentaiV1beta3ReviewDocumentRequest
- type GoogleCloudDocumentaiV1beta3ReviewDocumentResponse
- type GoogleCloudDocumentaiV1beta3Schema
- type GoogleCloudDocumentaiV1beta3SchemaEntityType
- type GoogleCloudDocumentaiV1beta3Vertex
- type GoogleCloudLocationListLocationsResponse
- type GoogleCloudLocationLocation
- type GoogleLongrunningListOperationsResponse
- type GoogleLongrunningOperation
- type GoogleProtobufEmpty
- type GoogleRpcStatus
- type GoogleTypeColor
- type GoogleTypeDate
- type GoogleTypeDateTime
- type GoogleTypeMoney
- type GoogleTypePostalAddress
- type GoogleTypeTimeZone
- type ProjectsLocationsFetchProcessorTypesCall
- func (c *ProjectsLocationsFetchProcessorTypesCall) Context(ctx context.Context) *ProjectsLocationsFetchProcessorTypesCall
- func (c *ProjectsLocationsFetchProcessorTypesCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse, error)
- func (c *ProjectsLocationsFetchProcessorTypesCall) Fields(s ...googleapi.Field) *ProjectsLocationsFetchProcessorTypesCall
- func (c *ProjectsLocationsFetchProcessorTypesCall) Header() http.Header
- func (c *ProjectsLocationsFetchProcessorTypesCall) IfNoneMatch(entityTag string) *ProjectsLocationsFetchProcessorTypesCall
- type ProjectsLocationsGetCall
- func (c *ProjectsLocationsGetCall) Context(ctx context.Context) *ProjectsLocationsGetCall
- func (c *ProjectsLocationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleCloudLocationLocation, error)
- func (c *ProjectsLocationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsGetCall
- func (c *ProjectsLocationsGetCall) Header() http.Header
- func (c *ProjectsLocationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsGetCall
- type ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) Context(ctx context.Context) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) Do(opts ...googleapi.CallOption) (*GoogleCloudLocationListLocationsResponse, error)
- func (c *ProjectsLocationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) Filter(filter string) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) Header() http.Header
- func (c *ProjectsLocationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) PageSize(pageSize int64) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) PageToken(pageToken string) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) Pages(ctx context.Context, f func(*GoogleCloudLocationListLocationsResponse) error) error
- type ProjectsLocationsOperationsCancelOperationCall
- func (c *ProjectsLocationsOperationsCancelOperationCall) Context(ctx context.Context) *ProjectsLocationsOperationsCancelOperationCall
- func (c *ProjectsLocationsOperationsCancelOperationCall) Do(opts ...googleapi.CallOption) (*GoogleProtobufEmpty, error)
- func (c *ProjectsLocationsOperationsCancelOperationCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsCancelOperationCall
- func (c *ProjectsLocationsOperationsCancelOperationCall) Header() http.Header
- type ProjectsLocationsOperationsGetCall
- func (c *ProjectsLocationsOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsOperationsGetCall
- func (c *ProjectsLocationsOperationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
- func (c *ProjectsLocationsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsGetCall
- func (c *ProjectsLocationsOperationsGetCall) Header() http.Header
- func (c *ProjectsLocationsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsGetCall
- type ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Context(ctx context.Context) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningListOperationsResponse, error)
- func (c *ProjectsLocationsOperationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Filter(filter string) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Header() http.Header
- func (c *ProjectsLocationsOperationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) PageSize(pageSize int64) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Pages(ctx context.Context, f func(*GoogleLongrunningListOperationsResponse) error) error
- type ProjectsLocationsOperationsService
- func (r *ProjectsLocationsOperationsService) CancelOperation(name string) *ProjectsLocationsOperationsCancelOperationCall
- func (r *ProjectsLocationsOperationsService) Get(name string) *ProjectsLocationsOperationsGetCall
- func (r *ProjectsLocationsOperationsService) List(name string) *ProjectsLocationsOperationsListCall
- type ProjectsLocationsProcessorsBatchProcessCall
- func (c *ProjectsLocationsProcessorsBatchProcessCall) Context(ctx context.Context) *ProjectsLocationsProcessorsBatchProcessCall
- func (c *ProjectsLocationsProcessorsBatchProcessCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
- func (c *ProjectsLocationsProcessorsBatchProcessCall) Fields(s ...googleapi.Field) *ProjectsLocationsProcessorsBatchProcessCall
- func (c *ProjectsLocationsProcessorsBatchProcessCall) Header() http.Header
- type ProjectsLocationsProcessorsCreateCall
- func (c *ProjectsLocationsProcessorsCreateCall) Context(ctx context.Context) *ProjectsLocationsProcessorsCreateCall
- func (c *ProjectsLocationsProcessorsCreateCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDocumentaiV1beta3Processor, error)
- func (c *ProjectsLocationsProcessorsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsProcessorsCreateCall
- func (c *ProjectsLocationsProcessorsCreateCall) Header() http.Header
- type ProjectsLocationsProcessorsDeleteCall
- func (c *ProjectsLocationsProcessorsDeleteCall) Context(ctx context.Context) *ProjectsLocationsProcessorsDeleteCall
- func (c *ProjectsLocationsProcessorsDeleteCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
- func (c *ProjectsLocationsProcessorsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsProcessorsDeleteCall
- func (c *ProjectsLocationsProcessorsDeleteCall) Header() http.Header
- type ProjectsLocationsProcessorsDisableCall
- func (c *ProjectsLocationsProcessorsDisableCall) Context(ctx context.Context) *ProjectsLocationsProcessorsDisableCall
- func (c *ProjectsLocationsProcessorsDisableCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
- func (c *ProjectsLocationsProcessorsDisableCall) Fields(s ...googleapi.Field) *ProjectsLocationsProcessorsDisableCall
- func (c *ProjectsLocationsProcessorsDisableCall) Header() http.Header
- type ProjectsLocationsProcessorsEnableCall
- func (c *ProjectsLocationsProcessorsEnableCall) Context(ctx context.Context) *ProjectsLocationsProcessorsEnableCall
- func (c *ProjectsLocationsProcessorsEnableCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
- func (c *ProjectsLocationsProcessorsEnableCall) Fields(s ...googleapi.Field) *ProjectsLocationsProcessorsEnableCall
- func (c *ProjectsLocationsProcessorsEnableCall) Header() http.Header
- type ProjectsLocationsProcessorsHumanReviewConfigReviewDocumentCall
- func (c *ProjectsLocationsProcessorsHumanReviewConfigReviewDocumentCall) Context(ctx context.Context) *ProjectsLocationsProcessorsHumanReviewConfigReviewDocumentCall
- func (c *ProjectsLocationsProcessorsHumanReviewConfigReviewDocumentCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
- func (c *ProjectsLocationsProcessorsHumanReviewConfigReviewDocumentCall) Fields(s ...googleapi.Field) *ProjectsLocationsProcessorsHumanReviewConfigReviewDocumentCall
- func (c *ProjectsLocationsProcessorsHumanReviewConfigReviewDocumentCall) Header() http.Header
- type ProjectsLocationsProcessorsHumanReviewConfigService
- type ProjectsLocationsProcessorsListCall
- func (c *ProjectsLocationsProcessorsListCall) Context(ctx context.Context) *ProjectsLocationsProcessorsListCall
- func (c *ProjectsLocationsProcessorsListCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDocumentaiV1beta3ListProcessorsResponse, error)
- func (c *ProjectsLocationsProcessorsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsProcessorsListCall
- func (c *ProjectsLocationsProcessorsListCall) Header() http.Header
- func (c *ProjectsLocationsProcessorsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsProcessorsListCall
- func (c *ProjectsLocationsProcessorsListCall) PageSize(pageSize int64) *ProjectsLocationsProcessorsListCall
- func (c *ProjectsLocationsProcessorsListCall) PageToken(pageToken string) *ProjectsLocationsProcessorsListCall
- func (c *ProjectsLocationsProcessorsListCall) Pages(ctx context.Context, ...) error
- type ProjectsLocationsProcessorsProcessCall
- func (c *ProjectsLocationsProcessorsProcessCall) Context(ctx context.Context) *ProjectsLocationsProcessorsProcessCall
- func (c *ProjectsLocationsProcessorsProcessCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDocumentaiV1beta3ProcessResponse, error)
- func (c *ProjectsLocationsProcessorsProcessCall) Fields(s ...googleapi.Field) *ProjectsLocationsProcessorsProcessCall
- func (c *ProjectsLocationsProcessorsProcessCall) Header() http.Header
- type ProjectsLocationsProcessorsProcessorVersionsBatchProcessCall
- func (c *ProjectsLocationsProcessorsProcessorVersionsBatchProcessCall) Context(ctx context.Context) *ProjectsLocationsProcessorsProcessorVersionsBatchProcessCall
- func (c *ProjectsLocationsProcessorsProcessorVersionsBatchProcessCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
- func (c *ProjectsLocationsProcessorsProcessorVersionsBatchProcessCall) Fields(s ...googleapi.Field) *ProjectsLocationsProcessorsProcessorVersionsBatchProcessCall
- func (c *ProjectsLocationsProcessorsProcessorVersionsBatchProcessCall) Header() http.Header
- type ProjectsLocationsProcessorsProcessorVersionsProcessCall
- func (c *ProjectsLocationsProcessorsProcessorVersionsProcessCall) Context(ctx context.Context) *ProjectsLocationsProcessorsProcessorVersionsProcessCall
- func (c *ProjectsLocationsProcessorsProcessorVersionsProcessCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDocumentaiV1beta3ProcessResponse, error)
- func (c *ProjectsLocationsProcessorsProcessorVersionsProcessCall) Fields(s ...googleapi.Field) *ProjectsLocationsProcessorsProcessorVersionsProcessCall
- func (c *ProjectsLocationsProcessorsProcessorVersionsProcessCall) Header() http.Header
- type ProjectsLocationsProcessorsProcessorVersionsService
- type ProjectsLocationsProcessorsService
- func (r *ProjectsLocationsProcessorsService) BatchProcess(name string, ...) *ProjectsLocationsProcessorsBatchProcessCall
- func (r *ProjectsLocationsProcessorsService) Create(parent string, ...) *ProjectsLocationsProcessorsCreateCall
- func (r *ProjectsLocationsProcessorsService) Delete(name string) *ProjectsLocationsProcessorsDeleteCall
- func (r *ProjectsLocationsProcessorsService) Disable(name string, ...) *ProjectsLocationsProcessorsDisableCall
- func (r *ProjectsLocationsProcessorsService) Enable(name string, ...) *ProjectsLocationsProcessorsEnableCall
- func (r *ProjectsLocationsProcessorsService) List(parent string) *ProjectsLocationsProcessorsListCall
- func (r *ProjectsLocationsProcessorsService) Process(name string, ...) *ProjectsLocationsProcessorsProcessCall
- type ProjectsLocationsService
- type ProjectsService
- type Service
Constants ¶
const (
// See, edit, configure, and delete your Google Cloud Platform data
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 ¶
type GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata ¶ added in v0.37.0
type GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata struct { // CreateTime: The creation time of the operation. CreateTime string `json:"createTime,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. State string `json:"state,omitempty"` // StateMessage: A message providing more details about the current // state of processing. StateMessage string `json:"stateMessage,omitempty"` // UpdateTime: The last update time of the operation. UpdateTime string `json:"updateTime,omitempty"` // ForceSendFields is a list of field names (e.g. "CreateTime") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata: The common metadata for long running operations.
func (*GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata) MarshalJSON ¶ added in v0.37.0
func (s *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata ¶
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata: The long running operation metadata for CreateLabelerPool.
func (*GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata) MarshalJSON ¶
func (s *GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata ¶
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata: The long running operation metadata for DeleteLabelerPool.
func (*GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata) MarshalJSON ¶
func (s *GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata ¶
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata: The long running operation metadata for delete processor method.
func (*GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata) MarshalJSON ¶
func (s *GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata ¶ added in v0.37.0
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata: The long running operation metadata for delete processor version method.
func (*GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata) MarshalJSON ¶ added in v0.37.0
func (s *GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata ¶ added in v0.37.0
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata: The long running operation metadata for deploy processor version method.
func (*GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata) MarshalJSON ¶ added in v0.37.0
func (s *GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse ¶ added in v0.37.0
type GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse struct { }
GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse: Response message for the deploy processor version method.
type GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata ¶
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata: The long running operation metadata for disable processor method.
func (*GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata) MarshalJSON ¶
func (s *GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse ¶
type GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse struct { }
GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse: Response message for the disable processor method. Intentionally empty proto for adding fields in future.
type GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata ¶
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata: The long running operation metadata for enable processor method.
func (*GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata) MarshalJSON ¶
func (s *GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse ¶
type GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse struct { }
GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse: Response message for the enable processor method. Intentionally empty proto for adding fields in future.
type GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata ¶ added in v0.38.0
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata: Metadata of the EvaluateProcessorVersion method.
func (*GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata) MarshalJSON ¶ added in v0.38.0
func (s *GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse ¶ added in v0.38.0
type GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse struct { // Evaluation: The resource name of the created evaluation. Evaluation string `json:"evaluation,omitempty"` // ForceSendFields is a list of field names (e.g. "Evaluation") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse: Metadata of the EvaluateProcessorVersion method.
func (*GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse) MarshalJSON ¶ added in v0.38.0
func (s *GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata ¶ added in v0.41.0
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata: The long running operation metadata for set default processor version method.
func (*GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata) MarshalJSON ¶ added in v0.41.0
func (s *GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse ¶ added in v0.41.0
type GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse struct { }
GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse: Response message for set default processor version method.
type GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata ¶ added in v0.37.0
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata: The metadata that represents a processor version being created.
func (*GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata) MarshalJSON ¶ added in v0.37.0
func (s *GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation ¶ added in v0.41.0
type GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation struct { // DatasetErrorCount: The total number of dataset errors. DatasetErrorCount int64 `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. DocumentErrorCount int64 `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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetVali dation: The dataset validation information. This includes any and all errors with documents and the dataset.
func (*GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation) MarshalJSON ¶ added in v0.41.0
func (s *GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse ¶ added in v0.37.0
type GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse struct { // ProcessorVersion: The resource name of the processor version produced // by training. ProcessorVersion string `json:"processorVersion,omitempty"` // ForceSendFields is a list of field names (e.g. "ProcessorVersion") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse: The response for the TrainProcessorVersion method.
func (*GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse) MarshalJSON ¶ added in v0.37.0
func (s *GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata ¶ added in v0.37.0
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata: The long running operation metadata for the undeploy processor version method.
func (*GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata) MarshalJSON ¶ added in v0.37.0
func (s *GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse ¶ added in v0.37.0
type GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse struct { }
GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse: Response message for the undeploy processor version method.
type GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata ¶ added in v0.37.0
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata: The long running operation metadata for updating the human review configuration.
func (*GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata) MarshalJSON ¶ added in v0.37.0
func (s *GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata ¶
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata: The long running operation metadata for UpdateLabelerPool.
func (*GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata) MarshalJSON ¶
func (s *GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1BatchProcessMetadata ¶ added in v0.37.0
type GoogleCloudDocumentaiV1BatchProcessMetadata struct { // CreateTime: The creation time of the operation. CreateTime string `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. State string `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. StateMessage string `json:"stateMessage,omitempty"` // UpdateTime: The last update time of the operation. UpdateTime string `json:"updateTime,omitempty"` // ForceSendFields is a list of field names (e.g. "CreateTime") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1BatchProcessMetadata: The long running operation metadata for batch process method.
func (*GoogleCloudDocumentaiV1BatchProcessMetadata) MarshalJSON ¶ added in v0.37.0
func (s *GoogleCloudDocumentaiV1BatchProcessMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus ¶ added in v0.37.0
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. The batch process is started by take snapshot of that // document, since a user can move or change that document during the // process. InputGcsSource string `json:"inputGcsSource,omitempty"` // OutputGcsDestination: The output_gcs_destination (in the request as // 'output_gcs_destination') of the processed document if it was // successful, otherwise empty. OutputGcsDestination string `json:"outputGcsDestination,omitempty"` // Status: The status of the processing of 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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus: The status of a each individual document in the batch process.
func (*GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus) MarshalJSON ¶ added in v0.37.0
func (s *GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1BatchProcessResponse ¶ added in v0.37.0
type GoogleCloudDocumentaiV1BatchProcessResponse struct { }
GoogleCloudDocumentaiV1BatchProcessResponse: Response message for batch process document method.
type GoogleCloudDocumentaiV1CommonOperationMetadata ¶ added in v0.37.0
type GoogleCloudDocumentaiV1CommonOperationMetadata struct { // CreateTime: The creation time of the operation. CreateTime string `json:"createTime,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. State string `json:"state,omitempty"` // StateMessage: A message providing more details about the current // state of processing. StateMessage string `json:"stateMessage,omitempty"` // UpdateTime: The last update time of the operation. UpdateTime string `json:"updateTime,omitempty"` // ForceSendFields is a list of field names (e.g. "CreateTime") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1CommonOperationMetadata: The common metadata for long running operations.
func (*GoogleCloudDocumentaiV1CommonOperationMetadata) MarshalJSON ¶ added in v0.37.0
func (s *GoogleCloudDocumentaiV1CommonOperationMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1HumanReviewStatus ¶ added in v0.37.0
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] // method. HumanReviewOperation string `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 is not 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. State string `json:"state,omitempty"` // StateMessage: A message providing more details about the human review // state. StateMessage string `json:"stateMessage,omitempty"` // ForceSendFields is a list of field names (e.g. // "HumanReviewOperation") to unconditionally include in API requests. // By default, fields with empty values are omitted from API requests. // However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1HumanReviewStatus: The status of human review on a processed document.
func (*GoogleCloudDocumentaiV1HumanReviewStatus) MarshalJSON ¶ added in v0.37.0
func (s *GoogleCloudDocumentaiV1HumanReviewStatus) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata ¶ added in v0.37.0
type GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata 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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata: The long running operation metadata for review document method.
func (*GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata) MarshalJSON ¶ added in v0.37.0
func (s *GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1ReviewDocumentResponse ¶ added in v0.37.0
type GoogleCloudDocumentaiV1ReviewDocumentResponse struct { // GcsDestination: The Cloud Storage uri for the human reviewed // document. GcsDestination string `json:"gcsDestination,omitempty"` // ForceSendFields is a list of field names (e.g. "GcsDestination") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1ReviewDocumentResponse: Response message for review document method.
func (*GoogleCloudDocumentaiV1ReviewDocumentResponse) MarshalJSON ¶ added in v0.37.0
func (s *GoogleCloudDocumentaiV1ReviewDocumentResponse) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse ¶
type GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse struct { // Responses: Responses for each individual document. Responses []*GoogleCloudDocumentaiV1beta1ProcessDocumentResponse `json:"responses,omitempty"` // ForceSendFields is a list of field names (e.g. "Responses") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Responses") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse: Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.
func (*GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1BoundingPoly ¶
type GoogleCloudDocumentaiV1beta1BoundingPoly struct { // NormalizedVertices: The bounding polygon normalized vertices. NormalizedVertices []*GoogleCloudDocumentaiV1beta1NormalizedVertex `json:"normalizedVertices,omitempty"` // Vertices: The bounding polygon vertices. Vertices []*GoogleCloudDocumentaiV1beta1Vertex `json:"vertices,omitempty"` // ForceSendFields is a list of field names (e.g. "NormalizedVertices") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1BoundingPoly: A bounding polygon for the detected image annotation.
func (*GoogleCloudDocumentaiV1beta1BoundingPoly) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1BoundingPoly) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1Document ¶
type GoogleCloudDocumentaiV1beta1Document struct { // 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. Content string `json:"content,omitempty"` // Entities: A list of entities detected on Document.text. For document // shards, entities in this list may cross shard boundaries. Entities []*GoogleCloudDocumentaiV1beta1DocumentEntity `json:"entities,omitempty"` // EntityRelations: Relationship among Document.entities. EntityRelations []*GoogleCloudDocumentaiV1beta1DocumentEntityRelation `json:"entityRelations,omitempty"` // Error: Any error that occurred while processing this document. Error *GoogleRpcStatus `json:"error,omitempty"` // MimeType: An IANA published MIME type (also referred to as media // type). For more information, see // https://www.iana.org/assignments/media-types/media-types.xhtml. MimeType string `json:"mimeType,omitempty"` // Pages: Visual page layout for the Document. Pages []*GoogleCloudDocumentaiV1beta1DocumentPage `json:"pages,omitempty"` // Revisions: Revision history of this document. Revisions []*GoogleCloudDocumentaiV1beta1DocumentRevision `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 *GoogleCloudDocumentaiV1beta1DocumentShardInfo `json:"shardInfo,omitempty"` // Text: Optional. UTF-8 encoded text in reading order from the // document. Text string `json:"text,omitempty"` // TextChanges: 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 []*GoogleCloudDocumentaiV1beta1DocumentTextChange `json:"textChanges,omitempty"` // TextStyles: Styles for the Document.text. TextStyles []*GoogleCloudDocumentaiV1beta1DocumentStyle `json:"textStyles,omitempty"` // Uri: Optional. Currently supports Google Cloud Storage URI of the // form `gs://bucket_name/object_name`. Object versioning is not // supported. See Google Cloud Storage Request URIs // (https://cloud.google.com/storage/docs/reference-uris) for more info. Uri string `json:"uri,omitempty"` // ForceSendFields is a list of field names (e.g. "Content") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1Document: Document represents the canonical document resource in Document Understanding AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document Understanding AI to iterate and optimize for quality.
func (*GoogleCloudDocumentaiV1beta1Document) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1Document) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1DocumentEntity ¶
type GoogleCloudDocumentaiV1beta1DocumentEntity struct { // Confidence: Optional. Confidence of detected Schema entity. Range [0, // 1]. Confidence float64 `json:"confidence,omitempty"` // Id: Optional. Canonical id. This will be a unique value in the entity // list for this document. Id string `json:"id,omitempty"` // MentionId: Optional. Deprecated. Use `id` field instead. MentionId string `json:"mentionId,omitempty"` // MentionText: Optional. Text value in the document e.g. `1600 // Amphitheatre Pkwy`. MentionText string `json:"mentionText,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 *GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue `json:"normalizedValue,omitempty"` // PageAnchor: Optional. Represents the provenance of this entity wrt. // the location on the page where it was found. PageAnchor *GoogleCloudDocumentaiV1beta1DocumentPageAnchor `json:"pageAnchor,omitempty"` // Properties: Optional. Entities can be nested to form a hierarchical // data structure representing the content in the document. Properties []*GoogleCloudDocumentaiV1beta1DocumentEntity `json:"properties,omitempty"` // Provenance: Optional. The history of this annotation. Provenance *GoogleCloudDocumentaiV1beta1DocumentProvenance `json:"provenance,omitempty"` // Redacted: Optional. Whether the entity will be redacted for // de-identification purposes. Redacted bool `json:"redacted,omitempty"` // TextAnchor: Optional. Provenance of the entity. Text anchor indexing // into the Document.text. TextAnchor *GoogleCloudDocumentaiV1beta1DocumentTextAnchor `json:"textAnchor,omitempty"` // Type: Entity type from a schema e.g. `Address`. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "Confidence") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentEntity: A phrase in the text that is a known entity type, such as a person, an organization, or location.
func (*GoogleCloudDocumentaiV1beta1DocumentEntity) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentEntity) MarshalJSON() ([]byte, error)
func (*GoogleCloudDocumentaiV1beta1DocumentEntity) UnmarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentEntity) UnmarshalJSON(data []byte) error
type GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue ¶
type GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue struct { // AddressValue: Postal address. See also: // https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto AddressValue *GoogleTypePostalAddress `json:"addressValue,omitempty"` // BooleanValue: Boolean value. Can be used for entities with binary // values, or for checkboxes. BooleanValue bool `json:"booleanValue,omitempty"` // DateValue: Date value. Includes year, month, day. See also: // https://github.com/googleapis/googleapis/blob/master/google/type/date.proto DateValue *GoogleTypeDate `json:"dateValue,omitempty"` // DatetimeValue: DateTime value. Includes date, time, and timezone. See // also: // https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto DatetimeValue *GoogleTypeDateTime `json:"datetimeValue,omitempty"` // MoneyValue: Money value. See also: // https://github.com/googleapis/googleapis/blob/master/google/type/money.proto MoneyValue *GoogleTypeMoney `json:"moneyValue,omitempty"` // Text: Required. Normalized entity value stored as a string. This // field is populated for supported document type (e.g. Invoice). For // some entity types, one of respective 'structured_value' fields may // also be populated. - Money/Currency type (`money_value`) is in the // ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 // text format. - Datetime type (`datetime_value`) is in the ISO 8601 // text format. Text string `json:"text,omitempty"` // ForceSendFields is a list of field names (e.g. "AddressValue") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue: Parsed and normalized entity value.
func (*GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1DocumentEntityRelation ¶
type GoogleCloudDocumentaiV1beta1DocumentEntityRelation struct { // ObjectId: Object entity id. ObjectId string `json:"objectId,omitempty"` // Relation: Relationship description. Relation string `json:"relation,omitempty"` // SubjectId: Subject entity id. SubjectId string `json:"subjectId,omitempty"` // ForceSendFields is a list of field names (e.g. "ObjectId") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentEntityRelation: Relationship between Entities.
func (*GoogleCloudDocumentaiV1beta1DocumentEntityRelation) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentEntityRelation) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1DocumentPage ¶
type GoogleCloudDocumentaiV1beta1DocumentPage 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 []*GoogleCloudDocumentaiV1beta1DocumentPageBlock `json:"blocks,omitempty"` // DetectedLanguages: A list of detected languages together with // confidence. DetectedLanguages []*GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"` // Dimension: Physical dimension of the page. Dimension *GoogleCloudDocumentaiV1beta1DocumentPageDimension `json:"dimension,omitempty"` // FormFields: A list of visually detected form fields on the page. FormFields []*GoogleCloudDocumentaiV1beta1DocumentPageFormField `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 *GoogleCloudDocumentaiV1beta1DocumentPageImage `json:"image,omitempty"` // Layout: Layout for the page. Layout *GoogleCloudDocumentaiV1beta1DocumentPageLayout `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 []*GoogleCloudDocumentaiV1beta1DocumentPageLine `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. PageNumber int64 `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 []*GoogleCloudDocumentaiV1beta1DocumentPageParagraph `json:"paragraphs,omitempty"` // Tables: A list of visually detected tables on the page. Tables []*GoogleCloudDocumentaiV1beta1DocumentPageTable `json:"tables,omitempty"` // Tokens: A list of visually detected tokens on the page. Tokens []*GoogleCloudDocumentaiV1beta1DocumentPageToken `json:"tokens,omitempty"` // Transforms: Transformation matrices that were applied to the original // document image to produce Page.image. Transforms []*GoogleCloudDocumentaiV1beta1DocumentPageMatrix `json:"transforms,omitempty"` // VisualElements: A list of detected non-text visual elements e.g. // checkbox, signature etc. on the page. VisualElements []*GoogleCloudDocumentaiV1beta1DocumentPageVisualElement `json:"visualElements,omitempty"` // ForceSendFields is a list of field names (e.g. "Blocks") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentPage: A page in a Document.
func (*GoogleCloudDocumentaiV1beta1DocumentPage) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentPage) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1DocumentPageAnchor ¶
type GoogleCloudDocumentaiV1beta1DocumentPageAnchor struct { // PageRefs: One or more references to visual page elements PageRefs []*GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef `json:"pageRefs,omitempty"` // ForceSendFields is a list of field names (e.g. "PageRefs") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentPageAnchor: Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types.
func (*GoogleCloudDocumentaiV1beta1DocumentPageAnchor) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentPageAnchor) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef ¶
type GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef struct { // BoundingPoly: Optional. Identifies the bounding polygon of a layout // element on the page. BoundingPoly *GoogleCloudDocumentaiV1beta1BoundingPoly `json:"boundingPoly,omitempty"` // Confidence: Optional. Confidence of detected page element, if // applicable. Range [0, 1]. Confidence float64 `json:"confidence,omitempty"` // LayoutId: Optional. Deprecated. Use PageRef.bounding_poly instead. LayoutId string `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. LayoutType string `json:"layoutType,omitempty"` // Page: Required. Index into the Document.pages element, for example // using Document.pages to locate the related page element. Page int64 `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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef: Represents a weak reference to a page element within a document.
func (*GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef) MarshalJSON() ([]byte, error)
func (*GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef) UnmarshalJSON ¶ added in v0.47.0
func (s *GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef) UnmarshalJSON(data []byte) error
type GoogleCloudDocumentaiV1beta1DocumentPageBlock ¶
type GoogleCloudDocumentaiV1beta1DocumentPageBlock struct { // DetectedLanguages: A list of detected languages together with // confidence. DetectedLanguages []*GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"` // Layout: Layout for Block. Layout *GoogleCloudDocumentaiV1beta1DocumentPageLayout `json:"layout,omitempty"` // Provenance: The history of this annotation. Provenance *GoogleCloudDocumentaiV1beta1DocumentProvenance `json:"provenance,omitempty"` // ForceSendFields is a list of field names (e.g. "DetectedLanguages") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentPageBlock: A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
func (*GoogleCloudDocumentaiV1beta1DocumentPageBlock) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentPageBlock) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage ¶
type GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage struct { // Confidence: Confidence of detected language. Range [0, 1]. Confidence float64 `json:"confidence,omitempty"` // LanguageCode: The BCP-47 language code, such as "en-US" or "sr-Latn". // For more information, see // http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. LanguageCode string `json:"languageCode,omitempty"` // ForceSendFields is a list of field names (e.g. "Confidence") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage: Detected language for a structural component.
func (*GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage) MarshalJSON() ([]byte, error)
func (*GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage) UnmarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage) UnmarshalJSON(data []byte) error
type GoogleCloudDocumentaiV1beta1DocumentPageDimension ¶
type GoogleCloudDocumentaiV1beta1DocumentPageDimension struct { // Height: Page height. Height float64 `json:"height,omitempty"` // Unit: Dimension unit. Unit string `json:"unit,omitempty"` // Width: Page width. Width float64 `json:"width,omitempty"` // ForceSendFields is a list of field names (e.g. "Height") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentPageDimension: Dimension for the page.
func (*GoogleCloudDocumentaiV1beta1DocumentPageDimension) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentPageDimension) MarshalJSON() ([]byte, error)
func (*GoogleCloudDocumentaiV1beta1DocumentPageDimension) UnmarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentPageDimension) UnmarshalJSON(data []byte) error
type GoogleCloudDocumentaiV1beta1DocumentPageFormField ¶
type GoogleCloudDocumentaiV1beta1DocumentPageFormField struct { // FieldName: Layout for the FormField name. e.g. `Address`, `Email`, // `Grand total`, `Phone number`, etc. FieldName *GoogleCloudDocumentaiV1beta1DocumentPageLayout `json:"fieldName,omitempty"` // FieldValue: Layout for the FormField value. FieldValue *GoogleCloudDocumentaiV1beta1DocumentPageLayout `json:"fieldValue,omitempty"` // NameDetectedLanguages: A list of detected languages for name together // with confidence. NameDetectedLanguages []*GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage `json:"nameDetectedLanguages,omitempty"` // ValueDetectedLanguages: A list of detected languages for value // together with confidence. ValueDetectedLanguages []*GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage `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" ValueType string `json:"valueType,omitempty"` // ForceSendFields is a list of field names (e.g. "FieldName") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "FieldName") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentPageFormField: A form field detected on the page.
func (*GoogleCloudDocumentaiV1beta1DocumentPageFormField) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentPageFormField) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1DocumentPageImage ¶
type GoogleCloudDocumentaiV1beta1DocumentPageImage struct { // Content: Raw byte content of the image. Content string `json:"content,omitempty"` // Height: Height of the image in pixels. Height int64 `json:"height,omitempty"` // MimeType: Encoding mime type for the image. MimeType string `json:"mimeType,omitempty"` // Width: Width of the image in pixels. Width int64 `json:"width,omitempty"` // ForceSendFields is a list of field names (e.g. "Content") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentPageImage: Rendered image contents for this page.
func (*GoogleCloudDocumentaiV1beta1DocumentPageImage) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentPageImage) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1DocumentPageLayout ¶
type GoogleCloudDocumentaiV1beta1DocumentPageLayout struct { // BoundingPoly: The bounding polygon for the Layout. BoundingPoly *GoogleCloudDocumentaiV1beta1BoundingPoly `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]. Confidence float64 `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. Orientation string `json:"orientation,omitempty"` // TextAnchor: Text anchor indexing into the Document.text. TextAnchor *GoogleCloudDocumentaiV1beta1DocumentTextAnchor `json:"textAnchor,omitempty"` // ForceSendFields is a list of field names (e.g. "BoundingPoly") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentPageLayout: Visual element describing a layout unit on a page.
func (*GoogleCloudDocumentaiV1beta1DocumentPageLayout) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentPageLayout) MarshalJSON() ([]byte, error)
func (*GoogleCloudDocumentaiV1beta1DocumentPageLayout) UnmarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentPageLayout) UnmarshalJSON(data []byte) error
type GoogleCloudDocumentaiV1beta1DocumentPageLine ¶
type GoogleCloudDocumentaiV1beta1DocumentPageLine struct { // DetectedLanguages: A list of detected languages together with // confidence. DetectedLanguages []*GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"` // Layout: Layout for Line. Layout *GoogleCloudDocumentaiV1beta1DocumentPageLayout `json:"layout,omitempty"` // Provenance: The history of this annotation. Provenance *GoogleCloudDocumentaiV1beta1DocumentProvenance `json:"provenance,omitempty"` // ForceSendFields is a list of field names (e.g. "DetectedLanguages") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentPageLine: A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.
func (*GoogleCloudDocumentaiV1beta1DocumentPageLine) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentPageLine) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1DocumentPageMatrix ¶
type GoogleCloudDocumentaiV1beta1DocumentPageMatrix struct { // Cols: Number of columns in the matrix. Cols int64 `json:"cols,omitempty"` // Data: The matrix data. Data string `json:"data,omitempty"` // Rows: Number of rows in the matrix. Rows int64 `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.html Type int64 `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "Cols") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentPageMatrix: Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.
func (*GoogleCloudDocumentaiV1beta1DocumentPageMatrix) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentPageMatrix) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1DocumentPageParagraph ¶
type GoogleCloudDocumentaiV1beta1DocumentPageParagraph struct { // DetectedLanguages: A list of detected languages together with // confidence. DetectedLanguages []*GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"` // Layout: Layout for Paragraph. Layout *GoogleCloudDocumentaiV1beta1DocumentPageLayout `json:"layout,omitempty"` // Provenance: The history of this annotation. Provenance *GoogleCloudDocumentaiV1beta1DocumentProvenance `json:"provenance,omitempty"` // ForceSendFields is a list of field names (e.g. "DetectedLanguages") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentPageParagraph: A collection of lines that a human would perceive as a paragraph.
func (*GoogleCloudDocumentaiV1beta1DocumentPageParagraph) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentPageParagraph) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1DocumentPageTable ¶
type GoogleCloudDocumentaiV1beta1DocumentPageTable struct { // BodyRows: Body rows of the table. BodyRows []*GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow `json:"bodyRows,omitempty"` // DetectedLanguages: A list of detected languages together with // confidence. DetectedLanguages []*GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"` // HeaderRows: Header rows of the table. HeaderRows []*GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow `json:"headerRows,omitempty"` // Layout: Layout for Table. Layout *GoogleCloudDocumentaiV1beta1DocumentPageLayout `json:"layout,omitempty"` // ForceSendFields is a list of field names (e.g. "BodyRows") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentPageTable: A table representation similar to HTML table structure.
func (*GoogleCloudDocumentaiV1beta1DocumentPageTable) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentPageTable) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell ¶
type GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell struct { // ColSpan: How many columns this cell spans. ColSpan int64 `json:"colSpan,omitempty"` // DetectedLanguages: A list of detected languages together with // confidence. DetectedLanguages []*GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"` // Layout: Layout for TableCell. Layout *GoogleCloudDocumentaiV1beta1DocumentPageLayout `json:"layout,omitempty"` // RowSpan: How many rows this cell spans. RowSpan int64 `json:"rowSpan,omitempty"` // ForceSendFields is a list of field names (e.g. "ColSpan") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell: A cell representation inside the table.
func (*GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow ¶
type GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow struct { // Cells: Cells that make up this row. Cells []*GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell `json:"cells,omitempty"` // ForceSendFields is a list of field names (e.g. "Cells") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow: A row of table cells.
func (*GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1DocumentPageToken ¶
type GoogleCloudDocumentaiV1beta1DocumentPageToken struct { // DetectedBreak: Detected break at the end of a Token. DetectedBreak *GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak `json:"detectedBreak,omitempty"` // DetectedLanguages: A list of detected languages together with // confidence. DetectedLanguages []*GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"` // Layout: Layout for Token. Layout *GoogleCloudDocumentaiV1beta1DocumentPageLayout `json:"layout,omitempty"` // Provenance: The history of this annotation. Provenance *GoogleCloudDocumentaiV1beta1DocumentProvenance `json:"provenance,omitempty"` // ForceSendFields is a list of field names (e.g. "DetectedBreak") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentPageToken: A detected token.
func (*GoogleCloudDocumentaiV1beta1DocumentPageToken) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentPageToken) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak ¶
type GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak 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. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "Type") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak: Detected break at the end of a Token.
func (*GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1DocumentPageVisualElement ¶
type GoogleCloudDocumentaiV1beta1DocumentPageVisualElement struct { // DetectedLanguages: A list of detected languages together with // confidence. DetectedLanguages []*GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"` // Layout: Layout for VisualElement. Layout *GoogleCloudDocumentaiV1beta1DocumentPageLayout `json:"layout,omitempty"` // Type: Type of the VisualElement. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "DetectedLanguages") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentPageVisualElement: Detected non-text visual elements e.g. checkbox, signature etc. on the page.
func (*GoogleCloudDocumentaiV1beta1DocumentPageVisualElement) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentPageVisualElement) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1DocumentProvenance ¶
type GoogleCloudDocumentaiV1beta1DocumentProvenance struct { // Id: The Id of this operation. Needs to be unique within the scope of // the revision. Id int64 `json:"id,omitempty"` // Parents: References to the original elements that are replaced. Parents []*GoogleCloudDocumentaiV1beta1DocumentProvenanceParent `json:"parents,omitempty"` // Revision: The index of the revision that produced this element. Revision int64 `json:"revision,omitempty"` // Type: The type of provenance operation. // // Possible values: // "OPERATION_TYPE_UNSPECIFIED" - Operation type unspecified. // "ADD" - Add an element. Implicit if no `parents` are set for the // provenance. // "REMOVE" - The element is removed. No `parents` should be set. // "REPLACE" - Explicitly replaces the element(s) identified by // `parents`. // "EVAL_REQUESTED" - Element is requested for human review. // "EVAL_APPROVED" - Element is reviewed and approved at human review, // confidence will be set to 1.0. // "EVAL_SKIPPED" - Element is skipped in the validation process. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "Id") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentProvenance: Structure to identify provenance relationships between annotations in different revisions.
func (*GoogleCloudDocumentaiV1beta1DocumentProvenance) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentProvenance) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1DocumentProvenanceParent ¶
type GoogleCloudDocumentaiV1beta1DocumentProvenanceParent struct { // Id: The id of the parent provenance. Id int64 `json:"id,omitempty"` // Index: The index of the parent revisions corresponding collection of // items (eg. list of entities, properties within entities, etc.) Index int64 `json:"index,omitempty"` // Revision: The index of the [Document.revisions] identifying the // parent revision. Revision int64 `json:"revision,omitempty"` // ForceSendFields is a list of field names (e.g. "Id") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentProvenanceParent: Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced.
func (*GoogleCloudDocumentaiV1beta1DocumentProvenanceParent) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentProvenanceParent) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1DocumentRevision ¶
type GoogleCloudDocumentaiV1beta1DocumentRevision struct { // Agent: If the change was made by a person specify the name or id of // that person. Agent string `json:"agent,omitempty"` // CreateTime: The time that the revision was created. CreateTime string `json:"createTime,omitempty"` // HumanReview: Human Review information of this revision. HumanReview *GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview `json:"humanReview,omitempty"` // Id: Id of the revision. Unique within the context of the document. Id string `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"` // Processor: If the annotation was made by processor identify the // processor by its resource name. Processor string `json:"processor,omitempty"` // ForceSendFields is a list of field names (e.g. "Agent") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentRevision: Contains past or forward revisions of this document.
func (*GoogleCloudDocumentaiV1beta1DocumentRevision) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentRevision) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview ¶
type GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview struct { // State: Human review state. e.g. `requested`, `succeeded`, `rejected`. State string `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`. StateMessage string `json:"stateMessage,omitempty"` // ForceSendFields is a list of field names (e.g. "State") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview: Human Review information of the document.
func (*GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1DocumentShardInfo ¶
type GoogleCloudDocumentaiV1beta1DocumentShardInfo struct { // ShardCount: Total number of shards. ShardCount int64 `json:"shardCount,omitempty,string"` // ShardIndex: The 0-based index of this shard. ShardIndex int64 `json:"shardIndex,omitempty,string"` // TextOffset: The index of the first character in Document.text in the // overall document global text. TextOffset int64 `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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentShardInfo: For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is.
func (*GoogleCloudDocumentaiV1beta1DocumentShardInfo) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentShardInfo) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1DocumentStyle ¶
type GoogleCloudDocumentaiV1beta1DocumentStyle struct { // BackgroundColor: Text background color. BackgroundColor *GoogleTypeColor `json:"backgroundColor,omitempty"` // Color: Text color. Color *GoogleTypeColor `json:"color,omitempty"` // FontSize: Font size. FontSize *GoogleCloudDocumentaiV1beta1DocumentStyleFontSize `json:"fontSize,omitempty"` // FontWeight: Font weight. Possible values are normal, bold, bolder, // and lighter. https://www.w3schools.com/cssref/pr_font_weight.asp FontWeight string `json:"fontWeight,omitempty"` // TextAnchor: Text anchor indexing into the Document.text. TextAnchor *GoogleCloudDocumentaiV1beta1DocumentTextAnchor `json:"textAnchor,omitempty"` // TextDecoration: Text decoration. Follows CSS standard. // https://www.w3schools.com/cssref/pr_text_text-decoration.asp TextDecoration string `json:"textDecoration,omitempty"` // TextStyle: Text style. Possible values are normal, italic, and // oblique. https://www.w3schools.com/cssref/pr_font_font-style.asp TextStyle string `json:"textStyle,omitempty"` // ForceSendFields is a list of field names (e.g. "BackgroundColor") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentStyle: Annotation for common text style attributes. This adheres to CSS conventions as much as possible.
func (*GoogleCloudDocumentaiV1beta1DocumentStyle) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentStyle) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1DocumentStyleFontSize ¶
type GoogleCloudDocumentaiV1beta1DocumentStyleFontSize struct { // Size: Font size for the text. Size float64 `json:"size,omitempty"` // Unit: Unit for the font size. Follows CSS naming (in, px, pt, etc.). Unit string `json:"unit,omitempty"` // ForceSendFields is a list of field names (e.g. "Size") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentStyleFontSize: Font size with unit.
func (*GoogleCloudDocumentaiV1beta1DocumentStyleFontSize) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentStyleFontSize) MarshalJSON() ([]byte, error)
func (*GoogleCloudDocumentaiV1beta1DocumentStyleFontSize) UnmarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentStyleFontSize) UnmarshalJSON(data []byte) error
type GoogleCloudDocumentaiV1beta1DocumentTextAnchor ¶
type GoogleCloudDocumentaiV1beta1DocumentTextAnchor struct { // Content: Contains the content of the text span so that users do not // have to look it up in the text_segments. Content string `json:"content,omitempty"` // TextSegments: The text segments from the Document.text. TextSegments []*GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment `json:"textSegments,omitempty"` // ForceSendFields is a list of field names (e.g. "Content") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentTextAnchor: Text reference indexing into the Document.text.
func (*GoogleCloudDocumentaiV1beta1DocumentTextAnchor) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentTextAnchor) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment ¶
type GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment struct { // EndIndex: TextSegment half open end UTF-8 char index in the // Document.text. EndIndex int64 `json:"endIndex,omitempty,string"` // StartIndex: TextSegment start UTF-8 char index in the Document.text. StartIndex int64 `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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment: A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
func (*GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1DocumentTextChange ¶
type GoogleCloudDocumentaiV1beta1DocumentTextChange struct { // ChangedText: The text that replaces the text identified in the // `text_anchor`. ChangedText string `json:"changedText,omitempty"` // Provenance: The history of this annotation. Provenance []*GoogleCloudDocumentaiV1beta1DocumentProvenance `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 *GoogleCloudDocumentaiV1beta1DocumentTextAnchor `json:"textAnchor,omitempty"` // ForceSendFields is a list of field names (e.g. "ChangedText") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1DocumentTextChange: This message is used for text changes aka. OCR corrections.
func (*GoogleCloudDocumentaiV1beta1DocumentTextChange) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1DocumentTextChange) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1GcsDestination ¶
type GoogleCloudDocumentaiV1beta1GcsDestination struct { Uri string `json:"uri,omitempty"` // ForceSendFields is a list of field names (e.g. "Uri") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Uri") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1GcsDestination: The Google Cloud Storage location where the output file will be written to.
func (*GoogleCloudDocumentaiV1beta1GcsDestination) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1GcsDestination) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1GcsSource ¶
type GoogleCloudDocumentaiV1beta1GcsSource struct { Uri string `json:"uri,omitempty"` // ForceSendFields is a list of field names (e.g. "Uri") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Uri") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1GcsSource: The Google Cloud Storage location where the input file will be read from.
func (*GoogleCloudDocumentaiV1beta1GcsSource) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1GcsSource) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1InputConfig ¶
type GoogleCloudDocumentaiV1beta1InputConfig struct { // GcsSource: The Google Cloud Storage location to read the input from. // This must be a single file. GcsSource *GoogleCloudDocumentaiV1beta1GcsSource `json:"gcsSource,omitempty"` // MimeType: Required. Mimetype of the input. Current supported // mimetypes are application/pdf, image/tiff, and image/gif. In // addition, application/json type is supported for requests with // ProcessDocumentRequest.automl_params field set. The JSON file needs // to be in Document format. MimeType string `json:"mimeType,omitempty"` // ForceSendFields is a list of field names (e.g. "GcsSource") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "GcsSource") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1InputConfig: The desired input location and metadata.
func (*GoogleCloudDocumentaiV1beta1InputConfig) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1InputConfig) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1NormalizedVertex ¶
type GoogleCloudDocumentaiV1beta1NormalizedVertex struct { // X: X coordinate. X float64 `json:"x,omitempty"` // Y: Y coordinate (starts from the top of the image). Y float64 `json:"y,omitempty"` // ForceSendFields is a list of field names (e.g. "X") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1NormalizedVertex: A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
func (*GoogleCloudDocumentaiV1beta1NormalizedVertex) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1NormalizedVertex) MarshalJSON() ([]byte, error)
func (*GoogleCloudDocumentaiV1beta1NormalizedVertex) UnmarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1NormalizedVertex) UnmarshalJSON(data []byte) error
type GoogleCloudDocumentaiV1beta1OperationMetadata ¶
type GoogleCloudDocumentaiV1beta1OperationMetadata struct { // CreateTime: The creation time of the operation. CreateTime string `json:"createTime,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. // "ACCEPTED" - Request is received. // "WAITING" - Request operation is waiting for scheduling. // "RUNNING" - Request is being processed. // "SUCCEEDED" - The batch processing completed successfully. // "CANCELLED" - The batch processing was cancelled. // "FAILED" - The batch processing has failed. State string `json:"state,omitempty"` // StateMessage: A message providing more details about the current // state of processing. StateMessage string `json:"stateMessage,omitempty"` // UpdateTime: The last update time of the operation. UpdateTime string `json:"updateTime,omitempty"` // ForceSendFields is a list of field names (e.g. "CreateTime") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1OperationMetadata: Contains metadata for the BatchProcessDocuments operation.
func (*GoogleCloudDocumentaiV1beta1OperationMetadata) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1OperationMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1OutputConfig ¶
type GoogleCloudDocumentaiV1beta1OutputConfig struct { // GcsDestination: The Google Cloud Storage location to write the output // to. GcsDestination *GoogleCloudDocumentaiV1beta1GcsDestination `json:"gcsDestination,omitempty"` // PagesPerShard: The max number of pages to include into each output // Document shard JSON on Google Cloud Storage. The valid range is [1, // 100]. If not specified, the default value is 20. For example, for one // pdf file with 100 pages, 100 parsed pages will be produced. If // `pages_per_shard` = 20, then 5 Document shard JSON files each // containing 20 parsed pages will be written under the prefix // OutputConfig.gcs_destination.uri and suffix pages-x-to-y.json where x // and y are 1-indexed page numbers. Example GCS outputs with 157 pages // and pages_per_shard = 50: pages-001-to-050.json pages-051-to-100.json // pages-101-to-150.json pages-151-to-157.json PagesPerShard int64 `json:"pagesPerShard,omitempty"` // ForceSendFields is a list of field names (e.g. "GcsDestination") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1OutputConfig: The desired output location and metadata.
func (*GoogleCloudDocumentaiV1beta1OutputConfig) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1OutputConfig) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1ProcessDocumentResponse ¶
type GoogleCloudDocumentaiV1beta1ProcessDocumentResponse struct { // InputConfig: Information about the input file. This is the same as // the corresponding input config in the request. InputConfig *GoogleCloudDocumentaiV1beta1InputConfig `json:"inputConfig,omitempty"` // OutputConfig: The output location of the parsed responses. The // responses are written to this location as JSON-serialized `Document` // objects. OutputConfig *GoogleCloudDocumentaiV1beta1OutputConfig `json:"outputConfig,omitempty"` // ForceSendFields is a list of field names (e.g. "InputConfig") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "InputConfig") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1ProcessDocumentResponse: Response to a single document processing request.
func (*GoogleCloudDocumentaiV1beta1ProcessDocumentResponse) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1ProcessDocumentResponse) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta1Vertex ¶
type GoogleCloudDocumentaiV1beta1Vertex struct { // X: X coordinate. X int64 `json:"x,omitempty"` // Y: Y coordinate (starts from the top of the image). Y int64 `json:"y,omitempty"` // ForceSendFields is a list of field names (e.g. "X") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta1Vertex: A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
func (*GoogleCloudDocumentaiV1beta1Vertex) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta1Vertex) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse ¶
type GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse struct { // Responses: Responses for each individual document. Responses []*GoogleCloudDocumentaiV1beta2ProcessDocumentResponse `json:"responses,omitempty"` // ForceSendFields is a list of field names (e.g. "Responses") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Responses") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse: Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.
func (*GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2BoundingPoly ¶
type GoogleCloudDocumentaiV1beta2BoundingPoly struct { // NormalizedVertices: The bounding polygon normalized vertices. NormalizedVertices []*GoogleCloudDocumentaiV1beta2NormalizedVertex `json:"normalizedVertices,omitempty"` // Vertices: The bounding polygon vertices. Vertices []*GoogleCloudDocumentaiV1beta2Vertex `json:"vertices,omitempty"` // ForceSendFields is a list of field names (e.g. "NormalizedVertices") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2BoundingPoly: A bounding polygon for the detected image annotation.
func (*GoogleCloudDocumentaiV1beta2BoundingPoly) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2BoundingPoly) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2Document ¶
type GoogleCloudDocumentaiV1beta2Document struct { // 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. Content string `json:"content,omitempty"` // Entities: A list of entities detected on Document.text. For document // shards, entities in this list may cross shard boundaries. Entities []*GoogleCloudDocumentaiV1beta2DocumentEntity `json:"entities,omitempty"` // EntityRelations: Relationship among Document.entities. EntityRelations []*GoogleCloudDocumentaiV1beta2DocumentEntityRelation `json:"entityRelations,omitempty"` // Error: Any error that occurred while processing this document. Error *GoogleRpcStatus `json:"error,omitempty"` // Labels: Labels for this document. Labels []*GoogleCloudDocumentaiV1beta2DocumentLabel `json:"labels,omitempty"` // MimeType: An IANA published MIME type (also referred to as media // type). For more information, see // https://www.iana.org/assignments/media-types/media-types.xhtml. MimeType string `json:"mimeType,omitempty"` // Pages: Visual page layout for the Document. Pages []*GoogleCloudDocumentaiV1beta2DocumentPage `json:"pages,omitempty"` // Revisions: Revision history of this document. Revisions []*GoogleCloudDocumentaiV1beta2DocumentRevision `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 *GoogleCloudDocumentaiV1beta2DocumentShardInfo `json:"shardInfo,omitempty"` // Text: Optional. UTF-8 encoded text in reading order from the // document. Text string `json:"text,omitempty"` // TextChanges: 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 []*GoogleCloudDocumentaiV1beta2DocumentTextChange `json:"textChanges,omitempty"` // TextStyles: Styles for the Document.text. TextStyles []*GoogleCloudDocumentaiV1beta2DocumentStyle `json:"textStyles,omitempty"` // Uri: Optional. Currently supports Google Cloud Storage URI of the // form `gs://bucket_name/object_name`. Object versioning is not // supported. See Google Cloud Storage Request URIs // (https://cloud.google.com/storage/docs/reference-uris) for more info. Uri string `json:"uri,omitempty"` // ForceSendFields is a list of field names (e.g. "Content") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2Document: Document represents the canonical document resource in Document Understanding AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document Understanding AI to iterate and optimize for quality.
func (*GoogleCloudDocumentaiV1beta2Document) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2Document) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2DocumentEntity ¶
type GoogleCloudDocumentaiV1beta2DocumentEntity struct { // Confidence: Optional. Confidence of detected Schema entity. Range [0, // 1]. Confidence float64 `json:"confidence,omitempty"` // Id: Optional. Canonical id. This will be a unique value in the entity // list for this document. Id string `json:"id,omitempty"` // MentionId: Optional. Deprecated. Use `id` field instead. MentionId string `json:"mentionId,omitempty"` // MentionText: Optional. Text value in the document e.g. `1600 // Amphitheatre Pkwy`. MentionText string `json:"mentionText,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 *GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue `json:"normalizedValue,omitempty"` // PageAnchor: Optional. Represents the provenance of this entity wrt. // the location on the page where it was found. PageAnchor *GoogleCloudDocumentaiV1beta2DocumentPageAnchor `json:"pageAnchor,omitempty"` // Properties: Optional. Entities can be nested to form a hierarchical // data structure representing the content in the document. Properties []*GoogleCloudDocumentaiV1beta2DocumentEntity `json:"properties,omitempty"` // Provenance: Optional. The history of this annotation. Provenance *GoogleCloudDocumentaiV1beta2DocumentProvenance `json:"provenance,omitempty"` // Redacted: Optional. Whether the entity will be redacted for // de-identification purposes. Redacted bool `json:"redacted,omitempty"` // TextAnchor: Optional. Provenance of the entity. Text anchor indexing // into the Document.text. TextAnchor *GoogleCloudDocumentaiV1beta2DocumentTextAnchor `json:"textAnchor,omitempty"` // Type: Entity type from a schema e.g. `Address`. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "Confidence") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentEntity: A phrase in the text that is a known entity type, such as a person, an organization, or location.
func (*GoogleCloudDocumentaiV1beta2DocumentEntity) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentEntity) MarshalJSON() ([]byte, error)
func (*GoogleCloudDocumentaiV1beta2DocumentEntity) UnmarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentEntity) UnmarshalJSON(data []byte) error
type GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue ¶
type GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue struct { // AddressValue: Postal address. See also: // https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto AddressValue *GoogleTypePostalAddress `json:"addressValue,omitempty"` // BooleanValue: Boolean value. Can be used for entities with binary // values, or for checkboxes. BooleanValue bool `json:"booleanValue,omitempty"` // DateValue: Date value. Includes year, month, day. See also: // https://github.com/googleapis/googleapis/blob/master/google/type/date.proto DateValue *GoogleTypeDate `json:"dateValue,omitempty"` // DatetimeValue: DateTime value. Includes date, time, and timezone. See // also: // https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto DatetimeValue *GoogleTypeDateTime `json:"datetimeValue,omitempty"` // MoneyValue: Money value. See also: // https://github.com/googleapis/googleapis/blob/master/google/type/money.proto MoneyValue *GoogleTypeMoney `json:"moneyValue,omitempty"` // Text: Required. Normalized entity value stored as a string. This // field is populated for supported document type (e.g. Invoice). For // some entity types, one of respective 'structured_value' fields may // also be populated. - Money/Currency type (`money_value`) is in the // ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 // text format. - Datetime type (`datetime_value`) is in the ISO 8601 // text format. Text string `json:"text,omitempty"` // ForceSendFields is a list of field names (e.g. "AddressValue") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue: Parsed and normalized entity value.
func (*GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2DocumentEntityRelation ¶
type GoogleCloudDocumentaiV1beta2DocumentEntityRelation struct { // ObjectId: Object entity id. ObjectId string `json:"objectId,omitempty"` // Relation: Relationship description. Relation string `json:"relation,omitempty"` // SubjectId: Subject entity id. SubjectId string `json:"subjectId,omitempty"` // ForceSendFields is a list of field names (e.g. "ObjectId") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentEntityRelation: Relationship between Entities.
func (*GoogleCloudDocumentaiV1beta2DocumentEntityRelation) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentEntityRelation) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2DocumentLabel ¶
type GoogleCloudDocumentaiV1beta2DocumentLabel struct { // AutomlModel: Label is generated AutoML model. This field stores the // full resource name of the AutoML model. Format: // `projects/{project-id}/locations/{location-id}/models/{model-id}` AutomlModel string `json:"automlModel,omitempty"` // Confidence: Confidence score between 0 and 1 for label assignment. Confidence float64 `json:"confidence,omitempty"` // Name: Name of the label. When the label is generated from AutoML Text // Classification model, this field represents the name of the category. Name string `json:"name,omitempty"` // ForceSendFields is a list of field names (e.g. "AutomlModel") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AutomlModel") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentLabel: Label attaches schema information and/or other metadata to segments within a Document. Multiple Labels on a single field can denote either different labels, different instances of the same label created at different times, or some combination of both.
func (*GoogleCloudDocumentaiV1beta2DocumentLabel) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentLabel) MarshalJSON() ([]byte, error)
func (*GoogleCloudDocumentaiV1beta2DocumentLabel) UnmarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentLabel) UnmarshalJSON(data []byte) error
type GoogleCloudDocumentaiV1beta2DocumentPage ¶
type GoogleCloudDocumentaiV1beta2DocumentPage 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 []*GoogleCloudDocumentaiV1beta2DocumentPageBlock `json:"blocks,omitempty"` // DetectedLanguages: A list of detected languages together with // confidence. DetectedLanguages []*GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"` // Dimension: Physical dimension of the page. Dimension *GoogleCloudDocumentaiV1beta2DocumentPageDimension `json:"dimension,omitempty"` // FormFields: A list of visually detected form fields on the page. FormFields []*GoogleCloudDocumentaiV1beta2DocumentPageFormField `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 *GoogleCloudDocumentaiV1beta2DocumentPageImage `json:"image,omitempty"` // Layout: Layout for the page. Layout *GoogleCloudDocumentaiV1beta2DocumentPageLayout `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 []*GoogleCloudDocumentaiV1beta2DocumentPageLine `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. PageNumber int64 `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 []*GoogleCloudDocumentaiV1beta2DocumentPageParagraph `json:"paragraphs,omitempty"` // Tables: A list of visually detected tables on the page. Tables []*GoogleCloudDocumentaiV1beta2DocumentPageTable `json:"tables,omitempty"` // Tokens: A list of visually detected tokens on the page. Tokens []*GoogleCloudDocumentaiV1beta2DocumentPageToken `json:"tokens,omitempty"` // Transforms: Transformation matrices that were applied to the original // document image to produce Page.image. Transforms []*GoogleCloudDocumentaiV1beta2DocumentPageMatrix `json:"transforms,omitempty"` // VisualElements: A list of detected non-text visual elements e.g. // checkbox, signature etc. on the page. VisualElements []*GoogleCloudDocumentaiV1beta2DocumentPageVisualElement `json:"visualElements,omitempty"` // ForceSendFields is a list of field names (e.g. "Blocks") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentPage: A page in a Document.
func (*GoogleCloudDocumentaiV1beta2DocumentPage) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentPage) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2DocumentPageAnchor ¶
type GoogleCloudDocumentaiV1beta2DocumentPageAnchor struct { // PageRefs: One or more references to visual page elements PageRefs []*GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef `json:"pageRefs,omitempty"` // ForceSendFields is a list of field names (e.g. "PageRefs") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentPageAnchor: Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types.
func (*GoogleCloudDocumentaiV1beta2DocumentPageAnchor) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentPageAnchor) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef ¶
type GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef struct { // BoundingPoly: Optional. Identifies the bounding polygon of a layout // element on the page. BoundingPoly *GoogleCloudDocumentaiV1beta2BoundingPoly `json:"boundingPoly,omitempty"` // Confidence: Optional. Confidence of detected page element, if // applicable. Range [0, 1]. Confidence float64 `json:"confidence,omitempty"` // LayoutId: Optional. Deprecated. Use PageRef.bounding_poly instead. LayoutId string `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. LayoutType string `json:"layoutType,omitempty"` // Page: Required. Index into the Document.pages element, for example // using Document.pages to locate the related page element. Page int64 `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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef: Represents a weak reference to a page element within a document.
func (*GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef) MarshalJSON() ([]byte, error)
func (*GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef) UnmarshalJSON ¶ added in v0.47.0
func (s *GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef) UnmarshalJSON(data []byte) error
type GoogleCloudDocumentaiV1beta2DocumentPageBlock ¶
type GoogleCloudDocumentaiV1beta2DocumentPageBlock struct { // DetectedLanguages: A list of detected languages together with // confidence. DetectedLanguages []*GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"` // Layout: Layout for Block. Layout *GoogleCloudDocumentaiV1beta2DocumentPageLayout `json:"layout,omitempty"` // Provenance: The history of this annotation. Provenance *GoogleCloudDocumentaiV1beta2DocumentProvenance `json:"provenance,omitempty"` // ForceSendFields is a list of field names (e.g. "DetectedLanguages") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentPageBlock: A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
func (*GoogleCloudDocumentaiV1beta2DocumentPageBlock) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentPageBlock) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage ¶
type GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage struct { // Confidence: Confidence of detected language. Range [0, 1]. Confidence float64 `json:"confidence,omitempty"` // LanguageCode: The BCP-47 language code, such as "en-US" or "sr-Latn". // For more information, see // http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. LanguageCode string `json:"languageCode,omitempty"` // ForceSendFields is a list of field names (e.g. "Confidence") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage: Detected language for a structural component.
func (*GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage) MarshalJSON() ([]byte, error)
func (*GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage) UnmarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage) UnmarshalJSON(data []byte) error
type GoogleCloudDocumentaiV1beta2DocumentPageDimension ¶
type GoogleCloudDocumentaiV1beta2DocumentPageDimension struct { // Height: Page height. Height float64 `json:"height,omitempty"` // Unit: Dimension unit. Unit string `json:"unit,omitempty"` // Width: Page width. Width float64 `json:"width,omitempty"` // ForceSendFields is a list of field names (e.g. "Height") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentPageDimension: Dimension for the page.
func (*GoogleCloudDocumentaiV1beta2DocumentPageDimension) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentPageDimension) MarshalJSON() ([]byte, error)
func (*GoogleCloudDocumentaiV1beta2DocumentPageDimension) UnmarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentPageDimension) UnmarshalJSON(data []byte) error
type GoogleCloudDocumentaiV1beta2DocumentPageFormField ¶
type GoogleCloudDocumentaiV1beta2DocumentPageFormField struct { // FieldName: Layout for the FormField name. e.g. `Address`, `Email`, // `Grand total`, `Phone number`, etc. FieldName *GoogleCloudDocumentaiV1beta2DocumentPageLayout `json:"fieldName,omitempty"` // FieldValue: Layout for the FormField value. FieldValue *GoogleCloudDocumentaiV1beta2DocumentPageLayout `json:"fieldValue,omitempty"` // NameDetectedLanguages: A list of detected languages for name together // with confidence. NameDetectedLanguages []*GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage `json:"nameDetectedLanguages,omitempty"` // ValueDetectedLanguages: A list of detected languages for value // together with confidence. ValueDetectedLanguages []*GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage `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" ValueType string `json:"valueType,omitempty"` // ForceSendFields is a list of field names (e.g. "FieldName") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "FieldName") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentPageFormField: A form field detected on the page.
func (*GoogleCloudDocumentaiV1beta2DocumentPageFormField) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentPageFormField) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2DocumentPageImage ¶
type GoogleCloudDocumentaiV1beta2DocumentPageImage struct { // Content: Raw byte content of the image. Content string `json:"content,omitempty"` // Height: Height of the image in pixels. Height int64 `json:"height,omitempty"` // MimeType: Encoding mime type for the image. MimeType string `json:"mimeType,omitempty"` // Width: Width of the image in pixels. Width int64 `json:"width,omitempty"` // ForceSendFields is a list of field names (e.g. "Content") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentPageImage: Rendered image contents for this page.
func (*GoogleCloudDocumentaiV1beta2DocumentPageImage) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentPageImage) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2DocumentPageLayout ¶
type GoogleCloudDocumentaiV1beta2DocumentPageLayout struct { // BoundingPoly: The bounding polygon for the Layout. BoundingPoly *GoogleCloudDocumentaiV1beta2BoundingPoly `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]. Confidence float64 `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. Orientation string `json:"orientation,omitempty"` // TextAnchor: Text anchor indexing into the Document.text. TextAnchor *GoogleCloudDocumentaiV1beta2DocumentTextAnchor `json:"textAnchor,omitempty"` // ForceSendFields is a list of field names (e.g. "BoundingPoly") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentPageLayout: Visual element describing a layout unit on a page.
func (*GoogleCloudDocumentaiV1beta2DocumentPageLayout) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentPageLayout) MarshalJSON() ([]byte, error)
func (*GoogleCloudDocumentaiV1beta2DocumentPageLayout) UnmarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentPageLayout) UnmarshalJSON(data []byte) error
type GoogleCloudDocumentaiV1beta2DocumentPageLine ¶
type GoogleCloudDocumentaiV1beta2DocumentPageLine struct { // DetectedLanguages: A list of detected languages together with // confidence. DetectedLanguages []*GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"` // Layout: Layout for Line. Layout *GoogleCloudDocumentaiV1beta2DocumentPageLayout `json:"layout,omitempty"` // Provenance: The history of this annotation. Provenance *GoogleCloudDocumentaiV1beta2DocumentProvenance `json:"provenance,omitempty"` // ForceSendFields is a list of field names (e.g. "DetectedLanguages") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentPageLine: A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.
func (*GoogleCloudDocumentaiV1beta2DocumentPageLine) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentPageLine) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2DocumentPageMatrix ¶
type GoogleCloudDocumentaiV1beta2DocumentPageMatrix struct { // Cols: Number of columns in the matrix. Cols int64 `json:"cols,omitempty"` // Data: The matrix data. Data string `json:"data,omitempty"` // Rows: Number of rows in the matrix. Rows int64 `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.html Type int64 `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "Cols") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentPageMatrix: Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.
func (*GoogleCloudDocumentaiV1beta2DocumentPageMatrix) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentPageMatrix) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2DocumentPageParagraph ¶
type GoogleCloudDocumentaiV1beta2DocumentPageParagraph struct { // DetectedLanguages: A list of detected languages together with // confidence. DetectedLanguages []*GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"` // Layout: Layout for Paragraph. Layout *GoogleCloudDocumentaiV1beta2DocumentPageLayout `json:"layout,omitempty"` // Provenance: The history of this annotation. Provenance *GoogleCloudDocumentaiV1beta2DocumentProvenance `json:"provenance,omitempty"` // ForceSendFields is a list of field names (e.g. "DetectedLanguages") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentPageParagraph: A collection of lines that a human would perceive as a paragraph.
func (*GoogleCloudDocumentaiV1beta2DocumentPageParagraph) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentPageParagraph) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2DocumentPageTable ¶
type GoogleCloudDocumentaiV1beta2DocumentPageTable struct { // BodyRows: Body rows of the table. BodyRows []*GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow `json:"bodyRows,omitempty"` // DetectedLanguages: A list of detected languages together with // confidence. DetectedLanguages []*GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"` // HeaderRows: Header rows of the table. HeaderRows []*GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow `json:"headerRows,omitempty"` // Layout: Layout for Table. Layout *GoogleCloudDocumentaiV1beta2DocumentPageLayout `json:"layout,omitempty"` // ForceSendFields is a list of field names (e.g. "BodyRows") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentPageTable: A table representation similar to HTML table structure.
func (*GoogleCloudDocumentaiV1beta2DocumentPageTable) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentPageTable) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell ¶
type GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell struct { // ColSpan: How many columns this cell spans. ColSpan int64 `json:"colSpan,omitempty"` // DetectedLanguages: A list of detected languages together with // confidence. DetectedLanguages []*GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"` // Layout: Layout for TableCell. Layout *GoogleCloudDocumentaiV1beta2DocumentPageLayout `json:"layout,omitempty"` // RowSpan: How many rows this cell spans. RowSpan int64 `json:"rowSpan,omitempty"` // ForceSendFields is a list of field names (e.g. "ColSpan") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell: A cell representation inside the table.
func (*GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow ¶
type GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow struct { // Cells: Cells that make up this row. Cells []*GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell `json:"cells,omitempty"` // ForceSendFields is a list of field names (e.g. "Cells") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow: A row of table cells.
func (*GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2DocumentPageToken ¶
type GoogleCloudDocumentaiV1beta2DocumentPageToken struct { // DetectedBreak: Detected break at the end of a Token. DetectedBreak *GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak `json:"detectedBreak,omitempty"` // DetectedLanguages: A list of detected languages together with // confidence. DetectedLanguages []*GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"` // Layout: Layout for Token. Layout *GoogleCloudDocumentaiV1beta2DocumentPageLayout `json:"layout,omitempty"` // Provenance: The history of this annotation. Provenance *GoogleCloudDocumentaiV1beta2DocumentProvenance `json:"provenance,omitempty"` // ForceSendFields is a list of field names (e.g. "DetectedBreak") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentPageToken: A detected token.
func (*GoogleCloudDocumentaiV1beta2DocumentPageToken) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentPageToken) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak ¶
type GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak 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. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "Type") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak: Detected break at the end of a Token.
func (*GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2DocumentPageVisualElement ¶
type GoogleCloudDocumentaiV1beta2DocumentPageVisualElement struct { // DetectedLanguages: A list of detected languages together with // confidence. DetectedLanguages []*GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"` // Layout: Layout for VisualElement. Layout *GoogleCloudDocumentaiV1beta2DocumentPageLayout `json:"layout,omitempty"` // Type: Type of the VisualElement. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "DetectedLanguages") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentPageVisualElement: Detected non-text visual elements e.g. checkbox, signature etc. on the page.
func (*GoogleCloudDocumentaiV1beta2DocumentPageVisualElement) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentPageVisualElement) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2DocumentProvenance ¶
type GoogleCloudDocumentaiV1beta2DocumentProvenance struct { // Id: The Id of this operation. Needs to be unique within the scope of // the revision. Id int64 `json:"id,omitempty"` // Parents: References to the original elements that are replaced. Parents []*GoogleCloudDocumentaiV1beta2DocumentProvenanceParent `json:"parents,omitempty"` // Revision: The index of the revision that produced this element. Revision int64 `json:"revision,omitempty"` // Type: The type of provenance operation. // // Possible values: // "OPERATION_TYPE_UNSPECIFIED" - Operation type unspecified. // "ADD" - Add an element. Implicit if no `parents` are set for the // provenance. // "REMOVE" - The element is removed. No `parents` should be set. // "REPLACE" - Explicitly replaces the element(s) identified by // `parents`. // "EVAL_REQUESTED" - Element is requested for human review. // "EVAL_APPROVED" - Element is reviewed and approved at human review, // confidence will be set to 1.0. // "EVAL_SKIPPED" - Element is skipped in the validation process. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "Id") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentProvenance: Structure to identify provenance relationships between annotations in different revisions.
func (*GoogleCloudDocumentaiV1beta2DocumentProvenance) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentProvenance) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2DocumentProvenanceParent ¶
type GoogleCloudDocumentaiV1beta2DocumentProvenanceParent struct { // Id: The id of the parent provenance. Id int64 `json:"id,omitempty"` // Index: The index of the parent revisions corresponding collection of // items (eg. list of entities, properties within entities, etc.) Index int64 `json:"index,omitempty"` // Revision: The index of the [Document.revisions] identifying the // parent revision. Revision int64 `json:"revision,omitempty"` // ForceSendFields is a list of field names (e.g. "Id") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentProvenanceParent: Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced.
func (*GoogleCloudDocumentaiV1beta2DocumentProvenanceParent) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentProvenanceParent) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2DocumentRevision ¶
type GoogleCloudDocumentaiV1beta2DocumentRevision struct { // Agent: If the change was made by a person specify the name or id of // that person. Agent string `json:"agent,omitempty"` // CreateTime: The time that the revision was created. CreateTime string `json:"createTime,omitempty"` // HumanReview: Human Review information of this revision. HumanReview *GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview `json:"humanReview,omitempty"` // Id: Id of the revision. Unique within the context of the document. Id string `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"` // Processor: If the annotation was made by processor identify the // processor by its resource name. Processor string `json:"processor,omitempty"` // ForceSendFields is a list of field names (e.g. "Agent") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentRevision: Contains past or forward revisions of this document.
func (*GoogleCloudDocumentaiV1beta2DocumentRevision) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentRevision) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview ¶
type GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview struct { // State: Human review state. e.g. `requested`, `succeeded`, `rejected`. State string `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`. StateMessage string `json:"stateMessage,omitempty"` // ForceSendFields is a list of field names (e.g. "State") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview: Human Review information of the document.
func (*GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2DocumentShardInfo ¶
type GoogleCloudDocumentaiV1beta2DocumentShardInfo struct { // ShardCount: Total number of shards. ShardCount int64 `json:"shardCount,omitempty,string"` // ShardIndex: The 0-based index of this shard. ShardIndex int64 `json:"shardIndex,omitempty,string"` // TextOffset: The index of the first character in Document.text in the // overall document global text. TextOffset int64 `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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentShardInfo: For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is.
func (*GoogleCloudDocumentaiV1beta2DocumentShardInfo) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentShardInfo) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2DocumentStyle ¶
type GoogleCloudDocumentaiV1beta2DocumentStyle struct { // BackgroundColor: Text background color. BackgroundColor *GoogleTypeColor `json:"backgroundColor,omitempty"` // Color: Text color. Color *GoogleTypeColor `json:"color,omitempty"` // FontSize: Font size. FontSize *GoogleCloudDocumentaiV1beta2DocumentStyleFontSize `json:"fontSize,omitempty"` // FontWeight: Font weight. Possible values are normal, bold, bolder, // and lighter. https://www.w3schools.com/cssref/pr_font_weight.asp FontWeight string `json:"fontWeight,omitempty"` // TextAnchor: Text anchor indexing into the Document.text. TextAnchor *GoogleCloudDocumentaiV1beta2DocumentTextAnchor `json:"textAnchor,omitempty"` // TextDecoration: Text decoration. Follows CSS standard. // https://www.w3schools.com/cssref/pr_text_text-decoration.asp TextDecoration string `json:"textDecoration,omitempty"` // TextStyle: Text style. Possible values are normal, italic, and // oblique. https://www.w3schools.com/cssref/pr_font_font-style.asp TextStyle string `json:"textStyle,omitempty"` // ForceSendFields is a list of field names (e.g. "BackgroundColor") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentStyle: Annotation for common text style attributes. This adheres to CSS conventions as much as possible.
func (*GoogleCloudDocumentaiV1beta2DocumentStyle) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentStyle) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2DocumentStyleFontSize ¶
type GoogleCloudDocumentaiV1beta2DocumentStyleFontSize struct { // Size: Font size for the text. Size float64 `json:"size,omitempty"` // Unit: Unit for the font size. Follows CSS naming (in, px, pt, etc.). Unit string `json:"unit,omitempty"` // ForceSendFields is a list of field names (e.g. "Size") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentStyleFontSize: Font size with unit.
func (*GoogleCloudDocumentaiV1beta2DocumentStyleFontSize) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentStyleFontSize) MarshalJSON() ([]byte, error)
func (*GoogleCloudDocumentaiV1beta2DocumentStyleFontSize) UnmarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentStyleFontSize) UnmarshalJSON(data []byte) error
type GoogleCloudDocumentaiV1beta2DocumentTextAnchor ¶
type GoogleCloudDocumentaiV1beta2DocumentTextAnchor struct { // Content: Contains the content of the text span so that users do not // have to look it up in the text_segments. Content string `json:"content,omitempty"` // TextSegments: The text segments from the Document.text. TextSegments []*GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment `json:"textSegments,omitempty"` // ForceSendFields is a list of field names (e.g. "Content") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentTextAnchor: Text reference indexing into the Document.text.
func (*GoogleCloudDocumentaiV1beta2DocumentTextAnchor) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentTextAnchor) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment ¶
type GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment struct { // EndIndex: TextSegment half open end UTF-8 char index in the // Document.text. EndIndex int64 `json:"endIndex,omitempty,string"` // StartIndex: TextSegment start UTF-8 char index in the Document.text. StartIndex int64 `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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment: A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
func (*GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2DocumentTextChange ¶
type GoogleCloudDocumentaiV1beta2DocumentTextChange struct { // ChangedText: The text that replaces the text identified in the // `text_anchor`. ChangedText string `json:"changedText,omitempty"` // Provenance: The history of this annotation. Provenance []*GoogleCloudDocumentaiV1beta2DocumentProvenance `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 *GoogleCloudDocumentaiV1beta2DocumentTextAnchor `json:"textAnchor,omitempty"` // ForceSendFields is a list of field names (e.g. "ChangedText") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2DocumentTextChange: This message is used for text changes aka. OCR corrections.
func (*GoogleCloudDocumentaiV1beta2DocumentTextChange) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2DocumentTextChange) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2GcsDestination ¶
type GoogleCloudDocumentaiV1beta2GcsDestination struct { Uri string `json:"uri,omitempty"` // ForceSendFields is a list of field names (e.g. "Uri") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Uri") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2GcsDestination: The Google Cloud Storage location where the output file will be written to.
func (*GoogleCloudDocumentaiV1beta2GcsDestination) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2GcsDestination) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2GcsSource ¶
type GoogleCloudDocumentaiV1beta2GcsSource struct { Uri string `json:"uri,omitempty"` // ForceSendFields is a list of field names (e.g. "Uri") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Uri") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2GcsSource: The Google Cloud Storage location where the input file will be read from.
func (*GoogleCloudDocumentaiV1beta2GcsSource) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2GcsSource) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2InputConfig ¶
type GoogleCloudDocumentaiV1beta2InputConfig struct { // Contents: Content in bytes, represented as a stream of bytes. Note: // As with all `bytes` fields, proto buffer messages use a pure binary // representation, whereas JSON representations use base64. This field // only works for synchronous ProcessDocument method. Contents string `json:"contents,omitempty"` // GcsSource: The Google Cloud Storage location to read the input from. // This must be a single file. GcsSource *GoogleCloudDocumentaiV1beta2GcsSource `json:"gcsSource,omitempty"` // MimeType: Required. Mimetype of the input. Current supported // mimetypes are application/pdf, image/tiff, and image/gif. In // addition, application/json type is supported for requests with // ProcessDocumentRequest.automl_params field set. The JSON file needs // to be in Document format. MimeType string `json:"mimeType,omitempty"` // ForceSendFields is a list of field names (e.g. "Contents") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Contents") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2InputConfig: The desired input location and metadata.
func (*GoogleCloudDocumentaiV1beta2InputConfig) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2InputConfig) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2NormalizedVertex ¶
type GoogleCloudDocumentaiV1beta2NormalizedVertex struct { // X: X coordinate. X float64 `json:"x,omitempty"` // Y: Y coordinate (starts from the top of the image). Y float64 `json:"y,omitempty"` // ForceSendFields is a list of field names (e.g. "X") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2NormalizedVertex: A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
func (*GoogleCloudDocumentaiV1beta2NormalizedVertex) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2NormalizedVertex) MarshalJSON() ([]byte, error)
func (*GoogleCloudDocumentaiV1beta2NormalizedVertex) UnmarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2NormalizedVertex) UnmarshalJSON(data []byte) error
type GoogleCloudDocumentaiV1beta2OperationMetadata ¶
type GoogleCloudDocumentaiV1beta2OperationMetadata struct { // CreateTime: The creation time of the operation. CreateTime string `json:"createTime,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. // "ACCEPTED" - Request is received. // "WAITING" - Request operation is waiting for scheduling. // "RUNNING" - Request is being processed. // "SUCCEEDED" - The batch processing completed successfully. // "CANCELLED" - The batch processing was cancelled. // "FAILED" - The batch processing has failed. State string `json:"state,omitempty"` // StateMessage: A message providing more details about the current // state of processing. StateMessage string `json:"stateMessage,omitempty"` // UpdateTime: The last update time of the operation. UpdateTime string `json:"updateTime,omitempty"` // ForceSendFields is a list of field names (e.g. "CreateTime") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2OperationMetadata: Contains metadata for the BatchProcessDocuments operation.
func (*GoogleCloudDocumentaiV1beta2OperationMetadata) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2OperationMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2OutputConfig ¶
type GoogleCloudDocumentaiV1beta2OutputConfig struct { // GcsDestination: The Google Cloud Storage location to write the output // to. GcsDestination *GoogleCloudDocumentaiV1beta2GcsDestination `json:"gcsDestination,omitempty"` // PagesPerShard: The max number of pages to include into each output // Document shard JSON on Google Cloud Storage. The valid range is [1, // 100]. If not specified, the default value is 20. For example, for one // pdf file with 100 pages, 100 parsed pages will be produced. If // `pages_per_shard` = 20, then 5 Document shard JSON files each // containing 20 parsed pages will be written under the prefix // OutputConfig.gcs_destination.uri and suffix pages-x-to-y.json where x // and y are 1-indexed page numbers. Example GCS outputs with 157 pages // and pages_per_shard = 50: pages-001-to-050.json pages-051-to-100.json // pages-101-to-150.json pages-151-to-157.json PagesPerShard int64 `json:"pagesPerShard,omitempty"` // ForceSendFields is a list of field names (e.g. "GcsDestination") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2OutputConfig: The desired output location and metadata.
func (*GoogleCloudDocumentaiV1beta2OutputConfig) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2OutputConfig) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2ProcessDocumentResponse ¶
type GoogleCloudDocumentaiV1beta2ProcessDocumentResponse struct { // InputConfig: Information about the input file. This is the same as // the corresponding input config in the request. InputConfig *GoogleCloudDocumentaiV1beta2InputConfig `json:"inputConfig,omitempty"` // OutputConfig: The output location of the parsed responses. The // responses are written to this location as JSON-serialized `Document` // objects. OutputConfig *GoogleCloudDocumentaiV1beta2OutputConfig `json:"outputConfig,omitempty"` // ForceSendFields is a list of field names (e.g. "InputConfig") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "InputConfig") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2ProcessDocumentResponse: Response to a single document processing request.
func (*GoogleCloudDocumentaiV1beta2ProcessDocumentResponse) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2ProcessDocumentResponse) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta2Vertex ¶
type GoogleCloudDocumentaiV1beta2Vertex struct { // X: X coordinate. X int64 `json:"x,omitempty"` // Y: Y coordinate (starts from the top of the image). Y int64 `json:"y,omitempty"` // ForceSendFields is a list of field names (e.g. "X") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta2Vertex: A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
func (*GoogleCloudDocumentaiV1beta2Vertex) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta2Vertex) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig ¶ added in v0.41.0
type GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig struct { // GcsDocuments: The set of documents individually specified on Cloud // Storage. GcsDocuments *GoogleCloudDocumentaiV1beta3GcsDocuments `json:"gcsDocuments,omitempty"` // GcsPrefix: The set of documents that match the specified Cloud // Storage [gcs_prefix]. GcsPrefix *GoogleCloudDocumentaiV1beta3GcsPrefix `json:"gcsPrefix,omitempty"` // ForceSendFields is a list of field names (e.g. "GcsDocuments") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig: The common config to specify a set of documents used as input.
func (*GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig) MarshalJSON ¶ added in v0.41.0
func (s *GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3BatchProcessMetadata ¶
type GoogleCloudDocumentaiV1beta3BatchProcessMetadata struct { // CreateTime: The creation time of the operation. CreateTime string `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. State string `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. StateMessage string `json:"stateMessage,omitempty"` // UpdateTime: The last update time of the operation. UpdateTime string `json:"updateTime,omitempty"` // ForceSendFields is a list of field names (e.g. "CreateTime") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3BatchProcessMetadata: The long running operation metadata for batch process method.
func (*GoogleCloudDocumentaiV1beta3BatchProcessMetadata) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3BatchProcessMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus ¶
type GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus struct { // HumanReviewOperation: The name of the operation triggered by the // processed document. If the human review process is not triggered, // this field will be empty. It has the same response type and metadata // as the long running operation returned by ReviewDocument method. HumanReviewOperation string `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. The batch process is started by take snapshot of that // document, since a user can move or change that document during the // process. InputGcsSource string `json:"inputGcsSource,omitempty"` // OutputGcsDestination: The output_gcs_destination (in the request as // 'output_gcs_destination') of the processed document if it was // successful, otherwise empty. OutputGcsDestination string `json:"outputGcsDestination,omitempty"` // Status: The status of the processing of 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 values are omitted from API requests. // However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatu s: The status of a each individual document in the batch process.
func (*GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3BatchProcessRequest ¶
type GoogleCloudDocumentaiV1beta3BatchProcessRequest struct { // DocumentOutputConfig: The overall output config for batch process. DocumentOutputConfig *GoogleCloudDocumentaiV1beta3DocumentOutputConfig `json:"documentOutputConfig,omitempty"` // InputConfigs: The input config for each single document in the batch // process. InputConfigs []*GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig `json:"inputConfigs,omitempty"` // InputDocuments: The input documents for batch process. InputDocuments *GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig `json:"inputDocuments,omitempty"` // OutputConfig: The overall output config for batch process. OutputConfig *GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig `json:"outputConfig,omitempty"` // SkipHumanReview: Whether Human Review feature should be skipped for // this request. Default to false. SkipHumanReview bool `json:"skipHumanReview,omitempty"` // ForceSendFields is a list of field names (e.g. // "DocumentOutputConfig") to unconditionally include in API requests. // By default, fields with empty values are omitted from API requests. // However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3BatchProcessRequest: Request message for batch process document method.
func (*GoogleCloudDocumentaiV1beta3BatchProcessRequest) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3BatchProcessRequest) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig ¶
type GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig struct { // GcsSource: The Cloud Storage location as the source of the document. GcsSource string `json:"gcsSource,omitempty"` // MimeType: Mimetype of the input. If the input is a raw document, the // supported mimetypes are application/pdf, image/tiff, and image/gif. // If the input is a [Document] proto, the type should be // application/json. MimeType string `json:"mimeType,omitempty"` // ForceSendFields is a list of field names (e.g. "GcsSource") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "GcsSource") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig: The message for input config in batch process.
func (*GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig ¶
type GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig struct { // GcsDestination: The output Cloud Storage directory to put the // processed documents. GcsDestination string `json:"gcsDestination,omitempty"` // ForceSendFields is a list of field names (e.g. "GcsDestination") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig: The message for output config in batch process.
func (*GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3BatchProcessResponse ¶
type GoogleCloudDocumentaiV1beta3BatchProcessResponse struct { }
GoogleCloudDocumentaiV1beta3BatchProcessResponse: Response message for batch process document method.
type GoogleCloudDocumentaiV1beta3BoundingPoly ¶
type GoogleCloudDocumentaiV1beta3BoundingPoly struct { // NormalizedVertices: The bounding polygon normalized vertices. NormalizedVertices []*GoogleCloudDocumentaiV1beta3NormalizedVertex `json:"normalizedVertices,omitempty"` // Vertices: The bounding polygon vertices. Vertices []*GoogleCloudDocumentaiV1beta3Vertex `json:"vertices,omitempty"` // ForceSendFields is a list of field names (e.g. "NormalizedVertices") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3BoundingPoly: A bounding polygon for the detected image annotation.
func (*GoogleCloudDocumentaiV1beta3BoundingPoly) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3BoundingPoly) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3CommonOperationMetadata ¶ added in v0.37.0
type GoogleCloudDocumentaiV1beta3CommonOperationMetadata struct { // CreateTime: The creation time of the operation. CreateTime string `json:"createTime,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. State string `json:"state,omitempty"` // StateMessage: A message providing more details about the current // state of processing. StateMessage string `json:"stateMessage,omitempty"` // UpdateTime: The last update time of the operation. UpdateTime string `json:"updateTime,omitempty"` // ForceSendFields is a list of field names (e.g. "CreateTime") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3CommonOperationMetadata: The common metadata for long running operations.
func (*GoogleCloudDocumentaiV1beta3CommonOperationMetadata) MarshalJSON ¶ added in v0.37.0
func (s *GoogleCloudDocumentaiV1beta3CommonOperationMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata ¶ added in v0.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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata: The long running operation metadata for delete processor method.
func (*GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata) MarshalJSON ¶ added in v0.48.0
func (s *GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DisableProcessorMetadata ¶ added in v0.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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DisableProcessorMetadata: The long running operation metadata for disable processor method.
func (*GoogleCloudDocumentaiV1beta3DisableProcessorMetadata) MarshalJSON ¶ added in v0.48.0
func (s *GoogleCloudDocumentaiV1beta3DisableProcessorMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DisableProcessorRequest ¶ added in v0.46.0
type GoogleCloudDocumentaiV1beta3DisableProcessorRequest struct { }
GoogleCloudDocumentaiV1beta3DisableProcessorRequest: Request message for the disable processor method.
type GoogleCloudDocumentaiV1beta3DisableProcessorResponse ¶ added in v0.48.0
type GoogleCloudDocumentaiV1beta3DisableProcessorResponse struct { }
GoogleCloudDocumentaiV1beta3DisableProcessorResponse: Response message for the disable processor method. Intentionally empty proto for adding fields in future.
type GoogleCloudDocumentaiV1beta3Document ¶
type GoogleCloudDocumentaiV1beta3Document struct { // 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. Content string `json:"content,omitempty"` // Entities: A list of entities detected on Document.text. For document // shards, entities in this list may cross shard boundaries. Entities []*GoogleCloudDocumentaiV1beta3DocumentEntity `json:"entities,omitempty"` // EntityRelations: Relationship among Document.entities. EntityRelations []*GoogleCloudDocumentaiV1beta3DocumentEntityRelation `json:"entityRelations,omitempty"` // Error: Any error that occurred while processing this document. Error *GoogleRpcStatus `json:"error,omitempty"` // MimeType: An IANA published MIME type (also referred to as media // type). For more information, see // https://www.iana.org/assignments/media-types/media-types.xhtml. MimeType string `json:"mimeType,omitempty"` // Pages: Visual page layout for the Document. Pages []*GoogleCloudDocumentaiV1beta3DocumentPage `json:"pages,omitempty"` // Revisions: Revision history of this document. Revisions []*GoogleCloudDocumentaiV1beta3DocumentRevision `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 *GoogleCloudDocumentaiV1beta3DocumentShardInfo `json:"shardInfo,omitempty"` // Text: Optional. UTF-8 encoded text in reading order from the // document. Text string `json:"text,omitempty"` // TextChanges: 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 []*GoogleCloudDocumentaiV1beta3DocumentTextChange `json:"textChanges,omitempty"` // TextStyles: Styles for the Document.text. TextStyles []*GoogleCloudDocumentaiV1beta3DocumentStyle `json:"textStyles,omitempty"` // Uri: Optional. Currently supports Google Cloud Storage URI of the // form `gs://bucket_name/object_name`. Object versioning is not // supported. See Google Cloud Storage Request URIs // (https://cloud.google.com/storage/docs/reference-uris) for more info. Uri string `json:"uri,omitempty"` // ForceSendFields is a list of field names (e.g. "Content") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3Document: Document represents the canonical document resource in Document Understanding AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document Understanding AI to iterate and optimize for quality.
func (*GoogleCloudDocumentaiV1beta3Document) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3Document) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DocumentEntity ¶
type GoogleCloudDocumentaiV1beta3DocumentEntity struct { // Confidence: Optional. Confidence of detected Schema entity. Range [0, // 1]. Confidence float64 `json:"confidence,omitempty"` // Id: Optional. Canonical id. This will be a unique value in the entity // list for this document. Id string `json:"id,omitempty"` // MentionId: Optional. Deprecated. Use `id` field instead. MentionId string `json:"mentionId,omitempty"` // MentionText: Optional. Text value in the document e.g. `1600 // Amphitheatre Pkwy`. MentionText string `json:"mentionText,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 *GoogleCloudDocumentaiV1beta3DocumentEntityNormalizedValue `json:"normalizedValue,omitempty"` // PageAnchor: Optional. Represents the provenance of this entity wrt. // the location on the page where it was found. PageAnchor *GoogleCloudDocumentaiV1beta3DocumentPageAnchor `json:"pageAnchor,omitempty"` // Properties: Optional. Entities can be nested to form a hierarchical // data structure representing the content in the document. Properties []*GoogleCloudDocumentaiV1beta3DocumentEntity `json:"properties,omitempty"` // Provenance: Optional. The history of this annotation. Provenance *GoogleCloudDocumentaiV1beta3DocumentProvenance `json:"provenance,omitempty"` // Redacted: Optional. Whether the entity will be redacted for // de-identification purposes. Redacted bool `json:"redacted,omitempty"` // TextAnchor: Optional. Provenance of the entity. Text anchor indexing // into the Document.text. TextAnchor *GoogleCloudDocumentaiV1beta3DocumentTextAnchor `json:"textAnchor,omitempty"` // Type: Entity type from a schema e.g. `Address`. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "Confidence") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentEntity: A phrase in the text that is a known entity type, such as a person, an organization, or location.
func (*GoogleCloudDocumentaiV1beta3DocumentEntity) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentEntity) MarshalJSON() ([]byte, error)
func (*GoogleCloudDocumentaiV1beta3DocumentEntity) UnmarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentEntity) UnmarshalJSON(data []byte) error
type GoogleCloudDocumentaiV1beta3DocumentEntityNormalizedValue ¶
type GoogleCloudDocumentaiV1beta3DocumentEntityNormalizedValue struct { // AddressValue: Postal address. See also: // https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto AddressValue *GoogleTypePostalAddress `json:"addressValue,omitempty"` // BooleanValue: Boolean value. Can be used for entities with binary // values, or for checkboxes. BooleanValue bool `json:"booleanValue,omitempty"` // DateValue: Date value. Includes year, month, day. See also: // https://github.com/googleapis/googleapis/blob/master/google/type/date.proto DateValue *GoogleTypeDate `json:"dateValue,omitempty"` // DatetimeValue: DateTime value. Includes date, time, and timezone. See // also: // https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto DatetimeValue *GoogleTypeDateTime `json:"datetimeValue,omitempty"` // MoneyValue: Money value. See also: // https://github.com/googleapis/googleapis/blob/master/google/type/money.proto MoneyValue *GoogleTypeMoney `json:"moneyValue,omitempty"` // Text: Required. Normalized entity value stored as a string. This // field is populated for supported document type (e.g. Invoice). For // some entity types, one of respective 'structured_value' fields may // also be populated. - Money/Currency type (`money_value`) is in the // ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 // text format. - Datetime type (`datetime_value`) is in the ISO 8601 // text format. Text string `json:"text,omitempty"` // ForceSendFields is a list of field names (e.g. "AddressValue") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentEntityNormalizedValue: Parsed and normalized entity value.
func (*GoogleCloudDocumentaiV1beta3DocumentEntityNormalizedValue) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentEntityNormalizedValue) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DocumentEntityRelation ¶
type GoogleCloudDocumentaiV1beta3DocumentEntityRelation struct { // ObjectId: Object entity id. ObjectId string `json:"objectId,omitempty"` // Relation: Relationship description. Relation string `json:"relation,omitempty"` // SubjectId: Subject entity id. SubjectId string `json:"subjectId,omitempty"` // ForceSendFields is a list of field names (e.g. "ObjectId") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentEntityRelation: Relationship between Entities.
func (*GoogleCloudDocumentaiV1beta3DocumentEntityRelation) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentEntityRelation) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DocumentOutputConfig ¶ added in v0.39.0
type GoogleCloudDocumentaiV1beta3DocumentOutputConfig struct { // GcsOutputConfig: Output config to write the results to Cloud Storage. GcsOutputConfig *GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfig `json:"gcsOutputConfig,omitempty"` // ForceSendFields is a list of field names (e.g. "GcsOutputConfig") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentOutputConfig: Config that controls the output of documents. All documents will be written as a JSON file.
func (*GoogleCloudDocumentaiV1beta3DocumentOutputConfig) MarshalJSON ¶ added in v0.39.0
func (s *GoogleCloudDocumentaiV1beta3DocumentOutputConfig) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfig ¶ added in v0.39.0
type GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfig struct { // GcsUri: The Cloud Storage uri (a directory) of the output. GcsUri string `json:"gcsUri,omitempty"` // ForceSendFields is a list of field names (e.g. "GcsUri") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfig: The configuration used when outputting documents.
func (*GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfig) MarshalJSON ¶ added in v0.39.0
func (s *GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfig) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DocumentPage ¶
type GoogleCloudDocumentaiV1beta3DocumentPage 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 []*GoogleCloudDocumentaiV1beta3DocumentPageBlock `json:"blocks,omitempty"` // DetectedLanguages: A list of detected languages together with // confidence. DetectedLanguages []*GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"` // Dimension: Physical dimension of the page. Dimension *GoogleCloudDocumentaiV1beta3DocumentPageDimension `json:"dimension,omitempty"` // FormFields: A list of visually detected form fields on the page. FormFields []*GoogleCloudDocumentaiV1beta3DocumentPageFormField `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 *GoogleCloudDocumentaiV1beta3DocumentPageImage `json:"image,omitempty"` // Layout: Layout for the page. Layout *GoogleCloudDocumentaiV1beta3DocumentPageLayout `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 []*GoogleCloudDocumentaiV1beta3DocumentPageLine `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. PageNumber int64 `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 []*GoogleCloudDocumentaiV1beta3DocumentPageParagraph `json:"paragraphs,omitempty"` // Tables: A list of visually detected tables on the page. Tables []*GoogleCloudDocumentaiV1beta3DocumentPageTable `json:"tables,omitempty"` // Tokens: A list of visually detected tokens on the page. Tokens []*GoogleCloudDocumentaiV1beta3DocumentPageToken `json:"tokens,omitempty"` // Transforms: Transformation matrices that were applied to the original // document image to produce Page.image. Transforms []*GoogleCloudDocumentaiV1beta3DocumentPageMatrix `json:"transforms,omitempty"` // VisualElements: A list of detected non-text visual elements e.g. // checkbox, signature etc. on the page. VisualElements []*GoogleCloudDocumentaiV1beta3DocumentPageVisualElement `json:"visualElements,omitempty"` // ForceSendFields is a list of field names (e.g. "Blocks") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentPage: A page in a Document.
func (*GoogleCloudDocumentaiV1beta3DocumentPage) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentPage) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DocumentPageAnchor ¶
type GoogleCloudDocumentaiV1beta3DocumentPageAnchor struct { // PageRefs: One or more references to visual page elements PageRefs []*GoogleCloudDocumentaiV1beta3DocumentPageAnchorPageRef `json:"pageRefs,omitempty"` // ForceSendFields is a list of field names (e.g. "PageRefs") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentPageAnchor: Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types.
func (*GoogleCloudDocumentaiV1beta3DocumentPageAnchor) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentPageAnchor) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DocumentPageAnchorPageRef ¶
type GoogleCloudDocumentaiV1beta3DocumentPageAnchorPageRef struct { // BoundingPoly: Optional. Identifies the bounding polygon of a layout // element on the page. BoundingPoly *GoogleCloudDocumentaiV1beta3BoundingPoly `json:"boundingPoly,omitempty"` // Confidence: Optional. Confidence of detected page element, if // applicable. Range [0, 1]. Confidence float64 `json:"confidence,omitempty"` // LayoutId: Optional. Deprecated. Use PageRef.bounding_poly instead. LayoutId string `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. LayoutType string `json:"layoutType,omitempty"` // Page: Required. Index into the Document.pages element, for example // using Document.pages to locate the related page element. Page int64 `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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentPageAnchorPageRef: Represents a weak reference to a page element within a document.
func (*GoogleCloudDocumentaiV1beta3DocumentPageAnchorPageRef) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentPageAnchorPageRef) MarshalJSON() ([]byte, error)
func (*GoogleCloudDocumentaiV1beta3DocumentPageAnchorPageRef) UnmarshalJSON ¶ added in v0.47.0
func (s *GoogleCloudDocumentaiV1beta3DocumentPageAnchorPageRef) UnmarshalJSON(data []byte) error
type GoogleCloudDocumentaiV1beta3DocumentPageBlock ¶
type GoogleCloudDocumentaiV1beta3DocumentPageBlock struct { // DetectedLanguages: A list of detected languages together with // confidence. DetectedLanguages []*GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"` // Layout: Layout for Block. Layout *GoogleCloudDocumentaiV1beta3DocumentPageLayout `json:"layout,omitempty"` // Provenance: The history of this annotation. Provenance *GoogleCloudDocumentaiV1beta3DocumentProvenance `json:"provenance,omitempty"` // ForceSendFields is a list of field names (e.g. "DetectedLanguages") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentPageBlock: A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
func (*GoogleCloudDocumentaiV1beta3DocumentPageBlock) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentPageBlock) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage ¶
type GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage struct { // Confidence: Confidence of detected language. Range [0, 1]. Confidence float64 `json:"confidence,omitempty"` // LanguageCode: The BCP-47 language code, such as "en-US" or "sr-Latn". // For more information, see // http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. LanguageCode string `json:"languageCode,omitempty"` // ForceSendFields is a list of field names (e.g. "Confidence") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage: Detected language for a structural component.
func (*GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage) MarshalJSON() ([]byte, error)
func (*GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage) UnmarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage) UnmarshalJSON(data []byte) error
type GoogleCloudDocumentaiV1beta3DocumentPageDimension ¶
type GoogleCloudDocumentaiV1beta3DocumentPageDimension struct { // Height: Page height. Height float64 `json:"height,omitempty"` // Unit: Dimension unit. Unit string `json:"unit,omitempty"` // Width: Page width. Width float64 `json:"width,omitempty"` // ForceSendFields is a list of field names (e.g. "Height") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentPageDimension: Dimension for the page.
func (*GoogleCloudDocumentaiV1beta3DocumentPageDimension) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentPageDimension) MarshalJSON() ([]byte, error)
func (*GoogleCloudDocumentaiV1beta3DocumentPageDimension) UnmarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentPageDimension) UnmarshalJSON(data []byte) error
type GoogleCloudDocumentaiV1beta3DocumentPageFormField ¶
type GoogleCloudDocumentaiV1beta3DocumentPageFormField struct { // FieldName: Layout for the FormField name. e.g. `Address`, `Email`, // `Grand total`, `Phone number`, etc. FieldName *GoogleCloudDocumentaiV1beta3DocumentPageLayout `json:"fieldName,omitempty"` // FieldValue: Layout for the FormField value. FieldValue *GoogleCloudDocumentaiV1beta3DocumentPageLayout `json:"fieldValue,omitempty"` // NameDetectedLanguages: A list of detected languages for name together // with confidence. NameDetectedLanguages []*GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage `json:"nameDetectedLanguages,omitempty"` // ValueDetectedLanguages: A list of detected languages for value // together with confidence. ValueDetectedLanguages []*GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage `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" ValueType string `json:"valueType,omitempty"` // ForceSendFields is a list of field names (e.g. "FieldName") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "FieldName") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentPageFormField: A form field detected on the page.
func (*GoogleCloudDocumentaiV1beta3DocumentPageFormField) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentPageFormField) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DocumentPageImage ¶
type GoogleCloudDocumentaiV1beta3DocumentPageImage struct { // Content: Raw byte content of the image. Content string `json:"content,omitempty"` // Height: Height of the image in pixels. Height int64 `json:"height,omitempty"` // MimeType: Encoding mime type for the image. MimeType string `json:"mimeType,omitempty"` // Width: Width of the image in pixels. Width int64 `json:"width,omitempty"` // ForceSendFields is a list of field names (e.g. "Content") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentPageImage: Rendered image contents for this page.
func (*GoogleCloudDocumentaiV1beta3DocumentPageImage) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentPageImage) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DocumentPageLayout ¶
type GoogleCloudDocumentaiV1beta3DocumentPageLayout struct { // BoundingPoly: The bounding polygon for the Layout. BoundingPoly *GoogleCloudDocumentaiV1beta3BoundingPoly `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]. Confidence float64 `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. Orientation string `json:"orientation,omitempty"` // TextAnchor: Text anchor indexing into the Document.text. TextAnchor *GoogleCloudDocumentaiV1beta3DocumentTextAnchor `json:"textAnchor,omitempty"` // ForceSendFields is a list of field names (e.g. "BoundingPoly") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentPageLayout: Visual element describing a layout unit on a page.
func (*GoogleCloudDocumentaiV1beta3DocumentPageLayout) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentPageLayout) MarshalJSON() ([]byte, error)
func (*GoogleCloudDocumentaiV1beta3DocumentPageLayout) UnmarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentPageLayout) UnmarshalJSON(data []byte) error
type GoogleCloudDocumentaiV1beta3DocumentPageLine ¶
type GoogleCloudDocumentaiV1beta3DocumentPageLine struct { // DetectedLanguages: A list of detected languages together with // confidence. DetectedLanguages []*GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"` // Layout: Layout for Line. Layout *GoogleCloudDocumentaiV1beta3DocumentPageLayout `json:"layout,omitempty"` // Provenance: The history of this annotation. Provenance *GoogleCloudDocumentaiV1beta3DocumentProvenance `json:"provenance,omitempty"` // ForceSendFields is a list of field names (e.g. "DetectedLanguages") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentPageLine: A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.
func (*GoogleCloudDocumentaiV1beta3DocumentPageLine) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentPageLine) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DocumentPageMatrix ¶
type GoogleCloudDocumentaiV1beta3DocumentPageMatrix struct { // Cols: Number of columns in the matrix. Cols int64 `json:"cols,omitempty"` // Data: The matrix data. Data string `json:"data,omitempty"` // Rows: Number of rows in the matrix. Rows int64 `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.html Type int64 `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "Cols") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentPageMatrix: Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.
func (*GoogleCloudDocumentaiV1beta3DocumentPageMatrix) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentPageMatrix) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DocumentPageParagraph ¶
type GoogleCloudDocumentaiV1beta3DocumentPageParagraph struct { // DetectedLanguages: A list of detected languages together with // confidence. DetectedLanguages []*GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"` // Layout: Layout for Paragraph. Layout *GoogleCloudDocumentaiV1beta3DocumentPageLayout `json:"layout,omitempty"` // Provenance: The history of this annotation. Provenance *GoogleCloudDocumentaiV1beta3DocumentProvenance `json:"provenance,omitempty"` // ForceSendFields is a list of field names (e.g. "DetectedLanguages") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentPageParagraph: A collection of lines that a human would perceive as a paragraph.
func (*GoogleCloudDocumentaiV1beta3DocumentPageParagraph) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentPageParagraph) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DocumentPageTable ¶
type GoogleCloudDocumentaiV1beta3DocumentPageTable struct { // BodyRows: Body rows of the table. BodyRows []*GoogleCloudDocumentaiV1beta3DocumentPageTableTableRow `json:"bodyRows,omitempty"` // DetectedLanguages: A list of detected languages together with // confidence. DetectedLanguages []*GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"` // HeaderRows: Header rows of the table. HeaderRows []*GoogleCloudDocumentaiV1beta3DocumentPageTableTableRow `json:"headerRows,omitempty"` // Layout: Layout for Table. Layout *GoogleCloudDocumentaiV1beta3DocumentPageLayout `json:"layout,omitempty"` // ForceSendFields is a list of field names (e.g. "BodyRows") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentPageTable: A table representation similar to HTML table structure.
func (*GoogleCloudDocumentaiV1beta3DocumentPageTable) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentPageTable) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DocumentPageTableTableCell ¶
type GoogleCloudDocumentaiV1beta3DocumentPageTableTableCell struct { // ColSpan: How many columns this cell spans. ColSpan int64 `json:"colSpan,omitempty"` // DetectedLanguages: A list of detected languages together with // confidence. DetectedLanguages []*GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"` // Layout: Layout for TableCell. Layout *GoogleCloudDocumentaiV1beta3DocumentPageLayout `json:"layout,omitempty"` // RowSpan: How many rows this cell spans. RowSpan int64 `json:"rowSpan,omitempty"` // ForceSendFields is a list of field names (e.g. "ColSpan") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentPageTableTableCell: A cell representation inside the table.
func (*GoogleCloudDocumentaiV1beta3DocumentPageTableTableCell) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentPageTableTableCell) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DocumentPageTableTableRow ¶
type GoogleCloudDocumentaiV1beta3DocumentPageTableTableRow struct { // Cells: Cells that make up this row. Cells []*GoogleCloudDocumentaiV1beta3DocumentPageTableTableCell `json:"cells,omitempty"` // ForceSendFields is a list of field names (e.g. "Cells") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentPageTableTableRow: A row of table cells.
func (*GoogleCloudDocumentaiV1beta3DocumentPageTableTableRow) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentPageTableTableRow) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DocumentPageToken ¶
type GoogleCloudDocumentaiV1beta3DocumentPageToken struct { // DetectedBreak: Detected break at the end of a Token. DetectedBreak *GoogleCloudDocumentaiV1beta3DocumentPageTokenDetectedBreak `json:"detectedBreak,omitempty"` // DetectedLanguages: A list of detected languages together with // confidence. DetectedLanguages []*GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"` // Layout: Layout for Token. Layout *GoogleCloudDocumentaiV1beta3DocumentPageLayout `json:"layout,omitempty"` // Provenance: The history of this annotation. Provenance *GoogleCloudDocumentaiV1beta3DocumentProvenance `json:"provenance,omitempty"` // ForceSendFields is a list of field names (e.g. "DetectedBreak") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentPageToken: A detected token.
func (*GoogleCloudDocumentaiV1beta3DocumentPageToken) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentPageToken) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DocumentPageTokenDetectedBreak ¶
type GoogleCloudDocumentaiV1beta3DocumentPageTokenDetectedBreak 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. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "Type") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentPageTokenDetectedBreak: Detected break at the end of a Token.
func (*GoogleCloudDocumentaiV1beta3DocumentPageTokenDetectedBreak) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentPageTokenDetectedBreak) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DocumentPageVisualElement ¶
type GoogleCloudDocumentaiV1beta3DocumentPageVisualElement struct { // DetectedLanguages: A list of detected languages together with // confidence. DetectedLanguages []*GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage `json:"detectedLanguages,omitempty"` // Layout: Layout for VisualElement. Layout *GoogleCloudDocumentaiV1beta3DocumentPageLayout `json:"layout,omitempty"` // Type: Type of the VisualElement. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "DetectedLanguages") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentPageVisualElement: Detected non-text visual elements e.g. checkbox, signature etc. on the page.
func (*GoogleCloudDocumentaiV1beta3DocumentPageVisualElement) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentPageVisualElement) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DocumentProvenance ¶
type GoogleCloudDocumentaiV1beta3DocumentProvenance struct { // Id: The Id of this operation. Needs to be unique within the scope of // the revision. Id int64 `json:"id,omitempty"` // Parents: References to the original elements that are replaced. Parents []*GoogleCloudDocumentaiV1beta3DocumentProvenanceParent `json:"parents,omitempty"` // Revision: The index of the revision that produced this element. Revision int64 `json:"revision,omitempty"` // Type: The type of provenance operation. // // Possible values: // "OPERATION_TYPE_UNSPECIFIED" - Operation type unspecified. // "ADD" - Add an element. Implicit if no `parents` are set for the // provenance. // "REMOVE" - The element is removed. No `parents` should be set. // "REPLACE" - Explicitly replaces the element(s) identified by // `parents`. // "EVAL_REQUESTED" - Element is requested for human review. // "EVAL_APPROVED" - Element is reviewed and approved at human review, // confidence will be set to 1.0. // "EVAL_SKIPPED" - Element is skipped in the validation process. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "Id") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentProvenance: Structure to identify provenance relationships between annotations in different revisions.
func (*GoogleCloudDocumentaiV1beta3DocumentProvenance) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentProvenance) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DocumentProvenanceParent ¶
type GoogleCloudDocumentaiV1beta3DocumentProvenanceParent struct { // Id: The id of the parent provenance. Id int64 `json:"id,omitempty"` // Index: The index of the parent revisions corresponding collection of // items (eg. list of entities, properties within entities, etc.) Index int64 `json:"index,omitempty"` // Revision: The index of the [Document.revisions] identifying the // parent revision. Revision int64 `json:"revision,omitempty"` // ForceSendFields is a list of field names (e.g. "Id") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentProvenanceParent: Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced.
func (*GoogleCloudDocumentaiV1beta3DocumentProvenanceParent) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentProvenanceParent) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DocumentRevision ¶
type GoogleCloudDocumentaiV1beta3DocumentRevision struct { // Agent: If the change was made by a person specify the name or id of // that person. Agent string `json:"agent,omitempty"` // CreateTime: The time that the revision was created. CreateTime string `json:"createTime,omitempty"` // HumanReview: Human Review information of this revision. HumanReview *GoogleCloudDocumentaiV1beta3DocumentRevisionHumanReview `json:"humanReview,omitempty"` // Id: Id of the revision. Unique within the context of the document. Id string `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"` // Processor: If the annotation was made by processor identify the // processor by its resource name. Processor string `json:"processor,omitempty"` // ForceSendFields is a list of field names (e.g. "Agent") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentRevision: Contains past or forward revisions of this document.
func (*GoogleCloudDocumentaiV1beta3DocumentRevision) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentRevision) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DocumentRevisionHumanReview ¶
type GoogleCloudDocumentaiV1beta3DocumentRevisionHumanReview struct { // State: Human review state. e.g. `requested`, `succeeded`, `rejected`. State string `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`. StateMessage string `json:"stateMessage,omitempty"` // ForceSendFields is a list of field names (e.g. "State") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentRevisionHumanReview: Human Review information of the document.
func (*GoogleCloudDocumentaiV1beta3DocumentRevisionHumanReview) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentRevisionHumanReview) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DocumentShardInfo ¶
type GoogleCloudDocumentaiV1beta3DocumentShardInfo struct { // ShardCount: Total number of shards. ShardCount int64 `json:"shardCount,omitempty,string"` // ShardIndex: The 0-based index of this shard. ShardIndex int64 `json:"shardIndex,omitempty,string"` // TextOffset: The index of the first character in Document.text in the // overall document global text. TextOffset int64 `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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentShardInfo: For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is.
func (*GoogleCloudDocumentaiV1beta3DocumentShardInfo) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentShardInfo) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DocumentStyle ¶
type GoogleCloudDocumentaiV1beta3DocumentStyle struct { // BackgroundColor: Text background color. BackgroundColor *GoogleTypeColor `json:"backgroundColor,omitempty"` // Color: Text color. Color *GoogleTypeColor `json:"color,omitempty"` // FontSize: Font size. FontSize *GoogleCloudDocumentaiV1beta3DocumentStyleFontSize `json:"fontSize,omitempty"` // FontWeight: Font weight. Possible values are normal, bold, bolder, // and lighter. https://www.w3schools.com/cssref/pr_font_weight.asp FontWeight string `json:"fontWeight,omitempty"` // TextAnchor: Text anchor indexing into the Document.text. TextAnchor *GoogleCloudDocumentaiV1beta3DocumentTextAnchor `json:"textAnchor,omitempty"` // TextDecoration: Text decoration. Follows CSS standard. // https://www.w3schools.com/cssref/pr_text_text-decoration.asp TextDecoration string `json:"textDecoration,omitempty"` // TextStyle: Text style. Possible values are normal, italic, and // oblique. https://www.w3schools.com/cssref/pr_font_font-style.asp TextStyle string `json:"textStyle,omitempty"` // ForceSendFields is a list of field names (e.g. "BackgroundColor") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentStyle: Annotation for common text style attributes. This adheres to CSS conventions as much as possible.
func (*GoogleCloudDocumentaiV1beta3DocumentStyle) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentStyle) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DocumentStyleFontSize ¶
type GoogleCloudDocumentaiV1beta3DocumentStyleFontSize struct { // Size: Font size for the text. Size float64 `json:"size,omitempty"` // Unit: Unit for the font size. Follows CSS naming (in, px, pt, etc.). Unit string `json:"unit,omitempty"` // ForceSendFields is a list of field names (e.g. "Size") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentStyleFontSize: Font size with unit.
func (*GoogleCloudDocumentaiV1beta3DocumentStyleFontSize) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentStyleFontSize) MarshalJSON() ([]byte, error)
func (*GoogleCloudDocumentaiV1beta3DocumentStyleFontSize) UnmarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentStyleFontSize) UnmarshalJSON(data []byte) error
type GoogleCloudDocumentaiV1beta3DocumentTextAnchor ¶
type GoogleCloudDocumentaiV1beta3DocumentTextAnchor struct { // Content: Contains the content of the text span so that users do not // have to look it up in the text_segments. Content string `json:"content,omitempty"` // TextSegments: The text segments from the Document.text. TextSegments []*GoogleCloudDocumentaiV1beta3DocumentTextAnchorTextSegment `json:"textSegments,omitempty"` // ForceSendFields is a list of field names (e.g. "Content") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentTextAnchor: Text reference indexing into the Document.text.
func (*GoogleCloudDocumentaiV1beta3DocumentTextAnchor) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentTextAnchor) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DocumentTextAnchorTextSegment ¶
type GoogleCloudDocumentaiV1beta3DocumentTextAnchorTextSegment struct { // EndIndex: TextSegment half open end UTF-8 char index in the // Document.text. EndIndex int64 `json:"endIndex,omitempty,string"` // StartIndex: TextSegment start UTF-8 char index in the Document.text. StartIndex int64 `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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentTextAnchorTextSegment: A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
func (*GoogleCloudDocumentaiV1beta3DocumentTextAnchorTextSegment) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentTextAnchorTextSegment) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3DocumentTextChange ¶
type GoogleCloudDocumentaiV1beta3DocumentTextChange struct { // ChangedText: The text that replaces the text identified in the // `text_anchor`. ChangedText string `json:"changedText,omitempty"` // Provenance: The history of this annotation. Provenance []*GoogleCloudDocumentaiV1beta3DocumentProvenance `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 *GoogleCloudDocumentaiV1beta3DocumentTextAnchor `json:"textAnchor,omitempty"` // ForceSendFields is a list of field names (e.g. "ChangedText") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3DocumentTextChange: This message is used for text changes aka. OCR corrections.
func (*GoogleCloudDocumentaiV1beta3DocumentTextChange) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3DocumentTextChange) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3EnableProcessorMetadata ¶ added in v0.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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3EnableProcessorMetadata: The long running operation metadata for enable processor method.
func (*GoogleCloudDocumentaiV1beta3EnableProcessorMetadata) MarshalJSON ¶ added in v0.48.0
func (s *GoogleCloudDocumentaiV1beta3EnableProcessorMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3EnableProcessorRequest ¶ added in v0.46.0
type GoogleCloudDocumentaiV1beta3EnableProcessorRequest struct { }
GoogleCloudDocumentaiV1beta3EnableProcessorRequest: Request message for the enable processor method.
type GoogleCloudDocumentaiV1beta3EnableProcessorResponse ¶ added in v0.48.0
type GoogleCloudDocumentaiV1beta3EnableProcessorResponse struct { }
GoogleCloudDocumentaiV1beta3EnableProcessorResponse: Response message for the enable processor method. Intentionally empty proto for adding fields in future.
type GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse ¶ added in v0.46.0
type GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse struct { // ProcessorTypes: The list of processor types. ProcessorTypes []*GoogleCloudDocumentaiV1beta3ProcessorType `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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse: Response message for fetch processor types.
func (*GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse) MarshalJSON ¶ added in v0.46.0
func (s *GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3GcsDocument ¶ added in v0.41.0
type GoogleCloudDocumentaiV1beta3GcsDocument struct { // GcsUri: The Cloud Storage object uri. GcsUri string `json:"gcsUri,omitempty"` // MimeType: An IANA MIME type (RFC6838) of the content. MimeType string `json:"mimeType,omitempty"` // ForceSendFields is a list of field names (e.g. "GcsUri") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3GcsDocument: Specifies a document stored on Cloud Storage.
func (*GoogleCloudDocumentaiV1beta3GcsDocument) MarshalJSON ¶ added in v0.41.0
func (s *GoogleCloudDocumentaiV1beta3GcsDocument) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3GcsDocuments ¶ added in v0.41.0
type GoogleCloudDocumentaiV1beta3GcsDocuments struct { // Documents: The list of documents. Documents []*GoogleCloudDocumentaiV1beta3GcsDocument `json:"documents,omitempty"` // ForceSendFields is a list of field names (e.g. "Documents") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3GcsDocuments: Specifies a set of documents on Cloud Storage.
func (*GoogleCloudDocumentaiV1beta3GcsDocuments) MarshalJSON ¶ added in v0.41.0
func (s *GoogleCloudDocumentaiV1beta3GcsDocuments) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3GcsPrefix ¶ added in v0.41.0
type GoogleCloudDocumentaiV1beta3GcsPrefix struct { // GcsUriPrefix: The URI prefix. GcsUriPrefix string `json:"gcsUriPrefix,omitempty"` // ForceSendFields is a list of field names (e.g. "GcsUriPrefix") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3GcsPrefix: Specifies all documents on Cloud Storage with a common prefix.
func (*GoogleCloudDocumentaiV1beta3GcsPrefix) MarshalJSON ¶ added in v0.41.0
func (s *GoogleCloudDocumentaiV1beta3GcsPrefix) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3HumanReviewStatus ¶ added in v0.37.0
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] // method. HumanReviewOperation string `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 is not 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. State string `json:"state,omitempty"` // StateMessage: A message providing more details about the human review // state. StateMessage string `json:"stateMessage,omitempty"` // ForceSendFields is a list of field names (e.g. // "HumanReviewOperation") to unconditionally include in API requests. // By default, fields with empty values are omitted from API requests. // However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3HumanReviewStatus: The status of human review on a processed document.
func (*GoogleCloudDocumentaiV1beta3HumanReviewStatus) MarshalJSON ¶ added in v0.37.0
func (s *GoogleCloudDocumentaiV1beta3HumanReviewStatus) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3ListProcessorsResponse ¶ added in v0.46.0
type GoogleCloudDocumentaiV1beta3ListProcessorsResponse struct { // NextPageToken: Points to the next processor, otherwise empty. NextPageToken string `json:"nextPageToken,omitempty"` // Processors: The list of processors. Processors []*GoogleCloudDocumentaiV1beta3Processor `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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3ListProcessorsResponse: Response message for list processors.
func (*GoogleCloudDocumentaiV1beta3ListProcessorsResponse) MarshalJSON ¶ added in v0.46.0
func (s *GoogleCloudDocumentaiV1beta3ListProcessorsResponse) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3NormalizedVertex ¶
type GoogleCloudDocumentaiV1beta3NormalizedVertex struct { // X: X coordinate. X float64 `json:"x,omitempty"` // Y: Y coordinate (starts from the top of the image). Y float64 `json:"y,omitempty"` // ForceSendFields is a list of field names (e.g. "X") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3NormalizedVertex: A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
func (*GoogleCloudDocumentaiV1beta3NormalizedVertex) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3NormalizedVertex) MarshalJSON() ([]byte, error)
func (*GoogleCloudDocumentaiV1beta3NormalizedVertex) UnmarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3NormalizedVertex) UnmarshalJSON(data []byte) error
type GoogleCloudDocumentaiV1beta3ProcessRequest ¶
type GoogleCloudDocumentaiV1beta3ProcessRequest struct { // Document: The document payload, the [content] and [mime_type] fields // must be set. Document *GoogleCloudDocumentaiV1beta3Document `json:"document,omitempty"` // InlineDocument: An inline document proto. InlineDocument *GoogleCloudDocumentaiV1beta3Document `json:"inlineDocument,omitempty"` // RawDocument: A raw document content (bytes). RawDocument *GoogleCloudDocumentaiV1beta3RawDocument `json:"rawDocument,omitempty"` // SkipHumanReview: Whether Human Review feature should be skipped for // this request. Default to false. SkipHumanReview bool `json:"skipHumanReview,omitempty"` // ForceSendFields is a list of field names (e.g. "Document") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3ProcessRequest: Request message for the process document method.
func (*GoogleCloudDocumentaiV1beta3ProcessRequest) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3ProcessRequest) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3ProcessResponse ¶
type GoogleCloudDocumentaiV1beta3ProcessResponse struct { // Document: The document payload, will populate fields based on the // processor's behavior. Document *GoogleCloudDocumentaiV1beta3Document `json:"document,omitempty"` // HumanReviewOperation: The name of the operation triggered by the // processed document. If the human review process is not triggered, // this field will be empty. It has the same response type and metadata // as the long running operation returned by ReviewDocument method. HumanReviewOperation string `json:"humanReviewOperation,omitempty"` // HumanReviewStatus: The status of human review on the processed // document. HumanReviewStatus *GoogleCloudDocumentaiV1beta3HumanReviewStatus `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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3ProcessResponse: Response message for the process document method.
func (*GoogleCloudDocumentaiV1beta3ProcessResponse) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3ProcessResponse) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3Processor ¶ added in v0.46.0
type GoogleCloudDocumentaiV1beta3Processor struct { // CreateTime: The time the processor was created. CreateTime string `json:"createTime,omitempty"` // DefaultProcessorVersion: The default processor version. DefaultProcessorVersion string `json:"defaultProcessorVersion,omitempty"` // DisplayName: The display name of the processor. DisplayName string `json:"displayName,omitempty"` // KmsKeyName: The KMS key used for encryption/decryption in CMEK // scenarios. See https://cloud.google.com/security-key-management. KmsKeyName string `json:"kmsKeyName,omitempty"` // Name: Output only. Immutable. The resource name of the processor. // Format: // projects/{project}/locations/{location}/processors/{processor} Name string `json:"name,omitempty"` // ProcessEndpoint: Output only. Immutable. The http endpoint that can // be called to invoke processing. ProcessEndpoint string `json:"processEndpoint,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. State string `json:"state,omitempty"` // Type: The processor type, e.g., INVOICE_PARSING, W2_PARSING, etc. Type string `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. "CreateTime") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3Processor: The first-class citizen for DAI. Each processor defines how to extract structural information from a document.
func (*GoogleCloudDocumentaiV1beta3Processor) MarshalJSON ¶ added in v0.46.0
func (s *GoogleCloudDocumentaiV1beta3Processor) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3ProcessorType ¶ added in v0.46.0
type GoogleCloudDocumentaiV1beta3ProcessorType struct { // AllowCreation: Whether the processor type allows creation. If yes, // user can create a processor of this processor type. Otherwise, user // needs to require for whitelisting. AllowCreation bool `json:"allowCreation,omitempty"` // AvailableLocations: The locations in which this processor is // available. AvailableLocations []*GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo `json:"availableLocations,omitempty"` // Category: The processor category, used by UI to group processor // types. Category string `json:"category,omitempty"` // Name: The resource name of the processor type. Format: // projects/{project}/processorTypes/{processor_type} Name string `json:"name,omitempty"` // Schema: The schema of the default version of this processor type. Schema *GoogleCloudDocumentaiV1beta3Schema `json:"schema,omitempty"` // Type: The type of the processor, e.g, "invoice_parsing". Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "AllowCreation") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3ProcessorType: A processor type is responsible for performing a certain document understanding task on a certain type of document. All processor types are created by the documentai service internally. User will only list all available processor types via UI. For different users (projects), the available processor types may be different since we'll expose the access of some types via EAP whitelisting. We make the ProcessorType a resource under location so we have a unified API and keep the possibility that UI will load different available processor types from different regions. But for alpha the behavior is that the user will always get the union of all available processor types among all regions no matter which regionalized endpoint is called, and then we use the 'available_locations' field to show under which regions a processor type is available. For example, users can call either the 'US' or 'EU' endpoint to feach processor types. In the return, we will have an 'invoice parsing' processor with 'available_locations' field only containing 'US'. So the user can try to create an 'invoice parsing' processor under the location 'US'. Such attempt of creating under the location 'EU' will fail. Next ID: 7.
func (*GoogleCloudDocumentaiV1beta3ProcessorType) MarshalJSON ¶ added in v0.46.0
func (s *GoogleCloudDocumentaiV1beta3ProcessorType) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo ¶ added in v0.46.0
type GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo struct { // LocationId: The location id, currently must be one of [us, eu]. LocationId string `json:"locationId,omitempty"` // ForceSendFields is a list of field names (e.g. "LocationId") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo: The location information about where the processor is available.
func (*GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo) MarshalJSON ¶ added in v0.46.0
func (s *GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3RawDocument ¶ added in v0.39.0
type GoogleCloudDocumentaiV1beta3RawDocument struct { // Content: Inline document content. Content string `json:"content,omitempty"` // MimeType: An IANA MIME type (RFC6838) indicating the nature and // format of the [content]. MimeType string `json:"mimeType,omitempty"` // ForceSendFields is a list of field names (e.g. "Content") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3RawDocument: Payload message of raw document content (bytes).
func (*GoogleCloudDocumentaiV1beta3RawDocument) MarshalJSON ¶ added in v0.39.0
func (s *GoogleCloudDocumentaiV1beta3RawDocument) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata ¶
type GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata struct { // CommonMetadata: The basic metadata of the long running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // CreateTime: The creation time of the operation. CreateTime string `json:"createTime,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. State string `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. StateMessage string `json:"stateMessage,omitempty"` // UpdateTime: The last update time of the operation. UpdateTime string `json:"updateTime,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata: The long running operation metadata for review document method.
func (*GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3ReviewDocumentRequest ¶
type GoogleCloudDocumentaiV1beta3ReviewDocumentRequest struct { // Document: The document that needs human review. Document *GoogleCloudDocumentaiV1beta3Document `json:"document,omitempty"` // EnableSchemaValidation: Whether the validation should be performed on // the ad-hoc review request. EnableSchemaValidation bool `json:"enableSchemaValidation,omitempty"` // InlineDocument: An inline document proto. InlineDocument *GoogleCloudDocumentaiV1beta3Document `json:"inlineDocument,omitempty"` // ForceSendFields is a list of field names (e.g. "Document") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3ReviewDocumentRequest: Request message for review document method. Next Id: 5.
func (*GoogleCloudDocumentaiV1beta3ReviewDocumentRequest) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3ReviewDocumentRequest) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3ReviewDocumentResponse ¶
type GoogleCloudDocumentaiV1beta3ReviewDocumentResponse struct { // GcsDestination: The Cloud Storage uri for the human reviewed // document. GcsDestination string `json:"gcsDestination,omitempty"` // ForceSendFields is a list of field names (e.g. "GcsDestination") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3ReviewDocumentResponse: Response message for review document method.
func (*GoogleCloudDocumentaiV1beta3ReviewDocumentResponse) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3ReviewDocumentResponse) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3Schema ¶ added in v0.46.0
type GoogleCloudDocumentaiV1beta3Schema struct { // Description: Description of the schema. Description string `json:"description,omitempty"` // DisplayName: Display name to show to users. DisplayName string `json:"displayName,omitempty"` // EntityTypes: Entity types of the schema. EntityTypes []*GoogleCloudDocumentaiV1beta3SchemaEntityType `json:"entityTypes,omitempty"` // ForceSendFields is a list of field names (e.g. "Description") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3Schema: The schema defines the output of the processed document by a processor.
func (*GoogleCloudDocumentaiV1beta3Schema) MarshalJSON ¶ added in v0.46.0
func (s *GoogleCloudDocumentaiV1beta3Schema) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3SchemaEntityType ¶ added in v0.46.0
type GoogleCloudDocumentaiV1beta3SchemaEntityType struct { // BaseType: Type of the entity. It must be one of the following: // `document` - the entity represents a classification of a logical // document. `object` - if the entity has properties it is likely an // object (or or a document.) `datetime` - the entity is a date or time // value. `money` - the entity represents a money value amount. `number` // - the entity is a number - integer or floating point. `string` - the // entity is a string value. `boolean` - the entity is a boolean value. // `address` - the entity is a location address. BaseType string `json:"baseType,omitempty"` // Description: Description of the entity type. Description string `json:"description,omitempty"` // EnumValues: If specified, lists all the possible values for this // entity. EnumValues []string `json:"enumValues,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. OccurrenceType string `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 []*GoogleCloudDocumentaiV1beta3SchemaEntityType `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. Source string `json:"source,omitempty"` // Type: Name of the type. It must be unique within the set of same // level types. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "BaseType") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3SchemaEntityType: EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.
func (*GoogleCloudDocumentaiV1beta3SchemaEntityType) MarshalJSON ¶ added in v0.46.0
func (s *GoogleCloudDocumentaiV1beta3SchemaEntityType) MarshalJSON() ([]byte, error)
type GoogleCloudDocumentaiV1beta3Vertex ¶
type GoogleCloudDocumentaiV1beta3Vertex struct { // X: X coordinate. X int64 `json:"x,omitempty"` // Y: Y coordinate (starts from the top of the image). Y int64 `json:"y,omitempty"` // ForceSendFields is a list of field names (e.g. "X") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudDocumentaiV1beta3Vertex: A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
func (*GoogleCloudDocumentaiV1beta3Vertex) MarshalJSON ¶
func (s *GoogleCloudDocumentaiV1beta3Vertex) MarshalJSON() ([]byte, error)
type GoogleCloudLocationListLocationsResponse ¶
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. NextPageToken string `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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudLocationListLocationsResponse: The response message for Locations.ListLocations.
func (*GoogleCloudLocationListLocationsResponse) MarshalJSON ¶
func (s *GoogleCloudLocationListLocationsResponse) MarshalJSON() ([]byte, error)
type GoogleCloudLocationLocation ¶
type GoogleCloudLocationLocation struct { // DisplayName: The friendly name for this location, typically a nearby // city name. For example, "Tokyo". DisplayName string `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". LocationId string `json:"locationId,omitempty"` // Metadata: Service-specific metadata. For example the available // capacity at the given location. Metadata googleapi.RawMessage `json:"metadata,omitempty"` // Name: Resource name for the location, which may vary between // implementations. For example: // "projects/example-project/locations/us-east1" Name string `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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleCloudLocationLocation: A resource that represents Google Cloud Platform location.
func (*GoogleCloudLocationLocation) MarshalJSON ¶
func (s *GoogleCloudLocationLocation) MarshalJSON() ([]byte, error)
type GoogleLongrunningListOperationsResponse ¶ added in v0.48.0
type GoogleLongrunningListOperationsResponse struct { // NextPageToken: The standard List next-page token. NextPageToken string `json:"nextPageToken,omitempty"` // Operations: A list of operations that matches the specified filter in // the request. Operations []*GoogleLongrunningOperation `json:"operations,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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleLongrunningListOperationsResponse: The response message for Operations.ListOperations.
func (*GoogleLongrunningListOperationsResponse) MarshalJSON ¶ added in v0.48.0
func (s *GoogleLongrunningListOperationsResponse) MarshalJSON() ([]byte, error)
type GoogleLongrunningOperation ¶
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. Done bool `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. Metadata googleapi.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}`. Name string `json:"name,omitempty"` // Response: The normal response of the operation in case of success. 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`. Response googleapi.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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleLongrunningOperation: This resource represents a long-running operation that is the result of a network API call.
func (*GoogleLongrunningOperation) MarshalJSON ¶
func (s *GoogleLongrunningOperation) MarshalJSON() ([]byte, error)
type GoogleProtobufEmpty ¶
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 avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
type GoogleRpcStatus ¶
type GoogleRpcStatus struct { // Code: The status code, which should be an enum value of // google.rpc.Code. Code int64 `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. Message string `json:"message,omitempty"` // ForceSendFields is a list of field names (e.g. "Code") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleRpcStatus: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains 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 the API Design Guide (https://cloud.google.com/apis/design/errors).
func (*GoogleRpcStatus) MarshalJSON ¶
func (s *GoogleRpcStatus) MarshalJSON() ([]byte, error)
type GoogleTypeColor ¶
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). Alpha float64 `json:"alpha,omitempty"` // Blue: The amount of blue in the color as a value in the interval [0, // 1]. Blue float64 `json:"blue,omitempty"` // Green: The amount of green in the color as a value in the interval // [0, 1]. Green float64 `json:"green,omitempty"` // Red: The amount of red in the color as a value in the interval [0, // 1]. Red float64 `json:"red,omitempty"` // ForceSendFields is a list of field names (e.g. "Alpha") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleTypeColor: Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `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 little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications should assume the sRGB color 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.Color fromProto(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()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [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:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&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); } var alphaFrac = 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 = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(”); }; // ...
func (*GoogleTypeColor) MarshalJSON ¶
func (s *GoogleTypeColor) MarshalJSON() ([]byte, error)
func (*GoogleTypeColor) UnmarshalJSON ¶
func (s *GoogleTypeColor) UnmarshalJSON(data []byte) error
type GoogleTypeDate ¶
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. Day int64 `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. Month int64 `json:"month,omitempty"` // Year: Year of the date. Must be from 1 to 9999, or 0 to specify a // date without a year. Year int64 `json:"year,omitempty"` // ForceSendFields is a list of field names (e.g. "Day") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleTypeDate: Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
func (*GoogleTypeDate) MarshalJSON ¶
func (s *GoogleTypeDate) MarshalJSON() ([]byte, error)
type GoogleTypeDateTime ¶
type GoogleTypeDateTime struct { // Day: Required. Day of month. Must be from 1 to 31 and valid for the // year and month. Day int64 `json:"day,omitempty"` // Hours: Required. Hours of day in 24 hour format. Should be from 0 to // 23. An API may choose to allow the value "24:00:00" for scenarios // like business closing time. Hours int64 `json:"hours,omitempty"` // Minutes: Required. Minutes of hour of day. Must be from 0 to 59. Minutes int64 `json:"minutes,omitempty"` // Month: Required. Month of year. Must be from 1 to 12. Month int64 `json:"month,omitempty"` // Nanos: Required. Fractions of seconds in nanoseconds. Must be from 0 // to 999,999,999. Nanos int64 `json:"nanos,omitempty"` // Seconds: Required. Seconds of minutes of the time. Must normally be // from 0 to 59. An API may allow the value 60 if it allows // leap-seconds. Seconds int64 `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 }. UtcOffset string `json:"utcOffset,omitempty"` // Year: Optional. Year of date. Must be from 1 to 9999, or 0 if // specifying a datetime without a year. Year int64 `json:"year,omitempty"` // ForceSendFields is a list of field names (e.g. "Day") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. 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: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year is 0, the DateTime is considered not to have a specific year. month and day must have valid, non-zero values. This type may also be used to represent a physical 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 physical time 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 some applications may want. Make sure to document and validate your application's limitations.
func (*GoogleTypeDateTime) MarshalJSON ¶
func (s *GoogleTypeDateTime) MarshalJSON() ([]byte, error)
type GoogleTypeMoney ¶
type GoogleTypeMoney struct { // CurrencyCode: The three-letter currency code defined in ISO 4217. CurrencyCode string `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. Nanos int64 `json:"nanos,omitempty"` // Units: The whole units of the amount. For example if `currencyCode` // is "USD", then 1 unit is one US dollar. Units int64 `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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleTypeMoney: Represents an amount of money with its currency type.
func (*GoogleTypeMoney) MarshalJSON ¶
func (s *GoogleTypeMoney) MarshalJSON() ([]byte, error)
type GoogleTypePostalAddress ¶
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 (e.g. "Austin, TX"), it is important that the line order is // clear. The order of address lines should be "envelope order" for the // country/region of the address. In places where this can vary (e.g. // Japan), address_language is used to make it explicit (e.g. "ja" for // large-to-small ordering and "ja-Latn" or "en" for small-to-large). // 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. // Specifically, for Spain this is the province and not the autonomous // community (e.g. "Barcelona" and not "Catalonia"). Many countries // don't use an administrative area in postal addresses. E.g. in // Switzerland this should be left unpopulated. AdministrativeArea string `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". LanguageCode string `json:"languageCode,omitempty"` // Locality: Optional. Generally refers to the city/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. Locality string `json:"locality,omitempty"` // Organization: Optional. The name of the organization at the address. Organization string `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 (e.g. state/zip validation in the U.S.A.). PostalCode string `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. See http://cldr.unicode.org/ and // http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html // for details. Example: "CH" for Switzerland. RegionCode string `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. Revision int64 `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 (e.g. // "CEDEX 7"), or just a number alone, representing the "sector code" // (Jamaica), "delivery area indicator" (Malawi) or "post office // indicator" (e.g. Côte d'Ivoire). SortingCode string `json:"sortingCode,omitempty"` // Sublocality: Optional. Sublocality of the address. For example, this // can be neighborhoods, boroughs, districts. Sublocality string `json:"sublocality,omitempty"` // ForceSendFields is a list of field names (e.g. "AddressLines") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleTypePostalAddress: Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478
func (*GoogleTypePostalAddress) MarshalJSON ¶
func (s *GoogleTypePostalAddress) MarshalJSON() ([]byte, error)
type GoogleTypeTimeZone ¶
type GoogleTypeTimeZone struct { // Id: IANA Time Zone Database time zone, e.g. "America/New_York". Id string `json:"id,omitempty"` // Version: Optional. IANA Time Zone Database version number, e.g. // "2019a". Version string `json:"version,omitempty"` // ForceSendFields is a list of field names (e.g. "Id") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. 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. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleTypeTimeZone: Represents a time zone from the IANA Time Zone Database (https://www.iana.org/time-zones).
func (*GoogleTypeTimeZone) MarshalJSON ¶
func (s *GoogleTypeTimeZone) MarshalJSON() ([]byte, error)
type ProjectsLocationsFetchProcessorTypesCall ¶ added in v0.46.0
type ProjectsLocationsFetchProcessorTypesCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsFetchProcessorTypesCall) Context ¶ added in v0.46.0
func (c *ProjectsLocationsFetchProcessorTypesCall) Context(ctx context.Context) *ProjectsLocationsFetchProcessorTypesCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsFetchProcessorTypesCall) Do ¶ added in v0.46.0
func (c *ProjectsLocationsFetchProcessorTypesCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse, error)
Do executes the "documentai.projects.locations.fetchProcessorTypes" call. Exactly one of *GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse.ServerRespons e.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsFetchProcessorTypesCall) Fields ¶ added in v0.46.0
func (c *ProjectsLocationsFetchProcessorTypesCall) Fields(s ...googleapi.Field) *ProjectsLocationsFetchProcessorTypesCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsFetchProcessorTypesCall) Header ¶ added in v0.46.0
func (c *ProjectsLocationsFetchProcessorTypesCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsFetchProcessorTypesCall) IfNoneMatch ¶ added in v0.46.0
func (c *ProjectsLocationsFetchProcessorTypesCall) IfNoneMatch(entityTag string) *ProjectsLocationsFetchProcessorTypesCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ProjectsLocationsGetCall ¶
type ProjectsLocationsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsGetCall) Context ¶
func (c *ProjectsLocationsGetCall) Context(ctx context.Context) *ProjectsLocationsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsGetCall) Do ¶
func (c *ProjectsLocationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleCloudLocationLocation, error)
Do executes the "documentai.projects.locations.get" call. Exactly one of *GoogleCloudLocationLocation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudLocationLocation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsGetCall) Fields ¶
func (c *ProjectsLocationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsGetCall) Header ¶
func (c *ProjectsLocationsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsGetCall) IfNoneMatch ¶
func (c *ProjectsLocationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ProjectsLocationsListCall ¶
type ProjectsLocationsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsListCall) Context ¶
func (c *ProjectsLocationsListCall) Context(ctx context.Context) *ProjectsLocationsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsListCall) Do ¶
func (c *ProjectsLocationsListCall) Do(opts ...googleapi.CallOption) (*GoogleCloudLocationListLocationsResponse, error)
Do executes the "documentai.projects.locations.list" call. Exactly one of *GoogleCloudLocationListLocationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudLocationListLocationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsListCall) Fields ¶
func (c *ProjectsLocationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsListCall) Filter ¶
func (c *ProjectsLocationsListCall) Filter(filter string) *ProjectsLocationsListCall
Filter sets the optional parameter "filter": A filter to narrow down results to 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 ¶
func (c *ProjectsLocationsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsListCall) IfNoneMatch ¶
func (c *ProjectsLocationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsLocationsListCall) PageSize ¶
func (c *ProjectsLocationsListCall) PageSize(pageSize int64) *ProjectsLocationsListCall
PageSize sets the optional parameter "pageSize": The maximum number of results to return. If not set, the service selects a default.
func (*ProjectsLocationsListCall) PageToken ¶
func (c *ProjectsLocationsListCall) PageToken(pageToken string) *ProjectsLocationsListCall
PageToken sets the optional parameter "pageToken": A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
func (*ProjectsLocationsListCall) Pages ¶
func (c *ProjectsLocationsListCall) Pages(ctx context.Context, f func(*GoogleCloudLocationListLocationsResponse) error) error
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.
type ProjectsLocationsOperationsCancelOperationCall ¶ added in v0.48.0
type ProjectsLocationsOperationsCancelOperationCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsOperationsCancelOperationCall) Context ¶ added in v0.48.0
func (c *ProjectsLocationsOperationsCancelOperationCall) Context(ctx context.Context) *ProjectsLocationsOperationsCancelOperationCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsOperationsCancelOperationCall) Do ¶ added in v0.48.0
func (c *ProjectsLocationsOperationsCancelOperationCall) Do(opts ...googleapi.CallOption) (*GoogleProtobufEmpty, error)
Do executes the "documentai.projects.locations.operations.cancelOperation" call. Exactly one of *GoogleProtobufEmpty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsOperationsCancelOperationCall) Fields ¶ added in v0.48.0
func (c *ProjectsLocationsOperationsCancelOperationCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsCancelOperationCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsOperationsCancelOperationCall) Header ¶ added in v0.48.0
func (c *ProjectsLocationsOperationsCancelOperationCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsLocationsOperationsGetCall ¶
type ProjectsLocationsOperationsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsOperationsGetCall) Context ¶
func (c *ProjectsLocationsOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsOperationsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsOperationsGetCall) Do ¶
func (c *ProjectsLocationsOperationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
Do executes the "documentai.projects.locations.operations.get" call. Exactly one of *GoogleLongrunningOperation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsOperationsGetCall) Fields ¶
func (c *ProjectsLocationsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsOperationsGetCall) Header ¶
func (c *ProjectsLocationsOperationsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsOperationsGetCall) IfNoneMatch ¶
func (c *ProjectsLocationsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ProjectsLocationsOperationsListCall ¶ added in v0.48.0
type ProjectsLocationsOperationsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsOperationsListCall) Context ¶ added in v0.48.0
func (c *ProjectsLocationsOperationsListCall) Context(ctx context.Context) *ProjectsLocationsOperationsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsOperationsListCall) Do ¶ added in v0.48.0
func (c *ProjectsLocationsOperationsListCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningListOperationsResponse, error)
Do executes the "documentai.projects.locations.operations.list" call. Exactly one of *GoogleLongrunningListOperationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningListOperationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsOperationsListCall) Fields ¶ added in v0.48.0
func (c *ProjectsLocationsOperationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsOperationsListCall) Filter ¶ added in v0.48.0
func (c *ProjectsLocationsOperationsListCall) Filter(filter string) *ProjectsLocationsOperationsListCall
Filter sets the optional parameter "filter": The standard list filter.
func (*ProjectsLocationsOperationsListCall) Header ¶ added in v0.48.0
func (c *ProjectsLocationsOperationsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsOperationsListCall) IfNoneMatch ¶ added in v0.48.0
func (c *ProjectsLocationsOperationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsLocationsOperationsListCall) PageSize ¶ added in v0.48.0
func (c *ProjectsLocationsOperationsListCall) PageSize(pageSize int64) *ProjectsLocationsOperationsListCall
PageSize sets the optional parameter "pageSize": The standard list page size.
func (*ProjectsLocationsOperationsListCall) PageToken ¶ added in v0.48.0
func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *ProjectsLocationsOperationsListCall
PageToken sets the optional parameter "pageToken": The standard list page token.
func (*ProjectsLocationsOperationsListCall) Pages ¶ added in v0.48.0
func (c *ProjectsLocationsOperationsListCall) Pages(ctx context.Context, f func(*GoogleLongrunningListOperationsResponse) error) error
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.
type ProjectsLocationsOperationsService ¶
type ProjectsLocationsOperationsService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsOperationsService ¶
func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService
func (*ProjectsLocationsOperationsService) CancelOperation ¶ added in v0.48.0
func (r *ProjectsLocationsOperationsService) CancelOperation(name string) *ProjectsLocationsOperationsCancelOperationCall
CancelOperation: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.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 ¶
func (r *ProjectsLocationsOperationsService) Get(name string) *ProjectsLocationsOperationsGetCall
Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
- name: The name of the operation resource.
func (*ProjectsLocationsOperationsService) List ¶ added in v0.48.0
func (r *ProjectsLocationsOperationsService) List(name string) *ProjectsLocationsOperationsListCall
List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
- name: The name of the operation's parent resource.
type ProjectsLocationsProcessorsBatchProcessCall ¶
type ProjectsLocationsProcessorsBatchProcessCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsProcessorsBatchProcessCall) Context ¶
func (c *ProjectsLocationsProcessorsBatchProcessCall) Context(ctx context.Context) *ProjectsLocationsProcessorsBatchProcessCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsProcessorsBatchProcessCall) Do ¶
func (c *ProjectsLocationsProcessorsBatchProcessCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
Do executes the "documentai.projects.locations.processors.batchProcess" call. Exactly one of *GoogleLongrunningOperation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsProcessorsBatchProcessCall) Fields ¶
func (c *ProjectsLocationsProcessorsBatchProcessCall) Fields(s ...googleapi.Field) *ProjectsLocationsProcessorsBatchProcessCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsProcessorsBatchProcessCall) Header ¶
func (c *ProjectsLocationsProcessorsBatchProcessCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsLocationsProcessorsCreateCall ¶ added in v0.46.0
type ProjectsLocationsProcessorsCreateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsProcessorsCreateCall) Context ¶ added in v0.46.0
func (c *ProjectsLocationsProcessorsCreateCall) Context(ctx context.Context) *ProjectsLocationsProcessorsCreateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsProcessorsCreateCall) Do ¶ added in v0.46.0
func (c *ProjectsLocationsProcessorsCreateCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDocumentaiV1beta3Processor, error)
Do executes the "documentai.projects.locations.processors.create" call. Exactly one of *GoogleCloudDocumentaiV1beta3Processor or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudDocumentaiV1beta3Processor.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsProcessorsCreateCall) Fields ¶ added in v0.46.0
func (c *ProjectsLocationsProcessorsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsProcessorsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsProcessorsCreateCall) Header ¶ added in v0.46.0
func (c *ProjectsLocationsProcessorsCreateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsLocationsProcessorsDeleteCall ¶ added in v0.46.0
type ProjectsLocationsProcessorsDeleteCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsProcessorsDeleteCall) Context ¶ added in v0.46.0
func (c *ProjectsLocationsProcessorsDeleteCall) Context(ctx context.Context) *ProjectsLocationsProcessorsDeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsProcessorsDeleteCall) Do ¶ added in v0.46.0
func (c *ProjectsLocationsProcessorsDeleteCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
Do executes the "documentai.projects.locations.processors.delete" call. Exactly one of *GoogleLongrunningOperation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsProcessorsDeleteCall) Fields ¶ added in v0.46.0
func (c *ProjectsLocationsProcessorsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsProcessorsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsProcessorsDeleteCall) Header ¶ added in v0.46.0
func (c *ProjectsLocationsProcessorsDeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsLocationsProcessorsDisableCall ¶ added in v0.46.0
type ProjectsLocationsProcessorsDisableCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsProcessorsDisableCall) Context ¶ added in v0.46.0
func (c *ProjectsLocationsProcessorsDisableCall) Context(ctx context.Context) *ProjectsLocationsProcessorsDisableCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsProcessorsDisableCall) Do ¶ added in v0.46.0
func (c *ProjectsLocationsProcessorsDisableCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
Do executes the "documentai.projects.locations.processors.disable" call. Exactly one of *GoogleLongrunningOperation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsProcessorsDisableCall) Fields ¶ added in v0.46.0
func (c *ProjectsLocationsProcessorsDisableCall) Fields(s ...googleapi.Field) *ProjectsLocationsProcessorsDisableCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsProcessorsDisableCall) Header ¶ added in v0.46.0
func (c *ProjectsLocationsProcessorsDisableCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsLocationsProcessorsEnableCall ¶ added in v0.46.0
type ProjectsLocationsProcessorsEnableCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsProcessorsEnableCall) Context ¶ added in v0.46.0
func (c *ProjectsLocationsProcessorsEnableCall) Context(ctx context.Context) *ProjectsLocationsProcessorsEnableCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsProcessorsEnableCall) Do ¶ added in v0.46.0
func (c *ProjectsLocationsProcessorsEnableCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
Do executes the "documentai.projects.locations.processors.enable" call. Exactly one of *GoogleLongrunningOperation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsProcessorsEnableCall) Fields ¶ added in v0.46.0
func (c *ProjectsLocationsProcessorsEnableCall) Fields(s ...googleapi.Field) *ProjectsLocationsProcessorsEnableCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsProcessorsEnableCall) Header ¶ added in v0.46.0
func (c *ProjectsLocationsProcessorsEnableCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsLocationsProcessorsHumanReviewConfigReviewDocumentCall ¶
type ProjectsLocationsProcessorsHumanReviewConfigReviewDocumentCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsProcessorsHumanReviewConfigReviewDocumentCall) Context ¶
func (c *ProjectsLocationsProcessorsHumanReviewConfigReviewDocumentCall) Context(ctx context.Context) *ProjectsLocationsProcessorsHumanReviewConfigReviewDocumentCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsProcessorsHumanReviewConfigReviewDocumentCall) Do ¶
func (c *ProjectsLocationsProcessorsHumanReviewConfigReviewDocumentCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
Do executes the "documentai.projects.locations.processors.humanReviewConfig.reviewDocument" call. Exactly one of *GoogleLongrunningOperation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsProcessorsHumanReviewConfigReviewDocumentCall) Fields ¶
func (c *ProjectsLocationsProcessorsHumanReviewConfigReviewDocumentCall) Fields(s ...googleapi.Field) *ProjectsLocationsProcessorsHumanReviewConfigReviewDocumentCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsProcessorsHumanReviewConfigReviewDocumentCall) Header ¶
func (c *ProjectsLocationsProcessorsHumanReviewConfigReviewDocumentCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsLocationsProcessorsHumanReviewConfigService ¶
type ProjectsLocationsProcessorsHumanReviewConfigService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsProcessorsHumanReviewConfigService ¶
func NewProjectsLocationsProcessorsHumanReviewConfigService(s *Service) *ProjectsLocationsProcessorsHumanReviewConfigService
func (*ProjectsLocationsProcessorsHumanReviewConfigService) ReviewDocument ¶
func (r *ProjectsLocationsProcessorsHumanReviewConfigService) ReviewDocument(humanReviewConfig string, googleclouddocumentaiv1beta3reviewdocumentrequest *GoogleCloudDocumentaiV1beta3ReviewDocumentRequest) *ProjectsLocationsProcessorsHumanReviewConfigReviewDocumentCall
ReviewDocument: Send a document for Human Review. The input document should be processed by the specified processor.
- humanReviewConfig: The resource name of the HumanReviewConfig that the document will be reviewed with.
type ProjectsLocationsProcessorsListCall ¶ added in v0.46.0
type ProjectsLocationsProcessorsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsProcessorsListCall) Context ¶ added in v0.46.0
func (c *ProjectsLocationsProcessorsListCall) Context(ctx context.Context) *ProjectsLocationsProcessorsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsProcessorsListCall) Do ¶ added in v0.46.0
func (c *ProjectsLocationsProcessorsListCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDocumentaiV1beta3ListProcessorsResponse, error)
Do executes the "documentai.projects.locations.processors.list" call. Exactly one of *GoogleCloudDocumentaiV1beta3ListProcessorsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudDocumentaiV1beta3ListProcessorsResponse.ServerResponse.Hea der or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsProcessorsListCall) Fields ¶ added in v0.46.0
func (c *ProjectsLocationsProcessorsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsProcessorsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsProcessorsListCall) Header ¶ added in v0.46.0
func (c *ProjectsLocationsProcessorsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsProcessorsListCall) IfNoneMatch ¶ added in v0.46.0
func (c *ProjectsLocationsProcessorsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsProcessorsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsLocationsProcessorsListCall) PageSize ¶ added in v0.46.0
func (c *ProjectsLocationsProcessorsListCall) PageSize(pageSize int64) *ProjectsLocationsProcessorsListCall
PageSize sets the optional parameter "pageSize": The maximum number of processors to return. If unspecified, at most 50 processors will be returned. The maximum value is 100; values above 100 will be coerced to 100.
func (*ProjectsLocationsProcessorsListCall) PageToken ¶ added in v0.46.0
func (c *ProjectsLocationsProcessorsListCall) PageToken(pageToken string) *ProjectsLocationsProcessorsListCall
PageToken sets the optional parameter "pageToken": We will return the processors sorted by creation time. The page token will point to the next processor.
func (*ProjectsLocationsProcessorsListCall) Pages ¶ added in v0.46.0
func (c *ProjectsLocationsProcessorsListCall) Pages(ctx context.Context, f func(*GoogleCloudDocumentaiV1beta3ListProcessorsResponse) error) error
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.
type ProjectsLocationsProcessorsProcessCall ¶
type ProjectsLocationsProcessorsProcessCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsProcessorsProcessCall) Context ¶
func (c *ProjectsLocationsProcessorsProcessCall) Context(ctx context.Context) *ProjectsLocationsProcessorsProcessCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsProcessorsProcessCall) Do ¶
func (c *ProjectsLocationsProcessorsProcessCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDocumentaiV1beta3ProcessResponse, error)
Do executes the "documentai.projects.locations.processors.process" call. Exactly one of *GoogleCloudDocumentaiV1beta3ProcessResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudDocumentaiV1beta3ProcessResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsProcessorsProcessCall) Fields ¶
func (c *ProjectsLocationsProcessorsProcessCall) Fields(s ...googleapi.Field) *ProjectsLocationsProcessorsProcessCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsProcessorsProcessCall) Header ¶
func (c *ProjectsLocationsProcessorsProcessCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsLocationsProcessorsProcessorVersionsBatchProcessCall ¶ added in v0.37.0
type ProjectsLocationsProcessorsProcessorVersionsBatchProcessCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsProcessorsProcessorVersionsBatchProcessCall) Context ¶ added in v0.37.0
func (c *ProjectsLocationsProcessorsProcessorVersionsBatchProcessCall) Context(ctx context.Context) *ProjectsLocationsProcessorsProcessorVersionsBatchProcessCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsProcessorsProcessorVersionsBatchProcessCall) Do ¶ added in v0.37.0
func (c *ProjectsLocationsProcessorsProcessorVersionsBatchProcessCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
Do executes the "documentai.projects.locations.processors.processorVersions.batchProcess" call. Exactly one of *GoogleLongrunningOperation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsProcessorsProcessorVersionsBatchProcessCall) Fields ¶ added in v0.37.0
func (c *ProjectsLocationsProcessorsProcessorVersionsBatchProcessCall) Fields(s ...googleapi.Field) *ProjectsLocationsProcessorsProcessorVersionsBatchProcessCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsProcessorsProcessorVersionsBatchProcessCall) Header ¶ added in v0.37.0
func (c *ProjectsLocationsProcessorsProcessorVersionsBatchProcessCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsLocationsProcessorsProcessorVersionsProcessCall ¶ added in v0.37.0
type ProjectsLocationsProcessorsProcessorVersionsProcessCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsProcessorsProcessorVersionsProcessCall) Context ¶ added in v0.37.0
func (c *ProjectsLocationsProcessorsProcessorVersionsProcessCall) Context(ctx context.Context) *ProjectsLocationsProcessorsProcessorVersionsProcessCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsProcessorsProcessorVersionsProcessCall) Do ¶ added in v0.37.0
func (c *ProjectsLocationsProcessorsProcessorVersionsProcessCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDocumentaiV1beta3ProcessResponse, error)
Do executes the "documentai.projects.locations.processors.processorVersions.process" call. Exactly one of *GoogleCloudDocumentaiV1beta3ProcessResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudDocumentaiV1beta3ProcessResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsProcessorsProcessorVersionsProcessCall) Fields ¶ added in v0.37.0
func (c *ProjectsLocationsProcessorsProcessorVersionsProcessCall) Fields(s ...googleapi.Field) *ProjectsLocationsProcessorsProcessorVersionsProcessCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsProcessorsProcessorVersionsProcessCall) Header ¶ added in v0.37.0
func (c *ProjectsLocationsProcessorsProcessorVersionsProcessCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsLocationsProcessorsProcessorVersionsService ¶ added in v0.37.0
type ProjectsLocationsProcessorsProcessorVersionsService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsProcessorsProcessorVersionsService ¶ added in v0.37.0
func NewProjectsLocationsProcessorsProcessorVersionsService(s *Service) *ProjectsLocationsProcessorsProcessorVersionsService
func (*ProjectsLocationsProcessorsProcessorVersionsService) BatchProcess ¶ added in v0.37.0
func (r *ProjectsLocationsProcessorsProcessorVersionsService) BatchProcess(name string, googleclouddocumentaiv1beta3batchprocessrequest *GoogleCloudDocumentaiV1beta3BatchProcessRequest) *ProjectsLocationsProcessorsProcessorVersionsBatchProcessCall
BatchProcess: LRO endpoint to batch process many documents. The output is written 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}/proce ssorVersions/{processorVersion}.
func (*ProjectsLocationsProcessorsProcessorVersionsService) Process ¶ added in v0.37.0
func (r *ProjectsLocationsProcessorsProcessorVersionsService) Process(name string, googleclouddocumentaiv1beta3processrequest *GoogleCloudDocumentaiV1beta3ProcessRequest) *ProjectsLocationsProcessorsProcessorVersionsProcessCall
Process: Processes a single document.
- name: The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/proce ssorVersions/{processorVersion}.
type ProjectsLocationsProcessorsService ¶
type ProjectsLocationsProcessorsService struct { HumanReviewConfig *ProjectsLocationsProcessorsHumanReviewConfigService ProcessorVersions *ProjectsLocationsProcessorsProcessorVersionsService // contains filtered or unexported fields }
func NewProjectsLocationsProcessorsService ¶
func NewProjectsLocationsProcessorsService(s *Service) *ProjectsLocationsProcessorsService
func (*ProjectsLocationsProcessorsService) BatchProcess ¶
func (r *ProjectsLocationsProcessorsService) BatchProcess(name string, googleclouddocumentaiv1beta3batchprocessrequest *GoogleCloudDocumentaiV1beta3BatchProcessRequest) *ProjectsLocationsProcessorsBatchProcessCall
BatchProcess: LRO endpoint to batch process many documents. The output is written 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}/proce ssorVersions/{processorVersion}.
func (*ProjectsLocationsProcessorsService) Create ¶ added in v0.46.0
func (r *ProjectsLocationsProcessorsService) Create(parent string, googleclouddocumentaiv1beta3processor *GoogleCloudDocumentaiV1beta3Processor) *ProjectsLocationsProcessorsCreateCall
Create: Creates a processor from the type processor that the user chose. The processor will be at "ENABLED" state by default after its creation.
- parent: The parent (project and location) under which to create the processor. Format: projects/{project}/locations/{location}.
func (*ProjectsLocationsProcessorsService) Delete ¶ added in v0.46.0
func (r *ProjectsLocationsProcessorsService) Delete(name string) *ProjectsLocationsProcessorsDeleteCall
Delete: Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor.
- name: The processor resource name to be deleted.
func (*ProjectsLocationsProcessorsService) Disable ¶ added in v0.46.0
func (r *ProjectsLocationsProcessorsService) Disable(name string, googleclouddocumentaiv1beta3disableprocessorrequest *GoogleCloudDocumentaiV1beta3DisableProcessorRequest) *ProjectsLocationsProcessorsDisableCall
Disable: Disables a processor
- name: The processor resource name to be disabled.
func (*ProjectsLocationsProcessorsService) Enable ¶ added in v0.46.0
func (r *ProjectsLocationsProcessorsService) Enable(name string, googleclouddocumentaiv1beta3enableprocessorrequest *GoogleCloudDocumentaiV1beta3EnableProcessorRequest) *ProjectsLocationsProcessorsEnableCall
Enable: Enables a processor
- name: The processor resource name to be enabled.
func (*ProjectsLocationsProcessorsService) List ¶ added in v0.46.0
func (r *ProjectsLocationsProcessorsService) List(parent string) *ProjectsLocationsProcessorsListCall
List: Lists all processors which belong to this project.
- parent: The parent (project and location) which owns this collection of Processors. Format: projects/{project}/locations/{location}.
func (*ProjectsLocationsProcessorsService) Process ¶
func (r *ProjectsLocationsProcessorsService) Process(name string, googleclouddocumentaiv1beta3processrequest *GoogleCloudDocumentaiV1beta3ProcessRequest) *ProjectsLocationsProcessorsProcessCall
Process: Processes a single document.
- name: The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/proce ssorVersions/{processorVersion}.
type ProjectsLocationsService ¶
type ProjectsLocationsService struct { Operations *ProjectsLocationsOperationsService Processors *ProjectsLocationsProcessorsService // contains filtered or unexported fields }
func NewProjectsLocationsService ¶
func NewProjectsLocationsService(s *Service) *ProjectsLocationsService
func (*ProjectsLocationsService) FetchProcessorTypes ¶ added in v0.46.0
func (r *ProjectsLocationsService) FetchProcessorTypes(parent string) *ProjectsLocationsFetchProcessorTypesCall
FetchProcessorTypes: Fetches processor types.
- parent: The project of processor type to list. The available processor types may depend on the whitelisting on projects. Format: projects/{project}/locations/{location}.
func (*ProjectsLocationsService) Get ¶
func (r *ProjectsLocationsService) Get(name string) *ProjectsLocationsGetCall
Get: Gets information about a location.
- name: Resource name for the location.
func (*ProjectsLocationsService) List ¶
func (r *ProjectsLocationsService) List(name string) *ProjectsLocationsListCall
List: Lists information about the supported locations for this service.
- name: The resource that owns the locations collection, if applicable.
type ProjectsService ¶
type ProjectsService struct { Locations *ProjectsLocationsService // contains filtered or unexported fields }
func NewProjectsService ¶
func NewProjectsService(s *Service) *ProjectsService
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment Projects *ProjectsService // contains filtered or unexported fields }
func New
deprecated
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.
func NewService ¶
NewService creates a new Service.