website logo
โŒ˜K
Introduction
Getting started
๐Ÿ“Reference
Data API
Cache API
Search API
Storage API
Queue API
Crawler API
๐Ÿ”‘Authentication
โœ”๏ธConfiguration
โšกContributing to hyper
๐Ÿ”ŒBuilding your own adapter
Code of Conduct
hyper RFCs
Style Guide
Bugs
Before Submitting A Bug Report
Building your own plugin
API Clients
Build your own client ๐Ÿ› ๏ธ
hyper connect
NodeJS Client ๐Ÿš€
Deno Client ๐Ÿฆ•
Middleware
Hooks
๐ŸšขDeploy
Deploy hyper on Render
Deploy hyper on AWS
Deploy hyper on Digital Ocean
Deploy hyper on Google Cloud
Deploy hyper on Azure
๐Ÿ“œChangelog
FAQ
๐Ÿ“•Terminology
Parameters
What is REST?
What is JSON?
๐Ÿ“˜Glossary
Docs powered byย archbeeย 
12min

Search API

This search service gives you a powerful search engine within your rest commands. Have documents you want to search, simply POST them to a search index and use the query command to get a set of matches from some text criteria. The goal of this API is to manage the complexity of running your own search engine, or having to deal with separate services, the search engine sits right next to your data, storage and cache for a high composable integration.

Features

  • Query Command - using a simple query text and optional filter you have a fully featured search at your disposal.
  • Bulk Document Indexing - create indexes using an array of documents to reduce round trips and quickly initialize your search engine.

REST API Commands

๏ปฟ

Index Commands

  • ๏ปฟPUT /search/{name} - Create Index
  • ๏ปฟDELETE /search/{name} - Delete Index
  • ๏ปฟPOST /search/{name}/_query - Query Index
  • ๏ปฟPOST /search/{name}/_bulk - Insert Bulk Docs

Document Commands

  • ๏ปฟPOST /search/{name} - Index document
  • ๏ปฟDELETE /search/{name}/{key} - Remove document from index

Adapters

  • ๏ปฟSearch Adapters

Use Cases

Full Text Search

Type ahead searching

๏ปฟ

๏ปฟ

Looking for help? Reach out to us for help at any time at support@hyper63.com

Updated 20 Jul 2021
Did this page help you?
Yes
No
UP NEXT
Create Search Index
Docs powered byย archbeeย 
TABLE OF CONTENTS
Features
REST API Commands
Index Commands
Document Commands
Adapters
Use Cases
Full Text Search
Type ahead searching