Interface GetChatControlsConfigurationResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetChatControlsConfigurationResponse.Builder,GetChatControlsConfigurationResponse>, QBusinessResponse.Builder, SdkBuilder<GetChatControlsConfigurationResponse.Builder,GetChatControlsConfigurationResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetChatControlsConfigurationResponse

@Mutable
@NotThreadSafe
public static interface GetChatControlsConfigurationResponse.Builder
extends QBusinessResponse.Builder, SdkPojo, CopyableBuilder<GetChatControlsConfigurationResponse.Builder,GetChatControlsConfigurationResponse>

Method Summary

Modifier and Type	Method	Description
default GetChatControlsConfigurationResponse.Builder	blockedPhrases(Consumer<BlockedPhrasesConfiguration.Builder> blockedPhrases)	The phrases blocked from chat by your chat control configuration.
GetChatControlsConfigurationResponse.Builder	blockedPhrases(BlockedPhrasesConfiguration blockedPhrases)	The phrases blocked from chat by your chat control configuration.
default GetChatControlsConfigurationResponse.Builder	creatorModeConfiguration(Consumer<AppliedCreatorModeConfiguration.Builder> creatorModeConfiguration)	The configuration details for CREATOR_MODE.
GetChatControlsConfigurationResponse.Builder	creatorModeConfiguration(AppliedCreatorModeConfiguration creatorModeConfiguration)	The configuration details for CREATOR_MODE.
default GetChatControlsConfigurationResponse.Builder	hallucinationReductionConfiguration(Consumer<HallucinationReductionConfiguration.Builder> hallucinationReductionConfiguration)	The hallucination reduction settings for your application.
GetChatControlsConfigurationResponse.Builder	hallucinationReductionConfiguration(HallucinationReductionConfiguration hallucinationReductionConfiguration)	The hallucination reduction settings for your application.
GetChatControlsConfigurationResponse.Builder	nextToken(String nextToken)	If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response.
default GetChatControlsConfigurationResponse.Builder	orchestrationConfiguration(Consumer<AppliedOrchestrationConfiguration.Builder> orchestrationConfiguration)	The chat response orchestration settings for your application.
GetChatControlsConfigurationResponse.Builder	orchestrationConfiguration(AppliedOrchestrationConfiguration orchestrationConfiguration)	The chat response orchestration settings for your application.
GetChatControlsConfigurationResponse.Builder	responseScope(String responseScope)	The response scope configured for a Amazon Q Business application.
GetChatControlsConfigurationResponse.Builder	responseScope(ResponseScope responseScope)	The response scope configured for a Amazon Q Business application.
GetChatControlsConfigurationResponse.Builder	topicConfigurations(Collection<TopicConfiguration> topicConfigurations)	The topic specific controls configured for a Amazon Q Business application.
GetChatControlsConfigurationResponse.Builder	topicConfigurations(Consumer<TopicConfiguration.Builder>... topicConfigurations)	The topic specific controls configured for a Amazon Q Business application.
GetChatControlsConfigurationResponse.Builder	topicConfigurations(TopicConfiguration... topicConfigurations)	The topic specific controls configured for a Amazon Q Business application.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.qbusiness.model.QBusinessResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

responseScope

GetChatControlsConfigurationResponse.Builder responseScope(String responseScope)

The response scope configured for a Amazon Q Business application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.

Parameters:

responseScope - The response scope configured for a Amazon Q Business application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• ResponseScope
• ResponseScope

responseScope

GetChatControlsConfigurationResponse.Builder responseScope(ResponseScope responseScope)

The response scope configured for a Amazon Q Business application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.

Parameters:

responseScope - The response scope configured for a Amazon Q Business application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• ResponseScope
• ResponseScope

orchestrationConfiguration

GetChatControlsConfigurationResponse.Builder orchestrationConfiguration(AppliedOrchestrationConfiguration orchestrationConfiguration)

The chat response orchestration settings for your application.

Chat orchestration is optimized to work for English language content. For more details on language support in Amazon Q Business, see Supported languages.

Parameters:

orchestrationConfiguration - The chat response orchestration settings for your application.

Chat orchestration is optimized to work for English language content. For more details on language support in Amazon Q Business, see Supported languages.

