AWS SDK for C++  1.9.1
AWS SDK for C++
Public Member Functions | List of all members
Aws::kendra::Model::QueryResultItem Class Reference

#include <QueryResultItem.h>

Public Member Functions

 QueryResultItem ()
 
 QueryResultItem (Aws::Utils::Json::JsonView jsonValue)
 
QueryResultItemoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
QueryResultItemWithId (const Aws::String &value)
 
QueryResultItemWithId (Aws::String &&value)
 
QueryResultItemWithId (const char *value)
 
const QueryResultTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const QueryResultType &value)
 
void SetType (QueryResultType &&value)
 
QueryResultItemWithType (const QueryResultType &value)
 
QueryResultItemWithType (QueryResultType &&value)
 
const Aws::Vector< AdditionalResultAttribute > & GetAdditionalAttributes () const
 
bool AdditionalAttributesHasBeenSet () const
 
void SetAdditionalAttributes (const Aws::Vector< AdditionalResultAttribute > &value)
 
void SetAdditionalAttributes (Aws::Vector< AdditionalResultAttribute > &&value)
 
QueryResultItemWithAdditionalAttributes (const Aws::Vector< AdditionalResultAttribute > &value)
 
QueryResultItemWithAdditionalAttributes (Aws::Vector< AdditionalResultAttribute > &&value)
 
QueryResultItemAddAdditionalAttributes (const AdditionalResultAttribute &value)
 
QueryResultItemAddAdditionalAttributes (AdditionalResultAttribute &&value)
 
const Aws::StringGetDocumentId () const
 
bool DocumentIdHasBeenSet () const
 
void SetDocumentId (const Aws::String &value)
 
void SetDocumentId (Aws::String &&value)
 
void SetDocumentId (const char *value)
 
QueryResultItemWithDocumentId (const Aws::String &value)
 
QueryResultItemWithDocumentId (Aws::String &&value)
 
QueryResultItemWithDocumentId (const char *value)
 
const TextWithHighlightsGetDocumentTitle () const
 
bool DocumentTitleHasBeenSet () const
 
void SetDocumentTitle (const TextWithHighlights &value)
 
void SetDocumentTitle (TextWithHighlights &&value)
 
QueryResultItemWithDocumentTitle (const TextWithHighlights &value)
 
QueryResultItemWithDocumentTitle (TextWithHighlights &&value)
 
const TextWithHighlightsGetDocumentExcerpt () const
 
bool DocumentExcerptHasBeenSet () const
 
void SetDocumentExcerpt (const TextWithHighlights &value)
 
void SetDocumentExcerpt (TextWithHighlights &&value)
 
QueryResultItemWithDocumentExcerpt (const TextWithHighlights &value)
 
QueryResultItemWithDocumentExcerpt (TextWithHighlights &&value)
 
const Aws::StringGetDocumentURI () const
 
bool DocumentURIHasBeenSet () const
 
void SetDocumentURI (const Aws::String &value)
 
void SetDocumentURI (Aws::String &&value)
 
void SetDocumentURI (const char *value)
 
QueryResultItemWithDocumentURI (const Aws::String &value)
 
QueryResultItemWithDocumentURI (Aws::String &&value)
 
QueryResultItemWithDocumentURI (const char *value)
 
const Aws::Vector< DocumentAttribute > & GetDocumentAttributes () const
 
bool DocumentAttributesHasBeenSet () const
 
void SetDocumentAttributes (const Aws::Vector< DocumentAttribute > &value)
 
void SetDocumentAttributes (Aws::Vector< DocumentAttribute > &&value)
 
QueryResultItemWithDocumentAttributes (const Aws::Vector< DocumentAttribute > &value)
 
QueryResultItemWithDocumentAttributes (Aws::Vector< DocumentAttribute > &&value)
 
QueryResultItemAddDocumentAttributes (const DocumentAttribute &value)
 
QueryResultItemAddDocumentAttributes (DocumentAttribute &&value)
 
const ScoreAttributesGetScoreAttributes () const
 
bool ScoreAttributesHasBeenSet () const
 
void SetScoreAttributes (const ScoreAttributes &value)
 
void SetScoreAttributes (ScoreAttributes &&value)
 
QueryResultItemWithScoreAttributes (const ScoreAttributes &value)
 
QueryResultItemWithScoreAttributes (ScoreAttributes &&value)
 
const Aws::StringGetFeedbackToken () const
 
bool FeedbackTokenHasBeenSet () const
 
void SetFeedbackToken (const Aws::String &value)
 
void SetFeedbackToken (Aws::String &&value)
 
void SetFeedbackToken (const char *value)
 
QueryResultItemWithFeedbackToken (const Aws::String &value)
 
QueryResultItemWithFeedbackToken (Aws::String &&value)
 
QueryResultItemWithFeedbackToken (const char *value)
 

Detailed Description

A single query result.

A query result contains information about a document returned by the query. This includes the original location of the document, a list of attributes assigned to the document, and relevant text from the document that satisfies the query.

See Also:

AWS API Reference

Definition at line 40 of file QueryResultItem.h.

Constructor & Destructor Documentation

◆ QueryResultItem() [1/2]

Aws::kendra::Model::QueryResultItem::QueryResultItem ( )

◆ QueryResultItem() [2/2]

Aws::kendra::Model::QueryResultItem::QueryResultItem ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddAdditionalAttributes() [1/2]

QueryResultItem& Aws::kendra::Model::QueryResultItem::AddAdditionalAttributes ( AdditionalResultAttribute &&  value)
inline

One or more additional attributes associated with the query result.

Definition at line 159 of file QueryResultItem.h.

◆ AddAdditionalAttributes() [2/2]

QueryResultItem& Aws::kendra::Model::QueryResultItem::AddAdditionalAttributes ( const AdditionalResultAttribute value)
inline

One or more additional attributes associated with the query result.

Definition at line 154 of file QueryResultItem.h.

◆ AddDocumentAttributes() [1/2]

QueryResultItem& Aws::kendra::Model::QueryResultItem::AddDocumentAttributes ( const DocumentAttribute value)
inline

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.

Definition at line 365 of file QueryResultItem.h.

◆ AddDocumentAttributes() [2/2]

QueryResultItem& Aws::kendra::Model::QueryResultItem::AddDocumentAttributes ( DocumentAttribute &&  value)
inline

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.

Definition at line 372 of file QueryResultItem.h.

◆ AdditionalAttributesHasBeenSet()

bool Aws::kendra::Model::QueryResultItem::AdditionalAttributesHasBeenSet ( ) const
inline

One or more additional attributes associated with the query result.

Definition at line 129 of file QueryResultItem.h.

◆ DocumentAttributesHasBeenSet()

bool Aws::kendra::Model::QueryResultItem::DocumentAttributesHasBeenSet ( ) const
inline

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.

Definition at line 330 of file QueryResultItem.h.

◆ DocumentExcerptHasBeenSet()

bool Aws::kendra::Model::QueryResultItem::DocumentExcerptHasBeenSet ( ) const
inline

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

Definition at line 250 of file QueryResultItem.h.

◆ DocumentIdHasBeenSet()

bool Aws::kendra::Model::QueryResultItem::DocumentIdHasBeenSet ( ) const
inline

The unique identifier for the document.

Definition at line 170 of file QueryResultItem.h.

◆ DocumentTitleHasBeenSet()

bool Aws::kendra::Model::QueryResultItem::DocumentTitleHasBeenSet ( ) const
inline

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

Definition at line 213 of file QueryResultItem.h.

◆ DocumentURIHasBeenSet()

bool Aws::kendra::Model::QueryResultItem::DocumentURIHasBeenSet ( ) const
inline

The URI of the original location of the document.

Definition at line 285 of file QueryResultItem.h.

◆ FeedbackTokenHasBeenSet()

bool Aws::kendra::Model::QueryResultItem::FeedbackTokenHasBeenSet ( ) const
inline

