AIProjectMemoryStores.GetMemories 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.
List all memory items in a memory store.
public virtual System.ClientModel.CollectionResult<Azure.AI.Projects.Memory.MemoryItem> GetMemories(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 GetMemories : string * string * Nullable<Azure.AI.Projects.Memory.MemoryItemKind> * Nullable<int> * Nullable<Azure.AI.Projects.Memory.MemoryStoreListOrder> * string * string * System.Threading.CancellationToken -> System.ClientModel.CollectionResult<Azure.AI.Projects.Memory.MemoryItem>
override this.GetMemories : string * string * Nullable<Azure.AI.Projects.Memory.MemoryItemKind> * Nullable<int> * Nullable<Azure.AI.Projects.Memory.MemoryStoreListOrder> * string * string * System.Threading.CancellationToken -> System.ClientModel.CollectionResult<Azure.AI.Projects.Memory.MemoryItem>Public Overridable Function GetMemories (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 CollectionResult(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.
