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

#include <UpdateQuerySuggestionsConfigRequest.h>

+ Inheritance diagram for Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest:

Public Member Functions

 UpdateQuerySuggestionsConfigRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetIndexId () const
 
bool IndexIdHasBeenSet () const
 
void SetIndexId (const Aws::String &value)
 
void SetIndexId (Aws::String &&value)
 
void SetIndexId (const char *value)
 
UpdateQuerySuggestionsConfigRequestWithIndexId (const Aws::String &value)
 
UpdateQuerySuggestionsConfigRequestWithIndexId (Aws::String &&value)
 
UpdateQuerySuggestionsConfigRequestWithIndexId (const char *value)
 
const ModeGetMode () const
 
bool ModeHasBeenSet () const
 
void SetMode (const Mode &value)
 
void SetMode (Mode &&value)
 
UpdateQuerySuggestionsConfigRequestWithMode (const Mode &value)
 
UpdateQuerySuggestionsConfigRequestWithMode (Mode &&value)
 
int GetQueryLogLookBackWindowInDays () const
 
bool QueryLogLookBackWindowInDaysHasBeenSet () const
 
void SetQueryLogLookBackWindowInDays (int value)
 
UpdateQuerySuggestionsConfigRequestWithQueryLogLookBackWindowInDays (int value)
 
bool GetIncludeQueriesWithoutUserInformation () const
 
bool IncludeQueriesWithoutUserInformationHasBeenSet () const
 
void SetIncludeQueriesWithoutUserInformation (bool value)
 
UpdateQuerySuggestionsConfigRequestWithIncludeQueriesWithoutUserInformation (bool value)
 
int GetMinimumNumberOfQueryingUsers () const
 
bool MinimumNumberOfQueryingUsersHasBeenSet () const
 
void SetMinimumNumberOfQueryingUsers (int value)
 
UpdateQuerySuggestionsConfigRequestWithMinimumNumberOfQueryingUsers (int value)
 
int GetMinimumQueryCount () const
 
bool MinimumQueryCountHasBeenSet () const
 
void SetMinimumQueryCount (int value)
 
UpdateQuerySuggestionsConfigRequestWithMinimumQueryCount (int value)
 
- Public Member Functions inherited from Aws::kendra::KendraRequest
virtual ~KendraRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 22 of file UpdateQuerySuggestionsConfigRequest.h.

Constructor & Destructor Documentation

◆ UpdateQuerySuggestionsConfigRequest()

Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::UpdateQuerySuggestionsConfigRequest ( )

Member Function Documentation

◆ GetIncludeQueriesWithoutUserInformation()

bool Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::GetIncludeQueriesWithoutUserInformation ( ) const
inline

TRUE to include queries without user information (i.e. all queries, irrespective of the user), otherwise FALSE to only include queries with user information.

If you pass user information to Amazon Kendra along with the queries, you can set this flag to FALSE and instruct Amazon Kendra to only consider queries with user information.

If you set to FALSE, Amazon Kendra only considers queries searched at least MinimumQueryCount times across MinimumNumberOfQueryingUsers unique users for suggestions.

If you set to TRUE, Amazon Kendra ignores all user information and learns from all queries.

Definition at line 189 of file UpdateQuerySuggestionsConfigRequest.h.

◆ GetIndexId()

const Aws::String& Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::GetIndexId ( ) const
inline

The identifier of the index you want to update query suggestions settings for.

Definition at line 42 of file UpdateQuerySuggestionsConfigRequest.h.

◆ GetMinimumNumberOfQueryingUsers()

int Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::GetMinimumNumberOfQueryingUsers ( ) const
inline

The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.

Increasing this number might decrease the number of suggestions. However, this ensures a query is searched by many users and is truly popular to suggest to users.

How you tune this setting depends on your specific needs.

Definition at line 241 of file UpdateQuerySuggestionsConfigRequest.h.

◆ GetMinimumQueryCount()

int Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::GetMinimumQueryCount ( ) const
inline