Returns:

Returns a reference to this object so that method calls can be chained together.

orchestrationConfiguration

default GetChatControlsConfigurationResponse.Builder orchestrationConfiguration(Consumer<AppliedOrchestrationConfiguration.Builder> orchestrationConfiguration)

The chat response orchestration settings for your application.

Chat orchestration is optimized to work for English language content. For more details on language support in Amazon Q Business, see Supported languages.

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

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

Parameters:

orchestrationConfiguration - a consumer that will call methods on AppliedOrchestrationConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• orchestrationConfiguration(AppliedOrchestrationConfiguration)

blockedPhrases

GetChatControlsConfigurationResponse.Builder blockedPhrases(BlockedPhrasesConfiguration blockedPhrases)

The phrases blocked from chat by your chat control configuration.

Parameters:

blockedPhrases - The phrases blocked from chat by your chat control configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

blockedPhrases

default GetChatControlsConfigurationResponse.Builder blockedPhrases(Consumer<BlockedPhrasesConfiguration.Builder> blockedPhrases)

The phrases blocked from chat by your chat control configuration.

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

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

Parameters:

blockedPhrases - a consumer that will call methods on BlockedPhrasesConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• blockedPhrases(BlockedPhrasesConfiguration)

topicConfigurations

GetChatControlsConfigurationResponse.Builder topicConfigurations(Collection<TopicConfiguration> topicConfigurations)

The topic specific controls configured for a Amazon Q Business application.

Parameters:

topicConfigurations - The topic specific controls configured for a Amazon Q Business application.

Returns:

Returns a reference to this object so that method calls can be chained together.

topicConfigurations

GetChatControlsConfigurationResponse.Builder topicConfigurations(TopicConfiguration... topicConfigurations)

The topic specific controls configured for a Amazon Q Business application.

Parameters:

topicConfigurations - The topic specific controls configured for a Amazon Q Business application.

Returns:

Returns a reference to this object so that method calls can be chained together.

topicConfigurations

GetChatControlsConfigurationResponse.Builder topicConfigurations(Consumer<TopicConfiguration.Builder>... topicConfigurations)

The topic specific controls configured for a Amazon Q Business application.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to topicConfigurations(List<TopicConfiguration>).

Parameters:

topicConfigurations - a consumer that will call methods on TopicConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• topicConfigurations(java.util.Collection<TopicConfiguration>)

creatorModeConfiguration

GetChatControlsConfigurationResponse.Builder creatorModeConfiguration(AppliedCreatorModeConfiguration creatorModeConfiguration)

The configuration details for CREATOR_MODE.

Parameters:

creatorModeConfiguration - The configuration details for CREATOR_MODE.

Returns:

Returns a reference to this object so that method calls can be chained together.

creatorModeConfiguration

default GetChatControlsConfigurationResponse.Builder creatorModeConfiguration(Consumer<AppliedCreatorModeConfiguration.Builder> creatorModeConfiguration)

The configuration details for CREATOR_MODE.

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

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

Parameters:

creatorModeConfiguration - a consumer that will call methods on AppliedCreatorModeConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• creatorModeConfiguration(AppliedCreatorModeConfiguration)

nextToken

GetChatControlsConfigurationResponse.Builder nextToken(String nextToken)

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.

Parameters:

nextToken - If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.

Returns:

Returns a reference to this object so that method calls can be chained together.

hallucinationReductionConfiguration

GetChatControlsConfigurationResponse.Builder hallucinationReductionConfiguration(HallucinationReductionConfiguration hallucinationReductionConfiguration)

The hallucination reduction settings for your application.

Parameters:

hallucinationReductionConfiguration - The hallucination reduction settings for your application.

Returns:

Returns a reference to this object so that method calls can be chained together.

hallucinationReductionConfiguration

default GetChatControlsConfigurationResponse.Builder hallucinationReductionConfiguration(Consumer<HallucinationReductionConfiguration.Builder> hallucinationReductionConfiguration)

The hallucination reduction settings for your application.

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

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

Parameters:

hallucinationReductionConfiguration - a consumer that will call methods on HallucinationReductionConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• hallucinationReductionConfiguration(HallucinationReductionConfiguration)