aidocument

package
v65.35.0 Latest Latest
Warning

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

 Go to latest Published: Apr 11, 2023 License: Apache-2.0, UPL-1.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetDimensionsUnitEnumStringValues 

func GetDimensionsUnitEnumStringValues() []string

GetDimensionsUnitEnumStringValues Enumerates the set of values in String for DimensionsUnitEnum

func GetDocumentFeatureFeatureTypeEnumStringValues 

func GetDocumentFeatureFeatureTypeEnumStringValues() []string

GetDocumentFeatureFeatureTypeEnumStringValues Enumerates the set of values in String for DocumentFeatureFeatureTypeEnum

func GetDocumentFieldFieldTypeEnumStringValues 

func GetDocumentFieldFieldTypeEnumStringValues() []string

GetDocumentFieldFieldTypeEnumStringValues Enumerates the set of values in String for DocumentFieldFieldTypeEnum

func GetDocumentTypeEnumStringValues 

func GetDocumentTypeEnumStringValues() []string

GetDocumentTypeEnumStringValues Enumerates the set of values in String for DocumentTypeEnum

func GetFieldValueValueTypeEnumStringValues 

func GetFieldValueValueTypeEnumStringValues() []string

GetFieldValueValueTypeEnumStringValues Enumerates the set of values in String for FieldValueValueTypeEnum

func GetInputLocationSourceTypeEnumStringValues 

func GetInputLocationSourceTypeEnumStringValues() []string

GetInputLocationSourceTypeEnumStringValues Enumerates the set of values in String for InputLocationSourceTypeEnum

func GetProcessorJobLifecycleDetailsEnumStringValues 

func GetProcessorJobLifecycleDetailsEnumStringValues() []string

GetProcessorJobLifecycleDetailsEnumStringValues Enumerates the set of values in String for ProcessorJobLifecycleDetailsEnum

func GetProcessorJobLifecycleStateEnumStringValues 

func GetProcessorJobLifecycleStateEnumStringValues() []string

GetProcessorJobLifecycleStateEnumStringValues Enumerates the set of values in String for ProcessorJobLifecycleStateEnum

func GetProcessorTypeEnumStringValues 

func GetProcessorTypeEnumStringValues() []string

GetProcessorTypeEnumStringValues Enumerates the set of values in String for ProcessorTypeEnum

Types

type AIServiceDocumentClient 

type AIServiceDocumentClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

AIServiceDocumentClient a client for AIServiceDocument

func NewAIServiceDocumentClientWithConfigurationProvider 

func NewAIServiceDocumentClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client AIServiceDocumentClient, err error)

NewAIServiceDocumentClientWithConfigurationProvider Creates a new default AIServiceDocument client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func NewAIServiceDocumentClientWithOboToken 

func NewAIServiceDocumentClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client AIServiceDocumentClient, err error)

NewAIServiceDocumentClientWithOboToken Creates a new default AIServiceDocument client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer 

as well as reading the region

func (AIServiceDocumentClient) CancelProcessorJob 

func (client AIServiceDocumentClient) CancelProcessorJob(ctx context.Context, request CancelProcessorJobRequest) (response CancelProcessorJobResponse, err error)

CancelProcessorJob Cancel a processor job.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/CancelProcessorJob.go.html to see an example of how to use CancelProcessorJob API.

func (*AIServiceDocumentClient) ConfigurationProvider 

