Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryResponse

A response containing the documents and aggregations for the query.

Hierarchy

  • QueryResponse

Index

Properties

Optional aggregations

aggregations: QueryAggregation[]

Array of aggregation results for the query.

Optional duplicates_removed

duplicates_removed: number

The number of duplicate results removed.

Optional matching_results

matching_results: number

The number of matching results for the query.

Optional passages

passages: QueryPassages[]

Array of passage results for the query.

Optional results

results: QueryResult[]

Array of document results for the query.

Optional retrieval_details

retrieval_details: RetrievalDetails

An object contain retrieval type information.

Optional session_token

session_token: string

The session token for this query. The session token can be used to add events associated with this query to the query and event log.

Important: Session tokens are case sensitive.

Optional suggested_query

suggested_query: string

The suggestions for a misspelled natural language query.

Generated using TypeDoc