Skip to content

retrieval

Classes

RetrievalClient 

RetrievalClient(client: OWUIClientBase)

Bases: ResourceBase

Client for the Retrieval endpoints.

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

Functions

get_status 
get_status() -> Dict

Get the status of the retrieval system.

Returns:

Type Description
Dict

Dict containing the status and configuration details.
Source code in src/owui_client/routers/retrieval.py 
22
23
24
25
26
27
28
29
async def get_status(self) -> Dict:
    """
    Get the status of the retrieval system.

    Returns:
        Dict containing the status and configuration details.
    """
    return await self._request("GET", "/v1/retrieval/")
get_embedding_config 
get_embedding_config() -> Dict

Get the current embedding configuration.

Returns:

Type Description
Dict

Dict containing the embedding configuration.
Source code in src/owui_client/routers/retrieval.py 
31
32
33
34
35
36
37
38
async def get_embedding_config(self) -> Dict:
    """
    Get the current embedding configuration.

    Returns:
        Dict containing the embedding configuration.
    """
    return await self._request("GET", "/v1/retrieval/embedding")
update_embedding_config 
update_embedding_config(
    form_data: EmbeddingModelUpdateForm,
) -> Dict

Update the embedding model configuration.

Parameters:

Name Type Description Default
form_data EmbeddingModelUpdateForm

The configuration updates.

 required

Returns:

Type Description
Dict

Dict containing the updated configuration.
Source code in src/owui_client/routers/retrieval.py 
40
41
42
43
44
45
46
47
48
49
50
async def update_embedding_config(self, form_data: EmbeddingModelUpdateForm) -> Dict:
    """
    Update the embedding model configuration.

    Args:
        form_data: The configuration updates.

    Returns:
        Dict containing the updated configuration.
    """
    return await self._request("POST", "/v1/retrieval/embedding/update", json=form_data.model_dump())
update_config 
update_config(form_data: ConfigForm) -> Dict

Update the retrieval configuration.

Parameters:

Name Type Description Default
form_data ConfigForm

The configuration updates.

 required

Returns:

Type Description
Dict

Dict containing the updated configuration.
Source code in src/owui_client/routers/retrieval.py 
52
53
54
55
56
57
58
59
60
61
62
async def update_config(self, form_data: ConfigForm) -> Dict:
    """
    Update the retrieval configuration.

    Args:
        form_data: The configuration updates.

    Returns:
        Dict containing the updated configuration.
    """
    return await self._request("POST", "/v1/retrieval/config/update", json=form_data.model_dump())
process_file 
process_file(form_data: ProcessFileForm) -> Dict

Process a file for retrieval.

Parameters:

Name Type Description Default
form_data ProcessFileForm

The file processing data.

 required

Returns:

Type Description
Dict

Dict containing the processing result.
Source code in src/owui_client/routers/retrieval.py 
64
65
66
67
68
69
70
71
72
73
74
async def process_file(self, form_data: ProcessFileForm) -> Dict:
    """
    Process a file for retrieval.

    Args:
        form_data: The file processing data.

    Returns:
        Dict containing the processing result.
    """
    return await self._request("POST", "/v1/retrieval/process/file", json=form_data.model_dump())
process_text 
process_text(form_data: ProcessTextForm) -> Dict

Process text for retrieval.

Parameters:

Name Type Description Default
form_data ProcessTextForm

The text processing data.

 required

Returns:

Type Description
Dict

Dict containing the processing result.
Source code in src/owui_client/routers/retrieval.py 
76
77
78
79
80
81
82
83
84
85
86
async def process_text(self, form_data: ProcessTextForm) -> Dict:
    """
    Process text for retrieval.

    Args:
        form_data: The text processing data.

    Returns:
        Dict containing the processing result.
    """
    return await self._request("POST", "/v1/retrieval/process/text", json=form_data.model_dump())
process_web 
process_web(form_data: ProcessUrlForm) -> Dict

Process a web URL for retrieval.

Parameters:

Name Type Description Default
form_data ProcessUrlForm

The URL processing data.

 required

Returns:

Type Description
Dict

Dict containing the processing result.
Source code in src/owui_client/routers/retrieval.py 
88
89
90
91
92
93
94
95
96
97
98
async def process_web(self, form_data: ProcessUrlForm) -> Dict:
    """
    Process a web URL for retrieval.

    Args:
        form_data: The URL processing data.

    Returns:
        Dict containing the processing result.
    """
    return await self._request("POST", "/v1/retrieval/process/web", json=form_data.model_dump())
process_youtube 
process_youtube(form_data: ProcessUrlForm) -> Dict

Process a YouTube URL for retrieval.

Parameters:

Name Type Description Default
form_data ProcessUrlForm

The YouTube URL processing data.

 required

Returns:

Type Description
Dict

Dict containing the processing result.
Source code in src/owui_client/routers/retrieval.py 
100
101
102
103
104
105
106
107
108
109
110
async def process_youtube(self, form_data: ProcessUrlForm) -> Dict:
    """
    Process a YouTube URL for retrieval.

    Args:
        form_data: The YouTube URL processing data.

    Returns:
        Dict containing the processing result.
    """
    return await self._request("POST", "/v1/retrieval/process/youtube", json=form_data.model_dump())

