AIProjectMemoryStores.GetMemory Method
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.
Overloads
| Name | Description |
|---|---|
| GetMemory(String, String, RequestOptions) |
[Protocol Method] Retrieve a memory item from a memory store.
|
| GetMemory(String, String, CancellationToken) |
Retrieve a memory item from a memory store. |
GetMemory(String, String, RequestOptions)
- Source:
- AIProjectMemoryStores.cs
[Protocol Method] Retrieve a memory item from a memory store.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual System.ClientModel.ClientResult GetMemory(string name, string memoryId, System.ClientModel.Primitives.RequestOptions options);abstract member GetMemory : string * string * System.ClientModel.Primitives.RequestOptions -> System.ClientModel.ClientResult
override this.GetMemory : string * string * System.ClientModel.Primitives.RequestOptions -> System.ClientModel.ClientResultPublic Overridable Function GetMemory (name As String, memoryId As String, options As RequestOptions) As ClientResultParameters
- name
- String
The name of the memory store.
- memoryId
- String
The ID of the memory item to retrieve.
- options
- RequestOptions
The request options, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The response returned from the service.
Exceptions
name or memoryId is null.
name or memoryId is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Applies to
GetMemory(String, String, CancellationToken)
- Source:
- AIProjectMemoryStores.cs
Retrieve a memory item from a memory store.
public virtual System.ClientModel.ClientResult<Azure.AI.Projects.Memory.MemoryItem> GetMemory(string name, string memoryId, System.Threading.CancellationToken cancellationToken = default);abstract member GetMemory : string * string * System.Threading.CancellationToken -> System.ClientModel.ClientResult<Azure.AI.Projects.Memory.MemoryItem>
override this.GetMemory : string * string * System.Threading.CancellationToken -> System.ClientModel.ClientResult<Azure.AI.Projects.Memory.MemoryItem>Public Overridable Function GetMemory (name As String, memoryId As String, Optional cancellationToken As CancellationToken = Nothing) As ClientResult(Of MemoryItem)Parameters
- name
- String
The name of the memory store.
- memoryId
- String
The ID of the memory item to retrieve.
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
Exceptions
name or memoryId is null.
name or memoryId is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