A token that identifies a particular result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback .

Definition at line 464 of file QueryResultItem.h.

◆ GetAdditionalAttributes()

const Aws::Vector<AdditionalResultAttribute>& Aws::kendra::Model::QueryResultItem::GetAdditionalAttributes ( ) const
inline

One or more additional attributes associated with the query result.

Definition at line 124 of file QueryResultItem.h.

◆ GetDocumentAttributes()

const Aws::Vector<DocumentAttribute>& Aws::kendra::Model::QueryResultItem::GetDocumentAttributes ( ) const
inline

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.

Definition at line 323 of file QueryResultItem.h.

◆ GetDocumentExcerpt()

const TextWithHighlights& Aws::kendra::Model::QueryResultItem::GetDocumentExcerpt ( ) const
inline

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

Definition at line 244 of file QueryResultItem.h.

◆ GetDocumentId()

const Aws::String& Aws::kendra::Model::QueryResultItem::GetDocumentId ( ) const
inline

The unique identifier for the document.

Definition at line 165 of file QueryResultItem.h.

◆ GetDocumentTitle()

const TextWithHighlights& Aws::kendra::Model::QueryResultItem::GetDocumentTitle ( ) const
inline

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

Definition at line 207 of file QueryResultItem.h.

◆ GetDocumentURI()

const Aws::String& Aws::kendra::Model::QueryResultItem::GetDocumentURI ( ) const
inline

The URI of the original location of the document.

Definition at line 280 of file QueryResultItem.h.

◆ GetFeedbackToken()

const Aws::String& Aws::kendra::Model::QueryResultItem::GetFeedbackToken ( ) const
inline

A token that identifies a particular result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback .

Definition at line 455 of file QueryResultItem.h.

◆ GetId()

const Aws::String& Aws::kendra::Model::QueryResultItem::GetId ( ) const
inline

The unique identifier for the query result.

Definition at line 52 of file QueryResultItem.h.

◆ GetScoreAttributes()

const ScoreAttributes& Aws::kendra::Model::QueryResultItem::GetScoreAttributes ( ) const
inline

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, MEDIUM and LOW. You can use the score to determine if a response meets the confidence needed for your application.

The field is only set to LOW when the Type field is set to DOCUMENT and Amazon Kendra is not confident that the result matches the query.

Definition at line 385 of file QueryResultItem.h.

◆ GetType()

const QueryResultType& Aws::kendra::Model::QueryResultItem::GetType ( ) const
inline

The type of document.

Definition at line 93 of file QueryResultItem.h.

◆ IdHasBeenSet()

bool Aws::kendra::Model::QueryResultItem::IdHasBeenSet ( ) const
inline

The unique identifier for the query result.

Definition at line 57 of file QueryResultItem.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::kendra::Model::QueryResultItem::Jsonize ( ) const

◆ operator=()

QueryResultItem& Aws::kendra::Model::QueryResultItem::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ ScoreAttributesHasBeenSet()

bool Aws::kendra::Model::QueryResultItem::ScoreAttributesHasBeenSet ( ) const
inline

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, MEDIUM and LOW. You can use the score to determine if a response meets the confidence needed for your application.

The field is only set to LOW when the Type field is set to DOCUMENT and Amazon Kendra is not confident that the result matches the query.

Definition at line 397 of file QueryResultItem.h.

◆ SetAdditionalAttributes() [1/2]

void Aws::kendra::Model::QueryResultItem::SetAdditionalAttributes ( Aws::Vector< AdditionalResultAttribute > &&  value)
inline

One or more additional attributes associated with the query result.

Definition at line 139 of file QueryResultItem.h.

◆ SetAdditionalAttributes() [2/2]

void Aws::kendra::Model::QueryResultItem::SetAdditionalAttributes ( const Aws::Vector< AdditionalResultAttribute > &  value)
inline

One or more additional attributes associated with the query result.

Definition at line 134 of file QueryResultItem.h.

◆ SetDocumentAttributes() [1/2]

