Hunt.Common.ApiDocument

Document format for the interpreter and JSON API. It includes the document description, the index data and additional metadata.

Documentation

data ApiDocument

The document accepted by the interpreter and JSON API.

Constructors

ApiDocument

Fields

adUri :: URI

The unique identifier.

adIndex :: IndexMap

The data to index according to schema associated with the context.

adDescr :: Description

The document description (a simple key-value map).

adWght :: Score

An optional document boost, (internal default is 1.0).

Instances

Show ApiDocument

ToJSON ApiDocument

FromJSON ApiDocument

Binary ApiDocument

NFData ApiDocument

LogShow ApiDocument

type IndexMap = Map Context Content

Context map

type ApiDocuments = [ApiDocument]

Multiple ApiDocuments.

type AnalyzerFunction = Text -> [(Position, Text)]

Text analysis function

data AnalyzerType

Types of analyzer

Constructors

DefaultAnalyzer

Instances

Show AnalyzerType

ToJSON AnalyzerType

FromJSON AnalyzerType

data LimitedResult x

Paginated result with an offset and chunk size.

Constructors

LimitedResult

Fields

lrResult :: [x]

The list with at most lrMax elements.

lrOffset :: Int

The offset of the result.

lrMax :: Int

The limit for the result.

lrCount :: Int

The size of the complete result.

Instances

Eq x => Eq (LimitedResult x)

Show x => Show (LimitedResult x)

ToJSON x => ToJSON (LimitedResult x)

FromJSON x => FromJSON (LimitedResult x)

NFData x => NFData (LimitedResult x)

mkLimitedResult :: Int -> Int -> [x] -> LimitedResult x

Create a paginated result with an offset and a chunk size. The result also includes the size of the complete result.

emptyApiDocIndexMap :: IndexMap

Empty index content.

emptyApiDocDescr :: Description

Empty Document description.

emptyApiDoc :: ApiDocument

Empty ApiDocument.