@qdrant/js-client-rest
Version:
This repository contains the REST client for the [Qdrant](https://github.com/qdrant/qdrant) vector search engine.
737 lines • 52.1 kB
TypeScript
import { Client } from '../api-client.js';
export declare function createServiceApi(client: Client): {
/**
* Get lock options. If write is locked, all write operations and collection creation are forbidden
*/
readonly getLocks: import("@qdrant/openapi-typescript-fetch").TypedFetch<{
responses: {
200: {
content: {
"application/json": {
time?: number | undefined;
status?: string | undefined;
result?: {
error_message?: string | null | undefined;
write: boolean;
} | 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;
};
};
};
};
}>;
/**
* Collect metrics data including app info, collections info, cluster info and statistics
*/
readonly metrics: import("@qdrant/openapi-typescript-fetch").TypedFetch<{
parameters: {
query?: {
anonymize?: boolean | undefined;
} | undefined;
};
responses: {
200: {
content: {
"text/plain": string;
};
};
"4XX": never;
};
}>;
/**
* Set lock options. If write is locked, all write operations and collection creation are forbidden. Returns previous lock options
*/
readonly postLocks: import("@qdrant/openapi-typescript-fetch").TypedFetch<{
requestBody?: {
content: {
"application/json": {
error_message?: string | null | undefined;
write: boolean;
};
};
} | undefined;
responses: {
200: {
content: {
"application/json": {
time?: number | undefined;
status?: string | undefined;
result?: {
error_message?: string | null | undefined;
write: boolean;
} | 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;
};
};
};
};
}>;
/**
* Collect telemetry data including app info, system info, collections info, cluster info, configs and statistics
*/
readonly telemetry: import("@qdrant/openapi-typescript-fetch").TypedFetch<{
parameters: {
query?: {
anonymize?: boolean | undefined;
} | undefined;
};
responses: {
200: {
content: {
"application/json": {
time?: number | undefined;
status?: string | undefined;
result?: {
id: string;
app: {
name: string;
version: string;
features?: Record<string, unknown> | {
debug: boolean;
web_feature: boolean;
service_debug_feature: boolean;
recovery_mode: boolean;
} | null | undefined;
system?: Record<string, unknown> | {
distribution?: string | null | undefined;
distribution_version?: string | null | undefined;
is_docker: boolean;
cores?: number | null | undefined;
ram_size?: number | null | undefined;
disk_size?: number | null | undefined;
cpu_flags: string;
} | null | undefined;
jwt_rbac?: boolean | null | undefined;
startup: string;
};
collections: {
number_of_collections: number;
collections?: ({
id: string;
init_time_ms: number;
config: {
params: {
vectors?: {
size: number;
distance: "Cosine" | "Euclid" | "Dot" | "Manhattan";
hnsw_config?: Record<string, unknown> | {
m?: number | null | undefined;
ef_construct?: number | null | undefined;
full_scan_threshold?: number | null | undefined;
max_indexing_threads?: number | null | undefined;
on_disk?: boolean | null | undefined;
payload_m?: number | null | undefined;
} | null | undefined;
quantization_config?: Record<string, unknown> | {
scalar: {
type: "int8";
quantile?: number | null | undefined;
always_ram?: boolean | null | undefined;
};
} | {
product: {
compression: "x4" | "x8" | "x16" | "x32" | "x64";
always_ram?: boolean | null | undefined;
};
} | {
binary: {
always_ram?: boolean | null | undefined;
};
} | null | undefined;
on_disk?: boolean | null | undefined;
datatype?: Record<string, unknown> | "float32" | "uint8" | "float16" | null | undefined;
multivector_config?: Record<string, unknown> | {
comparator: "max_sim";
} | null | undefined;
} | {
[key: string]: {
size: number;
distance: "Cosine" | "Euclid" | "Dot" | "Manhattan";
hnsw_config?: Record<string, unknown> | {
m?: number | null | undefined;
ef_construct?: number | null | undefined;
full_scan_threshold?: number | null | undefined;
max_indexing_threads?: number | null | undefined;
on_disk?: boolean | null | undefined;
payload_m?: number | null | undefined;
} | null | undefined;
quantization_config?: Record<string, unknown> | {
scalar: {
type: "int8";
quantile?: number | null | undefined;
always_ram?: boolean | null | undefined;
};
} | {
product: {
compression: "x4" | "x8" | "x16" | "x32" | "x64";
always_ram?: boolean | null | undefined;
};
} | {
binary: {
always_ram?: boolean | null | undefined;
};
} | null | undefined;
on_disk?: boolean | null | undefined;
datatype?: Record<string, unknown> | "float32" | "uint8" | "float16" | null | undefined;
multivector_config?: Record<string, unknown> | {
comparator: "max_sim";
} | null | undefined;
} | undefined;
} | undefined;
shard_number?: number | undefined;
sharding_method?: Record<string, unknown> | "auto" | "custom" | null | undefined;
replication_factor?: number | undefined;
write_consistency_factor?: number | undefined;
read_fan_out_factor?: number | null | undefined;
on_disk_payload?: boolean | undefined;
sparse_vectors?: {
[key: string]: {
index?: Record<string, unknown> | {
full_scan_threshold?: number | null | undefined;
on_disk?: boolean | null | undefined;
datatype?: Record<string, unknown> | "float32" | "uint8" | "float16" | null | undefined;
} | null | undefined;
modifier?: Record<string, unknown> | "none" | "idf" | null | undefined;
} | undefined;
} | null | undefined;
};
hnsw_config: {
m: number;
ef_construct: number;
full_scan_threshold: number;
max_indexing_threads?: number | undefined;
on_disk?: boolean | null | undefined;
payload_m?: number | null | undefined;
};
optimizer_config: {
deleted_threshold: number;
vacuum_min_vector_number: number;
default_segment_number: number;
max_segment_size?: number | null | undefined;
memmap_threshold?: number | null | undefined;
indexing_threshold?: number | null | undefined;
flush_interval_sec: number;
max_optimization_threads?: number | null | undefined;
};
wal_config: {
wal_capacity_mb: number;
wal_segments_ahead: number;
};
quantization_config?: Record<string, unknown> | {
scalar: {
type: "int8";
quantile?: number | null | undefined;
always_ram?: boolean | null | undefined;
};
} | {
product: {
compression: "x4" | "x8" | "x16" | "x32" | "x64";
always_ram?: boolean | null | undefined;
};
} | {
binary: {
always_ram?: boolean | null | undefined;
};
} | null | undefined;
};
shards: {
id: number;
local?: Record<string, unknown> | {
variant_name?: string | null | undefined;
segments: {
info: {
segment_type: "plain" | "indexed" | "special";
num_vectors: number;
num_points: number;
num_indexed_vectors: number;
num_deleted_vectors: number;
ram_usage_bytes: number;
disk_usage_bytes: number;
is_appendable: boolean;
index_schema: {
[key: string]: {
data_type: "keyword" | "integer" | "float" | "geo" | "text" | "bool" | "datetime" | "uuid";
params?: Record<string, unknown> | {
type: "keyword";
is_tenant?: boolean | null | undefined;
on_disk?: boolean | null | undefined;
} | {
type: "integer";
lookup: boolean;
range: boolean;
is_principal?: boolean | null | undefined;
on_disk?: boolean | null | undefined;
} | {
type: "float";
is_principal?: boolean | null | undefined;
on_disk?: boolean | null | undefined;
} | {
type: "geo";
} | {
type: "text";
tokenizer?: "prefix" | "whitespace" | "word" | "multilingual" | undefined;
min_token_len?: number | null | undefined;
max_token_len?: number | null | undefined;
lowercase?: boolean | null | undefined;
} | {
type: "bool";
} | {
type: "datetime";
is_principal?: boolean | null | undefined;
on_disk?: boolean | null | undefined;
} | {
type: "uuid";
is_tenant?: boolean | null | undefined;
on_disk?: boolean | null | undefined;
} | null | undefined;
points: number;
} | undefined;
};
vector_data: {
[key: string]: {
num_vectors: number;
num_indexed_vectors: number;
num_deleted_vectors: number;
} | undefined;
};
};
config: {
vector_data?: {
[key: string]: {
size: number;
distance: "Cosine" | "Euclid" | "Dot" | "Manhattan";
storage_type: "Memory" | "Mmap" | "ChunkedMmap" | "InRamChunkedMmap";
index: ({} & {
type: "hnsw";
options: {
m: number;
ef_construct: number;
full_scan_threshold: number;
max_indexing_threads?: number | undefined;
on_disk?: boolean | null | undefined;
payload_m?: number | null | undefined;
};
}) | ({} & {
type: "plain";
options: Record<string, never>;
});
quantization_config?: Record<string, unknown> | {
scalar: {
type: "int8";
quantile?: number | null | undefined;
always_ram?: boolean | null | undefined;
};
} | {
product: {
compression: "x4" | "x8" | "x16" | "x32" | "x64";
always_ram?: boolean | null | undefined;
};
} | {
binary: {
always_ram?: boolean | null | undefined;
};
} | null | undefined;
multivector_config?: Record<string, unknown> | {
comparator: "max_sim";
} | null | undefined;
datatype?: Record<string, unknown> | "float32" | "uint8" | "float16" | null | undefined;
} | undefined;
} | undefined;
sparse_vector_data?: {
[key: string]: {
index: {
full_scan_threshold?: number | null | undefined;
index_type: "Mmap" | "MutableRam" | "ImmutableRam";
datatype?: Record<string, unknown> | "float32" | "uint8" | "float16" | null | undefined;
};
} | undefined;
} | undefined;
payload_storage_type: ({} & {
type: "on_disk";
}) | ({} & {
type: "in_memory";
});
};
vector_index_searches: {
index_name?: string | null | undefined;
unfiltered_plain: {
count: number;
fail_count?: number | undefined;
avg_duration_micros?: number | null | undefined;
min_duration_micros?: number | null | undefined;
max_duration_micros?: number | null | undefined;
total_duration_micros: number;
last_responded?: string | null | undefined;
};
unfiltered_hnsw: {
count: number;
fail_count?: number | undefined;
avg_duration_micros?: number | null | undefined;
min_duration_micros?: number | null | undefined;
max_duration_micros?: number | null | undefined;
total_duration_micros: number;
last_responded?: string | null | undefined;
};
unfiltered_sparse: {
count: number;
fail_count?: number | undefined;
avg_duration_micros?: number | null | undefined;
min_duration_micros?: number | null | undefined;
max_duration_micros?: number | null | undefined;
total_duration_micros: number;
last_responded?: string | null | undefined;
};
filtered_plain: {
count: number;
fail_count?: number | undefined;
avg_duration_micros?: number | null | undefined;
min_duration_micros?: number | null | undefined;
max_duration_micros?: number | null | undefined;
total_duration_micros: number;
last_responded?: string | null | undefined;
};
filtered_small_cardinality: {
count: number;
fail_count?: number | undefined;
avg_duration_micros?: number | null | undefined;
min_duration_micros?: number | null | undefined;
max_duration_micros?: number | null | undefined;
total_duration_micros: number;
last_responded?: string | null | undefined;
};
filtered_large_cardinality: {
count: number;
fail_count?: number | undefined;
avg_duration_micros?: number | null | undefined;
min_duration_micros?: number | null | undefined;
max_duration_micros?: number | null | undefined;
total_duration_micros: number;
last_responded?: string | null | undefined;
};
filtered_exact: {
count: number;
fail_count?: number | undefined;
avg_duration_micros?: number | null | undefined;
min_duration_micros?: number | null | undefined;
max_duration_micros?: number | null | undefined;
total_duration_micros: number;
last_responded?: string | null | undefined;
};
filtered_sparse: {
count: number;
fail_count?: number | undefined;
avg_duration_micros?: number | null | undefined;
min_duration_micros?: number | null | undefined;
max_duration_micros?: number | null | undefined;
total_duration_micros: number;
last_responded?: string | null | undefined;
};
unfiltered_exact: {
count: number;
fail_count?: number | undefined;
avg_duration_micros?: number | null | undefined;
min_duration_micros?: number | null | undefined;
max_duration_micros?: number | null | undefined;
total_duration_micros: number;
last_responded?: string | null | undefined;
};
}[];
payload_field_indices: {
field_name?: string | null | undefined;
points_values_count: number;
points_count: number;
histogram_bucket_size?: number | null | undefined;
}[];
}[];
optimizations: {
status: "ok" | {
error: string;
};
optimizations: {
count: number;
fail_count?: number | undefined;
avg_duration_micros?: number | null | undefined;
min_duration_micros?: number | null | undefined;
max_duration_micros?: number | null | undefined;
total_duration_micros: number;
last_responded?: string | null | undefined;
};
log: {
name: string;
segment_ids: number[];
status: "optimizing" | "done" | {
cancelled: string;
} | {
error: string;
};
start_at: string;
end_at?: string | null | undefined;
}[];
};
} | null | undefined;
remote: {
shard_id: number;
peer_id?: number | null | undefined;
searches: {
count: number;
fail_count?: number | undefined;
avg_duration_micros?: number | null | undefined;
min_duration_micros?: number | null | undefined;
max_duration_micros?: number | null | undefined;
total_duration_micros: number;
last_responded?: string | null | undefined;
};
updates: {
count: number;
fail_count?: number | undefined;
avg_duration_micros?: number | null | undefined;
min_duration_micros?: number | null | undefined;
max_duration_micros?: number | null | undefined;
total_duration_micros: number;
last_responded?: string | null | undefined;
};
}[];
replicate_states: {
[key: string]: "Active" | "Dead" | "Partial" | "Initializing" | "Listener" | "PartialSnapshot" | "Recovery" | undefined;
};
}[];
transfers: {
shard_id: number;
from: number;
to: number;
sync: boolean;
method?: Record<string, unknown> | "stream_records" | "snapshot" | "wal_delta" | null | undefined;
comment?: string | null | undefined;
}[];
} | {
vectors: number;
optimizers_status: "ok" | {
error: string;
};
params: {
vectors?: {
size: number;
distance: "Cosine" | "Euclid" | "Dot" | "Manhattan";
hnsw_config?: Record<string, unknown> | {
m?: number | null | undefined;
ef_construct?: number | null | undefined;
full_scan_threshold?: number | null | undefined;
max_indexing_threads?: number | null | undefined;
on_disk?: boolean | null | undefined;
payload_m?: number | null | undefined;
} | null | undefined;
quantization_config?: Record<string, unknown> | {
scalar: {
type: "int8";
quantile?: number | null | undefined;
always_ram?: boolean | null | undefined;
};
} | {
product: {
compression: "x4" | "x8" | "x16" | "x32" | "x64";
always_ram?: boolean | null | undefined;
};
} | {
binary: {
always_ram?: boolean | null | undefined;
};
} | null | undefined;
on_disk?: boolean | null | undefined;
datatype?: Record<string, unknown> | "float32" | "uint8" | "float16" | null | undefined;
multivector_config?: Record<string, unknown> | {
comparator: "max_sim";
} | null | undefined;
} | {
[key: string]: {
size: number;
distance: "Cosine" | "Euclid" | "Dot" | "Manhattan";
hnsw_config?: Record<string, unknown> | {
m?: number | null | undefined;
ef_construct?: number | null | undefined;
full_scan_threshold?: number | null | undefined;
max_indexing_threads?: number | null | undefined;
on_disk?: boolean | null | undefined;
payload_m?: number | null | undefined;
} | null | undefined;
quantization_config?: Record<string, unknown> | {
scalar: {
type: "int8";
quantile?: number | null | undefined;
always_ram?: boolean | null | undefined;
};
} | {
product: {
compression: "x4" | "x8" | "x16" | "x32" | "x64";
always_ram?: boolean | null | undefined;
};
} | {
binary: {
always_ram?: boolean | null | undefined;
};
} | null | undefined;
on_disk?: boolean | null | undefined;
datatype?: Record<string, unknown> | "float32" | "uint8" | "float16" | null | undefined;
multivector_config?: Record<string, unknown> | {
comparator: "max_sim";
} | null | undefined;
} | undefined;
} | undefined;
shard_number?: number | undefined;
sharding_method?: Record<string, unknown> | "auto" | "custom" | null | undefined;
replication_factor?: number | undefined;
write_consistency_factor?: number | undefined;
read_fan_out_factor?: number | null | undefined;
on_disk_payload?: boolean | undefined;
sparse_vectors?: {
[key: string]: {
index?: Record<string, unknown> | {
full_scan_threshold?: number | null | undefined;
on_disk?: boolean | null | undefined;
datatype?: Record<string, unknown> | "float32" | "uint8" | "float16" | null | undefined;
} | null | undefined;
modifier?: Record<string, unknown> | "none" | "idf" | null | undefined;
} | undefined;
} | null | undefined;
};
})[] | null | undefined;
};
cluster: {
enabled: boolean;
status?: Record<string, unknown> | {
number_of_peers: number;
term: number;
commit: number;
pending_operations: number;
role?: Record<string, unknown> | "Follower" | "Candidate" | "Leader" | "PreCandidate" | null | undefined;
is_voter: boolean;
peer_id?: number | null | undefined;
consensus_thread_status: ({
last_update?: undefined;
} & {
consensus_thread_status: "stopped_with_err";
err: string;
}) | ({
err?: undefined;
} & (({
last_update?: undefined;
} & {
consensus_thread_status: "stopped";
}) | ({} & {
consensus_thread_status: "working";
last_update: string;
})));
} | null | undefined;
config?: Record<string, unknown> | {
grpc_timeout_ms: number;
p2p: {
connection_pool_size: number;
};
consensus: {
max_message_queue_size: number;
tick_period_ms: number;
bootstrap_timeout_sec: number;
};
} | null | undefined;
};
requests: {
rest: {
responses: {
[key: string]: {
[key: string]: {
count: number;
fail_count?: number | undefined;
avg_duration_micros?: number | null | undefined;
min_duration_micros?: number | null | undefined;
max_duration_micros?: number | null | undefined;
total_duration_micros: number;
last_responded?: string | null | undefined;
} | undefined;
} | undefined;
};
};
grpc: {
responses: {
[key: string]: {
count: number;
fail_count?: number | undefined;
avg_duration_micros?: number | null | undefined;
min_duration_micros?: number | null | undefined;
max_duration_micros?: number | null | undefined;
total_duration_micros: number;
last_responded?: string | null | undefined;
} | undefined;
};
};
};
} | 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;
};
};
};
};
}>;
/**
* An endpoint for health checking used in Kubernete