Skip to main content

Typesense_SearchResponseSuccess

No description

type Typesense_SearchResponseSuccess {
  facet_counts: [Typesense_SearchResponseFacetCounts]
  found: Int!
  found_docs: Int
  out_of: Int!
  page: Int!
  request_params: Typesense_SearchResponseRequestParams!
  search_time_ms: Int!
  search_cutoff: Boolean
  hits: [Typesense_SearchResponseHit]
  grouped_hits: [Typesense_SearchResponseGroupedHit]
  conversation: Typesense_SearchResponseConversation
}

Fields​

Typesense_SearchResponseSuccess.facet_counts ● [Typesense_SearchResponseFacetCounts] list object​

Typesense_SearchResponseSuccess.found ● Int! non-null scalar​

The number of documents found

Typesense_SearchResponseSuccess.found_docs ● Int scalar​

Typesense_SearchResponseSuccess.out_of ● Int! non-null scalar​

The total number of documents in the collection

Typesense_SearchResponseSuccess.page ● Int! non-null scalar​

The search result page number

Typesense_SearchResponseSuccess.request_params ● Typesense_SearchResponseRequestParams! non-null object​

Typesense_SearchResponseSuccess.search_time_ms ● Int! non-null scalar​

The number of milliseconds the search took

Typesense_SearchResponseSuccess.search_cutoff ● Boolean scalar​

Whether the search was cut off

Typesense_SearchResponseSuccess.hits ● [Typesense_SearchResponseHit] list object​

The documents that matched the search query

Typesense_SearchResponseSuccess.grouped_hits ● [Typesense_SearchResponseGroupedHit] list object​

Typesense_SearchResponseSuccess.conversation ● Typesense_SearchResponseConversation object​

Implemented By​

Typesense_SearchResponse union