DefaultQueryParams
public struct DefaultQueryParams : Codable, Equatable
Default query parameters for this project.
-
An array of collection identifiers to query. If empty or omitted all collections in the project are queried.
Declaration
Swift
public var collectionIDs: [String]?
-
Default settings configuration for passage search options.
Declaration
Swift
public var passages: DefaultQueryParamsPassages?
-
Default project query settings for table results.
Declaration
Swift
public var tableResults: DefaultQueryParamsTableResults?
-
A string representing the default aggregation query for the project.
Declaration
Swift
public var aggregation: String?
-
Object that contains suggested refinement settings. Available with Premium plans only.
Declaration
Swift
public var suggestedRefinements: DefaultQueryParamsSuggestedRefinements?
-
When
true
, a spelling suggestions for the query are returned by default.Declaration
Swift
public var spellingSuggestions: Bool?
-
When
true
, a highlights for the query are returned by default.Declaration
Swift
public var highlight: Bool?
-
The number of document results returned by default.
Declaration
Swift
public var count: Int?
-
A comma separated list of document fields to sort results by default.
Declaration
Swift
public var sort: String?
-
An array of field names to return in document results if present by default.
Declaration
Swift
public var `return`: [String]?
-
init(collectionIDs:
passages: tableResults: aggregation: suggestedRefinements: spellingSuggestions: highlight: count: sort: return: ) Initialize a
DefaultQueryParams
with member variables.Declaration
Swift
public init( collectionIDs: [String]? = nil, passages: DefaultQueryParamsPassages? = nil, tableResults: DefaultQueryParamsTableResults? = nil, aggregation: String? = nil, suggestedRefinements: DefaultQueryParamsSuggestedRefinements? = nil, spellingSuggestions: Bool? = nil, highlight: Bool? = nil, count: Int? = nil, sort: String? = nil, `return`: [String]? = nil )
Parameters
collectionIDs
An array of collection identifiers to query. If empty or omitted all collections in the project are queried.
passages
Default settings configuration for passage search options.
tableResults
Default project query settings for table results.
aggregation
A string representing the default aggregation query for the project.
suggestedRefinements
Object that contains suggested refinement settings. Available with Premium plans only.
spellingSuggestions
When
true
, a spelling suggestions for the query are returned by default.highlight
When
true
, a highlights for the query are returned by default.count
The number of document results returned by default.
sort
A comma separated list of document fields to sort results by default.
Return Value
An initialized
DefaultQueryParams
.