meilisearch.models package

Submodules

meilisearch.models.document module

class meilisearch.models.document.Document(doc: Dict[str, Any])[source]

Bases: object

class meilisearch.models.document.DocumentsResults(resp: Dict[str, Any])[source]

Bases: object

meilisearch.models.index module

class meilisearch.models.index.Embedders(*args: Any, **kwargs: Any)[source]

Bases: CamelBase

embedders: Dict[str, OpenAiEmbedder | HuggingFaceEmbedder | UserProvidedEmbedder]
class meilisearch.models.index.Faceting(*args: Any, **kwargs: Any)[source]

Bases: CamelBase

max_values_per_facet: int
sort_facet_values_by: Dict[str, str] | None = None
class meilisearch.models.index.HuggingFaceEmbedder(*args: Any, **kwargs: Any)[source]

Bases: CamelBase

document_template: str | None = None
model: str | None = None
revision: str | None = None
source: str = 'huggingFace'
class meilisearch.models.index.IndexStats(doc: Dict[str, Any])[source]

Bases: object

class meilisearch.models.index.MinWordSizeForTypos(*args: Any, **kwargs: Any)[source]

Bases: CamelBase

one_typo: int | None = None
two_typos: int | None = None
class meilisearch.models.index.OpenAiEmbedder(*args: Any, **kwargs: Any)[source]

Bases: CamelBase

api_key: str | None = None
dimensions: int | None = None
document_template: str | None = None
model: str | None = None
source: str = 'openAi'
class meilisearch.models.index.Pagination(*args: Any, **kwargs: Any)[source]

Bases: CamelBase

max_total_hits: int
class meilisearch.models.index.TypoTolerance(*args: Any, **kwargs: Any)[source]

Bases: CamelBase

disable_on_attributes: List[str] | None = None
disable_on_words: List[str] | None = None
enabled: bool = True
min_word_size_for_typos: MinWordSizeForTypos | None = None
class meilisearch.models.index.UserProvidedEmbedder(*args: Any, **kwargs: Any)[source]

Bases: CamelBase

dimensions: int
source: str = 'userProvided'

meilisearch.models.key module

class meilisearch.models.key.Key(*args: Any, **kwargs: Any)[source]

Bases: _KeyBase

created_at: datetime
key: str
updated_at: datetime | None = None
validate_created_at(v: str) datetime[source]
validate_updated_at(v: str) datetime | None[source]
class meilisearch.models.key.KeyUpdate(*args: Any, **kwargs: Any)[source]

Bases: CamelBase

actions: List[str] | None = None
description: str | None = None
expires_at: datetime | None = None
indexes: List[str] | None = None
key: str
model_config = {'ser_json_timedelta': 'iso8601'}
name: str | None = None
class meilisearch.models.key.KeysResults(*args: Any, **kwargs: Any)[source]

Bases: CamelBase

limit: int
offset: int
results: List[Key]
total: int

meilisearch.models.task module

class meilisearch.models.task.Task(*args: Any, **kwargs: Any)[source]

Bases: CamelBase

canceled_by: int | None = None
details: Dict[str, Any] | None = None
duration: str | None = None
enqueued_at: datetime
error: Dict[str, Any] | None = None
finished_at: datetime | None = None
index_uid: str | None = None
started_at: datetime | None = None
status: str
type: str
uid: int
validate_enqueued_at(v: str) datetime[source]
validate_finished_at(v: str) datetime | None[source]
validate_started_at(v: str) datetime | None[source]
class meilisearch.models.task.TaskInfo(*args: Any, **kwargs: Any)[source]

Bases: CamelBase

enqueued_at: datetime
index_uid: str | None
status: str
task_uid: int
type: str
validate_enqueued_at(v: str) datetime[source]
class meilisearch.models.task.TaskResults(resp: Dict[str, Any])[source]

Bases: object

Module contents