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 RequestedSupplementaryDocTextExtractionTask added in v3.3.0 

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

RequestedSupplementaryDocTextExtractionTask requests creation of a Text Extraction Task

func NewRequestedSupplementaryDocTextExtractionTask added in v3.3.0 

func NewRequestedSupplementaryDocTextExtractionTask(config RequestedSupplementaryDocTextExtractionTaskConfig) *RequestedSupplementaryDocTextExtractionTask

NewRequestedSupplementaryDocTextExtractionTask creates a new supplementary document text extraction task

func (*RequestedSupplementaryDocTextExtractionTask) Config added in v3.3.0 

func (t *RequestedSupplementaryDocTextExtractionTask) Config() RequestedTaskConfig

Config is the configuration of the Requested Task

func (*RequestedSupplementaryDocTextExtractionTask) MarshalJSON added in v3.3.0 

func (t *RequestedSupplementaryDocTextExtractionTask) MarshalJSON() ([]byte, error)

MarshalJSON marshals the RequestedSupplementaryDocTextExtractionTask to JSON

func (*RequestedSupplementaryDocTextExtractionTask) Type added in v3.3.0 

func (t *RequestedSupplementaryDocTextExtractionTask) Type() string

Type is the type of the Requested Task

type RequestedSupplementaryDocTextExtractionTaskBuilder added in v3.3.0 

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

RequestedSupplementaryDocTextExtractionTaskBuilder builds a RequestedSupplementaryDocTextExtractionTask

Example 
task, err := NewRequestedSupplementaryDocTextExtractionTaskBuilder().
	WithManualCheckAlways().
	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:

{"type":"SUPPLEMENTARY_DOCUMENT_TEXT_DATA_EXTRACTION","config":{"manual_check":"ALWAYS"}}

func NewRequestedSupplementaryDocTextExtractionTaskBuilder added in v3.3.0 

func NewRequestedSupplementaryDocTextExtractionTaskBuilder() *RequestedSupplementaryDocTextExtractionTaskBuilder

NewRequestedSupplementaryDocTextExtractionTaskBuilder creates a new RequestedSupplementaryDocTextExtractionTaskBuilder

func (*RequestedSupplementaryDocTextExtractionTaskBuilder) Build added in v3.3.0 

func (builder *RequestedSupplementaryDocTextExtractionTaskBuilder) Build() (*RequestedSupplementaryDocTextExtractionTask, error)

Build builds the RequestedSupplementaryDocTextExtractionTask

func (*RequestedSupplementaryDocTextExtractionTaskBuilder) WithManualCheckAlways added in v3.3.0 

func (builder *RequestedSupplementaryDocTextExtractionTaskBuilder) WithManualCheckAlways() *RequestedSupplementaryDocTextExtractionTaskBuilder

WithManualCheckAlways sets the value of manual check to "ALWAYS"

func (*RequestedSupplementaryDocTextExtractionTaskBuilder) WithManualCheckFallback added in v3.3.0 

func (builder *RequestedSupplementaryDocTextExtractionTaskBuilder) WithManualCheckFallback() *RequestedSupplementaryDocTextExtractionTaskBuilder

WithManualCheckFallback sets the value of manual check to "FALLBACK"

func (*RequestedSupplementaryDocTextExtractionTaskBuilder) WithManualCheckNever added in v3.3.0 

func (builder *RequestedSupplementaryDocTextExtractionTaskBuilder) WithManualCheckNever() *RequestedSupplementaryDocTextExtractionTaskBuilder

WithManualCheckNever sets the value of manual check to "NEVER"

type RequestedSupplementaryDocTextExtractionTaskConfig added in v3.3.0 

type RequestedSupplementaryDocTextExtractionTaskConfig struct {
	ManualCheck string `json:"manual_check,omitempty"`
}

RequestedSupplementaryDocTextExtractionTaskConfig is the configuration applied when creating a Text Extraction Task

type RequestedTask 

type RequestedTask interface {
	Type() string
	Config() RequestedTaskConfig
	MarshalJSON() ([]byte, error)
}

RequestedTask requests creation of a Task to be performed on each document

type RequestedTaskConfig 

type RequestedTaskConfig interface {
}

RequestedTaskConfig is the configuration applied when creating a Task

type RequestedTextExtractionTask 

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

RequestedTextExtractionTask requests creation of a Text Extraction Task

func NewRequestedTextExtractionTask 

func NewRequestedTextExtractionTask(config RequestedTextExtractionTaskConfig) *RequestedTextExtractionTask

NewRequestedTextExtractionTask creates a new text extraction task

func (*RequestedTextExtractionTask) Config 

func (t *RequestedTextExtractionTask) Config() RequestedTaskConfig

Config is the configuration of the Requested Task

func (*RequestedTextExtractionTask) MarshalJSON 

func (t *RequestedTextExtractionTask) MarshalJSON() ([]byte, error)

MarshalJSON marshals the RequestedTextExtractionTask to JSON

func (*RequestedTextExtractionTask) Type 

func (t *RequestedTextExtractionTask) Type() string

Type is the type of the Requested Task

type RequestedTextExtractionTaskBuilder 

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

RequestedTextExtractionTaskBuilder builds a RequestedTextExtractionTask

Example 
task, err := NewRequestedTextExtractionTaskBuilder().
	WithManualCheckAlways().
	WithChipDataIgnore().
	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:

{"type":"ID_DOCUMENT_TEXT_DATA_EXTRACTION","config":{"manual_check":"ALWAYS","chip_data":"IGNORE"}}

func NewRequestedTextExtractionTaskBuilder 

func NewRequestedTextExtractionTaskBuilder() *RequestedTextExtractionTaskBuilder

NewRequestedTextExtractionTaskBuilder creates a new RequestedTextExtractionTaskBuilder

func (*RequestedTextExtractionTaskBuilder) Build 

func (builder *RequestedTextExtractionTaskBuilder) Build() (*RequestedTextExtractionTask, error)

Build builds the RequestedTextExtractionTask

func (*RequestedTextExtractionTaskBuilder) WithChipDataDesired 

func (builder *RequestedTextExtractionTaskBuilder) WithChipDataDesired() *RequestedTextExtractionTaskBuilder

WithChipDataDesired sets the value of chip data to "DESIRED"

func (*RequestedTextExtractionTaskBuilder) WithChipDataIgnore 

func (builder *RequestedTextExtractionTaskBuilder) WithChipDataIgnore() *RequestedTextExtractionTaskBuilder

WithChipDataIgnore sets the value of chip data to "IGNORE"

func (*RequestedTextExtractionTaskBuilder) WithExpandedDocumentFields added in v3.10.0 

func (builder *RequestedTextExtractionTaskBuilder) WithExpandedDocumentFields(expandedDocumentFields bool) *RequestedTextExtractionTaskBuilder

withExpandedDocumentFields sets the value of expanded document fields whether its true or false

func (*RequestedTextExtractionTaskBuilder) WithManualCheckAlways 

func (builder *RequestedTextExtractionTaskBuilder) WithManualCheckAlways() *RequestedTextExtractionTaskBuilder

WithManualCheckAlways sets the value of manual check to "ALWAYS"

func (*RequestedTextExtractionTaskBuilder) WithManualCheckFallback 

func (builder *RequestedTextExtractionTaskBuilder) WithManualCheckFallback() *RequestedTextExtractionTaskBuilder

WithManualCheckFallback sets the value of manual check to "FALLBACK"

func (*RequestedTextExtractionTaskBuilder) WithManualCheckNever 

func (builder *RequestedTextExtractionTaskBuilder) WithManualCheckNever() *RequestedTextExtractionTaskBuilder

WithManualCheckNever sets the value of manual check to "NEVER"

type RequestedTextExtractionTaskConfig 

type RequestedTextExtractionTaskConfig struct {
	ManualCheck                  string `json:"manual_check,omitempty"`
	ChipData                     string `json:"chip_data,omitempty"`
	CreateExpandedDocumentFields bool   `json:"create_expanded_document_fields,omitempty"`
}

RequestedTextExtractionTaskConfig is the configuration applied when creating a Text Extraction Task

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.