Share via


MemorySearchTool Class

Definition

A tool for integrating memories into the agent.

public class MemorySearchTool : Azure.AI.Projects.OpenAI.AgentTool, System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.OpenAI.MemorySearchTool>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.OpenAI.MemorySearchTool>
type MemorySearchTool = class
    inherit AgentTool
    interface IJsonModel<MemorySearchTool>
    interface IPersistableModel<MemorySearchTool>
Public Class MemorySearchTool
Inherits AgentTool
Implements IJsonModel(Of MemorySearchTool), IPersistableModel(Of MemorySearchTool)
Inheritance
MemorySearchTool
Implements

Constructors

Name Description
MemorySearchTool(String, String)

Initializes a new instance of MemorySearchTool.

Properties

Name Description
MemoryStoreName

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.

SearchOptions

Options for searching the memory store.

UpdateDelay

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

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<AgentTool>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from AgentTool)
IJsonModel<AgentTool>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from AgentTool)
IJsonModel<MemorySearchTool>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<MemorySearchTool>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<AgentTool>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from AgentTool)
IPersistableModel<AgentTool>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from AgentTool)
IPersistableModel<AgentTool>.Write(ModelReaderWriterOptions) (Inherited from AgentTool)
IPersistableModel<MemorySearchTool>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<MemorySearchTool>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<MemorySearchTool>.Write(ModelReaderWriterOptions)

Applies to