Meilisearch Python SDK

https://meilisearch-python-sdk.paulsanders.dev
Admin
Meilisearch Python SDK provides both async and sync clients for the Meilisearch API, offering...
Tokens:508,063
Snippets:2,280
Trust Score:4.8
Update:1 week ago
Show doc for...
Tokens:
Raw
### Get documents example

Source: https://meilisearch-python-sdk.paulsanders.dev/index_api

Shows how to retrieve a batch of documents using the get_documents method. The example uses a client and index.

```python
>>> from meilisearch_python_sdk import Client
>>> with Client("http://localhost.com", "masterKey") as client:
>>>     index = client.index("movies")
>>>     documents = index.get_documents()
```

--------------------------------

### AsyncIndex.fetch_info() example

Source: https://meilisearch-python-sdk.paulsanders.dev/async_index_api

Shows how to fetch index information using AsyncClient. The example creates a client, gets an index, and calls fetch_info().

```python
>>> from meilisearch_python_sdk import AsyncClient
>>> async with AsyncClient("http://localhost.com", "masterKey") as client:
>>>     index = client.index("movies")
>>>     index_info = await index.fetch_info()
```

--------------------------------

### Example: update_documents_from_file_in_batches

Source: https://meilisearch-python-sdk.paulsanders.dev/index_api

Example usage of update_documents_from_file_in_batches. Creates a Client, gets the 'movies' index, and calls the method with a file path.

```python
>>> from pathlib import Path
>>> from meilisearch_python_sdk import Client
>>> file_path = Path("/path/to/file.json")
>>> with Client("http://localhost.com", "masterKey") as client:
>>>     index = client.index("movies")
>>>     index.update_documents_from_file_in_batches(file_path)

```

--------------------------------

### AsyncClient index creation example

Source: https://meilisearch-python-sdk.paulsanders.dev/async_client_api

Shows how to create an AsyncClient and get an index instance using the 'movies' uid.

```python
>>> from meilisearch_python_sdk import AsyncClient
>>> async with AsyncClient("http://localhost.com", "masterKey") as client:
>>>     index = client.index("movies")
```

--------------------------------

### AsyncClient get_or_create_index example

Source: https://meilisearch-python-sdk.paulsanders.dev/async_client_api

Shows how to get an index or create it if it doesn't exist using the AsyncClient.

```python
>>> from meilisearch_python_sdk import AsyncClient
>>> async with AsyncClient("http://localhost.com", "masterKey") as client:
>>>     index = await client.get_or_create_index("movies")
```

--------------------------------

### AsyncIndex.get_primary_key() example

Source: https://meilisearch-python-sdk.paulsanders.dev/async_index_api

Shows how to get the primary key of an index using AsyncClient. The example creates a client, gets an index, and calls get_primary_key().

```python
>>> from meilisearch_python_sdk import AsyncClient
>>> async with AsyncClient("http://localhost.com", "masterKey") as client:
>>>     index = client.index("movies")
>>>     primary_key = await index.get_primary_key()
```

--------------------------------

### Usage example for add_documents_from_directory

Source: https://meilisearch-python-sdk.paulsanders.dev/async_index_api

Example showing how to use the add_documents_from_directory method with an AsyncClient. It creates a client, gets an index, and calls the method with a directory path.

```python
>>> from pathlib import Path
>>> from meilisearch_python_sdk import AsyncClient
>>> directory_path = Path("/path/to/directory/containing/files")
>>> async with AsyncClient("http://localhost.com", "masterKey") as client:
>>>     index = client.index("movies")
>>>     await index.add_documents_from_directory(directory_path)
```

--------------------------------

### Example: update_documents_from_directory_in_batches usage

Source: https://meilisearch-python-sdk.paulsanders.dev/index_api

Example usage of update_documents_from_directory_in_batches from the method's docstring. It creates a Client, gets an index, and calls the method with a directory path. The example uses a placeholder URL and master key.

