@type date() :: String.t()

Date format in yyyy-MM-dd format, ex: 2023-12-31

@type exclude_part_of_speech() :: String.t()

CSV part-of-speech values to exclude

allowable values are:

"noun",
"adjective",
"verb",
"adverb",
"interjection",
"pronoun",
"preposition",
"abbreviation",
"affix",
"article",
"auxiliary-verb",
"conjunction",
"definite-article",
"family-name",
"given-name",
"idiom",
"imperative",
"noun-plural",
"noun-posessive",
"past-participle",
"phrasal-prefix",
"proper-noun",
"proper-noun-plural",
"proper-noun-posessive",
"suffix",
"verb-intransitive",
"verb-transitive"

@type include_part_of_speech() :: String.t()

CSV part-of-speech values to include

allowable values are:

"noun",
"adjective",
"verb",
"adverb",
"interjection",
"pronoun",
"preposition",
"abbreviation",
"affix",
"article",
"auxiliary-verb",
"conjunction",
"definite-article",
"family-name",
"given-name",
"idiom",
"imperative",
"noun-plural",
"noun-posessive",
"past-participle",
"phrasal-prefix",
"proper-noun",
"proper-noun-plural",
"proper-noun-posessive",
"suffix",
"verb-intransitive",
"verb-transitive"

@type part_of_speech() :: String.t()

part of speech

allowable values are:

"noun",
"adjective",
"verb",
"adverb",
"interjection",
"pronoun",
"preposition",
"abbreviation",
"affix",
"article",
"auxiliary-verb",
"conjunction",
"definite-article",
"family-name",
"given-name",
"idiom",
"imperative",
"noun-plural",
"noun-posessive",
"past-participle",
"phrasal-prefix",
"proper-noun",
"proper-noun-plural",
"proper-noun-posessive",
"suffix",
"verb-intransitive",
"verb-transitive"

@type relationship_types() :: String.t()

relationship type values

allowable values are:

"synonym",
"antonym",
"variant",
"equivalent",
"cross-reference",
"related-word",
"rhyme",
"form",
"etymologically-related-term",
"hypernym",
"hyponym",
"inflected-form",
"primary",
"same-context",
"verb-form",
"verb-stem",
"has-topic"

@type sort_by() :: String.t()

setting to sort by alphabetical or total count

allowable values:

"alpha",
"count"

@type sort_order() :: String.t()

setting to order by ascending or descending

allowable values:

"asc",
"desc"

@type source_dict() :: String.t()

Source dictionary to return definitions from.

allowed values are:

"ahd-5",
"century",
"wiktionary",
"webster",
"wordnet"

@type source_dictionaries() :: String.t()

Source dictionary to return definitions from. If 'all' is received, results are returned from all sources. If multiple values are received (e.g. 'century,wiktionary'), results are returned from the first specified dictionary that has definitions. If left blank, results are returned from the first dictionary that has definitions. By default, dictionaries are searched in this order: ahd-5, wiktionary, webster, century, wordnet

allowed values are:

"all",
"ahd-5",
"century",
"wiktionary",
"webster",
"wordnet"

@type type_format() :: String.t()

type format values

allowable values are:

"ahd-5",
"arpabet",
"gcide-diacritical",
"IPA"