The the minimum number of times a query must be searched in order to be eligible to suggest to your users.

Decreasing this number increases the number of suggestions. However, this affects the quality of suggestions as it sets a low bar for a query to be considered popular to suggest to users.

How you tune this setting depends on your specific needs.

Definition at line 278 of file UpdateQuerySuggestionsConfigRequest.h.

◆ GetMode()

const Mode& Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::GetMode ( ) const
inline

Set the mode to ENABLED or LEARN_ONLY.

By default, Amazon Kendra enables query suggestions. LEARN_ONLY mode allows you to turn off query suggestions. You can to update this at any time.

In LEARN_ONLY mode, Amazon Kendra continues to learn from new queries to keep suggestions up to date for when you are ready to switch to ENABLED mode again.

Definition at line 95 of file UpdateQuerySuggestionsConfigRequest.h.

◆ GetQueryLogLookBackWindowInDays()

int Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::GetQueryLogLookBackWindowInDays ( ) const
inline

How recent your queries are in your query log time window.

The time window is the number of days from current day to past days.

By default, Amazon Kendra sets this to 180.

Definition at line 153 of file UpdateQuerySuggestionsConfigRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::kendra::KendraRequest.

◆ GetServiceRequestName()

virtual const char* Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

◆ IncludeQueriesWithoutUserInformationHasBeenSet()

bool Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::IncludeQueriesWithoutUserInformationHasBeenSet ( ) const
inline

TRUE to include queries without user information (i.e. all queries, irrespective of the user), otherwise FALSE to only include queries with user information.

If you pass user information to Amazon Kendra along with the queries, you can set this flag to FALSE and instruct Amazon Kendra to only consider queries with user information.

If you set to FALSE, Amazon Kendra only considers queries searched at least MinimumQueryCount times across MinimumNumberOfQueryingUsers unique users for suggestions.

If you set to TRUE, Amazon Kendra ignores all user information and learns from all queries.

Definition at line 203 of file UpdateQuerySuggestionsConfigRequest.h.

◆ IndexIdHasBeenSet()

bool Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::IndexIdHasBeenSet ( ) const
inline

The identifier of the index you want to update query suggestions settings for.

Definition at line 48 of file UpdateQuerySuggestionsConfigRequest.h.

◆ MinimumNumberOfQueryingUsersHasBeenSet()

bool Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::MinimumNumberOfQueryingUsersHasBeenSet ( ) const
inline

The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.

Increasing this number might decrease the number of suggestions. However, this ensures a query is searched by many users and is truly popular to suggest to users.

How you tune this setting depends on your specific needs.

Definition at line 250 of file UpdateQuerySuggestionsConfigRequest.h.

◆ MinimumQueryCountHasBeenSet()

bool Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::MinimumQueryCountHasBeenSet ( ) const
inline

The the minimum number of times a query must be searched in order to be eligible to suggest to your users.

Decreasing this number increases the number of suggestions. However, this affects the quality of suggestions as it sets a low bar for a query to be considered popular to suggest to users.

How you tune this setting depends on your specific needs.

Definition at line 287 of file UpdateQuerySuggestionsConfigRequest.h.

◆ ModeHasBeenSet()

bool Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::ModeHasBeenSet ( ) const
inline

Set the mode to ENABLED or LEARN_ONLY.

By default, Amazon Kendra enables query suggestions. LEARN_ONLY mode allows you to turn off query suggestions. You can to update this at any time.

In LEARN_ONLY mode, Amazon Kendra continues to learn from new queries to keep suggestions up to date for when you are ready to switch to ENABLED mode again.

Definition at line 105 of file UpdateQuerySuggestionsConfigRequest.h.

◆ QueryLogLookBackWindowInDaysHasBeenSet()

bool Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::QueryLogLookBackWindowInDaysHasBeenSet ( ) const
inline

How recent your queries are in your query log time window.

The time window is the number of days from current day to past days.

By default, Amazon Kendra sets this to 180.

