ansys.tools.meilisearch.all_doc_indexer#

Module for indexing all public documents in Meilisearch.

Classes#

Provides for indexing all public documents in Meilisearch.

class ansys.tools.meilisearch.all_doc_indexer.DocsAllPublic(meilisearch_client: ansys.tools.meilisearch.client.MeilisearchClient, destination_index_uid: str = 'pyansys-docs-all-public')#

Provides for indexing all public documents in Meilisearch.

Parameters:

meilisearch_clientMeilisearchClient: Meilisearch client.
destination_index_uidstr, default: "pyansys-docs-all-public": Unique name of the destination index.

create_index(source_index_uid: str, index_uid: str = None) → None#

Create an index with the same primary key as the source index.

Parameters:

source_index_uidstr: Name of the source index from which the primary key will be copied.
index_uidstr: Name of the destination index to be created. The index will be created with the same primary key as the source index, ensuring unique identification of documents within the destination index

add_documents_to_temp_index(source_index_uid: str) → None#

Fetch all documents from the source index and add them to the destination index.

Parameters:

source_index_uidstr: Name of the source index from which the documents will be fetched.

add_all_public_doc(selected_keys: List[str] = ['ansys, pyansys']) → None#

Add all public documents to the destination index.

Parameters:

selected_keysList[str], default: ["ansys, pyansys"]: Include only indexes whose keys start with a specified string in the search.