task

package
v3.12.0 Latest Latest
Warning

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

 Go to latest Published: Feb 28, 2024 License: MIT Imports: 2 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type DocumentTextDataExtractionTask 

type DocumentTextDataExtractionTask struct {
	Result documentTextDataExtractionTaskResult `json:"result"`
	// contains filtered or unexported fields
}

DocumentTextDataExtractionTask represents a document text data extraction task

type DocumentTextDataExtractionTaskBuilder 

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

DocumentTextDataExtractionTaskBuilder builds a DocumentTextDataExtractionTask

Example 
docFilter, err := filter.NewDocumentFilterBuilder().Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

task, err := NewDocumentTextDataExtractionTaskBuilder().
	WithDocumentFilter(docFilter).
	WithDocumentField("some-key", "some-value").
	WithDocumentField("some-other-key", map[string]string{
		"some-nested-key": "some-nested-value",
	}).
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

data, err := json.Marshal(task)
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

fmt.Println(string(data))

Output:

{"document_filter":{"document_types":[],"country_codes":[]},"result":{"document_fields":{"some-key":"some-value","some-other-key":{"some-nested-key":"some-nested-value"}}}}
Example (Minimal) 
task, err := NewDocumentTextDataExtractionTaskBuilder().Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

data, err := json.Marshal(task)
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

fmt.Println(string(data))

Output:

{"result":{}}

func NewDocumentTextDataExtractionTaskBuilder 

func NewDocumentTextDataExtractionTaskBuilder() *DocumentTextDataExtractionTaskBuilder

NewDocumentTextDataExtractionTaskBuilder creates a new DocumentTextDataExtractionTaskBuilder

func (*DocumentTextDataExtractionTaskBuilder) Build 

func (b *DocumentTextDataExtractionTaskBuilder) Build() (*DocumentTextDataExtractionTask, error)

Build creates a new DocumentTextDataExtractionTask

func (*DocumentTextDataExtractionTaskBuilder) WithDetectedCountry added in v3.3.0 

func (b *DocumentTextDataExtractionTaskBuilder) WithDetectedCountry(detectedCountry string) *DocumentTextDataExtractionTaskBuilder

WithDetectedCountry sets the detected country

Example 
task, err := NewDocumentTextDataExtractionTaskBuilder().
	WithDetectedCountry("some-country").
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

data, err := json.Marshal(task)
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

fmt.Println(string(data))

Output:

{"result":{"detected_country":"some-country"}}

func (*DocumentTextDataExtractionTaskBuilder) WithDocumentField 

func (b *DocumentTextDataExtractionTaskBuilder) WithDocumentField(key string, value interface{}) *DocumentTextDataExtractionTaskBuilder

WithDocumentField adds a document field to the task

func (*DocumentTextDataExtractionTaskBuilder) WithDocumentFields 

func (b *DocumentTextDataExtractionTaskBuilder) WithDocumentFields(documentFields map[string]interface{}) *DocumentTextDataExtractionTaskBuilder

WithDocumentFields sets document fields

Example 
docFilter, err := filter.NewDocumentFilterBuilder().Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

task, err := NewDocumentTextDataExtractionTaskBuilder().
	WithDocumentFilter(docFilter).
	WithDocumentFields(map[string]interface{}{
		"some-key": "some-value",
		"some-other-key": map[string]string{
			"some-nested-key": "some-nested-value",
		},
	}).
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

data, err := json.Marshal(task)
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

fmt.Println(string(data))

Output:

{"document_filter":{"document_types":[],"country_codes":[]},"result":{"document_fields":{"some-key":"some-value","some-other-key":{"some-nested-key":"some-nested-value"}}}}

func (*DocumentTextDataExtractionTaskBuilder) WithDocumentFilter 

func (b *DocumentTextDataExtractionTaskBuilder) WithDocumentFilter(filter *filter.DocumentFilter) *DocumentTextDataExtractionTaskBuilder

WithDocumentFilter adds a document filter to the task

