ansys.tools.meilisearch.client#

Module providing the Meilisearch client.

Classes#

`BaseClient`	Provides the base class for the Meilisearch client.
`MeilisearchClient`	Provides for scraping documents and indexing content in Meilisearch.

Module Contents#

class ansys.tools.meilisearch.client.BaseClient(meilisearch_host_url=None, meilisearch_api_key=None)#

Provides the base class for the Meilisearch client.

Initialize the Meilisearch client.

Parameters:

meilisearch_host_urlstr, default: None: URL for the Meilisearch host.
meilisearch_api_keystr, default: None: API key (admin) for the Meilisearch host.

Raises:

RuntimeError: If the meilisearch_host_url or meilisearch_api_key parameter is None and the corresponding environment variable is not set.

property meilisearch_api_key#: Meilisearch API key.

property meilisearch_host_url#: Meilisearch host URL.

class ansys.tools.meilisearch.client.MeilisearchClient(meilisearch_host_url=None, meilisearch_api_key=None)#

Bases: BaseClient

Provides for scraping documents and indexing content in Meilisearch.

If no values are passed for the meilisearch_host_url or meilisearch_api_key parameters, the constructor checks for their values in environment variables.

Initialize a new instance of the MeilisearchClient class.

Parameters:

meilisearch_host_urlstr, default: None: URL for the Meilisarch host.
meilisearch_api_keystr, default: None: API key (admin) for the Meilisearch host.

Raises:

RuntimeError: If the MEILISEARCH_HOST_URL or MEILISEARCH_API_KEY environment variables are not set and no values are passed to the constructor for initializing a new instance of the MeilisearchClient class.

property client#: Meilisearch client.