meilisearch package

Subpackages

• meilisearch.models package
  • Submodules
  • meilisearch.models.document module
    • Document
    • DocumentsResults
    • FieldsResults
  • meilisearch.models.embedders module
    • CompositeEmbedder
      • CompositeEmbedder.indexing_embedder
      • CompositeEmbedder.search_embedder
      • CompositeEmbedder.source
    • Distribution
      • Distribution.mean
      • Distribution.sigma
    • Embedders
      • Embedders.embedders
    • HuggingFaceEmbedder
      • HuggingFaceEmbedder.binary_quantized
      • HuggingFaceEmbedder.dimensions
      • HuggingFaceEmbedder.distribution
      • HuggingFaceEmbedder.document_template
      • HuggingFaceEmbedder.document_template_max_bytes
      • HuggingFaceEmbedder.model
      • HuggingFaceEmbedder.pooling
      • HuggingFaceEmbedder.revision
      • HuggingFaceEmbedder.source
      • HuggingFaceEmbedder.url
    • OllamaEmbedder
      • OllamaEmbedder.api_key
      • OllamaEmbedder.binary_quantized
      • OllamaEmbedder.dimensions
      • OllamaEmbedder.distribution
      • OllamaEmbedder.document_template
      • OllamaEmbedder.document_template_max_bytes
      • OllamaEmbedder.model
      • OllamaEmbedder.source
      • OllamaEmbedder.url
    • OpenAiEmbedder
      • OpenAiEmbedder.api_key
      • OpenAiEmbedder.binary_quantized
      • OpenAiEmbedder.dimensions
      • OpenAiEmbedder.distribution
      • OpenAiEmbedder.document_template
      • OpenAiEmbedder.document_template_max_bytes
      • OpenAiEmbedder.model
      • OpenAiEmbedder.source
      • OpenAiEmbedder.url
    • PoolingType
      • PoolingType.USE_MODEL
      • PoolingType.FORCE_MEAN
      • PoolingType.FORCE_CLS
      • PoolingType.FORCE_CLS
      • PoolingType.FORCE_MEAN
      • PoolingType.USE_MODEL
    • RestEmbedder
      • RestEmbedder.api_key
      • RestEmbedder.binary_quantized
      • RestEmbedder.dimensions
      • RestEmbedder.distribution
      • RestEmbedder.document_template
      • RestEmbedder.document_template_max_bytes
      • RestEmbedder.headers
      • RestEmbedder.indexing_fragments
      • RestEmbedder.request
      • RestEmbedder.response
      • RestEmbedder.search_fragments
      • RestEmbedder.source
      • RestEmbedder.url
    • UserProvidedEmbedder
      • UserProvidedEmbedder.binary_quantized
      • UserProvidedEmbedder.dimensions
      • UserProvidedEmbedder.distribution
      • UserProvidedEmbedder.source
  • meilisearch.models.index module
  • meilisearch.models.key module
  • meilisearch.models.task module
  • meilisearch.models.webhook module
  • Module contents

Submodules

meilisearch.client module

meilisearch.config module

class meilisearch.config.Config(url: str, api_key: str | None = None, timeout: int | None = None, client_agents: Tuple[str, ...] | None = None)

Bases: object

Client’s credentials and configuration parameters

class Paths

Bases: object

accept_new_fields = 'accept-new-fields'

batch = 'batches'

dictionary = 'dictionary'

displayed_attributes = 'displayed-attributes'

distinct_attribute = 'distinct-attribute'

document = 'documents'

dumps = 'dumps'

edit = 'edit'

embedders = 'embedders'

experimental_features = 'experimental-features'

export = 'export'

facet_search = 'facet-search'

faceting = 'faceting'

fields = 'fields'

filterable_attributes = 'filterable-attributes'

health = 'health'

index = 'indexes'

keys = 'keys'

localized_attributes = 'localized-attributes'

multi_search = 'multi-search'

network = 'network'

non_separator_tokens = 'non-separator-tokens'

pagination = 'pagination'

prefix_search = 'prefix-search'

proximity_precision = 'proximity-precision'

ranking_rules = 'ranking-rules'

search = 'search'

search_cutoff_ms = 'search-cutoff-ms'

searchable_attributes = 'searchable-attributes'

separator_tokens = 'separator-tokens'

setting = 'settings'

similar = 'similar'

snapshots = 'snapshots'

sortable_attributes = 'sortable-attributes'

stat = 'stats'

stop_words = 'stop-words'

swap = 'swap-indexes'

synonyms = 'synonyms'

task = 'tasks'

typo_tolerance = 'typo-tolerance'

version = 'version'

webhooks = 'webhooks'

meilisearch.errors module

exception meilisearch.errors.MeilisearchApiError(error: str, request: Response)

Bases: MeilisearchError

Error sent by Meilisearch API

exception meilisearch.errors.MeilisearchCommunicationError(message: str)

Bases: MeilisearchError

Error when connecting to Meilisearch

exception meilisearch.errors.MeilisearchError(message: str)

Bases: Exception

Generic class for Meilisearch error handling

exception meilisearch.errors.MeilisearchTimeoutError(message: str)

Bases: MeilisearchError

Error when Meilisearch operation takes longer than expected

meilisearch.errors.version_error_hint_message(func: Callable[[...], T]) → Callable[[...], T]

meilisearch.index module

meilisearch.task module

meilisearch.version module

Module contents