Retrieves parameters from the specified collection.

Get collection details

Create a collection

API Reference

BinaryQuantization

BinaryQuantizationConfig

BoolIndexParams

CollectionConfig

CollectionConfigQuantizationConfig

Current statistics and configuration of the collection

CollectionInfo

Approximate number of indexed vectors in the collection. Indexed vectors in large segments are faster to query, as it is stored in a specialized vector index.

Approximate number of points (vectors + payloads) in collection. Each point could be accessed by unique id.

Number of segments in collection. Each segment has independent vector as payload indexes

CollectionParams

Sharding method Default is Auto - points are distributed across all available shards Custom - points are distributed across shards according to shard key

Defines how many replicas should apply the operation for us to consider it successful. Increasing this number will make the collection more resilient to inconsistencies, but will also make it fail if not enough replicas are available. Does not have any performance impact.

Defines how many additional replicas should be processing read request at the same time. Default value is Auto, which means that fan-out will be determined automatically based on the busyness of the local replica. Having more than 0 might be useful to smooth latency spikes of individual nodes.

If true - point's payload will not be stored in memory. It will be read from the disk every time it is requested. This setting saves RAM by (slightly) increasing the response time. Note: those payload values that are involved in filtering and are indexed - remain in RAM.

Configuration of the sparse vector storage

CollectionParamsShardingMethod

CollectionStatus

CompressionRatio

Datatype

DatetimeIndexParams

If true - use this key to organize storage of the collection data. This option assumes that this key will be used in majority of filtered requests.

If true, store the index on disk. Default: false.

Type of internal tags, build from payload Distance function types used to compare vectors

Distance

FloatIndexParams

GeoIndexParams

HnswConfig

Number of edges per node in the index graph. Larger the value - more accurate the search, more space required.

Number of neighbours to consider during the index building. Larger the value - more accurate the search, more time required to build index.

Number of parallel threads used for background index building. If 0 - automatically select from 8 to 16. Best to keep between 8 and 16 to prevent likelihood of slow building or broken/inefficient HNSW graphs. On small CPUs, less threads are used.

Store HNSW index on disk. If set to false, index will be stored in RAM. Default: false

Custom M param for hnsw graph built for payload index. If not set, default M will be used.

HnswConfigDiff

Number of neighbours to consider during the index building. Larger the value - more accurate the search, more time required to build the index.

Number of parallel threads used for background index building. If 0 - automatically select from 8 to 16. Best to keep between 8 and 16 to prevent likelihood of building broken/inefficient HNSW graphs. On small CPUs, less threads are used.

Store HNSW index on disk. If set to false, the index will be stored in RAM. Default: false

Custom M param for additional payload-aware HNSW links. If not set, default M will be used.

IntegerIndexParams

KeywordIndexParams

If true - used for tenant optimization. Default: false.

If used, include weight modification, which will be applied to sparse vectors at query time: None - no modification (default) Idf - inverse document frequency, based on statistics of the collection

Modifier

MultiVectorComparator

MultiVectorConfig

OptimizersConfig

The minimal fraction of deleted vectors in a segment, required to perform segment optimization

The minimal number of vectors in a segment, required to perform segment optimization

Maximum size (in kilobytes) of vectors allowed for plain index, exceeding this threshold will enable vector indexing

Default value is 20,000, based on <https://github.com/google-research/google-research/blob/master/scann/docs/algorithms.md>.

To disable vector indexing, set to `0`.

Note: 1kB = 1 vector of size 256.

OptimizersStatus

OptimizersStatusError

Display payload field type & index information

PayloadIndexInfo

PayloadIndexInfoParams

PayloadSchemaParams

PayloadSchemaType

ProductQuantization

ProductQuantizationConfig

QuantizationConfig

ScalarQuantization

ScalarQuantizationConfig

Quantile for quantization. Expected value range in [0.5, 1.0]. If not set - use the whole range of values

If true - quantized vectors always will be stored in RAM, ignoring the config of main storage

ScalarType

ShardingMethod

SparseIndexParams

Store index on disk. If set to false, the index will be stored in RAM. Default: false

SparseIndexParamsDatatype

Params of single sparse vector data storage

SparseVectorParams

Custom params for index. If none - values from collection configuration are used.

Configures addition value modifications for sparse vectors. Default: none

SparseVectorParamsIndex

SparseVectorParamsModifier

TextIndexParams

If true, lowercase all tokens. Default: true.

TokenizerType

UuidIndexParams

VectorParams

Custom params for HNSW index. If none - values from collection configuration are used.

Custom params for quantization. If none - values from collection configuration are used.

If true, vectors are served from disk, improving RAM usage at the cost of latency Default: false

VectorParamsDatatype

VectorParamsHnswConfig

VectorParamsMultivectorConfig

VectorParamsQuantizationConfig

Vector params separator for single and multiple vector modes Single mode:

{ "size": 128, "distance": "Cosine" }

or multiple mode:

{ "default": { "size": 128, "distance": "Cosine" } }

1	{
2	"time": 0.002,
3	"status": "ok",
4	"result": {
5	"status": "green",
6	"optimizer_status": "ok",
7	"segments_count": 1,
8	"config": {
9	"params": {},
10	"hnsw_config": {
11	"m": 1,
12	"ef_construct": 1,
13	"full_scan_threshold": 1
14	},
15	"optimizer_config": {
16	"deleted_threshold": 1.1,
17	"vacuum_min_vector_number": 1,
18	"default_segment_number": 1,
19	"flush_interval_sec": 1
20	},
21	"wal_config": {
22	"wal_capacity_mb": 1,
23	"wal_segments_ahead": 1
24	},
25	"quantization_config": {
26	"scalar": {
27	"type": "int8"
28	}
29	}
30	},
31	"payload_schema": {
32	"payload_schema": {
33	"data_type": "keyword",
34	"points": 1
35	}
36	},
37	"vectors_count": 1,
38	"indexed_vectors_count": 1,
39	"points_count": 1
40	}
41	}

Get collection details

Path parameters

Response

1	curl -X GET \
2	'http://localhost:6333/collections/collection_name' \
3	--header 'api-key: <api-key-value>'