\SearchApi

All URIs are relative to http://127.0.0.1:9308

Method	HTTP request	Description
autocomplete	Post /autocomplete	Performs an autocomplete search on a table
percolate	Post /pq/{table}/search	Perform reverse search on a percolate table
search	Post /search	Performs a search on a table

autocomplete

Vec<serde_json::Value> autocomplete(autocomplete_request) Performs an autocomplete search on a table

The method expects an object with the following mandatory properties: * the name of the table to search * the query string to autocomplete For details, see the documentation on Autocomplete An example: { \"table\":\"table_name\", \"query\":\"query_beginning\" } An example of the method's response: [ { \"total\": 3, \"error\": \"\", \"warning\": \"\", \"columns\": [ { \"query\": { \"type\": \"string\" } } ], \"data\": [ { \"query\": \"hello\" }, { \"query\": \"helio\" }, { \"query\": \"hell\" } ] } ] For more detailed information about the autocomplete queries, please refer to the documentation here.

Parameters

Name	Type	Description	Required	Notes
autocomplete_request	AutocompleteRequest		[required]

Return type

Vec<serde_json::Value>

Authorization

basicAuth, bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

percolate

models::SearchResponse percolate(table, percolate_request) Perform reverse search on a percolate table

Performs a percolate search. This method must be used only on percolate tables. Expects two parameters: the table name and an object with array of documents to be tested. An example of the documents object: { \"query\" { \"percolate\": { \"document\": { \"content\":\"sample content\" } } } } Responds with an object with matched stored queries: { 'timed_out':false, 'hits': { 'total':2, 'max_score':1, 'hits': [ { 'table':'idx_pq_1', '_type':'doc', '_id':'2', '_score':'1', '_source': { 'query': { 'match':{'title':'some'} } } }, { 'table':'idx_pq_1', '_type':'doc', '_id':'5', '_score':'1', '_source': { 'query': { 'ql':'some | none' } } } ] } }

Parameters

Name	Type	Description	Required	Notes
table	String	Name of the percolate table	[required]
percolate_request	PercolateRequest		[required]

Return type

models::SearchResponse

Authorization

basicAuth, bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

search

models::SearchResponse search(search_request) Performs a search on a table

The method expects an object with the following mandatory properties: * the name of the table to search * the match query object For details, see the documentation on SearchRequest The method returns an object with the following properties: - took: the time taken to execute the search query. - timed_out: a boolean indicating whether the query timed out. - hits: an object with the following properties: - total: the total number of hits found. - hits: an array of hit objects, where each hit object represents a matched document. Each hit object has the following properties: - _id: the ID of the matched document. - _score: the score of the matched document. - _source: the source data of the matched document. In addition, if profiling is enabled, the response will include an additional array with profiling information attached. Also, if pagination is enabled, the response will include an additional 'scroll' property with a scroll token to use for pagination Here is an example search response: { 'took':10, 'timed_out':false, 'hits': { 'total':2, 'hits': [ {'_id':'1','_score':1,'_source':{'gid':11}}, {'_id':'2','_score':1,'_source':{'gid':12}} ] } } For conversational search, include a chat object instead of table and query. The response then includes the optional conversational fields on searchResponse (conversation_uuid, user_query, search_query, response, sources). For more information about the match query syntax and additional parameters that can be added to request and response, please see the documentation here.

Parameters

Name	Type	Description	Required	Notes
search_request	SearchRequest		[required]

Return type

models::SearchResponse

Authorization

basicAuth, bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]