```python
>>> from pathlib import Path
>>> from meilisearch_python_sdk import Client
>>> directory_path = Path("/path/to/directory/containing/files")
>>> with Client("http://localhost.com", "masterKey") as client:
>>>     index = client.index("movies")
>>>     index.update_documents_from_directory_in_batches(directory_path)
```

--------------------------------

### AsyncIndex.search example

Source: https://meilisearch-python-sdk.paulsanders.dev/async_index_api

Shows how to use AsyncClient to create a client, get an index, and perform a search with the query 'Tron'. Requires a running Meilisearch instance and a valid API key.

```python
>>> from meilisearch_python_sdk import AsyncClient
>>> async with AsyncClient("http://localhost.com", "masterKey") as client:
>>>     index = client.index("movies")
>>>     search_results = await index.search("Tron")
```

--------------------------------

### Get pagination settings with AsyncClient

Source: https://meilisearch-python-sdk.paulsanders.dev/async_index_api

Shows how to retrieve pagination settings for an index using the AsyncClient. The example creates a client, gets the index, and calls get_pagination.

```python
>>> from meilisearch_async_client import AsyncClient
>>> async with AsyncClient("http://localhost.com", "masterKey") as client:
>>>     index = client.index("movies")
>>>     pagination_settings = await index.get_pagination()
```

--------------------------------

### AsyncIndex.update() example

Source: https://meilisearch-python-sdk.paulsanders.dev/async_index_api

Shows how to update an index's primary key using AsyncClient. The example creates a client, gets an index, and calls update().

```python
>>> from meilisearch_python_sdk import AsyncClient
>>> async with AsyncClient("http://localhost.com", "masterKey") as client:
>>>     index = client.index("movies")
>>>     updated_index = await index.update()
```

--------------------------------

### Get networks with Client

Source: https://meilisearch-python-sdk.paulsanders.dev/client_api

Shows how to fetch remote networks using the Client context manager. The example imports AsyncClient but uses Client, which may be a typo in the source.

```python
>>> from meilisearch_python_sdk import AsyncClient
>>>
>>>
>>> with Client("http://localhost.com", "masterKey") as client:
>>>     response = client.get_networks()
```

--------------------------------

### Get ranking rules example

Source: https://meilisearch-python-sdk.paulsanders.dev/index_api

Shows how to retrieve the ranking rules of an index using the get_ranking_rules method. Requires a Client instance and an existing index.

```python
>>> from meilisearch_python_sdk import Client
>>> with Client("http://localhost.com", "masterKey") as client:
>>>     index = client.index("movies")
>>>     ranking_rules = index.get_ranking_rules()
```

--------------------------------

### Client.get_tasks example

Source: https://meilisearch-python-sdk.paulsanders.dev/client_api

Shows how to create a Client and call get_tasks within a context manager. The example uses a placeholder URL and master key.

```python
>>> from meilisearch_python_sdk import Client
>>>
>>> with Client("http://localhost.com", "masterKey") as client:
>>>     client.get_tasks(client)
```

--------------------------------

### Get index stats with get_stats

Source: https://meilisearch-python-sdk.paulsanders.dev/index_api

Shows the signature of the get_stats method and an example of how to call it. The example uses the Client context manager to get an index and then retrieve its stats. The method returns an IndexStats object.

```python
get_stats(
    *,
    show_internal_database_sizes: bool = False,
    size_format: Literal["human", "raw"] | None = None,
) -> IndexStats
```

```python
>>> from meilisearch_python_sdk import Client
>>> with Client("http://localhost.com", "masterKey") as client:
>>>     index = client.index("movies")
>>>     stats = index.get_stats()
```

--------------------------------

### AsyncIndex.create usage example

Source: https://meilisearch-python-sdk.paulsanders.dev/async_index_api

Shows how to create an index using AsyncClient and the create classmethod. The example uses a local Meilisearch server with masterKey.

```python
>>> from meilisearch_python_sdk import AsyncClient
>>> async with AsyncClient("http://localhost.com", "masterKey") as client:
>>>     index = await index.create(client, "movies")

```

--------------------------------

### reset_faceting usage example

Source: https://meilisearch-python-sdk.paulsanders.dev/async_index_api

Example of using reset_faceting with an AsyncClient. It creates a client, gets the 'movies' index, and calls reset_faceting.

```python
>>> from meilisearch_python_sdk import AsyncClient
>>> async with AsyncClient("http://localhost.com", "masterKey") as client:
>>>     index = client.index("movies")
>>>     await index.reset_faceting()

```

--------------------------------

### get_foreign_keys usage example

Source: https://meilisearch-python-sdk.paulsanders.dev/async_index_api

Example usage of get_foreign_keys with AsyncClient. Creates a client, gets the 'movies' index, and retrieves foreign keys.

```python
>>> from meilisearch_async_client import AsyncClient
>>> async with AsyncClient("http://localhost.com", "masterKey") as client:
>>>     index = await client.index("movies")
>>>     foreign_keys = await index.get_foreign_keys()

```

--------------------------------

### Get document example

Source: https://meilisearch-python-sdk.paulsanders.dev/index_api

Shows how to retrieve a single document by its ID using the get_document method. The example uses a client and index.

```python
>>> from meilisearch_python_sdk import Client
>>> with Client("http://localhost.com", "masterKey") as client:
>>>     index = client.index("movies")
>>>     document = index.get_document("1234")
```

--------------------------------

### Create an index with AsyncClient

Source: https://meilisearch-python-sdk.paulsanders.dev/async_client_api

Shows how to create an index using the AsyncClient context manager. Requires a running Meilisearch instance and a master key.

```python
>>> from meilisearch_python_sdk import AsyncClient
>>> async with AsyncClient("http://localhost.com", "masterKey") as client:
>>>     index = await client.create_index("movies")
```

--------------------------------

### update_faceting usage example

Source: https://meilisearch-python-sdk.paulsanders.dev/async_index_api

Example of using update_faceting with an AsyncClient. It creates a client, gets the 'movies' index, and calls update_faceting with a Faceting object.

```python
>>> from meilisearch_python_sdk import AsyncClient
>>> async with AsyncClient("http://localhost.com", "masterKey") as client:
>>>     index = client.index("movies")
>>>     await index.update_faceting(faceting=Faceting(max_values_per_facet=100))

```

--------------------------------

### Client.wait_for_task example

Source: https://meilisearch-python-sdk.paulsanders.dev/client_api

Demonstrates adding documents to an index and then waiting for the task to complete using wait_for_task. The example uses an async context and shows the expected usage pattern.

```python
>>> from meilisearch_python_sdk import Client
>>> documents = [
>>>     {"id": 1, "title": "Movie 1", "genre": "comedy"},
>>>     {"id": 2, "title": "Movie 2", "genre": "drama"},
>>> ]
>>> with Client("http://localhost.com", "masterKey") as client:
>>>     index = client.index("movies")
>>>     response = await index.add_documents(documents)
>>>     client.wait_for_task(response.update_id)
```

--------------------------------

### Create an API key with Client.create_key

Source: https://meilisearch-python-sdk.paulsanders.dev/client_api

Shows how to create a new API key using KeyCreate. Note the import path in the example appears to have a typo (meilissearch_async_client). The client is used as a context manager. Requires a running Meilisearch instance and a master key.

```python
>>> from meilisearch_python_sdk import Client
>>> from meilissearch_async_client.models.client import KeyCreate
>>> with Client("http://localhost.com", "masterKey") as client:
>>>     key_info = KeyCreate(
>>>         description="My new key",
>>>         actions=["search"],
>>>         indexes=["movies"],
>>>     )
>>>     keys = client.create_key(key_info)
```

--------------------------------

### update_foreign_keys usage example

Source: https://meilisearch-python-sdk.paulsanders.dev/async_index_api

Example usage of update_foreign_keys with AsyncClient. Creates a client, gets the 'movies' index, and updates foreign keys with a single ForeignKey.

```python
>>> from meilisearch_python_sdk import AsyncClient
>>> from meilisearch_python_sdk.models.settings import ForeignKey
>>> async with AsyncClient("http://localhost.com", "masterKey") as client:
>>>     index = await client.index("movies")
>>>     await index.update_foreign_keys([ForeignKey(foreign_index_uid="title", field_name="title")])

```