func (client *AIServiceDocumentClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (AIServiceDocumentClient) CreateProcessorJob 

func (client AIServiceDocumentClient) CreateProcessorJob(ctx context.Context, request CreateProcessorJobRequest) (response CreateProcessorJobResponse, err error)

CreateProcessorJob Create a processor job for document analysis.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/CreateProcessorJob.go.html to see an example of how to use CreateProcessorJob API. A default retry strategy applies to this operation CreateProcessorJob()

func (AIServiceDocumentClient) GetProcessorJob 

func (client AIServiceDocumentClient) GetProcessorJob(ctx context.Context, request GetProcessorJobRequest) (response GetProcessorJobResponse, err error)

GetProcessorJob Get the details of a processor job.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/GetProcessorJob.go.html to see an example of how to use GetProcessorJob API. A default retry strategy applies to this operation GetProcessorJob()

func (*AIServiceDocumentClient) SetRegion 

func (client *AIServiceDocumentClient) SetRegion(region string)

SetRegion overrides the region of this client.

type AnalyzeDocumentResult 

type AnalyzeDocumentResult struct {
	DocumentMetadata *DocumentMetadata `mandatory:"true" json:"documentMetadata"`

	// The array of a Page.
	Pages []Page `mandatory:"true" json:"pages"`

	// An array of detected document types.
	DetectedDocumentTypes []DetectedDocumentType `mandatory:"false" json:"detectedDocumentTypes"`

	// An array of detected languages.
	DetectedLanguages []DetectedLanguage `mandatory:"false" json:"detectedLanguages"`

	// The document classification model version.
	DocumentClassificationModelVersion *string `mandatory:"false" json:"documentClassificationModelVersion"`

	// The document language classification model version.
	LanguageClassificationModelVersion *string `mandatory:"false" json:"languageClassificationModelVersion"`

	// The document text extraction model version.
	TextExtractionModelVersion *string `mandatory:"false" json:"textExtractionModelVersion"`

	// The document keyValue extraction model version.
	KeyValueExtractionModelVersion *string `mandatory:"false" json:"keyValueExtractionModelVersion"`

	// The document table extraction model version.
	TableExtractionModelVersion *string `mandatory:"false" json:"tableExtractionModelVersion"`

	// The errors encountered during document analysis.
	Errors []ProcessingError `mandatory:"false" json:"errors"`

	// The searchable PDF file that was generated.
	SearchablePdf []byte `mandatory:"false" json:"searchablePdf"`
}

AnalyzeDocumentResult The document analysis results.

func (AnalyzeDocumentResult) String 

func (m AnalyzeDocumentResult) String() string

func (AnalyzeDocumentResult) ValidateEnumValue 

func (m AnalyzeDocumentResult) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type BoundingPolygon 

type BoundingPolygon struct {

	// An array of normalized points defining the polygon's perimeter, with an implicit segment between subsequent points and between the first and last point.
	// Rectangles are defined with four points. For example, `[{"x": 0, "y": 0}, {"x": 1, "y": 0}, {"x": 1, "y": 0.5}, {"x": 0, "y": 0.5}]` represents the top half of an image.
	NormalizedVertices []NormalizedVertex `mandatory:"true" json:"normalizedVertices"`
}

BoundingPolygon The object-bounding polygon box.

func (BoundingPolygon) String 

func (m BoundingPolygon) String() string

func (BoundingPolygon) ValidateEnumValue 

func (m BoundingPolygon) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CancelProcessorJobRequest 

type CancelProcessorJobRequest struct {

	// Processor job id.
	ProcessorJobId *string `mandatory:"true" contributesTo:"path" name:"processorJobId"`

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

CancelProcessorJobRequest wrapper for the CancelProcessorJob operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/CancelProcessorJob.go.html to see an example of how to use CancelProcessorJobRequest.

func (CancelProcessorJobRequest) BinaryRequestBody 

func (request CancelProcessorJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CancelProcessorJobRequest) HTTPRequest 

func (request CancelProcessorJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CancelProcessorJobRequest) RetryPolicy 

func (request CancelProcessorJobRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CancelProcessorJobRequest) String 

func (request CancelProcessorJobRequest) String() string

func (CancelProcessorJobRequest) ValidateEnumValue 

func (request CancelProcessorJobRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CancelProcessorJobResponse 

type CancelProcessorJobResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

CancelProcessorJobResponse wrapper for the CancelProcessorJob operation

func (CancelProcessorJobResponse) HTTPResponse 

func (response CancelProcessorJobResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CancelProcessorJobResponse) String 

func (response CancelProcessorJobResponse) String() string

type Cell 

type Cell struct {

	// The text recognized in the cell.
	Text *string `mandatory:"true" json:"text"`

	// The index of the cell inside the row.
	RowIndex *int `mandatory:"true" json:"rowIndex"`

	// The index of the cell inside the column.
	ColumnIndex *int `mandatory:"true" json:"columnIndex"`

	// The confidence score between 0 and 1.
	Confidence *float32 `mandatory:"true" json:"confidence"`

	BoundingPolygon *BoundingPolygon `mandatory:"true" json:"boundingPolygon"`

	// The words detected in the cell.
	WordIndexes []int `mandatory:"true" json:"wordIndexes"`
}

Cell A single cell in a table.

func (Cell) String 

func (m Cell) String() string

func (Cell) ValidateEnumValue 

func (m Cell) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateProcessorJobDetails 

type CreateProcessorJobDetails struct {
	InputLocation InputLocation `mandatory:"true" json:"inputLocation"`

	OutputLocation *OutputLocation `mandatory:"true" json:"outputLocation"`

	// The compartment identifier.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	ProcessorConfig ProcessorConfig `mandatory:"true" json:"processorConfig"`

	// The display name of the processor job.
	DisplayName *string `mandatory:"false" json:"displayName"`
}

CreateProcessorJobDetails The details used to create a processor job.

func (CreateProcessorJobDetails) String 

func (m CreateProcessorJobDetails) String() string

func (*CreateProcessorJobDetails) UnmarshalJSON 

func (m *CreateProcessorJobDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (CreateProcessorJobDetails) ValidateEnumValue 

func (m CreateProcessorJobDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateProcessorJobRequest 

type CreateProcessorJobRequest struct {

	// The details for creating the processor job.
	CreateProcessorJobDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without the risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

CreateProcessorJobRequest wrapper for the CreateProcessorJob operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/CreateProcessorJob.go.html to see an example of how to use CreateProcessorJobRequest.

func (CreateProcessorJobRequest) BinaryRequestBody 

func (request CreateProcessorJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateProcessorJobRequest) HTTPRequest 

func (request CreateProcessorJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateProcessorJobRequest) RetryPolicy 

func (request CreateProcessorJobRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateProcessorJobRequest) String 

func (request CreateProcessorJobRequest) String() string

func (CreateProcessorJobRequest) ValidateEnumValue 

func (request CreateProcessorJobRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateProcessorJobResponse 

type CreateProcessorJobResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The ProcessorJob instance
	ProcessorJob `presentIn:"body"`

	// A unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

CreateProcessorJobResponse wrapper for the CreateProcessorJob operation

func (CreateProcessorJobResponse) HTTPResponse 

func (response CreateProcessorJobResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateProcessorJobResponse) String 

func (response CreateProcessorJobResponse) String() string

type DetectedDocumentType 

type DetectedDocumentType struct {

	// The document type.
	DocumentType *string `mandatory:"true" json:"documentType"`

	// The confidence score between 0 and 1.
	Confidence *float32 `mandatory:"true" json:"confidence"`
}

DetectedDocumentType The detected document type.

func (DetectedDocumentType) String 

func (m DetectedDocumentType) String() string

func (DetectedDocumentType) ValidateEnumValue 

func (m DetectedDocumentType) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DetectedLanguage 

type DetectedLanguage struct {

	// The document language, abbreviated according to the BCP 47 syntax.
	Language *string `mandatory:"true" json:"language"`

	// The confidence score between 0 and 1.
	Confidence *float32 `mandatory:"true" json:"confidence"`
}

DetectedLanguage The language detected in a document.

func (DetectedLanguage) String 

func (m DetectedLanguage) String() string

func (DetectedLanguage) ValidateEnumValue 

func (m DetectedLanguage) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type Dimensions 

type Dimensions struct {

	// the width of a page.
	Width *float64 `mandatory:"true" json:"width"`

	// The height of a page.
	Height *float64 `mandatory:"true" json:"height"`

	// The unit of length.
	Unit DimensionsUnitEnum `mandatory:"true" json:"unit"`
}

Dimensions The width and height of a page.

func (Dimensions) String 

func (m Dimensions) String() string

func (Dimensions) ValidateEnumValue 

func (m Dimensions) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DimensionsUnitEnum 

type DimensionsUnitEnum string

DimensionsUnitEnum Enum with underlying type: string 

const (
	DimensionsUnitPixel DimensionsUnitEnum = "PIXEL"
	DimensionsUnitInch  DimensionsUnitEnum = "INCH"
)

Set of constants representing the allowable values for DimensionsUnitEnum

func GetDimensionsUnitEnumValues 

func GetDimensionsUnitEnumValues() []DimensionsUnitEnum

GetDimensionsUnitEnumValues Enumerates the set of values for DimensionsUnitEnum

func GetMappingDimensionsUnitEnum 

func GetMappingDimensionsUnitEnum(val string) (DimensionsUnitEnum, bool)

GetMappingDimensionsUnitEnum performs case Insensitive comparison on enum value and return the desired enum

type DocumentClassificationFeature 

type DocumentClassificationFeature struct {

	// The maximum number of results to return.
	MaxResults *int `mandatory:"false" json:"maxResults"`
}

DocumentClassificationFeature Identifying the document type.

func (DocumentClassificationFeature) MarshalJSON 

func (m DocumentClassificationFeature) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (DocumentClassificationFeature) String 

func (m DocumentClassificationFeature) String() string

func (DocumentClassificationFeature) ValidateEnumValue 

func (m DocumentClassificationFeature) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DocumentFeature 

type DocumentFeature interface {
}

DocumentFeature The type of document analysis.

type DocumentFeatureFeatureTypeEnum 

type DocumentFeatureFeatureTypeEnum string

DocumentFeatureFeatureTypeEnum Enum with underlying type: string 

const (
	DocumentFeatureFeatureTypeLanguageClassification DocumentFeatureFeatureTypeEnum = "LANGUAGE_CLASSIFICATION"
	DocumentFeatureFeatureTypeTextExtraction         DocumentFeatureFeatureTypeEnum = "TEXT_EXTRACTION"
	DocumentFeatureFeatureTypeTableExtraction        DocumentFeatureFeatureTypeEnum = "TABLE_EXTRACTION"
	DocumentFeatureFeatureTypeKeyValueExtraction     DocumentFeatureFeatureTypeEnum = "KEY_VALUE_EXTRACTION"
	DocumentFeatureFeatureTypeDocumentClassification DocumentFeatureFeatureTypeEnum = "DOCUMENT_CLASSIFICATION"
)

Set of constants representing the allowable values for DocumentFeatureFeatureTypeEnum

func GetDocumentFeatureFeatureTypeEnumValues 

func GetDocumentFeatureFeatureTypeEnumValues() []DocumentFeatureFeatureTypeEnum

GetDocumentFeatureFeatureTypeEnumValues Enumerates the set of values for DocumentFeatureFeatureTypeEnum

func GetMappingDocumentFeatureFeatureTypeEnum 

func GetMappingDocumentFeatureFeatureTypeEnum(val string) (DocumentFeatureFeatureTypeEnum, bool)

GetMappingDocumentFeatureFeatureTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type DocumentField 

type DocumentField struct {

	// The field type.
	FieldType DocumentFieldFieldTypeEnum `mandatory:"true" json:"fieldType"`

	FieldValue FieldValue `mandatory:"true" json:"fieldValue"`

	FieldLabel *FieldLabel `mandatory:"false" json:"fieldLabel"`

	FieldName *FieldName `mandatory:"false" json:"fieldName"`
}

DocumentField Form field.

func (DocumentField) String 

func (m DocumentField) String() string

func (*DocumentField) UnmarshalJSON 

func (m *DocumentField) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (DocumentField) ValidateEnumValue 

func (m DocumentField) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DocumentFieldFieldTypeEnum 

type DocumentFieldFieldTypeEnum string

DocumentFieldFieldTypeEnum Enum with underlying type: string 

const (
	DocumentFieldFieldTypeLineItemGroup DocumentFieldFieldTypeEnum = "LINE_ITEM_GROUP"
	DocumentFieldFieldTypeLineItem      DocumentFieldFieldTypeEnum = "LINE_ITEM"
	DocumentFieldFieldTypeLineItemField DocumentFieldFieldTypeEnum = "LINE_ITEM_FIELD"
	DocumentFieldFieldTypeKeyValue      DocumentFieldFieldTypeEnum = "KEY_VALUE"
)

Set of constants representing the allowable values for DocumentFieldFieldTypeEnum

func GetDocumentFieldFieldTypeEnumValues 

func GetDocumentFieldFieldTypeEnumValues() []DocumentFieldFieldTypeEnum

GetDocumentFieldFieldTypeEnumValues Enumerates the set of values for DocumentFieldFieldTypeEnum

func GetMappingDocumentFieldFieldTypeEnum 

func GetMappingDocumentFieldFieldTypeEnum(val string) (DocumentFieldFieldTypeEnum, bool)

GetMappingDocumentFieldFieldTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type DocumentKeyValueExtractionFeature 

type DocumentKeyValueExtractionFeature struct {
}

DocumentKeyValueExtractionFeature Extracting form fields.

func (DocumentKeyValueExtractionFeature) MarshalJSON 

func (m DocumentKeyValueExtractionFeature) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (DocumentKeyValueExtractionFeature) String 

func (m DocumentKeyValueExtractionFeature) String() string

func (DocumentKeyValueExtractionFeature) ValidateEnumValue 

func (m DocumentKeyValueExtractionFeature) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DocumentLanguageClassificationFeature 

type DocumentLanguageClassificationFeature struct {

	// The maximum number of results to return.
	MaxResults *int `mandatory:"false" json:"maxResults"`
}

DocumentLanguageClassificationFeature Detecting the language of the document.

func (DocumentLanguageClassificationFeature) MarshalJSON 

func (m DocumentLanguageClassificationFeature) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (DocumentLanguageClassificationFeature) String 

func (m DocumentLanguageClassificationFeature) String() string

func (DocumentLanguageClassificationFeature) ValidateEnumValue 

func (m DocumentLanguageClassificationFeature) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DocumentMetadata 

type DocumentMetadata struct {

	// Teh number of pages in the document.
	PageCount *int `mandatory:"true" json:"pageCount"`

	// The result data format.
	MimeType *string `mandatory:"true" json:"mimeType"`
}

DocumentMetadata The document information.

func (DocumentMetadata) String 

func (m DocumentMetadata) String() string

func (DocumentMetadata) ValidateEnumValue 

func (m DocumentMetadata) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DocumentTableExtractionFeature 

type DocumentTableExtractionFeature struct {
}

DocumentTableExtractionFeature Detecting and extracting data in tables.

func (DocumentTableExtractionFeature) MarshalJSON 

func (m DocumentTableExtractionFeature) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (DocumentTableExtractionFeature) String 

func (m DocumentTableExtractionFeature) String() string

func (DocumentTableExtractionFeature) ValidateEnumValue 

func (m DocumentTableExtractionFeature) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DocumentTextExtractionFeature 

type DocumentTextExtractionFeature struct {

	// Whether or not to generate a searchable PDF file.
	GenerateSearchablePdf *bool `mandatory:"false" json:"generateSearchablePdf"`
}

DocumentTextExtractionFeature Text recognition

func (DocumentTextExtractionFeature) MarshalJSON 

func (m DocumentTextExtractionFeature) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (DocumentTextExtractionFeature) String 

func (m DocumentTextExtractionFeature) String() string

func (DocumentTextExtractionFeature) ValidateEnumValue 

func (m DocumentTextExtractionFeature) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DocumentTypeEnum 

type DocumentTypeEnum string

DocumentTypeEnum Enum with underlying type: string 

const (
	DocumentTypeInvoice       DocumentTypeEnum = "INVOICE"
	DocumentTypeReceipt       DocumentTypeEnum = "RECEIPT"
	DocumentTypeResume        DocumentTypeEnum = "RESUME"
	DocumentTypeTaxForm       DocumentTypeEnum = "TAX_FORM"
	DocumentTypeDriverLicense DocumentTypeEnum = "DRIVER_LICENSE"
	DocumentTypePassport      DocumentTypeEnum = "PASSPORT"
	DocumentTypeBankStatement DocumentTypeEnum = "BANK_STATEMENT"
	DocumentTypeCheck         DocumentTypeEnum = "CHECK"
	DocumentTypePayslip       DocumentTypeEnum = "PAYSLIP"
	DocumentTypeOthers        DocumentTypeEnum = "OTHERS"
)

Set of constants representing the allowable values for DocumentTypeEnum

func GetDocumentTypeEnumValues 

func GetDocumentTypeEnumValues() []DocumentTypeEnum

GetDocumentTypeEnumValues Enumerates the set of values for DocumentTypeEnum

func GetMappingDocumentTypeEnum 

func GetMappingDocumentTypeEnum(val string) (DocumentTypeEnum, bool)

GetMappingDocumentTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type FieldLabel 

type FieldLabel struct {

	// The name of the field label.
	Name *string `mandatory:"true" json:"name"`

	// The confidence score between 0 and 1.
	Confidence *float32 `mandatory:"false" json:"confidence"`
}

FieldLabel The label in a field.

func (FieldLabel) String 

func (m FieldLabel) String() string

func (FieldLabel) ValidateEnumValue 

func (m FieldLabel) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type FieldName 

type FieldName struct {

	// The name of the field.
	Name *string `mandatory:"true" json:"name"`

	// The confidence score between 0 and 1.
	Confidence *float32 `mandatory:"false" json:"confidence"`

	BoundingPolygon *BoundingPolygon `mandatory:"false" json:"boundingPolygon"`

	// The indexes of the words in the field name.
	WordIndexes []int `mandatory:"false" json:"wordIndexes"`
}

FieldName The name of a form field.

func (FieldName) String 

func (m FieldName) String() string

func (FieldName) ValidateEnumValue 

func (m FieldName) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type FieldValue 

type FieldValue interface {

	// The confidence score between 0 and 1.
	GetConfidence() *float32

	GetBoundingPolygon() *BoundingPolygon

	// The indexes of the words in the field value.
	GetWordIndexes() []int

	// The detected text of a field.
	GetText() *string
}

FieldValue The value of a form field.

type FieldValueValueTypeEnum 

type FieldValueValueTypeEnum string

FieldValueValueTypeEnum Enum with underlying type: string 

const (
	FieldValueValueTypeString      FieldValueValueTypeEnum = "STRING"
	FieldValueValueTypeDate        FieldValueValueTypeEnum = "DATE"
	FieldValueValueTypeTime        FieldValueValueTypeEnum = "TIME"
	FieldValueValueTypePhoneNumber FieldValueValueTypeEnum = "PHONE_NUMBER"
	FieldValueValueTypeNumber      FieldValueValueTypeEnum = "NUMBER"
	FieldValueValueTypeInteger     FieldValueValueTypeEnum = "INTEGER"
	FieldValueValueTypeArray       FieldValueValueTypeEnum = "ARRAY"
)

Set of constants representing the allowable values for FieldValueValueTypeEnum

func GetFieldValueValueTypeEnumValues 

func GetFieldValueValueTypeEnumValues() []FieldValueValueTypeEnum

GetFieldValueValueTypeEnumValues Enumerates the set of values for FieldValueValueTypeEnum

func GetMappingFieldValueValueTypeEnum 

func GetMappingFieldValueValueTypeEnum(val string) (FieldValueValueTypeEnum, bool)

GetMappingFieldValueValueTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type GeneralProcessorConfig 

type GeneralProcessorConfig struct {

	// The types of document analysis requested.
	Features []DocumentFeature `mandatory:"true" json:"features"`

	// Whether or not to generate a ZIP file containing the results.
	IsZipOutputEnabled *bool `mandatory:"false" json:"isZipOutputEnabled"`

	// The document language, abbreviated according to the BCP 47 Language-Tag syntax.
	Language *string `mandatory:"false" json:"language"`

	// The document type.
	DocumentType DocumentTypeEnum `mandatory:"false" json:"documentType,omitempty"`
}

GeneralProcessorConfig The configuration of a general processor.

func (GeneralProcessorConfig) MarshalJSON 

func (m GeneralProcessorConfig) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (GeneralProcessorConfig) String 

func (m GeneralProcessorConfig) String() string

func (*GeneralProcessorConfig) UnmarshalJSON 

func (m *GeneralProcessorConfig) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (GeneralProcessorConfig) ValidateEnumValue 

func (m GeneralProcessorConfig) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetProcessorJobRequest 

type GetProcessorJobRequest struct {

	// Processor job id.
	ProcessorJobId *string `mandatory:"true" contributesTo:"path" name:"processorJobId"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

GetProcessorJobRequest wrapper for the GetProcessorJob operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aidocument/GetProcessorJob.go.html to see an example of how to use GetProcessorJobRequest.

func (GetProcessorJobRequest) BinaryRequestBody 

func (request GetProcessorJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetProcessorJobRequest) HTTPRequest 

func (request GetProcessorJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetProcessorJobRequest) RetryPolicy 

func (request GetProcessorJobRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetProcessorJobRequest) String 

func (request GetProcessorJobRequest) String() string

func (GetProcessorJobRequest) ValidateEnumValue 

func (request GetProcessorJobRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetProcessorJobResponse 

type GetProcessorJobResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The ProcessorJob instance
	ProcessorJob `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// A unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetProcessorJobResponse wrapper for the GetProcessorJob operation

func (GetProcessorJobResponse) HTTPResponse 

func (response GetProcessorJobResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetProcessorJobResponse) String 

func (response GetProcessorJobResponse) String() string

type InlineDocumentContent 

type InlineDocumentContent struct {

	// Raw document data with Base64 encoding.
	Data []byte `mandatory:"true" json:"data"`
}

InlineDocumentContent The content of an inline document.

func (InlineDocumentContent) MarshalJSON 

func (m InlineDocumentContent) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (InlineDocumentContent) String 

func (m InlineDocumentContent) String() string

func (InlineDocumentContent) ValidateEnumValue 

func (m InlineDocumentContent) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type InputLocation 

type InputLocation interface {
}

InputLocation The location of the inputs.

type InputLocationSourceTypeEnum 

type InputLocationSourceTypeEnum string

InputLocationSourceTypeEnum Enum with underlying type: string 

const (
	InputLocationSourceTypeObjectStorageLocations InputLocationSourceTypeEnum = "OBJECT_STORAGE_LOCATIONS"
	InputLocationSourceTypeInlineDocumentContent  InputLocationSourceTypeEnum = "INLINE_DOCUMENT_CONTENT"
)

Set of constants representing the allowable values for InputLocationSourceTypeEnum

func GetInputLocationSourceTypeEnumValues 

func GetInputLocationSourceTypeEnumValues() []InputLocationSourceTypeEnum

GetInputLocationSourceTypeEnumValues Enumerates the set of values for InputLocationSourceTypeEnum

func GetMappingInputLocationSourceTypeEnum 

func GetMappingInputLocationSourceTypeEnum(val string) (InputLocationSourceTypeEnum, bool)

GetMappingInputLocationSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type Line 

type Line struct {

	// The text recognized.
	Text *string `mandatory:"true" json:"text"`

	// The confidence score between 0 and 1.
	Confidence *float32 `mandatory:"true" json:"confidence"`

	BoundingPolygon *BoundingPolygon `mandatory:"true" json:"boundingPolygon"`

	// The array of words.
	WordIndexes []int `mandatory:"true" json:"wordIndexes"`
}

Line The line of text.

func (Line) String 

func (m Line) String() string

func (Line) ValidateEnumValue 

func (m Line) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type NormalizedVertex 

type NormalizedVertex struct {

	// The X-axis normalized coordinate.
	X *float64 `mandatory:"true" json:"x"`

	// The Y-axis normalized coordinate.
	Y *float64 `mandatory:"true" json:"y"`
}

NormalizedVertex An (x, y) coordinate in the image with dimensions normalized from zero to one. The origin is at top left, with the positive x-axis pointing right and the positive y-axis pointing down. The bottom right corner is at (1, 1).

func (NormalizedVertex) String 

func (m NormalizedVertex) String() string

func (NormalizedVertex) ValidateEnumValue 

func (m NormalizedVertex) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ObjectLocation 

type ObjectLocation struct {

	// The Object Storage namespace name.
	NamespaceName *string `mandatory:"true" json:"namespaceName"`

	// The Object Storage bucket name.
	BucketName *string `mandatory:"true" json:"bucketName"`

	// The Object Storage object name.
	ObjectName *string `mandatory:"true" json:"objectName"`
}

ObjectLocation A location in Object Storage that is uniquely identified by namespace name, bucket name and object name.

func (ObjectLocation) String 

func (m ObjectLocation) String() string

func (ObjectLocation) ValidateEnumValue 

func (m ObjectLocation) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ObjectStorageLocations 

type ObjectStorageLocations struct {

	// The list of ObjectLocations.
	ObjectLocations []ObjectLocation `mandatory:"true" json:"objectLocations"`
}

ObjectStorageLocations A list of object locations in Object Storage.

func (ObjectStorageLocations) MarshalJSON 

func (m ObjectStorageLocations) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ObjectStorageLocations) String 

func (m ObjectStorageLocations) String() string

func (ObjectStorageLocations) ValidateEnumValue 

func (m ObjectStorageLocations) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type OutputLocation 

type OutputLocation struct {

	// The Object Storage namespace.
	NamespaceName *string `mandatory:"true" json:"namespaceName"`

	// The Object Storage bucket name.
	BucketName *string `mandatory:"true" json:"bucketName"`

	// The Object Storage folder name.
	Prefix *string `mandatory:"true" json:"prefix"`
}

OutputLocation The Object Storage Location.

func (OutputLocation) String 

func (m OutputLocation) String() string

func (OutputLocation) ValidateEnumValue 

func (m OutputLocation) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type Page 

type Page struct {

	// The document page number.
	PageNumber *int `mandatory:"true" json:"pageNumber"`

	Dimensions *Dimensions `mandatory:"false" json:"dimensions"`

	// An array of detected document types.
	DetectedDocumentTypes []DetectedDocumentType `mandatory:"false" json:"detectedDocumentTypes"`

	// An array of detected languages.
	DetectedLanguages []DetectedLanguage `mandatory:"false" json:"detectedLanguages"`

	// The words detected on the page.
	Words []Word `mandatory:"false" json:"words"`

	// The lines of text detected on the page.
	Lines []Line `mandatory:"false" json:"lines"`

	// The tables detected on the page.
	Tables []Table `mandatory:"false" json:"tables"`

	// The form fields detected on the page.
	DocumentFields []DocumentField `mandatory:"false" json:"documentFields"`
}

Page One page document analysis result.

func (Page) String 

func (m Page) String() string

func (Page) ValidateEnumValue 

func (m Page) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ProcessingError 

type ProcessingError struct {

	// The error code.
	Code *string `mandatory:"true" json:"code"`

	// The error message.
	Message *string `mandatory:"true" json:"message"`
}

ProcessingError The error in document processing.

func (ProcessingError) String 

func (m ProcessingError) String() string

func (ProcessingError) ValidateEnumValue 

func (m ProcessingError) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ProcessorConfig 

type ProcessorConfig interface {
}

ProcessorConfig The configuration of a processor.

type ProcessorJob 

type ProcessorJob struct {

	// The id of the processor job.
	Id *string `mandatory:"true" json:"id"`

	// The compartment identifier.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	ProcessorConfig ProcessorConfig `mandatory:"true" json:"processorConfig"`

	// The job acceptance time.
	TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`

	OutputLocation *OutputLocation `mandatory:"true" json:"outputLocation"`

	// The current state of the processor job.
	LifecycleState ProcessorJobLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The display name of the processor job.
	DisplayName *string `mandatory:"false" json:"displayName"`

	InputLocation InputLocation `mandatory:"false" json:"inputLocation"`

	// The job start time.
	TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

	// The job finish time.
	TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`

	// How much progress the operation has made, compared to the total amount of work to be performed.
	PercentComplete *float32 `mandatory:"false" json:"percentComplete"`

	// The detailed status of FAILED state.
	LifecycleDetails ProcessorJobLifecycleDetailsEnum `mandatory:"false" json:"lifecycleDetails,omitempty"`
}

ProcessorJob Details of a processor job.

func (ProcessorJob) String 

func (m ProcessorJob) String() string

func (*ProcessorJob) UnmarshalJSON 

func (m *ProcessorJob) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (ProcessorJob) ValidateEnumValue 

func (m ProcessorJob) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ProcessorJobLifecycleDetailsEnum 

type ProcessorJobLifecycleDetailsEnum string

ProcessorJobLifecycleDetailsEnum Enum with underlying type: string 

const (
	ProcessorJobLifecycleDetailsPartiallySucceeded ProcessorJobLifecycleDetailsEnum = "PARTIALLY_SUCCEEDED"
	ProcessorJobLifecycleDetailsCompletelyFailed   ProcessorJobLifecycleDetailsEnum = "COMPLETELY_FAILED"
)

Set of constants representing the allowable values for ProcessorJobLifecycleDetailsEnum

func GetMappingProcessorJobLifecycleDetailsEnum 

func GetMappingProcessorJobLifecycleDetailsEnum(val string) (ProcessorJobLifecycleDetailsEnum, bool)

GetMappingProcessorJobLifecycleDetailsEnum performs case Insensitive comparison on enum value and return the desired enum

func GetProcessorJobLifecycleDetailsEnumValues 

func GetProcessorJobLifecycleDetailsEnumValues() []ProcessorJobLifecycleDetailsEnum

GetProcessorJobLifecycleDetailsEnumValues Enumerates the set of values for ProcessorJobLifecycleDetailsEnum

type ProcessorJobLifecycleStateEnum 

type ProcessorJobLifecycleStateEnum string

ProcessorJobLifecycleStateEnum Enum with underlying type: string 

const (
	ProcessorJobLifecycleStateSucceeded  ProcessorJobLifecycleStateEnum = "SUCCEEDED"
	ProcessorJobLifecycleStateFailed     ProcessorJobLifecycleStateEnum = "FAILED"
	ProcessorJobLifecycleStateAccepted   ProcessorJobLifecycleStateEnum = "ACCEPTED"
	ProcessorJobLifecycleStateCanceled   ProcessorJobLifecycleStateEnum = "CANCELED"
	ProcessorJobLifecycleStateInProgress ProcessorJobLifecycleStateEnum = "IN_PROGRESS"
	ProcessorJobLifecycleStateCanceling  ProcessorJobLifecycleStateEnum = "CANCELING"
)

Set of constants representing the allowable values for ProcessorJobLifecycleStateEnum

func GetMappingProcessorJobLifecycleStateEnum 

func GetMappingProcessorJobLifecycleStateEnum(val string) (ProcessorJobLifecycleStateEnum, bool)

GetMappingProcessorJobLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetProcessorJobLifecycleStateEnumValues 

func GetProcessorJobLifecycleStateEnumValues() []ProcessorJobLifecycleStateEnum

GetProcessorJobLifecycleStateEnumValues Enumerates the set of values for ProcessorJobLifecycleStateEnum

type ProcessorTypeEnum 

type ProcessorTypeEnum string

ProcessorTypeEnum Enum with underlying type: string 

const (
	ProcessorTypeGeneral ProcessorTypeEnum = "GENERAL"
)

Set of constants representing the allowable values for ProcessorTypeEnum

func GetMappingProcessorTypeEnum 

func GetMappingProcessorTypeEnum(val string) (ProcessorTypeEnum, bool)

GetMappingProcessorTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetProcessorTypeEnumValues 

func GetProcessorTypeEnumValues() []ProcessorTypeEnum

GetProcessorTypeEnumValues Enumerates the set of values for ProcessorTypeEnum

type Table 

type Table struct {

	// The number of rows.
	RowCount *int `mandatory:"true" json:"rowCount"`

	// The number of columns.
	ColumnCount *int `mandatory:"true" json:"columnCount"`

	// The header rows.
	HeaderRows []TableRow `mandatory:"true" json:"headerRows"`

	// The body rows.
	BodyRows []TableRow `mandatory:"true" json:"bodyRows"`

	// the footer rows.
	FooterRows []TableRow `mandatory:"true" json:"footerRows"`

	// The confidence score between 0 and 1.
	Confidence *float32 `mandatory:"true" json:"confidence"`

	BoundingPolygon *BoundingPolygon `mandatory:"true" json:"boundingPolygon"`
}

Table The table extracted from a document.

func (Table) String 

func (m Table) String() string

func (Table) ValidateEnumValue 

func (m Table) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type TableRow 

type TableRow struct {

	// The cells in the row.
	Cells []Cell `mandatory:"true" json:"cells"`
}

TableRow A single row in a table.

func (TableRow) String 

func (m TableRow) String() string

func (TableRow) ValidateEnumValue 

func (m TableRow) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ValueArray 

type ValueArray struct {

	// The confidence score between 0 and 1.
	Confidence *float32 `mandatory:"true" json:"confidence"`

	BoundingPolygon *BoundingPolygon `mandatory:"true" json:"boundingPolygon"`

	// The indexes of the words in the field value.
	WordIndexes []int `mandatory:"true" json:"wordIndexes"`

	Items []DocumentField `mandatory:"true" json:"items"`

	// The detected text of a field.
	Text *string `mandatory:"false" json:"text"`
}

ValueArray The array of field values.

func (ValueArray) GetBoundingPolygon 

func (m ValueArray) GetBoundingPolygon() *BoundingPolygon

GetBoundingPolygon returns BoundingPolygon

func (ValueArray) GetConfidence 

func (m ValueArray) GetConfidence() *float32

GetConfidence returns Confidence

func (ValueArray) GetText 

func (m ValueArray) GetText() *string

GetText returns Text

func (ValueArray) GetWordIndexes 

func (m ValueArray) GetWordIndexes() []int

GetWordIndexes returns WordIndexes

func (ValueArray) MarshalJSON 

func (m ValueArray) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ValueArray) String 

func (m ValueArray) String() string

func (ValueArray) ValidateEnumValue 

func (m ValueArray) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ValueDate 

type ValueDate struct {

	// The confidence score between 0 and 1.
	Confidence *float32 `mandatory:"true" json:"confidence"`

	BoundingPolygon *BoundingPolygon `mandatory:"true" json:"boundingPolygon"`

	// The indexes of the words in the field value.
	WordIndexes []int `mandatory:"true" json:"wordIndexes"`

	// The date field value as yyyy-mm-dd.
	Value *common.SDKTime `mandatory:"true" json:"value"`

	// The detected text of a field.
	Text *string `mandatory:"false" json:"text"`
}

ValueDate The date field value.

func (ValueDate) GetBoundingPolygon 

func (m ValueDate) GetBoundingPolygon() *BoundingPolygon

GetBoundingPolygon returns BoundingPolygon

func (ValueDate) GetConfidence 

func (m ValueDate) GetConfidence() *float32

GetConfidence returns Confidence

func (ValueDate) GetText 

func (m ValueDate) GetText() *string

GetText returns Text

func (ValueDate) GetWordIndexes 

func (m ValueDate) GetWordIndexes() []int

GetWordIndexes returns WordIndexes

func (ValueDate) MarshalJSON 

func (m ValueDate) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ValueDate) String 

func (m ValueDate) String() string

func (ValueDate) ValidateEnumValue 

func (m ValueDate) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ValueInteger 

type ValueInteger struct {

	// The confidence score between 0 and 1.
	Confidence *float32 `mandatory:"true" json:"confidence"`

	BoundingPolygon *BoundingPolygon `mandatory:"true" json:"boundingPolygon"`

	// The indexes of the words in the field value.
	WordIndexes []int `mandatory:"true" json:"wordIndexes"`

	// The integer value.
	Value *int `mandatory:"true" json:"value"`

	// The detected text of a field.
	Text *string `mandatory:"false" json:"text"`
}

ValueInteger The integer field value.

func (ValueInteger) GetBoundingPolygon 

func (m ValueInteger) GetBoundingPolygon() *BoundingPolygon

GetBoundingPolygon returns BoundingPolygon

func (ValueInteger) GetConfidence 

func (m ValueInteger) GetConfidence() *float32

GetConfidence returns Confidence

func (ValueInteger) GetText 

func (m ValueInteger) GetText() *string

GetText returns Text

func (ValueInteger) GetWordIndexes 

func (m ValueInteger) GetWordIndexes() []int

GetWordIndexes returns WordIndexes

func (ValueInteger) MarshalJSON 

func (m ValueInteger) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ValueInteger) String 

func (m ValueInteger) String() string

func (ValueInteger) ValidateEnumValue 

func (m ValueInteger) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ValueNumber 

type ValueNumber struct {

	// The confidence score between 0 and 1.
	Confidence *float32 `mandatory:"true" json:"confidence"`

	BoundingPolygon *BoundingPolygon `mandatory:"true" json:"boundingPolygon"`

	// The indexes of the words in the field value.
	WordIndexes []int `mandatory:"true" json:"wordIndexes"`

	// The number value.
	Value *float32 `mandatory:"true" json:"value"`

	// The detected text of a field.
	Text *string `mandatory:"false" json:"text"`
}

ValueNumber The floating point number field value.

func (ValueNumber) GetBoundingPolygon 

func (m ValueNumber) GetBoundingPolygon() *BoundingPolygon

GetBoundingPolygon returns BoundingPolygon

func (ValueNumber) GetConfidence 

func (m ValueNumber) GetConfidence() *float32

GetConfidence returns Confidence

func (ValueNumber) GetText 

func (m ValueNumber) GetText() *string

GetText returns Text

func (ValueNumber) GetWordIndexes 

func (m ValueNumber) GetWordIndexes() []int

GetWordIndexes returns WordIndexes

func (ValueNumber) MarshalJSON 

func (m ValueNumber) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ValueNumber) String 

func (m ValueNumber) String() string

func (ValueNumber) ValidateEnumValue 

func (m ValueNumber) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ValuePhoneNumber 

type ValuePhoneNumber struct {

	// The confidence score between 0 and 1.
	Confidence *float32 `mandatory:"true" json:"confidence"`

	BoundingPolygon *BoundingPolygon `mandatory:"true" json:"boundingPolygon"`

	// The indexes of the words in the field value.
	WordIndexes []int `mandatory:"true" json:"wordIndexes"`

	// The phone number field value.
	Value *string `mandatory:"true" json:"value"`

	// The detected text of a field.
	Text *string `mandatory:"false" json:"text"`
}

ValuePhoneNumber The phone number field value.

func (ValuePhoneNumber) GetBoundingPolygon 

func (m ValuePhoneNumber) GetBoundingPolygon() *BoundingPolygon

GetBoundingPolygon returns BoundingPolygon

func (ValuePhoneNumber) GetConfidence 

func (m ValuePhoneNumber) GetConfidence() *float32

GetConfidence returns Confidence

func (ValuePhoneNumber) GetText 

func (m ValuePhoneNumber) GetText() *string

GetText returns Text

func (ValuePhoneNumber) GetWordIndexes 

func (m ValuePhoneNumber) GetWordIndexes() []int

GetWordIndexes returns WordIndexes

func (ValuePhoneNumber) MarshalJSON 

func (m ValuePhoneNumber) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ValuePhoneNumber) String 

func (m ValuePhoneNumber) String() string

func (ValuePhoneNumber) ValidateEnumValue 

func (m ValuePhoneNumber) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ValueString 

type ValueString struct {

	// The confidence score between 0 and 1.
	Confidence *float32 `mandatory:"true" json:"confidence"`

	BoundingPolygon *BoundingPolygon `mandatory:"true" json:"boundingPolygon"`

	// The indexes of the words in the field value.
	WordIndexes []int `mandatory:"true" json:"wordIndexes"`

	// The string text.
	Value *string `mandatory:"true" json:"value"`

	// The detected text of a field.
	Text *string `mandatory:"false" json:"text"`
}

ValueString The string field value.

func (ValueString) GetBoundingPolygon 

func (m ValueString) GetBoundingPolygon() *BoundingPolygon

GetBoundingPolygon returns BoundingPolygon

func (ValueString) GetConfidence 

func (m ValueString) GetConfidence() *float32

GetConfidence returns Confidence

func (ValueString) GetText 

func (m ValueString) GetText() *string

GetText returns Text

func (ValueString) GetWordIndexes 

func (m ValueString) GetWordIndexes() []int

GetWordIndexes returns WordIndexes

func (ValueString) MarshalJSON 

func (m ValueString) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ValueString) String 

func (m ValueString) String() string

func (ValueString) ValidateEnumValue 

func (m ValueString) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ValueTime 

type ValueTime struct {

	// The confidence score between 0 and 1.
	Confidence *float32 `mandatory:"true" json:"confidence"`

	BoundingPolygon *BoundingPolygon `mandatory:"true" json:"boundingPolygon"`

	// The indexes of the words in the field value.
	WordIndexes []int `mandatory:"true" json:"wordIndexes"`

	// The time field value as yyyy-mm-dd hh-mm-ss.
	Value *common.SDKTime `mandatory:"true" json:"value"`

	// The detected text of a field.
	Text *string `mandatory:"false" json:"text"`
}

ValueTime The time field value.

func (ValueTime) GetBoundingPolygon 

func (m ValueTime) GetBoundingPolygon() *BoundingPolygon

GetBoundingPolygon returns BoundingPolygon

func (ValueTime) GetConfidence 

func (m ValueTime) GetConfidence() *float32

GetConfidence returns Confidence

func (ValueTime) GetText 

func (m ValueTime) GetText() *string

GetText returns Text

func (ValueTime) GetWordIndexes 

func (m ValueTime) GetWordIndexes() []int

GetWordIndexes returns WordIndexes

func (ValueTime) MarshalJSON 

func (m ValueTime) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ValueTime) String 

func (m ValueTime) String() string

func (ValueTime) ValidateEnumValue 

func (m ValueTime) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type Word 

type Word struct {

	// The string of text characters in the word.
	Text *string `mandatory:"true" json:"text"`

	// the confidence score between 0 and 1.
	Confidence *float32 `mandatory:"true" json:"confidence"`

	BoundingPolygon *BoundingPolygon `mandatory:"true" json:"boundingPolygon"`
}

Word A single word.

func (Word) String 

func (m Word) String() string

func (Word) ValidateEnumValue 

func (m Word) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

Source Files

View all Source files

Jump to

Keyboard shortcuts

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