AIProjectMemoryStores.GetMemoriesAsync 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 |
|---|---|
| GetMemoriesAsync(String, BinaryContent, String, Nullable<Int32>, String, String, String, RequestOptions) |
[Protocol Method] List all memory items in a memory store.
|
| GetMemoriesAsync(String, String, Nullable<MemoryItemKind>, Nullable<Int32>, Nullable<MemoryStoreListOrder>, String, String, CancellationToken) |
List all memory items in a memory store. |
GetMemoriesAsync(String, BinaryContent, String, Nullable<Int32>, String, String, String, RequestOptions)
- Source:
- AIProjectMemoryStores.cs
[Protocol Method] List all memory items in a memory store.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual System.ClientModel.Primitives.AsyncCollectionResult GetMemoriesAsync(string name, System.ClientModel.BinaryContent content, string kind = default, int? limit = default, string order = default, string after = default, string before = default, System.ClientModel.Primitives.RequestOptions options = default);abstract member GetMemoriesAsync : string * System.ClientModel.BinaryContent * string * Nullable<int> * string * string * string * System.ClientModel.Primitives.RequestOptions -> System.ClientModel.Primitives.AsyncCollectionResult
override this.GetMemoriesAsync : string * System.ClientModel.BinaryContent * string * Nullable<int> * string * string * string * System.ClientModel.Primitives.RequestOptions -> System.ClientModel.Primitives.AsyncCollectionResultPublic Overridable Function GetMemoriesAsync (name As String, content As BinaryContent, Optional kind As String = Nothing, Optional limit As Nullable(Of Integer) = Nothing, Optional order As String = Nothing, Optional after As String = Nothing, Optional before As String = Nothing, Optional options As RequestOptions = Nothing) As AsyncCollectionResultParameters
- name
- String
The name of the memory store.
- content
- BinaryContent
The content to send as the body of the request.
- kind
- String
The kind of the memory item.
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
- order
- String
Sort order by the created_at timestamp of the objects. asc for ascending order anddesc
for descending order.
- after
- String
A cursor for use in pagination. after is an object ID that defines your place in the list.
For instance, if you make a list request and receive 100 objects, ending with obj_foo, your
subsequent call can include after=obj_foo in order to fetch the next page of the list.
- before
- String
A cursor for use in pagination. before is an object ID that defines your place in the list.
For instance, if you make a list request and receive 100 objects, ending with obj_foo, your
subsequent call can include before=obj_foo in order to fetch the previous page of the list.
- 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 content is null.
name is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Applies to
GetMemoriesAsync(String, String, Nullable<MemoryItemKind>, Nullable<Int32>, Nullable<MemoryStoreListOrder>, String, String, CancellationToken)
- Source:
- AIProjectMemoryStores.cs
List all memory items in a memory store.
public virtual System.ClientModel.AsyncCollectionResult<Azure.AI.Projects.Memory.MemoryItem> GetMemoriesAsync(string name, string scope, Azure.AI.Projects.Memory.MemoryItemKind? kind = default, int? limit = default, Azure.AI.Projects.Memory.MemoryStoreListOrder? order = default, string after = default, string before = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetMemoriesAsync : string * string * Nullable<Azure.AI.Projects.Memory.MemoryItemKind> * Nullable<int> * Nullable<Azure.AI.Projects.Memory.MemoryStoreListOrder> * string * string * System.Threading.CancellationToken -> System.ClientModel.AsyncCollectionResult<Azure.AI.Projects.Memory.MemoryItem>
override this.GetMemoriesAsync : string * string * Nullable<Azure.AI.Projects.Memory.MemoryItemKind> * Nullable<int> * Nullable<Azure.AI.Projects.Memory.MemoryStoreListOrder> * string * string * System.Threading.CancellationToken -> System.ClientModel.AsyncCollectionResult<Azure.AI.Projects.Memory.MemoryItem>Public Overridable Function GetMemoriesAsync (name As String, scope As String, Optional kind As Nullable(Of MemoryItemKind) = Nothing, Optional limit As Nullable(Of Integer) = Nothing, Optional order As Nullable(Of MemoryStoreListOrder) = Nothing, Optional after As String = Nothing, Optional before As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncCollectionResult(Of MemoryItem)Parameters
- name
- String
The name of the memory store.
- scope
- String
The namespace that logically groups and isolates memories, such as a user ID.
- kind
- Nullable<MemoryItemKind>
The kind of the memory item.
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
- order
- Nullable<MemoryStoreListOrder>
Sort order by the created_at timestamp of the objects. asc for ascending order anddesc
for descending order.
- after
- String
A cursor for use in pagination. after is an object ID that defines your place in the list.
For instance, if you make a list request and receive 100 objects, ending with obj_foo, your
subsequent call can include after=obj_foo in order to fetch the next page of the list.
- before
- String
A cursor for use in pagination. before is an object ID that defines your place in the list.
For instance, if you make a list request and receive 100 objects, ending with obj_foo, your
subsequent call can include before=obj_foo in order to fetch the previous page of the list.
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
Exceptions
name is null.
name is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
