SEseekstorm
Query

Query Index

Changed on

Query results from index with index_id. Query index via GET is a convenience function, that offers only a limited set of parameters compared to Query Index via POST. Always use Query Index via POST for the full set of parameters and maximum flexibility. Query Index via GET is provided for simple queries and quick testing, and to be easily callable from browser address bar, but it is not intended for production use.

get/api/v1/index/{index_id}/query

Request

Path parameters

index_idinteger required

index id

Query parameters

query_stringstring required

query string

offsetinteger required

result offset

lengthinteger required

result length

include_uncommittedboolean required

include uncommitted documents

enable_empty_queryboolean required

allow empty query

Headers

apikeystring required

YOUR_SECRET_API_KEY

Response

Results found, returns the SearchResultObject

original_querystring required

Search query string

querystring required

Search query string after any automatic query correction or completion

query_termsstring[] required

Vector of search query terms. Can be used e.g. for custom highlighting.

offsetinteger required

Offset of the returned search results

lengthinteger required

Number of requested search results

countinteger required

Number of returned search results. Identical to results.len()

count_totalinteger required

Total number of search results that match the query count_total is only accurate if result_type=TopkCount or ResultType=Count, but not for ResultType=Topk

observed_vector_countinteger required

number of vectors observed during search

observed_cluster_countinteger required

number of clusters observed during search

documentsobject[] required

Vector of search result documents

facetsobject required

List of facet fields: field name and vector of unique values and their counts. Unique values and their counts are only accurate if result_type=TopkCount or ResultType=Count, but not for ResultType=Topk

suggestionsstring[] required

Suggestions for auto complete and spelling correction.

timeinteger required

Time taken to execute the search query in nanoseconds

Changes

  • 546064e21d73Revision changes
    • breaking

      added the new required query request parameter include_uncommitted

    • breaking

      added the new required query request parameter query_string

    • breaking

      removed 'propertyNames' constraint from the / response property for the status

    • warning

      deleted the query request parameter query

    • warning

      deleted the query request parameter realtime

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

  • 39cce1ef7d95Revision changes
    • info

      api operation id query_index_api_get removed and replaced with query_index_get