QueryResultItem Structure Reference


                    
                    
                    _members

Declaration

Swift

public static var _members: [AWSShapeMember]


                    
                    
                    additionalAttributes

One or more additional attributes associated with the query result.

Declaration

Swift

public let additionalAttributes: [AdditionalResultAttribute]?


                    
                    
                    documentAttributes

An array of document attributes for the document that the query result maps to. For example, the document author (Author) or the source URI (SourceUri) of the document.

Declaration

Swift

public let documentAttributes: [DocumentAttribute]?


                    
                    
                    documentExcerpt

An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt.

Declaration

Swift

public let documentExcerpt: TextWithHighlights?


                    
                    
                    documentId

The unique identifier for the document.

Declaration

Swift

public let documentId: String?


                    
                    
                    documentTitle

The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title.

Declaration

Swift

public let documentTitle: TextWithHighlights?


                    
                    
                    documentURI

The URI of the original location of the document.

Declaration

Swift

public let documentURI: String?

id

The unique identifier for the query result.

Declaration

Swift

public let id: String?


                    
                    
                    scoreAttributes

Indicates the confidence that Amazon Kendra has that a result matches the query that you provided. Each result is placed into a bin that indicates the confidence, VERY_HIGH, HIGH, and MEDIUM. You can use the score to determine if a response meets the confidence needed for your application. Confidence scores are only returned for results with the Type field set to QUESTION_ANSWER or ANSWER. This field is not returned if the Type field is set to DOCUMENT.

Declaration

Swift

public let scoreAttributes: ScoreAttributes?


                    
                    
                    type

The type of document.

Declaration

Swift

public let type: QueryResultType?


                    
                    
                    init(additionalAttributes:documentAttributes:documentExcerpt:documentId:documentTitle:documentURI:id:scoreAttributes:type:)

Undocumented

Declaration

Swift

public init(additionalAttributes: [AdditionalResultAttribute]? = nil, documentAttributes: [DocumentAttribute]? = nil, documentExcerpt: TextWithHighlights? = nil, documentId: String? = nil, documentTitle: TextWithHighlights? = nil, documentURI: String? = nil, id: String? = nil, scoreAttributes: ScoreAttributes? = nil, type: QueryResultType? = nil)