/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace LexModelBuildingService { namespace Model { /** *

Provides configuration information for the AMAZON.KendraSearchIntent intent. * When you use this intent, Amazon Lex searches the specified Amazon Kendra index * and returns documents from the index that match the user's utterance. For more * information, see * AMAZON.KendraSearchIntent.

See Also:

AWS * API Reference

*/ class KendraConfiguration { public: AWS_LEXMODELBUILDINGSERVICE_API KendraConfiguration(); AWS_LEXMODELBUILDINGSERVICE_API KendraConfiguration(Aws::Utils::Json::JsonView jsonValue); AWS_LEXMODELBUILDINGSERVICE_API KendraConfiguration& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_LEXMODELBUILDINGSERVICE_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the * AMAZON.KendraSearchIntent intent to search. The index must be in the same * account and Region as the Amazon Lex bot. If the Amazon Kendra index does not * exist, you get an exception when you call the PutIntent * operation.

*/ inline const Aws::String& GetKendraIndex() const{ return m_kendraIndex; } /** *

The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the * AMAZON.KendraSearchIntent intent to search. The index must be in the same * account and Region as the Amazon Lex bot. If the Amazon Kendra index does not * exist, you get an exception when you call the PutIntent * operation.

*/ inline bool KendraIndexHasBeenSet() const { return m_kendraIndexHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the * AMAZON.KendraSearchIntent intent to search. The index must be in the same * account and Region as the Amazon Lex bot. If the Amazon Kendra index does not * exist, you get an exception when you call the PutIntent * operation.

*/ inline void SetKendraIndex(const Aws::String& value) { m_kendraIndexHasBeenSet = true; m_kendraIndex = value; } /** *

The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the * AMAZON.KendraSearchIntent intent to search. The index must be in the same * account and Region as the Amazon Lex bot. If the Amazon Kendra index does not * exist, you get an exception when you call the PutIntent * operation.

*/ inline void SetKendraIndex(Aws::String&& value) { m_kendraIndexHasBeenSet = true; m_kendraIndex = std::move(value); } /** *

The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the * AMAZON.KendraSearchIntent intent to search. The index must be in the same * account and Region as the Amazon Lex bot. If the Amazon Kendra index does not * exist, you get an exception when you call the PutIntent * operation.

*/ inline void SetKendraIndex(const char* value) { m_kendraIndexHasBeenSet = true; m_kendraIndex.assign(value); } /** *

The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the * AMAZON.KendraSearchIntent intent to search. The index must be in the same * account and Region as the Amazon Lex bot. If the Amazon Kendra index does not * exist, you get an exception when you call the PutIntent * operation.

*/ inline KendraConfiguration& WithKendraIndex(const Aws::String& value) { SetKendraIndex(value); return *this;} /** *

The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the * AMAZON.KendraSearchIntent intent to search. The index must be in the same * account and Region as the Amazon Lex bot. If the Amazon Kendra index does not * exist, you get an exception when you call the PutIntent * operation.

*/ inline KendraConfiguration& WithKendraIndex(Aws::String&& value) { SetKendraIndex(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the * AMAZON.KendraSearchIntent intent to search. The index must be in the same * account and Region as the Amazon Lex bot. If the Amazon Kendra index does not * exist, you get an exception when you call the PutIntent * operation.

*/ inline KendraConfiguration& WithKendraIndex(const char* value) { SetKendraIndex(value); return *this;} /** *

A query filter that Amazon Lex sends to Amazon Kendra to filter the response * from the query. The filter is in the format defined by Amazon Kendra. For more * information, see Filtering * queries.

You can override this filter string with a new filter string * at runtime.

*/ inline const Aws::String& GetQueryFilterString() const{ return m_queryFilterString; } /** *

A query filter that Amazon Lex sends to Amazon Kendra to filter the response * from the query. The filter is in the format defined by Amazon Kendra. For more * information, see Filtering * queries.

You can override this filter string with a new filter string * at runtime.

*/ inline bool QueryFilterStringHasBeenSet() const { return m_queryFilterStringHasBeenSet; } /** *

A query filter that Amazon Lex sends to Amazon Kendra to filter the response * from the query. The filter is in the format defined by Amazon Kendra. For more * information, see Filtering * queries.

You can override this filter string with a new filter string * at runtime.

*/ inline void SetQueryFilterString(const Aws::String& value) { m_queryFilterStringHasBeenSet = true; m_queryFilterString = value; } /** *

A query filter that Amazon Lex sends to Amazon Kendra to filter the response * from the query. The filter is in the format defined by Amazon Kendra. For more * information, see Filtering * queries.

You can override this filter string with a new filter string * at runtime.

*/ inline void SetQueryFilterString(Aws::String&& value) { m_queryFilterStringHasBeenSet = true; m_queryFilterString = std::move(value); } /** *

A query filter that Amazon Lex sends to Amazon Kendra to filter the response * from the query. The filter is in the format defined by Amazon Kendra. For more * information, see Filtering * queries.

You can override this filter string with a new filter string * at runtime.

*/ inline void SetQueryFilterString(const char* value) { m_queryFilterStringHasBeenSet = true; m_queryFilterString.assign(value); } /** *

A query filter that Amazon Lex sends to Amazon Kendra to filter the response * from the query. The filter is in the format defined by Amazon Kendra. For more * information, see Filtering * queries.

You can override this filter string with a new filter string * at runtime.

*/ inline KendraConfiguration& WithQueryFilterString(const Aws::String& value) { SetQueryFilterString(value); return *this;} /** *

A query filter that Amazon Lex sends to Amazon Kendra to filter the response * from the query. The filter is in the format defined by Amazon Kendra. For more * information, see Filtering * queries.

You can override this filter string with a new filter string * at runtime.

*/ inline KendraConfiguration& WithQueryFilterString(Aws::String&& value) { SetQueryFilterString(std::move(value)); return *this;} /** *

A query filter that Amazon Lex sends to Amazon Kendra to filter the response * from the query. The filter is in the format defined by Amazon Kendra. For more * information, see Filtering * queries.

You can override this filter string with a new filter string * at runtime.

*/ inline KendraConfiguration& WithQueryFilterString(const char* value) { SetQueryFilterString(value); return *this;} /** *

The Amazon Resource Name (ARN) of an IAM role that has permission to search * the Amazon Kendra index. The role must be in the same account and Region as the * Amazon Lex bot. If the role does not exist, you get an exception when you call * the PutIntent operation.

*/ inline const Aws::String& GetRole() const{ return m_role; } /** *

The Amazon Resource Name (ARN) of an IAM role that has permission to search * the Amazon Kendra index. The role must be in the same account and Region as the * Amazon Lex bot. If the role does not exist, you get an exception when you call * the PutIntent operation.

*/ inline bool RoleHasBeenSet() const { return m_roleHasBeenSet; } /** *

The Amazon Resource Name (ARN) of an IAM role that has permission to search * the Amazon Kendra index. The role must be in the same account and Region as the * Amazon Lex bot. If the role does not exist, you get an exception when you call * the PutIntent operation.

*/ inline void SetRole(const Aws::String& value) { m_roleHasBeenSet = true; m_role = value; } /** *

The Amazon Resource Name (ARN) of an IAM role that has permission to search * the Amazon Kendra index. The role must be in the same account and Region as the * Amazon Lex bot. If the role does not exist, you get an exception when you call * the PutIntent operation.

*/ inline void SetRole(Aws::String&& value) { m_roleHasBeenSet = true; m_role = std::move(value); } /** *

The Amazon Resource Name (ARN) of an IAM role that has permission to search * the Amazon Kendra index. The role must be in the same account and Region as the * Amazon Lex bot. If the role does not exist, you get an exception when you call * the PutIntent operation.

*/ inline void SetRole(const char* value) { m_roleHasBeenSet = true; m_role.assign(value); } /** *

The Amazon Resource Name (ARN) of an IAM role that has permission to search * the Amazon Kendra index. The role must be in the same account and Region as the * Amazon Lex bot. If the role does not exist, you get an exception when you call * the PutIntent operation.

*/ inline KendraConfiguration& WithRole(const Aws::String& value) { SetRole(value); return *this;} /** *

The Amazon Resource Name (ARN) of an IAM role that has permission to search * the Amazon Kendra index. The role must be in the same account and Region as the * Amazon Lex bot. If the role does not exist, you get an exception when you call * the PutIntent operation.

*/ inline KendraConfiguration& WithRole(Aws::String&& value) { SetRole(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of an IAM role that has permission to search * the Amazon Kendra index. The role must be in the same account and Region as the * Amazon Lex bot. If the role does not exist, you get an exception when you call * the PutIntent operation.

*/ inline KendraConfiguration& WithRole(const char* value) { SetRole(value); return *this;} private: Aws::String m_kendraIndex; bool m_kendraIndexHasBeenSet = false; Aws::String m_queryFilterString; bool m_queryFilterStringHasBeenSet = false; Aws::String m_role; bool m_roleHasBeenSet = false; }; } // namespace Model } // namespace LexModelBuildingService } // namespace Aws