Summary

public struct Summary : Codable

Summary information about the search that was performed.

Important

This is a Public Preview API. It may be changed or removed at any time.

Lifecycle

  • Init method for Summary.

    Declaration

    Swift

    public init(
        query: String,
        queryType: String,
        queryTime: Int,
        numResults: Int,
        offset: Int,
        totalResults: Int,
        fuzzyLevel: Int
    )

    Parameters

    query

    The query this is a response to.

    queryType

    The type of the query.

    queryTime

    The time the query took to execute.

    numResults

    The number of results.

    offset

    Start index of returned results for query.

    totalResults

    Number of total results available for given query.

    fuzzyLevel

    The fuzzy search level.

Public

  • The query this is a response to.

    Declaration

    Swift

    public let query: String
  • The type of the query.

    Declaration

    Swift

    public let queryType: String
  • The time the query took to execute.

    Declaration

    Swift

    public let queryTime: Int
  • The number of results.

    Declaration

    Swift

    public let numResults: Int
  • Start index of returned results for query.

    Declaration

    Swift

    public let offset: Int
  • Number of total results available for given query.

    Declaration

    Swift

    public let totalResults: Int
  • The fuzzy search level.

    Declaration

    Swift

    public let fuzzyLevel: Int