api

Documentation

Overview

Package api defines the interface for requests to the language model.

Index

• Constants
• type CharTrigramMatch
• type CharTrigramRequest
• type CharTrigramResponse
• type TrigramRequest
• type TrigramResponse

Constants

const (
	CharTrigramURL = "/chartrigram"
	TrigramURL     = "/trigram"
)

Default paths for the different api requests.

Types

type CharTrigramMatch

type CharTrigramMatch struct {
	NGram string
	Count uint64
}

CharTrigramMatch defines a (string, uint64) match pair.

type CharTrigramRequest

type CharTrigramRequest struct {
	Q     string
	Regex bool
}

CharTrigramRequest defines the data for a request for character 3-grams.

type CharTrigramResponse

type CharTrigramResponse struct {
	CharTrigramRequest
	Total   uint64
	Matches []CharTrigramMatch
}

CharTrigramResponse defines the data for the response of a request for character 3-grams.

type TrigramRequest

type TrigramRequest struct {
	F, S, T string
}

TrigramRequest defines the data for a request for token n-grams.

type TrigramResponse

type TrigramResponse struct {
	TrigramRequest
	Total   uint64
	Matches interface{}
}

TrigramResponse defines the data for the respones of a request for token n-grams.