DefaultQueryParamsPassages

public struct DefaultQueryParamsPassages : Codable, Equatable

Default settings configuration for passage search options.

  • When true, a passage search is performed by default.

    Declaration

    Swift

    public var enabled: Bool?

  • The number of passages to return.

    Declaration

    Swift

    public var count: Int?

  • An array of field names to perform the passage search on.

    Declaration

    Swift

    public var fields: [String]?

  • The approximate number of characters that each returned passage will contain.

    Declaration

    Swift

    public var characters: Int?

  • When true the number of passages that can be returned from a single document is restricted to the max_per_document value.

    Declaration

    Swift

    public var perDocument: Bool?

  • The default maximum number of passages that can be taken from a single document as the result of a passage query.

    Declaration

    Swift

    public var maxPerDocument: Int?

  • Initialize a DefaultQueryParamsPassages with member variables.

    Declaration

    Swift

    public init(
    enabled: Bool? = nil,
    count: Int? = nil,
    fields: [String]? = nil,
    characters: Int? = nil,
    perDocument: Bool? = nil,
    maxPerDocument: Int? = nil
)

    Parameters

    enabled

    When true, a passage search is performed by default.
    count

    The number of passages to return.
    fields

    An array of field names to perform the passage search on.
    characters

    The approximate number of characters that each returned passage will contain.
    perDocument

    When true the number of passages that can be returned from a single document is restricted to the max_per_document value.
    maxPerDocument

    The default maximum number of passages that can be taken from a single document as the result of a passage query.

    Return Value

    An initialized DefaultQueryParamsPassages.