Interface SessionState.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SessionState.Builder,SessionState>, SdkBuilder<SessionState.Builder,SessionState>, SdkPojo

Enclosing class:

SessionState

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

Method Summary

Modifier and Type	Method	Description
default SessionState.Builder	conversationHistory(Consumer<ConversationHistory.Builder> conversationHistory)	The state's conversation history.
SessionState.Builder	conversationHistory(ConversationHistory conversationHistory)	The state's conversation history.
SessionState.Builder	files(Collection<InputFile> files)	Contains information about the files used by code interpreter.
SessionState.Builder	files(Consumer<InputFile.Builder>... files)	Contains information about the files used by code interpreter.
SessionState.Builder	files(InputFile... files)	Contains information about the files used by code interpreter.
SessionState.Builder	invocationId(String invocationId)	The identifier of the invocation of an action.
SessionState.Builder	knowledgeBaseConfigurations(Collection<KnowledgeBaseConfiguration> knowledgeBaseConfigurations)	An array of configurations, each of which applies to a knowledge base attached to the agent.
SessionState.Builder	knowledgeBaseConfigurations(Consumer<KnowledgeBaseConfiguration.Builder>... knowledgeBaseConfigurations)	An array of configurations, each of which applies to a knowledge base attached to the agent.
SessionState.Builder	knowledgeBaseConfigurations(KnowledgeBaseConfiguration... knowledgeBaseConfigurations)	An array of configurations, each of which applies to a knowledge base attached to the agent.
SessionState.Builder	promptSessionAttributes(Map<String,String> promptSessionAttributes)	Contains attributes that persist across a prompt and the values of those attributes.
SessionState.Builder	returnControlInvocationResults(Collection<InvocationResultMember> returnControlInvocationResults)	Contains information about the results from the action group invocation.
SessionState.Builder	returnControlInvocationResults(Consumer<InvocationResultMember.Builder>... returnControlInvocationResults)	Contains information about the results from the action group invocation.
SessionState.Builder	returnControlInvocationResults(InvocationResultMember... returnControlInvocationResults)	Contains information about the results from the action group invocation.
SessionState.Builder	sessionAttributes(Map<String,String> sessionAttributes)	Contains attributes that persist across a session and the values of those attributes.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

conversationHistory

SessionState.Builder conversationHistory(ConversationHistory conversationHistory)

The state's conversation history.

Parameters:

conversationHistory - The state's conversation history.

Returns:

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

conversationHistory

default SessionState.Builder conversationHistory(Consumer<ConversationHistory.Builder> conversationHistory)

The state's conversation history.

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

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

Parameters:

conversationHistory - a consumer that will call methods on ConversationHistory.Builder

Returns:

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

See Also:

• conversationHistory(ConversationHistory)

files

SessionState.Builder files(Collection<InputFile> files)

Contains information about the files used by code interpreter.

Parameters:

files - Contains information about the files used by code interpreter.

Returns:

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

files

SessionState.Builder files(InputFile... files)

Contains information about the files used by code interpreter.

Parameters:

files - Contains information about the files used by code interpreter.

Returns:

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

files

SessionState.Builder files(Consumer<InputFile.Builder>... files)

Contains information about the files used by code interpreter.

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

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

Parameters:

files - a consumer that will call methods on InputFile.Builder

Returns:

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

See Also:

• files(java.util.Collection<InputFile>)

invocationId

SessionState.Builder invocationId(String invocationId)

The identifier of the invocation of an action. This value must match the invocationId returned in the InvokeAgent response for the action whose results are provided in the returnControlInvocationResults field. For more information, see Return control to the agent developer and Control session context.

Parameters:

invocationId - The identifier of the invocation of an action. This value must match the invocationId returned in the InvokeAgent response for the action whose results are provided in the returnControlInvocationResults field. For more information, see Return control to the agent developer and Control session context.

Returns:

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

knowledgeBaseConfigurations

SessionState.Builder knowledgeBaseConfigurations(Collection<KnowledgeBaseConfiguration> knowledgeBaseConfigurations)

An array of configurations, each of which applies to a knowledge base attached to the agent.

Parameters:

knowledgeBaseConfigurations - An array of configurations, each of which applies to a knowledge base attached to the agent.

Returns:

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

knowledgeBaseConfigurations

SessionState.Builder knowledgeBaseConfigurations(KnowledgeBaseConfiguration... knowledgeBaseConfigurations)

An array of configurations, each of which applies to a knowledge base attached to the agent.

Parameters:

knowledgeBaseConfigurations - An array of configurations, each of which applies to a knowledge base attached to the agent.

Returns:

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

knowledgeBaseConfigurations

SessionState.Builder knowledgeBaseConfigurations(Consumer<KnowledgeBaseConfiguration.Builder>... knowledgeBaseConfigurations)

An array of configurations, each of which applies to a knowledge base attached to the agent.

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

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

Parameters:

knowledgeBaseConfigurations - a consumer that will call methods on KnowledgeBaseConfiguration.Builder

Returns:

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

See Also:

• knowledgeBaseConfigurations(java.util.Collection<KnowledgeBaseConfiguration>)

promptSessionAttributes

SessionState.Builder promptSessionAttributes(Map<String,String> promptSessionAttributes)

Contains attributes that persist across a prompt and the values of those attributes.

• In orchestration prompt template, these attributes replace the $prompt_session_attributes$ placeholder variable. For more information, see Prompt template placeholder variables.

• In multi-agent collaboration, the promptSessionAttributes will only be used by supervisor agent when $prompt_session_attributes$ is present in prompt template.

Parameters:

promptSessionAttributes - Contains attributes that persist across a prompt and the values of those attributes.

• In orchestration prompt template, these attributes replace the $prompt_session_attributes$ placeholder variable. For more information, see Prompt template placeholder variables.

• In multi-agent collaboration, the promptSessionAttributes will only be used by supervisor agent when $prompt_session_attributes$ is present in prompt template.

Returns:

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

returnControlInvocationResults

SessionState.Builder returnControlInvocationResults(Collection<InvocationResultMember> returnControlInvocationResults)

Contains information about the results from the action group invocation. For more information, see Return control to the agent developer and Control session context.

If you include this field, the inputText field will be ignored.

Parameters:

returnControlInvocationResults - Contains information about the results from the action group invocation. For more information, see Return control to the agent developer and Control session context.

If you include this field, the inputText field will be ignored.

Returns:

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

returnControlInvocationResults

SessionState.Builder returnControlInvocationResults(InvocationResultMember... returnControlInvocationResults)

Contains information about the results from the action group invocation. For more information, see Return control to the agent developer and Control session context.

If you include this field, the inputText field will be ignored.

Parameters:

returnControlInvocationResults - Contains information about the results from the action group invocation. For more information, see Return control to the agent developer and Control session context.

If you include this field, the inputText field will be ignored.

Returns:

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

returnControlInvocationResults

SessionState.Builder returnControlInvocationResults(Consumer<InvocationResultMember.Builder>... returnControlInvocationResults)

Contains information about the results from the action group invocation. For more information, see Return control to the agent developer and Control session context.

If you include this field, the inputText field will be ignored.

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

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

Parameters:

returnControlInvocationResults - a consumer that will call methods on InvocationResultMember.Builder

Returns:

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

See Also:

• returnControlInvocationResults(java.util.Collection<InvocationResultMember>)

sessionAttributes

SessionState.Builder sessionAttributes(Map<String,String> sessionAttributes)

Contains attributes that persist across a session and the values of those attributes. If sessionAttributes are passed to a supervisor agent in multi-agent collaboration, it will be forwarded to all agent collaborators.

Parameters:

sessionAttributes - Contains attributes that persist across a session and the values of those attributes. If sessionAttributes are passed to a supervisor agent in multi-agent collaboration, it will be forwarded to all agent collaborators.

Returns:

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