--------------------------------

### AsyncClient get_tasks example

Source: https://meilisearch-python-sdk.paulsanders.dev/async_client_api

Shows how to use the AsyncClient to retrieve tasks. Requires a running Meilisearch instance and a valid API key.

```python
>>> from meilisearch_python_sdk import AsyncClient
>>>
>>> async with AsyncClient("http://localhost.com", "masterKey") as client:
>>>     await client.get_tasks()
```

--------------------------------

### Usage example with Client and ConnectionInfo

Source: https://meilisearch-python-sdk.paulsanders.dev/decorators_api

Shows how to use the add_documents decorator with either a Client instance or ConnectionInfo. Requires an index_name and connection_info. The decorated function must return a list of dictionaries.

```python
>>> from meilisearch_python_sdk import Client
>>> from meilisearch_python_sdk.decorators import add_documents, ConnectionInfo
>>>
>>>
>>> # With `Client`
>>> client = Client(url="http://localhost:7700", api_key="masterKey")
>>> @add_documents(index_name="movies", connection_info=client)
>>> def my_function() -> list[dict[str, Any]]:
>>>     return [{"id": 1, "title": "Test 1"}, {"id": 2, "title": "Test 2"}]
>>>
>>> # With `ConnectionInfo`
>>> @add_documents(
        index_name="movies",
        connection_info=ConnectionInfo(url="http://localhost:7700", api_key="masterKey"),
    )
>>> def my_function() -> list[dict[str, Any]]:
>>>     return [{"id": 1, "title": "Test 1"}, {"id": 2, "title": "Test 2"}]
```

--------------------------------

### AsyncClient.__init__

Source: https://meilisearch-python-sdk.paulsanders.dev/async_client_api

Initializes an AsyncClient instance with the specified URL, API key, and optional configuration parameters.

```APIDOC
## AsyncClient.__init__

### Description
Initializes an AsyncClient instance for interacting with the Meilisearch API.

### Method
Constructor

### Signature
```python
__init__(
    url: str,
    api_key: str | None = None,
    *,
    timeout: int | None = None,
    verify: bool | SSLContext = True,
    custom_headers: dict[str, str] | None = None,
    json_handler: BuiltinHandler | OrjsonHandler | None = None,
    http2: bool = False,
) -> None
```

### Parameters
- **url** (str) - Required - The URL to the Meilisearch API (e.g., http://localhost:7700).
- **api_key** (str | None) - Optional - The API key for Meilisearch. Defaults to None.
- **timeout** (int | None) - Optional - Time in seconds to wait for a response before timing out. Defaults to None.
- **verify** (bool | SSLContext) - Optional - SSL certificates (CA bundle) used to verify the identity of requested hosts. Either True (default CA bundle), a path to an SSL certificate file, or False (disable verification). Defaults to True.
- **custom_headers** (dict[str, str] | None) - Optional - Custom headers to add when sending data to Meilisearch. Defaults to None.
- **json_handler** (BuiltinHandler | OrjsonHandler | None) - Optional - The module to use for JSON operations. Options are BuiltinHandler (standard library json) or OrjsonHandler (orjson). Defaults to OrjsonHandler if orjson is installed, otherwise BuiltinHandler.
- **http2** (bool) - Optional - Whether to use HTTP/2. Defaults to False.

### Returns
None
```

--------------------------------

### Create a webhook with Client

Source: https://meilisearch-python-sdk.paulsanders.dev/client_api

Shows how to create a webhook by constructing a WebhookCreate object and passing it to client.create_webhook.

```python
>>> from meilisearch_python_sdk import Client
>>> from meilisearch_python_sdk.models.webhook import WebhookCreate
>>> with Client("http://localhost.com", "masterKey") as client:
>>>     webhook_config = WebhookCreate(
>>>         url="https://example.com/webhook",
>>>         headers={"Authorization": "Bearer token"}
>>>     )
>>>     webhook = client.create_webhook(webhook_config)
```

