MemorySearchTool interface

Package:

@azure/ai-projects

A tool for integrating memories into the agent.

Extends

Tool

Properties

memory_store_name	The name of the memory store to use.
scope	The namespace used to group and isolate memories, such as a user ID. Limits which memories can be retrieved or updated. Use special variable {{$userId}} to scope memories to the current signed-in user.
search_options	Options for searching the memory store.
type	The type of the tool. Always memory_search.
update_delay	Time to wait before updating memories after inactivity (seconds). Default 300.

Property Details

memory_store_name

The name of the memory store to use.

memory_store_name: string

Property Value

string

scope

The namespace used to group and isolate memories, such as a user ID. Limits which memories can be retrieved or updated. Use special variable {{$userId}} to scope memories to the current signed-in user.

scope: string

Property Value

string

search_options

Options for searching the memory store.

search_options?: MemorySearchOptions

Property Value

MemorySearchOptions

type

The type of the tool. Always memory_search.

type: "memory_search"

Property Value

"memory_search"

update_delay

Time to wait before updating memories after inactivity (seconds). Default 300.

update_delay?: number

Property Value

number