Collection
create_collection(request, requesting_user=Depends(get_current_user))
async
Create a private collection and provision its backing vector index (Qdrant).
The new collection is private to its creator. The MongoDB collection ID is used as the Qdrant collection name.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CollectionRequest
|
New collection parameters. |
required |
requesting_user
|
User
|
Authenticated user injected by dependency. |
Depends(get_current_user)
|
Returns:
| Type | Description |
|---|---|
Collection
|
Created collection. |
Raises:
| Type | Description |
|---|---|
HTTPException
|
500 if vector collection creation fails or on server errors. |
Source code in routers/collection.py
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 | |
delete_collection(collection_id, requesting_user=Depends(get_current_user))
async
Delete a collection and its related resources.
Deletes documents in the collection, attempts to remove the vector index, and finally deletes the collection record.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
collection_id
|
str
|
Collection identifier. |
required |
requesting_user
|
User
|
Authenticated user injected by dependency. |
Depends(get_current_user)
|
Returns:
| Type | Description |
|---|---|
dict
|
Confirmation message. |
Raises:
| Type | Description |
|---|---|
HTTPException
|
404 if not found; 403 if deletion is forbidden; 500 for server errors. |
Source code in routers/collection.py
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 | |
get_collection(collection_id)
async
Get a collection by id with document and vector counts.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
collection_id
|
str
|
Target collection identifier. |
required |
Returns:
| Type | Description |
|---|---|
dict
|
Collection data including documents_count and points_count. |
Raises:
| Type | Description |
|---|---|
HTTPException
|
404 if collection is not found. |
Source code in routers/collection.py
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 | |
list_collections(request=Depends(), request_user=Depends(get_current_user))
async
List collections owned by the current user.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
Pagination
|
Pagination parameters. |
Depends()
|
request_user
|
User
|
Authenticated user injected by dependency. |
Depends(get_current_user)
|
Returns:
| Type | Description |
|---|---|
PaginatedResponse[Collection]
|
Paginated list of user collections. |
Source code in routers/collection.py
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | |
list_public_collections(pagination=Depends())
async
List public collections with pagination.
Combines platform-curated public collections and environment-specific public collections, then paginates the combined list.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
pagination
|
Pagination
|
Pagination parameters. |
Depends()
|
Returns:
| Type | Description |
|---|---|
PaginatedResponse[Collection]
|
Paginated list of public collections. |
Source code in routers/collection.py
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 | |
update_collection(request, collection_id, requesting_user=Depends(get_current_user))
async
Update a collection's mutable fields.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CollectionUpdate
|
Update payload (e.g., name). |
required |
collection_id
|
str
|
Collection identifier. |
required |
requesting_user
|
User
|
Authenticated user injected by dependency. |
Depends(get_current_user)
|
Returns:
| Type | Description |
|---|---|
Collection
|
Updated collection. |
Raises:
| Type | Description |
|---|---|
HTTPException
|
404 if not found; 403 if update is forbidden; 500 for server errors. |
Source code in routers/collection.py
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 | |