beta_memory_stores

Creates, updates, deletes, gets or lists a beta_memory_stores resource.

Overview

Name	beta_memory_stores
Type	Resource
Id	azure.ai_projects.beta_memory_stores

Fields

The following fields are returned by SELECT queries:

get_memory

Name	Datatype	Description
memory_id	string	The unique ID of the memory item. Required.
content	string	The content of the memory. Required.
kind	string	The kind of the memory item. Required. Known values are: "user_profile", "chat_summary", and "procedural".
scope	string	The namespace that logically groups and isolates memories, such as a user ID. Required.
updated_at	string (date-time)	The last update time of the memory item. Required.

get

Name	Datatype	Description
id	string	The unique identifier of the memory store. Required.
name	string	The name of the memory store. Required.
created_at	string (date-time)	The Unix timestamp (seconds) when the memory store was created. Required.
definition	object	The definition of the memory store. Required.
description	string	A human-readable description of the memory store.
metadata	object	Arbitrary key-value metadata to associate with the memory store.
object	string	The object type, which is always 'memory_store'. Required. MEMORY_STORE.
updated_at	string (date-time)	The Unix timestamp (seconds) when the memory store was last updated. Required.

list

Name	Datatype	Description
id	string	The unique identifier of the memory store. Required.
name	string	The name of the memory store. Required.
created_at	string (date-time)	The Unix timestamp (seconds) when the memory store was created. Required.
definition	object	The definition of the memory store. Required.
description	string	A human-readable description of the memory store.
metadata	object	Arbitrary key-value metadata to associate with the memory store.
object	string	The object type, which is always 'memory_store'. Required. MEMORY_STORE.
updated_at	string (date-time)	The Unix timestamp (seconds) when the memory store was last updated. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_memory	select	name, memory_id, endpoint		Get a memory item. Retrieves the specified memory item from the memory store.
get	select	name, endpoint		Get a memory store. Retrieves the specified memory store and its current configuration.
list	select	endpoint	limit, order, after, before	List memory stores. Returns the memory stores available to the caller.
create	insert	endpoint		Create a memory store. Creates a memory store resource with the provided configuration.
delete	delete	name, endpoint		Delete a memory store. Deletes the specified memory store.
update	exec	name, endpoint		Update a memory store. Updates the specified memory store with the supplied configuration changes.
list_memories	exec	name, endpoint	kind, limit, order, after, before	List memory items. Returns memory items from the specified memory store.
update_memory	exec	name, memory_id, endpoint		Update a memory item. Updates the specified memory item in the memory store.
delete_memory	exec	name, memory_id, endpoint		Delete a memory item. Deletes the specified memory item from the memory store.
delete_scope	exec	name, endpoint		Delete memories by scope. Deletes all memories in the specified memory store that are associated with the provided scope.
create_memory	exec	name, endpoint		Create a memory item. Creates a memory item in the specified memory store.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
memory_id	string	The ID of the memory item to delete. Required.
name	string	The name of the memory store. Required.
after	string
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. Default value is None.
kind	string	The kind of the memory item. Known values are: "user_profile", "chat_summary", and "procedural". Default value is None.
limit	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. Default value is None.
order	string	Sort order by the created_at timestamp of the objects. asc for ascending order anddesc for descending order. Known values are: "asc" and "desc". Default value is None.

SELECT examples

get_memory

Get a memory item. Retrieves the specified memory item from the memory store.

SELECT
memory_id,
content,
kind,
scope,
updated_at
FROM azure.ai_projects.beta_memory_stores
WHERE name = '{{ name }}' -- required
AND memory_id = '{{ memory_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

get

Get a memory store. Retrieves the specified memory store and its current configuration.

SELECT
id,
name,
created_at,
definition,
description,
metadata,
object,
updated_at
FROM azure.ai_projects.beta_memory_stores
WHERE name = '{{ name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list

List memory stores. Returns the memory stores available to the caller.

SELECT
id,
name,
created_at,
definition,
description,
metadata,
object,
updated_at
FROM azure.ai_projects.beta_memory_stores
WHERE endpoint = '{{ endpoint }}' -- required
AND limit = '{{ limit }}'
AND order = '{{ order }}'
AND after = '{{ after }}'
AND before = '{{ before }}'
;

INSERT examples

create

Create a memory store. Creates a memory store resource with the provided configuration.

INSERT INTO azure.ai_projects.beta_memory_stores (
endpoint
)
SELECT 
'{{ endpoint }}'
RETURNING
id,
name,
created_at,
definition,
description,
metadata,
object,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: beta_memory_stores
props:
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the beta_memory_stores resource.

DELETE examples

delete

Delete a memory store. Deletes the specified memory store.

DELETE FROM azure.ai_projects.beta_memory_stores
WHERE name = '{{ name }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

update

Update a memory store. Updates the specified memory store with the supplied configuration changes.

EXEC azure.ai_projects.beta_memory_stores.update 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

list_memories

List memory items. Returns memory items from the specified memory store.

EXEC azure.ai_projects.beta_memory_stores.list_memories 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@kind='{{ kind }}', 
@limit='{{ limit }}', 
@order='{{ order }}', 
@after='{{ after }}', 
@before='{{ before }}'
;

update_memory

Update a memory item. Updates the specified memory item in the memory store.

EXEC azure.ai_projects.beta_memory_stores.update_memory 
@name='{{ name }}' --required, 
@memory_id='{{ memory_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

delete_memory

Delete a memory item. Deletes the specified memory item from the memory store.

EXEC azure.ai_projects.beta_memory_stores.delete_memory 
@name='{{ name }}' --required, 
@memory_id='{{ memory_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

delete_scope

Delete memories by scope. Deletes all memories in the specified memory store that are associated with the provided scope.

EXEC azure.ai_projects.beta_memory_stores.delete_scope 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

create_memory

Create a memory item. Creates a memory item in the specified memory store.

EXEC azure.ai_projects.beta_memory_stores.create_memory 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required
;