Interface SessionState.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<SessionState.Builder,
,SessionState> SdkBuilder<SessionState.Builder,
,SessionState> SdkPojo
- Enclosing class:
SessionState
-
Method Summary
Modifier and TypeMethodDescriptioninvocationId
(String invocationId) The identifier of the invocation of an action.promptSessionAttributes
(Map<String, String> promptSessionAttributes) Contains attributes that persist across a prompt and the values of those attributes.returnControlInvocationResults
(Collection<InvocationResultMember> returnControlInvocationResults) Contains information about the results from the action group invocation.returnControlInvocationResults
(Consumer<InvocationResultMember.Builder>... returnControlInvocationResults) Contains information about the results from the action group invocation.returnControlInvocationResults
(InvocationResultMember... returnControlInvocationResults) Contains information about the results from the action group invocation.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
The identifier of the invocation of an action. This value must match the
invocationId
returned in theInvokeAgent
response for the action whose results are provided in thereturnControlInvocationResults
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 theinvocationId
returned in theInvokeAgent
response for the action whose results are provided in thereturnControlInvocationResults
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
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.InvocationResultMember.Builder
avoiding the need to create one manually viaInvocationResultMember.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toreturnControlInvocationResults(List<InvocationResultMember>)
.- Parameters:
returnControlInvocationResults
- a consumer that will call methods onInvocationResultMember.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-