Spaces:
Running
Running
File size: 10,818 Bytes
287a0bc |
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 |
import { IEmbeddingFunction } from './embeddings/IEmbeddingFunction';
import { Configuration, ApiApi as DefaultApi } from "./generated";
import { handleSuccess, handleError } from "./utils";
import { Collection } from './Collection';
import { ChromaClientParams, CollectionMetadata, CollectionType, ConfigOptions, CreateCollectionParams, DeleteCollectionParams, GetCollectionParams, GetOrCreateCollectionParams, ListCollectionsParams } from './types';
import {
AuthOptions,
ClientAuthProtocolAdapter,
IsomorphicFetchClientAuthProtocolAdapter
} from "./auth";
import { DefaultEmbeddingFunction } from './embeddings/DefaultEmbeddingFunction';
import { AdminClient } from './AdminClient';
const DEFAULT_TENANT = "default_tenant"
const DEFAULT_DATABASE = "default_database"
export class ChromaClient {
/**
* @ignore
*/
private api: DefaultApi & ConfigOptions;
private apiAdapter: ClientAuthProtocolAdapter<any>|undefined;
private tenant: string = DEFAULT_TENANT;
private database: string = DEFAULT_DATABASE;
private _adminClient?: AdminClient
/**
* Creates a new ChromaClient instance.
* @param {Object} params - The parameters for creating a new client
* @param {string} [params.path] - The base path for the Chroma API.
* @returns {ChromaClient} A new ChromaClient instance.
*
* @example
* ```typescript
* const client = new ChromaClient({
* path: "http://localhost:8000"
* });
* ```
*/
constructor({
path,
fetchOptions,
auth,
tenant = DEFAULT_TENANT,
database = DEFAULT_DATABASE,
}: ChromaClientParams = {}) {
if (path === undefined) path = "http://localhost:8000";
this.tenant = tenant;
this.database = database;
const apiConfig: Configuration = new Configuration({
basePath: path,
});
if (auth !== undefined) {
this.apiAdapter = new IsomorphicFetchClientAuthProtocolAdapter(new DefaultApi(apiConfig), auth);
this.api = this.apiAdapter.getApi();
} else {
this.api = new DefaultApi(apiConfig);
}
this._adminClient = new AdminClient({
path: path,
fetchOptions: fetchOptions,
auth: auth,
tenant: tenant,
database: database
});
// TODO: Validate tenant and database on client creation
// this got tricky because:
// - the constructor is sync but the generated api is async
// - we need to inject auth information so a simple rewrite/fetch does not work
this.api.options = fetchOptions ?? {};
}
/**
* Resets the state of the object by making an API call to the reset endpoint.
*
* @returns {Promise<boolean>} A promise that resolves when the reset operation is complete.
* @throws {Error} If there is an issue resetting the state.
*
* @example
* ```typescript
* await client.reset();
* ```
*/
public async reset(): Promise<boolean> {
return await this.api.reset(this.api.options);
}
/**
* Returns the version of the Chroma API.
* @returns {Promise<string>} A promise that resolves to the version of the Chroma API.
*
* @example
* ```typescript
* const version = await client.version();
* ```
*/
public async version(): Promise<string> {
const response = await this.api.version(this.api.options);
return await handleSuccess(response);
}
/**
* Returns a heartbeat from the Chroma API.
* @returns {Promise<number>} A promise that resolves to the heartbeat from the Chroma API.
*
* @example
* ```typescript
* const heartbeat = await client.heartbeat();
* ```
*/
public async heartbeat(): Promise<number> {
const response = await this.api.heartbeat(this.api.options);
let ret = await handleSuccess(response);
return ret["nanosecond heartbeat"]
}
/**
* Creates a new collection with the specified properties.
*
* @param {Object} params - The parameters for creating a new collection.
* @param {string} params.name - The name of the collection.
* @param {CollectionMetadata} [params.metadata] - Optional metadata associated with the collection.
* @param {IEmbeddingFunction} [params.embeddingFunction] - Optional custom embedding function for the collection.
*
* @returns {Promise<Collection>} A promise that resolves to the created collection.
* @throws {Error} If there is an issue creating the collection.
*
* @example
* ```typescript
* const collection = await client.createCollection({
* name: "my_collection",
* metadata: {
* "description": "My first collection"
* }
* });
* ```
*/
public async createCollection({
name,
metadata,
embeddingFunction
}: CreateCollectionParams): Promise<Collection> {
if (embeddingFunction === undefined) {
embeddingFunction = new DefaultEmbeddingFunction();
}
const newCollection = await this.api
.createCollection(this.tenant, this.database, {
name,
metadata,
}, this.api.options)
.then(handleSuccess)
.catch(handleError);
if (newCollection.error) {
throw new Error(newCollection.error);
}
return new Collection(name, newCollection.id, this.api, metadata, embeddingFunction);
}
/**
* Gets or creates a collection with the specified properties.
*
* @param {Object} params - The parameters for creating a new collection.
* @param {string} params.name - The name of the collection.
* @param {CollectionMetadata} [params.metadata] - Optional metadata associated with the collection.
* @param {IEmbeddingFunction} [params.embeddingFunction] - Optional custom embedding function for the collection.
*
* @returns {Promise<Collection>} A promise that resolves to the got or created collection.
* @throws {Error} If there is an issue getting or creating the collection.
*
* @example
* ```typescript
* const collection = await client.getOrCreateCollection({
* name: "my_collection",
* metadata: {
* "description": "My first collection"
* }
* });
* ```
*/
public async getOrCreateCollection({
name,
metadata,
embeddingFunction
}: GetOrCreateCollectionParams): Promise<Collection> {
if (embeddingFunction === undefined) {
embeddingFunction = new DefaultEmbeddingFunction();
}
const newCollection = await this.api
.createCollection(this.tenant, this.database, {
name,
metadata,
'get_or_create': true
}, this.api.options)
.then(handleSuccess)
.catch(handleError);
if (newCollection.error) {
throw new Error(newCollection.error);
}
return new Collection(
name,
newCollection.id,
this.api,
newCollection.metadata,
embeddingFunction
);
}
/**
* Lists all collections.
*
* @returns {Promise<CollectionType[]>} A promise that resolves to a list of collection names.
* @param {PositiveInteger} [params.limit] - Optional limit on the number of items to get.
* @param {PositiveInteger} [params.offset] - Optional offset on the items to get.
* @throws {Error} If there is an issue listing the collections.
*
* @example
* ```typescript
* const collections = await client.listCollections({
* limit: 10,
* offset: 0,
* });
* ```
*/
public async listCollections({
limit,
offset,
}: ListCollectionsParams = {}): Promise<CollectionType[]> {
const response = await this.api.listCollections(
this.tenant,
this.database,
limit,
offset,
this.api.options);
return handleSuccess(response);
}
/**
* Counts all collections.
*
* @returns {Promise<number>} A promise that resolves to the number of collections.
* @throws {Error} If there is an issue counting the collections.
*
* @example
* ```typescript
* const collections = await client.countCollections();
* ```
*/
public async countCollections(): Promise<number> {
const response = await this.api.countCollections(this.tenant, this.database, this.api.options);
return handleSuccess(response);
}
/**
* Gets a collection with the specified name.
* @param {Object} params - The parameters for getting a collection.
* @param {string} params.name - The name of the collection.
* @param {IEmbeddingFunction} [params.embeddingFunction] - Optional custom embedding function for the collection.
* @returns {Promise<Collection>} A promise that resolves to the collection.
* @throws {Error} If there is an issue getting the collection.
*
* @example
* ```typescript
* const collection = await client.getCollection({
* name: "my_collection"
* });
* ```
*/
public async getCollection({
name,
embeddingFunction
}: GetCollectionParams): Promise<Collection> {
const response = await this.api
.getCollection(name, this.tenant, this.database, this.api.options)
.then(handleSuccess)
.catch(handleError);
if (response.error) {
throw new Error(response.error);
}
return new Collection(
response.name,
response.id,
this.api,
response.metadata,
embeddingFunction
);
}
/**
* Deletes a collection with the specified name.
* @param {Object} params - The parameters for deleting a collection.
* @param {string} params.name - The name of the collection.
* @returns {Promise<void>} A promise that resolves when the collection is deleted.
* @throws {Error} If there is an issue deleting the collection.
*
* @example
* ```typescript
* await client.deleteCollection({
* name: "my_collection"
* });
* ```
*/
public async deleteCollection({
name
}: DeleteCollectionParams): Promise<void> {
return await this.api
.deleteCollection(name, this.tenant, this.database, this.api.options)
.then(handleSuccess)
.catch(handleError);
}
}
|