Interface MemoryStrategyConfiguration.Builder

  • Method Details

    • extractionPrompt

      MemoryStrategyConfiguration.Builder extractionPrompt(String extractionPrompt)

      Instructions that define what a CUSTOM strategy extracts, up to 30,720 characters. Required for a CUSTOM strategy: CreateSpace and UpdateSpace fail with ValidationException if a CUSTOM strategy has none.

      Only CUSTOM strategies use it. SEMANTIC and SUMMARY strategies always extract with the service's built-in instructions: the service accepts and stores a prompt on them, and GetSpace returns it, but extraction doesn't use it.

      Parameters:
      extractionPrompt - Instructions that define what a CUSTOM strategy extracts, up to 30,720 characters. Required for a CUSTOM strategy: CreateSpace and UpdateSpace fail with ValidationException if a CUSTOM strategy has none.

      Only CUSTOM strategies use it. SEMANTIC and SUMMARY strategies always extract with the service's built-in instructions: the service accepts and stores a prompt on them, and GetSpace returns it, but extraction doesn't use it.

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

      MemoryStrategyConfiguration.Builder extractEveryNMessages(Integer 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, and idleTimeoutSeconds is reached. The service then extracts them together in one pass.

      Parameters:
      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, and idleTimeoutSeconds is reached. The service then extracts them together in one pass.

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

      MemoryStrategyConfiguration.Builder extractEveryNTokens(Integer 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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • idleTimeoutSeconds

      MemoryStrategyConfiguration.Builder idleTimeoutSeconds(Integer 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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • extractionSeedTopK

      MemoryStrategyConfiguration.Builder extractionSeedTopK(Integer 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 and extractionSeedRecentN are both set, the two sets of memories are combined without duplicates.

      Parameters:
      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 and extractionSeedRecentN are both set, the two sets of memories are combined without duplicates.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • extractionSeedRecentN

      MemoryStrategyConfiguration.Builder extractionSeedRecentN(Integer 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 SUMMARY strategy when neither seed setting is given. When this and extractionSeedTopK are both set, the two sets of memories are combined without duplicates.

      Parameters:
      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 SUMMARY strategy when neither seed setting is given. When this and extractionSeedTopK are both set, the two sets of memories are combined without duplicates.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • consolidationEnabled

      MemoryStrategyConfiguration.Builder consolidationEnabled(Boolean 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 SEMANTIC and SUMMARY, off for CUSTOM.

      Parameters:
      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 SEMANTIC and SUMMARY, off for CUSTOM.

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