void Aws::kendra::Model::QueryResultItem::SetDocumentAttributes ( Aws::Vector< DocumentAttribute > &&  value)
inline

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.

Definition at line 344 of file QueryResultItem.h.

◆ SetDocumentAttributes() [2/2]

void Aws::kendra::Model::QueryResultItem::SetDocumentAttributes ( const Aws::Vector< DocumentAttribute > &  value)
inline

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.

Definition at line 337 of file QueryResultItem.h.

◆ SetDocumentExcerpt() [1/2]

void Aws::kendra::Model::QueryResultItem::SetDocumentExcerpt ( const TextWithHighlights value)
inline

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

Definition at line 256 of file QueryResultItem.h.

◆ SetDocumentExcerpt() [2/2]

void Aws::kendra::Model::QueryResultItem::SetDocumentExcerpt ( TextWithHighlights &&  value)
inline

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

Definition at line 262 of file QueryResultItem.h.

◆ SetDocumentId() [1/3]

void Aws::kendra::Model::QueryResultItem::SetDocumentId ( Aws::String &&  value)
inline

The unique identifier for the document.

Definition at line 180 of file QueryResultItem.h.

◆ SetDocumentId() [2/3]

void Aws::kendra::Model::QueryResultItem::SetDocumentId ( const Aws::String value)
inline

The unique identifier for the document.

Definition at line 175 of file QueryResultItem.h.

◆ SetDocumentId() [3/3]

void Aws::kendra::Model::QueryResultItem::SetDocumentId ( const char *  value)
inline

The unique identifier for the document.

Definition at line 185 of file QueryResultItem.h.

◆ SetDocumentTitle() [1/2]

void Aws::kendra::Model::QueryResultItem::SetDocumentTitle ( const TextWithHighlights value)
inline

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

Definition at line 219 of file QueryResultItem.h.

◆ SetDocumentTitle() [2/2]

void Aws::kendra::Model::QueryResultItem::SetDocumentTitle ( TextWithHighlights &&  value)
inline

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

Definition at line 225 of file QueryResultItem.h.

◆ SetDocumentURI() [1/3]

void Aws::kendra::Model::QueryResultItem::SetDocumentURI ( Aws::String &&  value)
inline

The URI of the original location of the document.

Definition at line 295 of file QueryResultItem.h.

◆ SetDocumentURI() [2/3]

void Aws::kendra::Model::QueryResultItem::SetDocumentURI ( const Aws::String value)
inline

The URI of the original location of the document.

Definition at line 290 of file QueryResultItem.h.

◆ SetDocumentURI() [3/3]

void Aws::kendra::Model::QueryResultItem::SetDocumentURI ( const char *  value)
inline

The URI of the original location of the document.

Definition at line 300 of file QueryResultItem.h.

◆ SetFeedbackToken() [1/3]

void Aws::kendra::Model::QueryResultItem::SetFeedbackToken ( Aws::String &&  value)
inline

A token that identifies a particular result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback .

Definition at line 482 of file QueryResultItem.h.

◆ SetFeedbackToken() [2/3]

void Aws::kendra::Model::QueryResultItem::SetFeedbackToken ( const Aws::String value)
inline

A token that identifies a particular result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback .

Definition at line 473 of file QueryResultItem.h.

◆ SetFeedbackToken() [3/3]

void Aws::kendra::Model::QueryResultItem::SetFeedbackToken ( const char *  value)
inline

A token that identifies a particular result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback .

Definition at line 491 of file QueryResultItem.h.

◆ SetId() [1/3]

void Aws::kendra::Model::QueryResultItem::SetId ( Aws::String &&  value)
inline

The unique identifier for the query result.

Definition at line 67 of file QueryResultItem.h.

◆ SetId() [2/3]

void Aws::kendra::Model::QueryResultItem::SetId ( const Aws::String value)
inline

The unique identifier for the query result.

Definition at line 62 of file QueryResultItem.h.

◆ SetId() [3/3]

void Aws::kendra::Model::QueryResultItem::SetId ( const char *  value)
inline

The unique identifier for the query result.

