AttributeSuggestionsGetConfig - Amazon Kendra API Reference

AttributeSuggestionsGetConfig

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

Contents

AdditionalResponseAttributes

The list of additional document field/attribute keys or field names to include in the response. You can use additional fields to provide extra information in the response. Additional fields are not used to based suggestions on.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: [a-zA-Z0-9_][a-zA-Z0-9_-]*

Required: No

AttributeFilter

Filters the search results based on document fields/attributes.

Type: AttributeFilter object

Required: No

SuggestionAttributes

The list of document field/attribute keys or field names to use for query suggestions. If the content within any of the fields match what your user starts typing as their query, then the field content is returned as a query suggestion.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: [a-zA-Z0-9_][a-zA-Z0-9_-]*

Required: No

UserContext

Applies user context filtering so that only users who are given access to certain documents see these document in their search results.

Type: UserContext object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: