ProjectsAgentsModelFactory.MemorySearchPreviewTool Method

Definition

Namespace:

Azure.AI.Projects.Agents

Assembly:

Azure.AI.Projects.Agents.dll

Package:

Azure.AI.Projects.Agents v2.1.0-beta.3

Source:

ProjectsAgentsModelFactory.cs

A tool for integrating memories into the agent.

public static Azure.AI.Projects.Agents.MemorySearchPreviewTool MemorySearchPreviewTool(string name = default, string description = default, System.Collections.Generic.IDictionary<string,Azure.AI.Projects.Agents.ToolConfig> toolConfigs = default, string memoryStoreName = default, string scope = default, Azure.AI.Projects.Agents.MemorySearchToolOptions searchOptions = default, int? updateDelayInSecs = default);

static member MemorySearchPreviewTool : string * string * System.Collections.Generic.IDictionary<string, Azure.AI.Projects.Agents.ToolConfig> * string * string * Azure.AI.Projects.Agents.MemorySearchToolOptions * Nullable<int> -> Azure.AI.Projects.Agents.MemorySearchPreviewTool

Public Shared Function MemorySearchPreviewTool (Optional name As String = Nothing, Optional description As String = Nothing, Optional toolConfigs As IDictionary(Of String, ToolConfig) = Nothing, Optional memoryStoreName As String = Nothing, Optional scope As String = Nothing, Optional searchOptions As MemorySearchToolOptions = Nothing, Optional updateDelayInSecs As Nullable(Of Integer) = Nothing) As MemorySearchPreviewTool

Parameters

name

String

Optional user-defined name for this tool or configuration.

description

String

Optional user-defined description for this tool or configuration.

toolConfigs

IDictionary<String,ToolConfig>

Per-tool configuration map. Keys are tool names or * (catch-all default). Resolution order: exact tool name match takes priority over *. Unknown tool names are silently ignored at runtime.

memoryStoreName

String

The name of the memory store to use.

scope

String

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.

searchOptions

MemorySearchToolOptions

Options for searching the memory store.

updateDelayInSecs

Nullable<Int32>

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

Returns

MemorySearchPreviewTool

A new MemorySearchPreviewTool instance for mocking.