Definition at line 160 of file UpdateQuerySuggestionsConfigRequest.h.

◆ SerializePayload()

Aws::String Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetIncludeQueriesWithoutUserInformation()

void Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::SetIncludeQueriesWithoutUserInformation ( bool  value)
inline

TRUE to include queries without user information (i.e. all queries, irrespective of the user), otherwise FALSE to only include queries with user information.

If you pass user information to Amazon Kendra along with the queries, you can set this flag to FALSE and instruct Amazon Kendra to only consider queries with user information.

If you set to FALSE, Amazon Kendra only considers queries searched at least MinimumQueryCount times across MinimumNumberOfQueryingUsers unique users for suggestions.

If you set to TRUE, Amazon Kendra ignores all user information and learns from all queries.

Definition at line 217 of file UpdateQuerySuggestionsConfigRequest.h.

◆ SetIndexId() [1/3]

void Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::SetIndexId ( Aws::String &&  value)
inline

The identifier of the index you want to update query suggestions settings for.

Definition at line 60 of file UpdateQuerySuggestionsConfigRequest.h.

◆ SetIndexId() [2/3]

void Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::SetIndexId ( const Aws::String value)
inline

The identifier of the index you want to update query suggestions settings for.

Definition at line 54 of file UpdateQuerySuggestionsConfigRequest.h.

◆ SetIndexId() [3/3]

void Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::SetIndexId ( const char *  value)
inline

The identifier of the index you want to update query suggestions settings for.

Definition at line 66 of file UpdateQuerySuggestionsConfigRequest.h.

◆ SetMinimumNumberOfQueryingUsers()

void Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::SetMinimumNumberOfQueryingUsers ( int  value)
inline

The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.

Increasing this number might decrease the number of suggestions. However, this ensures a query is searched by many users and is truly popular to suggest to users.

How you tune this setting depends on your specific needs.

Definition at line 259 of file UpdateQuerySuggestionsConfigRequest.h.

◆ SetMinimumQueryCount()

void Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::SetMinimumQueryCount ( int  value)
inline

The the minimum number of times a query must be searched in order to be eligible to suggest to your users.

Decreasing this number increases the number of suggestions. However, this affects the quality of suggestions as it sets a low bar for a query to be considered popular to suggest to users.

How you tune this setting depends on your specific needs.

Definition at line 296 of file UpdateQuerySuggestionsConfigRequest.h.

◆ SetMode() [1/2]

void Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::SetMode ( const Mode value)
inline

Set the mode to ENABLED or LEARN_ONLY.

By default, Amazon Kendra enables query suggestions. LEARN_ONLY mode allows you to turn off query suggestions. You can to update this at any time.

In LEARN_ONLY mode, Amazon Kendra continues to learn from new queries to keep suggestions up to date for when you are ready to switch to ENABLED mode again.

Definition at line 115 of file UpdateQuerySuggestionsConfigRequest.h.

◆ SetMode() [2/2]

void Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::SetMode ( Mode &&  value)
inline

Set the mode to ENABLED or LEARN_ONLY.

By default, Amazon Kendra enables query suggestions. LEARN_ONLY mode allows you to turn off query suggestions. You can to update this at any time.

In LEARN_ONLY mode, Amazon Kendra continues to learn from new queries to keep suggestions up to date for when you are ready to switch to ENABLED mode again.

Definition at line 125 of file UpdateQuerySuggestionsConfigRequest.h.

◆ SetQueryLogLookBackWindowInDays()

void Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::SetQueryLogLookBackWindowInDays ( int  value)
inline

How recent your queries are in your query log time window.

The time window is the number of days from current day to past days.

By default, Amazon Kendra sets this to 180.

Definition at line 167 of file UpdateQuerySuggestionsConfigRequest.h.

◆ WithIncludeQueriesWithoutUserInformation()

UpdateQuerySuggestionsConfigRequest& Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::WithIncludeQueriesWithoutUserInformation ( bool  value)
inline

