QueryResponse

public struct QueryResponse : Codable, Equatable

A response containing the documents and aggregations for the query.

  • The number of matching results for the query.

    Declaration

    Swift

    public var matchingResults: Int?
  • Array of document results for the query.

    Declaration

    Swift

    public var results: [QueryResult]?
  • Array of aggregation results for the query.

    Declaration

    Swift

    public var aggregations: [QueryAggregation]?
  • Array of passage results for the query.

    Declaration

    Swift

    public var passages: [QueryPassages]?
  • The number of duplicate results removed.

    Declaration

    Swift

    public var duplicatesRemoved: Int?
  • 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.

    Declaration

    Swift

    public var sessionToken: String?
  • An object contain retrieval type information.

    Declaration

    Swift

    public var retrievalDetails: RetrievalDetails?
  • The suggestions for a misspelled natural language query.

    Declaration

    Swift

    public var suggestedQuery: String?