Share via

MemorySearchTool Class

Definition

Namespace:
Azure.AI.AgentServer.Contracts.Generated.MemoryStore
Assembly:
Azure.AI.AgentServer.Contracts.dll
Package:
Azure.AI.AgentServer.Contracts v1.0.0-beta.4
Source:
MemorySearchTool.cs

A tool for integrating memories into the agent.

public class MemorySearchTool : Azure.AI.AgentServer.Contracts.Generated.OpenAI.Tool, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.MemoryStore.MemorySearchTool>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.MemoryStore.MemorySearchTool>
type MemorySearchTool = class
    inherit Tool
    interface IUtf8JsonSerializable
    interface IJsonModel<MemorySearchTool>
    interface IPersistableModel<MemorySearchTool>
Public Class MemorySearchTool
Inherits Tool
Implements IJsonModel(Of MemorySearchTool), IPersistableModel(Of MemorySearchTool)
Inheritance
Object
Tool
MemorySearchTool
Implements
IUtf8JsonSerializable IJsonModel<MemorySearchTool> IPersistableModel<MemorySearchTool> IPersistableModel<T>

Constructors

Name Description
MemorySearchTool()

Initializes a new instance of MemorySearchTool for deserialization.
MemorySearchTool(String, String)

Initializes a new instance of MemorySearchTool.
MemorySearchTool(ToolType, IDictionary<String,BinaryData>, String, String, MemorySearchOptions, Nullable<TimeSpan>)

Initializes a new instance of MemorySearchTool.

Properties

Name Description
MemoryStoreId

The ID 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.
SearchOptions

Options for searching the memory store.
Type

Gets or sets the type.

(Inherited from Tool)
UpdateDelay

The amount of time to wait after inactivity before updating memories with messages from the call (e.g., '0s', '5m'). Defaults to '60s'.

Methods

Name Description
DeserializeMemorySearchTool(JsonElement, ModelReaderWriterOptions)
FromResponse(Response)

Deserializes the model from a raw response.
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
ToRequestContent()

Convert into a RequestContent.

Explicit Interface Implementations

Name Description
IJsonModel<MemorySearchTool>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<MemorySearchTool>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IJsonModel<Tool>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from Tool)
IJsonModel<Tool>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from Tool)
IPersistableModel<MemorySearchTool>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<MemorySearchTool>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<MemorySearchTool>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.
IPersistableModel<Tool>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from Tool)
IPersistableModel<Tool>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from Tool)
IPersistableModel<Tool>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from Tool)
IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to