Definition at line 72 of file QueryResultItem.h.

◆ SetScoreAttributes() [1/2]

void Aws::kendra::Model::QueryResultItem::SetScoreAttributes ( const ScoreAttributes value)
inline

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, MEDIUM and LOW. You can use the score to determine if a response meets the confidence needed for your application.

The field is only set to LOW when the Type field is set to DOCUMENT and Amazon Kendra is not confident that the result matches the query.

Definition at line 409 of file QueryResultItem.h.

◆ SetScoreAttributes() [2/2]

void Aws::kendra::Model::QueryResultItem::SetScoreAttributes ( ScoreAttributes &&  value)
inline

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, MEDIUM and LOW. You can use the score to determine if a response meets the confidence needed for your application.

The field is only set to LOW when the Type field is set to DOCUMENT and Amazon Kendra is not confident that the result matches the query.

Definition at line 421 of file QueryResultItem.h.

◆ SetType() [1/2]

void Aws::kendra::Model::QueryResultItem::SetType ( const QueryResultType value)
inline

The type of document.

Definition at line 103 of file QueryResultItem.h.

◆ SetType() [2/2]

void Aws::kendra::Model::QueryResultItem::SetType ( QueryResultType &&  value)
inline

The type of document.

Definition at line 108 of file QueryResultItem.h.

◆ TypeHasBeenSet()

bool Aws::kendra::Model::QueryResultItem::TypeHasBeenSet ( ) const
inline

The type of document.

Definition at line 98 of file QueryResultItem.h.

◆ WithAdditionalAttributes() [1/2]

QueryResultItem& Aws::kendra::Model::QueryResultItem::WithAdditionalAttributes ( Aws::Vector< AdditionalResultAttribute > &&  value)
inline

One or more additional attributes associated with the query result.

Definition at line 149 of file QueryResultItem.h.

◆ WithAdditionalAttributes() [2/2]

QueryResultItem& Aws::kendra::Model::QueryResultItem::WithAdditionalAttributes ( const Aws::Vector< AdditionalResultAttribute > &  value)
inline

One or more additional attributes associated with the query result.

Definition at line 144 of file QueryResultItem.h.

◆ WithDocumentAttributes() [1/2]

QueryResultItem& Aws::kendra::Model::QueryResultItem::WithDocumentAttributes ( Aws::Vector< DocumentAttribute > &&  value)
inline

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.

Definition at line 358 of file QueryResultItem.h.

◆ WithDocumentAttributes() [2/2]

QueryResultItem& Aws::kendra::Model::QueryResultItem::WithDocumentAttributes ( const Aws::Vector< DocumentAttribute > &  value)
inline

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.

Definition at line 351 of file QueryResultItem.h.

◆ WithDocumentExcerpt() [1/2]

QueryResultItem& Aws::kendra::Model::QueryResultItem::WithDocumentExcerpt ( const TextWithHighlights value)
inline

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

Definition at line 268 of file QueryResultItem.h.

◆ WithDocumentExcerpt() [2/2]

QueryResultItem& Aws::kendra::Model::QueryResultItem::WithDocumentExcerpt ( TextWithHighlights &&  value)
inline

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

Definition at line 274 of file QueryResultItem.h.

◆ WithDocumentId() [1/3]

QueryResultItem& Aws::kendra::Model::QueryResultItem::WithDocumentId ( Aws::String &&  value)
inline

The unique identifier for the document.

Definition at line 195 of file QueryResultItem.h.

◆ WithDocumentId() [2/3]

QueryResultItem& Aws::kendra::Model::QueryResultItem::WithDocumentId ( const Aws::String value)
inline

The unique identifier for the document.

Definition at line 190 of file QueryResultItem.h.

◆ WithDocumentId() [3/3]

QueryResultItem& Aws::kendra::Model::QueryResultItem::WithDocumentId ( const char *  value)
inline

The unique identifier for the document.

Definition at line 200 of file QueryResultItem.h.

◆ WithDocumentTitle() [1/2]

QueryResultItem& Aws::kendra::Model::QueryResultItem::WithDocumentTitle ( const TextWithHighlights value)
inline

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

Definition at line 231 of file QueryResultItem.h.

◆ WithDocumentTitle() [2/2]

QueryResultItem& Aws::kendra::Model::QueryResultItem::WithDocumentTitle ( TextWithHighlights &&  value)
inline

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

Definition at line 237 of file QueryResultItem.h.

◆ WithDocumentURI() [1/3]

QueryResultItem& Aws::kendra::Model::QueryResultItem::WithDocumentURI ( Aws::String &&  value)
inline

The URI of the original location of the document.

Definition at line 310 of file QueryResultItem.h.

◆ WithDocumentURI() [2/3]

QueryResultItem& Aws::kendra::Model::QueryResultItem::WithDocumentURI ( const Aws::String value)
inline

The URI of the original location of the document.

Definition at line 305 of file QueryResultItem.h.

◆ WithDocumentURI() [3/3]

QueryResultItem& Aws::kendra::Model::QueryResultItem::WithDocumentURI ( const char *  value)
inline

The URI of the original location of the document.

Definition at line 315 of file QueryResultItem.h.

◆ WithFeedbackToken() [1/3]

QueryResultItem& Aws::kendra::Model::QueryResultItem::WithFeedbackToken ( Aws::String &&  value)
inline

A token that identifies a particular result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback .

Definition at line 509 of file QueryResultItem.h.

◆ WithFeedbackToken() [2/3]

QueryResultItem& Aws::kendra::Model::QueryResultItem::WithFeedbackToken ( const Aws::String value)
inline

A token that identifies a particular result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback .

Definition at line 500 of file QueryResultItem.h.

◆ WithFeedbackToken() [3/3]

QueryResultItem& Aws::kendra::Model::QueryResultItem::WithFeedbackToken ( const char *  value)
inline

A token that identifies a particular result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback .

Definition at line 518 of file QueryResultItem.h.

◆ WithId() [1/3]

QueryResultItem& Aws::kendra::Model::QueryResultItem::WithId ( Aws::String &&  value)
inline

The unique identifier for the query result.

Definition at line 82 of file QueryResultItem.h.

◆ WithId() [2/3]

QueryResultItem& Aws::kendra::Model::QueryResultItem::WithId ( const Aws::String value)
inline

The unique identifier for the query result.

Definition at line 77 of file QueryResultItem.h.

◆ WithId() [3/3]

QueryResultItem& Aws::kendra::Model::QueryResultItem::WithId ( const char *  value)
inline

The unique identifier for the query result.

Definition at line 87 of file QueryResultItem.h.

◆ WithScoreAttributes() [1/2]

QueryResultItem& Aws::kendra::Model::QueryResultItem::WithScoreAttributes ( const ScoreAttributes value)
inline

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, MEDIUM and LOW. You can use the score to determine if a response meets the confidence needed for your application.

The field is only set to LOW when the Type field is set to DOCUMENT and Amazon Kendra is not confident that the result matches the query.

Definition at line 433 of file QueryResultItem.h.

◆ WithScoreAttributes() [2/2]

QueryResultItem& Aws::kendra::Model::QueryResultItem::WithScoreAttributes ( ScoreAttributes &&  value)
inline

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, MEDIUM and LOW. You can use the score to determine if a response meets the confidence needed for your application.

The field is only set to LOW when the Type field is set to DOCUMENT and Amazon Kendra is not confident that the result matches the query.

Definition at line 445 of file QueryResultItem.h.

◆ WithType() [1/2]

QueryResultItem& Aws::kendra::Model::QueryResultItem::WithType ( const QueryResultType value)
inline

The type of document.

Definition at line 113 of file QueryResultItem.h.

◆ WithType() [2/2]

QueryResultItem& Aws::kendra::Model::QueryResultItem::WithType ( QueryResultType &&  value)
inline

The type of document.

Definition at line 118 of file QueryResultItem.h.


The documentation for this class was generated from the following file: