Data.Textocat.Internal

Documentation

type ErrorMsg = String

Error message

data Config

API configuration. Currently only API key is saved

Constructors

Config

Fields

apiKey :: ByteString

API key

hostName :: String

host name

Instances

Eq Config

Show Config

data Document

Document sent for analysis

Constructors

Document

Fields

d_text :: Text

Text (less than 100 KB)

d_tag :: Maybe Text

Tag (say, user identifier of document)

Instances

Eq Document

Show Document

Generic Document

ToJSON Document

FromJSON Document

type Rep Document

documentOptions :: Options

newtype BatchID

Batch identifier (you get it after submitting documents)

Constructors

BatchID

Fields

batch_id :: Text

Instances

Eq BatchID

Read BatchID

Show BatchID

ToJSON BatchID

FromJSON BatchID

data BatchState

States of batch processing

Constructors

FINISHED

Batch is ready for retrieving

IN_PROGRESS

Batch is being processed

Instances

Eq BatchState

Read BatchState

Show BatchState

ToJSON BatchState

FromJSON BatchState

data BatchStatus

Status of batch

Constructors

BatchStatus

Fields

bs_batchId :: Text

Batch ID

bs_status :: BatchState

Batch status

Instances

Eq BatchStatus

Show BatchStatus

Generic BatchStatus

ToJSON BatchStatus

FromJSON BatchStatus

type Rep BatchStatus

bsOptions :: Options

data DocumentState

States of document processing

Constructors

SUCCESS

INPUT_ERROR

SERVICE_ERROR

Instances

Eq DocumentState

Read DocumentState

Show DocumentState

ToJSON DocumentState

FromJSON DocumentState

data Category

Entity category

Constructors

PERSON

ORGANIZATION

GPE

LOCATION

FACILITY

TIME

MONEY

Instances

Eq Category

Ord Category

Read Category

Show Category

ToJSON Category

FromJSON Category

data Entity

Constructors

Entity

Fields

e_span :: Text

e_beginOffset :: Int

e_endOffset :: Int

e_category :: Category

Instances

Eq Entity

Show Entity

Generic Entity

ToJSON Entity

FromJSON Entity

type Rep Entity

entityOptions :: Options

data AnnotatedDocument

Constructors

AnnotatedDocument

Fields

ad_status :: DocumentState

ad_tag :: Maybe Text

ad_entities :: [Entity]

Instances

Eq AnnotatedDocument

Show AnnotatedDocument

Generic AnnotatedDocument

ToJSON AnnotatedDocument

FromJSON AnnotatedDocument

type Rep AnnotatedDocument

adOptions :: Options

data Batch

Constructors

Batch

Fields

b_batchIds :: [BatchID]

b_documents :: [AnnotatedDocument]

Instances

Eq Batch

Show Batch

Generic Batch

ToJSON Batch

FromJSON Batch

type Rep Batch

batchOptions :: Options

data SearchResult

Constructors

SearchResult

Fields

sr_searchQuery :: Text

sr_documents :: [AnnotatedDocument]

Instances

Eq SearchResult

Show SearchResult

Generic SearchResult

ToJSON SearchResult

FromJSON SearchResult

type Rep SearchResult

srOptions :: Options

data ServiceStatus

Constructors

ServiceOK

ServiceUnavailable

Instances

Eq ServiceStatus

Show ServiceStatus