--------------------------------

### Get all webhooks with Client

Source: https://meilisearch-python-sdk.paulsanders.dev/client_api

Shows how to retrieve all configured webhooks using the Client context manager.

```python
>>> from meilisearch_python_sdk import Client
>>> with Client("http://localhost.com", "masterKey") as client:
>>>     webhooks = client.get_webhooks()
```

--------------------------------

### Get faceting settings with AsyncClient

Source: https://meilisearch-python-sdk.paulsanders.dev/async_index_api

Shows how to retrieve faceting settings for an index using the AsyncClient. The example creates a client, gets the index, and calls get_faceting.

```python
>>> from meilisearch_python_sdk import AsyncClient
>>> async with AsyncClient("http://localhost.com", "masterKey") as client:
>>>     index = client.index("movies")
>>>     faceting = await index.get_faceting()
```

--------------------------------

### Create an index with AsyncClient

Source: https://meilisearch-python-sdk.paulsanders.dev/async_index_api

Shows how to create an index using the AsyncClient. Requires a running Meilisearch instance and valid API key.

```python
>>> from meilisearch_python_sdk import AsyncClient
>>> async with AsyncClient("http://localhost.com", "masterKey") as client:
>>>     index = await index.create(client, "movies")
```

--------------------------------

### Get a single task with AsyncClient

Source: https://meilisearch-python-sdk.paulsanders.dev/async_client_api

Example usage of the get_task method. It requires an AsyncClient instance and a master key. The example retrieves the task with ID 1244.

```python
>>> from meilisearch_python_sdk import AsyncClient
>>> from meilisearch_python_sdk.task import get_task
>>>
>>> async with AsyncClient("http://localhost.com", "masterKey") as client:
>>>     await client.get_task(client, 1244)
```

--------------------------------

### Get filterable attributes with AsyncClient

Source: https://meilisearch-python-sdk.paulsanders.dev/async_index_api

Shows how to retrieve filterable attributes of an index using the AsyncClient. The example creates a client, gets the 'movies' index, and calls get_filterable_attributes.

```python
>>> from meilisearch_python_sdk import AsyncClient
>>> async with AsyncClient("http://localhost.com", "masterKey") as client:
>>>     index = client.index("movies")
>>>     filterable_attributes = await index.get_filterable_attributes()
```

--------------------------------

### Get pagination settings with get_pagination

Source: https://meilisearch-python-sdk.paulsanders.dev/index_api

Retrieves the pagination settings for an index. The example creates a client, gets the 'movies' index, and calls get_pagination() to obtain a Pagination object. Note that this example uses the async client (meilisearch_async_client) instead of the sync client. Requires a running Meilisearch server and a valid API key.

```python
>>> from meilisearch_async_client import Client
>>> with Client("http://localhost.com", "masterKey") as client:
>>>     index = client.index("movies")
>>>     pagination_settings = index.get_pagination()
```

--------------------------------

### Client.__init__

Source: https://meilisearch-python-sdk.paulsanders.dev/client_api

Initializes a new Client instance to connect to the Meilisearch API. Accepts the API URL, optional API key, and various configuration options.

```APIDOC
## Client.__init__

### Description
Initializes a new Client instance to connect to the Meilisearch API.

### Method
Constructor

### Signature
```python
Client(
    url: str,
    api_key: str | None = None,
    *,
    timeout: int | None = None,
    verify: bool | SSLContext = True,
    custom_headers: dict[str, str] | None = None,
    json_handler: BuiltinHandler | OrjsonHandler | None = None,
    http2: bool = False
) -> None
```

### Parameters
- **url** (str) - Required - The URL to the Meilisearch API (e.g., http://localhost:7700).
- **api_key** (str | None) - Optional - The API key for Meilisearch. Defaults to None.
- **timeout** (int | None) - Optional - Time in seconds to wait for a response before timing out. Defaults to None.
- **verify** (bool | SSLContext) - Optional - SSL certificates used to verify the identity of requested hosts. Either True (default CA bundle), a path to an SSL certificate file, or False (disable verification). Defaults to True.
- **custom_headers** (dict[str, str] | None) - Optional - Custom headers to add when sending data to Meilisearch. Defaults to None.
- **json_handler** (BuiltinHandler | OrjsonHandler | None) - Optional - Module to use for JSON operations. Options are BuiltinHandler (standard library json) or OrjsonHandler (orjson). Defaults to OrjsonHandler if orjson is installed, otherwise BuiltinHandler.
- **http2** (bool) - Optional - If True, the client will use HTTP/2. Defaults to False.

### Returns
None
```

