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

Updates the configuration information for the document fields/attributes that * you want to base query suggestions on.

To deactivate using documents * fields for query suggestions, set the mode to INACTIVE. You must * also set SuggestionTypes as either QUERY or * DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions. * If you set to QUERY, then Amazon Kendra uses the query history to * base suggestions on. If you set to DOCUMENT_ATTRIBUTES, then Amazon * Kendra uses the contents of document fields to base suggestions * on.

See Also:

AWS * API Reference

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

The list of fields/attributes that you want to set as suggestible for query * suggestions.

*/ inline const Aws::Vector& GetSuggestableConfigList() const{ return m_suggestableConfigList; } /** *

The list of fields/attributes that you want to set as suggestible for query * suggestions.

*/ inline bool SuggestableConfigListHasBeenSet() const { return m_suggestableConfigListHasBeenSet; } /** *

The list of fields/attributes that you want to set as suggestible for query * suggestions.

*/ inline void SetSuggestableConfigList(const Aws::Vector& value) { m_suggestableConfigListHasBeenSet = true; m_suggestableConfigList = value; } /** *

The list of fields/attributes that you want to set as suggestible for query * suggestions.

*/ inline void SetSuggestableConfigList(Aws::Vector&& value) { m_suggestableConfigListHasBeenSet = true; m_suggestableConfigList = std::move(value); } /** *

The list of fields/attributes that you want to set as suggestible for query * suggestions.

*/ inline AttributeSuggestionsUpdateConfig& WithSuggestableConfigList(const Aws::Vector& value) { SetSuggestableConfigList(value); return *this;} /** *

The list of fields/attributes that you want to set as suggestible for query * suggestions.

*/ inline AttributeSuggestionsUpdateConfig& WithSuggestableConfigList(Aws::Vector&& value) { SetSuggestableConfigList(std::move(value)); return *this;} /** *

The list of fields/attributes that you want to set as suggestible for query * suggestions.

*/ inline AttributeSuggestionsUpdateConfig& AddSuggestableConfigList(const SuggestableConfig& value) { m_suggestableConfigListHasBeenSet = true; m_suggestableConfigList.push_back(value); return *this; } /** *

The list of fields/attributes that you want to set as suggestible for query * suggestions.

*/ inline AttributeSuggestionsUpdateConfig& AddSuggestableConfigList(SuggestableConfig&& value) { m_suggestableConfigListHasBeenSet = true; m_suggestableConfigList.push_back(std::move(value)); return *this; } /** *

You can set the mode to ACTIVE or INACTIVE. You * must also set SuggestionTypes as either QUERY or * DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions. * If Mode to use query history is set to ENABLED when * calling UpdateQuerySuggestionsConfig * and AttributeSuggestionsMode to use fields/attributes is set to * ACTIVE, and you haven't set your SuggestionTypes * preference to DOCUMENT_ATTRIBUTES, then Amazon Kendra uses the * query history.

*/ inline const AttributeSuggestionsMode& GetAttributeSuggestionsMode() const{ return m_attributeSuggestionsMode; } /** *

You can set the mode to ACTIVE or INACTIVE. You * must also set SuggestionTypes as either QUERY or * DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions. * If Mode to use query history is set to ENABLED when * calling UpdateQuerySuggestionsConfig * and AttributeSuggestionsMode to use fields/attributes is set to * ACTIVE, and you haven't set your SuggestionTypes * preference to DOCUMENT_ATTRIBUTES, then Amazon Kendra uses the * query history.

*/ inline bool AttributeSuggestionsModeHasBeenSet() const { return m_attributeSuggestionsModeHasBeenSet; } /** *

You can set the mode to ACTIVE or INACTIVE. You * must also set SuggestionTypes as either QUERY or * DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions. * If Mode to use query history is set to ENABLED when * calling UpdateQuerySuggestionsConfig * and AttributeSuggestionsMode to use fields/attributes is set to * ACTIVE, and you haven't set your SuggestionTypes * preference to DOCUMENT_ATTRIBUTES, then Amazon Kendra uses the * query history.

*/ inline void SetAttributeSuggestionsMode(const AttributeSuggestionsMode& value) { m_attributeSuggestionsModeHasBeenSet = true; m_attributeSuggestionsMode = value; } /** *

You can set the mode to ACTIVE or INACTIVE. You * must also set SuggestionTypes as either QUERY or * DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions. * If Mode to use query history is set to ENABLED when * calling UpdateQuerySuggestionsConfig * and AttributeSuggestionsMode to use fields/attributes is set to * ACTIVE, and you haven't set your SuggestionTypes * preference to DOCUMENT_ATTRIBUTES, then Amazon Kendra uses the * query history.

*/ inline void SetAttributeSuggestionsMode(AttributeSuggestionsMode&& value) { m_attributeSuggestionsModeHasBeenSet = true; m_attributeSuggestionsMode = std::move(value); } /** *

You can set the mode to ACTIVE or INACTIVE. You * must also set SuggestionTypes as either QUERY or * DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions. * If Mode to use query history is set to ENABLED when * calling UpdateQuerySuggestionsConfig * and AttributeSuggestionsMode to use fields/attributes is set to * ACTIVE, and you haven't set your SuggestionTypes * preference to DOCUMENT_ATTRIBUTES, then Amazon Kendra uses the * query history.

*/ inline AttributeSuggestionsUpdateConfig& WithAttributeSuggestionsMode(const AttributeSuggestionsMode& value) { SetAttributeSuggestionsMode(value); return *this;} /** *

You can set the mode to ACTIVE or INACTIVE. You * must also set SuggestionTypes as either QUERY or * DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions. * If Mode to use query history is set to ENABLED when * calling UpdateQuerySuggestionsConfig * and AttributeSuggestionsMode to use fields/attributes is set to * ACTIVE, and you haven't set your SuggestionTypes * preference to DOCUMENT_ATTRIBUTES, then Amazon Kendra uses the * query history.

*/ inline AttributeSuggestionsUpdateConfig& WithAttributeSuggestionsMode(AttributeSuggestionsMode&& value) { SetAttributeSuggestionsMode(std::move(value)); return *this;} private: Aws::Vector m_suggestableConfigList; bool m_suggestableConfigListHasBeenSet = false; AttributeSuggestionsMode m_attributeSuggestionsMode; bool m_attributeSuggestionsModeHasBeenSet = false; }; } // namespace Model } // namespace kendra } // namespace Aws