process_web_search(form_data: SearchForm) -> Dict

Process a web search for retrieval.

Parameters:

Name Type Description Default
form_data SearchForm

The search query data.

 required

Returns:

Type Description
Dict

Dict containing the search results.
Source code in src/owui_client/routers/retrieval.py 
112
113
114
115
116
117
118
119
120
121
122
async def process_web_search(self, form_data: SearchForm) -> Dict:
    """
    Process a web search for retrieval.

    Args:
        form_data: The search query data.

    Returns:
        Dict containing the search results.
    """
    return await self._request("POST", "/v1/retrieval/process/web/search", json=form_data.model_dump())
query_doc 
query_doc(form_data: QueryDocForm) -> Dict

Query a document in a collection.

Parameters:

Name Type Description Default
form_data QueryDocForm

The query data.

 required

Returns:

Type Description
Dict

Dict containing the query results.
Source code in src/owui_client/routers/retrieval.py 
124
125
126
127
128
129
130
131
132
133
134
async def query_doc(self, form_data: QueryDocForm) -> Dict:
    """
    Query a document in a collection.

    Args:
        form_data: The query data.

    Returns:
        Dict containing the query results.
    """
    return await self._request("POST", "/v1/retrieval/query/doc", json=form_data.model_dump())
query_collection 
query_collection(form_data: QueryCollectionsForm) -> Dict

Query multiple collections.

Parameters:

Name Type Description Default
form_data QueryCollectionsForm

The query data.

 required

Returns:

Type Description
Dict

Dict containing the query results.
Source code in src/owui_client/routers/retrieval.py 
136
137
138
139
140
141
142
143
144
145
146
async def query_collection(self, form_data: QueryCollectionsForm) -> Dict:
    """
    Query multiple collections.

    Args:
        form_data: The query data.

    Returns:
        Dict containing the query results.
    """
    return await self._request("POST", "/v1/retrieval/query/collection", json=form_data.model_dump())
delete 
delete(form_data: DeleteForm) -> bool

Delete a file from a collection.

Parameters:

Name Type Description Default
form_data DeleteForm

The delete request data.

 required

Returns:

Name Type Description
bool bool

True if successful.
Source code in src/owui_client/routers/retrieval.py 
148
149
150
151
152
153
154
155
156
157
158
async def delete(self, form_data: DeleteForm) -> bool:
    """
    Delete a file from a collection.

    Args:
        form_data: The delete request data.

    Returns:
        bool: True if successful.
    """
    return await self._request("POST", "/v1/retrieval/delete", json=form_data.model_dump())
reset_db 
reset_db() -> bool

Reset the retrieval database.

Returns:

Name Type Description
bool bool

True if successful.
Source code in src/owui_client/routers/retrieval.py 
160
161
162
163
164
165
166
167
async def reset_db(self) -> bool:
    """
    Reset the retrieval database.

    Returns:
        bool: True if successful.
    """
    return await self._request("POST", "/v1/retrieval/reset/db")
reset_uploads 
reset_uploads() -> bool

Reset the uploaded files.

Returns:

Name Type Description
bool bool

True if successful.
Source code in src/owui_client/routers/retrieval.py 
169
170
171
172
173
174
175
176
async def reset_uploads(self) -> bool:
    """
    Reset the uploaded files.

    Returns:
        bool: True if successful.
    """
    return await self._request("POST", "/v1/retrieval/reset/uploads")
process_files_batch 
process_files_batch(
    form_data: BatchProcessFilesForm,
) -> BatchProcessFilesResponse

Process a batch of files for retrieval.

Parameters:

Name Type Description Default
form_data BatchProcessFilesForm

The batch processing data.

 required

Returns:

Type Description
BatchProcessFilesResponse

BatchProcessFilesResponse containing the results.
Source code in src/owui_client/routers/retrieval.py 
178
179
180
181
182
183
184
185
186
187
188
189
async def process_files_batch(self, form_data: BatchProcessFilesForm) -> BatchProcessFilesResponse:
    """
    Process a batch of files for retrieval.

    Args:
        form_data: The batch processing data.

    Returns:
        `BatchProcessFilesResponse` containing the results.
    """
    response = await self._request("POST", "/v1/retrieval/process/files/batch", json=form_data.model_dump())
    return BatchProcessFilesResponse(**response)
get_embeddings 
get_embeddings(text: str = 'Hello World!') -> Dict

Get embeddings for a given text.

Parameters:

Name Type Description Default
text str

The text to get embeddings for.

 'Hello World!'

Returns:

Type Description
Dict

Dict containing the embeddings.
Source code in src/owui_client/routers/retrieval.py 
191
192
193
194
195
196
197
198
199
200
201
async def get_embeddings(self, text: str = "Hello World!") -> Dict:
    """
    Get embeddings for a given text.

    Args:
        text: The text to get embeddings for.

    Returns:
        Dict containing the embeddings.
    """
    return await self._request("GET", f"/v1/retrieval/ef/{text}")