UpdateMemoriesRequest Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The UpdateMemoriesRequest.
public class UpdateMemoriesRequest : Azure.AI.AgentServer.Contracts.Generated.Common.IUtf8JsonSerializable, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.MemoryStore.UpdateMemoriesRequest>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.MemoryStore.UpdateMemoriesRequest>type UpdateMemoriesRequest = class
interface IUtf8JsonSerializable
interface IJsonModel<UpdateMemoriesRequest>
interface IPersistableModel<UpdateMemoriesRequest>Public Class UpdateMemoriesRequest
Implements IJsonModel(Of UpdateMemoriesRequest), IPersistableModel(Of UpdateMemoriesRequest), IUtf8JsonSerializable- Inheritance
-
UpdateMemoriesRequest
- Implements
Constructors
| Name | Description |
|---|---|
| UpdateMemoriesRequest() |
Initializes a new instance of UpdateMemoriesRequest for deserialization. |
| UpdateMemoriesRequest(String, String, IReadOnlyList<ItemParam>, String, Nullable<Int32>, IDictionary<String,BinaryData>) |
Initializes a new instance of UpdateMemoriesRequest. |
| UpdateMemoriesRequest(String) |
Initializes a new instance of UpdateMemoriesRequest. |
Properties
| Name | Description |
|---|---|
| ConversationId |
The conversation ID from which to extract memories. Only one of conversation_id or items should be provided. |
| Items |
Conversation items from which to extract memories. Only one of conversation_id or items should be provided. Please note ItemParam is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ResponsesAssistantMessageItemParam, CodeInterpreterToolCallItemParam, ComputerToolCallItemParam, ComputerToolCallOutputItemParam, ResponsesDeveloperMessageItemParam, FileSearchToolCallItemParam, FunctionToolCallItemParam, FunctionToolCallOutputItemParam, ImageGenToolCallItemParam, ItemReferenceItemParam, LocalShellToolCallItemParam, LocalShellToolCallOutputItemParam, MCPApprovalRequestItemParam, MCPApprovalResponseItemParam, MCPCallItemParam, MCPListToolsItemParam, MemorySearchToolCallItemParam, ResponsesMessageItemParam, ReasoningItemParam, ResponsesSystemMessageItemParam, ResponsesUserMessageItemParam and WebSearchToolCallItemParam. |
| PreviousUpdateId |
The unique ID of the previous update request, enabling incremental memory updates from where the last operation left off. Cannot be used together with conversation_id. |
| Scope |
The namespace that logically groups and isolates memories, such as a user ID. |
| UpdateDelay |
Timeout period before processing the memory update in seconds. If a new update request is received during this period, it will cancel the current request and reset the timeout. Set to 0 to immediately trigger the update without delay. Defaults to 300 (5 minutes). |
Methods
| Name | Description |
|---|---|
| DeserializeUpdateMemoriesRequest(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<UpdateMemoriesRequest>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<UpdateMemoriesRequest>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<UpdateMemoriesRequest>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<UpdateMemoriesRequest>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<UpdateMemoriesRequest>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
| IUtf8JsonSerializable.Write(Utf8JsonWriter) | |
