Interface AgenticRetrieveMemoryRetrievalConfig.Builder

All Superinterfaces:
Buildable, CopyableBuilder<AgenticRetrieveMemoryRetrievalConfig.Builder,AgenticRetrieveMemoryRetrievalConfig>, SdkBuilder<AgenticRetrieveMemoryRetrievalConfig.Builder,AgenticRetrieveMemoryRetrievalConfig>, SdkPojo
Enclosing class:
AgenticRetrieveMemoryRetrievalConfig
@Mutable @NotThreadSafe public static interface AgenticRetrieveMemoryRetrievalConfig.Builder extends SdkPojo, CopyableBuilder<AgenticRetrieveMemoryRetrievalConfig.Builder,AgenticRetrieveMemoryRetrievalConfig>

  • Method Details

    • metadataFilters

      AgenticRetrieveMemoryRetrievalConfig.Builder metadataFilters(Collection<AgenticRetrieveMemoryMetadataFilter> metadataFilters)

      The metadata filter expressions that restrict retrieval to matching memory records. You can specify a maximum of 5 expressions.

      Parameters:
      metadataFilters - The metadata filter expressions that restrict retrieval to matching memory records. You can specify a maximum of 5 expressions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metadataFilters

      AgenticRetrieveMemoryRetrievalConfig.Builder metadataFilters(AgenticRetrieveMemoryMetadataFilter... metadataFilters)

      The metadata filter expressions that restrict retrieval to matching memory records. You can specify a maximum of 5 expressions.

      Parameters:
      metadataFilters - The metadata filter expressions that restrict retrieval to matching memory records. You can specify a maximum of 5 expressions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metadataFilters

      AgenticRetrieveMemoryRetrievalConfig.Builder metadataFilters(Consumer<AgenticRetrieveMemoryMetadataFilter.Builder>... metadataFilters)

      The metadata filter expressions that restrict retrieval to matching memory records. You can specify a maximum of 5 expressions.

      This is a convenience method that creates an instance of the AgenticRetrieveMemoryMetadataFilter.Builder avoiding the need to create one manually via AgenticRetrieveMemoryMetadataFilter.builder() .

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metadataFilters(List<AgenticRetrieveMemoryMetadataFilter>).

      Parameters:
      metadataFilters - a consumer that will call methods on AgenticRetrieveMemoryMetadataFilter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • namespace

      AgenticRetrieveMemoryRetrievalConfig.Builder namespace(String namespace)

      The namespace prefix to filter memory records by. The agent retrieves memory records in namespaces that start with the provided prefix. You must specify either namespace or namespacePath.

      Parameters:
      namespace - The namespace prefix to filter memory records by. The agent retrieves memory records in namespaces that start with the provided prefix. You must specify either namespace or namespacePath.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • namespacePath

      AgenticRetrieveMemoryRetrievalConfig.Builder namespacePath(String namespacePath)

      The parent namespace to use for hierarchical retrievals. The agent retrieves all memory records whose namespace falls under the same parent hierarchy. You must specify either namespace or namespacePath.

      Parameters:
      namespacePath - The parent namespace to use for hierarchical retrievals. The agent retrieves all memory records whose namespace falls under the same parent hierarchy. You must specify either namespace or namespacePath.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • strategyId

      AgenticRetrieveMemoryRetrievalConfig.Builder strategyId(String strategyId)

      The extraction strategy ID that restricts retrieval to memory records produced by a single strategy. Omit this parameter to retrieve records from every strategy on the memory resource.

      Parameters:
      strategyId - The extraction strategy ID that restricts retrieval to memory records produced by a single strategy. Omit this parameter to retrieve records from every strategy on the memory resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.