QueryLargePassages Structure Reference


                    
                    
                    enabled

A passages query that returns the most relevant passages from the results.

Declaration

Swift

public var enabled: Bool?


                    
                    
                    perDocument

If true, ranks the documents by document quality, and then returns the highest-ranked passages per document in a document_passages field for each document entry in the results list of the response. If false, ranks the passages from all of the documents by passage quality regardless of the document quality and returns them in a separate passages field in the response.

Declaration

Swift

public var perDocument: Bool?


                    
                    
                    maxPerDocument

Maximum number of passages to return per document in the result. Ignored if passages.per_document is false.

Declaration

Swift

public var maxPerDocument: Int?


                    
                    
                    fields

A list of fields to extract passages from. If this parameter is an empty list, then all root-level fields are included.

Declaration

Swift

public var fields: [String]?


                    
                    
                    count

The maximum number of passages to return. Ignored if passages.per_document is true.

Declaration

Swift

public var count: Int?


                    
                    
                    characters

The approximate number of characters that any one passage will have.

Declaration

Swift

public var characters: Int?


                    
                    
                    findAnswers

When true, answer objects are returned as part of each passage in the query results. The primary difference between an answer and a passage is that the length of a passage is defined by the query, where the length of an answer is calculated by Discovery based on how much text is needed to answer the question. This parameter is ignored if passages are not enabled for the query, or no natural_language_query is specified. If the find_answers parameter is set to true and per_document parameter is also set to true, then the document search results and the passage search results within each document are reordered using the answer confidences. The goal of this reordering is to place the best answer as the first answer of the first passage of the first document. Similarly, if the find_answers parameter is set to true and per_document parameter is set to false, then the passage search results are reordered in decreasing order of the highest confidence answer for each document and passage. The find_answers parameter is available only on managed instances of Discovery.

Declaration

Swift

public var findAnswers: Bool?


                    
                    
                    maxAnswersPerPassage

The number of answer objects to return per passage if the find_answers parmeter is specified as true.

Declaration

Swift

public var maxAnswersPerPassage: Int?


                    
                    
                    init(enabled:perDocument:maxPerDocument:fields:count:characters:findAnswers:maxAnswersPerPassage:)

Initialize a QueryLargePassages with member variables.

Declaration

Swift

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

Parameters

`enabled`	A passages query that returns the most relevant passages from the results.
`perDocument`	If `true`, ranks the documents by document quality, and then returns the highest-ranked passages per document in a `document_passages` field for each document entry in the results list of the response. If `false`, ranks the passages from all of the documents by passage quality regardless of the document quality and returns them in a separate `passages` field in the response.
`maxPerDocument`	Maximum number of passages to return per document in the result. Ignored if `passages.per_document` is `false`.
`fields`	A list of fields to extract passages from. If this parameter is an empty list, then all root-level fields are included.
`count`	The maximum number of passages to return. Ignored if `passages.per_document` is `true`.
`characters`	The approximate number of characters that any one passage will have.
`findAnswers`	When true, `answer` objects are returned as part of each passage in the query results. The primary difference between an `answer` and a `passage` is that the length of a passage is defined by the query, where the length of an `answer` is calculated by Discovery based on how much text is needed to answer the question. This parameter is ignored if passages are not enabled for the query, or no natural_language_query is specified. If the find_answers parameter is set to `true` and per_document parameter is also set to `true`, then the document search results and the passage search results within each document are reordered using the answer confidences. The goal of this reordering is to place the best answer as the first answer of the first passage of the first document. Similarly, if the find_answers parameter is set to `true` and per_document parameter is set to `false`, then the passage search results are reordered in decreasing order of the highest confidence answer for each document and passage. The find_answers parameter is available only on managed instances of Discovery.
`maxAnswersPerPassage`	The number of `answer` objects to return per passage if the find_answers parmeter is specified as `true`.

Return Value

An initialized QueryLargePassages.