@qdrant/js-client-rest
Version:
This repository contains the REST client for the [Qdrant](https://github.com/qdrant/qdrant) vector search engine.
1,018 lines • 1.01 MB
TypeScript
import { Client } from '../api-client.js';
export declare function createPointsApi(client: Client): {
/**
* Remove all payload for specified points
*/
readonly clearPayload: import("@qdrant/openapi-typescript-fetch").TypedFetch<{
parameters: {
query?: {
wait?: boolean | undefined;
ordering?: "weak" | "medium" | "strong" | undefined;
} | undefined;
path: {
collection_name: string;
};
};
requestBody?: {
content: {
"application/json": {
points: (string | number)[];
shard_key?: string | number | Record<string, unknown> | (string | number)[] | null | undefined;
} | {
filter: {
should?: Record<string, unknown> | any | {
key: string;
match?: Record<string, unknown> | {
value: string | number | boolean;
} | {
text: string;
} | {
any: string[] | number[];
} | {
except: string[] | number[];
} | null | undefined;
range?: Record<string, unknown> | {
lt?: number | null | undefined;
gt?: number | null | undefined;
gte?: number | null | undefined;
lte?: number | null | undefined;
} | {
lt?: string | null | undefined;
gt?: string | null | undefined;
gte?: string | null | undefined;
lte?: string | null | undefined;
} | null | undefined;
geo_bounding_box?: Record<string, unknown> | {
top_left: {
lon: number;
lat: number;
};
bottom_right: {
lon: number;
lat: number;
};
} | null | undefined;
geo_radius?: Record<string, unknown> | {
center: {
lon: number;
lat: number;
};
radius: number;
} | null | undefined;
geo_polygon?: Record<string, unknown> | {
exterior: {
points: {
lon: number;
lat: number;
}[];
};
interiors?: {
points: {
lon: number;
lat: number;
}[];
}[] | null | undefined;
} | null | undefined;
values_count?: Record<string, unknown> | {
lt?: number | null | undefined;
gt?: number | null | undefined;
gte?: number | null | undefined;
lte?: number | null | undefined;
} | null | undefined;
} | {
is_empty: {
key: string;
};
} | {
is_null: {
key: string;
};
} | {
has_id: (string | number)[];
} | {
nested: {
key: string;
filter: any;
};
} | (any | {
key: string;
match?: Record<string, unknown> | {
value: string | number | boolean;
} | {
text: string;
} | {
any: string[] | number[];
} | {
except: string[] | number[];
} | null | undefined;
range?: Record<string, unknown> | {
lt?: number | null | undefined;
gt?: number | null | undefined;
gte?: number | null | undefined;
lte?: number | null | undefined;
} | {
lt?: string | null | undefined;
gt?: string | null | undefined;
gte?: string | null | undefined;
lte?: string | null | undefined;
} | null | undefined;
geo_bounding_box?: Record<string, unknown> | {
top_left: {
lon: number;
lat: number;
};
bottom_right: {
lon: number;
lat: number;
};
} | null | undefined;
geo_radius?: Record<string, unknown> | {
center: {
lon: number;
lat: number;
};
radius: number;
} | null | undefined;
geo_polygon?: Record<string, unknown> | {
exterior: {
points: {
lon: number;
lat: number;
}[];
};
interiors?: {
points: {
lon: number;
lat: number;
}[];
}[] | null | undefined;
} | null | undefined;
values_count?: Record<string, unknown> | {
lt?: number | null | undefined;
gt?: number | null | undefined;
gte?: number | null | undefined;
lte?: number | null | undefined;
} | null | undefined;
} | {
is_empty: {
key: string;
};
} | {
is_null: {
key: string;
};
} | {
has_id: (string | number)[];
} | {
nested: {
key: string;
filter: any;
};
})[] | null | undefined;
min_should?: Record<string, unknown> | {
conditions: (any | {
key: string;
match?: Record<string, unknown> | {
value: string | number | boolean;
} | {
text: string;
} | {
any: string[] | number[];
} | {
except: string[] | number[];
} | null | undefined;
range?: Record<string, unknown> | {
lt?: number | null | undefined;
gt?: number | null | undefined;
gte?: number | null | undefined;
lte?: number | null | undefined;
} | {
lt?: string | null | undefined;
gt?: string | null | undefined;
gte?: string | null | undefined;
lte?: string | null | undefined;
} | null | undefined;
geo_bounding_box?: Record<string, unknown> | {
top_left: {
lon: number;
lat: number;
};
bottom_right: {
lon: number;
lat: number;
};
} | null | undefined;
geo_radius?: Record<string, unknown> | {
center: {
lon: number;
lat: number;
};
radius: number;
} | null | undefined;
geo_polygon?: Record<string, unknown> | {
exterior: {
points: {
lon: number;
lat: number;
}[];
};
interiors?: {
points: {
lon: number;
lat: number;
}[];
}[] | null | undefined;
} | null | undefined;
values_count?: Record<string, unknown> | {
lt?: number | null | undefined;
gt?: number | null | undefined;
gte?: number | null | undefined;
lte?: number | null | undefined;
} | null | undefined;
} | {
is_empty: {
key: string;
};
} | {
is_null: {
key: string;
};
} | {
has_id: (string | number)[];
} | {
nested: {
key: string;
filter: any;
};
})[];
min_count: number;
} | null | undefined;
must?: Record<string, unknown> | any | {
key: string;
match?: Record<string, unknown> | {
value: string | number | boolean;
} | {
text: string;
} | {
any: string[] | number[];
} | {
except: string[] | number[];
} | null | undefined;
range?: Record<string, unknown> | {
lt?: number | null | undefined;
gt?: number | null | undefined;
gte?: number | null | undefined;
lte?: number | null | undefined;
} | {
lt?: string | null | undefined;
gt?: string | null | undefined;
gte?: string | null | undefined;
lte?: string | null | undefined;
} | null | undefined;
geo_bounding_box?: Record<string, unknown> | {
top_left: {
lon: number;
lat: number;
};
bottom_right: {
lon: number;
lat: number;
};
} | null | undefined;
geo_radius?: Record<string, unknown> | {
center: {
lon: number;
lat: number;
};
radius: number;
} | null | undefined;
geo_polygon?: Record<string, unknown> | {
exterior: {
points: {
lon: number;
lat: number;
}[];
};
interiors?: {
points: {
lon: number;
lat: number;
}[];
}[] | null | undefined;
} | null | undefined;
values_count?: Record<string, unknown> | {
lt?: number | null | undefined;
gt?: number | null | undefined;
gte?: number | null | undefined;
lte?: number | null | undefined;
} | null | undefined;
} | {
is_empty: {
key: string;
};
} | {
is_null: {
key: string;
};
} | {
has_id: (string | number)[];
} | {
nested: {
key: string;
filter: any;
};
} | (any | {
key: string;
match?: Record<string, unknown> | {
value: string | number | boolean;
} | {
text: string;
} | {
any: string[] | number[];
} | {
except: string[] | number[];
} | null | undefined;
range?: Record<string, unknown> | {
lt?: number | null | undefined;
gt?: number | null | undefined;
gte?: number | null | undefined;
lte?: number | null | undefined;
} | {
lt?: string | null | undefined;
gt?: string | null | undefined;
gte?: string | null | undefined;
lte?: string | null | undefined;
} | null | undefined;
geo_bounding_box?: Record<string, unknown> | {
top_left: {
lon: number;
lat: number;
};
bottom_right: {
lon: number;
lat: number;
};
} | null | undefined;
geo_radius?: Record<string, unknown> | {
center: {
lon: number;
lat: number;
};
radius: number;
} | null | undefined;
geo_polygon?: Record<string, unknown> | {
exterior: {
points: {
lon: number;
lat: number;
}[];
};
interiors?: {
points: {
lon: number;
lat: number;
}[];
}[] | null | undefined;
} | null | undefined;
values_count?: Record<string, unknown> | {
lt?: number | null | undefined;
gt?: number | null | undefined;
gte?: number | null | undefined;
lte?: number | null | undefined;
} | null | undefined;
} | {
is_empty: {
key: string;
};
} | {
is_null: {
key: string;
};
} | {
has_id: (string | number)[];
} | {
nested: {
key: string;
filter: any;
};
})[] | null | undefined;
must_not?: Record<string, unknown> | any | {
key: string;
match?: Record<string, unknown> | {
value: string | number | boolean;
} | {
text: string;
} | {
any: string[] | number[];
} | {
except: string[] | number[];
} | null | undefined;
range?: Record<string, unknown> | {
lt?: number | null | undefined;
gt?: number | null | undefined;
gte?: number | null | undefined;
lte?: number | null | undefined;
} | {
lt?: string | null | undefined;
gt?: string | null | undefined;
gte?: string | null | undefined;
lte?: string | null | undefined;
} | null | undefined;
geo_bounding_box?: Record<string, unknown> | {
top_left: {
lon: number;
lat: number;
};
bottom_right: {
lon: number;
lat: number;
};
} | null | undefined;
geo_radius?: Record<string, unknown> | {
center: {
lon: number;
lat: number;
};
radius: number;
} | null | undefined;
geo_polygon?: Record<string, unknown> | {
exterior: {
points: {
lon: number;
lat: number;
}[];
};
interiors?: {
points: {
lon: number;
lat: number;
}[];
}[] | null | undefined;
} | null | undefined;
values_count?: Record<string, unknown> | {
lt?: number | null | undefined;
gt?: number | null | undefined;
gte?: number | null | undefined;
lte?: number | null | undefined;
} | null | undefined;
} | {
is_empty: {
key: string;
};
} | {
is_null: {
key: string;
};
} | {
has_id: (string | number)[];
} | {
nested: {
key: string;
filter: any;
};
} | (any | {
key: string;
match?: Record<string, unknown> | {
value: string | number | boolean;
} | {
text: string;
} | {
any: string[] | number[];
} | {
except: string[] | number[];
} | null | undefined;
range?: Record<string, unknown> | {
lt?: number | null | undefined;
gt?: number | null | undefined;
gte?: number | null | undefined;
lte?: number | null | undefined;
} | {
lt?: string | null | undefined;
gt?: string | null | undefined;
gte?: string | null | undefined;
lte?: string | null | undefined;
} | null | undefined;
geo_bounding_box?: Record<string, unknown> | {
top_left: {
lon: number;
lat: number;
};
bottom_right: {
lon: number;
lat: number;
};
} | null | undefined;
geo_radius?: Record<string, unknown> | {
center: {
lon: number;
lat: number;
};
radius: number;
} | null | undefined;
geo_polygon?: Record<string, unknown> | {
exterior: {
points: {
lon: number;
lat: number;
}[];
};
interiors?: {
points: {
lon: number;
lat: number;
}[];
}[] | null | undefined;
} | null | undefined;
values_count?: Record<string, unknown> | {
lt?: number | null | undefined;
gt?: number | null | undefined;
gte?: number | null | undefined;
lte?: number | null | undefined;
} | null | undefined;
} | {
is_empty: {
key: string;
};
} | {
is_null: {
key: string;
};
} | {
has_id: (string | number)[];
} | {
nested: {
key: string;
filter: any;
};
})[] | null | undefined;
};
shard_key?: string | number | Record<string, unknown> | (string | number)[] | null | undefined;
};
};
} | undefined;
responses: {
200: {
content: {
"application/json": {
time?: number | undefined;
status?: string | undefined;
result?: {
operation_id?: number | null | undefined;
status: "acknowledged" | "completed";
} | undefined;
};
};
};
default: {
content: {
"application/json": {
time?: number | undefined;
status?: {
error?: string | undefined;
} | undefined;
result?: Record<string, unknown> | null | undefined;
};
};
};
"4XX": {
content: {
"application/json": {
time?: number | undefined;
status?: {
error?: string | undefined;
} | undefined;
result?: Record<string, unknown> | null | undefined;
};
};
};
};
}>;
/**
* Count points which matches given filtering condition
*/
readonly countPoints: import("@qdrant/openapi-typescript-fetch").TypedFetch<{
parameters: {
query?: {
timeout?: number | undefined;
} | undefined;
path: {
collection_name: string;
};
};
requestBody?: {
content: {
"application/json": {
shard_key?: string | number | Record<string, unknown> | (string | number)[] | null | undefined;
filter?: Record<string, unknown> | {
should?: Record<string, unknown> | any | {
key: string;
match?: Record<string, unknown> | {
value: string | number | boolean;
} | {
text: string;
} | {
any: string[] | number[];
} | {
except: string[] | number[];
} | null | undefined;
range?: Record<string, unknown> | {
lt?: number | null | undefined;
gt?: number | null | undefined;
gte?: number | null | undefined;
lte?: number | null | undefined;
} | {
lt?: string | null | undefined;
gt?: string | null | undefined;
gte?: string | null | undefined;
lte?: string | null | undefined;
} | null | undefined;
geo_bounding_box?: Record<string, unknown> | {
top_left: {
lon: number;
lat: number;
};
bottom_right: {
lon: number;
lat: number;
};
} | null | undefined;
geo_radius?: Record<string, unknown> | {
center: {
lon: number;
lat: number;
};
radius: number;
} | null | undefined;
geo_polygon?: Record<string, unknown> | {
exterior: {
points: {
lon: number;
lat: number;
}[];
};
interiors?: {
points: {
lon: number;
lat: number;
}[];
}[] | null | undefined;
} | null | undefined;
values_count?: Record<string, unknown> | {
lt?: number | null | undefined;
gt?: number | null | undefined;
gte?: number | null | undefined;
lte?: number | null | undefined;
} | null | undefined;
} | {
is_empty: {
key: string;
};
} | {
is_null: {
key: string;
};
} | {
has_id: (string | number)[];
} | {
nested: {
key: string;
filter: any;
};
} | (any | {
key: string;
match?: Record<string, unknown> | {
value: string | number | boolean;
} | {
text: string;
} | {
any: string[] | number[];
} | {
except: string[] | number[];
} | null | undefined;
range?: Record<string, unknown> | {
lt?: number | null | undefined;
gt?: number | null | undefined;
gte?: number | null | undefined;
lte?: number | null | undefined;
} | {
lt?: string | null | undefined;
gt?: string | null | undefined;
gte?: string | null | undefined;
lte?: string | null | undefined;
} | null | undefined;
geo_bounding_box?: Record<string, unknown> | {
top_left: {
lon: number;
lat: number;
};
bottom_right: {
lon: number;
lat: number;
};
} | null | undefined;
geo_radius?: Record<string, unknown> | {
center: {
lon: number;
lat: number;
};
radius: number;
} | null | undefined;
geo_polygon?: Record<string, unknown> | {
exterior: {
points: {
lon: number;
lat: number;
}[];
};
interiors?: {
points: {
lon: number;
lat: number;
}[];
}[] | null | undefined;
} | null | undefined;
values_count?: Record<string, unknown> | {
lt?: number | null | undefined;
gt?: number | null | undefined;
gte?: number | null | undefined;
lte?: number | null | undefined;
} | null | undefined;
} | {
is_empty: {
key: string;
};
} | {
is_null: {
key: string;
};
} | {
has_id: (string | number)[];
} | {
nested: {
key: string;
filter: any;
};
})[] | null | undefined;
min_should?: Record<string, unknown> | {
conditions: (any | {
key: string;
match?: Record<string, unknown> | {
value: string | number | boolean;
} | {
text: string;
} | {
any: string[] | number[];
} | {
except: string[] | number[];
} | null | undefined;
range?: Record<string, unknown> | {
lt?: number | null | undefined;
gt?: number | null | undefined;
gte?: number | null | undefined;
lte?: number | null | undefined;
} | {
lt?: string | null | undefined;
gt?: string | null | undefined;
gte?: string | null | undefined;
lte?: string | null | undefined;
} | null | undefined;
geo_bounding_box?: Record<string, unknown> | {
top_left: {
lon: number;
lat: number;
};
bottom_right: {
lon: number;
lat: number;
};
} | null | undefined;
geo_radius?: Record<string, unknown> | {
center: {
lon: number;
lat: number;
};
radius: number;
} | null | undefined;
geo_polygon?: Record<string, unknown> | {
exterior: {
points: {
lon: number;
lat: number;
}[];
};
interiors?: {
points: {
lon: number;
lat: number;
}[];
}[] | null | undefined;
} | null | undefined;
values_count?: Record<string, unknown> | {
lt?: number | null | undefined;
gt?: number | null | undefined;
gte?: number | null | undefined;
lte?: number | null | undefined;
} | null | undefined;
} | {
is_empty: {
key: string;
};
} | {
is_null: {
key: string;
};
} | {
has_id: (string | number)[];
} | {
nested: {
key: string;
filter: any;
};
})[];
min_count: number;
} | null | undefined;
must?: Record<string, unknown> | any | {
key: string;
match?: Record<string, unknown> | {
value: string | number | boolean;
} | {
text: string;
} | {
any: string[] | number[];
} | {
except: string[] | number[];
} | null | undefined;
range?: Record<string, unknown> | {
lt?: number | null | undefined;
gt?: number | null | undefined;
gte?: number | null | undefined;
lte?: number | null | undefined;
} | {
lt?: string | null | undefined;
gt?: string | null | undefined;
gte?: string | null | undefined;
lte?: string | null | undefined;
} | null | undefined;
geo_bounding_box?: Record<string, unknown> | {
top_left: {
lon: number;
lat: number;
};
bottom_right: {
lon: number;
lat: number;
};
} | null | undefined;
geo_radius?: Record<string, unknown> | {
center: {
lon: number;
lat: number;
};
radius: number;
} | null | undefined;
geo_polygon?: Record<string, unknown> | {
exterior: {
points: {
lon: number;
lat: number;
}[];
};
interiors?: {
points: {
lon: number;
lat: number;
}[];
}[] | null | undefined;
} | null | undefined;
values_count?: Record<string, unknown> | {
lt?: number | null | undefined;
gt?: number | null | undefined;
gte?: number | null | undefined;
lte?: number | null | undefined;
} | null | undefined;
} | {
is_empty: {
key: string;
};
} | {
is_null: {
key: string;
};
} | {
has_id: (string | number)[];
} | {
nested: {
key: string;
filter: any;
};
} | (any | {
key: string;
match?: Record<string, unknown> | {
value: string | number | boolean;
} | {
text: string;
} | {
any: string[] | number[];
} | {
except: string[] | number[];
} | null | undefined;
range?: Record<string, unknown> | {
lt?: number | null | undefined;
gt?: number | null | undefined;
gte?: number | null | undefined;
lte?: number | null | undefined;
} | {
lt?: string | null | undefined;
gt?: string | null | undefined;
gte?: string | null | undefined;
lte?: string | null | undefined;
} | null | undefined;
geo_bounding_box?: Record<string, unknown> | {
top_left: {
lon: number;
lat: number;
};
bottom_right: {
lon: number;
lat: number;
};
} | null | undefined;
geo_radius?: Record<string, unknown> | {
center: {
lon: number;
lat: number;
};
radius: number;
} | null | undefined;
geo_polygon?: Record<string, unknown> | {
exterior: {
points: {
lon: number;
lat: number;
}[];
};
interiors?: {
points: {
lon: number;
lat: number;
}[];
}[] | null | undefined;
} | null | undefined;
values_count?: Record<string, unknown> | {
lt?: number | null | undefined;
gt?: number | null | undefined;
gte?: number | null | undefined;
lte?: number | null | undefined;
} | null | undefined;
} | {
is_empty: {
key: string;
};
} | {
is_null: {
key: string;
};
} | {
has_id: (string | number)[];
} | {
nested: {
key: string;
filter: any;
};
})[] | null | undefined;
must_not?: Record<string, unknown> | any | {
key: string;
match?: Record<string, unknown> | {
value: string | number | boolean;
} | {
text: string;
} | {
any: string[] | number[];
} | {
except: string[] | number[];
} | null | undefined;
range?: Record<string, unknown> | {
lt?: number | null | undefined;
gt?: number | null | undefined;
gte?: number | null | undefined;
lte?: number | null | undefined;
} | {
lt?: string | null | undefined;
gt?: string | null | undefined;
gte?: string | null | undefined;
lte?: string | null | undefined;
} | null | undefined;
geo_bounding_box?: Record<string, unknown> | {
top_left: {
lon: number;
lat: number;
};
bottom_right: {
lon: number;
lat: number;
};
} | null | undefined;
geo_radius?: Record<string, unknown> | {
center: {
lon: number;
lat