Models index
Index Models
These are the models that describe indexes and the documents in them. IndexInfo and IndexStats
are returned by the index information methods, the Field models describe how an attribute is
configured, and DocumentsInfo is returned when getting multiple documents.
Index Models API
meilisearch_python_sdk.models.index
IndexBase
Bases: CamelBase
Source code in meilisearch_python_sdk/models/index.py
| class IndexBase(CamelBase):
uid: str
primary_key: str | None = None
|
primary_key
class-attribute
instance-attribute
primary_key: str | None = None
IndexInfo
Bases: IndexBase
Source code in meilisearch_python_sdk/models/index.py
| class IndexInfo(IndexBase):
created_at: datetime
updated_at: datetime
|
created_at
instance-attribute
updated_at
instance-attribute
IndexStats
Bases: CamelBase
Source code in meilisearch_python_sdk/models/index.py
| class IndexStats(CamelBase):
number_of_documents: int
number_of_embedded_documents: int | None = None
number_of_embeddings: int | None = None
is_indexing: bool
field_distribution: dict[str, int]
internal_database_sizes: JsonDict | None = None
index_size: int | str | None = None
used_index_size: int | str | None = None
|
number_of_documents
instance-attribute
number_of_embedded_documents
class-attribute
instance-attribute
number_of_embedded_documents: int | None = None
number_of_embeddings
class-attribute
instance-attribute
number_of_embeddings: int | None = None
is_indexing
instance-attribute
field_distribution
instance-attribute
field_distribution: dict[str, int]
internal_database_sizes
class-attribute
instance-attribute
internal_database_sizes: JsonDict | None = None
index_size
class-attribute
instance-attribute
index_size: int | str | None = None
used_index_size
class-attribute
instance-attribute
used_index_size: int | str | None = None
FieldsFilter
Bases: CamelBase
Source code in meilisearch_python_sdk/models/index.py
| class FieldsFilter(CamelBase):
attribute_patterns: str | None = None
displayed: bool | None = None
sortable: bool | None = None
searchable: bool | None = None
ranking_rule: bool | None = None
filterable: bool | None = None
|
attribute_patterns
class-attribute
instance-attribute
attribute_patterns: str | None = None
displayed
class-attribute
instance-attribute
displayed: bool | None = None
sortable
class-attribute
instance-attribute
sortable: bool | None = None
searchable
class-attribute
instance-attribute
searchable: bool | None = None
ranking_rule
class-attribute
instance-attribute
ranking_rule: bool | None = None
filterable
class-attribute
instance-attribute
filterable: bool | None = None
FieldDisplayConfig
Bases: CamelBase
Source code in meilisearch_python_sdk/models/index.py
| class FieldDisplayConfig(CamelBase):
enabled: bool
|
enabled
instance-attribute
FieldSearchConfig
Bases: CamelBase
Source code in meilisearch_python_sdk/models/index.py
| class FieldSearchConfig(CamelBase):
enabled: bool
|
enabled
instance-attribute
FieldSortableConfig
Bases: CamelBase
Source code in meilisearch_python_sdk/models/index.py
| class FieldSortableConfig(CamelBase):
enabled: bool
|
enabled
instance-attribute
FieldRankingRuleConfig
Bases: CamelBase
Source code in meilisearch_python_sdk/models/index.py
| class FieldRankingRuleConfig(CamelBase):
order: str | None = None
|
order
class-attribute
instance-attribute
FieldDistinctConfig
Bases: CamelBase
Source code in meilisearch_python_sdk/models/index.py
| class FieldDistinctConfig(CamelBase):
enabled: bool
|
enabled
instance-attribute
FieldFilterableConfig
Bases: CamelBase
Source code in meilisearch_python_sdk/models/index.py
| class FieldFilterableConfig(CamelBase):
enabled: bool
sort_by: str
facet_search: bool
equality: bool
comparison: bool
|
enabled
instance-attribute
sort_by
instance-attribute
facet_search
instance-attribute
equality
instance-attribute
comparison
instance-attribute
FieldLocalizedConfig
Bases: CamelBase
Source code in meilisearch_python_sdk/models/index.py
| class FieldLocalizedConfig(CamelBase):
locales: list[str]
|
locales
instance-attribute
Field
Bases: CamelBase
Source code in meilisearch_python_sdk/models/index.py
| class Field(CamelBase):
name: str
displayed: FieldDisplayConfig
searchable: FieldSearchConfig
sortable: FieldSortableConfig
distinct: FieldDistinctConfig
ranking_rule: FieldRankingRuleConfig
filterable: FieldFilterableConfig
localized: FieldLocalizedConfig
|
displayed
instance-attribute
displayed: FieldDisplayConfig
searchable
instance-attribute
searchable: FieldSearchConfig
sortable
instance-attribute
sortable: FieldSortableConfig
distinct
instance-attribute
distinct: FieldDistinctConfig
ranking_rule
instance-attribute
ranking_rule: FieldRankingRuleConfig
filterable
instance-attribute
filterable: FieldFilterableConfig
localized
instance-attribute
localized: FieldLocalizedConfig
FieldResults
Bases: CamelBase
Source code in meilisearch_python_sdk/models/index.py
| class FieldResults(CamelBase):
fields: list[Field]
offset: int
limit: int
total: int
|
fields
instance-attribute
offset
instance-attribute
Document Models API
meilisearch_python_sdk.models.documents
DocumentsInfo
Bases: CamelBase
Source code in meilisearch_python_sdk/models/documents.py
| class DocumentsInfo(CamelBase):
results: list[JsonDict]
offset: int
limit: int
total: int
|
results
instance-attribute
offset
instance-attribute