MemoryStores
List MemoryStores
Retrieves a paginated list of memory stores in the workspace. Use cursor-based pagination parameters to navigate through the results.from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.memory_stores.list(limit=10)
# Handle response
print(res)
Show Parameters
Show Parameters
A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 10
A cursor for use in pagination.
starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with 01JJ1HDHN79XAS7A01WB3HYSDB, your subsequent call can include after=01JJ1HDHN79XAS7A01WB3HYSDB in order to fetch the next page of the list.Show Response
Show Response
Show Properties of data
Show Properties of data
The unique identifier of the memory store
The unique key of the memory store. The key is unique and inmmutable and cannot be repeated within the same workspace.
The description of the memory store. Be as precise as possible to help the AI to understand the purpose of the memory store.
The user ID of the creator
The user ID of the last updater
The creation date of the memory store
The last update date of the memory store
The default time to live of every memory document created within the memory store. Useful to control if the documents in the memory should be store for short or long term.
Create a MemoryStore
Create memory storefrom orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.memory_stores.create(request={
"key": "<key>",
"embedding_config": {
"model": "cohere/embed-multilingual-light-v3.0",
},
"description": "unlike excluding soulful quirkily hmph baseboard whereas gee deserted",
"path": "Default",
})
# Handle response
print(res)
Show Parameters
Show Parameters
The unique key of the memory store. The key is unique and inmmutable and cannot be repeated within the same workspace.
The description of the memory store. Be as precise as possible to help the AI to understand the purpose of the memory store.
The default time to live of every memory document created within the memory store. Useful to control if the documents in the memory should be store for short or long term.
Show Response
Show Response
The unique identifier of the memory store
The unique key of the memory store. The key is unique and inmmutable and cannot be repeated within the same workspace.
The description of the memory store. Be as precise as possible to help the AI to understand the purpose of the memory store.
The user ID of the creator
The user ID of the last updater
The creation date of the memory store
The last update date of the memory store
The default time to live of every memory document created within the memory store. Useful to control if the documents in the memory should be store for short or long term.
Retrieve a MemoryStore
Retrieves detailed information about a specific memory store, including its configuration and metadata.from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.memory_stores.retrieve(memory_store_key="<value>")
# Handle response
print(res)
Show Parameters
Show Parameters
The request object to use for the request.
Show Response
Show Response
The unique identifier of the memory store
The unique key of the memory store. The key is unique and inmmutable and cannot be repeated within the same workspace.
The description of the memory store. Be as precise as possible to help the AI to understand the purpose of the memory store.
The user ID of the creator
The user ID of the last updater
The creation date of the memory store
The last update date of the memory store
The default time to live of every memory document created within the memory store. Useful to control if the documents in the memory should be store for short or long term.
Update a MemoryStore
Update the memory store configurationfrom orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.memory_stores.update(memory_store_key="<value>", description="wherever cash since now exempt proliferate aha tabulate ack", path="Default")
# Handle response
print(res)
Show Parameters
Show Parameters
The unique key identifier of the memory store
Show Response
Show Response
The unique identifier of the memory store
The unique key of the memory store. The key is unique and inmmutable and cannot be repeated within the same workspace.
The description of the memory store. Be as precise as possible to help the AI to understand the purpose of the memory store.
The user ID of the creator
The user ID of the last updater
The creation date of the memory store
The last update date of the memory store
The default time to live of every memory document created within the memory store. Useful to control if the documents in the memory should be store for short or long term.
Delete a MemoryStore
Permanently delete a memory store, including memories and documents.from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
orq.memory_stores.delete(memory_store_key="<value>")
# Use the SDK ...
Show Parameters
Show Parameters
The request object to use for the request.
List Memories
Retrieves a paginated list of memories for the memory storefrom orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.memory_stores.list_memories(memory_store_key="<value>", limit=10)
# Handle response
print(res)
Show Parameters
Show Parameters
The unique key identifier of the memory store
A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 10
A cursor for use in pagination.
starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with 01JJ1HDHN79XAS7A01WB3HYSDB, your subsequent call can include after=01JJ1HDHN79XAS7A01WB3HYSDB in order to fetch the next page of the list.A cursor for use in pagination.
ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with 01JJ1HDHN79XAS7A01WB3HYSDB, your subsequent call can include before=01JJ1HDHN79XAS7A01WB3HYSDB in order to fetch the previous page of the list.Show Response
Show Response
Show Properties of data
Show Properties of data
Unique identifier for the memory. This is automatically generated by the system.
Customer provided entity ID for the memory. This is used to link the memory to a specific user/company/session/etc. Has to be unique within the memory store.
Create Memory
Creates a new memory in the specified memory store.from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.memory_stores.create_memory(memory_store_key="<value>", entity_id="<id>")
# Handle response
print(res)
Show Parameters
Show Parameters
The unique key identifier of the memory store
Show Response
Show Response
Unique identifier for the memory. This is automatically generated by the system.
Customer provided entity ID for the memory. This is used to link the memory to a specific user/company/session/etc. Has to be unique within the memory store.
Retrieve Memory
Retrieves details of a specific memory by its IDfrom orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.memory_stores.retrieve_memory(memory_store_key="<value>", memory_entity_id="<id>")
# Handle response
print(res)
Show Parameters
Show Parameters
The unique key identifier of the memory store
Show Response
Show Response
Unique identifier for the memory. This is automatically generated by the system.
Customer provided entity ID for the memory. This is used to link the memory to a specific user/company/session/etc. Has to be unique within the memory store.
Update Memory
Updates the details of a specific memory.from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.memory_stores.update_memory(memory_store_key="<value>", memory_entity_id="<id>")
# Handle response
print(res)
Show Parameters
Show Parameters
Show Response
Show Response
Unique identifier for the memory. This is automatically generated by the system.
Customer provided entity ID for the memory. This is used to link the memory to a specific user/company/session/etc. Has to be unique within the memory store.
Delete Memory
Permanently deletes a specific memory. Use this endpoint to:- Remove a memory from the store
- Clean up unused memories
- Manage memory storage space
from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
orq.memory_stores.delete_memory(memory_store_key="<value>", memory_entity_id="<id>")
# Use the SDK ...
Show Parameters
Show Parameters
The unique key identifier of the memory store
List Documents
Retrieves a paginated list of documents associated with a specific memory.from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.memory_stores.list_documents(memory_store_key="<value>", memory_entity_id="<id>", limit=10)
# Handle response
print(res)
Show Parameters
Show Parameters
The unique key identifier of the memory store
The unique identifier of the memory
A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 10
A cursor for use in pagination.
starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with 01JJ1HDHN79XAS7A01WB3HYSDB, your subsequent call can include after=01JJ1HDHN79XAS7A01WB3HYSDB in order to fetch the next page of the list.A cursor for use in pagination.
ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with 01JJ1HDHN79XAS7A01WB3HYSDB, your subsequent call can include before=01JJ1HDHN79XAS7A01WB3HYSDB in order to fetch the previous page of the list.Filter documents updated after this ISO datetime
Show Response
Show Response
Create Document
Creates a new document in the specified memory.from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.memory_stores.create_document(memory_store_key="<value>", memory_entity_id="<id>", text="<value>")
# Handle response
print(res)
Show Parameters
Show Parameters
Show Response
Show Response
Retrieve Document
Retrieves details of a specific memory document by its ID.from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.memory_stores.retrieve_document(memory_store_key="<value>", memory_entity_id="<id>", document_id="<id>")
# Handle response
print(res)
Show Parameters
Show Parameters
Show Response
Show Response
Update Document
Updates the details of a specific memory document.from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.memory_stores.update_document(memory_store_key="<value>", memory_entity_id="<id>", document_id="<id>")
# Handle response
print(res)
Show Parameters
Show Parameters
Show Response
Show Response
Delete Document
Permanently deletes a specific memory document. Use this endpoint to:- Remove a document from a memory
- Clean up unused documents
- Manage document storage space
from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
orq.memory_stores.delete_document(memory_store_key="<value>", memory_entity_id="<id>", document_id="<id>")
# Use the SDK ...