func (*DocumentTextDataExtractionTaskBuilder) WithDocumentIDPhoto added in v3.2.0 

func (b *DocumentTextDataExtractionTaskBuilder) WithDocumentIDPhoto(contentType string, data []byte) *DocumentTextDataExtractionTaskBuilder

WithDocumentIDPhoto sets the document ID photo

Example 
task, err := NewDocumentTextDataExtractionTaskBuilder().
	WithDocumentIDPhoto("some-content-type", []byte{0xDE, 0xAD, 0xBE, 0xEF}).
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

data, err := json.Marshal(task)
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

fmt.Println(string(data))

Output:

{"result":{"document_id_photo":{"content_type":"some-content-type","data":"3q2+7w=="}}}

func (*DocumentTextDataExtractionTaskBuilder) WithRecommendation added in v3.3.0 

func (b *DocumentTextDataExtractionTaskBuilder) WithRecommendation(recommendation *TextDataExtractionRecommendation) *DocumentTextDataExtractionTaskBuilder

WithRecommendation sets the recommendation

Example 
recommendation, err := NewTextDataExtractionRecommendationBuilder().
	ForProgress().
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

task, err := NewDocumentTextDataExtractionTaskBuilder().
	WithRecommendation(recommendation).
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

data, err := json.Marshal(task)
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

fmt.Println(string(data))

Output:

{"result":{"recommendation":{"value":"PROGRESS"}}}

type SupplementaryDocumentTextDataExtractionTask added in v3.3.0 

type SupplementaryDocumentTextDataExtractionTask struct {
	Result supplementaryDocumentTextDataExtractionTaskResult `json:"result"`
	// contains filtered or unexported fields
}

SupplementaryDocumentTextDataExtractionTask represents a document text data extraction task

type SupplementaryDocumentTextDataExtractionTaskBuilder added in v3.3.0 

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

SupplementaryDocumentTextDataExtractionTaskBuilder builds a SupplementaryDocumentTextDataExtractionTask

Example 
docFilter, err := filter.NewDocumentFilterBuilder().Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

task, err := NewSupplementaryDocumentTextDataExtractionTaskBuilder().
	WithDocumentFilter(docFilter).
	WithDocumentField("some-key", "some-value").
	WithDocumentField("some-other-key", map[string]string{
		"some-nested-key": "some-nested-value",
	}).
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

data, err := json.Marshal(task)
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

fmt.Println(string(data))

Output:

{"document_filter":{"document_types":[],"country_codes":[]},"result":{"document_fields":{"some-key":"some-value","some-other-key":{"some-nested-key":"some-nested-value"}}}}
Example (Minimal) 
task, err := NewSupplementaryDocumentTextDataExtractionTaskBuilder().Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

data, err := json.Marshal(task)
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

fmt.Println(string(data))

Output:

{"result":{}}

func NewSupplementaryDocumentTextDataExtractionTaskBuilder added in v3.3.0 

func NewSupplementaryDocumentTextDataExtractionTaskBuilder() *SupplementaryDocumentTextDataExtractionTaskBuilder

NewSupplementaryDocumentTextDataExtractionTaskBuilder creates a new SupplementaryDocumentTextDataExtractionTaskBuilder

func (*SupplementaryDocumentTextDataExtractionTaskBuilder) Build added in v3.3.0 

func (b *SupplementaryDocumentTextDataExtractionTaskBuilder) Build() (*SupplementaryDocumentTextDataExtractionTask, error)

Build creates a new SupplementaryDocumentTextDataExtractionTask

func (*SupplementaryDocumentTextDataExtractionTaskBuilder) WithDetectedCountry added in v3.3.0 

func (b *SupplementaryDocumentTextDataExtractionTaskBuilder) WithDetectedCountry(detectedCountry string) *SupplementaryDocumentTextDataExtractionTaskBuilder

WithDetectedCountry sets the detected country

Example 
task, err := NewSupplementaryDocumentTextDataExtractionTaskBuilder().
	WithDetectedCountry("some-country").
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

data, err := json.Marshal(task)
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

