Search

Search entities using Natural Language Query (NLQ)

Search entities using Natural Language Queries (NLQ) with full search capabilities.

get/v1/search/nlq/query

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/search/nlq/query
  • Auth: HTTP bearer

Query parameters

qstring

NLQ query string in natural language

indexstring

ElasticSearch Index name, defaults to table_search_index

deletedboolean

Filter documents by deleted param. By default deleted is false

frominteger

From field to paginate the results, defaults to 0

sizeinteger

Size field to limit the no.of results returned, defaults to 10

search_afterstring[]

Pagination cursor. Repeat once per sort value: ?search_after=v1&search_after=v2.

sort_fieldstring

Sort the search results by field

sort_orderstring

Sort order asc for ascending or desc for descending, defaults to desc

track_total_hitsboolean

Track Total Hits

query_filterstring

Additional filters to apply

post_filterstring

Post-filters to apply

fetch_sourceboolean

Get document body for each hit

include_source_fieldsstring[]

Get only selected fields of the document body

exclude_source_fieldsstring[]

Exclude specified fields from the document body for each hit

getHierarchyboolean

Fetch results in hierarchical order

explainboolean

Explain the results of the query

Response

NLQ search response

SearchResponse required

Changes

No recorded changes to this operation across all 1 revision of this API.