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

#include <QueryRequest.h>

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

Public Member Functions

 QueryRequest ()
 
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)
 
QueryRequestWithIndexId (const Aws::String &value)
 
QueryRequestWithIndexId (Aws::String &&value)
 
QueryRequestWithIndexId (const char *value)
 
const Aws::StringGetQueryText () const
 
bool QueryTextHasBeenSet () const
 
void SetQueryText (const Aws::String &value)
 
void SetQueryText (Aws::String &&value)
 
void SetQueryText (const char *value)
 
QueryRequestWithQueryText (const Aws::String &value)
 
QueryRequestWithQueryText (Aws::String &&value)
 
QueryRequestWithQueryText (const char *value)
 
const AttributeFilterGetAttributeFilter () const
 
bool AttributeFilterHasBeenSet () const
 
void SetAttributeFilter (const AttributeFilter &value)
 
void SetAttributeFilter (AttributeFilter &&value)
 
QueryRequestWithAttributeFilter (const AttributeFilter &value)
 
QueryRequestWithAttributeFilter (AttributeFilter &&value)
 
const Aws::Vector< Facet > & GetFacets () const
 
bool FacetsHasBeenSet () const
 
void SetFacets (const Aws::Vector< Facet > &value)
 
void SetFacets (Aws::Vector< Facet > &&value)
 
QueryRequestWithFacets (const Aws::Vector< Facet > &value)
 
QueryRequestWithFacets (Aws::Vector< Facet > &&value)
 
QueryRequestAddFacets (const Facet &value)
 
QueryRequestAddFacets (Facet &&value)
 
const Aws::Vector< Aws::String > & GetRequestedDocumentAttributes () const
 
bool RequestedDocumentAttributesHasBeenSet () const
 
void SetRequestedDocumentAttributes (const Aws::Vector< Aws::String > &value)
 
void SetRequestedDocumentAttributes (Aws::Vector< Aws::String > &&value)
 
QueryRequestWithRequestedDocumentAttributes (const Aws::Vector< Aws::String > &value)
 
QueryRequestWithRequestedDocumentAttributes (Aws::Vector< Aws::String > &&value)
 
QueryRequestAddRequestedDocumentAttributes (const Aws::String &value)
 
QueryRequestAddRequestedDocumentAttributes (Aws::String &&value)
 
QueryRequestAddRequestedDocumentAttributes (const char *value)
 
const QueryResultTypeGetQueryResultTypeFilter () const
 
bool QueryResultTypeFilterHasBeenSet () const
 
void SetQueryResultTypeFilter (const QueryResultType &value)
 
void SetQueryResultTypeFilter (QueryResultType &&value)
 
QueryRequestWithQueryResultTypeFilter (const QueryResultType &value)
 
QueryRequestWithQueryResultTypeFilter (QueryResultType &&value)
 
const Aws::Vector< DocumentRelevanceConfiguration > & GetDocumentRelevanceOverrideConfigurations () const
 
bool DocumentRelevanceOverrideConfigurationsHasBeenSet () const
 
void SetDocumentRelevanceOverrideConfigurations (const Aws::Vector< DocumentRelevanceConfiguration > &value)
 
void SetDocumentRelevanceOverrideConfigurations (Aws::Vector< DocumentRelevanceConfiguration > &&value)
 
QueryRequestWithDocumentRelevanceOverrideConfigurations (const Aws::Vector< DocumentRelevanceConfiguration > &value)
 
QueryRequestWithDocumentRelevanceOverrideConfigurations (Aws::Vector< DocumentRelevanceConfiguration > &&value)
 
QueryRequestAddDocumentRelevanceOverrideConfigurations (const DocumentRelevanceConfiguration &value)
 
QueryRequestAddDocumentRelevanceOverrideConfigurations (DocumentRelevanceConfiguration &&value)
 
int GetPageNumber () const
 
bool PageNumberHasBeenSet () const
 
void SetPageNumber (int value)
 
QueryRequestWithPageNumber (int value)
 
int GetPageSize () const
 
bool PageSizeHasBeenSet () const
 
void SetPageSize (int value)
 
QueryRequestWithPageSize (int value)
 
const SortingConfigurationGetSortingConfiguration () const
 
bool SortingConfigurationHasBeenSet () const
 
void SetSortingConfiguration (const SortingConfiguration &value)
 
void SetSortingConfiguration (SortingConfiguration &&value)
 
QueryRequestWithSortingConfiguration (const SortingConfiguration &value)
 
QueryRequestWithSortingConfiguration (SortingConfiguration &&value)
 
const UserContextGetUserContext () const
 
bool UserContextHasBeenSet () const
 
void SetUserContext (const UserContext &value)
 
void SetUserContext (UserContext &&value)
 
QueryRequestWithUserContext (const UserContext &value)
 
QueryRequestWithUserContext (UserContext &&value)
 
const Aws::StringGetVisitorId () const
 
bool VisitorIdHasBeenSet () const
 
void SetVisitorId (const Aws::String &value)
 
void SetVisitorId (Aws::String &&value)
 
void SetVisitorId (const char *value)
 
QueryRequestWithVisitorId (const Aws::String &value)
 
QueryRequestWithVisitorId (Aws::String &&value)
 
QueryRequestWithVisitorId (const char *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 28 of file QueryRequest.h.

Constructor & Destructor Documentation

◆ QueryRequest()

Aws::kendra::Model::QueryRequest::QueryRequest ( )

Member Function Documentation

◆ AddDocumentRelevanceOverrideConfigurations() [1/2]

QueryRequest& Aws::kendra::Model::QueryRequest::AddDocumentRelevanceOverrideConfigurations ( const DocumentRelevanceConfiguration value)
inline

Overrides relevance tuning configurations of fields or attributes set at the index level.

If you use this API to override the relevance tuning configured at the index level, but there is no relevance tuning configured at the index level, then Amazon Kendra does not apply any relevance tuning.

If there is relevance tuning configured at the index level, but you do not use this API to override any relevance tuning in the index, then Amazon Kendra uses the relevance tuning that is configured at the index level.

If there is relevance tuning configured for fields at the index level, but you use this API to override only some of these fields, then for the fields you did not override, the importance is set to 1.

Definition at line 449 of file QueryRequest.h.

◆ AddDocumentRelevanceOverrideConfigurations() [2/2]

QueryRequest& Aws::kendra::Model::QueryRequest::AddDocumentRelevanceOverrideConfigurations ( DocumentRelevanceConfiguration &&  value)
inline

Overrides relevance tuning configurations of fields or attributes set at the index level.

If you use this API to override the relevance tuning configured at the index level, but there is no relevance tuning configured at the index level, then Amazon Kendra does not apply any relevance tuning.

If there is relevance tuning configured at the index level, but you do not use this API to override any relevance tuning in the index, then Amazon Kendra uses the relevance tuning that is configured at the index level.

If there is relevance tuning configured for fields at the index level, but you use this API to override only some of these fields, then for the fields you did not override, the importance is set to 1.

Definition at line 463 of file QueryRequest.h.

◆ AddFacets() [1/2]

QueryRequest& Aws::kendra::Model::QueryRequest::AddFacets ( const Facet value)
inline

An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.

Definition at line 242 of file QueryRequest.h.

◆ AddFacets() [2/2]

QueryRequest& Aws::kendra::Model::QueryRequest::AddFacets ( Facet &&  value)
inline

An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.

Definition at line 249 of file QueryRequest.h.

◆ AddRequestedDocumentAttributes() [1/3]

QueryRequest& Aws::kendra::Model::QueryRequest::AddRequestedDocumentAttributes ( Aws::String &&  value)
inline

An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.

Definition at line 306 of file QueryRequest.h.

◆ AddRequestedDocumentAttributes() [2/3]

QueryRequest& Aws::kendra::Model::QueryRequest::AddRequestedDocumentAttributes ( const Aws::String value)
inline

An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.

Definition at line 299 of file QueryRequest.h.

◆ AddRequestedDocumentAttributes() [3/3]

QueryRequest& Aws::kendra::Model::QueryRequest::AddRequestedDocumentAttributes ( const char *  value)
inline

An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.

Definition at line 313 of file QueryRequest.h.

◆ AttributeFilterHasBeenSet()

bool Aws::kendra::Model::QueryRequest::AttributeFilterHasBeenSet ( ) const
inline

Enables filtered searches based on document attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.

The AttributeFilter parameter enables you to create a set of filtering rules that a document must satisfy to be included in the query results.

Definition at line 152 of file QueryRequest.h.

◆ DocumentRelevanceOverrideConfigurationsHasBeenSet()

bool Aws::kendra::Model::QueryRequest::DocumentRelevanceOverrideConfigurationsHasBeenSet ( ) const
inline

Overrides relevance tuning configurations of fields or attributes set at the index level.

If you use this API to override the relevance tuning configured at the index level, but there is no relevance tuning configured at the index level, then Amazon Kendra does not apply any relevance tuning.

If there is relevance tuning configured at the index level, but you do not use this API to override any relevance tuning in the index, then Amazon Kendra uses the relevance tuning that is configured at the index level.

If there is relevance tuning configured for fields at the index level, but you use this API to override only some of these fields, then for the fields you did not override, the importance is set to 1.

Definition at line 379 of file QueryRequest.h.

◆ FacetsHasBeenSet()

bool Aws::kendra::Model::QueryRequest::FacetsHasBeenSet ( ) const
inline

An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.

Definition at line 207 of file QueryRequest.h.

◆ GetAttributeFilter()

const AttributeFilter& Aws::kendra::Model::QueryRequest::GetAttributeFilter ( ) const
inline

Enables filtered searches based on document attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.

The AttributeFilter parameter enables you to create a set of filtering rules that a document must satisfy to be included in the query results.

Definition at line 142 of file QueryRequest.h.

◆ GetDocumentRelevanceOverrideConfigurations()

const Aws::Vector<DocumentRelevanceConfiguration>& Aws::kendra::Model::QueryRequest::GetDocumentRelevanceOverrideConfigurations ( ) const
inline

Overrides relevance tuning configurations of fields or attributes set at the index level.

If you use this API to override the relevance tuning configured at the index level, but there is no relevance tuning configured at the index level, then Amazon Kendra does not apply any relevance tuning.

If there is relevance tuning configured at the index level, but you do not use this API to override any relevance tuning in the index, then Amazon Kendra uses the relevance tuning that is configured at the index level.

If there is relevance tuning configured for fields at the index level, but you use this API to override only some of these fields, then for the fields you did not override, the importance is set to 1.

Definition at line 365 of file QueryRequest.h.

◆ GetFacets()

const Aws::Vector<Facet>& Aws::kendra::Model::QueryRequest::GetFacets ( ) const
inline

An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.

Definition at line 200 of file QueryRequest.h.

◆ GetIndexId()

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

The unique identifier of the index to search. The identifier is returned in the response from the CreateIndex operation.

Definition at line 48 of file QueryRequest.h.

◆ GetPageNumber()

int Aws::kendra::Model::QueryRequest::GetPageNumber ( ) const
inline

Query results are returned in pages the size of the PageSize parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.

Definition at line 471 of file QueryRequest.h.

◆ GetPageSize()

int Aws::kendra::Model::QueryRequest::GetPageSize ( ) const
inline

Sets the number of results that are returned in each page of results. The default page size is 10. The maximum number of results returned is 100. If you ask for more than 100 results, only 100 are returned.

Definition at line 500 of file QueryRequest.h.

◆ GetQueryResultTypeFilter()

const QueryResultType& Aws::kendra::Model::QueryRequest::GetQueryResultTypeFilter ( ) const
inline

Sets the type of query. Only results for the specified query type are returned.

Definition at line 320 of file QueryRequest.h.

◆ GetQueryText()

const Aws::String& Aws::kendra::Model::QueryRequest::GetQueryText ( ) const
inline

The text to search for.

Definition at line 96 of file QueryRequest.h.

◆ GetRequestedDocumentAttributes()

const Aws::Vector<Aws::String>& Aws::kendra::Model::QueryRequest::GetRequestedDocumentAttributes ( ) const
inline

An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.

Definition at line 257 of file QueryRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::kendra::KendraRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file QueryRequest.h.

◆ GetSortingConfiguration()

const SortingConfiguration& Aws::kendra::Model::QueryRequest::GetSortingConfiguration ( ) const
inline

Provides information that determines how the results of the query are sorted. You can set the field that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. In the case of ties in sorting the results, the results are sorted by relevance.

If you don't provide sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result.

Definition at line 532 of file QueryRequest.h.

◆ GetUserContext()

const UserContext& Aws::kendra::Model::QueryRequest::GetUserContext ( ) const
inline

The user context token or user and group information.

Definition at line 588 of file QueryRequest.h.

◆ GetVisitorId()

const Aws::String& Aws::kendra::Model::QueryRequest::GetVisitorId ( ) const
inline

Provides an identifier for a specific user. The VisitorId should be a unique identifier, such as a GUID. Don't use personally identifiable information, such as the user's email address, as the VisitorId.

Definition at line 622 of file QueryRequest.h.

◆ IndexIdHasBeenSet()

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

The unique identifier of the index to search. The identifier is returned in the response from the CreateIndex operation.

Definition at line 54 of file QueryRequest.h.

◆ PageNumberHasBeenSet()

bool Aws::kendra::Model::QueryRequest::PageNumberHasBeenSet ( ) const
inline

Query results are returned in pages the size of the PageSize parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.

Definition at line 478 of file QueryRequest.h.

◆ PageSizeHasBeenSet()

bool Aws::kendra::Model::QueryRequest::PageSizeHasBeenSet ( ) const
inline

Sets the number of results that are returned in each page of results. The default page size is 10. The maximum number of results returned is 100. If you ask for more than 100 results, only 100 are returned.

Definition at line 507 of file QueryRequest.h.

◆ QueryResultTypeFilterHasBeenSet()

bool Aws::kendra::Model::QueryRequest::QueryResultTypeFilterHasBeenSet ( ) const
inline

Sets the type of query. Only results for the specified query type are returned.

Definition at line 326 of file QueryRequest.h.

◆ QueryTextHasBeenSet()

bool Aws::kendra::Model::QueryRequest::QueryTextHasBeenSet ( ) const
inline

The text to search for.

Definition at line 101 of file QueryRequest.h.

◆ RequestedDocumentAttributesHasBeenSet()

bool Aws::kendra::Model::QueryRequest::RequestedDocumentAttributesHasBeenSet ( ) const
inline

An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.

Definition at line 264 of file QueryRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAttributeFilter() [1/2]

void Aws::kendra::Model::QueryRequest::SetAttributeFilter ( AttributeFilter &&  value)
inline

Enables filtered searches based on document attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.

The AttributeFilter parameter enables you to create a set of filtering rules that a document must satisfy to be included in the query results.

Definition at line 172 of file QueryRequest.h.

◆ SetAttributeFilter() [2/2]

void Aws::kendra::Model::QueryRequest::SetAttributeFilter ( const AttributeFilter value)
inline

Enables filtered searches based on document attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.

The AttributeFilter parameter enables you to create a set of filtering rules that a document must satisfy to be included in the query results.

Definition at line 162 of file QueryRequest.h.

◆ SetDocumentRelevanceOverrideConfigurations() [1/2]

void Aws::kendra::Model::QueryRequest::SetDocumentRelevanceOverrideConfigurations ( Aws::Vector< DocumentRelevanceConfiguration > &&  value)
inline

Overrides relevance tuning configurations of fields or attributes set at the index level.

If you use this API to override the relevance tuning configured at the index level, but there is no relevance tuning configured at the index level, then Amazon Kendra does not apply any relevance tuning.

If there is relevance tuning configured at the index level, but you do not use this API to override any relevance tuning in the index, then Amazon Kendra uses the relevance tuning that is configured at the index level.

If there is relevance tuning configured for fields at the index level, but you use this API to override only some of these fields, then for the fields you did not override, the importance is set to 1.

Definition at line 407 of file QueryRequest.h.

◆ SetDocumentRelevanceOverrideConfigurations() [2/2]

void Aws::kendra::Model::QueryRequest::SetDocumentRelevanceOverrideConfigurations ( const Aws::Vector< DocumentRelevanceConfiguration > &  value)
inline

Overrides relevance tuning configurations of fields or attributes set at the index level.

If you use this API to override the relevance tuning configured at the index level, but there is no relevance tuning configured at the index level, then Amazon Kendra does not apply any relevance tuning.

If there is relevance tuning configured at the index level, but you do not use this API to override any relevance tuning in the index, then Amazon Kendra uses the relevance tuning that is configured at the index level.

If there is relevance tuning configured for fields at the index level, but you use this API to override only some of these fields, then for the fields you did not override, the importance is set to 1.

Definition at line 393 of file QueryRequest.h.

◆ SetFacets() [1/2]

void Aws::kendra::Model::QueryRequest::SetFacets ( Aws::Vector< Facet > &&  value)
inline

An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.

Definition at line 221 of file QueryRequest.h.

◆ SetFacets() [2/2]

void Aws::kendra::Model::QueryRequest::SetFacets ( const Aws::Vector< Facet > &  value)
inline

An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.

Definition at line 214 of file QueryRequest.h.

◆ SetIndexId() [1/3]

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

The unique identifier of the index to search. The identifier is returned in the response from the CreateIndex operation.

Definition at line 66 of file QueryRequest.h.

◆ SetIndexId() [2/3]

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

The unique identifier of the index to search. The identifier is returned in the response from the CreateIndex operation.

Definition at line 60 of file QueryRequest.h.

◆ SetIndexId() [3/3]

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

The unique identifier of the index to search. The identifier is returned in the response from the CreateIndex operation.

Definition at line 72 of file QueryRequest.h.

◆ SetPageNumber()

void Aws::kendra::Model::QueryRequest::SetPageNumber ( int  value)
inline

Query results are returned in pages the size of the PageSize parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.

Definition at line 485 of file QueryRequest.h.

◆ SetPageSize()

void Aws::kendra::Model::QueryRequest::SetPageSize ( int  value)
inline

Sets the number of results that are returned in each page of results. The default page size is 10. The maximum number of results returned is 100. If you ask for more than 100 results, only 100 are returned.

Definition at line 514 of file QueryRequest.h.

◆ SetQueryResultTypeFilter() [1/2]

void Aws::kendra::Model::QueryRequest::SetQueryResultTypeFilter ( const QueryResultType value)
inline

Sets the type of query. Only results for the specified query type are returned.

Definition at line 332 of file QueryRequest.h.

◆ SetQueryResultTypeFilter() [2/2]

void Aws::kendra::Model::QueryRequest::SetQueryResultTypeFilter ( QueryResultType &&  value)
inline

Sets the type of query. Only results for the specified query type are returned.

Definition at line 338 of file QueryRequest.h.

◆ SetQueryText() [1/3]

void Aws::kendra::Model::QueryRequest::SetQueryText ( Aws::String &&  value)
inline

The text to search for.

Definition at line 111 of file QueryRequest.h.

◆ SetQueryText() [2/3]

void Aws::kendra::Model::QueryRequest::SetQueryText ( const Aws::String value)
inline

The text to search for.

Definition at line 106 of file QueryRequest.h.

◆ SetQueryText() [3/3]

void Aws::kendra::Model::QueryRequest::SetQueryText ( const char *  value)
inline

The text to search for.

Definition at line 116 of file QueryRequest.h.

◆ SetRequestedDocumentAttributes() [1/2]

void Aws::kendra::Model::QueryRequest::SetRequestedDocumentAttributes ( Aws::Vector< Aws::String > &&  value)
inline

An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.

Definition at line 278 of file QueryRequest.h.

◆ SetRequestedDocumentAttributes() [2/2]

void Aws::kendra::Model::QueryRequest::SetRequestedDocumentAttributes ( const Aws::Vector< Aws::String > &  value)
inline

An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.

Definition at line 271 of file QueryRequest.h.

◆ SetSortingConfiguration() [1/2]

void Aws::kendra::Model::QueryRequest::SetSortingConfiguration ( const SortingConfiguration value)
inline

Provides information that determines how the results of the query are sorted. You can set the field that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. In the case of ties in sorting the results, the results are sorted by relevance.

If you don't provide sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result.

Definition at line 552 of file QueryRequest.h.

◆ SetSortingConfiguration() [2/2]

void Aws::kendra::Model::QueryRequest::SetSortingConfiguration ( SortingConfiguration &&  value)
inline

Provides information that determines how the results of the query are sorted. You can set the field that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. In the case of ties in sorting the results, the results are sorted by relevance.

If you don't provide sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result.

Definition at line 562 of file QueryRequest.h.

◆ SetUserContext() [1/2]

void Aws::kendra::Model::QueryRequest::SetUserContext ( const UserContext value)
inline

The user context token or user and group information.

Definition at line 598 of file QueryRequest.h.

◆ SetUserContext() [2/2]

void Aws::kendra::Model::QueryRequest::SetUserContext ( UserContext &&  value)
inline

The user context token or user and group information.

Definition at line 603 of file QueryRequest.h.

◆ SetVisitorId() [1/3]

void Aws::kendra::Model::QueryRequest::SetVisitorId ( Aws::String &&  value)
inline

Provides an identifier for a specific user. The VisitorId should be a unique identifier, such as a GUID. Don't use personally identifiable information, such as the user's email address, as the VisitorId.

Definition at line 646 of file QueryRequest.h.

◆ SetVisitorId() [2/3]

void Aws::kendra::Model::QueryRequest::SetVisitorId ( const Aws::String value)
inline

Provides an identifier for a specific user. The VisitorId should be a unique identifier, such as a GUID. Don't use personally identifiable information, such as the user's email address, as the VisitorId.

Definition at line 638 of file QueryRequest.h.

◆ SetVisitorId() [3/3]

void Aws::kendra::Model::QueryRequest::SetVisitorId ( const char *  value)
inline

Provides an identifier for a specific user. The VisitorId should be a unique identifier, such as a GUID. Don't use personally identifiable information, such as the user's email address, as the VisitorId.

Definition at line 654 of file QueryRequest.h.

◆ SortingConfigurationHasBeenSet()

bool Aws::kendra::Model::QueryRequest::SortingConfigurationHasBeenSet ( ) const
inline

Provides information that determines how the results of the query are sorted. You can set the field that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. In the case of ties in sorting the results, the results are sorted by relevance.

If you don't provide sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result.

Definition at line 542 of file QueryRequest.h.

◆ UserContextHasBeenSet()

bool Aws::kendra::Model::QueryRequest::UserContextHasBeenSet ( ) const
inline

The user context token or user and group information.

Definition at line 593 of file QueryRequest.h.

◆ VisitorIdHasBeenSet()

bool Aws::kendra::Model::QueryRequest::VisitorIdHasBeenSet ( ) const
inline

Provides an identifier for a specific user. The VisitorId should be a unique identifier, such as a GUID. Don't use personally identifiable information, such as the user's email address, as the VisitorId.

Definition at line 630 of file QueryRequest.h.

◆ WithAttributeFilter() [1/2]

QueryRequest& Aws::kendra::Model::QueryRequest::WithAttributeFilter ( AttributeFilter &&  value)
inline

Enables filtered searches based on document attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.

The AttributeFilter parameter enables you to create a set of filtering rules that a document must satisfy to be included in the query results.

Definition at line 192 of file QueryRequest.h.

◆ WithAttributeFilter() [2/2]

QueryRequest& Aws::kendra::Model::QueryRequest::WithAttributeFilter ( const AttributeFilter value)
inline

Enables filtered searches based on document attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.

The AttributeFilter parameter enables you to create a set of filtering rules that a document must satisfy to be included in the query results.

Definition at line 182 of file QueryRequest.h.

◆ WithDocumentRelevanceOverrideConfigurations() [1/2]

QueryRequest& Aws::kendra::Model::QueryRequest::WithDocumentRelevanceOverrideConfigurations ( Aws::Vector< DocumentRelevanceConfiguration > &&  value)
inline

Overrides relevance tuning configurations of fields or attributes set at the index level.

If you use this API to override the relevance tuning configured at the index level, but there is no relevance tuning configured at the index level, then Amazon Kendra does not apply any relevance tuning.

If there is relevance tuning configured at the index level, but you do not use this API to override any relevance tuning in the index, then Amazon Kendra uses the relevance tuning that is configured at the index level.

If there is relevance tuning configured for fields at the index level, but you use this API to override only some of these fields, then for the fields you did not override, the importance is set to 1.

Definition at line 435 of file QueryRequest.h.

◆ WithDocumentRelevanceOverrideConfigurations() [2/2]

QueryRequest& Aws::kendra::Model::QueryRequest::WithDocumentRelevanceOverrideConfigurations ( const Aws::Vector< DocumentRelevanceConfiguration > &  value)
inline

Overrides relevance tuning configurations of fields or attributes set at the index level.

If you use this API to override the relevance tuning configured at the index level, but there is no relevance tuning configured at the index level, then Amazon Kendra does not apply any relevance tuning.

If there is relevance tuning configured at the index level, but you do not use this API to override any relevance tuning in the index, then Amazon Kendra uses the relevance tuning that is configured at the index level.

If there is relevance tuning configured for fields at the index level, but you use this API to override only some of these fields, then for the fields you did not override, the importance is set to 1.

Definition at line 421 of file QueryRequest.h.

◆ WithFacets() [1/2]

QueryRequest& Aws::kendra::Model::QueryRequest::WithFacets ( Aws::Vector< Facet > &&  value)
inline

An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.

Definition at line 235 of file QueryRequest.h.

◆ WithFacets() [2/2]

QueryRequest& Aws::kendra::Model::QueryRequest::WithFacets ( const Aws::Vector< Facet > &  value)
inline

An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.

Definition at line 228 of file QueryRequest.h.

◆ WithIndexId() [1/3]

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

The unique identifier of the index to search. The identifier is returned in the response from the CreateIndex operation.

Definition at line 84 of file QueryRequest.h.

◆ WithIndexId() [2/3]

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

The unique identifier of the index to search. The identifier is returned in the response from the CreateIndex operation.

Definition at line 78 of file QueryRequest.h.

◆ WithIndexId() [3/3]

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

The unique identifier of the index to search. The identifier is returned in the response from the CreateIndex operation.

Definition at line 90 of file QueryRequest.h.

◆ WithPageNumber()

QueryRequest& Aws::kendra::Model::QueryRequest::WithPageNumber ( int  value)
inline

Query results are returned in pages the size of the PageSize parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.

Definition at line 492 of file QueryRequest.h.

◆ WithPageSize()

QueryRequest& Aws::kendra::Model::QueryRequest::WithPageSize ( int  value)
inline

Sets the number of results that are returned in each page of results. The default page size is 10. The maximum number of results returned is 100. If you ask for more than 100 results, only 100 are returned.

Definition at line 521 of file QueryRequest.h.

◆ WithQueryResultTypeFilter() [1/2]

QueryRequest& Aws::kendra::Model::QueryRequest::WithQueryResultTypeFilter ( const QueryResultType value)
inline

Sets the type of query. Only results for the specified query type are returned.

Definition at line 344 of file QueryRequest.h.

◆ WithQueryResultTypeFilter() [2/2]

QueryRequest& Aws::kendra::Model::QueryRequest::WithQueryResultTypeFilter ( QueryResultType &&  value)
inline

Sets the type of query. Only results for the specified query type are returned.

Definition at line 350 of file QueryRequest.h.

◆ WithQueryText() [1/3]

QueryRequest& Aws::kendra::Model::QueryRequest::WithQueryText ( Aws::String &&  value)
inline

The text to search for.

Definition at line 126 of file QueryRequest.h.

◆ WithQueryText() [2/3]

QueryRequest& Aws::kendra::Model::QueryRequest::WithQueryText ( const Aws::String value)
inline

The text to search for.

Definition at line 121 of file QueryRequest.h.

◆ WithQueryText() [3/3]

QueryRequest& Aws::kendra::Model::QueryRequest::WithQueryText ( const char *  value)
inline

The text to search for.

Definition at line 131 of file QueryRequest.h.

◆ WithRequestedDocumentAttributes() [1/2]

QueryRequest& Aws::kendra::Model::QueryRequest::WithRequestedDocumentAttributes ( Aws::Vector< Aws::String > &&  value)
inline

An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.

Definition at line 292 of file QueryRequest.h.

◆ WithRequestedDocumentAttributes() [2/2]

QueryRequest& Aws::kendra::Model::QueryRequest::WithRequestedDocumentAttributes ( const Aws::Vector< Aws::String > &  value)
inline

An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.

Definition at line 285 of file QueryRequest.h.

◆ WithSortingConfiguration() [1/2]

QueryRequest& Aws::kendra::Model::QueryRequest::WithSortingConfiguration ( const SortingConfiguration value)
inline

Provides information that determines how the results of the query are sorted. You can set the field that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. In the case of ties in sorting the results, the results are sorted by relevance.

If you don't provide sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result.

Definition at line 572 of file QueryRequest.h.

◆ WithSortingConfiguration() [2/2]

QueryRequest& Aws::kendra::Model::QueryRequest::WithSortingConfiguration ( SortingConfiguration &&  value)
inline

Provides information that determines how the results of the query are sorted. You can set the field that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. In the case of ties in sorting the results, the results are sorted by relevance.

If you don't provide sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result.

Definition at line 582 of file QueryRequest.h.

◆ WithUserContext() [1/2]

QueryRequest& Aws::kendra::Model::QueryRequest::WithUserContext ( const UserContext value)
inline

The user context token or user and group information.

Definition at line 608 of file QueryRequest.h.

◆ WithUserContext() [2/2]

QueryRequest& Aws::kendra::Model::QueryRequest::WithUserContext ( UserContext &&  value)
inline

The user context token or user and group information.

Definition at line 613 of file QueryRequest.h.

◆ WithVisitorId() [1/3]

QueryRequest& Aws::kendra::Model::QueryRequest::WithVisitorId ( Aws::String &&  value)
inline

Provides an identifier for a specific user. The VisitorId should be a unique identifier, such as a GUID. Don't use personally identifiable information, such as the user's email address, as the VisitorId.

Definition at line 670 of file QueryRequest.h.

◆ WithVisitorId() [2/3]

QueryRequest& Aws::kendra::Model::QueryRequest::WithVisitorId ( const Aws::String value)
inline

Provides an identifier for a specific user. The VisitorId should be a unique identifier, such as a GUID. Don't use personally identifiable information, such as the user's email address, as the VisitorId.

Definition at line 662 of file QueryRequest.h.

◆ WithVisitorId() [3/3]

QueryRequest& Aws::kendra::Model::QueryRequest::WithVisitorId ( const char *  value)
inline

Provides an identifier for a specific user. The VisitorId should be a unique identifier, such as a GUID. Don't use personally identifiable information, such as the user's email address, as the VisitorId.

Definition at line 678 of file QueryRequest.h.


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