...
...
...
...
...
...
...
...
...
...
| Section | ||
|---|---|---|
| Column | ||
| ||
| Info | ||
| Note | ||
Important Depending on the version of HawkSearch used, method of integration, and the presence of data feed files for indexing, you may need to perform indexing as per this article or Using Dashboard API to Rebuild Indexes. Please contact HawkSearch for any clarifications.clarifications. |
| Column | ||||
|---|---|---|---|---|
| ||||
Contents
|
Domains
Hawksearch has three environments available: Development, Test and a load-balanced Production. When using the search API methods in this document, the following domains can be used to access each environment after your engine has been set-up in that environment.
Note: to index hierarchical data, please build the hierarchy using the Hierarchy API and then call the index-items API.
Development
Configurations for an engine in this location are maintained in the Hawksearch Workbench at dev.hawksearch.net.
Test
Configurations for an engine in this location are maintained in the Hawksearch Workbench at test.hawksearch.net.
Production
Configurations for an engine in this location are maintained in the Hawksearch Workbench at https://dashboard-na.hawksearch.com/
...
...
Contents
| Table of Contents | ||
|---|---|---|
|
Indexing API Methods
Create
...
| Expand | ||
|---|---|---|
| ||
Example 2.1 Delete single item from index
"Id": "Item_DocId" |
Response
| Expand | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
None or Message with Error
|
...
| Expand | ||
|---|---|---|
| ||
Example 3.1 Delete single item from index
"Ids": ["Item_DocId", "Item_Doc2Id"] |
Response
| Expand | ||||||
|---|---|---|---|---|---|---|
| ||||||
None or Message with Error
|
...
If an item is sent with a key that matches an existing item, that item will be updated with the attributes being sent. If an item is sent with a new key, that item will be added to the index.
| Note |
|---|
Note: To index hierarchical data, please build the hierarchy using the Hierarchy API and then call the index-items API. |
Request
Endpoint | Method | Header Key |
|---|---|---|
api/v2/indexing/index-items | POST | X-HawkSearch-ApiKey |
...
Endpoint | Method | Header Key |
|---|---|---|
api/v2/indexing/rebuild-learning | POST | X-HawkSearch-ApiKey |
| Expand | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
| ||||||||||||
...
Endpoint | Method | Header Key |
|---|---|---|
api/v2/indexing/rebuild-related | POST | X-HawkSearch-ApiKey |
| Expand | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
| ||||||||||||
...