Skip to content

memories

Classes

MemoriesClient 

MemoriesClient(client: OWUIClientBase)

Bases: ResourceBase

Client for the Memories endpoints.

Used by:
Source code in src/owui_client/client_base.py 
175
176
def __init__(self, client: OWUIClientBase):
    self._client = client

Functions

get_memories 
get_memories() -> List[MemoryModel]

Retrieve all memories associated with the authenticated user.

Returns:

Type Description
List[MemoryModel]

List[MemoryModel]: A list of the user's memories.
Source code in src/owui_client/routers/memories.py 
16
17
18
19
20
21
22
23
24
25
26
27
async def get_memories(self) -> List[MemoryModel]:
    """
    Retrieve all memories associated with the authenticated user.

    Returns:
        List[MemoryModel]: A list of the user's memories.
    """
    return await self._request(
        "GET",
        "/v1/memories/",
        model=MemoryModel,
    )
add_memory 
add_memory(
    form_data: AddMemoryForm,
) -> Optional[MemoryModel]

Create a new memory for the authenticated user and add it to the vector database.

Parameters:

Name Type Description Default
form_data AddMemoryForm

The content of the memory to create.

 required

Returns:

Type Description
Optional[MemoryModel]

Optional[MemoryModel]: The created memory object, or None if creation failed.
Source code in src/owui_client/routers/memories.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
async def add_memory(self, form_data: AddMemoryForm) -> Optional[MemoryModel]:
    """
    Create a new memory for the authenticated user and add it to the vector database.

    Args:
        form_data: The content of the memory to create.

    Returns:
        Optional[MemoryModel]: The created memory object, or None if creation failed.
    """
    return await self._request(
        "POST",
        "/v1/memories/add",
        model=Optional[MemoryModel],
        json=form_data.model_dump(),
    )
query_memory 
query_memory(form_data: QueryMemoryForm) -> Any

Search for memories using vector similarity search.

Parameters:

Name Type Description Default
form_data QueryMemoryForm

The query parameters, including the search text and limit (k).

 required

Returns:

Name Type Description
Any Any

The search results from the vector database.
Source code in src/owui_client/routers/memories.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
async def query_memory(self, form_data: QueryMemoryForm) -> Any:
    """
    Search for memories using vector similarity search.

    Args:
        form_data: The query parameters, including the search text and limit (k).

    Returns:
        Any: The search results from the vector database.
    """
    return await self._request(
        "POST",
        "/v1/memories/query",
        json=form_data.model_dump(),
    )
reset_memory_from_vector_db 
reset_memory_from_vector_db() -> bool

Reset the vector database collection for the user's memories.

This deletes the existing collection and regenerates embeddings for all current memories.

Returns:

Name Type Description
bool bool

True if the reset was successful.
Source code in src/owui_client/routers/memories.py 
62
63
64
65
66
67
68
69
70
71
72
73
74
75
async def reset_memory_from_vector_db(self) -> bool:
    """
    Reset the vector database collection for the user's memories.

    This deletes the existing collection and regenerates embeddings for all current memories.

    Returns:
        bool: True if the reset was successful.
    """
    return await self._request(
        "POST",
        "/v1/memories/reset",
        model=bool,
    )
delete_memory_by_user_id 
delete_memory_by_user_id() -> bool

Delete all memories for the authenticated user.

This removes all memories from both the primary database and the vector database.

Returns:

Name Type Description
bool bool

True if the deletion was successful.
Source code in src/owui_client/routers/memories.py 
77
78
79
80
81
82
83
84
85
86
87
88
89
90
async def delete_memory_by_user_id(self) -> bool:
    """
    Delete all memories for the authenticated user.

    This removes all memories from both the primary database and the vector database.

    Returns:
        bool: True if the deletion was successful.
    """
    return await self._request(
        "DELETE",
        "/v1/memories/delete/user",
        model=bool,
    )
update_memory_by_id 
update_memory_by_id(
    memory_id: str, form_data: MemoryUpdateModel
) -> Optional[MemoryModel]

Update a specific memory by its ID.

Updates the content in both the primary database and the vector database.

Parameters:

Name Type Description Default
memory_id str

The unique identifier of the memory to update.

 required
form_data MemoryUpdateModel

The data to update (e.g., new content).

 required

Returns:

Type Description
Optional[MemoryModel]

Optional[MemoryModel]: The updated memory object, or None if the memory was not found.
Source code in src/owui_client/routers/memories.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
async def update_memory_by_id(
    self, memory_id: str, form_data: MemoryUpdateModel
) -> Optional[MemoryModel]:
    """
    Update a specific memory by its ID.

    Updates the content in both the primary database and the vector database.

    Args:
        memory_id: The unique identifier of the memory to update.
        form_data: The data to update (e.g., new content).

    Returns:
        Optional[MemoryModel]: The updated memory object, or None if the memory was not found.
    """
    return await self._request(
        "POST",
        f"/v1/memories/{memory_id}/update",
        model=Optional[MemoryModel],
        json=form_data.model_dump(),
    )
delete_memory_by_id 
delete_memory_by_id(memory_id: str) -> bool

Delete a specific memory by its ID.

Removes the memory from both the primary database and the vector database.

Parameters:

Name Type Description Default
memory_id str

The unique identifier of the memory to delete.

 required

Returns:

Name Type Description
bool bool

True if the deletion was successful.
Source code in src/owui_client/routers/memories.py 
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
async def delete_memory_by_id(self, memory_id: str) -> bool:
    """
    Delete a specific memory by its ID.

    Removes the memory from both the primary database and the vector database.

    Args:
        memory_id: The unique identifier of the memory to delete.

    Returns:
        bool: True if the deletion was successful.
    """
    return await self._request(
        "DELETE",
        f"/v1/memories/{memory_id}",
        model=bool,
    )
get_embeddings 
get_embeddings() -> dict

Test the embedding function.

Generates an embedding for the text "hello world" to verify the embedding function is working.

Returns:

Name Type Description
dict dict

A dictionary containing the embedding result.
Source code in src/owui_client/routers/memories.py 
132
133
134
135
136
137
138
139
140
141
142
143
144
async def get_embeddings(self) -> dict:
    """
    Test the embedding function.

    Generates an embedding for the text "hello world" to verify the embedding function is working.

    Returns:
        dict: A dictionary containing the embedding result.
    """
    return await self._request(
        "GET",
        "/v1/memories/ef",
    )