Skip to main content

Simplifying Index Management

Working with search functionality in Python can be a challenging endeavor, often involving complex tasks such as interacting with an index, clearing index data, and integrating search operations. To streamline these processes, HoppySearch introduces its Python client, designed to simplify these tasks and empower Python developers with efficient tools.

With the HoppySearch Python client, you can seamlessly perform various operations, including adding data to an index, conducting search operations (both Normal and Lucene searches), retrieving index statistics, deleting specific data from an index, and clearing index data.

How to Use the HoppySearch Python Client:

Follow the instructions below to set up and use the HoppySearch Python client for your projects:

  1. Installation:

    1. Install the HoppySearch Python client via pip by running the following command:

      pip install hoppysearch

    2. For more details, visit the HoppySearch Python client on PyPI..

  2. Initial Configuration:

    1. Import the HoppySearch client and handle potential exceptions:
    from hoppysearch import HoppySearch, ApiException
    index_id = YOUR_INDEX_ID
    api_key = YOUR_WRITE_API_KEY
    hoppysearch = HoppySearch(index_id, api_key )
    1. Replace YOUR_INDEX_ID with your specific index ID and YOUR_WRITE_API_KEY with your Write API Key obtained from HoppySearch.

  3. Retrieve Index ID and API Key:

    1. To obtain your index ID and Write API Key, follow these steps:

      1. Visit the /indices page within HoppySearch.

      2. Select the index to which you want to apply the HoppySearch Python client.

      3. Retrieve your index ID from your index endpoint. For example, if your index endpoint is (https://unm8df.hoppysearch.com) your index ID is "unm8df."

      4. Index Id

      5. Obtain your Write API Key from the "Access Management" -> "API Keys" section. Ensure that you choose an API key with write permission.

      6. api key

  4. Getting Started:

    1. With the HoppySearch Python client configured, you are now ready to utilize its features for your specific purposes. Follow the specific instructions provided in the subsequent sections to perform actions such as adding data to the index, conducting search operations, managing statistics, deleting data from the index, and clearing index data.

By adopting the HoppySearch Python client, you gain the ability to simplify your Python projects' search functionality, enhancing efficiency and enabling robust index management.