Mystemex.Types (Mystemex v0.2.1)

Copy Markdown View Source

Here are the types that are used in Mystemex.

Summary

Types

analysis_item()

@type analysis_item() :: %{
  :gr => String.t(),
  :lex => String.t(),
  :wt => float(),
  optional(:qual) => String.t()
}

analyze_items()

@type analyze_items() :: [%{analysis: [analysis_item()], text: String.t()}]

analyze_response()

@type analyze_response() :: base_response(analyze_items())

base_response(a)

@type base_response(a) :: {:ok, a} | {:exit_code, integer()} | {:error, String.t()}

lemmatize_response()

@type lemmatize_response() :: base_response([String.t()])

lemmatize_word_response()

@type lemmatize_word_response() :: base_response(String.t())

query_kind()

@type query_kind() :: :analyze | :lemmatize | :lemmatize_word

query_type()

@type query_type() :: {query_kind(), String.t()}

responses()