📄️ Create Index
HoppySearch uses Lucene's powerful search capabilities for indexing. Lucene is an open-source Java-based search engine library that analyzes text data, breaks it down into individual terms, and creates an inverted index. This index is stored in a set of files and can be quickly queried to retrieve relevant documents based on search terms. Lucene uses scoring algorithms to determine the relevance of each document. Overall, indexing in Lucene involves analyzing, tokenizing, and storing data in index files for fast searching and retrieval.
📄️ Indexing Your Data in HoppySearch
Searching your content effectively in HoppySearch requires you to first send your data to the HoppySearch Index, where it is hosted on the cloud. This cloud-based hosting ensures efficient and rapid searches. To facilitate this process, follow the step-by-step data workflow outlined below:
📄️ Insert Data Through HoppySearch UI
When it comes to populating your data in HoppySearch, you have two user-friendly options:
📄️ Inserting Data Through REST API Call
To add data to your HoppySearch index using a REST API call, follow these steps:
📄️ Search
Before delving into search, it's important to understand the concept of Hoppysearch records.
📄️ Minimizing Record Size
When you upload data to your index, its size will increase proportionally. To keep the index size manageable, HoppySearch recommends that you follow the steps below before indexing the data.
📄️ Strategies for Indexing Large Documents
In case you have to index lengthy documents that exceed the size limit, you have to divide them into smaller chunks. Currently, HoppySearch supports datasets with a maximum size of 6MB. However, we are soon planning to enhance the size limit through our user interface. Until then, you can use the following steps to index significant data.
📄️ Searchable Fields
Searchable fields are the key-value pairs of the JSON data that you have uploaded and want to make available for search. You can choose to include all the fields or only a subset of them. It is only possible to search the fields that have been designated as searchable.
📄️ Accessing API Documentation
HoppySearch offers two tools to simplify your API testing experience: a Postman collection and Swagger Documentation. The Postman collection allows you to quickly import and test APIs, while the Swagger Documentation provides a comprehensive guide to the API's endpoints, parameters, and response structures. With these tools at your disposal, you can ensure that your APIs are functioning correctly and efficiently, without spending hours on manual testing.