Package software.amazon.awssdk.services.bedrockagentruntime.model

Interface SessionState.Builder

All Superinterfaces:

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

Enclosing class:

SessionState

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

Method Summary

Modifier and Type	Method	Description
SessionState.Builder	invocationId(String invocationId)	The identifier of the invocation of an action.
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, sdkFields

Method Details

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.

promptSessionAttributes

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

Contains attributes that persist across a prompt and the values of those attributes. These attributes replace the $prompt_session_attributes$ placeholder variable in the orchestration prompt template. For more information, see Prompt template placeholder variables.

Parameters:

promptSessionAttributes - Contains attributes that persist across a prompt and the values of those attributes. These attributes replace the $prompt_session_attributes$ placeholder variable in the orchestration prompt template. For more information, see Prompt template placeholder variables.

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.

Parameters:

sessionAttributes - Contains attributes that persist across a session and the values of those attributes.

Returns:

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