kylefang/chroma
1
0
Fork 0
mirror of https://github.com/placeholder-soft/chroma.git synced 2026-01-12 17:02:54 +08:00
Code Issues Packages Projects Releases Wiki Activity

clean up JS API, remove increment_index, createIndex and rawSql (#922)

Browse Source 
This cleans up the JS API
- remove `increment_index`
- removes `createIndex`
- removes `rawSql`

It also bumps the version to 1.5.6 (not yet released) and fixes a type
that changed.
This commit is contained in:
Jeff Huber
2023-08-04 21:54:31 -07:00
committed by GitHub
parent 4c4cdacca4
commit 608d01ed98
4 changed files with 7 additions and 178 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
clients/js/package.json
View File

@@ -1,6 +1,6 @@
{
"name": "chromadb",
"version": "1.5.5",
"version": "1.5.6",
"description": "A JavaScript interface for chroma",
"keywords": [],
"author": "",

4
clients/js/src/ChromaClient.ts
View File

@@ -42,7 +42,7 @@ export class ChromaClient {
/**
* Resets the state of the object by making an API call to the reset endpoint.
*
* @returns {Promise<Api.Reset200Response>} A promise that resolves when the reset operation is complete.
* @returns {Promise<boolean>} A promise that resolves when the reset operation is complete.
* @throws {Error} If there is an issue resetting the state.
*
* @example
@@ -50,7 +50,7 @@ export class ChromaClient {
* await client.reset();
* ```
*/
public async reset(): Promise<Api.Reset200Response> {
public async reset(): Promise<boolean> {
return await this.api.reset(this.api.options);
}

155
clients/js/src/generated/api.ts
View File

@@ -222,38 +222,6 @@ export const ApiApiFetchParamCreator = function (configuration?: Configuration)
options: localVarRequestOptions,
};
},
/**
* @summary Create Index
* @param {string} collectionName
* @param {RequestInit} [options] Override http request option.
* @throws {RequiredError}
*/
createIndex(collectionName: string, options: RequestInit = {}): FetchArgs {
// verify required parameter 'collectionName' is not null or undefined
if (collectionName === null || collectionName === undefined) {
throw new RequiredError('collectionName', 'Required parameter collectionName was null or undefined when calling createIndex.');
}
let localVarPath = `/api/v1/collections/{collection_name}/create_index`
.replace('{collection_name}', encodeURIComponent(String(collectionName)));
const localVarPathQueryStart = localVarPath.indexOf("?");
const localVarRequestOptions: RequestInit = Object.assign({ method: 'POST' }, options);
const localVarHeaderParameter: Headers = options.headers ? new Headers(options.headers) : new Headers();
const localVarQueryParameter = new URLSearchParams(localVarPathQueryStart !== -1 ? localVarPath.substring(localVarPathQueryStart + 1) : "");
if (localVarPathQueryStart !== -1) {
localVarPath = localVarPath.substring(0, localVarPathQueryStart);
}
localVarRequestOptions.headers = localVarHeaderParameter;
const localVarQueryParameterString = localVarQueryParameter.toString();
if (localVarQueryParameterString) {
localVarPath += "?" + localVarQueryParameterString;
}
return {
url: localVarPath,
options: localVarRequestOptions,
};
},
/**
* @summary Delete Collection
* @param {string} collectionName
@@ -413,43 +381,6 @@ export const ApiApiFetchParamCreator = function (configuration?: Configuration)
options: localVarRequestOptions,
};
},
/**
* @summary Raw Sql
* @param {Api.RawSql} request
* @param {RequestInit} [options] Override http request option.
* @throws {RequiredError}
*/
rawSql(request: Api.RawSql, options: RequestInit = {}): FetchArgs {
// verify required parameter 'request' is not null or undefined
if (request === null || request === undefined) {
throw new RequiredError('request', 'Required parameter request was null or undefined when calling rawSql.');
}
let localVarPath = `/api/v1/raw_sql`;
const localVarPathQueryStart = localVarPath.indexOf("?");
const localVarRequestOptions: RequestInit = Object.assign({ method: 'POST' }, options);
const localVarHeaderParameter: Headers = options.headers ? new Headers(options.headers) : new Headers();
const localVarQueryParameter = new URLSearchParams(localVarPathQueryStart !== -1 ? localVarPath.substring(localVarPathQueryStart + 1) : "");
if (localVarPathQueryStart !== -1) {
localVarPath = localVarPath.substring(0, localVarPathQueryStart);
}
localVarHeaderParameter.set('Content-Type', 'application/json');
localVarRequestOptions.headers = localVarHeaderParameter;
if (request !== undefined) {
localVarRequestOptions.body = JSON.stringify(request || {});
}
const localVarQueryParameterString = localVarQueryParameter.toString();
if (localVarQueryParameterString) {
localVarPath += "?" + localVarQueryParameterString;
}
return {
url: localVarPath,
options: localVarRequestOptions,
};
},
/**
* @summary Reset
* @param {RequestInit} [options] Override http request option.
@@ -814,35 +745,6 @@ export const ApiApiFp = function(configuration?: Configuration) {
});
};
},
/**
* @summary Create Index
* @param {string} collectionName
* @param {RequestInit} [options] Override http request option.
* @throws {RequiredError}
*/
createIndex(collectionName: string, options?: RequestInit): (fetch?: FetchAPI, basePath?: string) => Promise<Api.CreateIndex200Response> {
const localVarFetchArgs = ApiApiFetchParamCreator(configuration).createIndex(collectionName, options);
return (fetch: FetchAPI = defaultFetch, basePath: string = BASE_PATH) => {
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
const contentType = response.headers.get('Content-Type');
const mimeType = contentType ? contentType.replace(/;.*/, '') : undefined;
if (response.status === 200) {
if (mimeType === 'application/json') {
return response.json() as any;
}
throw response;
}
if (response.status === 422) {
if (mimeType === 'application/json') {
throw response;
}
throw response;
}
throw response;
});
};
},
/**
* @summary Delete Collection
* @param {string} collectionName
@@ -936,7 +838,7 @@ export const ApiApiFp = function(configuration?: Configuration) {
* @param {RequestInit} [options] Override http request option.
* @throws {RequiredError}
*/
heartbeat(options?: RequestInit): (fetch?: FetchAPI, basePath?: string) => Promise<Api.Heartbeat200Response> {
heartbeat(options?: RequestInit): (fetch?: FetchAPI, basePath?: string) => Promise<{ [name: string]: number }> {
const localVarFetchArgs = ApiApiFetchParamCreator(configuration).heartbeat(options);
return (fetch: FetchAPI = defaultFetch, basePath: string = BASE_PATH) => {
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
@@ -975,41 +877,12 @@ export const ApiApiFp = function(configuration?: Configuration) {
});
};
},
/**
* @summary Raw Sql
* @param {Api.RawSql} request
* @param {RequestInit} [options] Override http request option.
* @throws {RequiredError}
*/
rawSql(request: Api.RawSql, options?: RequestInit): (fetch?: FetchAPI, basePath?: string) => Promise<Api.RawSql200Response> {
const localVarFetchArgs = ApiApiFetchParamCreator(configuration).rawSql(request, options);
return (fetch: FetchAPI = defaultFetch, basePath: string = BASE_PATH) => {
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
const contentType = response.headers.get('Content-Type');
const mimeType = contentType ? contentType.replace(/;.*/, '') : undefined;
if (response.status === 200) {
if (mimeType === 'application/json') {
return response.json() as any;
}
throw response;
}
if (response.status === 422) {
if (mimeType === 'application/json') {
throw response;
}
throw response;
}
throw response;
});
};
},
/**
* @summary Reset
* @param {RequestInit} [options] Override http request option.
* @throws {RequiredError}
*/
reset(options?: RequestInit): (fetch?: FetchAPI, basePath?: string) => Promise<Api.Reset200Response> {
reset(options?: RequestInit): (fetch?: FetchAPI, basePath?: string) => Promise<boolean> {
const localVarFetchArgs = ApiApiFetchParamCreator(configuration).reset(options);
return (fetch: FetchAPI = defaultFetch, basePath: string = BASE_PATH) => {
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
@@ -1031,7 +904,7 @@ export const ApiApiFp = function(configuration?: Configuration) {
* @param {RequestInit} [options] Override http request option.
* @throws {RequiredError}
*/
root(options?: RequestInit): (fetch?: FetchAPI, basePath?: string) => Promise<Api.Root200Response> {
root(options?: RequestInit): (fetch?: FetchAPI, basePath?: string) => Promise<{ [name: string]: number }> {
const localVarFetchArgs = ApiApiFetchParamCreator(configuration).root(options);
return (fetch: FetchAPI = defaultFetch, basePath: string = BASE_PATH) => {
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
@@ -1143,7 +1016,7 @@ export const ApiApiFp = function(configuration?: Configuration) {
* @param {RequestInit} [options] Override http request option.
* @throws {RequiredError}
*/
version(options?: RequestInit): (fetch?: FetchAPI, basePath?: string) => Promise<Api.Version200Response> {
version(options?: RequestInit): (fetch?: FetchAPI, basePath?: string) => Promise<string> {
const localVarFetchArgs = ApiApiFetchParamCreator(configuration).version(options);
return (fetch: FetchAPI = defaultFetch, basePath: string = BASE_PATH) => {
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
@@ -1231,16 +1104,6 @@ export class ApiApi extends BaseAPI {
return ApiApiFp(this.configuration).createCollection(request, options)(this.fetch, this.basePath);
}
/**
* @summary Create Index
* @param {string} collectionName
* @param {RequestInit} [options] Override http request option.
* @throws {RequiredError}
*/
public createIndex(collectionName: string, options?: RequestInit) {
return ApiApiFp(this.configuration).createIndex(collectionName, options)(this.fetch, this.basePath);
}
/**
* @summary Delete Collection
* @param {string} collectionName
@@ -1290,16 +1153,6 @@ export class ApiApi extends BaseAPI {
return ApiApiFp(this.configuration).listCollections(options)(this.fetch, this.basePath);
}
/**
* @summary Raw Sql
* @param {Api.RawSql} request
* @param {RequestInit} [options] Override http request option.
* @throws {RequiredError}
*/
public rawSql(request: Api.RawSql, options?: RequestInit) {
return ApiApiFp(this.configuration).rawSql(request, options)(this.fetch, this.basePath);
}
/**
* @summary Reset
* @param {RequestInit} [options] Override http request option.

24
clients/js/src/generated/models.ts
View File

@@ -21,7 +21,6 @@ export namespace Api {
metadatas?: Api.AddEmbedding.Metadata[];
documents?: string[];
ids: string[];
'increment_index'?: boolean;
}
/**
@@ -65,9 +64,6 @@ export namespace Api {
export interface CreateCollection200Response {
}
export interface CreateIndex200Response {
}
export interface DeleteCollection200Response {
}
@@ -152,9 +148,6 @@ export namespace Api {
export interface GetNearestNeighbors200Response {
}
export interface Heartbeat200Response {
}
export interface HTTPValidationError {
detail?: Api.ValidationError[];
}
@@ -215,19 +208,6 @@ export namespace Api {
}
export interface RawSql {
'raw_sql': string;
}
export interface RawSql200Response {
}
export interface Reset200Response {
}
export interface Root200Response {
}
export interface Update200Response {
}
@@ -254,7 +234,6 @@ export namespace Api {
metadatas?: Api.UpdateEmbedding.Metadata[];
documents?: string[];
ids: string[];
'increment_index'?: boolean;
}
/**
@@ -279,7 +258,4 @@ export namespace Api {
'type': string;
}
export interface Version200Response {
}
}