fmt.Println(string(data))

Output:

{"result":{"detected_country":"some-country"}}

func (*SupplementaryDocumentTextDataExtractionTaskBuilder) WithDocumentField added in v3.3.0 

func (b *SupplementaryDocumentTextDataExtractionTaskBuilder) WithDocumentField(key string, value interface{}) *SupplementaryDocumentTextDataExtractionTaskBuilder

WithDocumentField adds a document field to the task

func (*SupplementaryDocumentTextDataExtractionTaskBuilder) WithDocumentFields added in v3.3.0 

func (b *SupplementaryDocumentTextDataExtractionTaskBuilder) WithDocumentFields(documentFields map[string]interface{}) *SupplementaryDocumentTextDataExtractionTaskBuilder

WithDocumentFields sets document fields

Example 
docFilter, err := filter.NewDocumentFilterBuilder().Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

task, err := NewSupplementaryDocumentTextDataExtractionTaskBuilder().
	WithDocumentFilter(docFilter).
	WithDocumentFields(map[string]interface{}{
		"some-key": "some-value",
		"some-other-key": map[string]string{
			"some-nested-key": "some-nested-value",
		},
	}).
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

data, err := json.Marshal(task)
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

fmt.Println(string(data))

Output:

{"document_filter":{"document_types":[],"country_codes":[]},"result":{"document_fields":{"some-key":"some-value","some-other-key":{"some-nested-key":"some-nested-value"}}}}

func (*SupplementaryDocumentTextDataExtractionTaskBuilder) WithDocumentFilter added in v3.3.0 

func (b *SupplementaryDocumentTextDataExtractionTaskBuilder) WithDocumentFilter(filter *filter.DocumentFilter) *SupplementaryDocumentTextDataExtractionTaskBuilder

WithDocumentFilter adds a document filter to the task

func (*SupplementaryDocumentTextDataExtractionTaskBuilder) WithRecommendation added in v3.3.0 

func (b *SupplementaryDocumentTextDataExtractionTaskBuilder) WithRecommendation(recommendation *TextDataExtractionRecommendation) *SupplementaryDocumentTextDataExtractionTaskBuilder

WithRecommendation sets the recommendation

Example 
recommendation, err := NewTextDataExtractionRecommendationBuilder().
	ForProgress().
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

task, err := NewSupplementaryDocumentTextDataExtractionTaskBuilder().
	WithRecommendation(recommendation).
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

data, err := json.Marshal(task)
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

fmt.Println(string(data))

Output:

{"result":{"recommendation":{"value":"PROGRESS"}}}

type TextDataExtractionReason added in v3.3.0 

type TextDataExtractionReason struct {
	Value  string `json:"value"`
	Detail string `json:"detail,omitempty"`
}

TextDataExtractionReason represents a text data extraction reason

type TextDataExtractionReasonBuilder added in v3.3.0 

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

TextDataExtractionReasonBuilder builds a TextDataExtractionReason

Example 
reason, err := NewTextDataExtractionReasonBuilder().
	ForQuality().
	WithDetail("some-detail").
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

data, err := json.Marshal(reason)
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

fmt.Println(string(data))

Output:

{"value":"QUALITY","detail":"some-detail"}

func NewTextDataExtractionReasonBuilder added in v3.3.0 

func NewTextDataExtractionReasonBuilder() *TextDataExtractionReasonBuilder

NewTextDataExtractionReasonBuilder creates a new TextDataExtractionReasonBuilder

func (*TextDataExtractionReasonBuilder) Build added in v3.3.0 

func (b *TextDataExtractionReasonBuilder) Build() (*TextDataExtractionReason, error)

Build creates a new TextDataExtractionReason

func (*TextDataExtractionReasonBuilder) ForQuality added in v3.3.0 

func (b *TextDataExtractionReasonBuilder) ForQuality() *TextDataExtractionReasonBuilder

ForQuality sets the reason to quality

Example 
reason, err := NewTextDataExtractionReasonBuilder().
	ForQuality().
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

data, err := json.Marshal(reason)
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

