Class MemoryStrategyConfiguration
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<MemoryStrategyConfiguration.Builder,MemoryStrategyConfiguration>
Settings for a memory strategy. The defaults described here apply when you create a strategy. In
UpdateSpace, a member you omit for a kept strategy keeps its current value.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final BooleanSpecifies whether the strategy consolidates memories.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final IntegerExtract once this many messages have accumulated, from 1 to 1000.final IntegerExtract once this many tokens of conversation have accumulated, from 1 to 80,000, however few messages that takes.final StringInstructions that define what aCUSTOMstrategy extracts, up to 30,720 characters.final IntegerHow many of the strategy's most recent stored memories to include in the extraction prompt, from 0 to 20.final IntegerHow many of the strategy's stored memories that are most relevant to the conversation to include in the extraction prompt, from 0 to 20, to improve extraction and reduce duplicates.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()final IntegerExtract what has accumulated once the conversation has been idle for this many seconds, from 1 to 86,400.static Class<? extends MemoryStrategyConfiguration.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
extractionPrompt
Instructions that define what a
CUSTOMstrategy extracts, up to 30,720 characters. Required for aCUSTOMstrategy:CreateSpaceandUpdateSpacefail withValidationExceptionif aCUSTOMstrategy has none.Only
CUSTOMstrategies use it.SEMANTICandSUMMARYstrategies always extract with the service's built-in instructions: the service accepts and stores a prompt on them, andGetSpacereturns it, but extraction doesn't use it.- Returns:
- Instructions that define what a
CUSTOMstrategy extracts, up to 30,720 characters. Required for aCUSTOMstrategy:CreateSpaceandUpdateSpacefail withValidationExceptionif aCUSTOMstrategy has none.Only
CUSTOMstrategies use it.SEMANTICandSUMMARYstrategies always extract with the service's built-in instructions: the service accepts and stores a prompt on them, andGetSpacereturns it, but extraction doesn't use it.
-
extractEveryNMessages
Extract once this many messages have accumulated, from 1 to 1000. Lower values extract more often, in smaller batches. The default is 12.
Messages accumulate until the first of
extractEveryNMessages,extractEveryNTokens, andidleTimeoutSecondsis reached. The service then extracts them together in one pass.- Returns:
- Extract once this many messages have accumulated, from 1 to 1000. Lower values extract more often, in
smaller batches. The default is 12.
Messages accumulate until the first of
extractEveryNMessages,extractEveryNTokens, andidleTimeoutSecondsis reached. The service then extracts them together in one pass.
-
extractEveryNTokens
Extract once this many tokens of conversation have accumulated, from 1 to 80,000, however few messages that takes. Use it to bound how much text one extraction call carries when message sizes vary widely. Omit it to bound a batch only by
extractEveryNMessages,idleTimeoutSeconds, and the service's maximum batch size.- Returns:
- Extract once this many tokens of conversation have accumulated, from 1 to 80,000, however few messages
that takes. Use it to bound how much text one extraction call carries when message sizes vary widely.
Omit it to bound a batch only by
extractEveryNMessages,idleTimeoutSeconds, and the service's maximum batch size.
-
idleTimeoutSeconds
Extract what has accumulated once the conversation has been idle for this many seconds, from 1 to 86,400. The default is 60. This is what extracts the end of a conversation that stops. Raise it when the pauses in your conversations are longer than that, so that one exchange isn't split across several extraction passes.
- Returns:
- Extract what has accumulated once the conversation has been idle for this many seconds, from 1 to 86,400. The default is 60. This is what extracts the end of a conversation that stops. Raise it when the pauses in your conversations are longer than that, so that one exchange isn't split across several extraction passes.
-
extractionSeedTopK
How many of the strategy's stored memories that are most relevant to the conversation to include in the extraction prompt, from 0 to 20, to improve extraction and reduce duplicates. If you omit this or set it to 0, the service uses its default (see
extractionSeedRecentN). When this andextractionSeedRecentNare both set, the two sets of memories are combined without duplicates.- Returns:
- How many of the strategy's stored memories that are most relevant to the conversation to include in the
extraction prompt, from 0 to 20, to improve extraction and reduce duplicates. If you omit this or set it
to 0, the service uses its default (see
extractionSeedRecentN). When this andextractionSeedRecentNare both set, the two sets of memories are combined without duplicates.
-
extractionSeedRecentN
How many of the strategy's most recent stored memories to include in the extraction prompt, from 0 to 20. If you omit this or set it to 0, the service uses its default: no seeding for most strategy types, and the 10 most recent memories for a
SUMMARYstrategy when neither seed setting is given. When this andextractionSeedTopKare both set, the two sets of memories are combined without duplicates.- Returns:
- How many of the strategy's most recent stored memories to include in the extraction prompt, from 0 to 20.
If you omit this or set it to 0, the service uses its default: no seeding for most strategy types, and
the 10 most recent memories for a
SUMMARYstrategy when neither seed setting is given. When this andextractionSeedTopKare both set, the two sets of memories are combined without duplicates.
-
consolidationEnabled
Specifies whether the strategy consolidates memories. With consolidation, each new memory is compared with similar stored memories, and the service adds it, updates a stored memory, or skips it, so duplicate or contradicting facts don't accumulate. Without it, every extracted memory is stored as a new memory, which costs less and keeps a full history.
When omitted, the default depends on the strategy's type: on for
SEMANTICandSUMMARY, off forCUSTOM.- Returns:
- Specifies whether the strategy consolidates memories. With consolidation, each new memory is compared
with similar stored memories, and the service adds it, updates a stored memory, or skips it, so duplicate
or contradicting facts don't accumulate. Without it, every extracted memory is stored as a new memory,
which costs less and keeps a full history.
When omitted, the default depends on the strategy's type: on for
SEMANTICandSUMMARY, off forCUSTOM.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<MemoryStrategyConfiguration.Builder,MemoryStrategyConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-