# {py:mod}`tdk.dictionaries.gts` ```{py:module} tdk.dictionaries.gts ``` ```{autodoc2-docstring} tdk.dictionaries.gts :allowtitles: ``` ## Module Contents ### Classes ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`GTSWriter ` - * - {py:obj}`GTSMeaningExample ` - * - {py:obj}`GTSProverb ` - * - {py:obj}`GTSMeaning ` - * - {py:obj}`GTSEntry ` - ```` ### Functions ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`get_gts_index ` - ```{autodoc2-docstring} tdk.dictionaries.gts.get_gts_index :summary: ``` * - {py:obj}`get_gts_index_sync ` - ```{autodoc2-docstring} tdk.dictionaries.gts.get_gts_index_sync :summary: ``` * - {py:obj}`get_gts_circumflex_index ` - ```{autodoc2-docstring} tdk.dictionaries.gts.get_gts_circumflex_index :summary: ``` * - {py:obj}`get_gts_circumflex_index_sync ` - ```{autodoc2-docstring} tdk.dictionaries.gts.get_gts_circumflex_index_sync :summary: ``` * - {py:obj}`search_gts ` - ```{autodoc2-docstring} tdk.dictionaries.gts.search_gts :summary: ``` * - {py:obj}`search_gts_sync ` - ```{autodoc2-docstring} tdk.dictionaries.gts.search_gts_sync :summary: ``` * - {py:obj}`search_gts_proverbs_and_phrases ` - ```{autodoc2-docstring} tdk.dictionaries.gts.search_gts_proverbs_and_phrases :summary: ``` * - {py:obj}`search_gts_proverbs_and_phrases_sync ` - ```{autodoc2-docstring} tdk.dictionaries.gts.search_gts_proverbs_and_phrases_sync :summary: ``` * - {py:obj}`get_gts_suggestions ` - ```{autodoc2-docstring} tdk.dictionaries.gts.get_gts_suggestions :summary: ``` * - {py:obj}`get_gts_suggestions_sync ` - ```{autodoc2-docstring} tdk.dictionaries.gts.get_gts_suggestions_sync :summary: ``` ```` ### Data ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`__all__ ` - ```{autodoc2-docstring} tdk.dictionaries.gts.__all__ :summary: ``` * - {py:obj}`entry_list_adapter ` - ```{autodoc2-docstring} tdk.dictionaries.gts.entry_list_adapter :summary: ``` ```` ### API ````{py:data} __all__ :canonical: tdk.dictionaries.gts.__all__ :value: > ['GTSEntry', 'GTSMeaning', 'GTSMeaningExample', 'GTSProverb', 'GTSWriter', 'get_gts_index', 'get_gts... ```{autodoc2-docstring} tdk.dictionaries.gts.__all__ ``` ```` `````{py:class} GTSWriter(/, **data: typing.Any) :canonical: tdk.dictionaries.gts.GTSWriter Bases: {py:obj}`pydantic.BaseModel` ````{py:attribute} tdk_id :canonical: tdk.dictionaries.gts.GTSWriter.tdk_id :type: int :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSWriter.tdk_id ``` ```` ````{py:attribute} full_name :canonical: tdk.dictionaries.gts.GTSWriter.full_name :type: str :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSWriter.full_name ``` ```` ````{py:attribute} short_name :canonical: tdk.dictionaries.gts.GTSWriter.short_name :type: str :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSWriter.short_name ``` ```` ````` `````{py:class} GTSMeaningExample(/, **data: typing.Any) :canonical: tdk.dictionaries.gts.GTSMeaningExample Bases: {py:obj}`pydantic.BaseModel` ````{py:attribute} tdk_id :canonical: tdk.dictionaries.gts.GTSMeaningExample.tdk_id :type: int :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSMeaningExample.tdk_id ``` ```` ````{py:attribute} meaning_id :canonical: tdk.dictionaries.gts.GTSMeaningExample.meaning_id :type: int :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSMeaningExample.meaning_id ``` ```` ````{py:attribute} order :canonical: tdk.dictionaries.gts.GTSMeaningExample.order :type: int :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSMeaningExample.order ``` ```` ````{py:attribute} example :canonical: tdk.dictionaries.gts.GTSMeaningExample.example :type: str :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSMeaningExample.example ``` ```` ````{py:attribute} writers :canonical: tdk.dictionaries.gts.GTSMeaningExample.writers :type: list[tdk.dictionaries.gts.GTSWriter] :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSMeaningExample.writers ``` ```` ````` `````{py:class} GTSProverb(/, **data: typing.Any) :canonical: tdk.dictionaries.gts.GTSProverb Bases: {py:obj}`pydantic.BaseModel` ````{py:attribute} tdk_id :canonical: tdk.dictionaries.gts.GTSProverb.tdk_id :type: int :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSProverb.tdk_id ``` ```` ````{py:attribute} proverb :canonical: tdk.dictionaries.gts.GTSProverb.proverb :type: str :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSProverb.proverb ``` ```` ````{py:attribute} prefix :canonical: tdk.dictionaries.gts.GTSProverb.prefix :type: str | None :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSProverb.prefix ``` ```` ````` `````{py:class} GTSMeaning(/, **data: typing.Any) :canonical: tdk.dictionaries.gts.GTSMeaning Bases: {py:obj}`pydantic.BaseModel` ````{py:attribute} meaning :canonical: tdk.dictionaries.gts.GTSMeaning.meaning :type: str :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSMeaning.meaning ``` ```` ````{py:attribute} tdk_id :canonical: tdk.dictionaries.gts.GTSMeaning.tdk_id :type: int :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSMeaning.tdk_id ``` ```` ````{py:attribute} order :canonical: tdk.dictionaries.gts.GTSMeaning.order :type: int :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSMeaning.order ``` ```` ````{py:attribute} is_verb :canonical: tdk.dictionaries.gts.GTSMeaning.is_verb :type: bool :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSMeaning.is_verb ``` ```` ````{py:attribute} entry_id :canonical: tdk.dictionaries.gts.GTSMeaning.entry_id :type: int :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSMeaning.entry_id ``` ```` ````{py:attribute} examples :canonical: tdk.dictionaries.gts.GTSMeaning.examples :type: list[tdk.dictionaries.gts.GTSMeaningExample] :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSMeaning.examples ``` ```` ````{py:attribute} properties :canonical: tdk.dictionaries.gts.GTSMeaning.properties :type: list[tdk.internal.utils.ValidatedProperty] :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSMeaning.properties ``` ```` ````` `````{py:class} GTSEntry(/, **data: typing.Any) :canonical: tdk.dictionaries.gts.GTSEntry Bases: {py:obj}`pydantic.BaseModel` ````{py:attribute} tdk_id :canonical: tdk.dictionaries.gts.GTSEntry.tdk_id :type: int :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSEntry.tdk_id ``` ```` ````{py:attribute} order :canonical: tdk.dictionaries.gts.GTSEntry.order :type: int :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSEntry.order ``` ```` ````{py:attribute} entry :canonical: tdk.dictionaries.gts.GTSEntry.entry :type: str :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSEntry.entry ``` ```` ````{py:attribute} plural :canonical: tdk.dictionaries.gts.GTSEntry.plural :type: bool :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSEntry.plural ``` ```` ````{py:attribute} proper :canonical: tdk.dictionaries.gts.GTSEntry.proper :type: bool :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSEntry.proper ``` ```` ````{py:attribute} origin_language :canonical: tdk.dictionaries.gts.GTSEntry.origin_language :type: tdk.enums.OriginLanguage :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSEntry.origin_language ``` ```` ````{py:attribute} original :canonical: tdk.dictionaries.gts.GTSEntry.original :type: str :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSEntry.original ``` ```` ````{py:attribute} entry_normalized :canonical: tdk.dictionaries.gts.GTSEntry.entry_normalized :type: str | None :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSEntry.entry_normalized ``` ```` ````{py:attribute} meanings :canonical: tdk.dictionaries.gts.GTSEntry.meanings :type: list[tdk.dictionaries.gts.GTSMeaning] :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSEntry.meanings ``` ```` ````{py:attribute} proverbs :canonical: tdk.dictionaries.gts.GTSEntry.proverbs :type: list[tdk.dictionaries.gts.GTSProverb] :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSEntry.proverbs ``` ```` ````{py:attribute} pronunciation :canonical: tdk.dictionaries.gts.GTSEntry.pronunciation :type: str | None :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSEntry.pronunciation ``` ```` ````{py:attribute} prefix :canonical: tdk.dictionaries.gts.GTSEntry.prefix :type: str | None :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSEntry.prefix ``` ```` ````{py:attribute} suffix :canonical: tdk.dictionaries.gts.GTSEntry.suffix :type: str | None :value: > 'Field(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.GTSEntry.suffix ``` ```` ````` ````{py:data} entry_list_adapter :canonical: tdk.dictionaries.gts.entry_list_adapter :value: > 'TypeAdapter(...)' ```{autodoc2-docstring} tdk.dictionaries.gts.entry_list_adapter ``` ```` ````{py:function} get_gts_index(*, http_session: aiohttp.ClientSession) -> list[str] :canonical: tdk.dictionaries.gts.get_gts_index :async: ```{autodoc2-docstring} tdk.dictionaries.gts.get_gts_index ``` ```` ````{py:function} get_gts_index_sync() :canonical: tdk.dictionaries.gts.get_gts_index_sync ```{autodoc2-docstring} tdk.dictionaries.gts.get_gts_index_sync ``` ```` ````{py:function} get_gts_circumflex_index(*, http_session: aiohttp.ClientSession) -> dict[str, str] :canonical: tdk.dictionaries.gts.get_gts_circumflex_index :async: ```{autodoc2-docstring} tdk.dictionaries.gts.get_gts_circumflex_index ``` ```` ````{py:function} get_gts_circumflex_index_sync() :canonical: tdk.dictionaries.gts.get_gts_circumflex_index_sync ```{autodoc2-docstring} tdk.dictionaries.gts.get_gts_circumflex_index_sync ``` ```` ````{py:function} search_gts(query: str, /, *, http_session: aiohttp.ClientSession) -> list[tdk.dictionaries.gts.GTSEntry] :canonical: tdk.dictionaries.gts.search_gts :async: ```{autodoc2-docstring} tdk.dictionaries.gts.search_gts ``` ```` ````{py:function} search_gts_sync() :canonical: tdk.dictionaries.gts.search_gts_sync ```{autodoc2-docstring} tdk.dictionaries.gts.search_gts_sync ``` ```` ````{py:function} search_gts_proverbs_and_phrases(query: str, /, *, http_session: aiohttp.ClientSession) -> list[tdk.dictionaries.gts.GTSEntry] :canonical: tdk.dictionaries.gts.search_gts_proverbs_and_phrases :async: ```{autodoc2-docstring} tdk.dictionaries.gts.search_gts_proverbs_and_phrases ``` ```` ````{py:function} search_gts_proverbs_and_phrases_sync() :canonical: tdk.dictionaries.gts.search_gts_proverbs_and_phrases_sync ```{autodoc2-docstring} tdk.dictionaries.gts.search_gts_proverbs_and_phrases_sync ``` ```` ````{py:function} get_gts_suggestions(query: str, /, *, http_session: aiohttp.ClientSession) -> list[str] :canonical: tdk.dictionaries.gts.get_gts_suggestions :async: ```{autodoc2-docstring} tdk.dictionaries.gts.get_gts_suggestions ``` ```` ````{py:function} get_gts_suggestions_sync() :canonical: tdk.dictionaries.gts.get_gts_suggestions_sync ```{autodoc2-docstring} tdk.dictionaries.gts.get_gts_suggestions_sync ``` ````