--------------------------------

### Install Meilisearch Python SDK with pip

Source: https://meilisearch-python-sdk.paulsanders.dev/

Install the package using pip. A virtual environment is recommended.

```bash
pip install meilisearch-python-sdk
```

--------------------------------

### update_documents_from_directory: usage example with AsyncClient

Source: https://meilisearch-python-sdk.paulsanders.dev/async_index_api

Example usage of update_documents_from_directory with AsyncClient. It imports Path and AsyncClient, creates a client, gets the 'movies' index, and calls the method with a directory path.

```python
>>> from pathlib import Path
>>> from meilisearch_python_sdk import AsyncClient
>>> directory_path = Path("/path/to/directory/containing/files")
>>> async with AsyncClient("http://localhost.com", "masterKey") as client:
>>>     index = client.index("movies")
>>>     await index.update_documents_from_directory(directory_path)
```

--------------------------------

### Get field properties with fields

Source: https://meilisearch-python-sdk.paulsanders.dev/index_api

Shows how to get field properties on an index using the fields method. Requires a Client instance and an index. The example adds documents before retrieving fields.

```python
>>> from meilisearch_async_client import Client
>>> with Client("http://localhost.com", "masterKey") as client:
>>>     docs = [{"id": 1, "title": "Some Title}]
>>>     index = client.index("movies")
>>>     index.add_documents(docs)
>>>     fields = index.fields()
```

--------------------------------

### Get all stats with Client.get_all_stats

Source: https://meilisearch-python-sdk.paulsanders.dev/client_api

Shows how to instantiate the Client and call get_all_stats to retrieve database size and index information. The client is used as a context manager. Requires a running Meilisearch instance and a master key.

```python
>>> from meilisearch_python_sdk import Client
>>> with Client("http://localhost.com", "masterKey") as client:
>>>     stats = client.get_all_stats()
```

--------------------------------

### delete_document usage example

Source: https://meilisearch-python-sdk.paulsanders.dev/index_api

Example usage of delete_document: creates a client, gets the 'movies' index, and deletes document with ID '1234'. Demonstrates the typical workflow for deleting a single document.

```python
>>> from meilisearch_python_sdk import Client
>>> with Client("http://localhost.com", "masterKey") as client:
>>>     index = client.index("movies")
>>>     index.delete_document("1234")

```

--------------------------------

### Search similar documents example

Source: https://meilisearch-python-sdk.paulsanders.dev/index_api

Shows how to use the search_similar_documents method with a client and index. The example uses a local Meilisearch server and a document ID.

```python
>>> from meilisearch_python_sdk import Client
>>> with Client("http://localhost.com", "masterKey") as client:
>>>     index = client.index("movies")
>>>     search_results = index.search_similar_documents("123")
```

--------------------------------

### AsyncIndex.update_documents_from_directory_in_batches example

Source: https://meilisearch-python-sdk.paulsanders.dev/async_index_api

Example usage of the update_documents_from_directory_in_batches method. It creates an AsyncClient, gets an index, and calls the method with a directory path. The method loads documents from files in the directory and updates them in batches.

```python
>>> from pathlib import Path
>>> from meilisearch_python_sdk import AsyncClient
>>> directory_path = Path("/path/to/directory/containing/files")
>>> async with AsyncClient("http://localhost.com", "masterKey") as client:
>>>     index = client.index("movies")
>>>     await index.update_documents_from_directory_in_batches(directory_path)
```
Tokens:
Raw