1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
|
from typing import Any, Optional
from uuid import UUID
from shared.api.models import (
WrappedBooleanResponse,
WrappedCollectionResponse,
WrappedCollectionsResponse,
WrappedDocumentsResponse,
WrappedGenericMessageResponse,
WrappedUsersResponse,
)
class CollectionsSDK:
def __init__(self, client):
self.client = client
def create(
self,
name: str,
description: Optional[str] = None,
) -> WrappedCollectionResponse:
"""Create a new collection.
Args:
name (str): Name of the collection
description (Optional[str]): Description of the collection
Returns:
WrappedCollectionResponse
"""
data: dict[str, Any] = {"name": name, "description": description}
response_dict = self.client._make_request(
"POST",
"collections",
json=data,
version="v3",
)
return WrappedCollectionResponse(**response_dict)
def list(
self,
ids: Optional[list[str | UUID]] = None,
offset: Optional[int] = 0,
limit: Optional[int] = 100,
) -> WrappedCollectionsResponse:
"""List collections with pagination and filtering options.
Args:
ids (Optional[list[str | UUID]]): Filter collections by ids
offset (int, optional): Specifies the number of objects to skip. Defaults to 0.
limit (int, optional): Specifies a limit on the number of objects to return, ranging between 1 and 100. Defaults to 100.
Returns:
WrappedCollectionsResponse
"""
params: dict = {
"offset": offset,
"limit": limit,
}
if ids:
params["ids"] = ids
response_dict = self.client._make_request(
"GET", "collections", params=params, version="v3"
)
return WrappedCollectionsResponse(**response_dict)
def retrieve(
self,
id: str | UUID,
) -> WrappedCollectionResponse:
"""Get detailed information about a specific collection.
Args:
id (str | UUID): Collection ID to retrieve
Returns:
WrappedCollectionResponse
"""
response_dict = self.client._make_request(
"GET", f"collections/{str(id)}", version="v3"
)
return WrappedCollectionResponse(**response_dict)
def update(
self,
id: str | UUID,
name: Optional[str] = None,
description: Optional[str] = None,
generate_description: Optional[bool] = False,
) -> WrappedCollectionResponse:
"""Update collection information.
Args:
id (str | UUID): Collection ID to update
name (Optional[str]): Optional new name for the collection
description (Optional[str]): Optional new description for the collection
generate_description (Optional[bool]): Whether to generate a new synthetic description for the collection.
Returns:
WrappedCollectionResponse
"""
data: dict[str, Any] = {}
if name is not None:
data["name"] = name
if description is not None:
data["description"] = description
if generate_description:
data["generate_description"] = str(generate_description)
response_dict = self.client._make_request(
"POST",
f"collections/{str(id)}",
json=data,
version="v3",
)
return WrappedCollectionResponse(**response_dict)
def delete(
self,
id: str | UUID,
) -> WrappedBooleanResponse:
"""Delete a collection.
Args:
id (str | UUID): Collection ID to delete
Returns:
WrappedBooleanResponse
"""
response_dict = self.client._make_request(
"DELETE", f"collections/{str(id)}", version="v3"
)
return WrappedBooleanResponse(**response_dict)
def list_documents(
self,
id: str | UUID,
offset: Optional[int] = 0,
limit: Optional[int] = 100,
) -> WrappedDocumentsResponse:
"""List all documents in a collection.
Args:
id (str | UUID): Collection ID
offset (int, optional): Specifies the number of objects to skip. Defaults to 0.
limit (int, optional): Specifies a limit on the number of objects to return, ranging between 1 and 100. Defaults to 100.
Returns:
WrappedDocumentsResponse
"""
params: dict = {
"offset": offset,
"limit": limit,
}
response_dict = self.client._make_request(
"GET",
f"collections/{str(id)}/documents",
params=params,
version="v3",
)
return WrappedDocumentsResponse(**response_dict)
def add_document(
self,
id: str | UUID,
document_id: str | UUID,
) -> WrappedGenericMessageResponse:
"""Add a document to a collection.
Args:
id (str | UUID): Collection ID
document_id (str | UUID): Document ID to add
Returns:
WrappedGenericMessageResponse
"""
response_dict = self.client._make_request(
"POST",
f"collections/{str(id)}/documents/{str(document_id)}",
version="v3",
)
return WrappedGenericMessageResponse(**response_dict)
def remove_document(
self,
id: str | UUID,
document_id: str | UUID,
) -> WrappedBooleanResponse:
"""Remove a document from a collection.
Args:
id (str | UUID): Collection ID
document_id (str | UUID): Document ID to remove
Returns:
WrappedBooleanResponse
"""
response_dict = self.client._make_request(
"DELETE",
f"collections/{str(id)}/documents/{str(document_id)}",
version="v3",
)
return WrappedBooleanResponse(**response_dict)
def list_users(
self,
id: str | UUID,
offset: Optional[int] = 0,
limit: Optional[int] = 100,
) -> WrappedUsersResponse:
"""List all users in a collection.
Args:
id (str, UUID): Collection ID
offset (int, optional): Specifies the number of objects to skip. Defaults to 0.
limit (int, optional): Specifies a limit on the number of objects to return, ranging between 1 and 100. Defaults to 100.
Returns:
WrappedUsersResponse
"""
params: dict = {
"offset": offset,
"limit": limit,
}
response_dict = self.client._make_request(
"GET", f"collections/{str(id)}/users", params=params, version="v3"
)
return WrappedUsersResponse(**response_dict)
def add_user(
self,
id: str | UUID,
user_id: str | UUID,
) -> WrappedBooleanResponse:
"""Add a user to a collection.
Args:
id (str | UUID): Collection ID
user_id (str | UUID): User ID to add
Returns:
WrappedBooleanResponse
"""
response_dict = self.client._make_request(
"POST", f"collections/{str(id)}/users/{str(user_id)}", version="v3"
)
return WrappedBooleanResponse(**response_dict)
def remove_user(
self,
id: str | UUID,
user_id: str | UUID,
) -> WrappedBooleanResponse:
"""Remove a user from a collection.
Args:
id (str | UUID): Collection ID
user_id (str | UUID): User ID to remove
Returns:
WrappedBooleanResponse
"""
response_dict = self.client._make_request(
"DELETE",
f"collections/{str(id)}/users/{str(user_id)}",
version="v3",
)
return WrappedBooleanResponse(**response_dict)
def extract(
self,
id: str | UUID,
settings: Optional[dict] = None,
run_with_orchestration: Optional[bool] = True,
) -> WrappedGenericMessageResponse:
"""Extract entities and relationships from documents in a collection.
Args:
id (str | UUID): Collection ID to extract from
settings (Optional[dict]): Settings for the entities and relationships extraction process
run_with_orchestration (Optional[bool]): Whether to run the extraction process with orchestration.
Defaults to True
Returns:
WrappedGenericMessageResponse
"""
params = {"run_with_orchestration": run_with_orchestration}
data: dict[str, Any] = {}
if settings is not None:
data["settings"] = settings
response_dict = self.client._make_request(
"POST",
f"collections/{str(id)}/extract",
params=params,
json=data or None,
version="v3",
)
return WrappedGenericMessageResponse(**response_dict)
def retrieve_by_name(
self, name: str, owner_id: Optional[str] = None
) -> WrappedCollectionResponse:
"""Retrieve a collection by its name.
For non-superusers, the backend will use the authenticated user's ID.
For superusers, the caller must supply an owner_id to restrict the search.
Args:
name (str): The name of the collection to retrieve.
owner_id (Optional[str]): The owner ID to restrict the search. Required for superusers.
Returns:
WrappedCollectionResponse
"""
query_params: dict[str, Any] = {}
if owner_id is not None:
query_params["owner_id"] = owner_id
response_dict = self.client._make_request(
"GET",
f"collections/name/{name}",
params=query_params,
version="v3",
)
return WrappedCollectionResponse(**response_dict)
|