fmt.Println(string(data))

Output:

{"value":"QUALITY"}

func (*TextDataExtractionReasonBuilder) ForUserError added in v3.3.0 

func (b *TextDataExtractionReasonBuilder) ForUserError() *TextDataExtractionReasonBuilder

ForUserError sets the reason to user error

Example 
reason, err := NewTextDataExtractionReasonBuilder().
	ForUserError().
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

data, err := json.Marshal(reason)
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

fmt.Println(string(data))

Output:

{"value":"USER_ERROR"}

func (*TextDataExtractionReasonBuilder) WithDetail added in v3.3.0 

func (b *TextDataExtractionReasonBuilder) WithDetail(detail string) *TextDataExtractionReasonBuilder

WithDetail sets the reason detail

type TextDataExtractionRecommendation added in v3.3.0 

type TextDataExtractionRecommendation struct {
	Value  string                    `json:"value"`
	Reason *TextDataExtractionReason `json:"reason,omitempty"`
}

TextDataExtractionRecommendation represents a text data extraction reason

type TextDataExtractionRecommendationBuilder added in v3.3.0 

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

TextDataExtractionRecommendationBuilder builds a TextDataExtractionRecommendation

Example 
reason, err := NewTextDataExtractionReasonBuilder().
	ForQuality().
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

recommendation, err := NewTextDataExtractionRecommendationBuilder().
	ForShouldTryAgain().
	WithReason(reason).
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

data, err := json.Marshal(recommendation)
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

fmt.Println(string(data))

Output:

{"value":"SHOULD_TRY_AGAIN","reason":{"value":"QUALITY"}}

func NewTextDataExtractionRecommendationBuilder added in v3.3.0 

func NewTextDataExtractionRecommendationBuilder() *TextDataExtractionRecommendationBuilder

NewTextDataExtractionRecommendationBuilder creates a new TextDataExtractionRecommendationBuilder

func (*TextDataExtractionRecommendationBuilder) Build added in v3.3.0 

func (b *TextDataExtractionRecommendationBuilder) Build() (*TextDataExtractionRecommendation, error)

Build creates a new TextDataExtractionRecommendation

func (*TextDataExtractionRecommendationBuilder) ForMustTryAgain added in v3.3.0 

func (b *TextDataExtractionRecommendationBuilder) ForMustTryAgain() *TextDataExtractionRecommendationBuilder

ForMustTryAgain sets the recommendation value to must try again

Example 
recommendation, err := NewTextDataExtractionRecommendationBuilder().
	ForMustTryAgain().
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

data, err := json.Marshal(recommendation)
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

fmt.Println(string(data))

Output:

{"value":"MUST_TRY_AGAIN"}

func (*TextDataExtractionRecommendationBuilder) ForProgress added in v3.3.0 

func (b *TextDataExtractionRecommendationBuilder) ForProgress() *TextDataExtractionRecommendationBuilder

ForProgress sets the recommendation value to progress

Example 
recommendation, err := NewTextDataExtractionRecommendationBuilder().
	ForProgress().
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

data, err := json.Marshal(recommendation)
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

fmt.Println(string(data))

Output:

{"value":"PROGRESS"}

func (*TextDataExtractionRecommendationBuilder) ForShouldTryAgain added in v3.3.0 

func (b *TextDataExtractionRecommendationBuilder) ForShouldTryAgain() *TextDataExtractionRecommendationBuilder

ForShouldTryAgain sets the recommendation value to should try again

Example 
recommendation, err := NewTextDataExtractionRecommendationBuilder().
	ForShouldTryAgain().
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

data, err := json.Marshal(recommendation)
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

fmt.Println(string(data))

Output:

{"value":"SHOULD_TRY_AGAIN"}

func (*TextDataExtractionRecommendationBuilder) WithReason added in v3.3.0 

func (b *TextDataExtractionRecommendationBuilder) WithReason(reason *TextDataExtractionReason) *TextDataExtractionRecommendationBuilder

WithReason sets the recommendation reason

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.