ansys.tools.meilisearch.utils

Provides utilities for Meilisearch.

Classes

MeilisearchUtils

Provides utility functions for working with Meilisearch.

Module Contents

class ansys.tools.meilisearch.utils.MeilisearchUtils(meilisearch_client: ansys.tools.meilisearch.client.MeilisearchClient)

Provides utility functions for working with Meilisearch.

Initialize the Meilisearch client.

Parameters:

meilisearch_clientMeilisearchClient

Meilisearch client.

fetch_all_documents(source_index_uid: str, limit: int = 20) → List[dict]

Fetch all documents from a source index and return them as a list.

Parameters:

source_index_uidstr

Unique name of the index to fetch documents from.

limitint, default: 20

The maximum number of documents to fetch in a single offset or query. This parameter determines how many documents are included in each response when fetching data. The default value is 20.

Returns:

list

List of all documents fetched from the source index.