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

Class ChatSyncRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.qbusiness.model.QBusinessRequest

software.amazon.awssdk.services.qbusiness.model.ChatSyncRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ChatSyncRequest.Builder,ChatSyncRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ChatSyncRequest
extends QBusinessRequest
implements ToCopyableBuilder<ChatSyncRequest.Builder,ChatSyncRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ChatSyncRequest.Builder

Method Summary

Modifier and Type	Method	Description
ActionExecution	actionExecution()	A request from an end user to perform an Amazon Q Business plugin action.
String	applicationId()	The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.
List<AttachmentInput>	attachments()	A list of files uploaded directly during chat.
AttributeFilter	attributeFilter()	Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.
AuthChallengeResponse	authChallengeResponse()	An authentication verification event response by a third party authentication server to Amazon Q Business.
static ChatSyncRequest.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()	The chat mode configuration for an Amazon Q Business application.
String	clientToken()	A token that you provide to identify a chat request.
String	conversationId()	The identifier of the Amazon Q Business conversation.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttachments()	For responses, this returns true if the service returned a value for the Attachments property.
int	hashCode()
boolean	hasUserGroups()	For responses, this returns true if the service returned a value for the UserGroups property.
String	parentMessageId()	The identifier of the previous system message in a conversation.
List<SdkField<?>>	sdkFields()
static Class<? extends ChatSyncRequest.Builder>	serializableBuilderClass()
ChatSyncRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	userGroups()	The groups that a user associated with the chat input belongs to.
String	userId()	The identifier of the user attached to the chat input.
String	userMessage()	A end user message in a conversation.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

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

copy

Method Detail

applicationId

public final String applicationId()

The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.

Returns:

The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.

userId

public final String userId()

The identifier of the user attached to the chat input.

Returns:

The identifier of the user attached to the chat input.

hasUserGroups

public final boolean hasUserGroups()

For responses, this returns true if the service returned a value for the UserGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

userGroups

public final List<String> userGroups()

The groups that a user associated with the chat input belongs to.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUserGroups() method.

Returns:

The groups that a user associated with the chat input belongs to.

userMessage

public final String userMessage()

A end user message in a conversation.

Returns:

A end user message in a conversation.

hasAttachments

public final boolean hasAttachments()

For responses, this returns true if the service returned a value for the Attachments property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

attachments

public final List<AttachmentInput> attachments()

A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttachments() method.

Returns:

A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.

actionExecution

public final ActionExecution actionExecution()

A request from an end user to perform an Amazon Q Business plugin action.

Returns:

A request from an end user to perform an Amazon Q Business plugin action.

authChallengeResponse

public final AuthChallengeResponse authChallengeResponse()

An authentication verification event response by a third party authentication server to Amazon Q Business.

Returns:

An authentication verification event response by a third party authentication server to Amazon Q Business.

conversationId

public final String conversationId()

The identifier of the Amazon Q Business conversation.

Returns:

The identifier of the Amazon Q Business conversation.

parentMessageId

public final String parentMessageId()

The identifier of the previous system message in a conversation.

Returns:

The identifier of the previous system message in a conversation.

attributeFilter

public final AttributeFilter attributeFilter()

Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.

Returns:

Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.

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()

The chat mode configuration for an Amazon Q Business application.

Returns:

The chat mode configuration for an Amazon Q Business application.

clientToken

public final String clientToken()

A token that you provide to identify a chat request.

Returns:

A token that you provide to identify a chat request.

toBuilder

public ChatSyncRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ChatSyncRequest.Builder,ChatSyncRequest>

Specified by:

toBuilder in class QBusinessRequest

builder

public static ChatSyncRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo