Class AgenticRetrieveMemoryConfiguration

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

Specifies an AgentCore Memory resource and how this retrieval uses it. Set sessionBinding to restore and continue a session. Set retrievalConfigs to let the agent retrieve from long-term memory. You must specify at least one of the two.

See Also:

  • Method Details

    • memoryId

      public final String memoryId()

      The identifier of the AgentCore Memory resource to use. The resource must exist in your account and be in the ACTIVE state.

      Returns:
      The identifier of the AgentCore Memory resource to use. The resource must exist in your account and be in the ACTIVE state.

    • persistenceMode

      public final AgenticRetrieveMemoryPersistenceMode persistenceMode()

      Specifies whether the agent-generated answer is written back to the given short-term memory session, and applies only when sessionBinding is set. Valid values:

      • DEFAULT (default) – Specifies that the question and the agent-generated answer are persisted to the session as a single event. This value requires generateResponse to be true.

      • NONE – Specifies that the session is left unchanged.

      If the service returns an enum value that is not available in the current SDK version, persistenceMode will return AgenticRetrieveMemoryPersistenceMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from persistenceModeAsString().

      Returns:
      Specifies whether the agent-generated answer is written back to the given short-term memory session, and applies only when sessionBinding is set. Valid values:

      • DEFAULT (default) – Specifies that the question and the agent-generated answer are persisted to the session as a single event. This value requires generateResponse to be true.

      • NONE – Specifies that the session is left unchanged.

      See Also:

    • persistenceModeAsString

      public final String persistenceModeAsString()

      Specifies whether the agent-generated answer is written back to the given short-term memory session, and applies only when sessionBinding is set. Valid values:

      • DEFAULT (default) – Specifies that the question and the agent-generated answer are persisted to the session as a single event. This value requires generateResponse to be true.

      • NONE – Specifies that the session is left unchanged.

      If the service returns an enum value that is not available in the current SDK version, persistenceMode will return AgenticRetrieveMemoryPersistenceMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from persistenceModeAsString().

      Returns:
      Specifies whether the agent-generated answer is written back to the given short-term memory session, and applies only when sessionBinding is set. Valid values:

      • DEFAULT (default) – Specifies that the question and the agent-generated answer are persisted to the session as a single event. This value requires generateResponse to be true.

      • NONE – Specifies that the session is left unchanged.

      See Also:

    • hasRetrievalConfigs

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

    • retrievalConfigs

      public final List<AgenticRetrieveMemoryRetrievalConfig> retrievalConfigs()

      Specifies the long-term memory configuration the agent can retrieve from. The agent decides whether to retrieve and composes its own query. This field currently accepts at most one entry.

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

      Returns:
      Specifies the long-term memory configuration the agent can retrieve from. The agent decides whether to retrieve and composes its own query. This field currently accepts at most one entry.

    • sessionBinding

      public final AgenticRetrieveMemorySessionBinding sessionBinding()

      The short-term memory session whose history is restored for this retrieval. To persist the agent-generated answer to the session, omit persistenceMode or set it to DEFAULT. To leave the session unchanged, set persistenceMode to NONE. Supply session history through the existing messages parameter or through short-term memory, but not both.

      Returns:
      The short-term memory session whose history is restored for this retrieval. To persist the agent-generated answer to the session, omit persistenceMode or set it to DEFAULT. To leave the session unchanged, set persistenceMode to NONE. Supply session history through the existing messages parameter or through short-term memory, but not both.

    • toBuilder

      public AgenticRetrieveMemoryConfiguration.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<AgenticRetrieveMemoryConfiguration.Builder,AgenticRetrieveMemoryConfiguration>
      Returns:
      a builder for type T

    • builder

      public static AgenticRetrieveMemoryConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AgenticRetrieveMemoryConfiguration.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.