TRUE to include queries without user information (i.e. all queries, irrespective of the user), otherwise FALSE to only include queries with user information.

If you pass user information to Amazon Kendra along with the queries, you can set this flag to FALSE and instruct Amazon Kendra to only consider queries with user information.

If you set to FALSE, Amazon Kendra only considers queries searched at least MinimumQueryCount times across MinimumNumberOfQueryingUsers unique users for suggestions.

If you set to TRUE, Amazon Kendra ignores all user information and learns from all queries.

Definition at line 231 of file UpdateQuerySuggestionsConfigRequest.h.

◆ WithIndexId() [1/3]

UpdateQuerySuggestionsConfigRequest& Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::WithIndexId ( Aws::String &&  value)
inline

The identifier of the index you want to update query suggestions settings for.

Definition at line 78 of file UpdateQuerySuggestionsConfigRequest.h.

◆ WithIndexId() [2/3]

UpdateQuerySuggestionsConfigRequest& Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::WithIndexId ( const Aws::String value)
inline

The identifier of the index you want to update query suggestions settings for.

Definition at line 72 of file UpdateQuerySuggestionsConfigRequest.h.

◆ WithIndexId() [3/3]

UpdateQuerySuggestionsConfigRequest& Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::WithIndexId ( const char *  value)
inline

The identifier of the index you want to update query suggestions settings for.

Definition at line 84 of file UpdateQuerySuggestionsConfigRequest.h.

◆ WithMinimumNumberOfQueryingUsers()

UpdateQuerySuggestionsConfigRequest& Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::WithMinimumNumberOfQueryingUsers ( int  value)
inline

The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.

Increasing this number might decrease the number of suggestions. However, this ensures a query is searched by many users and is truly popular to suggest to users.

How you tune this setting depends on your specific needs.

Definition at line 268 of file UpdateQuerySuggestionsConfigRequest.h.

◆ WithMinimumQueryCount()

UpdateQuerySuggestionsConfigRequest& Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::WithMinimumQueryCount ( int  value)
inline

The the minimum number of times a query must be searched in order to be eligible to suggest to your users.

Decreasing this number increases the number of suggestions. However, this affects the quality of suggestions as it sets a low bar for a query to be considered popular to suggest to users.

How you tune this setting depends on your specific needs.

Definition at line 305 of file UpdateQuerySuggestionsConfigRequest.h.

◆ WithMode() [1/2]

UpdateQuerySuggestionsConfigRequest& Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::WithMode ( const Mode value)
inline

Set the mode to ENABLED or LEARN_ONLY.

By default, Amazon Kendra enables query suggestions. LEARN_ONLY mode allows you to turn off query suggestions. You can to update this at any time.

In LEARN_ONLY mode, Amazon Kendra continues to learn from new queries to keep suggestions up to date for when you are ready to switch to ENABLED mode again.

Definition at line 135 of file UpdateQuerySuggestionsConfigRequest.h.

◆ WithMode() [2/2]

UpdateQuerySuggestionsConfigRequest& Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::WithMode ( Mode &&  value)
inline

Set the mode to ENABLED or LEARN_ONLY.

By default, Amazon Kendra enables query suggestions. LEARN_ONLY mode allows you to turn off query suggestions. You can to update this at any time.

In LEARN_ONLY mode, Amazon Kendra continues to learn from new queries to keep suggestions up to date for when you are ready to switch to ENABLED mode again.

Definition at line 145 of file UpdateQuerySuggestionsConfigRequest.h.

◆ WithQueryLogLookBackWindowInDays()

UpdateQuerySuggestionsConfigRequest& Aws::kendra::Model::UpdateQuerySuggestionsConfigRequest::WithQueryLogLookBackWindowInDays ( int  value)
inline

How recent your queries are in your query log time window.

The time window is the number of days from current day to past days.

By default, Amazon Kendra sets this to 180.

Definition at line 174 of file UpdateQuerySuggestionsConfigRequest.h.


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