BetaMemoryStoresOperations interface
Interface representing a BetaMemoryStores operations.
Properties
| create | Creates a memory store resource with the provided configuration. |
| create |
Creates a memory item in the specified memory store. |
| delete | Deletes the specified memory store. |
| delete |
Deletes the specified memory item from the memory store. |
| delete |
Deletes all memories in the specified memory store that are associated with the provided scope. |
| get | Retrieves the specified memory store and its current configuration. |
| get |
Retrieves the specified memory item from the memory store. |
| get |
Retrieves the status and result of a memory store update operation. |
| list | Returns the memory stores available to the caller. |
| list |
Returns memory items from the specified memory store. |
| search |
Searches the specified memory store for memories relevant to the provided conversation context. |
| update | Updates the specified memory store with the supplied configuration changes. |
| update |
Starts an update that writes conversation memories into the specified memory store. The operation returns a long-running status location for polling the update result. |
| update |
Updates the specified memory item in the memory store. |
Property Details
create
Creates a memory store resource with the provided configuration.
create: (name: string, definition: MemoryStoreDefinitionUnion, options?: BetaMemoryStoresCreateOptionalParams) => Promise<MemoryStore>Property Value
(name: string, definition: MemoryStoreDefinitionUnion, options?: BetaMemoryStoresCreateOptionalParams) => Promise<MemoryStore>
createMemory
Creates a memory item in the specified memory store.
createMemory: (name: string, scope: string, content: string, kind: MemoryItemKind, options?: BetaMemoryStoresCreateMemoryOptionalParams) => Promise<MemoryItemUnion>Property Value
(name: string, scope: string, content: string, kind: MemoryItemKind, options?: BetaMemoryStoresCreateMemoryOptionalParams) => Promise<MemoryItemUnion>
delete
Deletes the specified memory store.
delete: (name: string, options?: BetaMemoryStoresDeleteOptionalParams) => Promise<DeleteMemoryStoreResponse>Property Value
(name: string, options?: BetaMemoryStoresDeleteOptionalParams) => Promise<DeleteMemoryStoreResponse>
deleteMemory
Deletes the specified memory item from the memory store.
deleteMemory: (name: string, memoryId: string, options?: BetaMemoryStoresDeleteMemoryOptionalParams) => Promise<DeleteMemoryResponse>Property Value
(name: string, memoryId: string, options?: BetaMemoryStoresDeleteMemoryOptionalParams) => Promise<DeleteMemoryResponse>
deleteScope
Deletes all memories in the specified memory store that are associated with the provided scope.
deleteScope: (name: string, scope: string, options?: BetaMemoryStoresDeleteScopeOptionalParams) => Promise<MemoryStoreDeleteScopeResponse>Property Value
(name: string, scope: string, options?: BetaMemoryStoresDeleteScopeOptionalParams) => Promise<MemoryStoreDeleteScopeResponse>
get
Retrieves the specified memory store and its current configuration.
get: (name: string, options?: BetaMemoryStoresGetOptionalParams) => Promise<MemoryStore>Property Value
(name: string, options?: BetaMemoryStoresGetOptionalParams) => Promise<MemoryStore>
getMemory
Retrieves the specified memory item from the memory store.
getMemory: (name: string, memoryId: string, options?: BetaMemoryStoresGetMemoryOptionalParams) => Promise<MemoryItemUnion>Property Value
(name: string, memoryId: string, options?: BetaMemoryStoresGetMemoryOptionalParams) => Promise<MemoryItemUnion>
getUpdateResult
Retrieves the status and result of a memory store update operation.
getUpdateResult: (name: string, updateId: string, options?: BetaMemoryStoresGetUpdateResultOptionalParams) => Promise<MemoryStoreUpdateResponse>Property Value
(name: string, updateId: string, options?: BetaMemoryStoresGetUpdateResultOptionalParams) => Promise<MemoryStoreUpdateResponse>
list
Returns the memory stores available to the caller.
list: (options?: BetaMemoryStoresListOptionalParams) => PagedAsyncIterableIterator<MemoryStore, MemoryStore[], PageSettings>Property Value
(options?: BetaMemoryStoresListOptionalParams) => PagedAsyncIterableIterator<MemoryStore, MemoryStore[], PageSettings>
listMemories
Returns memory items from the specified memory store.
listMemories: (name: string, scope: string, options?: BetaMemoryStoresListMemoriesOptionalParams) => PagedAsyncIterableIterator<MemoryItemUnion, MemoryItemUnion[], PageSettings>Property Value
(name: string, scope: string, options?: BetaMemoryStoresListMemoriesOptionalParams) => PagedAsyncIterableIterator<MemoryItemUnion, MemoryItemUnion[], PageSettings>
searchMemories
Searches the specified memory store for memories relevant to the provided conversation context.
searchMemories: (name: string, scope: string, options?: BetaMemoryStoresSearchMemoriesOptionalParams) => Promise<MemoryStoreSearchResponse>Property Value
(name: string, scope: string, options?: BetaMemoryStoresSearchMemoriesOptionalParams) => Promise<MemoryStoreSearchResponse>
update
Updates the specified memory store with the supplied configuration changes.
update: (name: string, options?: BetaMemoryStoresUpdateOptionalParams) => Promise<MemoryStore>Property Value
(name: string, options?: BetaMemoryStoresUpdateOptionalParams) => Promise<MemoryStore>
updateMemories
Starts an update that writes conversation memories into the specified memory store. The operation returns a long-running status location for polling the update result.
updateMemories: (name: string, scope: string, options?: BetaMemoryStoresUpdateMemoriesOptionalParams) => PollerLike<OperationState<MemoryStoreUpdateCompletedResult>, MemoryStoreUpdateCompletedResult>Property Value
(name: string, scope: string, options?: BetaMemoryStoresUpdateMemoriesOptionalParams) => PollerLike<OperationState<MemoryStoreUpdateCompletedResult>, MemoryStoreUpdateCompletedResult>
updateMemory
Updates the specified memory item in the memory store.
updateMemory: (name: string, memoryId: string, content: string, options?: BetaMemoryStoresUpdateMemoryOptionalParams) => Promise<MemoryItemUnion>Property Value
(name: string, memoryId: string, content: string, options?: BetaMemoryStoresUpdateMemoryOptionalParams) => Promise<MemoryItemUnion>