Package software.amazon.awssdk.services.qbusiness.model

Class ConfigurationEvent

java.lang.Object

software.amazon.awssdk.services.qbusiness.model.ConfigurationEvent

All Implemented Interfaces:

Serializable, SdkPojo, ChatInputStream, ToCopyableBuilder<ConfigurationEvent.Builder,ConfigurationEvent>

Direct Known Subclasses:

DefaultConfigurationEvent

@Generated("software.amazon.awssdk:codegen")
public class ConfigurationEvent
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ConfigurationEvent.Builder,ConfigurationEvent>, ChatInputStream

A configuration event activated by an end user request to select a specific chat mode.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ConfigurationEvent.Builder
protected static class	ConfigurationEvent.BuilderImpl

Nested classes/interfaces inherited from interface software.amazon.awssdk.services.qbusiness.model.ChatInputStream

ChatInputStream.EventType

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ConfigurationEvent(ConfigurationEvent.BuilderImpl builder)

Method Summary

Modifier and Type	Method	Description
AttributeFilter	attributeFilter()	Returns the value of the AttributeFilter property for this object.
static ConfigurationEvent.Builder	builder()
ChatMode	chatMode()	The chat modes available to an Amazon Q Business end user.
String	chatModeAsString()	The chat modes available to an Amazon Q Business end user.
ChatModeConfiguration	chatModeConfiguration()	Returns the value of the ChatModeConfiguration property for this object.
ConfigurationEvent	copy(Consumer<? super ConfigurationEvent.Builder> modifier)
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends ConfigurationEvent.Builder>	serializableBuilderClass()
ConfigurationEvent.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.services.qbusiness.model.ChatInputStream

sdkEventType

Constructor Detail

ConfigurationEvent

protected ConfigurationEvent(ConfigurationEvent.BuilderImpl builder)

Method Detail

chatMode

public final ChatMode chatMode()

The chat modes available to an Amazon Q Business end user.

• RETRIEVAL_MODE - The default chat mode for an Amazon Q Business application. When this mode is enabled, Amazon Q Business generates responses only from data sources connected to an Amazon Q Business application.

• CREATOR_MODE - By selecting this mode, users can choose to generate responses only from the LLM knowledge, without consulting connected data sources, for a chat request.

• PLUGIN_MODE - By selecting this mode, users can choose to use plugins in chat.

For more information, see Admin controls and guardrails, Plugins, and Conversation settings.

If the service returns an enum value that is not available in the current SDK version, chatMode will return ChatMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from chatModeAsString().

Returns:

The chat modes available to an Amazon Q Business end user.

• RETRIEVAL_MODE - The default chat mode for an Amazon Q Business application. When this mode is enabled, Amazon Q Business generates responses only from data sources connected to an Amazon Q Business application.

• CREATOR_MODE - By selecting this mode, users can choose to generate responses only from the LLM knowledge, without consulting connected data sources, for a chat request.

• PLUGIN_MODE - By selecting this mode, users can choose to use plugins in chat.

For more information, see Admin controls and guardrails, Plugins, and Conversation settings.

See Also:

ChatMode

chatModeAsString

public final String chatModeAsString()

The chat modes available to an Amazon Q Business end user.

• RETRIEVAL_MODE - The default chat mode for an Amazon Q Business application. When this mode is enabled, Amazon Q Business generates responses only from data sources connected to an Amazon Q Business application.

• CREATOR_MODE - By selecting this mode, users can choose to generate responses only from the LLM knowledge, without consulting connected data sources, for a chat request.

• PLUGIN_MODE - By selecting this mode, users can choose to use plugins in chat.

For more information, see Admin controls and guardrails, Plugins, and Conversation settings.

If the service returns an enum value that is not available in the current SDK version, chatMode will return ChatMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from chatModeAsString().

Returns:

The chat modes available to an Amazon Q Business end user.

• RETRIEVAL_MODE - The default chat mode for an Amazon Q Business application. When this mode is enabled, Amazon Q Business generates responses only from data sources connected to an Amazon Q Business application.

• CREATOR_MODE - By selecting this mode, users can choose to generate responses only from the LLM knowledge, without consulting connected data sources, for a chat request.

• PLUGIN_MODE - By selecting this mode, users can choose to use plugins in chat.

For more information, see Admin controls and guardrails, Plugins, and Conversation settings.

See Also:

ChatMode

chatModeConfiguration

public final ChatModeConfiguration chatModeConfiguration()

Returns the value of the ChatModeConfiguration property for this object.

Returns:

The value of the ChatModeConfiguration property for this object.

attributeFilter

public final AttributeFilter attributeFilter()

Returns the value of the AttributeFilter property for this object.

Returns:

The value of the AttributeFilter property for this object.

toBuilder

public ConfigurationEvent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ConfigurationEvent.Builder,ConfigurationEvent>

builder

public static ConfigurationEvent.Builder builder()

serializableBuilderClass

public static Class<? extends ConfigurationEvent.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

copy

public final ConfigurationEvent copy(Consumer<? super ConfigurationEvent.Builder> modifier)

Specified by:

copy in interface ToCopyableBuilder<ConfigurationEvent.Builder,ConfigurationEvent>

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo