Package software.amazon.awssdk.services.kendra.model

Interface AttributeSuggestionsGetConfig.Builder

All Superinterfaces:
Buildable, CopyableBuilder<AttributeSuggestionsGetConfig.Builder,AttributeSuggestionsGetConfig>, SdkBuilder<AttributeSuggestionsGetConfig.Builder,AttributeSuggestionsGetConfig>, SdkPojo
Enclosing class:
AttributeSuggestionsGetConfig
public static interface AttributeSuggestionsGetConfig.Builder extends SdkPojo, CopyableBuilder<AttributeSuggestionsGetConfig.Builder,AttributeSuggestionsGetConfig>

  • Method Details

    • suggestionAttributes

      AttributeSuggestionsGetConfig.Builder suggestionAttributes(Collection<String> 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • suggestionAttributes

      AttributeSuggestionsGetConfig.Builder suggestionAttributes(String... 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalResponseAttributes

      AttributeSuggestionsGetConfig.Builder additionalResponseAttributes(Collection<String> 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalResponseAttributes

      AttributeSuggestionsGetConfig.Builder additionalResponseAttributes(String... 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributeFilter

      AttributeSuggestionsGetConfig.Builder attributeFilter(AttributeFilter attributeFilter)

      Filters the search results based on document fields/attributes.

      Parameters:
      attributeFilter - Filters the search results based on document fields/attributes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributeFilter

      default AttributeSuggestionsGetConfig.Builder attributeFilter(Consumer<AttributeFilter.Builder> attributeFilter)

      Filters the search results based on document fields/attributes.

      This is a convenience method that creates an instance of the AttributeFilter.Builder avoiding the need to create one manually via AttributeFilter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to attributeFilter(AttributeFilter).

      Parameters:
      attributeFilter - a consumer that will call methods on AttributeFilter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • userContext

      AttributeSuggestionsGetConfig.Builder userContext(UserContext userContext)

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

      Parameters:
      userContext - Applies user context filtering so that only users who are given access to certain documents see these document in their search results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userContext

      default AttributeSuggestionsGetConfig.Builder userContext(Consumer<UserContext.Builder> userContext)

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

      This is a convenience method that creates an instance of the UserContext.Builder avoiding the need to create one manually via UserContext.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to userContext(UserContext).

      Parameters:
      userContext - a consumer that will call methods on UserContext.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: