MemorySearchOptions Class

Definition

Namespace:

Azure.AI.Projects.Memory

Assembly:

Azure.AI.Projects.dll

Package:

Azure.AI.Projects v2.0.1

Source:

MemorySearchOptions.cs

Options that describe a memory-store search request.

public class MemorySearchOptions : System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.Memory.MemorySearchOptions>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.Memory.MemorySearchOptions>

type MemorySearchOptions = class
    interface IJsonModel<MemorySearchOptions>
    interface IPersistableModel<MemorySearchOptions>

Public Class MemorySearchOptions
Implements IJsonModel(Of MemorySearchOptions), IPersistableModel(Of MemorySearchOptions)

Inheritance

Object

MemorySearchOptions

Implements

IJsonModel<MemorySearchOptions> IPersistableModel<MemorySearchOptions> IPersistableModel<T>

Constructors

Name	Description
MemorySearchOptions(String)	Initializes a new instance of MemorySearchOptions.

Properties

Name	Description
Items	The conversation items used as context for the search.
PreviousSearchId	The identifier of the previous search, used to continue or refine a prior search.
ResultOptions	Options controlling how the search results are shaped (limits, ranking, etc.).
Scope	The scope (for example, user or session identifier) that partitions the memory store.

Explicit Interface Implementations

Name	Description
IJsonModel<MemorySearchOptions>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<MemorySearchOptions>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<MemorySearchOptions>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<MemorySearchOptions>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<MemorySearchOptions>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.