MemoryStoresOperations interface

Package:

@azure/ai-projects

Interface representing a MemoryStores operations.

Properties

create	Create a memory store.
delete	Delete a memory store.
deleteScope	Delete all memories associated with a specific scope from a memory store.
get	Retrieve a memory store.
getUpdateResult	Get memory store update result.
list	List all memory stores.
searchMemories	Search for relevant memories from a memory store based on conversation context.
update	Update a memory store.
updateMemories	Update memory store with conversation memories.

Property Details

create

Create a memory store.

create: (name: string, definition: MemoryStoreDefinitionUnion, options?: MemoryStoresCreateMemoryStoreOptionalParams) => Promise<MemoryStore>

Property Value

(name: string, definition: MemoryStoreDefinitionUnion, options?: MemoryStoresCreateMemoryStoreOptionalParams) => Promise<MemoryStore>

delete

Delete a memory store.

delete: (name: string, options?: MemoryStoresDeleteMemoryStoreOptionalParams) => Promise<DeleteMemoryStoreResponse>

Property Value

(name: string, options?: MemoryStoresDeleteMemoryStoreOptionalParams) => Promise<DeleteMemoryStoreResponse>

deleteScope

Delete all memories associated with a specific scope from a memory store.

deleteScope: (name: string, scope: string, options?: MemoryStoresDeleteScopeOptionalParams) => Promise<MemoryStoreDeleteScopeResponse>

Property Value

(name: string, scope: string, options?: MemoryStoresDeleteScopeOptionalParams) => Promise<MemoryStoreDeleteScopeResponse>

get

Retrieve a memory store.

get: (name: string, options?: MemoryStoresGetMemoryStoreOptionalParams) => Promise<MemoryStore>

Property Value

(name: string, options?: MemoryStoresGetMemoryStoreOptionalParams) => Promise<MemoryStore>

getUpdateResult

Get memory store update result.

getUpdateResult: (name: string, updateId: string, options?: MemoryStoresGetUpdateResultOptionalParams) => Promise<MemoryStoreUpdateResponse>

Property Value

(name: string, updateId: string, options?: MemoryStoresGetUpdateResultOptionalParams) => Promise<MemoryStoreUpdateResponse>

list

List all memory stores.

list: (options?: MemoryStoresListMemoryStoresOptionalParams) => PagedAsyncIterableIterator<MemoryStore, MemoryStore[], PageSettings>

Property Value

(options?: MemoryStoresListMemoryStoresOptionalParams) => PagedAsyncIterableIterator<MemoryStore, MemoryStore[], PageSettings>

searchMemories

Search for relevant memories from a memory store based on conversation context.

searchMemories: (name: string, scope: string, options?: MemoryStoresSearchMemoriesOptionalParams) => Promise<MemoryStoreSearchResponse>

Property Value

(name: string, scope: string, options?: MemoryStoresSearchMemoriesOptionalParams) => Promise<MemoryStoreSearchResponse>

update

Update a memory store.

update: (name: string, options?: MemoryStoresUpdateMemoryStoreOptionalParams) => Promise<MemoryStore>

Property Value

(name: string, options?: MemoryStoresUpdateMemoryStoreOptionalParams) => Promise<MemoryStore>

updateMemories

Update memory store with conversation memories.

updateMemories: (name: string, scope: string, options?: MemoryStoresUpdateMemoriesOptionalParams) => PollerLike<OperationState<MemoryStoreUpdateCompletedResult>, MemoryStoreUpdateCompletedResult>

Property Value

(name: string, scope: string, options?: MemoryStoresUpdateMemoriesOptionalParams) => PollerLike<OperationState<MemoryStoreUpdateCompletedResult>, MemoryStoreUpdateCompletedResult>