MemorySearchPreviewTool Class

Definition

A tool for integrating memories into the agent.

public class MemorySearchPreviewTool : Azure.AI.AgentServer.Responses.Models.Tool, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Responses.Models.MemorySearchPreviewTool>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Responses.Models.MemorySearchPreviewTool>
type MemorySearchPreviewTool = class
    inherit Tool
    interface IJsonModel<MemorySearchPreviewTool>
    interface IPersistableModel<MemorySearchPreviewTool>
Public Class MemorySearchPreviewTool
Inherits Tool
Implements IJsonModel(Of MemorySearchPreviewTool), IPersistableModel(Of MemorySearchPreviewTool)
Inheritance
MemorySearchPreviewTool
Implements

Constructors

Name Description
MemorySearchPreviewTool(String, String)

Initializes a new instance of MemorySearchPreviewTool.

Properties

Name Description
Description

Optional user-defined description for this tool or configuration.

MemoryStoreName

The name of the memory store to use.

Name

Optional user-defined name for this tool or configuration.

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<MemorySearchPreviewTool>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<MemorySearchPreviewTool>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IJsonModel<Tool>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from Tool)
IJsonModel<Tool>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from Tool)
IPersistableModel<MemorySearchPreviewTool>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<MemorySearchPreviewTool>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<MemorySearchPreviewTool>.Write(ModelReaderWriterOptions)
IPersistableModel<Tool>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from Tool)
IPersistableModel<Tool>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from Tool)
IPersistableModel<Tool>.Write(ModelReaderWriterOptions) (Inherited from Tool)

Applies to