QueryResponse

public struct QueryResponse : Codable, Equatable

A response that contains the documents and aggregations for the query.

  • The number of matching results for the query. Results that match due to a curation only are not counted in the total.

    Declaration

    Swift

    public var matchingResults: Int?

  • Array of document results for the query.

    Declaration

    Swift

    public var results: [QueryResult]?

  • Array of aggregations for the query.

    Declaration

    Swift

    public var aggregations: [QueryAggregation]?

  • An object contain retrieval type information.

    Declaration

    Swift

    public var retrievalDetails: RetrievalDetails?

  • Suggested correction to the submitted natural_language_query value.

    Declaration

    Swift

    public var suggestedQuery: String?

  • Array of suggested refinements.

    Declaration

    Swift

    public var suggestedRefinements: [QuerySuggestedRefinement]?

  • Array of table results.

    Declaration

    Swift

    public var tableResults: [QueryTableResult]?

  • Passages that best match the query from across all of the collections in the project.

    Declaration

    Swift

    public var passages: [QueryResponsePassage]?