Class SessionState

java.lang.Object
software.amazon.awssdk.services.bedrockagentruntime.model.SessionState
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SessionState.Builder,SessionState>
@Generated("software.amazon.awssdk:codegen") public final class SessionState extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SessionState.Builder,SessionState>

Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a Lambda function for an action group or pass them when making an InvokeAgent request. Use session state attributes to control and provide conversational context for your agent and to help customize your agent's behavior. For more information, see Control session context.

See Also:

  • Method Details

    • conversationHistory

      public final ConversationHistory conversationHistory()

      The state's conversation history.

      Returns:
      The state's conversation history.

    • hasFiles

      public final boolean hasFiles()
      For responses, this returns true if the service returned a value for the Files 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.

    • files

      public final List<InputFile> files()

      Contains information about the files used by code interpreter.

      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 hasFiles() method.

      Returns:
      Contains information about the files used by code interpreter.

    • invocationId

      public final 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.

      Returns:
      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.

    • hasKnowledgeBaseConfigurations

      public final boolean hasKnowledgeBaseConfigurations()
      For responses, this returns true if the service returned a value for the KnowledgeBaseConfigurations 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.

    • knowledgeBaseConfigurations

      public final List<KnowledgeBaseConfiguration> knowledgeBaseConfigurations()

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

      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 hasKnowledgeBaseConfigurations() method.

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

    • hasPromptSessionAttributes

      public final boolean hasPromptSessionAttributes()
      For responses, this returns true if the service returned a value for the PromptSessionAttributes 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.

    • promptSessionAttributes

      public final 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.

      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 hasPromptSessionAttributes() method.

      Returns:
      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.

    • hasReturnControlInvocationResults

      public final boolean hasReturnControlInvocationResults()
      For responses, this returns true if the service returned a value for the ReturnControlInvocationResults 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.

    • returnControlInvocationResults

      public final List<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.

      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 hasReturnControlInvocationResults() method.

      Returns:
      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.

    • hasSessionAttributes

      public final boolean hasSessionAttributes()
      For responses, this returns true if the service returned a value for the SessionAttributes 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.

    • sessionAttributes

      public final 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.

      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 hasSessionAttributes() method.

      Returns:
      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.

    • toBuilder

      public SessionState.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SessionState.Builder,SessionState>
      Returns:
      a builder for type T

    • builder

      public static SessionState.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SessionState.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.