Search API #

Search API Reference #

Get Query Suggestions #

//request
curl  -XGET http://localhost:9000/query/_suggest\?query\=buss

//response
{
  "query": "buss",
  "suggestions": [
    {
      "suggestion": "Q3 Business Report",
      "score": 0.99,
      "source": {
         "type":"connector",
         "name":"google_drive",
         "id":"e806831dacc3",
       }
    }
  ]
}

Get Search Results #

//request
curl  -XGET http://localhost:9000/query/_search\?query\=Business

//response
{"took":15,"timed_out":false,"_shards":{"total":1,"successful":1,"skipped":0,"failed":0},"hits":{"total":{"value":1,"relation":"eq"},"max_score":3.0187376,"hits":[{"_index":"coco_document","_type":"_doc","_id":"csstf6rq50k5sqipjaa0","_score":3.0187376,"_source":{"id":"csstf6rq50k5sqipjaa0", ...OMITTED...}}}]}}

Parameters #

Parameter	Type	Default	Description
`query`	string	`""`	The search query string.
`from`	int	`0`	The starting offset of the search results (used for pagination).
`size`	int	`10`	The number of search results to return.
`datasource`	string	`""`	Filter results by a specific data source ID.
`category`	string	`""`	Filter results by a top-level category.
`subcategory`	string	`""`	Filter results by a subcategory within the main category.
`rich_category`	string	`""`	Filter results by a richer, possibly hierarchical, category structure.
`username`	string	`""`	Filter results by the username of the user who created or owns the documents.
`userid`	string	`""`	Filter results by the user ID of the user who created or owns the documents.
`tags`	string	`""`	Filter results by tags assigned to the documents.
`search_field`	string	`"title"`	Specifies which field(s) to search within the documents (e.g., `title`, `content`).
`source_fields`	string	`"*"`	Specifies which fields to return in the search result (`*` returns all fields).