Schemathesis 4.29.4
API Coverage Report
2026-10-08 23:28:37
Operations
Operations called at least once
100% 69 of 69 called
Parameters
Tested with valid and invalid values
80.6% 154 of 191 covered
Keywords
Constraints tested both ways
66.6% 5934 of 8898 covered
Examples
Schema examples sent in tests
100% 206 of 206 used
Responses
Documented response codes hit
58.4% 124 of 212 received
Show
Aliases 3 operations 3 covered 0 partial 0 uncovered 0 not measured 100% #
Responses1 of 3 documented received
codedescriptionhitsavg
200successful operation50ms
4XXerror0never seen
defaulterror0-
Query Parameters2 of 2 keywords covered
timeout2 / 2
#validinvalidschema
1141150{
214190 "minimum": 1,
323160 "type": "integer"
4141150}
Body35 of 35 keywords covered
application/json35 / 35
ChangeAliasesOperation
1192114{
219275 "properties": {
319275 "actions": {
419259 "items": {
556968 "$ref": "#/components/schemas/AliasOperations"
619259 },
725116 "type": "array"
819275 }
919275 },
1026723 "required": [
1126723 "actions"
1226723 ],
1329016 "type": "object"
14192114}
Referenced Components (7)43 of 43 keywords
AliasOperations5 of 5 keywords
156968{
256968 "anyOf": [
3303334 {
4303334 "$ref": "#/components/schemas/CreateAliasOperation"
5303334 },
6183454 {
7183454 "$ref": "#/components/schemas/DeleteAliasOperation"
8183454 },
983554 {
1083554 "$ref": "#/components/schemas/RenameAliasOperation"
1183554 }
1256968 ],
1356968}
CreateAlias7 of 7 keywords
130322{
230810 "properties": {
33125 "alias_name": {
43125 "type": "string"
53125 },
63095 "collection_name": {
73095 "type": "string"
83095 }
930810 },
103135 "required": [
113171 "alias_name",
123144 "collection_name"
133135 ],
143187 "type": "object"
1530322}
CreateAliasOperation6 of 6 keywords
1303334{
230322 "properties": {
330322 "create_alias": {
430322 "$ref": "#/components/schemas/CreateAlias"
530322 }
630322 },
7325295 "required": [
8325295 "create_alias"
9325295 ],
1062017 "type": "object"
11303334}
DeleteAlias6 of 6 keywords
118311{
21835 "properties": {
31835 "alias_name": {
41835 "type": "string"
51835 }
61835 },
71881 "required": [
81881 "alias_name"
91881 ],
101895 "type": "object"
1118311}
DeleteAliasOperation6 of 6 keywords
1183454{
218311 "properties": {
318311 "delete_alias": {
418311 "$ref": "#/components/schemas/DeleteAlias"
518311 }
618311 },
7194426 "required": [
8194426 "delete_alias"
9194426 ],
1062017 "type": "object"
11183454}
RenameAlias7 of 7 keywords
18317{
28510 "properties": {
3895 "new_alias_name": {
4895 "type": "string"
5895 },
6895 "old_alias_name": {
7895 "type": "string"
8895 }
98510 },
10932 "required": [
11941 "new_alias_name",
12941 "old_alias_name"
13932 ],
14955 "type": "object"
158317}
RenameAliasOperation6 of 6 keywords
183554{
28317 "properties": {
38317 "rename_alias": {
48317 "$ref": "#/components/schemas/RenameAlias"
58317 }
68317 },
7100520 "required": [
8100520 "rename_alias"
9100520 ],
1062017 "type": "object"
1183554}
Responses2 of 3 documented received
codedescriptionhitsavg
200successful operation6312ms
4XXerror3120ms
defaulterror0-
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
1227n/a{
2227n/a "type": "string"
3227n/a}
Responses1 of 3 documented received
codedescriptionhitsavg
200successful operation2270ms
4XXerror0never seen
defaulterror0-
Beta 2 operations 2 covered 0 partial 0 uncovered 0 not measured — #
Responses1 of 3 documented received
codedescriptionhitsavg
200successful operation50ms
4XXerror0never seen
defaulterror0-
Responses1 of 2 documented received
codedescriptionhitsavg
200Successful response50ms
4XXerror0never seen
Collections 9 operations 6 covered 3 partial 0 uncovered 0 not measured 61% #
Responses1 of 3 documented received
codedescriptionhitsavg
200successful operation10020ms
4XXerror0never seen
defaulterror0-
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
1144n/a{
2144n/a "type": "string"
3144n/a}
Query Parameters2 of 2 keywords covered
timeout2 / 2
11675{
21623 "minimum": 1,
33952 "type": "integer"
41675}
Responses2 of 3 documented received
codedescriptionhitsavg
200successful operation698ms
4XXerror750ms
defaulterror0-
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
1236n/a{
2236n/a "type": "string"
3236n/a}
Responses2 of 3 documented received
codedescriptionhitsavg
200successful operation2181ms
4XXerror180ms
defaulterror0-
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
1861n/a{
2861n/a "type": "string"
3861n/a}
Query Parameters2 of 2 keywords covered
timeout2 / 2
171023{
271010 "minimum": 1,
372013 "type": "integer"
471023}
Body198 of 353 keywords covered
application/json198 / 353
UpdateCollection
18335{
2629n/a "properties": {
3622n/a "hnsw_config": {
4622n/a "anyOf": [
539583 {
639583 "$ref": "#/components/schemas/HnswConfigDiff"
739583 },
8622n/a {
9622n/a "nullable": true
10622n/a }
11622n/a ],
12622n/a },
13622n/a "metadata": {
14622n/a "anyOf": [
153619 {
163619 "$ref": "#/components/schemas/Payload"
173619 },
18622n/a {
19622n/a "nullable": true
20622n/a }
21622n/a ],
22622n/a },
23621n/a "optimizers_config": {
24621n/a "anyOf": [
2541580 {
2641580 "$ref": "#/components/schemas/OptimizersConfigDiff"
2741580 },
28621n/a {
29621n/a "nullable": true
30621n/a }
31621n/a ],
32621n/a },
33620n/a "params": {
34620n/a "anyOf": [
3556564 {
3656564 "$ref": "#/components/schemas/CollectionParamsDiff"
3756564 },
38620n/a {
39620n/a "nullable": true
40620n/a }
41620n/a ],
42620n/a },
43619n/a "quantization_config": {
44619n/a "anyOf": [
45103516 {
46103516 "$ref": "#/components/schemas/QuantizationConfigDiff"
47103516 },
48619n/a {
49619n/a "nullable": true
50619n/a }
51619n/a ],
52619n/a },
53618n/a "sparse_vectors": {
54618n/a "anyOf": [
5549569 {
5649569 "$ref": "#/components/schemas/SparseVectorsConfig"
5749569 },
58618n/a {
59618n/a "nullable": true
60618n/a }
61618n/a ],
62618n/a },
63617n/a "strict_mode_config": {
64617n/a "anyOf": [
6536581 {
6636581 "$ref": "#/components/schemas/StrictModeConfig"
6736581 },
68617n/a {
69617n/a "nullable": true
70617n/a }
71617n/a ]
72617n/a },
73616n/a "vectors": {
74616n/a "anyOf": [
75174442 {
76174442 "$ref": "#/components/schemas/VectorsConfigDiff"
77174442 },
78616n/a {
79616n/a "nullable": true
80616n/a }
81616n/a ],
82616n/a }
83629n/a },
848335 "type": "object"
858335}
Referenced Components (36)215 of 386 keywords
BinaryQuantization3 of 6 keywords
176710{
2760 "properties": {
3760 "binary": {
4760 "$ref": "#/components/schemas/BinaryQuantizationConfig"
5760 }
6760 },
776131 "required": [
876131 "binary"
976131 ],
10207579 "type": "object"
1176710}
BinaryQuantizationConfig13 of 17 keywords
1760{
2740 "properties": {
3680 "always_ram": {
468n/a "nullable": true,
5680 "type": "boolean"
6680 },
768n/a "encoding": {
868n/a "anyOf": [
9662 {
10662 "$ref": "#/components/schemas/BinaryQuantizationEncoding"
11662 },
1268n/a {
1368n/a "nullable": true
1468n/a }
1568n/a ]
1668n/a },
1766n/a "memory": {
1866n/a "anyOf": [
19660 {
20660 "$ref": "#/components/schemas/Memory"
21660 },
2266n/a {
2366n/a "nullable": true
2466n/a }
2566n/a ],
2666n/a },
2764n/a "query_encoding": {
2864n/a "anyOf": [
29856 {
30856 "$ref": "#/components/schemas/BinaryQuantizationQueryEncoding"
31856 },
3264n/a {
3364n/a "nullable": true
3464n/a }
3564n/a ],
3664n/a }
37740 },
38760 "type": "object"
39760}
BinaryQuantizationEncoding3 of 3 keywords
1662{
2662 "enum": [
32n/a "one_bit",
42n/a "two_bits",
52n/a "one_and_half_bits"
6662 ],
7860 "type": "string"
8662}
BinaryQuantizationQueryEncoding3 of 3 keywords
1856{
2856 "enum": [
32n/a "default",
42n/a "binary",
52n/a "scalar4bits",
62n/a "scalar8bits"
7856 ],
81054 "type": "string"
9856}
CollectionParamsDiff14 of 29 keywords
156564{
2550 "properties": {
349n/a "id_tracker": {
449n/a "anyOf": [
51138 {
61138 "$ref": "#/components/schemas/IdTrackerParams"
71138 },
849n/a {
949n/a "nullable": true
1049n/a }
1149n/a ],
1249n/a },
13490 "on_disk_payload": {
1449n/a "nullable": true,
15490 "type": "boolean"
16490 },
1748n/a "payload": {
1848n/a "anyOf": [
191137 {
201137 "$ref": "#/components/schemas/PayloadStorageParams"
211137 },
2248n/a {
2348n/a "nullable": true
2448n/a }
2548n/a ],
2648n/a },
27470 "read_fan_out_delay_ms": {
2800 "format": "uint64",
29460 "minimum": 0,
3047n/a "nullable": true,
31470 "type": "integer"
32470 },
33460 "read_fan_out_factor": {
3400 "format": "uint32",
35450 "minimum": 0,
3646n/a "nullable": true,
37460 "type": "integer"
38460 },
39450 "replication_factor": {
4000 "format": "uint32",
41440 "minimum": 1,
4245n/a "nullable": true,
43450 "type": "integer"
44450 },
45440 "write_consistency_factor": {
4600 "format": "uint32",
47430 "minimum": 1,
4844n/a "nullable": true,
49440 "type": "integer"
50440 }
51550 },
5256564 "type": "object"
5356564}
CompressionRatio0 of 3 keywords
1380{
2380 "enum": [
330n/a "x4",
42n/a "x8",
52n/a "x16",
62n/a "x32",
72n/a "x64"
8380 ],
9380 "type": "string"
10380}
Datatype3 of 3 keywords
1423{
2423 "enum": [
31n/a "float32",
41n/a "uint8",
51n/a "float16",
61n/a "turbo4"
7423 ],
8522 "type": "string"
9423}
Disabled3 of 3 keywords
12784{
22784 "enum": [
32n/a "Disabled"
42784 ],
54782 "type": "string"
62784}
HnswConfigDiff12 of 31 keywords
178713{
2760 "properties": {
3620 "ef_construct": {
400 "format": "uint",
5600 "minimum": 4,
662n/a "nullable": true,
7620 "type": "integer"
8620 },
9620 "full_scan_threshold": {
1000 "format": "uint",
11600 "minimum": 10,
1262n/a "nullable": true,
13620 "type": "integer"
14620 },
15600 "inline_storage": {
1660n/a "nullable": true,
17600 "type": "boolean"
18600 },
19580 "m": {
2000 "format": "uint",
21560 "minimum": 0,
2258n/a "nullable": true,
23580 "type": "integer"
24580 },
25560 "max_indexing_threads": {
2600 "format": "uint",
27540 "minimum": 0,
2856n/a "nullable": true,
29560 "type": "integer"
30560 },
3154n/a "memory": {
3254n/a "anyOf": [
33648 {
34648 "$ref": "#/components/schemas/Memory"
35648 },
3654n/a {
3754n/a "nullable": true
3854n/a }
3954n/a ],
4054n/a },
41520 "on_disk": {
4252n/a "nullable": true,
43520 "type": "boolean"
44520 },
45500 "payload_m": {
4600 "format": "uint",
47480 "minimum": 0,
4850n/a "nullable": true,
49500 "type": "integer"
50500 }
51760 },
5278713 "type": "object"
5378713}
IdTrackerParams7 of 7 keywords
11138{
210n/a "properties": {
310n/a "memory": {
410n/a "anyOf": [
537 {
637 "$ref": "#/components/schemas/Memory"
737 },
810n/a {
910n/a "nullable": true
1010n/a }
1110n/a ],
1210n/a }
1310n/a },
141138 "type": "object"
151138}
MaxOptimizationThreads4 of 6 keywords
1327{
2327 "anyOf": [
3129 {
4129 "$ref": "#/components/schemas/MaxOptimizationThreadsSetting"
5129 },
6228 {
700 "format": "uint",
820 "minimum": 0,
9228 "type": "integer"
10228 }
11327 ]
12327}
MaxOptimizationThreadsSetting3 of 3 keywords
1129{
2129 "enum": [
31n/a "auto"
4129 ],
5228 "type": "string"
6129}
Memory3 of 3 keywords
142405{
242405 "enum": [
314n/a "cold",
414n/a "cached",
514n/a "pinned"
642405 ],
756391 "type": "string"
842405}
Modifier3 of 3 keywords
1244{
2244 "enum": [
31n/a "none",
41n/a "idf"
5244 ],
6343 "type": "string"
7244}
OptimizersConfigDiff16 of 38 keywords
141580{
2401 "properties": {
3330 "default_segment_number": {
400 "format": "uint",
5320 "minimum": 0,
633n/a "nullable": true,
7330 "type": "integer"
8330 },
9321 "deleted_threshold": {
10321 "format": "double",
11320 "maximum": 1,
12320 "minimum": 0,
1333n/a "nullable": true,
14330 "type": "number"
15321 },
16320 "flush_interval_sec": {
1700 "format": "uint64",
18310 "minimum": 0,
1932n/a "nullable": true,
20320 "type": "integer"
21320 },
22310 "indexing_threshold": {
2300 "format": "uint",
24300 "minimum": 0,
2531n/a "nullable": true,
26310 "type": "integer"
27310 },
2830n/a "max_optimization_threads": {
2930n/a "anyOf": [
30327 {
31327 "$ref": "#/components/schemas/MaxOptimizationThreads"
32327 },
3330n/a {
3430n/a "nullable": true
3530n/a }
3630n/a ],
3730n/a },
38290 "max_segment_size": {
3900 "format": "uint",
40280 "minimum": 1,
4129n/a "nullable": true,
42290 "type": "integer"
43290 },
44280 "memmap_threshold": {
4500 "format": "uint",
46270 "minimum": 0,
4728n/a "nullable": true,
48280 "type": "integer"
49280 },
50270 "prevent_unoptimized": {
5127n/a "nullable": true,
52270 "type": "boolean"
53270 },
54260 "vacuum_min_vector_number": {
5500 "format": "uint",
56250 "minimum": 100,
5726n/a "nullable": true,
58260 "type": "integer"
59260 }
60401 },
6142579 "type": "object"
6241580}
Payload2 of 2 keywords
13619{
21n/a "additionalProperties": true,
33619 "type": "object"
43619}
PayloadStorageParams7 of 7 keywords
11137{
210n/a "properties": {
310n/a "memory": {
410n/a "anyOf": [
537 {
637 "$ref": "#/components/schemas/Memory"
737 },
810n/a {
910n/a "nullable": true
1010n/a }
1110n/a ],
1210n/a }
1310n/a },
141137 "type": "object"
151137}
ProductQuantization3 of 6 keywords
138748{
2380 "properties": {
3380 "product": {
4380 "$ref": "#/components/schemas/ProductQuantizationConfig"
5380 }
6380 },
738169 "required": [
838169 "product"
938169 ],
10207579 "type": "object"
1138748}
ProductQuantizationConfig5 of 12 keywords
1380{
2380 "properties": {
3340 "always_ram": {
434n/a "nullable": true,
5340 "type": "boolean"
6340 },
7380 "compression": {
8380 "$ref": "#/components/schemas/CompressionRatio"
9380 },
1034n/a "memory": {
1134n/a "anyOf": [
12628 {
13628 "$ref": "#/components/schemas/Memory"
14628 },
1534n/a {
1634n/a "nullable": true
1734n/a }
1834n/a ],
1934n/a }
20380 },
21380 "required": [
22380 "compression"
23380 ],
24380 "type": "object"
25380}
QuantizationConfigDiff7 of 7 keywords
1206580{
2206580 "anyOf": [
336750 {
436750 "$ref": "#/components/schemas/ScalarQuantization"
536750 },
638748 {
738748 "$ref": "#/components/schemas/ProductQuantization"
838748 },
976710 {
1076710 "$ref": "#/components/schemas/BinaryQuantization"
1176710 },
1254732 {
1354732 "$ref": "#/components/schemas/TurboQuantization"
1454732 },
152784 {
162784 "$ref": "#/components/schemas/Disabled"
172784 }
18206580 ]
19206580}
ScalarQuantization6 of 6 keywords
136750{
2362 "properties": {
3362 "scalar": {
4362 "$ref": "#/components/schemas/ScalarQuantizationConfig"
5362 }
6362 },
738169 "required": [
838169 "scalar"
938169 ],
10207579 "type": "object"
1136750}
ScalarQuantizationConfig9 of 17 keywords
1362{
2362 "properties": {
3320 "always_ram": {
432n/a "nullable": true,
5320 "type": "boolean"
6320 },
732n/a "memory": {
832n/a "anyOf": [
9626 {
10626 "$ref": "#/components/schemas/Memory"
11626 },
1232n/a {
1332n/a "nullable": true
1432n/a }
1532n/a ],
1632n/a },
17282 "quantile": {
18282 "format": "float",
19280 "maximum": 1,
20280 "minimum": 0.5,
2130n/a "nullable": true,
22300 "type": "number"
23282 },
24380 "type": {
25380 "$ref": "#/components/schemas/ScalarType"
26380 }
27362 },
28380 "required": [
29380 "type"
30380 ],
31380 "type": "object"
32362}
ScalarType0 of 3 keywords
1380{
2380 "enum": [
338n/a "int8"
4380 ],
5380 "type": "string"
6380}
SparseIndexParams11 of 17 keywords
13115{
2300 "properties": {
327n/a "datatype": {
427n/a "anyOf": [
5423 {
6423 "$ref": "#/components/schemas/Datatype"
7423 },
827n/a {
927n/a "nullable": true
1027n/a }
1127n/a ],
1227n/a },
13270 "full_scan_threshold": {
1400 "format": "uint",
15260 "minimum": 0,
1627n/a "nullable": true,
17270 "type": "integer"
18270 },
1926n/a "memory": {
2026n/a "anyOf": [
21323 {
22323 "$ref": "#/components/schemas/Memory"
23323 },
2426n/a {
2526n/a "nullable": true
2626n/a }
2726n/a ],
2826n/a },
29250 "on_disk": {
3025n/a "nullable": true,
31250 "type": "boolean"
32250 }
33300 },
343115 "type": "object"
353115}
SparseVectorParams10 of 11 keywords
1480{
247n/a "properties": {
346n/a "index": {
446n/a "anyOf": [
53115 {
63115 "$ref": "#/components/schemas/SparseIndexParams"
73115 },
846n/a {
946n/a "nullable": true
1046n/a }
1146n/a ],
1246n/a },
1346n/a "modifier": {
1446n/a "anyOf": [
15244 {
16244 "$ref": "#/components/schemas/Modifier"
17244 },
1846n/a {
1946n/a "nullable": true
2046n/a }
2146n/a ],
2246n/a }
2347n/a },
24480 "type": "object"
25480}
SparseVectorsConfig1 of 2 keywords
149569{
2480 "additionalProperties": {
3480 "$ref": "#/components/schemas/SparseVectorParams"
4480 },
549569 "type": "object"
649569}
StrictModeConfig31 of 79 keywords
136581{
23565 "properties": {
3800 "condition_max_size": {
400 "format": "uint",
5790 "minimum": 0,
680n/a "nullable": true,
7800 "type": "integer"
8800 },
9800 "enabled": {
1080n/a "nullable": true,
11800 "type": "boolean"
12800 },
13790 "filter_max_conditions": {
1400 "format": "uint",
15780 "minimum": 0,
1679n/a "nullable": true,
17790 "type": "integer"
18790 },
19780 "max_collection_payload_size_bytes": {
2000 "format": "uint",
21770 "minimum": 0,
2278n/a "nullable": true,
23780 "type": "integer"
24780 },
25770 "max_collection_vector_size_bytes": {
2600 "format": "uint",
27760 "minimum": 0,
2877n/a "nullable": true,
29770 "type": "integer"
30770 },
31760 "max_payload_index_count": {
3200 "format": "uint",
33750 "minimum": 0,
3476n/a "nullable": true,
35760 "type": "integer"
36760 },
37750 "max_points_count": {
3800 "format": "uint",
39740 "minimum": 1,
4075n/a "nullable": true,
41750 "type": "integer"
42750 },
43740 "max_query_limit": {
4400 "format": "uint",
45730 "minimum": 1,
4674n/a "nullable": true,
47740 "type": "integer"
48740 },
49730 "max_resident_memory_percent": {
5000 "format": "uint8",
51720 "maximum": 100,
52720 "minimum": 1,
5373n/a "nullable": true,
54730 "type": "integer"
55730 },
56720 "max_timeout": {
5700 "format": "uint",
58710 "minimum": 1,
5972n/a "nullable": true,
60720 "type": "integer"
61720 },
6271n/a "multivector_config": {
6371n/a "anyOf": [
64566 {
65566 "$ref": "#/components/schemas/StrictModeMultivectorConfig"
66566 },
6771n/a {
6871n/a "nullable": true
6971n/a }
7071n/a ],
7171n/a },
72700 "read_rate_limit": {
7300 "format": "uint",
74690 "minimum": 1,
7570n/a "nullable": true,
76700 "type": "integer"
77700 },
78690 "search_allow_exact": {
7969n/a "nullable": true,
80690 "type": "boolean"
81690 },
82680 "search_max_batchsize": {
8300 "format": "uint",
84670 "minimum": 0,
8568n/a "nullable": true,
86680 "type": "integer"
87680 },
88670 "search_max_hnsw_ef": {
8900 "format": "uint",
90660 "minimum": 0,
9167n/a "nullable": true,
92670 "type": "integer"
93670 },
94165 "search_max_oversampling": {
95165 "format": "double",
9666n/a "nullable": true,
97660 "type": "number"
98165 },
9965n/a "sparse_config": {
10065n/a "anyOf": [
101560 {
102560 "$ref": "#/components/schemas/StrictModeSparseConfig"
103560 },
10465n/a {
10565n/a "nullable": true
10665n/a }
10765n/a ],
10865n/a },
109640 "unindexed_filtering_retrieve": {
11064n/a "nullable": true,
111640 "type": "boolean"
112640 },
113630 "unindexed_filtering_update": {
11463n/a "nullable": true,
115630 "type": "boolean"
116630 },
117620 "upsert_max_batchsize": {
11800 "format": "uint",
119610 "minimum": 0,
12062n/a "nullable": true,
121620 "type": "integer"
122620 },
123610 "write_rate_limit": {
12400 "format": "uint",
125600 "minimum": 1,
12661n/a "nullable": true,
127610 "type": "integer"
128610 }
1293565 },
130101516 "type": "object"
13136581}
StrictModeMultivector1 of 7 keywords
140{
230 "properties": {
330 "max_vectors": {
400 "format": "uint",
520 "minimum": 1,
63n/a "nullable": true,
730 "type": "integer"
830 }
930 },
1040 "type": "object"
1140}
StrictModeMultivectorConfig1 of 2 keywords
1566{
240 "additionalProperties": {
340 "$ref": "#/components/schemas/StrictModeMultivector"
440 },
5566 "type": "object"
6566}
StrictModeSparse1 of 7 keywords
140{
230 "properties": {
330 "max_length": {
400 "format": "uint",
520 "minimum": 1,
63n/a "nullable": true,
730 "type": "integer"
830 }
930 },
1040 "type": "object"
1140}
StrictModeSparseConfig1 of 2 keywords
1560{
240 "additionalProperties": {
340 "$ref": "#/components/schemas/StrictModeSparse"
440 },
5560 "type": "object"
6560}
TurboQuantBitSize3 of 3 keywords
1840{
2840 "enum": [
32n/a "bits1",
42n/a "bits1_5",
52n/a "bits2",
62n/a "bits4"
7840 ],
81038 "type": "string"
9840}
TurboQuantQuantizationConfig9 of 13 keywords
1540{
2520 "properties": {
3480 "always_ram": {
448n/a "nullable": true,
5480 "type": "boolean"
6480 },
748n/a "bits": {
848n/a "anyOf": [
9840 {
10840 "$ref": "#/components/schemas/TurboQuantBitSize"
11840 },
1248n/a {
1348n/a "nullable": true
1448n/a }
1548n/a ]
1648n/a },
1746n/a "memory": {
1846n/a "anyOf": [
19640 {
20640 "$ref": "#/components/schemas/Memory"
21640 },
2246n/a {
2346n/a "nullable": true
2446n/a }
2546n/a ],
2646n/a }
27520 },
28540 "type": "object"
29540}
TurboQuantization3 of 6 keywords
154732{
2540 "properties": {
3540 "turbo": {
4540 "$ref": "#/components/schemas/TurboQuantQuantizationConfig"
5540 }
6540 },
754153 "required": [
854153 "turbo"
954153 ],
10207579 "type": "object"
1154732}
VectorParamsDiff13 of 17 keywords
11730{
21720 "properties": {
3169n/a "hnsw_config": {
4169n/a "anyOf": [
539130 {
639130 "$ref": "#/components/schemas/HnswConfigDiff"
739130 },
8169n/a {
9169n/a "nullable": true
10169n/a }
11169n/a ],
12169n/a },
13169n/a "memory": {
14169n/a "anyOf": [
153166 {
163166 "$ref": "#/components/schemas/Memory"
173166 },
18169n/a {
19169n/a "nullable": true
20169n/a }
21169n/a ],
22169n/a },
231680 "on_disk": {
24168n/a "nullable": true,
251680 "type": "boolean"
261680 },
27167n/a "quantization_config": {
28167n/a "anyOf": [
2910364 {
3010364 "$ref": "#/components/schemas/QuantizationConfigDiff"
3110364 },
32167n/a {
33167n/a "nullable": true
34167n/a }
35167n/a ],
36167n/a }
371720 },
381730 "type": "object"
391730}
VectorsConfigDiff1 of 2 keywords
1174442{
21730 "additionalProperties": {
31730 "$ref": "#/components/schemas/VectorParamsDiff"
41730 },
5174442 "type": "object"
6174442}
Responses2 of 3 documented received
codedescriptionhitsavg
200successful operation4378ms
4XXerror4240ms
defaulterror0-
Examples4 / 4 used
Body: application/json
{ "city": "London", "color": "green" }Payload
nullOptimizersConfigDiff.prevent_unoptimized
nullCollectionParamsDiff.on_disk_payload
nullUpdateCollection.quantization_config
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
11183n/a{
21183n/a "type": "string"
31183n/a}
Query Parameters2 of 2 keywords covered
timeout2 / 2
1102277{
2102258 "minimum": 1,
3108019 "type": "integer"
4102277}
Body228 of 381 keywords covered
application/json228 / 381
CreateCollection
1105286{
295381 "properties": {
3923n/a "hnsw_config": {
4923n/a "anyOf": [
539884 {
639884 "$ref": "#/components/schemas/HnswConfigDiff"
739884 },
8923n/a {
9923n/a "nullable": true
10923n/a }
11923n/a ],
12923n/a },
13923n/a "id_tracker": {
14923n/a "anyOf": [
1511912 {
1611912 "$ref": "#/components/schemas/IdTrackerParams"
1711912 },
18923n/a {
19923n/a "nullable": true
20923n/a }
21923n/a ],
22923n/a },
23922n/a "metadata": {
24922n/a "anyOf": [
253919 {
263919 "$ref": "#/components/schemas/Payload"
273919 },
28922n/a {
29922n/a "nullable": true
30922n/a }
31922n/a ],
32922n/a },
339654 "on_disk_payload": {
34969n/a "nullable": true,
359654 "type": "boolean"
369654 },
37920n/a "optimizers_config": {
38920n/a "anyOf": [
3941879 {
4041879 "$ref": "#/components/schemas/OptimizersConfigDiff"
4141879 },
42920n/a {
43920n/a "nullable": true
44920n/a }
45920n/a ],
46920n/a },
47919n/a "payload": {
48919n/a "anyOf": [
4911908 {
5011908 "$ref": "#/components/schemas/PayloadStorageParams"
5111908 },
52919n/a {
53919n/a "nullable": true
54919n/a }
55919n/a ],
56919n/a },
57918n/a "quantization_config": {
58918n/a "anyOf": [
59102816 {
60102816 "$ref": "#/components/schemas/QuantizationConfig"
61102816 },
62918n/a {
63918n/a "nullable": true
64918n/a }
65918n/a ],
66918n/a },
679806 "replication_factor": {
6800 "format": "uint32",
699302 "minimum": 1,
70986n/a "nullable": true,
719815 "type": "integer"
729806 },
739756 "shard_number": {
7400 "format": "uint32",
759322 "minimum": 1,
76981n/a "nullable": true,
779765 "type": "integer"
789756 },
79915n/a "sharding_method": {
80915n/a "anyOf": [
812913 {
822913 "$ref": "#/components/schemas/ShardingMethod"
832913 },
84915n/a {
85915n/a "nullable": true
86915n/a }
87915n/a ],
88915n/a },
899749 "sparse_vectors": {
90955 "additionalProperties": {
911985 "$ref": "#/components/schemas/SparseVectorParams"
92955 },
93983n/a "nullable": true,
949794 "type": "object"
959749 },
96913n/a "strict_mode_config": {
97913n/a "anyOf": [
9836877 {
9936877 "$ref": "#/components/schemas/StrictModeConfig"
10036877 },
101913n/a {
102913n/a "nullable": true
103913n/a }
104913n/a ],
105913n/a },
10689550 "vectors": {
10789550 "$ref": "#/components/schemas/VectorsConfig"
10889550 },
109911n/a "wal_config": {
110911n/a "anyOf": [
11112899 {
11212899 "$ref": "#/components/schemas/WalConfigDiff"
11312899 },
114911n/a {
115911n/a "nullable": true
116911n/a }
117911n/a ],
118911n/a },
1199466 "write_consistency_factor": {
12000 "format": "uint32",
1219252 "minimum": 1,
122952n/a "nullable": true,
1239475 "type": "integer"
1249466 }
12595381 },
12611335 "type": "object"
127105286}
Referenced Components (38)232 of 399 keywords
BinaryQuantization3 of 6 keywords
11141222{
21140 "properties": {
31140 "binary": {
41140 "$ref": "#/components/schemas/BinaryQuantizationConfig"
51140 }
61140 },
7114197 "required": [
8114197 "binary"
9114197 ],
103111025 "type": "object"
111141222}
BinaryQuantizationConfig13 of 17 keywords
11140{
21110 "properties": {
31020 "always_ram": {
4102n/a "nullable": true,
51020 "type": "boolean"
61020 },
7102n/a "encoding": {
8102n/a "anyOf": [
9993 {
10993 "$ref": "#/components/schemas/BinaryQuantizationEncoding"
11993 },
12102n/a {
13102n/a "nullable": true
14102n/a }
15102n/a ]
16102n/a },
1799n/a "memory": {
1899n/a "anyOf": [
19990 {
20990 "$ref": "#/components/schemas/Memory"
21990 },
2299n/a {
2399n/a "nullable": true
2499n/a }
2599n/a ],
2699n/a },
2796n/a "query_encoding": {
2896n/a "anyOf": [
291284 {
301284 "$ref": "#/components/schemas/BinaryQuantizationQueryEncoding"
311284 },
3296n/a {
3396n/a "nullable": true
3496n/a }
3596n/a ],
3696n/a }
371110 },
381140 "type": "object"
391140}
BinaryQuantizationEncoding3 of 3 keywords
1993{
2993 "enum": [
33n/a "one_bit",
43n/a "two_bits",
53n/a "one_and_half_bits"
6993 ],
71290 "type": "string"
8993}
BinaryQuantizationQueryEncoding3 of 3 keywords
11284{
21284 "enum": [
33n/a "default",
43n/a "binary",
53n/a "scalar4bits",
63n/a "scalar8bits"
71284 ],
81581 "type": "string"
91284}
CompressionRatio0 of 3 keywords
1570{
2570 "enum": [
345n/a "x4",
43n/a "x8",
53n/a "x16",
63n/a "x32",
73n/a "x64"
8570 ],
9570 "type": "string"
10570}
Datatype3 of 3 keywords
112441{
212441 "enum": [
33n/a "float32",
43n/a "uint8",
53n/a "float16",
63n/a "turbo4"
712441 ],
815438 "type": "string"
912441}
Distance3 of 3 keywords
145312{
245312 "enum": [
3424n/a "Cosine",
47n/a "Euclid",
513n/a "Dot",
69n/a "Manhattan"
745312 ],
845510 "type": "string"
945312}
HnswConfigDiff12 of 31 keywords
11171232{
21140 "properties": {
3930 "ef_construct": {
400 "format": "uint",
5900 "minimum": 4,
693n/a "nullable": true,
7930 "type": "integer"
8930 },
9930 "full_scan_threshold": {
1000 "format": "uint",
11900 "minimum": 10,
1293n/a "nullable": true,
13930 "type": "integer"
14930 },
15900 "inline_storage": {
1690n/a "nullable": true,
17900 "type": "boolean"
18900 },
19870 "m": {
2000 "format": "uint",
21840 "minimum": 0,
2287n/a "nullable": true,
23870 "type": "integer"
24870 },
25840 "max_indexing_threads": {
2600 "format": "uint",
27810 "minimum": 0,
2884n/a "nullable": true,
29840 "type": "integer"
30840 },
3181n/a "memory": {
3281n/a "anyOf": [
33972 {
34972 "$ref": "#/components/schemas/Memory"
35972 },
3681n/a {
3781n/a "nullable": true
3881n/a }
3981n/a ],
4081n/a },
41780 "on_disk": {
4278n/a "nullable": true,
43780 "type": "boolean"
44780 },
45750 "payload_m": {
4600 "format": "uint",
47720 "minimum": 0,
4875n/a "nullable": true,
49750 "type": "integer"
50750 }
511140 },
521171232 "type": "object"
531171232}
IdTrackerParams7 of 7 keywords
111912{
210n/a "properties": {
310n/a "memory": {
410n/a "anyOf": [
537 {
637 "$ref": "#/components/schemas/Memory"
737 },
810n/a {
910n/a "nullable": true
1010n/a }
1110n/a ],
1210n/a }
1310n/a },
1411912 "type": "object"
1511912}
MaxOptimizationThreads4 of 6 keywords
1327{
2327 "anyOf": [
3129 {
4129 "$ref": "#/components/schemas/MaxOptimizationThreadsSetting"
5129 },
6228 {
700 "format": "uint",
820 "minimum": 0,
9228 "type": "integer"
10228 }
11327 ]
12327}
MaxOptimizationThreadsSetting3 of 3 keywords
1129{
2129 "enum": [
31n/a "auto"
4129 ],
5228 "type": "string"
6129}
Memory3 of 3 keywords
163782{
263782 "enum": [
321n/a "cold",
421n/a "cached",
521n/a "pinned"
663782 ],
784761 "type": "string"
863782}
Modifier3 of 3 keywords
1244{
2244 "enum": [
31n/a "none",
41n/a "idf"
5244 ],
6343 "type": "string"
7244}
MultiVectorComparator0 of 3 keywords
120{
220 "enum": [
32n/a "max_sim"
420 ],
520 "type": "string"
620}
MultiVectorConfig3 of 6 keywords
12420{
220 "properties": {
320 "comparator": {
420 "$ref": "#/components/schemas/MultiVectorComparator"
520 }
620 },
722 "required": [
822 "comparator"
922 ],
104418 "type": "object"
112420}
OptimizersConfigDiff16 of 38 keywords
141879{
2401 "properties": {
3330 "default_segment_number": {
400 "format": "uint",
5320 "minimum": 0,
633n/a "nullable": true,
7330 "type": "integer"
8330 },
9321 "deleted_threshold": {
10321 "format": "double",
11320 "maximum": 1,
12320 "minimum": 0,
1333n/a "nullable": true,
14330 "type": "number"
15321 },
16320 "flush_interval_sec": {
1700 "format": "uint64",
18310 "minimum": 0,
1932n/a "nullable": true,
20320 "type": "integer"
21320 },
22310 "indexing_threshold": {
2300 "format": "uint",
24300 "minimum": 0,
2531n/a "nullable": true,
26310 "type": "integer"
27310 },
2830n/a "max_optimization_threads": {
2930n/a "anyOf": [
30327 {
31327 "$ref": "#/components/schemas/MaxOptimizationThreads"
32327 },
3330n/a {
3430n/a "nullable": true
3530n/a }
3630n/a ],
3730n/a },
38290 "max_segment_size": {
3900 "format": "uint",
40280 "minimum": 1,
4129n/a "nullable": true,
42290 "type": "integer"
43290 },
44280 "memmap_threshold": {
4500 "format": "uint",
46270 "minimum": 0,
4728n/a "nullable": true,
48280 "type": "integer"
49280 },
50270 "prevent_unoptimized": {
5127n/a "nullable": true,
52270 "type": "boolean"
53270 },
54260 "vacuum_min_vector_number": {
5500 "format": "uint",
56250 "minimum": 100,
5726n/a "nullable": true,
58260 "type": "integer"
59260 }
60401 },
6142878 "type": "object"
6241879}
Payload2 of 2 keywords
13919{
21n/a "additionalProperties": true,
33919 "type": "object"
43919}
PayloadStorageParams7 of 7 keywords
111908{
210n/a "properties": {
310n/a "memory": {
410n/a "anyOf": [
537 {
637 "$ref": "#/components/schemas/Memory"
737 },
810n/a {
910n/a "nullable": true
1010n/a }
1110n/a ],
1210n/a }
1310n/a },
1411908 "type": "object"
1511908}
ProductQuantization3 of 6 keywords
1571279{
2570 "properties": {
3570 "product": {
4570 "$ref": "#/components/schemas/ProductQuantizationConfig"
5570 }
6570 },
757254 "required": [
857254 "product"
957254 ],
103111025 "type": "object"
11571279}
ProductQuantizationConfig5 of 12 keywords
1570{
2570 "properties": {
3510 "always_ram": {
451n/a "nullable": true,
5510 "type": "boolean"
6510 },
7570 "compression": {
8570 "$ref": "#/components/schemas/CompressionRatio"
9570 },
1051n/a "memory": {
1151n/a "anyOf": [
12942 {
13942 "$ref": "#/components/schemas/Memory"
14942 },
1551n/a {
1651n/a "nullable": true
1751n/a }
1851n/a ],
1951n/a }
20570 },
21570 "required": [
22570 "compression"
23570 ],
24570 "type": "object"
25570}
QuantizationConfig6 of 6 keywords
13061030{
23061030 "anyOf": [
3541282 {
4541282 "$ref": "#/components/schemas/ScalarQuantization"
5541282 },
6571279 {
7571279 "$ref": "#/components/schemas/ProductQuantization"
8571279 },
91141222 {
101141222 "$ref": "#/components/schemas/BinaryQuantization"
111141222 },
12811255 {
13811255 "$ref": "#/components/schemas/TurboQuantization"
14811255 }
153061030 ]
163061030}
ScalarQuantization6 of 6 keywords
1541282{
2543 "properties": {
3543 "scalar": {
4543 "$ref": "#/components/schemas/ScalarQuantizationConfig"
5543 }
6543 },
757254 "required": [
857254 "scalar"
957254 ],
103111025 "type": "object"
11541282}
ScalarQuantizationConfig9 of 17 keywords
1543{
2543 "properties": {
3480 "always_ram": {
448n/a "nullable": true,
5480 "type": "boolean"
6480 },
748n/a "memory": {
848n/a "anyOf": [
9939 {
10939 "$ref": "#/components/schemas/Memory"
11939 },
1248n/a {
1348n/a "nullable": true
1448n/a }
1548n/a ],
1648n/a },
17423 "quantile": {
18423 "format": "float",
19420 "maximum": 1,
20420 "minimum": 0.5,
2145n/a "nullable": true,
22450 "type": "number"
23423 },
24570 "type": {
25570 "$ref": "#/components/schemas/ScalarType"
26570 }
27543 },
28570 "required": [
29570 "type"
30570 ],
31570 "type": "object"
32543}
ScalarType0 of 3 keywords
1570{
2570 "enum": [
357n/a "int8"
4570 ],
5570 "type": "string"
6570}
ShardingMethod3 of 3 keywords
12913{
22913 "enum": [
31n/a "auto",
41n/a "custom"
52913 ],
63912 "type": "string"
72913}
SparseIndexParams11 of 17 keywords
13115{
2300 "properties": {
327n/a "datatype": {
427n/a "anyOf": [
5423 {
6423 "$ref": "#/components/schemas/Datatype"
7423 },
827n/a {
927n/a "nullable": true
1027n/a }
1127n/a ],
1227n/a },
13270 "full_scan_threshold": {
1400 "format": "uint",
15260 "minimum": 0,
1627n/a "nullable": true,
17270 "type": "integer"
18270 },
1926n/a "memory": {
2026n/a "anyOf": [
21323 {
22323 "$ref": "#/components/schemas/Memory"
23323 },
2426n/a {
2526n/a "nullable": true
2626n/a }
2726n/a ],
2826n/a },
29250 "on_disk": {
3025n/a "nullable": true,
31250 "type": "boolean"
32250 }
33300 },
343115 "type": "object"
353115}
SparseVectorParams11 of 11 keywords
11985{
247n/a "properties": {
346n/a "index": {
446n/a "anyOf": [
53115 {
63115 "$ref": "#/components/schemas/SparseIndexParams"
73115 },
846n/a {
946n/a "nullable": true
1046n/a }
1146n/a ],
1246n/a },
1346n/a "modifier": {
1446n/a "anyOf": [
15244 {
16244 "$ref": "#/components/schemas/Modifier"
17244 },
1846n/a {
1946n/a "nullable": true
2046n/a }
2146n/a ],
2246n/a }
2347n/a },
241985 "type": "object"
251985}
StrictModeConfig31 of 79 keywords
136877{
23565 "properties": {
3800 "condition_max_size": {
400 "format": "uint",
5790 "minimum": 0,
680n/a "nullable": true,
7800 "type": "integer"
8800 },
9800 "enabled": {
1080n/a "nullable": true,
11800 "type": "boolean"
12800 },
13790 "filter_max_conditions": {
1400 "format": "uint",
15780 "minimum": 0,
1679n/a "nullable": true,
17790 "type": "integer"
18790 },
19780 "max_collection_payload_size_bytes": {
2000 "format": "uint",
21770 "minimum": 0,
2278n/a "nullable": true,
23780 "type": "integer"
24780 },
25770 "max_collection_vector_size_bytes": {
2600 "format": "uint",
27760 "minimum": 0,
2877n/a "nullable": true,
29770 "type": "integer"
30770 },
31760 "max_payload_index_count": {
3200 "format": "uint",
33750 "minimum": 0,
3476n/a "nullable": true,
35760 "type": "integer"
36760 },
37750 "max_points_count": {
3800 "format": "uint",
39740 "minimum": 1,
4075n/a "nullable": true,
41750 "type": "integer"
42750 },
43740 "max_query_limit": {
4400 "format": "uint",
45730 "minimum": 1,
4674n/a "nullable": true,
47740 "type": "integer"
48740 },
49730 "max_resident_memory_percent": {
5000 "format": "uint8",
51720 "maximum": 100,
52720 "minimum": 1,
5373n/a "nullable": true,
54730 "type": "integer"
55730 },
56720 "max_timeout": {
5700 "format": "uint",
58710 "minimum": 1,
5972n/a "nullable": true,
60720 "type": "integer"
61720 },
6271n/a "multivector_config": {
6371n/a "anyOf": [
64566 {
65566 "$ref": "#/components/schemas/StrictModeMultivectorConfig"
66566 },
6771n/a {
6871n/a "nullable": true
6971n/a }
7071n/a ],
7171n/a },
72700 "read_rate_limit": {
7300 "format": "uint",
74690 "minimum": 1,
7570n/a "nullable": true,
76700 "type": "integer"
77700 },
78690 "search_allow_exact": {
7969n/a "nullable": true,
80690 "type": "boolean"
81690 },
82680 "search_max_batchsize": {
8300 "format": "uint",
84670 "minimum": 0,
8568n/a "nullable": true,
86680 "type": "integer"
87680 },
88670 "search_max_hnsw_ef": {
8900 "format": "uint",
90660 "minimum": 0,
9167n/a "nullable": true,
92670 "type": "integer"
93670 },
94165 "search_max_oversampling": {
95165 "format": "double",
9666n/a "nullable": true,
97660 "type": "number"
98165 },
9965n/a "sparse_config": {
10065n/a "anyOf": [
101560 {
102560 "$ref": "#/components/schemas/StrictModeSparseConfig"
103560 },
10465n/a {
10565n/a "nullable": true
10665n/a }
10765n/a ],
10865n/a },
109640 "unindexed_filtering_retrieve": {
11064n/a "nullable": true,
111640 "type": "boolean"
112640 },
113630 "unindexed_filtering_update": {
11463n/a "nullable": true,
115630 "type": "boolean"
116630 },
117620 "upsert_max_batchsize": {
11800 "format": "uint",
119610 "minimum": 0,
12062n/a "nullable": true,
121620 "type": "integer"
122620 },
123610 "write_rate_limit": {
12400 "format": "uint",
125600 "minimum": 1,
12661n/a "nullable": true,
127610 "type": "integer"
128610 }
1293565 },
130101812 "type": "object"
13136877}
StrictModeMultivector1 of 7 keywords
140{
230 "properties": {
330 "max_vectors": {
400 "format": "uint",
520 "minimum": 1,
63n/a "nullable": true,
730 "type": "integer"
830 }
930 },
1040 "type": "object"
1140}
StrictModeMultivectorConfig1 of 2 keywords
1566{
240 "additionalProperties": {
340 "$ref": "#/components/schemas/StrictModeMultivector"
440 },
5566 "type": "object"
6566}
StrictModeSparse1 of 7 keywords
140{
230 "properties": {
330 "max_length": {
400 "format": "uint",
520 "minimum": 1,
63n/a "nullable": true,
730 "type": "integer"
830 }
930 },
1040 "type": "object"
1140}
StrictModeSparseConfig1 of 2 keywords
1560{
240 "additionalProperties": {
340 "$ref": "#/components/schemas/StrictModeSparse"
440 },
5560 "type": "object"
6560}
TurboQuantBitSize3 of 3 keywords
11260{
21260 "enum": [
33n/a "bits1",
43n/a "bits1_5",
53n/a "bits2",
63n/a "bits4"
71260 ],
81557 "type": "string"
91260}
TurboQuantQuantizationConfig9 of 13 keywords
1810{
2780 "properties": {
3720 "always_ram": {
472n/a "nullable": true,
5720 "type": "boolean"
6720 },
772n/a "bits": {
872n/a "anyOf": [
91260 {
101260 "$ref": "#/components/schemas/TurboQuantBitSize"
111260 },
1272n/a {
1372n/a "nullable": true
1472n/a }
1572n/a ]
1672n/a },
1769n/a "memory": {
1869n/a "anyOf": [
19960 {
20960 "$ref": "#/components/schemas/Memory"
21960 },
2269n/a {
2369n/a "nullable": true
2469n/a }
2569n/a ],
2669n/a }
27780 },
28810 "type": "object"
29810}
TurboQuantization3 of 6 keywords
1811255{
2810 "properties": {
3810 "turbo": {
4810 "$ref": "#/components/schemas/TurboQuantQuantizationConfig"
5810 }
6810 },
781230 "required": [
881230 "turbo"
981230 ],
103111025 "type": "object"
11811255}
VectorParams31 of 32 keywords
14272540{
245936 "properties": {
3426n/a "datatype": {
4426n/a "anyOf": [
58418 {
68418 "$ref": "#/components/schemas/Datatype"
78418 },
8426n/a {
9426n/a "nullable": true
10426n/a }
11426n/a ],
12426n/a },
1345312 "distance": {
1445312 "$ref": "#/components/schemas/Distance"
1545312 },
16426n/a "hnsw_config": {
17426n/a "anyOf": [
1878348 {
1978348 "$ref": "#/components/schemas/HnswConfigDiff"
2078348 },
21426n/a {
22426n/a "nullable": true
23426n/a }
24426n/a ],
25426n/a },
26451n/a "memory": {
27451n/a "anyOf": [
289442 {
299442 "$ref": "#/components/schemas/Memory"
309442 },
31451n/a {
32451n/a "nullable": true
33451n/a }
34451n/a ],
35451n/a },
36422n/a "multivector_config": {
37422n/a "anyOf": [
382420 {
392420 "$ref": "#/components/schemas/MultiVectorConfig"
402420 },
41422n/a {
42422n/a "nullable": true
43422n/a }
44422n/a ]
45422n/a },
464538 "on_disk": {
47461n/a "nullable": true,
484538 "type": "boolean"
494538 },
50418n/a "quantization_config": {
51418n/a "anyOf": [
52204214 {
53204214 "$ref": "#/components/schemas/QuantizationConfig"
54204214 },
55418n/a {
56418n/a "nullable": true
57418n/a }
58418n/a ],
59418n/a },
6044916 "size": {
6100 "format": "uint64",
624532 "maximum": 65536,
634514 "minimum": 1,
6445312 "type": "integer"
6544916 }
6645936 },
67463877 "required": [
68465875 "distance",
69465875 "size"
70463877 ],
7113401627 "type": "object"
724272540}
VectorsConfig5 of 5 keywords
189550{
289550 "anyOf": [
3215730 {
4215730 "$ref": "#/components/schemas/VectorParams"
5215730 },
6680265 {
7204260 "additionalProperties": {
82121810 "$ref": "#/components/schemas/VectorParams"
9204260 },
109405 "type": "object"
11680265 }
1289550 ],
1389550}
WalConfigDiff4 of 15 keywords
112899{
2110 "properties": {
390 "wal_capacity_mb": {
400 "format": "uint",
580 "minimum": 1,
69n/a "nullable": true,
790 "type": "integer"
890 },
990 "wal_retain_closed": {
1000 "format": "uint",
1180 "minimum": 0,
129n/a "nullable": true,
1390 "type": "integer"
1490 },
1580 "wal_segments_ahead": {
1600 "format": "uint",
1770 "minimum": 0,
188n/a "nullable": true,
1980 "type": "integer"
2080 }
21110 },
2212899 "type": "object"
2312899}
Responses2 of 3 documented received
codedescriptionhitsavg
200successful operation10174ms
4XXerror11720ms
defaulterror0-
Examples10 / 10 used
Body: application/json
nullCreateCollection.id_tracker
{ "city": "London", "color": "green" }Payload
nullCreateCollection.on_disk_payload
nullOptimizersConfigDiff.prevent_unoptimized
nullCreateCollection.payload
nullCreateCollection.quantization_config
nullCreateCollection.replication_factor
nullCreateCollection.shard_number
nullCreateCollection.sharding_method
nullCreateCollection.write_consistency_factor
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
1228n/a{
2228n/a "type": "string"
3228n/a}
Responses1 of 3 documented received
codedescriptionhitsavg
200successful operation2280ms
4XXerror0never seen
defaulterror0-
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
1238n/a{
2238n/a "type": "string"
3238n/a}
Query Parameters3 of 3 keywords covered
with1 / 1
192n/a{
292n/a "type": "string"
392n/a}
completed_limit2 / 2
125150{
22530 "minimum": 0,
355120 "type": "integer"
425150}
Responses2 of 3 documented received
codedescriptionhitsavg
200successful operation590ms
4XXerror1790ms
defaulterror0-
Examples1 / 1 used
Query
16completed_limit
Path Parameters2 of 2 keywords covered
collection_name1 / 1
#validinvalidschema
1114n/a{
2114n/a "type": "string"
3114n/a}
vector_name1 / 1
1114n/a{
2114n/a "type": "string"
3114n/a}
Query Parameters5 of 5 keywords covered
wait1 / 1
15013{
25013 "type": "boolean"
35013}
ordering2 / 2
WriteOrdering
15115{
25115 "enum": [
325n/a "weak",
411n/a "medium",
515n/a "strong"
65115 ],
766n/a "type": "string"
85115}
timeout2 / 2
14320{
2435 "minimum": 1,
34815 "type": "integer"
44320}
Responses2 of 3 documented received
codedescriptionhitsavg
200successful operation2143ms
4XXerror930ms
defaulterror0-
Path Parameters2 of 2 keywords covered
collection_name1 / 1
#validinvalidschema
1345n/a{
2345n/a "type": "string"
3345n/a}
vector_name1 / 1
1345n/a{
2345n/a "type": "string"
3345n/a}
Query Parameters5 of 5 keywords covered
wait1 / 1
117521{
217521 "type": "boolean"
317521}
ordering2 / 2
WriteOrdering
118554{
218554 "enum": [
3146n/a "weak",
421n/a "medium",
518n/a "strong"
618554 ],
7239n/a "type": "string"
818554}
timeout2 / 2
116465{
216436 "minimum": 1,
320029 "type": "integer"
416465}
Body40 of 45 keywords covered
application/json40 / 45
VectorNameConfig
126146{
226146 "anyOf": [
3166141 {
4166141 "$ref": "#/components/schemas/DenseVectorNameConfig"
5166141 },
695212 {
795212 "$ref": "#/components/schemas/SparseVectorNameConfig"
895212 }
926146 ],
1026146}
Referenced Components (9)52 of 59 keywords
DenseVectorConfig17 of 18 keywords
116628{
216920 "properties": {
389n/a "datatype": {
489n/a "anyOf": [
5485 {
6485 "$ref": "#/components/schemas/VectorStorageDatatype"
7485 },
889n/a {
989n/a "nullable": true
1089n/a }
1189n/a ],
1289n/a },
131826 "distance": {
141826 "$ref": "#/components/schemas/Distance"
151826 },
1683n/a "multivector_config": {
1783n/a "anyOf": [
18182 {
19182 "$ref": "#/components/schemas/MultiVectorConfig"
20182 },
2183n/a {
2283n/a "nullable": true
2383n/a }
2483n/a ],
2583n/a },
2617314 "size": {
2700 "format": "uint",
281751 "maximum": 65536,
291742 "minimum": 1,
3017512 "type": "integer"
3117314 }
3216920 },
331863 "required": [
341881 "distance",
351872 "size"
361863 ],
371895 "type": "object"
3816628}
DenseVectorNameConfig6 of 6 keywords
1166141{
216628 "properties": {
316628 "dense": {
416628 "$ref": "#/components/schemas/DenseVectorConfig"
516628 }
616628 },
7194101 "required": [
8194101 "dense"
9194101 ],
1029512 "type": "object"
11166141}
Distance3 of 3 keywords
11826{
21826 "enum": [
396n/a "Cosine",
414n/a "Euclid",
567n/a "Dot",
65n/a "Manhattan"
71826 ],
81835 "type": "string"
91826}
Modifier3 of 3 keywords
1218{
2218 "enum": [
31n/a "none",
41n/a "idf"
5218 ],
6317 "type": "string"
7218}
MultiVectorComparator0 of 3 keywords
110{
210 "enum": [
31n/a "max_sim"
410 ],
510 "type": "string"
610}
MultiVectorConfig3 of 6 keywords
1182{
210 "properties": {
310 "comparator": {
410 "$ref": "#/components/schemas/MultiVectorComparator"
510 }
610 },
711 "required": [
811 "comparator"
911 ],
10281 "type": "object"
11182}
SparseVectorConfig11 of 11 keywords
1955{
221n/a "properties": {
320n/a "datatype": {
420n/a "anyOf": [
5416 {
6416 "$ref": "#/components/schemas/VectorStorageDatatype"
7416 },
820n/a {
920n/a "nullable": true
1020n/a }
1120n/a ],
1220n/a },
1320n/a "modifier": {
1420n/a "anyOf": [
15218 {
16218 "$ref": "#/components/schemas/Modifier"
17218 },
1820n/a {
1920n/a "nullable": true
2020n/a }
2120n/a ],
2220n/a }
2321n/a },
24955 "type": "object"
25955}
SparseVectorNameConfig6 of 6 keywords
195212{
2955 "properties": {
3955 "sparse": {
4955 "$ref": "#/components/schemas/SparseVectorConfig"
5955 }
6955 },
7100195 "required": [
8100195 "sparse"
9100195 ],
1029512 "type": "object"
1195212}
VectorStorageDatatype3 of 3 keywords
18101{
28101 "enum": [
32n/a "float32",
42n/a "float16",
52n/a "uint8",
62n/a "turbo4"
78101 ],
81099 "type": "string"
98101}
Responses2 of 3 documented received
codedescriptionhitsavg
200successful operation6915ms
4XXerror2761ms
defaulterror0-
Distributed 9 operations 6 covered 3 partial 0 uncovered 0 not measured 73% #
Responses1 of 3 documented received
codedescriptionhitsavg
200successful operation50ms
4XXerror0never seen
defaulterror0-
Path Parameters1 of 1 keywords covered
peer_id1 / 1
#validinvalidschema
128647{
228647 "type": "integer"
328647}
Query Parameters3 of 3 keywords covered
timeout2 / 2
15340{
2537 "minimum": 1,
36033 "type": "integer"
45340}
force1 / 1
16334{
26334 "type": "boolean"
36334}
Responses1 of 3 documented received
codedescriptionhitsavg
200successful operation0never seen
4XXerror3330ms
defaulterror0-
Examples1 / 1 used
Query
falseforce
Responses1 of 3 documented received
codedescriptionhitsavg
200successful operation0never seen
4XXerror51ms
defaulterror0-
Query Parameters3 of 3 keywords covered
details_level1 / 1
#validinvalidschema
171218{
271218 "type": "integer"
371218}
timeout2 / 2
183174{
28385 "minimum": 1,
316889 "type": "integer"
483174}
Responses2 of 3 documented received
codedescriptionhitsavg
200successful operation0never seen
4XXerror2670ms
defaulterror621ms
Examples1 / 1 used
Query
60timeout
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
1241n/a{
2241n/a "type": "string"
3241n/a}
Responses2 of 3 documented received
codedescriptionhitsavg
200successful operation2031ms
4XXerror380ms
defaulterror0-
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
12103n/a{
22103n/a "type": "string"
32103n/a}
Query Parameters2 of 2 keywords covered
timeout2 / 2
1190696{
2190629 "minimum": 1,
3193567 "type": "integer"
4190696}
Body296 of 416 keywords covered
application/json296 / 416
ClusterOperations
11798242{
21798242 "anyOf": [
3801960 {
4801960 "$ref": "#/components/schemas/MoveShardOperation"
5801960 },
6322008 {
7322008 "$ref": "#/components/schemas/ReplicateShardOperation"
8322008 },
9182022 {
10182022 "$ref": "#/components/schemas/AbortTransferOperation"
11182022 },
12112029 {
13112029 "$ref": "#/components/schemas/DropReplicaOperation"
14112029 },
15561984 {
16561984 "$ref": "#/components/schemas/CreateShardingKeyOperation"
17561984 },
18112029 {
19112029 "$ref": "#/components/schemas/DropShardingKeyOperation"
20112029 },
21112029 {
22112029 "$ref": "#/components/schemas/RestartTransferOperation"
23112029 },
24392001 {
25392001 "$ref": "#/components/schemas/StartReshardingOperation"
26392001 },
27132027 {
28132027 "$ref": "#/components/schemas/AbortReshardingOperation"
29132027 },
301527513 {
311527513 "$ref": "#/components/schemas/ReplicatePointsOperation"
321527513 }
331798242 ]
341798242}
Referenced Components (58)369 of 520 keywords
AbortResharding1 of 1 keywords
1135{
2135 "type": "object"
3135}
AbortReshardingOperation6 of 6 keywords
1132027{
2135 "properties": {
3135 "abort_resharding": {
4135 "$ref": "#/components/schemas/AbortResharding"
5135 }
6135 },
7182015 "required": [
8182015 "abort_resharding"
9182015 ],
1020337 "type": "object"
11132027}
AbortShardTransfer11 of 14 keywords
11829{
22121 "properties": {
3347 "from_peer_id": {
400 "format": "uint64",
5351 "minimum": 0,
6356 "type": "integer"
7347 },
8347 "shard_id": {
900 "format": "uint32",
10351 "minimum": 0,
11356 "type": "integer"
12347 },
13347 "to_peer_id": {
1400 "format": "uint64",
15351 "minimum": 0,
16356 "type": "integer"
17347 }
182121 },
19393 "required": [
20411 "from_peer_id",
21411 "shard_id",
22411 "to_peer_id"
23393 ],
24425 "type": "object"
251829}
AbortTransferOperation6 of 6 keywords
1182022{
21829 "properties": {
31829 "abort_transfer": {
41829 "$ref": "#/components/schemas/AbortShardTransfer"
51829 }
61829 },
7471986 "required": [
8471986 "abort_transfer"
9471986 ],
1020337 "type": "object"
11182022}
AnyVariants3 of 9 keywords
1840{
2840 "anyOf": [
32856 {
42856 "items": {
51456 "type": "string"
62856 },
7840 "type": "array",
8840 "uniqueItems": true
92856 },
107014 {
117014 "items": {
125614 "format": "int64",
135614 "type": "integer"
147014 },
15840 "type": "array",
16840 "uniqueItems": true
177014 }
18840 ]
19840}
Condition10 of 10 keywords
115245241{
215245241 "anyOf": [
38755890 {
48755890 "$ref": "#/components/schemas/FieldCondition"
58755890 },
676758 {
776758 "$ref": "#/components/schemas/IsEmptyCondition"
876758 },
976758 {
1076758 "$ref": "#/components/schemas/IsNullCondition"
1176758 },
12516714 {
13516714 "$ref": "#/components/schemas/HasIdCondition"
14516714 },
1576758 {
1676758 "$ref": "#/components/schemas/HasVectorCondition"
1776758 },
18216744 {
19216744 "$ref": "#/components/schemas/SliceCondition"
20216744 },
212576508 {
222576508 "$ref": "#/components/schemas/NestedCondition"
232576508 },
242996466 {
252996466 "$ref": "#/components/schemas/Filter"
262996466 }
2715245241 ]
2815245241}
CreateShardingKey20 of 23 keywords
15636{
25730 "properties": {
365n/a "initial_state": {
465n/a "anyOf": [
51154 {
61154 "$ref": "#/components/schemas/ReplicaState"
71154 },
865n/a {
965n/a "nullable": true
1065n/a }
1165n/a ],
1265n/a },
136112 "placement": {
14558 "items": {
1500 "format": "uint64",
16221 "minimum": 0,
17228 "type": "integer"
18558 },
1973n/a "nullable": true,
20694 "type": "array"
216112 },
22636 "replication_factor": {
2300 "format": "uint32",
24552 "minimum": 1,
2569n/a "nullable": true,
26645 "type": "integer"
27636 },
28806 "shard_key": {
29806 "$ref": "#/components/schemas/ShardKey"
30806 },
31636 "shards_number": {
3200 "format": "uint32",
33572 "minimum": 1,
3469n/a "nullable": true,
35645 "type": "integer"
36636 }
375730 },
38861 "required": [
39861 "shard_key"
40861 ],
41875 "type": "object"
425636}
CreateShardingKeyOperation6 of 6 keywords
1561984{
25636 "properties": {
35636 "create_sharding_key": {
45636 "$ref": "#/components/schemas/CreateShardingKey"
55636 }
65636 },
7921941 "required": [
8921941 "create_sharding_key"
9921941 ],
1020337 "type": "object"
11561984}
DatetimeRange11 of 15 keywords
1133651{
212628 "properties": {
31057 "gt": {
4490 "format": "date-time",
5112n/a "nullable": true,
61057 "type": "string"
71057 },
81057 "gte": {
9490 "format": "date-time",
10112n/a "nullable": true,
111057 "type": "string"
121057 },
13917 "lt": {
14420 "format": "date-time",
1598n/a "nullable": true,
16917 "type": "string"
17917 },
18777 "lte": {
19350 "format": "date-time",
2084n/a "nullable": true,
21777 "type": "string"
22777 }
2312628 },
24161623 "type": "object"
25133651}
DropReplicaOperation6 of 6 keywords
1112029{
21121 "properties": {
31121 "drop_replica": {
41121 "$ref": "#/components/schemas/Replica"
51121 }
61121 },
7322001 "required": [
8322001 "drop_replica"
9322001 ],
1020337 "type": "object"
11112029}
DropShardingKey6 of 6 keywords
11112{
2116 "properties": {
3116 "shard_key": {
4116 "$ref": "#/components/schemas/ShardKey"
5116 }
6116 },
7171 "required": [
8171 "shard_key"
9171 ],
10185 "type": "object"
111112}
DropShardingKeyOperation6 of 6 keywords
1112029{
21112 "properties": {
31112 "drop_sharding_key": {
41112 "$ref": "#/components/schemas/DropShardingKey"
51112 }
61112 },
7232010 "required": [
8232010 "drop_sharding_key"
9232010 ],
1020337 "type": "object"
11112029}
ExtendedPointId2 of 7 keywords
1440{
2440 "anyOf": [
32915 {
400 "format": "uint64",
5290 "minimum": 0,
62915 "type": "integer"
72915 },
81529 {
9150 "format": "uuid",
101529 "type": "string"
111529 }
12440 ],
13440}
FieldCondition33 of 34 keywords
18755890{
287514 "properties": {
3819n/a "geo_bounding_box": {
4819n/a "anyOf": [
57812 {
67812 "$ref": "#/components/schemas/GeoBoundingBox"
77812 },
8819n/a {
9819n/a "nullable": true
10819n/a }
11819n/a ],
12819n/a },
13819n/a "geo_polygon": {
14819n/a "anyOf": [
1542777 {
1642777 "$ref": "#/components/schemas/GeoPolygon"
1742777 },
18819n/a {
19819n/a "nullable": true
20819n/a }
21819n/a ],
22819n/a },
23812n/a "geo_radius": {
24812n/a "anyOf": [
257805 {
267805 "$ref": "#/components/schemas/GeoRadius"
277805 },
28812n/a {
29812n/a "nullable": true
30812n/a }
31812n/a ],
32812n/a },
338057 "is_empty": {
34812n/a "nullable": true,
358057 "type": "boolean"
368057 },
377987 "is_null": {
38805n/a "nullable": true,
397987 "type": "boolean"
407987 },
418750 "key": {
428750 "type": "string"
438750 },
44791n/a "match": {
45791n/a "anyOf": [
46168623 {
47168623 "$ref": "#/components/schemas/Match"
48168623 },
49791n/a {
50791n/a "nullable": true
51791n/a }
52791n/a ],
53791n/a },
54784n/a "range": {
55784n/a "anyOf": [
56133651 {
57133651 "$ref": "#/components/schemas/RangeInterface"
58133651 },
59784n/a {
60784n/a "nullable": true
61784n/a }
62784n/a ],
63784n/a },
64777n/a "values_count": {
65777n/a "anyOf": [
66112665 {
67112665 "$ref": "#/components/schemas/ValuesCount"
68112665 },
69777n/a {
70777n/a "nullable": true
71777n/a }
72777n/a ],
73777n/a }
7487514 },
75875649 "required": [
76875649 "key"
77875649 ],
7815245241 "type": "object"
798755890}
Filter25 of 25 keywords
120606494{
2n/a1225 "additionalProperties": false,
32003n/a "properties": {
41958n/a "min_should": {
51958n/a "anyOf": [
62361722 {
72361722 "$ref": "#/components/schemas/MinShould"
82361722 },
91958n/a {
101958n/a "nullable": true
111958n/a }
121958n/a ],
131958n/a },
141958n/a "must": {
151958n/a "anyOf": [
162261732 {
172261732 "$ref": "#/components/schemas/Condition"
182261732 },
192271731 {
2022715 "items": {
2121230 "$ref": "#/components/schemas/Condition"
2222715 },
232421716 "type": "array"
242271731 },
251958n/a {
261958n/a "nullable": true
271958n/a }
281958n/a ],
291958n/a },
301943n/a "must_not": {
311943n/a "anyOf": [
322261717 {
332261717 "$ref": "#/components/schemas/Condition"
342261717 },
352271716 {
3622715 "items": {
3721230 "$ref": "#/components/schemas/Condition"
3822715 },
392421701 "type": "array"
402271716 },
411943n/a {
421943n/a "nullable": true
431943n/a }
441943n/a ],
451943n/a },
461928n/a "should": {
471928n/a "anyOf": [
482261702 {
492261702 "$ref": "#/components/schemas/Condition"
502261702 },
512271701 {
5222715 "items": {
5321230 "$ref": "#/components/schemas/Condition"
5422715 },
552421686 "type": "array"
562271701 },
571928n/a {
581928n/a "nullable": true
591928n/a }
601928n/a ],
611928n/a }
622003n/a },
6332855269 "type": "object"
6420606494}
GeoBoundingBox3 of 7 keywords
17812{
270 "properties": {
370 "bottom_right": {
470 "$ref": "#/components/schemas/GeoPoint"
570 },
670 "top_left": {
770 "$ref": "#/components/schemas/GeoPoint"
870 }
970 },
1077 "required": [
1177 "bottom_right",
1277 "top_left"
1377 ],
1414805 "type": "object"
157812}
GeoLineString0 of 7 keywords
1560{
2560 "properties": {
3560 "points": {
4560 "items": {
5140 "$ref": "#/components/schemas/GeoPoint"
6560 },
7560 "type": "array"
8560 }
9560 },
10560 "required": [
11560 "points"
12560 ],
13560 "type": "object"
14560}
GeoPoint0 of 9 keywords
1350{
2350 "properties": {
3350 "lat": {
4350 "format": "double",
5350 "type": "number"
6350 },
7350 "lon": {
8350 "format": "double",
9350 "type": "number"
10350 }
11350 },
12350 "required": [
13350 "lat",
14350 "lon"
15350 ],
16350 "type": "object"
17350}
GeoPolygon4 of 9 keywords
142777{
2420 "properties": {
3420 "exterior": {
4420 "$ref": "#/components/schemas/GeoLineString"
5420 },
6350 "interiors": {
7280 "items": {
8140 "$ref": "#/components/schemas/GeoLineString"
9280 },
1035n/a "nullable": true,
11350 "type": "array"
12350 }
13420 },
14427 "required": [
15427 "exterior"
16427 ],
1749770 "type": "object"
1842777}
GeoRadius3 of 8 keywords
17805{
270 "properties": {
370 "center": {
470 "$ref": "#/components/schemas/GeoPoint"
570 },
670 "radius": {
770 "format": "double",
870 "type": "number"
970 }
1070 },
1177 "required": [
1277 "center",
1377 "radius"
1477 ],
1514798 "type": "object"
167805}
HasIdCondition3 of 8 keywords
1516714{
2510 "properties": {
3510 "has_id": {
4510 "items": {
5440 "$ref": "#/components/schemas/ExtendedPointId"
6510 },
7510 "type": "array",
8510 "uniqueItems": true
9510 }
10510 },
11511473 "required": [
12511473 "has_id"
13511473 ],
1415245241 "type": "object"
15516714}
HasVectorCondition3 of 6 keywords
176758{
270 "properties": {
370 "has_vector": {
470 "type": "string"
570 }
670 },
771517 "required": [
871517 "has_vector"
971517 ],
1015245241 "type": "object"
1176758}
IsEmptyCondition6 of 6 keywords
176758{
27805 "properties": {
37805 "is_empty": {
47805 "$ref": "#/components/schemas/PayloadField"
57805 }
67805 },
7812712 "required": [
8812712 "is_empty"
9812712 ],
1015245241 "type": "object"
1176758}
IsNullCondition6 of 6 keywords
176758{
27798 "properties": {
37798 "is_null": {
47798 "$ref": "#/components/schemas/PayloadField"
57798 }
67798 },
7805719 "required": [
8805719 "is_null"
9805719 ],
1015245241 "type": "object"
1176758}
Match10 of 10 keywords
1168623{
2168623 "anyOf": [
349742 {
449742 "$ref": "#/components/schemas/MatchValue"
549742 },
67784 {
77784 "$ref": "#/components/schemas/MatchText"
87784 },
97784 {
107784 "$ref": "#/components/schemas/MatchTextAny"
117784 },
127784 {
137784 "$ref": "#/components/schemas/MatchPhrase"
147784 },
157784 {
167784 "$ref": "#/components/schemas/MatchPrefix"
177784 },
187784 {
197784 "$ref": "#/components/schemas/MatchSubstring"
207784 },
2142749 {
2242749 "$ref": "#/components/schemas/MatchAny"
2342749 },
2442749 {
2542749 "$ref": "#/components/schemas/MatchExcept"
2642749 }
27168623 ],
28168623}
MatchAny3 of 6 keywords
142749{
2420 "properties": {
3420 "any": {
4420 "$ref": "#/components/schemas/AnyVariants"
5420 }
6420 },
742133 "required": [
842133 "any"
942133 ],
10175616 "type": "object"
1142749}
MatchExcept3 of 6 keywords
142749{
2420 "properties": {
3420 "except": {
4420 "$ref": "#/components/schemas/AnyVariants"
5420 }
6420 },
742133 "required": [
842133 "except"
942133 ],
10175616 "type": "object"
1142749}
MatchPhrase3 of 6 keywords
17784{
270 "properties": {
370 "phrase": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "phrase"
97168 ],
10175616 "type": "object"
117784}
MatchPrefix3 of 6 keywords
17784{
270 "properties": {
370 "prefix": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "prefix"
97168 ],
10175616 "type": "object"
117784}
MatchSubstring3 of 6 keywords
17784{
270 "properties": {
370 "substring": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "substring"
97168 ],
10175616 "type": "object"
117784}
MatchText3 of 6 keywords
17784{
270 "properties": {
370 "text": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "text"
97168 ],
10175616 "type": "object"
117784}
MatchTextAny3 of 6 keywords
17784{
270 "properties": {
370 "text_any": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "text_any"
97168 ],
10175616 "type": "object"
117784}
MatchValue3 of 6 keywords
149742{
2490 "properties": {
3490 "value": {
4490 "$ref": "#/components/schemas/ValueVariants"
5490 }
6490 },
749126 "required": [
849126 "value"
949126 ],
10175616 "type": "object"
1149742}
MinShould3 of 10 keywords
12361722{
22360 "properties": {
32360 "conditions": {
42360 "items": {
52100 "$ref": "#/components/schemas/Condition"
62360 },
72360 "type": "array"
82360 },
92360 "min_count": {
1000 "format": "uint",
112360 "minimum": 1,
122360 "type": "integer"
132360 }
142360 },
1523615 "required": [
1623615 "conditions",
1723615 "min_count"
1823615 ],
192511707 "type": "object"
202361722}
MoveShard15 of 18 keywords
18029{
28321 "properties": {
3967 "from_peer_id": {
400 "format": "uint64",
5971 "minimum": 0,
6976 "type": "integer"
7967 },
845n/a "method": {
945n/a "anyOf": [
10441 {
11441 "$ref": "#/components/schemas/ShardTransferMethod"
12441 },
1345n/a {
1445n/a "nullable": true
1545n/a }
1645n/a ],
1745n/a },
18967 "shard_id": {
1900 "format": "uint32",
20971 "minimum": 0,
21976 "type": "integer"
22967 },
23967 "to_peer_id": {
2400 "format": "uint64",
25971 "minimum": 0,
26976 "type": "integer"
27967 }
288321 },
291013 "required": [
301031 "from_peer_id",
311031 "shard_id",
321031 "to_peer_id"
331013 ],
341045 "type": "object"
358029}
MoveShardOperation6 of 6 keywords
1801960{
28029 "properties": {
38029 "move_shard": {
48029 "$ref": "#/components/schemas/MoveShard"
58029 }
68029 },
71091924 "required": [
81091924 "move_shard"
91091924 ],
1020337 "type": "object"
11801960}
Nested0 of 7 keywords
12570{
22570 "properties": {
32570 "filter": {
42570 "$ref": "#/components/schemas/Filter"
52570 },
62570 "key": {
72570 "type": "string"
82570 }
92570 },
102570 "required": [
112570 "filter",
122570 "key"
132570 ],
142570 "type": "object"
152570}
NestedCondition3 of 6 keywords
12576508{
22570 "properties": {
32570 "nested": {
42570 "$ref": "#/components/schemas/Nested"
52570 }
62570 },
72571267 "required": [
82571267 "nested"
92571267 ],
1015245241 "type": "object"
112576508}
PayloadField1 of 6 keywords
1141603{
2140 "properties": {
3140 "key": {
4140 "type": "string"
5140 }
6140 },
7140 "required": [
8140 "key"
9140 ],
10141603 "type": "object"
11141603}
Range13 of 15 keywords
17777{
20154 "properties": {
37105 "gt": {
47105 "format": "double",
5112n/a "nullable": true,
66349 "type": "number"
77105 },
87105 "gte": {
97105 "format": "double",
10112n/a "nullable": true,
116349 "type": "number"
127105 },
13791 "lt": {
14791 "format": "double",
1598n/a "nullable": true,
165642 "type": "number"
17791 },
18777 "lte": {
19777 "format": "double",
2084n/a "nullable": true,
214935 "type": "number"
22777 }
230154 },
24161623 "type": "object"
257777}
RangeInterface4 of 4 keywords
1133651{
2133651 "anyOf": [
37777 {
47777 "$ref": "#/components/schemas/Range"
57777 },
6133651 {
7133651 "$ref": "#/components/schemas/DatetimeRange"
8133651 }
9133651 ]
10133651}
Replica9 of 11 keywords
11121{
21314 "properties": {
3197 "peer_id": {
400 "format": "uint64",
5201 "minimum": 0,
6206 "type": "integer"
7197 },
8197 "shard_id": {
900 "format": "uint32",
10201 "minimum": 0,
11206 "type": "integer"
12197 }
131314 },
14252 "required": [
15261 "peer_id",
16261 "shard_id"
17252 ],
18275 "type": "object"
191121}
ReplicaState3 of 3 keywords
11154{
21154 "enum": [
31n/a "Active",
41n/a "Dead",
51n/a "Partial",
61n/a "Initializing",
71n/a "Listener",
81n/a "PartialSnapshot",
91n/a "Recovery",
101n/a "Resharding",
111n/a "ReshardingScaleDown",
121n/a "ActiveRead",
131n/a "ManualRecovery"
141154 ],
151253 "type": "string"
161154}
ReplicatePoints11 of 11 keywords
1152719{
2152912 "properties": {
31532n/a "filter": {
41532n/a "anyOf": [
5150428 {
6150428 "$ref": "#/components/schemas/Filter"
7150428 },
81532n/a {
91532n/a "nullable": true
101532n/a }
111532n/a ]
121532n/a },
1315346 "from_shard_key": {
1415346 "$ref": "#/components/schemas/ShardKey"
1515346 },
1615346 "to_shard_key": {
1715346 "$ref": "#/components/schemas/ShardKey"
1815346 }
19152912 },
2015392 "required": [
2115401 "from_shard_key",
2215401 "to_shard_key"
2315392 ],
2415415 "type": "object"
25152719}
ReplicatePointsOperation6 of 6 keywords
11527513{
2152719 "properties": {
3152719 "replicate_points": {
4152719 "$ref": "#/components/schemas/ReplicatePoints"
5152719 }
6152719 },
71546487 "required": [
81546487 "replicate_points"
91546487 ],
1020337 "type": "object"
111527513}
ReplicateShard15 of 18 keywords
13229{
23521 "properties": {
3487 "from_peer_id": {
400 "format": "uint64",
5491 "minimum": 0,
6496 "type": "integer"
7487 },
838n/a "method": {
938n/a "anyOf": [
10434 {
11434 "$ref": "#/components/schemas/ShardTransferMethod"
12434 },
1338n/a {
1438n/a "nullable": true
1538n/a }
1638n/a ],
1738n/a },
18487 "shard_id": {
1900 "format": "uint32",
20491 "minimum": 0,
21496 "type": "integer"
22487 },
23487 "to_peer_id": {
2400 "format": "uint64",
25491 "minimum": 0,
26496 "type": "integer"
27487 }
283521 },
29533 "required": [
30551 "from_peer_id",
31551 "shard_id",
32551 "to_peer_id"
33533 ],
34565 "type": "object"
353229}
ReplicateShardOperation6 of 6 keywords
1322008{
23229 "properties": {
33229 "replicate_shard": {
43229 "$ref": "#/components/schemas/ReplicateShard"
53229 }
63229 },
7611972 "required": [
8611972 "replicate_shard"
9611972 ],
1020337 "type": "object"
11322008}
ReshardingDirection3 of 3 keywords
1456{
2456 "enum": [
340n/a "up",
45n/a "down"
5456 ],
6465 "type": "string"
7456}
RestartTransfer12 of 15 keywords
11136{
21527 "properties": {
3347 "from_peer_id": {
400 "format": "uint64",
5351 "minimum": 0,
6356 "type": "integer"
7347 },
8356 "method": {
9356 "$ref": "#/components/schemas/ShardTransferMethod"
10356 },
11347 "shard_id": {
1200 "format": "uint32",
13351 "minimum": 0,
14356 "type": "integer"
15347 },
16347 "to_peer_id": {
1700 "format": "uint64",
18351 "minimum": 0,
19356 "type": "integer"
20347 }
211527 },
22384 "required": [
23411 "from_peer_id",
24411 "method",
25411 "shard_id",
26411 "to_peer_id"
27384 ],
28425 "type": "object"
291136}
RestartTransferOperation6 of 6 keywords
1112029{
21136 "properties": {
31136 "restart_transfer": {
41136 "$ref": "#/components/schemas/RestartTransfer"
51136 }
61136 },
7471986 "required": [
8471986 "restart_transfer"
9471986 ],
1020337 "type": "object"
11112029}
ShardKey5 of 6 keywords
1316646{
2316646 "anyOf": [
3311993 {
4311993 "type": "string"
5311993 },
6473165 {
700 "format": "uint64",
8514 "minimum": 0,
9513161 "type": "integer"
10473165 }
11316646 ]
12316646}
ShardTransferMethod3 of 3 keywords
14381{
24381 "enum": [
330n/a "stream_records",
46n/a "snapshot",
54n/a "wal_delta",
63n/a "resharding_stream_records"
74381 ],
84678 "type": "string"
94381}
Slice0 of 11 keywords
1210{
2210 "properties": {
3210 "index": {
400 "format": "uint32",
5210 "minimum": 0,
6210 "type": "integer"
7210 },
8210 "total": {
900 "format": "uint32",
10210 "minimum": 1,
11210 "type": "integer"
12210 }
13210 },
14210 "required": [
15210 "index",
16210 "total"
17210 ],
18210 "type": "object"
19210}
SliceCondition3 of 6 keywords
1216744{
2210 "properties": {
3210 "slice": {
4210 "$ref": "#/components/schemas/Slice"
5210 }
6210 },
7211503 "required": [
8211503 "slice"
9211503 ],
1015245241 "type": "object"
11216744}
StartResharding13 of 14 keywords
13918{
24012 "properties": {
3456 "direction": {
4456 "$ref": "#/components/schemas/ReshardingDirection"
5456 },
6316 "peer_id": {
700 "format": "uint64",
8281 "minimum": 0,
937n/a "nullable": true,
10325 "type": "integer"
11316 },
1229n/a "shard_key": {
1329n/a "anyOf": [
14722 {
15722 "$ref": "#/components/schemas/ShardKey"
16722 },
1729n/a {
1829n/a "nullable": true
1929n/a }
2029n/a ],
2129n/a }
224012 },
23511 "required": [
24511 "direction"
25511 ],
26525 "type": "object"
273918}
StartReshardingOperation6 of 6 keywords
1392001{
23918 "properties": {
33918 "start_resharding": {
43918 "$ref": "#/components/schemas/StartResharding"
53918 }
63918 },
7571976 "required": [
8571976 "start_resharding"
9571976 ],
1020337 "type": "object"
11392001}
ValueVariants4 of 6 keywords
1490{
2490 "anyOf": [
3742 {
4742 "type": "string"
5742 },
62821 {
72821 "format": "int64",
82821 "type": "integer"
92821 },
101435 {
111435 "type": "boolean"
121435 }
13490 ]
14490}
ValuesCount5 of 19 keywords
1112665{
21050 "properties": {
3840 "gt": {
400 "format": "uint",
5770 "minimum": 0,
684n/a "nullable": true,
7840 "type": "integer"
8840 },
9840 "gte": {
1000 "format": "uint",
11770 "minimum": 0,
1284n/a "nullable": true,
13840 "type": "integer"
14840 },
15770 "lt": {
1600 "format": "uint",
17700 "minimum": 0,
1877n/a "nullable": true,
19770 "type": "integer"
20770 },
21700 "lte": {
2200 "format": "uint",
23630 "minimum": 0,
2470n/a "nullable": true,
25700 "type": "integer"
26700 }
271050 },
28112665 "type": "object"
29112665}
Responses1 of 3 documented received
codedescriptionhitsavg
200successful operation0never seen
4XXerror21030ms
defaulterror0-
Examples4 / 4 used
Body: application/json
"region_1"ShardKey
12ShardKey
42ExtendedPointId
"550e8400-e29b-41d4-a716-446655440000"ExtendedPointId
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
1302n/a{
2302n/a "type": "string"
3302n/a}
Responses2 of 3 documented received
codedescriptionhitsavg
200successful operation870ms
4XXerror2150ms
defaulterror0-
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
1383n/a{
2383n/a "type": "string"
3383n/a}
Query Parameters2 of 2 keywords covered
timeout2 / 2
116057{
216024 "minimum": 1,
318433 "type": "integer"
416057}
Body23 of 27 keywords covered
application/json23 / 27
CreateShardingKey
119899{
219990 "properties": {
3115n/a "initial_state": {
4115n/a "anyOf": [
511104 {
611104 "$ref": "#/components/schemas/ReplicaState"
711104 },
8115n/a {
9115n/a "nullable": true
10115n/a }
11115n/a ],
12115n/a },
1312533 "placement": {
1410312 "items": {
1500 "format": "uint64",
162171 "minimum": 0,
1721712 "type": "integer"
1810312 },
19158n/a "nullable": true,
2013721 "type": "array"
2112533 },
2213112 "replication_factor": {
2300 "format": "uint32",
241043 "minimum": 1,
25143n/a "nullable": true,
2613310 "type": "integer"
2713112 },
2825038 "shard_key": {
2925038 "$ref": "#/components/schemas/ShardKey"
3025038 },
3110537 "shards_number": {
3200 "format": "uint32",
33829 "minimum": 1,
34142n/a "nullable": true,
3511230 "type": "integer"
3610537 }
3719990 },
382884 "required": [
392884 "shard_key"
402884 ],
412925 "type": "object"
4219899}
Referenced Components (2)8 of 9 keywords
ReplicaState3 of 3 keywords
111104{
211104 "enum": [
31n/a "Active",
41n/a "Dead",
51n/a "Partial",
61n/a "Initializing",
71n/a "Listener",
81n/a "PartialSnapshot",
91n/a "Recovery",
101n/a "Resharding",
111n/a "ReshardingScaleDown",
121n/a "ActiveRead",
131n/a "ManualRecovery"
1411104 ],
151798 "type": "string"
1611104}
ShardKey5 of 6 keywords
125038{
225038 "anyOf": [
319395 {
419395 "type": "string"
519395 },
657231 {
700 "format": "uint64",
8648 "minimum": 0,
965223 "type": "integer"
1057231 }
1125038 ]
1225038}
Responses1 of 3 documented received
codedescriptionhitsavg
200successful operation0never seen
4XXerror3830ms
defaulterror0-
Examples2 / 2 used
Body: application/json
"region_1"ShardKey
12ShardKey
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
1328n/a{
2328n/a "type": "string"
3328n/a}
Query Parameters2 of 2 keywords covered
timeout2 / 2
114471{
214441 "minimum": 1,
318530 "type": "integer"
414471}
Body8 of 9 keywords covered
application/json8 / 9
DropShardingKey
121027{
221011 "properties": {
321011 "shard_key": {
421011 "$ref": "#/components/schemas/ShardKey"
521011 }
621011 },
72213 "required": [
82213 "shard_key"
92213 ],
1022413 "type": "object"
1121027}
Referenced Components (1)5 of 6 keywords
ShardKey5 of 6 keywords
121011{
221011 "anyOf": [
314576 {
414576 "type": "string"
514576 },
665156 {
700 "format": "uint64",
8672 "minimum": 0,
967154 "type": "integer"
1065156 }
1121011 ]
1221011}
Responses1 of 3 documented received
codedescriptionhitsavg
200successful operation0never seen
4XXerror3280ms
defaulterror0-
Examples2 / 2 used
Body: application/json
"region_1"ShardKey
12ShardKey
Indexes 2 operations 1 covered 1 partial 0 uncovered 0 not measured 73% #
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
1615n/a{
2615n/a "type": "string"
3615n/a}
Query Parameters5 of 5 keywords covered
wait1 / 1
139981{
239981 "type": "boolean"
339981}
ordering2 / 2
WriteOrdering
141483{
241483 "enum": [
3374n/a "weak",
426n/a "medium",
514n/a "strong"
641483 ],
7497n/a "type": "string"
841483}
timeout2 / 2
140188{
240162 "minimum": 1,
346326 "type": "integer"
440188}
Body143 of 199 keywords covered
application/json143 / 199
CreateFieldIndex
147969{
248044 "properties": {
347944 "field_name": {
447944 "type": "string"
547944 },
6413n/a "field_schema": {
7413n/a "anyOf": [
831994 {
931994 "$ref": "#/components/schemas/PayloadFieldSchema"
1031994 },
11413n/a {
12413n/a "nullable": true
13413n/a }
14413n/a ]
15413n/a }
1648044 },
1752319 "required": [
1852319 "field_name"
1952319 ],
205426 "type": "object"
2147969}
Referenced Components (30)183 of 242 keywords
BoolIndexParams12 of 14 keywords
119394{
236292 "properties": {
32860 "enable_hnsw": {
4286n/a "nullable": true,
52860 "type": "boolean"
62860 },
7262n/a "memory": {
8262n/a "anyOf": [
924238 {
1024238 "$ref": "#/components/schemas/Memory"
1124238 },
12262n/a {
13262n/a "nullable": true
14262n/a }
15262n/a ],
16262n/a },
172690 "on_disk": {
18269n/a "nullable": true,
192690 "type": "boolean"
202690 },
2119292 "type": {
2219292 "$ref": "#/components/schemas/BoolIndexType"
2319292 }
2436292 },
2531121 "required": [
2631121 "type"
2731121 ],
2833281 "type": "object"
2919394}
BoolIndexType2 of 3 keywords
119292{
219292 "enum": [
319n/a "bool"
419292 ],
53110 "type": "string"
619292}
DatetimeIndexParams13 of 16 keywords
123390{
240288 "properties": {
32860 "enable_hnsw": {
4286n/a "nullable": true,
52860 "type": "boolean"
62860 },
7630 "is_principal": {
863n/a "nullable": true,
9630 "type": "boolean"
10630 },
11262n/a "memory": {
12262n/a "anyOf": [
1324238 {
1424238 "$ref": "#/components/schemas/Memory"
1524238 },
16262n/a {
17262n/a "nullable": true
18262n/a }
19262n/a ],
20262n/a },
212690 "on_disk": {
22269n/a "nullable": true,
232690 "type": "boolean"
242690 },
2523288 "type": {
2623288 "$ref": "#/components/schemas/DatetimeIndexType"
2723288 }
2840288 },
2931121 "required": [
3031121 "type"
3131121 ],
3233281 "type": "object"
3323390}
DatetimeIndexType2 of 3 keywords
123288{
223288 "enum": [
323n/a "datetime"
423288 ],
53110 "type": "string"
623288}
DisabledStemmerParams6 of 6 keywords
11127{
2119 "properties": {
3119 "type": {
4119 "$ref": "#/components/schemas/NoStemmer"
5119 }
6119 },
7201 "required": [
8201 "type"
9201 ],
1021107 "type": "object"
111127}
FloatIndexParams13 of 16 keywords
123390{
240288 "properties": {
32860 "enable_hnsw": {
4286n/a "nullable": true,
52860 "type": "boolean"
62860 },
7630 "is_principal": {
863n/a "nullable": true,
9630 "type": "boolean"
10630 },
11262n/a "memory": {
12262n/a "anyOf": [
1324238 {
1424238 "$ref": "#/components/schemas/Memory"
1524238 },
16262n/a {
17262n/a "nullable": true
18262n/a }
19262n/a ],
20262n/a },
212690 "on_disk": {
22269n/a "nullable": true,
232690 "type": "boolean"
242690 },
2523288 "type": {
2623288 "$ref": "#/components/schemas/FloatIndexType"
2723288 }
2840288 },
2931121 "required": [
3031121 "type"
3131121 ],
3233281 "type": "object"
3323390}
FloatIndexType2 of 3 keywords
123288{
223288 "enum": [
323n/a "float"
423288 ],
53110 "type": "string"
623288}
GeoIndexParams12 of 14 keywords
119394{
236292 "properties": {
32860 "enable_hnsw": {
4286n/a "nullable": true,
52860 "type": "boolean"
62860 },
7262n/a "memory": {
8262n/a "anyOf": [
924238 {
1024238 "$ref": "#/components/schemas/Memory"
1124238 },
12262n/a {
13262n/a "nullable": true
14262n/a }
15262n/a ],
16262n/a },
172690 "on_disk": {
18269n/a "nullable": true,
192690 "type": "boolean"
202690 },
2119292 "type": {
2219292 "$ref": "#/components/schemas/GeoIndexType"
2319292 }
2436292 },
2531121 "required": [
2631121 "type"
2731121 ],
2833281 "type": "object"
2919394}
GeoIndexType2 of 3 keywords
119292{
219292 "enum": [
319n/a "geo"
419292 ],
53110 "type": "string"
619292}
IntegerIndexParams15 of 20 keywords
131382{
248280 "properties": {
32860 "enable_hnsw": {
4286n/a "nullable": true,
52860 "type": "boolean"
62860 },
7630 "is_principal": {
863n/a "nullable": true,
9630 "type": "boolean"
10630 },
11240 "lookup": {
1224n/a "nullable": true,
13240 "type": "boolean"
14240 },
15262n/a "memory": {
16262n/a "anyOf": [
1724238 {
1824238 "$ref": "#/components/schemas/Memory"
1924238 },
20262n/a {
21262n/a "nullable": true
22262n/a }
23262n/a ],
24262n/a },
252690 "on_disk": {
26269n/a "nullable": true,
272690 "type": "boolean"
282690 },
29210 "range": {
3021n/a "nullable": true,
31210 "type": "boolean"
32210 },
3331280 "type": {
3431280 "$ref": "#/components/schemas/IntegerIndexType"
3531280 }
3648280 },
3731121 "required": [
3831121 "type"
3931121 ],
4033281 "type": "object"
4131382}
IntegerIndexType2 of 3 keywords
131280{
231280 "enum": [
331n/a "integer"
431280 ],
53110 "type": "string"
631280}
KeywordIndexParams14 of 18 keywords
127386{
244284 "properties": {
32860 "enable_hnsw": {
4286n/a "nullable": true,
52860 "type": "boolean"
62860 },
7410 "is_tenant": {
841n/a "nullable": true,
9410 "type": "boolean"
10410 },
11262n/a "memory": {
12262n/a "anyOf": [
1324238 {
1424238 "$ref": "#/components/schemas/Memory"
1524238 },
16262n/a {
17262n/a "nullable": true
18262n/a }
19262n/a ],
20262n/a },
212690 "on_disk": {
22269n/a "nullable": true,
232690 "type": "boolean"
242690 },
25190 "prefix": {
2619n/a "nullable": true,
27190 "type": "boolean"
28190 },
2927284 "type": {
3027284 "$ref": "#/components/schemas/KeywordIndexType"
3127284 }
3244284 },
3331121 "required": [
3431121 "type"
3531121 ],
3633281 "type": "object"
3727386}
KeywordIndexType2 of 3 keywords
127284{
227284 "enum": [
327n/a "keyword"
427284 ],
53110 "type": "string"
627284}
Language3 of 3 keywords
16097{
26097 "enum": [
32n/a "arabic",
42n/a "azerbaijani",
52n/a "basque",
62n/a "bengali",
72n/a "catalan",
82n/a "chinese",
92n/a "danish",
102n/a "dutch",
112n/a "english",
122n/a "finnish",
132n/a "french",
142n/a "german",
152n/a "greek",
162n/a "hebrew",
172n/a "hinglish",
182n/a "hungarian",
192n/a "indonesian",
202n/a "italian",
212n/a "japanese",
222n/a "kazakh",
232n/a "nepali",
242n/a "norwegian",
252n/a "portuguese",
262n/a "romanian",
272n/a "russian",
282n/a "slovene",
292n/a "spanish",
302n/a "swedish",
312n/a "tajik",
322n/a "turkish"
336097 ],
346196 "type": "string"
356097}
Memory3 of 3 keywords
11921904{
21921904 "enum": [
364n/a "cold",
464n/a "cached",
564n/a "pinned"
61921904 ],
72561840 "type": "string"
81921904}
NoStemmer2 of 3 keywords
1119{
2119 "enum": [
31n/a "none"
4119 ],
5200 "type": "string"
6119}
PayloadFieldSchema4 of 4 keywords
131994{
231994 "anyOf": [
38405 {
48405 "$ref": "#/components/schemas/PayloadSchemaType"
58405 },
6311102 {
7311102 "$ref": "#/components/schemas/PayloadSchemaParams"
8311102 }
931994 ]
1031994}
PayloadSchemaParams10 of 10 keywords
1311102{
2311102 "anyOf": [
327386 {
427386 "$ref": "#/components/schemas/KeywordIndexParams"
527386 },
631382 {
731382 "$ref": "#/components/schemas/IntegerIndexParams"
831382 },
923390 {
1023390 "$ref": "#/components/schemas/FloatIndexParams"
1123390 },
1219394 {
1319394 "$ref": "#/components/schemas/GeoIndexParams"
1419394 },
15146267 {
16146267 "$ref": "#/components/schemas/TextIndexParams"
17146267 },
1819394 {
1919394 "$ref": "#/components/schemas/BoolIndexParams"
2019394 },
2123390 {
2223390 "$ref": "#/components/schemas/DatetimeIndexParams"
2323390 },
2423390 {
2523390 "$ref": "#/components/schemas/UuidIndexParams"
2623390 }
27311102 ],
28311102}
PayloadSchemaType3 of 3 keywords
18405{
28405 "enum": [
31n/a "keyword",
41n/a "integer",
51n/a "float",
61n/a "geo",
71n/a "text",
81n/a "bool",
91n/a "datetime",
101n/a "uuid"
118405 ],
129404 "type": "string"
138405}
Snowball2 of 3 keywords
1191{
2191 "enum": [
319n/a "snowball"
4191 ],
5200 "type": "string"
6191}
SnowballLanguage0 of 3 keywords
1190{
2190 "enum": [
31n/a "arabic",
41n/a "armenian",
51n/a "danish",
61n/a "dutch",
71n/a "english",
81n/a "finnish",
91n/a "french",
101n/a "german",
111n/a "greek",
121n/a "hungarian",
131n/a "italian",
141n/a "norwegian",
151n/a "portuguese",
161n/a "romanian",
171n/a "russian",
181n/a "spanish",
191n/a "swedish",
201n/a "tamil",
211n/a "turkish"
22190 ],
23190 "type": "string"
24190}
SnowballParams6 of 7 keywords
119109{
2191 "properties": {
3190 "language": {
4190 "$ref": "#/components/schemas/SnowballLanguage"
5190 },
6191 "type": {
7191 "$ref": "#/components/schemas/Snowball"
8191 }
9191 },
10192 "required": [
11192 "language",
12201 "type"
13192 ],
1421107 "type": "object"
1519109}
StemmingAlgorithm4 of 4 keywords
120108{
220108 "anyOf": [
319109 {
419109 "$ref": "#/components/schemas/SnowballParams"
519109 },
61127 {
71127 "$ref": "#/components/schemas/DisabledStemmerParams"
81127 }
920108 ],
1020108}
StopwordsInterface4 of 4 keywords
16760{
26760 "anyOf": [
33097 {
43097 "$ref": "#/components/schemas/Language"
53097 },
63790 {
73790 "$ref": "#/components/schemas/StopwordsSet"
83790 }
96760 ]
106760}
StopwordsSet3 of 11 keywords
13790{
2360 "properties": {
3350 "custom": {
4340 "items": {
510 "type": "string"
6340 },
735n/a "nullable": true,
8350 "type": "array",
9340 "uniqueItems": true
10350 },
11350 "languages": {
12340 "items": {
13300 "$ref": "#/components/schemas/Language"
14340 },
1535n/a "nullable": true,
16350 "type": "array",
17340 "uniqueItems": true
18350 }
19360 },
203790 "type": "object"
213790}
TextIndexParams25 of 37 keywords
1146267{
2166165 "properties": {
31530 "ascii_folding": {
4153n/a "nullable": true,
51530 "type": "boolean"
61530 },
72860 "enable_hnsw": {
8286n/a "nullable": true,
92860 "type": "boolean"
102860 },
111500 "lowercase": {
12150n/a "nullable": true,
131500 "type": "boolean"
141500 },
151470 "max_token_len": {
1600 "format": "uint",
171340 "minimum": 0,
18147n/a "nullable": true,
191470 "type": "integer"
201470 },
21262n/a "memory": {
22262n/a "anyOf": [
2324238 {
2424238 "$ref": "#/components/schemas/Memory"
2524238 },
26262n/a {
27262n/a "nullable": true
28262n/a }
29262n/a ],
30262n/a },
311450 "min_token_len": {
3200 "format": "uint",
331320 "minimum": 0,
34145n/a "nullable": true,
351450 "type": "integer"
361450 },
372690 "on_disk": {
38269n/a "nullable": true,
392690 "type": "boolean"
402690 },
411440 "phrase_matching": {
42144n/a "nullable": true,
431440 "type": "boolean"
441440 },
45128n/a "stemmer": {
46128n/a "anyOf": [
4720108 {
4820108 "$ref": "#/components/schemas/StemmingAlgorithm"
4920108 },
50128n/a {
51128n/a "nullable": true
52128n/a }
53128n/a ],
54128n/a },
55127n/a "stopwords": {
56127n/a "anyOf": [
576760 {
586760 "$ref": "#/components/schemas/StopwordsInterface"
596760 },
60127n/a {
61127n/a "nullable": true
62127n/a }
63127n/a ],
64127n/a },
651400 "tokenizer": {
661400 "$ref": "#/components/schemas/TokenizerType"
671400 },
68146165 "type": {
69146165 "$ref": "#/components/schemas/TextIndexType"
70146165 }
71166165 },
7231121 "required": [
7331121 "type"
7431121 ],
7533281 "type": "object"
76146267}
TextIndexType2 of 3 keywords
1146165{
2146165 "enum": [
3146n/a "text"
4146165 ],
53110 "type": "string"
6146165}
TokenizerType0 of 3 keywords
11400{
21400 "enum": [
3123n/a "prefix",
41n/a "whitespace",
53n/a "word",
613n/a "multilingual"
71400 ],
81400 "type": "string"
91400}
UuidIndexParams13 of 16 keywords
123390{
240288 "properties": {
32860 "enable_hnsw": {
4286n/a "nullable": true,
52860 "type": "boolean"
62860 },
7410 "is_tenant": {
841n/a "nullable": true,
9410 "type": "boolean"
10410 },
11262n/a "memory": {
12262n/a "anyOf": [
1324238 {
1424238 "$ref": "#/components/schemas/Memory"
1524238 },
16262n/a {
17262n/a "nullable": true
18262n/a }
19262n/a ],
20262n/a },
212690 "on_disk": {
22269n/a "nullable": true,
232690 "type": "boolean"
242690 },
2523288 "type": {
2623288 "$ref": "#/components/schemas/UuidIndexType"
2723288 }
2840288 },
2931121 "required": [
3031121 "type"
3131121 ],
3233281 "type": "object"
3323390}
UuidIndexType2 of 3 keywords
123288{
223288 "enum": [
323n/a "uuid"
423288 ],
53110 "type": "string"
623288}
Responses1 of 3 documented received
codedescriptionhitsavg
200successful operation0never seen
4XXerror6150ms
defaulterror0-
Path Parameters2 of 2 keywords covered
collection_name1 / 1
#validinvalidschema
1172n/a{
2172n/a "type": "string"
3172n/a}
field_name1 / 1
1172n/a{
2172n/a "type": "string"
3172n/a}
Query Parameters5 of 5 keywords covered
wait1 / 1
14527{
24527 "type": "boolean"
34527}
ordering2 / 2
WriteOrdering
15336{
25336 "enum": [
332n/a "weak",
414n/a "medium",
57n/a "strong"
65336 ],
789n/a "type": "string"
85336}
timeout2 / 2
14541{
24521 "minimum": 1,
36620 "type": "integer"
44541}
Responses2 of 3 documented received
codedescriptionhitsavg
200successful operation1436ms
4XXerror1580ms
defaulterror0-
Points 14 operations 0 covered 14 partial 0 uncovered 0 not measured 67% #
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
11837n/a{
21837n/a "type": "string"
31837n/a}
Query Parameters8 of 9 keywords covered
consistency6 / 7
ReadConsistency
116211677{
216211677 "anyOf": [
316021696 {
400 "format": "uint",
516028 "minimum": 1,
616101688 "type": "integer"
716021696 },
8193279 {
9193279 "$ref": "#/components/schemas/ReadConsistencyType"
10193279 }
1116211677 ],
1216211677}
Referenced Components (1)3 of 3 keywords
ReadConsistencyType3 of 3 keywords
1193279{
2193279 "enum": [
37n/a "majority",
47n/a "quorum",
55n/a "all"
6193279 ],
71688n/a "type": "string"
8193279}
timeout2 / 2
1165360{
2165317 "minimum": 1,
3167043 "type": "integer"
4165360}
Body170 of 277 keywords covered
application/json170 / 277
FacetRequest
1172742{
2174115 "properties": {
316284 "exact": {
41632n/a "nullable": true,
516284 "type": "boolean"
616284 },
71591n/a "filter": {
81591n/a "anyOf": [
9150685 {
10150685 "$ref": "#/components/schemas/Filter"
11150685 },
121591n/a {
131591n/a "nullable": true
141591n/a }
151591n/a ],
161591n/a },
1717375 "key": {
1817375 "type": "string"
1917375 },
2016116 "limit": {
2100 "format": "uint",
2215942 "minimum": 1,
231617n/a "nullable": true,
2416125 "type": "integer"
2516116 },
261589n/a "shard_key": {
271589n/a "anyOf": [
28251564 {
29251564 "$ref": "#/components/schemas/ShardKeySelector"
30251564 },
311589n/a {
321589n/a "nullable": true
331589n/a }
341589n/a ]
351589n/a }
36174115 },
37174222 "required": [
38174222 "key"
39174222 ],
4017645 "type": "object"
41172742}
Referenced Components (37)195 of 333 keywords
AnyVariants3 of 9 keywords
1840{
2840 "anyOf": [
32856 {
42856 "items": {
51456 "type": "string"
62856 },
7840 "type": "array",
8840 "uniqueItems": true
92856 },
107014 {
117014 "items": {
125614 "format": "int64",
135614 "type": "integer"
147014 },
15840 "type": "array",
16840 "uniqueItems": true
177014 }
18840 ]
19840}
Condition10 of 10 keywords
115325241{
215325241 "anyOf": [
38755898 {
48755898 "$ref": "#/components/schemas/FieldCondition"
58755898 },
676766 {
776766 "$ref": "#/components/schemas/IsEmptyCondition"
876766 },
976766 {
1076766 "$ref": "#/components/schemas/IsNullCondition"
1176766 },
12596714 {
13596714 "$ref": "#/components/schemas/HasIdCondition"
14596714 },
1576766 {
1676766 "$ref": "#/components/schemas/HasVectorCondition"
1776766 },
18216752 {
19216752 "$ref": "#/components/schemas/SliceCondition"
20216752 },
212576516 {
222576516 "$ref": "#/components/schemas/NestedCondition"
232576516 },
242996474 {
252996474 "$ref": "#/components/schemas/Filter"
262996474 }
2715325241 ]
2815325241}
DatetimeRange11 of 15 keywords
1133651{
212628 "properties": {
31057 "gt": {
4490 "format": "date-time",
5112n/a "nullable": true,
61057 "type": "string"
71057 },
81057 "gte": {
9490 "format": "date-time",
10112n/a "nullable": true,
111057 "type": "string"
121057 },
13917 "lt": {
14420 "format": "date-time",
1598n/a "nullable": true,
16917 "type": "string"
17917 },
18777 "lte": {
19350 "format": "date-time",
2084n/a "nullable": true,
21777 "type": "string"
22777 }
2312628 },
24161623 "type": "object"
25133651}
ExtendedPointId2 of 7 keywords
1520{
2520 "anyOf": [
33319 {
400 "format": "uint64",
5330 "minimum": 0,
63319 "type": "integer"
73319 },
81933 {
9190 "format": "uuid",
101933 "type": "string"
111933 }
12520 ],
13520}
FieldCondition33 of 34 keywords
18755898{
287514 "properties": {
3819n/a "geo_bounding_box": {
4819n/a "anyOf": [
57812 {
67812 "$ref": "#/components/schemas/GeoBoundingBox"
77812 },
8819n/a {
9819n/a "nullable": true
10819n/a }
11819n/a ],
12819n/a },
13819n/a "geo_polygon": {
14819n/a "anyOf": [
1542777 {
1642777 "$ref": "#/components/schemas/GeoPolygon"
1742777 },
18819n/a {
19819n/a "nullable": true
20819n/a }
21819n/a ],
22819n/a },
23812n/a "geo_radius": {
24812n/a "anyOf": [
257805 {
267805 "$ref": "#/components/schemas/GeoRadius"
277805 },
28812n/a {
29812n/a "nullable": true
30812n/a }
31812n/a ],
32812n/a },
338057 "is_empty": {
34812n/a "nullable": true,
358057 "type": "boolean"
368057 },
377987 "is_null": {
38805n/a "nullable": true,
397987 "type": "boolean"
407987 },
418750 "key": {
428750 "type": "string"
438750 },
44791n/a "match": {
45791n/a "anyOf": [
46168623 {
47168623 "$ref": "#/components/schemas/Match"
48168623 },
49791n/a {
50791n/a "nullable": true
51791n/a }
52791n/a ],
53791n/a },
54784n/a "range": {
55784n/a "anyOf": [
56133651 {
57133651 "$ref": "#/components/schemas/RangeInterface"
58133651 },
59784n/a {
60784n/a "nullable": true
61784n/a }
62784n/a ],
63784n/a },
64777n/a "values_count": {
65777n/a "anyOf": [
66112665 {
67112665 "$ref": "#/components/schemas/ValuesCount"
68112665 },
69777n/a {
70777n/a "nullable": true
71777n/a }
72777n/a ],
73777n/a }
7487514 },
75875657 "required": [
76875657 "key"
77875657 ],
7815325241 "type": "object"
798755898}
Filter25 of 25 keywords
120626559{
2n/a1233 "additionalProperties": false,
32005n/a "properties": {
41960n/a "min_should": {
51960n/a "anyOf": [
62381722 {
72381722 "$ref": "#/components/schemas/MinShould"
82381722 },
91960n/a {
101960n/a "nullable": true
111960n/a }
121960n/a ],
131960n/a },
141960n/a "must": {
151960n/a "anyOf": [
162281732 {
172281732 "$ref": "#/components/schemas/Condition"
182281732 },
192271733 {
2022715 "items": {
2121230 "$ref": "#/components/schemas/Condition"
2222715 },
232421718 "type": "array"
242271733 },
251960n/a {
261960n/a "nullable": true
271960n/a }
281960n/a ],
291960n/a },
301945n/a "must_not": {
311945n/a "anyOf": [
322281717 {
332281717 "$ref": "#/components/schemas/Condition"
342281717 },
352271718 {
3622715 "items": {
3721230 "$ref": "#/components/schemas/Condition"
3822715 },
392421703 "type": "array"
402271718 },
411945n/a {
421945n/a "nullable": true
431945n/a }
441945n/a ],
451945n/a },
461930n/a "should": {
471930n/a "anyOf": [
482281702 {
492281702 "$ref": "#/components/schemas/Condition"
502281702 },
512271703 {
5222715 "items": {
5321230 "$ref": "#/components/schemas/Condition"
5422715 },
552421688 "type": "array"
562271703 },
571930n/a {
581930n/a "nullable": true
591930n/a }
601930n/a ],
611930n/a }
622005n/a },
6332955326 "type": "object"
6420626559}
GeoBoundingBox3 of 7 keywords
17812{
270 "properties": {
370 "bottom_right": {
470 "$ref": "#/components/schemas/GeoPoint"
570 },
670 "top_left": {
770 "$ref": "#/components/schemas/GeoPoint"
870 }
970 },
1077 "required": [
1177 "bottom_right",
1277 "top_left"
1377 ],
1414805 "type": "object"
157812}
GeoLineString0 of 7 keywords
1560{
2560 "properties": {
3560 "points": {
4560 "items": {
5140 "$ref": "#/components/schemas/GeoPoint"
6560 },
7560 "type": "array"
8560 }
9560 },
10560 "required": [
11560 "points"
12560 ],
13560 "type": "object"
14560}
GeoPoint0 of 9 keywords
1350{
2350 "properties": {
3350 "lat": {
4350 "format": "double",
5350 "type": "number"
6350 },
7350 "lon": {
8350 "format": "double",
9350 "type": "number"
10350 }
11350 },
12350 "required": [
13350 "lat",
14350 "lon"
15350 ],
16350 "type": "object"
17350}
GeoPolygon4 of 9 keywords
142777{
2420 "properties": {
3420 "exterior": {
4420 "$ref": "#/components/schemas/GeoLineString"
5420 },
6350 "interiors": {
7280 "items": {
8140 "$ref": "#/components/schemas/GeoLineString"
9280 },
1035n/a "nullable": true,
11350 "type": "array"
12350 }
13420 },
14427 "required": [
15427 "exterior"
16427 ],
1749770 "type": "object"
1842777}
GeoRadius3 of 8 keywords
17805{
270 "properties": {
370 "center": {
470 "$ref": "#/components/schemas/GeoPoint"
570 },
670 "radius": {
770 "format": "double",
870 "type": "number"
970 }
1070 },
1177 "required": [
1277 "center",
1377 "radius"
1477 ],
1514798 "type": "object"
167805}
HasIdCondition3 of 8 keywords
1596714{
2590 "properties": {
3590 "has_id": {
4590 "items": {
5520 "$ref": "#/components/schemas/ExtendedPointId"
6590 },
7590 "type": "array",
8590 "uniqueItems": true
9590 }
10590 },
11591473 "required": [
12591473 "has_id"
13591473 ],
1415325241 "type": "object"
15596714}
HasVectorCondition3 of 6 keywords
176766{
270 "properties": {
370 "has_vector": {
470 "type": "string"
570 }
670 },
771525 "required": [
871525 "has_vector"
971525 ],
1015325241 "type": "object"
1176766}
IsEmptyCondition6 of 6 keywords
176766{
27805 "properties": {
37805 "is_empty": {
47805 "$ref": "#/components/schemas/PayloadField"
57805 }
67805 },
7812720 "required": [
8812720 "is_empty"
9812720 ],
1015325241 "type": "object"
1176766}
IsNullCondition6 of 6 keywords
176766{
27798 "properties": {
37798 "is_null": {
47798 "$ref": "#/components/schemas/PayloadField"
57798 }
67798 },
7805727 "required": [
8805727 "is_null"
9805727 ],
1015325241 "type": "object"
1176766}
Match10 of 10 keywords
1168623{
2168623 "anyOf": [
349742 {
449742 "$ref": "#/components/schemas/MatchValue"
549742 },
67784 {
77784 "$ref": "#/components/schemas/MatchText"
87784 },
97784 {
107784 "$ref": "#/components/schemas/MatchTextAny"
117784 },
127784 {
137784 "$ref": "#/components/schemas/MatchPhrase"
147784 },
157784 {
167784 "$ref": "#/components/schemas/MatchPrefix"
177784 },
187784 {
197784 "$ref": "#/components/schemas/MatchSubstring"
207784 },
2142749 {
2242749 "$ref": "#/components/schemas/MatchAny"
2342749 },
2442749 {
2542749 "$ref": "#/components/schemas/MatchExcept"
2642749 }
27168623 ],
28168623}
MatchAny3 of 6 keywords
142749{
2420 "properties": {
3420 "any": {
4420 "$ref": "#/components/schemas/AnyVariants"
5420 }
6420 },
742133 "required": [
842133 "any"
942133 ],
10175616 "type": "object"
1142749}
MatchExcept3 of 6 keywords
142749{
2420 "properties": {
3420 "except": {
4420 "$ref": "#/components/schemas/AnyVariants"
5420 }
6420 },
742133 "required": [
842133 "except"
942133 ],
10175616 "type": "object"
1142749}
MatchPhrase3 of 6 keywords
17784{
270 "properties": {
370 "phrase": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "phrase"
97168 ],
10175616 "type": "object"
117784}
MatchPrefix3 of 6 keywords
17784{
270 "properties": {
370 "prefix": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "prefix"
97168 ],
10175616 "type": "object"
117784}
MatchSubstring3 of 6 keywords
17784{
270 "properties": {
370 "substring": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "substring"
97168 ],
10175616 "type": "object"
117784}
MatchText3 of 6 keywords
17784{
270 "properties": {
370 "text": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "text"
97168 ],
10175616 "type": "object"
117784}
MatchTextAny3 of 6 keywords
17784{
270 "properties": {
370 "text_any": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "text_any"
97168 ],
10175616 "type": "object"
117784}
MatchValue3 of 6 keywords
149742{
2490 "properties": {
3490 "value": {
4490 "$ref": "#/components/schemas/ValueVariants"
5490 }
6490 },
749126 "required": [
849126 "value"
949126 ],
10175616 "type": "object"
1149742}
MinShould3 of 10 keywords
12381722{
22380 "properties": {
32380 "conditions": {
42380 "items": {
52120 "$ref": "#/components/schemas/Condition"
62380 },
72380 "type": "array"
82380 },
92380 "min_count": {
1000 "format": "uint",
112380 "minimum": 1,
122380 "type": "integer"
132380 }
142380 },
1523815 "required": [
1623815 "conditions",
1723815 "min_count"
1823815 ],
192531707 "type": "object"
202381722}
Nested0 of 7 keywords
12570{
22570 "properties": {
32570 "filter": {
42570 "$ref": "#/components/schemas/Filter"
52570 },
62570 "key": {
72570 "type": "string"
82570 }
92570 },
102570 "required": [
112570 "filter",
122570 "key"
132570 ],
142570 "type": "object"
152570}
NestedCondition3 of 6 keywords
12576516{
22570 "properties": {
32570 "nested": {
42570 "$ref": "#/components/schemas/Nested"
52570 }
62570 },
72571275 "required": [
82571275 "nested"
92571275 ],
1015325241 "type": "object"
112576516}
PayloadField1 of 6 keywords
1141603{
2140 "properties": {
3140 "key": {
4140 "type": "string"
5140 }
6140 },
7140 "required": [
8140 "key"
9140 ],
10141603 "type": "object"
11141603}
Range13 of 15 keywords
17777{
20154 "properties": {
37105 "gt": {
47105 "format": "double",
5112n/a "nullable": true,
66349 "type": "number"
77105 },
87105 "gte": {
97105 "format": "double",
10112n/a "nullable": true,
116349 "type": "number"
127105 },
13791 "lt": {
14791 "format": "double",
1598n/a "nullable": true,
165642 "type": "number"
17791 },
18777 "lte": {
19777 "format": "double",
2084n/a "nullable": true,
214935 "type": "number"
22777 }
230154 },
24161623 "type": "object"
257777}
RangeInterface4 of 4 keywords
1133651{
2133651 "anyOf": [
37777 {
47777 "$ref": "#/components/schemas/Range"
57777 },
6133651 {
7133651 "$ref": "#/components/schemas/DatetimeRange"
8133651 }
9133651 ]
10133651}
ShardKey4 of 6 keywords
1351584{
2351584 "anyOf": [
3191600 {
4191600 "type": "string"
5191600 },
6161603 {
700 "format": "uint64",
8160 "minimum": 0,
9161603 "type": "integer"
10161603 }
11351584 ]
12351584}
ShardKeySelector6 of 6 keywords
1251564{
2251564 "anyOf": [
371582 {
471582 "$ref": "#/components/schemas/ShardKey"
571582 },
671582 {
771 "items": {
862 "$ref": "#/components/schemas/ShardKey"
971 },
1081581 "type": "array"
1171582 },
12111578 {
13111578 "$ref": "#/components/schemas/ShardKeyWithFallback"
14111578 }
15251564 ]
16251564}
ShardKeyWithFallback3 of 7 keywords
1111578{
2110 "properties": {
3110 "fallback": {
4110 "$ref": "#/components/schemas/ShardKey"
5110 },
6110 "target": {
7110 "$ref": "#/components/schemas/ShardKey"
8110 }
9110 },
10111 "required": [
11111 "fallback",
12111 "target"
13111 ],
14121577 "type": "object"
15111578}
Slice0 of 11 keywords
1210{
2210 "properties": {
3210 "index": {
400 "format": "uint32",
5210 "minimum": 0,
6210 "type": "integer"
7210 },
8210 "total": {
900 "format": "uint32",
10210 "minimum": 1,
11210 "type": "integer"
12210 }
13210 },
14210 "required": [
15210 "index",
16210 "total"
17210 ],
18210 "type": "object"
19210}
SliceCondition3 of 6 keywords
1216752{
2210 "properties": {
3210 "slice": {
4210 "$ref": "#/components/schemas/Slice"
5210 }
6210 },
7211511 "required": [
8211511 "slice"
9211511 ],
1015325241 "type": "object"
11216752}
ValueVariants4 of 6 keywords
1490{
2490 "anyOf": [
3742 {
4742 "type": "string"
5742 },
62821 {
72821 "format": "int64",
82821 "type": "integer"
92821 },
101435 {
111435 "type": "boolean"
121435 }
13490 ]
14490}
ValuesCount5 of 19 keywords
1112665{
21050 "properties": {
3840 "gt": {
400 "format": "uint",
5770 "minimum": 0,
684n/a "nullable": true,
7840 "type": "integer"
8840 },
9840 "gte": {
1000 "format": "uint",
11770 "minimum": 0,
1284n/a "nullable": true,
13840 "type": "integer"
14840 },
15770 "lt": {
1600 "format": "uint",
17700 "minimum": 0,
1877n/a "nullable": true,
19770 "type": "integer"
20770 },
21700 "lte": {
2200 "format": "uint",
23630 "minimum": 0,
2470n/a "nullable": true,
25700 "type": "integer"
26700 }
271050 },
28112665 "type": "object"
29112665}
Responses2 of 3 documented received
codedescriptionhitsavg
200successful operation220ms
4XXerror18150ms
defaulterror0-
Examples4 / 4 used
Body: application/json
42ExtendedPointId
"550e8400-e29b-41d4-a716-446655440000"ExtendedPointId
"region_1"ShardKey
12ShardKey
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
1957n/a{
2957n/a "type": "string"
3957n/a}
Query Parameters8 of 9 keywords covered
consistency6 / 7
ReadConsistency
1375394{
2375394 "anyOf": [
3255514 {
400 "format": "uint",
525514 "minimum": 1,
6269500 "type": "integer"
7255514 },
8120649 {
9120649 "$ref": "#/components/schemas/ReadConsistencyType"
10120649 }
11375394 ],
12375394}
Referenced Components (1)3 of 3 keywords
ReadConsistencyType3 of 3 keywords
1120649{
2120649 "enum": [
337n/a "majority",
449n/a "quorum",
534n/a "all"
6120649 ],
7500n/a "type": "string"
8120649}
timeout2 / 2
1413129{
241370 "minimum": 1,
348359 "type": "integer"
4413129}
Body49 of 55 keywords covered
application/json49 / 55
PointRequest
177856{
278436 "properties": {
379222 "ids": {
479217 "items": {
5311347 "$ref": "#/components/schemas/ExtendedPointId"
679217 },
78095 "type": "array"
879222 },
9114n/a "shard_key": {
10114n/a "anyOf": [
112589 {
122589 "$ref": "#/components/schemas/ShardKeySelector"
132589 },
14114n/a {
15114n/a "nullable": true
16114n/a }
17114n/a ],
18114n/a },
19110n/a "with_payload": {
20110n/a "anyOf": [
218102 {
228102 "$ref": "#/components/schemas/WithPayloadInterface"
238102 },
24110n/a {
25110n/a "nullable": true
26110n/a }
27110n/a ],
28110n/a },
2944114 "with_vector": {
3044114 "$ref": "#/components/schemas/WithVector"
3144114 }
3278436 },
3381415 "required": [
3481415 "ids"
3581415 ],
368295 "type": "object"
3777856}
Referenced Components (9)48 of 55 keywords
ExtendedPointId6 of 7 keywords
1311347{
2311347 "anyOf": [
315881572 {
400 "format": "uint64",
5158931 "minimum": 0,
616191541 "type": "integer"
715881572 },
815251635 {
915252 "format": "uuid",
1015271633 "type": "string"
1115251635 }
12311347 ],
13311347}
PayloadSelector4 of 4 keywords
14106{
24106 "anyOf": [
32108 {
42108 "$ref": "#/components/schemas/PayloadSelectorInclude"
52108 },
62108 {
72108 "$ref": "#/components/schemas/PayloadSelectorExclude"
82108 }
94106 ],
104106}
PayloadSelectorExclude3 of 7 keywords
12108{
2n/a3 "additionalProperties": false,
320 "properties": {
420 "exclude": {
520 "items": {
610 "type": "string"
720 },
820 "type": "array"
920 }
1020 },
1124 "required": [
1224 "exclude"
1324 ],
146104 "type": "object"
152108}
PayloadSelectorInclude6 of 7 keywords
12108{
2n/a2 "additionalProperties": false,
321 "properties": {
421 "include": {
520 "items": {
610 "type": "string"
720 },
821 "type": "array"
921 }
1021 },
1133 "required": [
1233 "include"
1333 ],
146104 "type": "object"
152108}
ShardKey5 of 6 keywords
135121{
235121 "anyOf": [
319137 {
419137 "type": "string"
519137 },
616140 {
700 "format": "uint64",
81612 "minimum": 0,
928128 "type": "integer"
1016140 }
1135121 ]
1235121}
ShardKeySelector6 of 6 keywords
12589{
22589 "anyOf": [
37107 {
47107 "$ref": "#/components/schemas/ShardKey"
57107 },
67107 {
771 "items": {
862 "$ref": "#/components/schemas/ShardKey"
971 },
108106 "type": "array"
117107 },
1211103 {
1311103 "$ref": "#/components/schemas/ShardKeyWithFallback"
1411103 }
152589 ]
162589}
ShardKeyWithFallback7 of 7 keywords
111103{
2116 "properties": {
3116 "fallback": {
4116 "$ref": "#/components/schemas/ShardKey"
5116 },
6116 "target": {
7116 "$ref": "#/components/schemas/ShardKey"
8116 }
9116 },
10171 "required": [
11171 "fallback",
12171 "target"
13171 ],
141896 "type": "object"
1511103}
WithPayloadInterface6 of 6 keywords
18102{
28102 "anyOf": [
32108 {
42108 "type": "boolean"
52108 },
62108 {
721 "items": {
812 "type": "string"
921 },
103107 "type": "array"
112108 },
124106 {
134106 "$ref": "#/components/schemas/PayloadSelector"
144106 }
158102 ],
168102}
WithVector5 of 5 keywords
144114{
244114 "anyOf": [
3138317 {
4138317 "type": "boolean"
5138317 },
6303152 {
73036 "items": {
86877 "type": "string"
93036 },
10309146 "type": "array"
11303152 }
1244114 ],
1344114}
Responses2 of 3 documented received
codedescriptionhitsavg
200successful operation2132ms
4XXerror7440ms
defaulterror0-
Examples4 / 4 used
Body: application/json
42ExtendedPointId
"550e8400-e29b-41d4-a716-446655440000"ExtendedPointId
"region_1"ShardKey
12ShardKey
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
14376n/a{
24376n/a "type": "string"
34376n/a}
Query Parameters5 of 5 keywords covered
wait1 / 1
1416318{
2416318 "type": "boolean"
3416318}
ordering2 / 2
WriteOrdering
1416127{
2416127 "enum": [
34137n/a "weak",
411n/a "medium",
513n/a "strong"
6416127 ],
74188n/a "type": "string"
8416127}
timeout2 / 2
1415937{
2415911 "minimum": 1,
3417026 "type": "integer"
4415937}
Body326 of 461 keywords covered
application/json326 / 461
PointInsertOperations
14021322{
24021322 "anyOf": [
320082335 {
420082335 "$ref": "#/components/schemas/PointsBatch"
520082335 },
620132330 {
720132330 "$ref": "#/components/schemas/PointsList"
820132330 }
94021322 ]
104021322}
Referenced Components (62)405 of 575 keywords
AnyVariants3 of 9 keywords
13360{
23360 "anyOf": [
3112224 {
4112224 "items": {
556224 "type": "string"
6112224 },
73360 "type": "array",
83360 "uniqueItems": true
9112224 },
1028056 {
1128056 "items": {
1222456 "format": "int64",
1322456 "type": "integer"
1428056 },
153360 "type": "array",
163360 "uniqueItems": true
1728056 }
183360 ]
193360}
Batch14 of 14 keywords
12008165{
22010158 "properties": {
3215413 "ids": {
421548 "items": {
51098 "$ref": "#/components/schemas/ExtendedPointId"
621548 },
721625 "type": "array"
8215413 },
921077 "payloads": {
1020n/a "items": {
1132n/a "anyOf": [
121418 {
131418 "$ref": "#/components/schemas/Payload"
141418 },
1532n/a {
1632n/a "nullable": true
1732n/a }
1832n/a ]
1920n/a },
202114n/a "nullable": true,
2121077 "type": "array"
2221077 },
232029138 "vectors": {
242029138 "$ref": "#/components/schemas/BatchVectorStruct"
252029138 }
262010158 },
2721662 "required": [
2821671 "ids",
2921671 "vectors"
3021662 ],
3121685 "type": "object"
322008165}
BatchVectorStruct20 of 20 keywords
12029138{
22029138 "anyOf": [
31668499 {
41668242 "items": {
57334 "items": {
6261147 "format": "float",
7261147 "type": "number"
87334 },
9107273 "type": "array"
101668242 },
111910257 "type": "array"
121668499 },
131661506 {
141661249 "items": {
154463 "items": {
161356 "items": {
174387 "format": "float",
184387 "type": "number"
191356 },
20141267 "type": "array"
214463 },
22107273 "type": "array"
231661249 },
241910257 "type": "array"
251661506 },
261721995 {
2717181 "additionalProperties": {
2817276 "items": {
2918876 "$ref": "#/components/schemas/Vector"
3017276 },
312485 "type": "array"
3217181 },
332531914 "type": "object"
341721995 },
351789378 {
361789121 "items": {
37155225 "$ref": "#/components/schemas/Document"
381789121 },
391910257 "type": "array"
401789378 },
411665502 {
421665245 "items": {
4352328 "$ref": "#/components/schemas/Image"
441665245 },
451910257 "type": "array"
461665502 },
471660507 {
481660250 "items": {
4923357 "$ref": "#/components/schemas/InferenceObject"
501660250 },
511910257 "type": "array"
521660507 }
532029138 ]
542029138}
Bm25Config14 of 32 keywords
1562267{
25240 "properties": {
34840 "ascii_folding": {
4484n/a "nullable": true,
54840 "type": "boolean"
64840 },
74840 "avg_len": {
84840 "format": "double",
94840 "type": "number"
104840 },
114800 "b": {
124800 "format": "double",
134800 "type": "number"
144800 },
154760 "k": {
164760 "format": "double",
174760 "type": "number"
184760 },
194720 "language": {
20472n/a "nullable": true,
214720 "type": "string"
224720 },
234680 "lowercase": {
24468n/a "nullable": true,
254680 "type": "boolean"
264680 },
274640 "max_token_len": {
2800 "format": "uint",
294600 "minimum": 0,
30464n/a "nullable": true,
314640 "type": "integer"
324640 },
334600 "min_token_len": {
3400 "format": "uint",
354560 "minimum": 0,
36460n/a "nullable": true,
374600 "type": "integer"
384600 },
39456n/a "stemmer": {
40456n/a "anyOf": [
4180376 {
4280376 "$ref": "#/components/schemas/StemmingAlgorithm"
4380376 },
44456n/a {
45456n/a "nullable": true
46456n/a }
47456n/a ],
48456n/a },
49452n/a "stopwords": {
50452n/a "anyOf": [
51268184 {
52268184 "$ref": "#/components/schemas/StopwordsInterface"
53268184 },
54452n/a {
55452n/a "nullable": true
56452n/a }
57452n/a ],
58452n/a },
594480 "tokenizer": {
604480 "$ref": "#/components/schemas/TokenizerType"
614480 }
625240 },
63562267 "type": "object"
64562267}
Condition10 of 10 keywords
1612820964{
2612820964 "anyOf": [
3350023592 {
4350023592 "$ref": "#/components/schemas/FieldCondition"
5350023592 },
62827064 {
72827064 "$ref": "#/components/schemas/IsEmptyCondition"
82827064 },
92827064 {
102827064 "$ref": "#/components/schemas/IsNullCondition"
112827064 },
1223626856 {
1323626856 "$ref": "#/components/schemas/HasIdCondition"
1423626856 },
152827064 {
162827064 "$ref": "#/components/schemas/HasVectorCondition"
172827064 },
188427008 {
198427008 "$ref": "#/components/schemas/SliceCondition"
208427008 },
21102826064 {
22102826064 "$ref": "#/components/schemas/NestedCondition"
23102826064 },
24119625896 {
25119625896 "$ref": "#/components/schemas/Filter"
26119625896 }
27612820964 ]
28612820964}
DatetimeRange11 of 15 keywords
15322604{
2504112 "properties": {
342028 "gt": {
41960 "format": "date-time",
5448n/a "nullable": true,
642028 "type": "string"
742028 },
842028 "gte": {
91960 "format": "date-time",
10448n/a "nullable": true,
1142028 "type": "string"
1242028 },
1336428 "lt": {
141680 "format": "date-time",
15392n/a "nullable": true,
1636428 "type": "string"
1736428 },
1830828 "lte": {
191400 "format": "date-time",
20336n/a "nullable": true,
2130828 "type": "string"
2230828 }
23504112 },
246442492 "type": "object"
255322604}
DisabledStemmerParams6 of 6 keywords
14452{
2476 "properties": {
3476 "type": {
4476 "$ref": "#/components/schemas/NoStemmer"
5476 }
6476 },
7804 "required": [
8804 "type"
9804 ],
1084372 "type": "object"
114452}
Document12 of 12 keywords
16001966{
282692 "properties": {
383472 "model": {
483412 "minLength": 1,
584660 "type": "string"
683472 },
7829n/a "options": {
8829n/a "anyOf": [
9562267 {
10562267 "$ref": "#/components/schemas/DocumentOptions"
11562267 },
12829n/a {
13829n/a "nullable": true
14829n/a }
15829n/a ],
16829n/a },
1762820 "text": {
1862820 "type": "string"
1962820 }
2082692 },
21644856 "required": [
22906594 "model",
23648852 "text"
24644856 ],
2515001066 "type": "object"
266001966}
DocumentOptions5 of 5 keywords
1562267{
2562267 "anyOf": [
3562267 {
41n/a "additionalProperties": true,
5562267 "type": "object"
6562267 },
7562267 {
8562267 "$ref": "#/components/schemas/Bm25Config"
9562267 }
10562267 ],
11562267}
ExtendedPointId6 of 7 keywords
197916{
297916 "anyOf": [
3243752 {
400 "format": "uint64",
52452 "minimum": 0,
6245750 "type": "integer"
7243752 },
8736259 {
97364 "format": "uuid",
10740255 "type": "string"
11736259 }
1297916 ],
1397916}
FieldCondition33 of 34 keywords
1350023592{
2350056 "properties": {
33276n/a "geo_bounding_box": {
43276n/a "anyOf": [
5283248 {
6283248 "$ref": "#/components/schemas/GeoBoundingBox"
7283248 },
83276n/a {
93276n/a "nullable": true
103276n/a }
113276n/a ],
123276n/a },
133276n/a "geo_polygon": {
143276n/a "anyOf": [
151683108 {
161683108 "$ref": "#/components/schemas/GeoPolygon"
171683108 },
183276n/a {
193276n/a "nullable": true
203276n/a }
213276n/a ],
223276n/a },
233248n/a "geo_radius": {
243248n/a "anyOf": [
25283220 {
26283220 "$ref": "#/components/schemas/GeoRadius"
27283220 },
283248n/a {
293248n/a "nullable": true
303248n/a }
313248n/a ],
323248n/a },
33322028 "is_empty": {
343248n/a "nullable": true,
35322028 "type": "boolean"
36322028 },
37319228 "is_null": {
383220n/a "nullable": true,
39319228 "type": "boolean"
40319228 },
4135000 "key": {
4235000 "type": "string"
4335000 },
443164n/a "match": {
453164n/a "anyOf": [
466722492 {
476722492 "$ref": "#/components/schemas/Match"
486722492 },
493164n/a {
503164n/a "nullable": true
513164n/a }
523164n/a ],
533164n/a },
543136n/a "range": {
553136n/a "anyOf": [
565322604 {
575322604 "$ref": "#/components/schemas/RangeInterface"
585322604 },
593136n/a {
603136n/a "nullable": true
613136n/a }
623136n/a ],
633136n/a },
643108n/a "values_count": {
653108n/a "anyOf": [
664482660 {
674482660 "$ref": "#/components/schemas/ValuesCount"
684482660 },
693108n/a {
703108n/a "nullable": true
713108n/a }
723108n/a ],
733108n/a }
74350056 },
7535002628 "required": [
7635002628 "key"
7735002628 ],
78612820964 "type": "object"
79350023592}
Filter25 of 25 keywords
1824828158{
2n/a4932 "additionalProperties": false,
38020n/a "properties": {
47840n/a "min_should": {
57840n/a "anyOf": [
69526888 {
79526888 "$ref": "#/components/schemas/MinShould"
89526888 },
97840n/a {
107840n/a "nullable": true
117840n/a }
127840n/a ],
137840n/a },
147840n/a "must": {
157840n/a "anyOf": [
169126928 {
179126928 "$ref": "#/components/schemas/Condition"
189126928 },
199086932 {
2090860 "items": {
21848120 "$ref": "#/components/schemas/Condition"
2290860 },
239686872 "type": "array"
249086932 },
257840n/a {
267840n/a "nullable": true
277840n/a }
287840n/a ],
297840n/a },
307780n/a "must_not": {
317780n/a "anyOf": [
329126868 {
339126868 "$ref": "#/components/schemas/Condition"
349126868 },
359086872 {
3690860 "items": {
37848120 "$ref": "#/components/schemas/Condition"
3890860 },
399686812 "type": "array"
409086872 },
417780n/a {
427780n/a "nullable": true
437780n/a }
447780n/a ],
457780n/a },
467720n/a "should": {
477720n/a "anyOf": [
489126808 {
499126808 "$ref": "#/components/schemas/Condition"
509126808 },
519086812 {
5290860 "items": {
53848120 "$ref": "#/components/schemas/Condition"
5490860 },
559686752 "type": "array"
569086812 },
577720n/a {
587720n/a "nullable": true
597720n/a }
607720n/a ],
617720n/a }
628020n/a },
631318023226 "type": "object"
64824828158}
GeoBoundingBox3 of 7 keywords
1283248{
2280 "properties": {
3280 "bottom_right": {
4280 "$ref": "#/components/schemas/GeoPoint"
5280 },
6280 "top_left": {
7280 "$ref": "#/components/schemas/GeoPoint"
8280 }
9280 },
102828 "required": [
112828 "bottom_right",
122828 "top_left"
132828 ],
14563220 "type": "object"
15283248}
GeoLineString0 of 7 keywords
12240{
22240 "properties": {
32240 "points": {
42240 "items": {
5560 "$ref": "#/components/schemas/GeoPoint"
62240 },
72240 "type": "array"
82240 }
92240 },
102240 "required": [
112240 "points"
122240 ],
132240 "type": "object"
142240}
GeoPoint0 of 9 keywords
11400{
21400 "properties": {
31400 "lat": {
41400 "format": "double",
51400 "type": "number"
61400 },
71400 "lon": {
81400 "format": "double",
91400 "type": "number"
101400 }
111400 },
121400 "required": [
131400 "lat",
141400 "lon"
151400 ],
161400 "type": "object"
171400}
GeoPolygon4 of 9 keywords
11683108{
21680 "properties": {
31680 "exterior": {
41680 "$ref": "#/components/schemas/GeoLineString"
51680 },
61400 "interiors": {
71120 "items": {
8560 "$ref": "#/components/schemas/GeoLineString"
91120 },
10140n/a "nullable": true,
111400 "type": "array"
121400 }
131680 },
1416828 "required": [
1516828 "exterior"
1616828 ],
171963080 "type": "object"
181683108}
GeoRadius3 of 8 keywords
1283220{
2280 "properties": {
3280 "center": {
4280 "$ref": "#/components/schemas/GeoPoint"
5280 },
6280 "radius": {
7280 "format": "double",
8280 "type": "number"
9280 }
10280 },
112828 "required": [
122828 "center",
132828 "radius"
142828 ],
15563192 "type": "object"
16283220}
HasIdCondition3 of 8 keywords
123626856{
22360 "properties": {
32360 "has_id": {
42360 "items": {
52080 "$ref": "#/components/schemas/ExtendedPointId"
62360 },
72360 "type": "array",
82360 "uniqueItems": true
92360 }
102360 },
112365892 "required": [
122365892 "has_id"
132365892 ],
14612820964 "type": "object"
1523626856}
HasVectorCondition3 of 6 keywords
12827064{
2280 "properties": {
3280 "has_vector": {
4280 "type": "string"
5280 }
6280 },
7286100 "required": [
8286100 "has_vector"
9286100 ],
10612820964 "type": "object"
112827064}
Image10 of 10 keywords
1932473{
2794124 "properties": {
3137n/a "image": {
4137n/a },
583472 "model": {
683412 "minLength": 1,
784660 "type": "string"
883472 },
977752 "options": {
101n/a "additionalProperties": true,
11829n/a "nullable": true,
1277752 "type": "object"
1377752 }
14794124 },
151331367 "required": [
161371363 "image",
17906594 "model"
181331367 ],
1915001066 "type": "object"
20932473}
InferenceObject10 of 10 keywords
1812485{
2794124 "properties": {
383472 "model": {
483412 "minLength": 1,
584660 "type": "string"
683472 },
7125n/a "object": {
8125n/a },
977752 "options": {
101n/a "additionalProperties": true,
11829n/a "nullable": true,
1277752 "type": "object"
1377752 }
14794124 },
151211379 "required": [
16906594 "model",
171251375 "object"
181211379 ],
1915001066 "type": "object"
20812485}
IsEmptyCondition6 of 6 keywords
12827064{
2283220 "properties": {
3283220 "is_empty": {
4283220 "$ref": "#/components/schemas/PayloadField"
5283220 }
6283220 },
732482880 "required": [
832482880 "is_empty"
932482880 ],
10612820964 "type": "object"
112827064}
IsNullCondition6 of 6 keywords
12827064{
2283192 "properties": {
3283192 "is_null": {
4283192 "$ref": "#/components/schemas/PayloadField"
5283192 }
6283192 },
732202908 "required": [
832202908 "is_null"
932202908 ],
10612820964 "type": "object"
112827064}
Language3 of 3 keywords
1240332{
2240332 "enum": [
38n/a "arabic",
48n/a "azerbaijani",
58n/a "basque",
68n/a "bengali",
78n/a "catalan",
88n/a "chinese",
98n/a "danish",
108n/a "dutch",
118n/a "english",
128n/a "finnish",
138n/a "french",
148n/a "german",
158n/a "greek",
168n/a "hebrew",
178n/a "hinglish",
188n/a "hungarian",
198n/a "indonesian",
208n/a "italian",
218n/a "japanese",
228n/a "kazakh",
238n/a "nepali",
248n/a "norwegian",
258n/a "portuguese",
268n/a "romanian",
278n/a "russian",
288n/a "slovene",
298n/a "spanish",
308n/a "swedish",
318n/a "tajik",
328n/a "turkish"
33240332 ],
34244328 "type": "string"
35240332}
Match10 of 10 keywords
16722492{
26722492 "anyOf": [
31962968 {
41962968 "$ref": "#/components/schemas/MatchValue"
51962968 },
6283136 {
7283136 "$ref": "#/components/schemas/MatchText"
8283136 },
9283136 {
10283136 "$ref": "#/components/schemas/MatchTextAny"
11283136 },
12283136 {
13283136 "$ref": "#/components/schemas/MatchPhrase"
14283136 },
15283136 {
16283136 "$ref": "#/components/schemas/MatchPrefix"
17283136 },
18283136 {
19283136 "$ref": "#/components/schemas/MatchSubstring"
20283136 },
211682996 {
221682996 "$ref": "#/components/schemas/MatchAny"
231682996 },
241682996 {
251682996 "$ref": "#/components/schemas/MatchExcept"
261682996 }
276722492 ],
286722492}
MatchAny3 of 6 keywords
11682996{
21680 "properties": {
31680 "any": {
41680 "$ref": "#/components/schemas/AnyVariants"
51680 }
61680 },
7168532 "required": [
8168532 "any"
9168532 ],
107002464 "type": "object"
111682996}
MatchExcept3 of 6 keywords
11682996{
21680 "properties": {
31680 "except": {
41680 "$ref": "#/components/schemas/AnyVariants"
51680 }
61680 },
7168532 "required": [
8168532 "except"
9168532 ],
107002464 "type": "object"
111682996}
MatchPhrase3 of 6 keywords
1283136{
2280 "properties": {
3280 "phrase": {
4280 "type": "string"
5280 }
6280 },
728672 "required": [
828672 "phrase"
928672 ],
107002464 "type": "object"
11283136}
MatchPrefix3 of 6 keywords
1283136{
2280 "properties": {
3280 "prefix": {
4280 "type": "string"
5280 }
6280 },
728672 "required": [
828672 "prefix"
928672 ],
107002464 "type": "object"
11283136}
MatchSubstring3 of 6 keywords
1283136{
2280 "properties": {
3280 "substring": {
4280 "type": "string"
5280 }
6280 },
728672 "required": [
828672 "substring"
928672 ],
107002464 "type": "object"
11283136}
MatchText3 of 6 keywords
1283136{
2280 "properties": {
3280 "text": {
4280 "type": "string"
5280 }
6280 },
728672 "required": [
828672 "text"
928672 ],
107002464 "type": "object"
11283136}
MatchTextAny3 of 6 keywords
1283136{
2280 "properties": {
3280 "text_any": {
4280 "type": "string"
5280 }
6280 },
728672 "required": [
828672 "text_any"
928672 ],
107002464 "type": "object"
11283136}
MatchValue3 of 6 keywords
11962968{
21960 "properties": {
31960 "value": {
41960 "$ref": "#/components/schemas/ValueVariants"
51960 }
61960 },
7196504 "required": [
8196504 "value"
9196504 ],
107002464 "type": "object"
111962968}
MinShould3 of 10 keywords
19526888{
29520 "properties": {
39520 "conditions": {
49520 "items": {
58480 "$ref": "#/components/schemas/Condition"
69520 },
79520 "type": "array"
89520 },
99520 "min_count": {
1000 "format": "uint",
119520 "minimum": 1,
129520 "type": "integer"
139520 }
149520 },
1595260 "required": [
1695260 "conditions",
1795260 "min_count"
1895260 ],
1910126828 "type": "object"
209526888}
Nested0 of 7 keywords
110280{
210280 "properties": {
310280 "filter": {
410280 "$ref": "#/components/schemas/Filter"
510280 },
610280 "key": {
710280 "type": "string"
810280 }
910280 },
1010280 "required": [
1110280 "filter",
1210280 "key"
1310280 ],
1410280 "type": "object"
1510280}
NestedCondition3 of 6 keywords
1102826064{
210280 "properties": {
310280 "nested": {
410280 "$ref": "#/components/schemas/Nested"
510280 }
610280 },
710285100 "required": [
810285100 "nested"
910285100 ],
10612820964 "type": "object"
11102826064}
NoStemmer2 of 3 keywords
1476{
2476 "enum": [
34n/a "none"
4476 ],
5800 "type": "string"
6476}
Payload2 of 2 keywords
122501{
21n/a "additionalProperties": true,
322501 "type": "object"
422501}
PayloadField1 of 6 keywords
1566412{
2560 "properties": {
3560 "key": {
4560 "type": "string"
5560 }
6560 },
7560 "required": [
8560 "key"
9560 ],
10566412 "type": "object"
11566412}
PointStruct11 of 11 keywords
1534142{
2536135 "properties": {
36628 "id": {
46628 "$ref": "#/components/schemas/ExtendedPointId"
56628 },
6491n/a "payload": {
7491n/a "anyOf": [
88483 {
98483 "$ref": "#/components/schemas/Payload"
108483 },
11491n/a {
12491n/a "nullable": true
13491n/a }
14491n/a ],
15491n/a },
16543127 "vector": {
17543127 "$ref": "#/components/schemas/VectorStruct"
18543127 }
19536135 },
206692 "required": [
216701 "id",
226701 "vector"
236692 ],
246715 "type": "object"
25534142}
PointsBatch18 of 18 keywords
120082335{
24053165 "properties": {
32008165 "batch": {
42008165 "$ref": "#/components/schemas/Batch"
52008165 },
64143n/a "shard_key": {
74143n/a "anyOf": [
8504093 {
9504093 "$ref": "#/components/schemas/ShardKeySelector"
10504093 },
114143n/a {
124143n/a "nullable": true
134143n/a }
144143n/a ]
154143n/a },
164143n/a "update_filter": {
174143n/a "anyOf": [
1830121131 {
1930121131 "$ref": "#/components/schemas/Filter"
2030121131 },
214143n/a {
224143n/a "nullable": true
234143n/a }
244143n/a ],
254143n/a },
264141n/a "update_mode": {
274141n/a "anyOf": [
2864135 {
2964135 "$ref": "#/components/schemas/UpdateMode"
3064135 },
314141n/a {
324141n/a "nullable": true
334141n/a }
344141n/a ],
354141n/a }
364053165 },
3721732161 "required": [
3821732161 "batch"
3921732161 ],
4043349 "type": "object"
4120082335}
PointsList19 of 19 keywords
120132330{
24116147 "properties": {
32013147 "points": {
42013142 "items": {
5534142 "$ref": "#/components/schemas/PointStruct"
62013142 },
721555 "type": "array"
82013147 },
94143n/a "shard_key": {
104143n/a "anyOf": [
11504093 {
12504093 "$ref": "#/components/schemas/ShardKeySelector"
13504093 },
144143n/a {
154143n/a "nullable": true
164143n/a }
174143n/a ]
184143n/a },
194143n/a "update_filter": {
204143n/a "anyOf": [
2130121131 {
2230121131 "$ref": "#/components/schemas/Filter"
2330121131 },
244143n/a {
254143n/a "nullable": true
264143n/a }
274143n/a ],
284143n/a },
294141n/a "update_mode": {
304141n/a "anyOf": [
3164135 {
3264135 "$ref": "#/components/schemas/UpdateMode"
3364135 },
344141n/a {
354141n/a "nullable": true
364141n/a }
374141n/a ],
384141n/a }
394116147 },
4021602174 "required": [
4121602174 "points"
4221602174 ],
4343349 "type": "object"
4420132330}
Range13 of 15 keywords
1283108{
20616 "properties": {
328420 "gt": {
428420 "format": "double",
5448n/a "nullable": true,
6252196 "type": "number"
728420 },
828420 "gte": {
928420 "format": "double",
10448n/a "nullable": true,
11252196 "type": "number"
1228420 },
1328364 "lt": {
1428364 "format": "double",
15392n/a "nullable": true,
16224168 "type": "number"
1728364 },
1828308 "lte": {
1928308 "format": "double",
20336n/a "nullable": true,
21196140 "type": "number"
2228308 }
230616 },
246442492 "type": "object"
25283108}
RangeInterface4 of 4 keywords
15322604{
25322604 "anyOf": [
3283108 {
4283108 "$ref": "#/components/schemas/Range"
5283108 },
65322604 {
75322604 "$ref": "#/components/schemas/DatetimeRange"
85322604 }
95322604 ]
105322604}
ShardKey4 of 6 keywords
11408266{
21408266 "anyOf": [
3768330 {
4768330 "type": "string"
5768330 },
6648342 {
700 "format": "uint64",
8640 "minimum": 0,
9648342 "type": "integer"
10648342 }
111408266 ]
121408266}
ShardKeySelector6 of 6 keywords
11008186{
21008186 "anyOf": [
3288258 {
4288258 "$ref": "#/components/schemas/ShardKey"
5288258 },
6288258 {
7284 "items": {
8248 "$ref": "#/components/schemas/ShardKey"
9284 },
10328254 "type": "array"
11288258 },
12448242 {
13448242 "$ref": "#/components/schemas/ShardKeyWithFallback"
14448242 }
151008186 ]
161008186}
ShardKeyWithFallback3 of 7 keywords
1448242{
2440 "properties": {
3440 "fallback": {
4440 "$ref": "#/components/schemas/ShardKey"
5440 },
6440 "target": {
7440 "$ref": "#/components/schemas/ShardKey"
8440 }
9440 },
10444 "required": [
11444 "fallback",
12444 "target"
13444 ],
14488238 "type": "object"
15448242}
Slice0 of 11 keywords
1840{
2840 "properties": {
3840 "index": {
400 "format": "uint32",
5840 "minimum": 0,
6840 "type": "integer"
7840 },
8840 "total": {
900 "format": "uint32",
10840 "minimum": 1,
11840 "type": "integer"
12840 }
13840 },
14840 "required": [
15840 "index",
16840 "total"
17840 ],
18840 "type": "object"
19840}
SliceCondition3 of 6 keywords
18427008{
2840 "properties": {
3840 "slice": {
4840 "$ref": "#/components/schemas/Slice"
5840 }
6840 },
7846044 "required": [
8846044 "slice"
9846044 ],
10612820964 "type": "object"
118427008}
Snowball2 of 3 keywords
1764{
2764 "enum": [
376n/a "snowball"
4764 ],
5800 "type": "string"
6764}
SnowballLanguage0 of 3 keywords
1760{
2760 "enum": [
34n/a "arabic",
44n/a "armenian",
54n/a "danish",
64n/a "dutch",
74n/a "english",
84n/a "finnish",
94n/a "french",
104n/a "german",
114n/a "greek",
124n/a "hungarian",
134n/a "italian",
144n/a "norwegian",
154n/a "portuguese",
164n/a "romanian",
174n/a "russian",
184n/a "spanish",
194n/a "swedish",
204n/a "tamil",
214n/a "turkish"
22760 ],
23760 "type": "string"
24760}
SnowballParams6 of 7 keywords
176380{
2764 "properties": {
3760 "language": {
4760 "$ref": "#/components/schemas/SnowballLanguage"
5760 },
6764 "type": {
7764 "$ref": "#/components/schemas/Snowball"
8764 }
9764 },
10768 "required": [
11768 "language",
12804 "type"
13768 ],
1484372 "type": "object"
1576380}
SparseVector11 of 12 keywords
1141502{
21844 "properties": {
33624 "indices": {
43614 "items": {
500 "format": "uint32",
6402 "minimum": 0,
74012 "type": "integer"
83614 },
95010 "type": "array"
103624 },
114020 "values": {
124010 "items": {
131710 "format": "float",
141710 "type": "number"
154010 },
165010 "type": "array"
174020 }
181844 },
1958600 "required": [
2060598 "indices",
2160598 "values"
2258600 ],
23658858 "type": "object"
24141502}
StemmingAlgorithm4 of 4 keywords
180376{
280376 "anyOf": [
376380 {
476380 "$ref": "#/components/schemas/SnowballParams"
576380 },
64452 {
74452 "$ref": "#/components/schemas/DisabledStemmerParams"
84452 }
980376 ],
1080376}
StopwordsInterface4 of 4 keywords
1268184{
2268184 "anyOf": [
3120332 {
4120332 "$ref": "#/components/schemas/Language"
5120332 },
6148304 {
7148304 "$ref": "#/components/schemas/StopwordsSet"
8148304 }
9268184 ]
10268184}
StopwordsSet3 of 11 keywords
1148304{
21440 "properties": {
31400 "custom": {
41360 "items": {
540 "type": "string"
61360 },
7140n/a "nullable": true,
81400 "type": "array",
91360 "uniqueItems": true
101400 },
111400 "languages": {
121360 "items": {
131200 "$ref": "#/components/schemas/Language"
141360 },
15140n/a "nullable": true,
161400 "type": "array",
171360 "uniqueItems": true
181400 }
191440 },
20148304 "type": "object"
21148304}
TokenizerType0 of 3 keywords
14480{
24480 "enum": [
3436n/a "prefix",
44n/a "whitespace",
54n/a "word",
64n/a "multilingual"
74480 ],
84480 "type": "string"
94480}
UpdateMode3 of 3 keywords
1128270{
2128270 "enum": [
34n/a "upsert",
44n/a "insert_only",
54n/a "update_only"
6128270 ],
7168266 "type": "string"
8128270}
ValueVariants4 of 6 keywords
11960{
21960 "anyOf": [
328168 {
428168 "type": "string"
528168 },
611284 {
711284 "format": "int64",
811284 "type": "integer"
911284 },
1056140 {
1156140 "type": "boolean"
1256140 }
131960 ]
141960}
ValuesCount5 of 19 keywords
14482660{
24200 "properties": {
33360 "gt": {
400 "format": "uint",
53080 "minimum": 0,
6336n/a "nullable": true,
73360 "type": "integer"
83360 },
93360 "gte": {
1000 "format": "uint",
113080 "minimum": 0,
12336n/a "nullable": true,
133360 "type": "integer"
143360 },
153080 "lt": {
1600 "format": "uint",
172800 "minimum": 0,
18308n/a "nullable": true,
193080 "type": "integer"
203080 },
212800 "lte": {
2200 "format": "uint",
232520 "minimum": 0,
24280n/a "nullable": true,
252800 "type": "integer"
262800 }
274200 },
284482660 "type": "object"
294482660}
Vector13 of 13 keywords
1659857{
2659857 "anyOf": [
32821234 {
428269 "items": {
5775130 "format": "float",
6775130 "type": "number"
728269 },
83511165 "type": "array"
92821234 },
10141502 {
11141502 "$ref": "#/components/schemas/SparseVector"
12141502 },
13421474 {
1442309 "items": {
156015 "items": {
1621218 "format": "float",
1721218 "type": "number"
186015 },
1975830 "type": "array"
2042309 },
213511165 "type": "array"
22421474 },
232961220 {
242961220 "$ref": "#/components/schemas/Document"
252961220 },
26231493 {
27231493 "$ref": "#/components/schemas/Image"
28231493 },
29271489 {
30271489 "$ref": "#/components/schemas/InferenceObject"
31271489 }
32659857 ],
33659857}
VectorStruct14 of 14 keywords
1543127{
2543127 "anyOf": [
355615 {
45536 "items": {
5143141 "format": "float",
6143141 "type": "number"
75536 },
891579 "type": "array"
955615 },
1049621 {
114942 "items": {
121296 "items": {
136257 "format": "float",
146257 "type": "number"
151296 },
16135149 "type": "array"
174942 },
1891579 "type": "array"
1949621 },
20265405 {
21181310 "additionalProperties": {
22471781 "$ref": "#/components/schemas/Vector"
23181310 },
2457595 "type": "object"
25265405 },
26149521 {
27149521 "$ref": "#/components/schemas/Document"
28149521 },
2918652 {
3018652 "$ref": "#/components/schemas/Image"
3118652 },
3231639 {
3331639 "$ref": "#/components/schemas/InferenceObject"
3431639 }
35543127 ],
36543127}
Responses3 of 3 documented received
codedescriptionhitsavg
200successful operation830ms
4XXerror39690ms
defaulterror3240ms
Examples16 / 16 used
Body: application/json
42ExtendedPointId
"550e8400-e29b-41d4-a716-446655440000"ExtendedPointId
{ "city": "London", "color": "green" }Payload
"jinaai/jina-embeddings-v2-base-en"Document.model
256Bm25Config.avg_len
0.75Bm25Config.b
1.2Bm25Config.k
"This is a document text"Document.text
"https://example.com/image.jpg"Image.image
"Qdrant/clip-ViT-B-32-vision"Image.model
"jinaai/jina-embeddings-v2-base-en"InferenceObject.model
"region_1"ShardKey
12ShardKey
[ 0.875, 0.140625, 0.897599995136261 ]VectorStruct
[ [ 0.875, 0.140625, 0.11020000278949738 ], [ 0.7580000162124634, 0.28126001358032227, 0.9687100052833557 ], [ 0.6209999918937683, 0.42187801003456116, 0.9375 ] ]VectorStruct
{ "image-embeddings": [ 0.8730000257492065, 0.140625, 0.897599995136261 ] }VectorStruct
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
115900n/a{
215900n/a "type": "string"
315900n/a}
Query Parameters5 of 5 keywords covered
wait1 / 1
11562820{
21562820 "type": "boolean"
31562820}
ordering2 / 2
WriteOrdering
11564621{
21564621 "enum": [
315610n/a "weak",
419n/a "medium",
517n/a "strong"
61564621 ],
715667n/a "type": "string"
81564621}
timeout2 / 2
11563027{
2156308 "minimum": 1,
31563819 "type": "integer"
41563027}
Body452 of 587 keywords covered
application/json452 / 587
UpdateOperations
115229652{
215229644 "properties": {
315229644 "operations": {
415229639 "items": {
515596639 "$ref": "#/components/schemas/UpdateOperation"
615229639 },
7158685 "type": "array"
815229644 }
915229644 },
10158733 "required": [
11158733 "operations"
12158733 ],
13158765 "type": "object"
1415229652}
Referenced Components (80)572 of 742 keywords
AnyVariants3 of 9 keywords
19240{
29240 "anyOf": [
3308616 {
4308616 "items": {
5154616 "type": "string"
6308616 },
79240 "type": "array",
89240 "uniqueItems": true
9308616 },
10770154 {
11770154 "items": {
12616154 "format": "int64",
13616154 "type": "integer"
14770154 },
159240 "type": "array",
169240 "uniqueItems": true
17770154 }
189240 ]
199240}
Batch14 of 14 keywords
12018162{
22020155 "properties": {
3216113 "ids": {
421618 "items": {
51108 "$ref": "#/components/schemas/ExtendedPointId"
621618 },
721695 "type": "array"
8216113 },
920684 "payloads": {
1020n/a "items": {
1123n/a "anyOf": [
121013 {
131013 "$ref": "#/components/schemas/Payload"
141013 },
1523n/a {
1623n/a "nullable": true
1723n/a }
1823n/a ]
1920n/a },
202072n/a "nullable": true,
2120684 "type": "array"
2220684 },
232036138 "vectors": {
242036138 "$ref": "#/components/schemas/BatchVectorStruct"
252036138 }
262020155 },
2721732 "required": [
2821741 "ids",
2921741 "vectors"
3021732 ],
3121755 "type": "object"
322018162}
BatchVectorStruct20 of 20 keywords
12036138{
22036138 "anyOf": [
31669505 {
41669228 "items": {
54139 "items": {
647169 "format": "float",
747169 "type": "number"
84139 },
980215 "type": "array"
101669228 },
111897277 "type": "array"
121669505 },
131670504 {
141670227 "items": {
155822 "items": {
161576 "items": {
176357 "format": "float",
186357 "type": "number"
191576 },
2016353 "type": "array"
215822 },
2280215 "type": "array"
231670227 },
241897277 "type": "array"
251670504 },
261921982 {
2718181 "additionalProperties": {
2820376 "items": {
2929176 "$ref": "#/components/schemas/Vector"
3020376 },
312795 "type": "array"
3218181 },
332731901 "type": "object"
341921982 },
351793381 {
361793104 "items": {
37144151 "$ref": "#/components/schemas/Document"
381793104 },
391897277 "type": "array"
401793381 },
411660514 {
421660237 "items": {
4311284 "$ref": "#/components/schemas/Image"
441660237 },
451897277 "type": "array"
461660514 },
471664510 {
481664233 "items": {
4917278 "$ref": "#/components/schemas/InferenceObject"
501664233 },
511897277 "type": "array"
521664510 }
532036138 ]
542036138}
Bm25Config14 of 32 keywords
1887423{
27860 "properties": {
37260 "ascii_folding": {
4726n/a "nullable": true,
57260 "type": "boolean"
67260 },
77260 "avg_len": {
87260 "format": "double",
97260 "type": "number"
107260 },
117200 "b": {
127200 "format": "double",
137200 "type": "number"
147200 },
157140 "k": {
167140 "format": "double",
177140 "type": "number"
187140 },
197080 "language": {
20708n/a "nullable": true,
217080 "type": "string"
227080 },
237020 "lowercase": {
24702n/a "nullable": true,
257020 "type": "boolean"
267020 },
276960 "max_token_len": {
2800 "format": "uint",
296900 "minimum": 0,
30696n/a "nullable": true,
316960 "type": "integer"
326960 },
336900 "min_token_len": {
3400 "format": "uint",
356840 "minimum": 0,
36690n/a "nullable": true,
376900 "type": "integer"
386900 },
39684n/a "stemmer": {
40684n/a "anyOf": [
41120564 {
42120564 "$ref": "#/components/schemas/StemmingAlgorithm"
43120564 },
44684n/a {
45684n/a "nullable": true
46684n/a }
47684n/a ],
48684n/a },
49678n/a "stopwords": {
50678n/a "anyOf": [
51402276 {
52402276 "$ref": "#/components/schemas/StopwordsInterface"
53402276 },
54678n/a {
55678n/a "nullable": true
56678n/a }
57678n/a ],
58678n/a },
596720 "tokenizer": {
606720 "$ref": "#/components/schemas/TokenizerType"
616720 }
627860 },
63887423 "type": "object"
64887423}
ClearPayloadOperation6 of 6 keywords
1162114614{
2162124 "properties": {
3162124 "clear_payload": {
4162124 "$ref": "#/components/schemas/PointsSelector"
5162124 }
6162124 },
7164514585 "required": [
8164514585 "clear_payload"
9164514585 ],
10162305 "type": "object"
11162114614}
Condition10 of 10 keywords
11686057823{
21686057823 "anyOf": [
3962565058 {
4962565058 "$ref": "#/components/schemas/FieldCondition"
5962565058 },
67774606 {
77774606 "$ref": "#/components/schemas/IsEmptyCondition"
87774606 },
97774606 {
107774606 "$ref": "#/components/schemas/IsNullCondition"
117774606 },
1264974034 {
1364974034 "$ref": "#/components/schemas/HasIdCondition"
1464974034 },
157774606 {
167774606 "$ref": "#/components/schemas/HasVectorCondition"
177774606 },
1823174452 {
1923174452 "$ref": "#/components/schemas/SliceCondition"
2023174452 },
21282771856 {
22282771856 "$ref": "#/components/schemas/NestedCondition"
23282771856 },
24329771386 {
25329771386 "$ref": "#/components/schemas/Filter"
26329771386 }
271686057823 ]
281686057823}
DatetimeRange11 of 15 keywords
114637161{
21386308 "properties": {
3115577 "gt": {
45390 "format": "date-time",
51232n/a "nullable": true,
6115577 "type": "string"
7115577 },
8115577 "gte": {
95390 "format": "date-time",
101232n/a "nullable": true,
11115577 "type": "string"
12115577 },
13100177 "lt": {
144620 "format": "date-time",
151078n/a "nullable": true,
16100177 "type": "string"
17100177 },
1884777 "lte": {
193850 "format": "date-time",
20924n/a "nullable": true,
2184777 "type": "string"
2284777 }
231386308 },
2417716853 "type": "object"
2514637161}
DeleteOperation6 of 6 keywords
1165314582{
2165324 "properties": {
3165324 "delete": {
4165324 "$ref": "#/components/schemas/PointsSelector"
5165324 }
6165324 },
7167714553 "required": [
8167714553 "delete"
9167714553 ],
10162305 "type": "object"
11165314582}
DeletePayload18 of 18 keywords
1162829{
2162923 "properties": {
31567n/a "filter": {
41567n/a "anyOf": [
5150661 {
6150661 "$ref": "#/components/schemas/Filter"
7150661 },
81567n/a {
91567n/a "nullable": true
101567n/a }
111567n/a ],
121567n/a },
13164110 "keys": {
1416415 "items": {
154125 "type": "string"
1616415 },
1716465 "type": "array"
18164110 },
19159713 "points": {
2015709 "items": {
213910 "$ref": "#/components/schemas/ExtendedPointId"
2215709 },
231610n/a "nullable": true,
2416064 "type": "array"
25159713 },
261566n/a "shard_key": {
271566n/a "anyOf": [
28251541 {
29251541 "$ref": "#/components/schemas/ShardKeySelector"
30251541 },
311566n/a {
321566n/a "nullable": true
331566n/a }
341566n/a ]
351566n/a }
36162923 },
3716511 "required": [
3816511 "keys"
3916511 ],
4016525 "type": "object"
41162829}
DeletePayloadOperation6 of 6 keywords
1162814607{
2162829 "properties": {
3162829 "delete_payload": {
4162829 "$ref": "#/components/schemas/DeletePayload"
5162829 }
6162829 },
7165714573 "required": [
8165714573 "delete_payload"
9165714573 ],
10162305 "type": "object"
11162814607}
DeleteVectors20 of 20 keywords
1157831{
2157925 "properties": {
31569n/a "filter": {
41569n/a "anyOf": [
5150663 {
6150663 "$ref": "#/components/schemas/Filter"
7150663 },
81569n/a {
91569n/a "nullable": true
101569n/a }
111569n/a ],
121569n/a },
13157013 "points": {
1415589 "items": {
153510 "$ref": "#/components/schemas/ExtendedPointId"
1615589 },
171583n/a "nullable": true,
1815794 "type": "array"
19157013 },
201568n/a "shard_key": {
211568n/a "anyOf": [
22251543 {
23251543 "$ref": "#/components/schemas/ShardKeySelector"
24251543 },
251568n/a {
261568n/a "nullable": true
271568n/a }
281568n/a ]
291568n/a },
30159112 "vector": {
3115935 "items": {
3217095 "type": "string"
3315935 },
3415971 "minItems": 1,
3515985 "type": "array",
3615971 "uniqueItems": true
37159112 }
38157925 },
3916031 "required": [
4016031 "vector"
4116031 ],
4216045 "type": "object"
43157831}
DeleteVectorsOperation6 of 6 keywords
1157814657{
2157831 "properties": {
3157831 "delete_vectors": {
4157831 "$ref": "#/components/schemas/DeleteVectors"
5157831 }
6157831 },
7160914621 "required": [
8160914621 "delete_vectors"
9160914621 ],
10162305 "type": "object"
11157814657}
DisabledStemmerParams6 of 6 keywords
16678{
26114 "properties": {
36114 "type": {
46114 "$ref": "#/components/schemas/NoStemmer"
56114 }
66114 },
71206 "required": [
81206 "type"
91206 ],
10126558 "type": "object"
116678}
Document12 of 12 keywords
19526381{
21435138 "properties": {
31447108 "model": {
4144718 "minLength": 1,
5146590 "type": "string"
61447108 },
71310n/a "options": {
81310n/a "anyOf": [
9887423 {
10887423 "$ref": "#/components/schemas/DocumentOptions"
11887423 },
121310n/a {
131310n/a "nullable": true
141310n/a }
151310n/a ],
161310n/a },
1799430 "text": {
1899430 "type": "string"
1999430 }
201435138 },
2110181908 "required": [
2215551371 "model",
2310241902 "text"
2410181908 ],
2529264407 "type": "object"
269526381}
DocumentOptions5 of 5 keywords
1887423{
2887423 "anyOf": [
3887423 {
41n/a "additionalProperties": true,
5887423 "type": "object"
6887423 },
7887423 {
8887423 "$ref": "#/components/schemas/Bm25Config"
9887423 }
10887423 ],
11887423}
ExtendedPointId6 of 7 keywords
1454880{
2454880 "anyOf": [
310643564 {
400 "format": "uint64",
510739 "minimum": 0,
610733555 "type": "integer"
710643564 },
834841144 {
9348418 "format": "uuid",
1035021126 "type": "string"
1134841144 }
12454880 ],
13454880}
FieldCondition33 of 34 keywords
1962565058{
29625154 "properties": {
39009n/a "geo_bounding_box": {
49009n/a "anyOf": [
5778932 {
6778932 "$ref": "#/components/schemas/GeoBoundingBox"
7778932 },
89009n/a {
99009n/a "nullable": true
109009n/a }
119009n/a ],
129009n/a },
139009n/a "geo_polygon": {
149009n/a "anyOf": [
154628547 {
164628547 "$ref": "#/components/schemas/GeoPolygon"
174628547 },
189009n/a {
199009n/a "nullable": true
209009n/a }
219009n/a ],
229009n/a },
238932n/a "geo_radius": {
248932n/a "anyOf": [
25778855 {
26778855 "$ref": "#/components/schemas/GeoRadius"
27778855 },
288932n/a {
298932n/a "nullable": true
308932n/a }
318932n/a ],
328932n/a },
33885577 "is_empty": {
348932n/a "nullable": true,
35885577 "type": "boolean"
36885577 },
37877877 "is_null": {
388855n/a "nullable": true,
39877877 "type": "boolean"
40877877 },
4196250 "key": {
4296250 "type": "string"
4396250 },
448701n/a "match": {
458701n/a "anyOf": [
4618486853 {
4718486853 "$ref": "#/components/schemas/Match"
4818486853 },
498701n/a {
508701n/a "nullable": true
518701n/a }
528701n/a ],
538701n/a },
548624n/a "range": {
558624n/a "anyOf": [
5614637161 {
5714637161 "$ref": "#/components/schemas/RangeInterface"
5814637161 },
598624n/a {
608624n/a "nullable": true
618624n/a }
628624n/a ],
638624n/a },
648547n/a "values_count": {
658547n/a "anyOf": [
6612327315 {
6712327315 "$ref": "#/components/schemas/ValuesCount"
6812327315 },
698547n/a {
708547n/a "nullable": true
718547n/a }
728547n/a ],
738547n/a }
749625154 },
7596257242 "required": [
7696257242 "key"
7796257242 ],
781686757816 "type": "object"
79962565058}
Filter25 of 25 keywords
12277574340{
2n/a13570 "additionalProperties": false,
322116n/a "properties": {
421618n/a "min_should": {
521618n/a "anyOf": [
6261819000 {
7261819000 "$ref": "#/components/schemas/MinShould"
8261819000 },
921618n/a {
1021618n/a "nullable": true
1121618n/a }
1221618n/a ],
1321618n/a },
1421620n/a "must": {
1521620n/a "anyOf": [
16251019110 {
17251019110 "$ref": "#/components/schemas/Condition"
18251019110 },
19249819122 {
202498168 "items": {
212332337 "$ref": "#/components/schemas/Condition"
222498168 },
23266618954 "type": "array"
24249819122 },
2521620n/a {
2621620n/a "nullable": true
2721620n/a }
2821620n/a ],
2921620n/a },
3021451n/a "must_not": {
3121451n/a "anyOf": [
32251118940 {
33251118940 "$ref": "#/components/schemas/Condition"
34251118940 },
35249818953 {
362498166 "items": {
372333331 "$ref": "#/components/schemas/Condition"
382498166 },
39266418787 "type": "array"
40249818953 },
4121451n/a {
4221451n/a "nullable": true
4321451n/a }
4421451n/a ],
4521451n/a },
4621285n/a "should": {
4721285n/a "anyOf": [
48251018775 {
49251018775 "$ref": "#/components/schemas/Condition"
50251018775 },
51249718788 {
522497165 "items": {
532332330 "$ref": "#/components/schemas/Condition"
542497165 },
55266218623 "type": "array"
56249718788 },
5721285n/a {
5821285n/a "nullable": true
5921285n/a }
6021285n/a ],
6121285n/a }
6222116n/a },
633634560770 "type": "object"
642277574340}
FilterSelector10 of 10 keywords
13097225{
2319310 "properties": {
3309710 "filter": {
4309710 "$ref": "#/components/schemas/Filter"
5309710 },
63164n/a "shard_key": {
73164n/a "anyOf": [
81003064 {
91003064 "$ref": "#/components/schemas/ShardKeySelector"
101003064 },
113164n/a {
123164n/a "nullable": true
133164n/a }
143164n/a ]
153164n/a }
16319310 },
173107205 "required": [
183107205 "filter"
193107205 ],
20331210 "type": "object"
213097225}
GeoBoundingBox3 of 7 keywords
1778932{
2770 "properties": {
3770 "bottom_right": {
4770 "$ref": "#/components/schemas/GeoPoint"
5770 },
6770 "top_left": {
7770 "$ref": "#/components/schemas/GeoPoint"
8770 }
9770 },
107777 "required": [
117777 "bottom_right",
127777 "top_left"
137777 ],
141548855 "type": "object"
15778932}
GeoLineString0 of 7 keywords
16160{
26160 "properties": {
36160 "points": {
46160 "items": {
51540 "$ref": "#/components/schemas/GeoPoint"
66160 },
76160 "type": "array"
86160 }
96160 },
106160 "required": [
116160 "points"
126160 ],
136160 "type": "object"
146160}
GeoPoint0 of 9 keywords
13850{
23850 "properties": {
33850 "lat": {
43850 "format": "double",
53850 "type": "number"
63850 },
73850 "lon": {
83850 "format": "double",
93850 "type": "number"
103850 }
113850 },
123850 "required": [
133850 "lat",
143850 "lon"
153850 ],
163850 "type": "object"
173850}
GeoPolygon4 of 9 keywords
14628547{
24620 "properties": {
34620 "exterior": {
44620 "$ref": "#/components/schemas/GeoLineString"
54620 },
63850 "interiors": {
73080 "items": {
81540 "$ref": "#/components/schemas/GeoLineString"
93080 },
10385n/a "nullable": true,
113850 "type": "array"
123850 }
134620 },
1446277 "required": [
1546277 "exterior"
1646277 ],
175398470 "type": "object"
184628547}
GeoRadius3 of 8 keywords
1778855{
2770 "properties": {
3770 "center": {
4770 "$ref": "#/components/schemas/GeoPoint"
5770 },
6770 "radius": {
7770 "format": "double",
8770 "type": "number"
9770 }
10770 },
117777 "required": [
127777 "center",
137777 "radius"
147777 ],
151548778 "type": "object"
16778855}
HasIdCondition3 of 8 keywords
164974034{
26490 "properties": {
36490 "has_id": {
46490 "items": {
55720 "$ref": "#/components/schemas/ExtendedPointId"
66490 },
76490 "type": "array",
86490 "uniqueItems": true
96490 }
106490 },
1164916218 "required": [
1264916218 "has_id"
1364916218 ],
141686757816 "type": "object"
1564974034}
HasVectorCondition3 of 6 keywords
17774606{
2770 "properties": {
3770 "has_vector": {
4770 "type": "string"
5770 }
6770 },
77716790 "required": [
87716790 "has_vector"
97716790 ],
101686757816 "type": "object"
117774606}
Image10 of 10 keywords
11767157{
21387186 "properties": {
3242n/a "image": {
4242n/a },
51447108 "model": {
6144718 "minLength": 1,
7146590 "type": "string"
81447108 },
9123278 "options": {
101n/a "additionalProperties": true,
111310n/a "nullable": true,
12123278 "type": "object"
13123278 }
141387186 },
152362690 "required": [
162422684 "image",
1715551371 "model"
182362690 ],
1929264407 "type": "object"
201767157}
InferenceObject10 of 10 keywords
12297104{
21387186 "properties": {
31447108 "model": {
4144718 "minLength": 1,
5146590 "type": "string"
61447108 },
7295n/a "object": {
8295n/a },
9123278 "options": {
101n/a "additionalProperties": true,
111310n/a "nullable": true,
12123278 "type": "object"
13123278 }
141387186 },
152892637 "required": [
1615551371 "model",
172952631 "object"
182892637 ],
1929264407 "type": "object"
202297104}
IsEmptyCondition6 of 6 keywords
17774606{
2778855 "properties": {
3778855 "is_empty": {
4778855 "$ref": "#/components/schemas/PayloadField"
5778855 }
6778855 },
789327935 "required": [
889327935 "is_empty"
989327935 ],
101686757816 "type": "object"
117774606}
IsNullCondition6 of 6 keywords
17774606{
2778778 "properties": {
3778778 "is_null": {
4778778 "$ref": "#/components/schemas/PayloadField"
5778778 }
6778778 },
788558012 "required": [
888558012 "is_null"
988558012 ],
101686757816 "type": "object"
117774606}
Language3 of 3 keywords
1360498{
2360498 "enum": [
312n/a "arabic",
412n/a "azerbaijani",
512n/a "basque",
612n/a "bengali",
712n/a "catalan",
812n/a "chinese",
912n/a "danish",
1012n/a "dutch",
1112n/a "english",
1212n/a "finnish",
1312n/a "french",
1412n/a "german",
1512n/a "greek",
1612n/a "hebrew",
1712n/a "hinglish",
1812n/a "hungarian",
1912n/a "indonesian",
2012n/a "italian",
2112n/a "japanese",
2212n/a "kazakh",
2312n/a "nepali",
2412n/a "norwegian",
2512n/a "portuguese",
2612n/a "romanian",
2712n/a "russian",
2812n/a "slovene",
2912n/a "spanish",
3012n/a "swedish",
3112n/a "tajik",
3212n/a "turkish"
33360498 ],
34366492 "type": "string"
35360498}
Match10 of 10 keywords
118486853{
218486853 "anyOf": [
35398162 {
45398162 "$ref": "#/components/schemas/MatchValue"
55398162 },
6778624 {
7778624 "$ref": "#/components/schemas/MatchText"
8778624 },
9778624 {
10778624 "$ref": "#/components/schemas/MatchTextAny"
11778624 },
12778624 {
13778624 "$ref": "#/components/schemas/MatchPhrase"
14778624 },
15778624 {
16778624 "$ref": "#/components/schemas/MatchPrefix"
17778624 },
18778624 {
19778624 "$ref": "#/components/schemas/MatchSubstring"
20778624 },
214628239 {
224628239 "$ref": "#/components/schemas/MatchAny"
234628239 },
244628239 {
254628239 "$ref": "#/components/schemas/MatchExcept"
264628239 }
2718486853 ],
2818486853}
MatchAny3 of 6 keywords
14628239{
24620 "properties": {
34620 "any": {
44620 "$ref": "#/components/schemas/AnyVariants"
54620 }
64620 },
74621463 "required": [
84621463 "any"
94621463 ],
1019256776 "type": "object"
114628239}
MatchExcept3 of 6 keywords
14628239{
24620 "properties": {
34620 "except": {
44620 "$ref": "#/components/schemas/AnyVariants"
54620 }
64620 },
74621463 "required": [
84621463 "except"
94621463 ],
1019256776 "type": "object"
114628239}
MatchPhrase3 of 6 keywords
1778624{
2770 "properties": {
3770 "phrase": {
4770 "type": "string"
5770 }
6770 },
7771848 "required": [
8771848 "phrase"
9771848 ],
1019256776 "type": "object"
11778624}
MatchPrefix3 of 6 keywords
1778624{
2770 "properties": {
3770 "prefix": {
4770 "type": "string"
5770 }
6770 },
7771848 "required": [
8771848 "prefix"
9771848 ],
1019256776 "type": "object"
11778624}
MatchSubstring3 of 6 keywords
1778624{
2770 "properties": {
3770 "substring": {
4770 "type": "string"
5770 }
6770 },
7771848 "required": [
8771848 "substring"
9771848 ],
1019256776 "type": "object"
11778624}
MatchText3 of 6 keywords
1778624{
2770 "properties": {
3770 "text": {
4770 "type": "string"
5770 }
6770 },
7771848 "required": [
8771848 "text"
9771848 ],
1019256776 "type": "object"
11778624}
MatchTextAny3 of 6 keywords
1778624{
2770 "properties": {
3770 "text_any": {
4770 "type": "string"
5770 }
6770 },
7771848 "required": [
8771848 "text_any"
9771848 ],
1019256776 "type": "object"
11778624}
MatchValue3 of 6 keywords
15398162{
25390 "properties": {
35390 "value": {
45390 "$ref": "#/components/schemas/ValueVariants"
55390 }
65390 },
75391386 "required": [
85391386 "value"
95391386 ],
1019256776 "type": "object"
115398162}
MinShould3 of 10 keywords
1261819000{
226180 "properties": {
326180 "conditions": {
426180 "items": {
523320 "$ref": "#/components/schemas/Condition"
626180 },
726180 "type": "array"
826180 },
926180 "min_count": {
1000 "format": "uint",
1126180 "minimum": 1,
1226180 "type": "integer"
1326180 }
1426180 },
152618170 "required": [
162618170 "conditions",
172618170 "min_count"
182618170 ],
19278818830 "type": "object"
20261819000}
Nested0 of 7 keywords
128270{
228270 "properties": {
328270 "filter": {
428270 "$ref": "#/components/schemas/Filter"
528270 },
628270 "key": {
728270 "type": "string"
828270 }
928270 },
1028270 "required": [
1128270 "filter",
1228270 "key"
1328270 ],
1428270 "type": "object"
1528270}
NestedCondition3 of 6 keywords
1282771856{
228270 "properties": {
328270 "nested": {
428270 "$ref": "#/components/schemas/Nested"
528270 }
628270 },
7282714040 "required": [
8282714040 "nested"
9282714040 ],
101686757816 "type": "object"
11282771856}
NoStemmer2 of 3 keywords
16114{
26114 "enum": [
36n/a "none"
46114 ],
51200 "type": "string"
66114}
OverwritePayloadOperation6 of 6 keywords
1160414631{
2160428 "properties": {
3160428 "overwrite_payload": {
4160428 "$ref": "#/components/schemas/SetPayload"
5160428 }
6160428 },
7163214598 "required": [
8163214598 "overwrite_payload"
9163214598 ],
10162305 "type": "object"
11160414631}
Payload2 of 2 keywords
13273506{
21n/a "additionalProperties": true,
33273506 "type": "object"
43273506}
PayloadField1 of 6 keywords
115417633{
21540 "properties": {
31540 "key": {
41540 "type": "string"
51540 }
61540 },
71540 "required": [
81540 "key"
91540 ],
1015417633 "type": "object"
1115417633}
PointIdsList11 of 11 keywords
11773145{
2324726 "properties": {
317726 "points": {
417716 "items": {
560516 "$ref": "#/components/schemas/ExtendedPointId"
617716 },
719310 "type": "array"
817726 },
93164n/a "shard_key": {
103164n/a "anyOf": [
111003064 {
121003064 "$ref": "#/components/schemas/ShardKeySelector"
131003064 },
143164n/a {
153164n/a "nullable": true
163164n/a }
173164n/a ]
183164n/a }
19324726 },
202033109 "required": [
212033109 "points"
222033109 ],
23331210 "type": "object"
241773145}
PointInsertOperations4 of 4 keywords
13960315{
23960315 "anyOf": [
320182257 {
420182257 "$ref": "#/components/schemas/PointsBatch"
520182257 },
619422333 {
719422333 "$ref": "#/components/schemas/PointsList"
819422333 }
93960315 ]
103960315}
PointStruct11 of 11 keywords
1595142{
2597135 "properties": {
37238 "id": {
47238 "$ref": "#/components/schemas/ExtendedPointId"
57238 },
6491n/a "payload": {
7491n/a "anyOf": [
88483 {
98483 "$ref": "#/components/schemas/Payload"
108483 },
11491n/a {
12491n/a "nullable": true
13491n/a }
14491n/a ],
15491n/a },
16604127 "vector": {
17604127 "$ref": "#/components/schemas/VectorStruct"
18604127 }
19597135 },
207302 "required": [
217311 "id",
227311 "vector"
237302 ],
247325 "type": "object"
25595142}
PointVectors7 of 7 keywords
12166142{
22168135 "properties": {
322948 "id": {
422948 "$ref": "#/components/schemas/ExtendedPointId"
522948 },
62175127 "vector": {
72175127 "$ref": "#/components/schemas/VectorStruct"
82175127 }
92168135 },
1023012 "required": [
1123021 "id",
1223021 "vector"
1323012 ],
1423035 "type": "object"
152166142}
PointsBatch18 of 18 keywords
120182257{
24063162 "properties": {
32018162 "batch": {
42018162 "$ref": "#/components/schemas/Batch"
52018162 },
64101n/a "shard_key": {
74101n/a "anyOf": [
8504051 {
9504051 "$ref": "#/components/schemas/ShardKeySelector"
10504051 },
114101n/a {
124101n/a "nullable": true
134101n/a }
144101n/a ]
154101n/a },
164101n/a "update_filter": {
174101n/a "anyOf": [
1830121089 {
1930121089 "$ref": "#/components/schemas/Filter"
2030121089 },
214101n/a {
224101n/a "nullable": true
234101n/a }
244101n/a ],
254101n/a },
264099n/a "update_mode": {
274099n/a "anyOf": [
2864093 {
2964093 "$ref": "#/components/schemas/UpdateMode"
3064093 },
314099n/a {
324099n/a "nullable": true
334099n/a }
344099n/a ],
354099n/a }
364063162 },
3721802090 "required": [
3821802090 "batch"
3921802090 ],
4042705 "type": "object"
4120182257}
PointsList19 of 19 keywords
119422333{
24003147 "properties": {
31942147 "points": {
41942142 "items": {
5595142 "$ref": "#/components/schemas/PointStruct"
61942142 },
720845 "type": "array"
81942147 },
94101n/a "shard_key": {
104101n/a "anyOf": [
11504051 {
12504051 "$ref": "#/components/schemas/ShardKeySelector"
13504051 },
144101n/a {
154101n/a "nullable": true
164101n/a }
174101n/a ]
184101n/a },
194101n/a "update_filter": {
204101n/a "anyOf": [
2130121089 {
2230121089 "$ref": "#/components/schemas/Filter"
2330121089 },
244101n/a {
254101n/a "nullable": true
264101n/a }
274101n/a ],
284101n/a },
294099n/a "update_mode": {
304099n/a "anyOf": [
3164093 {
3264093 "$ref": "#/components/schemas/UpdateMode"
3364093 },
344099n/a {
354099n/a "nullable": true
364099n/a }
374099n/a ],
384099n/a }
394003147 },
4020892181 "required": [
4120892181 "points"
4220892181 ],
4342705 "type": "object"
4419422333}
PointsSelector4 of 4 keywords
1327448{
2327448 "anyOf": [
31773145 {
41773145 "$ref": "#/components/schemas/PointIdsList"
51773145 },
63097225 {
73097225 "$ref": "#/components/schemas/FilterSelector"
83097225 }
9327448 ]
10327448}
Range13 of 15 keywords
1778547{
201694 "properties": {
3771155 "gt": {
4771155 "format": "double",
51232n/a "nullable": true,
6693539 "type": "number"
7771155 },
8771155 "gte": {
9771155 "format": "double",
101232n/a "nullable": true,
11693539 "type": "number"
12771155 },
13771001 "lt": {
14771001 "format": "double",
151078n/a "nullable": true,
16616462 "type": "number"
17771001 },
1877847 "lte": {
1977847 "format": "double",
20924n/a "nullable": true,
21539385 "type": "number"
2277847 }
2301694 },
2417716853 "type": "object"
25778547}
RangeInterface4 of 4 keywords
114637161{
214637161 "anyOf": [
3778547 {
4778547 "$ref": "#/components/schemas/Range"
5778547 },
614637161 {
714637161 "$ref": "#/components/schemas/DatetimeRange"
814637161 }
914637161 ]
1014637161}
SetPayload19 of 19 keywords
1322156{
2322344 "properties": {
33134n/a "filter": {
43134n/a "anyOf": [
53012122 {
63012122 "$ref": "#/components/schemas/Filter"
73012122 },
83134n/a {
93134n/a "nullable": true
103134n/a }
113134n/a ],
123134n/a },
1331848 "key": {
143192n/a "nullable": true,
1531848 "type": "string"
1631848 },
17325510 "payload": {
18325510 "$ref": "#/components/schemas/Payload"
19325510 },
20317326 "points": {
21315418 "items": {
2217020 "$ref": "#/components/schemas/ExtendedPointId"
23315418 },
243199n/a "nullable": true,
2531918 "type": "array"
26317326 },
273130n/a "shard_key": {
283130n/a "anyOf": [
29503080 {
30503080 "$ref": "#/components/schemas/ShardKeySelector"
31503080 },
323130n/a {
333130n/a "nullable": true
343130n/a }
353130n/a ]
363130n/a }
37322344 },
3832652 "required": [
3932652 "payload"
4032652 ],
41326710 "type": "object"
42322156}
SetPayloadOperation6 of 6 keywords
1161714618{
2161728 "properties": {
3161728 "set_payload": {
4161728 "$ref": "#/components/schemas/SetPayload"
5161728 }
6161728 },
7164514585 "required": [
8164514585 "set_payload"
9164514585 ],
10162305 "type": "object"
11161714618}
ShardKey4 of 6 keywords
159522735{
259522735 "anyOf": [
332323007 {
432323007 "type": "string"
532323007 },
627223058 {
700 "format": "uint64",
82720 "minimum": 0,
927223058 "type": "integer"
1027223058 }
1159522735 ]
1259522735}
ShardKeySelector6 of 6 keywords
142522395{
242522395 "anyOf": [
311922701 {
411922701 "$ref": "#/components/schemas/ShardKey"
511922701 },
611922701 {
711917 "items": {
810234 "$ref": "#/components/schemas/ShardKey"
911917 },
1013622684 "type": "array"
1111922701 },
1218722633 {
1318722633 "$ref": "#/components/schemas/ShardKeyWithFallback"
1418722633 }
1542522395 ]
1642522395}
ShardKeyWithFallback3 of 7 keywords
118722633{
21870 "properties": {
31870 "fallback": {
41870 "$ref": "#/components/schemas/ShardKey"
51870 },
61870 "target": {
71870 "$ref": "#/components/schemas/ShardKey"
81870 }
91870 },
1018717 "required": [
1118717 "fallback",
1218717 "target"
1318717 ],
1420422616 "type": "object"
1518722633}
Slice0 of 11 keywords
12310{
22310 "properties": {
32310 "index": {
400 "format": "uint32",
52310 "minimum": 0,
62310 "type": "integer"
72310 },
82310 "total": {
900 "format": "uint32",
102310 "minimum": 1,
112310 "type": "integer"
122310 }
132310 },
142310 "required": [
152310 "index",
162310 "total"
172310 ],
182310 "type": "object"
192310}
SliceCondition3 of 6 keywords
123174452{
22310 "properties": {
32310 "slice": {
42310 "$ref": "#/components/schemas/Slice"
52310 }
62310 },
723116636 "required": [
823116636 "slice"
923116636 ],
101686757816 "type": "object"
1123174452}
Snowball2 of 3 keywords
11146{
21146 "enum": [
3114n/a "snowball"
41146 ],
51200 "type": "string"
61146}
SnowballLanguage0 of 3 keywords
11140{
21140 "enum": [
36n/a "arabic",
46n/a "armenian",
56n/a "danish",
66n/a "dutch",
76n/a "english",
86n/a "finnish",
96n/a "french",
106n/a "german",
116n/a "greek",
126n/a "hungarian",
136n/a "italian",
146n/a "norwegian",
156n/a "portuguese",
166n/a "romanian",
176n/a "russian",
186n/a "spanish",
196n/a "swedish",
206n/a "tamil",
216n/a "turkish"
221140 ],
231140 "type": "string"
241140}
SnowballParams6 of 7 keywords
1114570{
21146 "properties": {
31140 "language": {
41140 "$ref": "#/components/schemas/SnowballLanguage"
51140 },
61146 "type": {
71146 "$ref": "#/components/schemas/Snowball"
81146 }
91146 },
1011412 "required": [
1111412 "language",
121206 "type"
1311412 ],
14126558 "type": "object"
15114570}
SparseVector11 of 12 keywords
1733932{
27966 "properties": {
310636 "indices": {
410621 "items": {
500 "format": "uint32",
61663 "minimum": 0,
716618 "type": "integer"
810621 },
912715 "type": "array"
1010636 },
1111230 "values": {
1211215 "items": {
1344515 "format": "float",
1444515 "type": "number"
1511215 },
1612715 "type": "array"
1711230 }
187966 },
191391360 "required": [
201421357 "indices",
211421357 "values"
221391360 ],
2314992506 "type": "object"
24733932}
StemmingAlgorithm4 of 4 keywords
1120564{
2120564 "anyOf": [
3114570 {
4114570 "$ref": "#/components/schemas/SnowballParams"
5114570 },
66678 {
76678 "$ref": "#/components/schemas/DisabledStemmerParams"
86678 }
9120564 ],
10120564}
StopwordsInterface4 of 4 keywords
1402276{
2402276 "anyOf": [
3180498 {
4180498 "$ref": "#/components/schemas/Language"
5180498 },
6222456 {
7222456 "$ref": "#/components/schemas/StopwordsSet"
8222456 }
9402276 ]
10402276}
StopwordsSet3 of 11 keywords
1222456{
22160 "properties": {
32100 "custom": {
42040 "items": {
560 "type": "string"
62040 },
7210n/a "nullable": true,
82100 "type": "array",
92040 "uniqueItems": true
102100 },
112100 "languages": {
122040 "items": {
131800 "$ref": "#/components/schemas/Language"
142040 },
15210n/a "nullable": true,
162100 "type": "array",
172040 "uniqueItems": true
182100 }
192160 },
20222456 "type": "object"
21222456}
TokenizerType0 of 3 keywords
16720{
26720 "enum": [
3654n/a "prefix",
46n/a "whitespace",
56n/a "word",
66n/a "multilingual"
76720 ],
86720 "type": "string"
96720}
UpdateMode3 of 3 keywords
1128186{
2128186 "enum": [
34n/a "upsert",
44n/a "insert_only",
54n/a "update_only"
6128186 ],
7168182 "type": "string"
8128186}
UpdateOperation10 of 10 keywords
115596639{
215596639 "anyOf": [
3396012275 {
4396012275 "$ref": "#/components/schemas/UpsertOperation"
5396012275 },
6165314582 {
7165314582 "$ref": "#/components/schemas/DeleteOperation"
8165314582 },
9161714618 {
10161714618 "$ref": "#/components/schemas/SetPayloadOperation"
11161714618 },
12160414631 {
13160414631 "$ref": "#/components/schemas/OverwritePayloadOperation"
14160414631 },
15162814607 {
16162814607 "$ref": "#/components/schemas/DeletePayloadOperation"
17162814607 },
18162114614 {
19162114614 "$ref": "#/components/schemas/ClearPayloadOperation"
20162114614 },
21193514300 {
22193514300 "$ref": "#/components/schemas/UpdateVectorsOperation"
23193514300 },
24157814657 {
25157814657 "$ref": "#/components/schemas/DeleteVectorsOperation"
26157814657 }
2715596639 ]
2815596639}
UpdateVectors16 of 16 keywords
11935154{
21936148 "properties": {
31935148 "points": {
41936142 "items": {
52166142 "$ref": "#/components/schemas/PointVectors"
61936142 },
720771 "minItems": 1,
820785 "type": "array"
91935148 },
102026n/a "shard_key": {
112026n/a "anyOf": [
12252001 {
13252001 "$ref": "#/components/schemas/ShardKeySelector"
14252001 },
152026n/a {
162026n/a "nullable": true
172026n/a }
182026n/a ]
192026n/a },
202026n/a "update_filter": {
212026n/a "anyOf": [
221506520 {
231506520 "$ref": "#/components/schemas/Filter"
241506520 },
252026n/a {
262026n/a "nullable": true
272026n/a }
282026n/a ]
292026n/a }
301936148 },
3120831 "required": [
3220831 "points"
3320831 ],
3420845 "type": "object"
351935154}
UpdateVectorsOperation6 of 6 keywords
1193514300{
21935154 "properties": {
31935154 "update_vectors": {
41935154 "$ref": "#/components/schemas/UpdateVectors"
51935154 }
61935154 },
7208914141 "required": [
8208914141 "update_vectors"
9208914141 ],
10162305 "type": "object"
11193514300}
UpsertOperation6 of 6 keywords
1396012275{
23960315 "properties": {
33960315 "upsert": {
43960315 "$ref": "#/components/schemas/PointInsertOperations"
53960315 }
63960315 },
7427511955 "required": [
8427511955 "upsert"
9427511955 ],
10162305 "type": "object"
11396012275}
ValueVariants4 of 6 keywords
15390{
25390 "anyOf": [
377462 {
477462 "type": "string"
577462 },
6308231 {
7308231 "format": "int64",
8308231 "type": "integer"
9308231 },
10154385 {
11154385 "type": "boolean"
12154385 }
135390 ]
145390}
ValuesCount5 of 19 keywords
112327315{
211550 "properties": {
39240 "gt": {
400 "format": "uint",
58470 "minimum": 0,
6924n/a "nullable": true,
79240 "type": "integer"
89240 },
99240 "gte": {
1000 "format": "uint",
118470 "minimum": 0,
12924n/a "nullable": true,
139240 "type": "integer"
149240 },
158470 "lt": {
1600 "format": "uint",
177700 "minimum": 0,
18847n/a "nullable": true,
198470 "type": "integer"
208470 },
217700 "lte": {
2200 "format": "uint",
236930 "minimum": 0,
24770n/a "nullable": true,
257700 "type": "integer"
267700 }
2711550 },
2812327315 "type": "object"
2912327315}
Vector13 of 13 keywords
115162489{
215162489 "anyOf": [
37773228 {
4777296 "items": {
51958698 "format": "float",
61958698 "type": "number"
7777296 },
810732932 "type": "array"
97773228 },
10733932 {
11733932 "$ref": "#/components/schemas/SparseVector"
12733932 },
132233782 {
14223850 "items": {
1531481 "items": {
161579116 "format": "float",
171579116 "type": "number"
1831481 },
193952261 "type": "array"
20223850 },
2110732932 "type": "array"
222233782 },
234493556 {
244493556 "$ref": "#/components/schemas/Document"
254493556 },
26813924 {
27813924 "$ref": "#/components/schemas/Image"
28813924 },
29793926 {
30793926 "$ref": "#/components/schemas/InferenceObject"
31793926 }
3215162489 ],
3315162489}
VectorStruct14 of 14 keywords
12779254{
22779254 "anyOf": [
316871346 {
41687120 "items": {
5515489 "format": "float",
6515489 "type": "number"
71687120 },
818071226 "type": "array"
916871346 },
1016971336 {
111697110 "items": {
1246512 "items": {
13205114 "format": "float",
14205114 "type": "number"
1546512 },
16477527 "type": "array"
171697110 },
1818071226 "type": "array"
1916971336 },
204182615 {
21404800 "additionalProperties": {
2212252413 "$ref": "#/components/schemas/Vector"
23404800 },
2412181815 "type": "object"
254182615 },
263592674 {
273592674 "$ref": "#/components/schemas/Document"
283592674 },
29842949 {
30842949 "$ref": "#/components/schemas/Image"
31842949 },
321332900 {
331332900 "$ref": "#/components/schemas/InferenceObject"
341332900 }
352779254 ],
362779254}
Responses3 of 3 documented received
codedescriptionhitsavg
200successful operation4432ms
4XXerror149760ms
defaulterror4811ms
Examples16 / 16 used
Body: application/json
42ExtendedPointId
"550e8400-e29b-41d4-a716-446655440000"ExtendedPointId
{ "city": "London", "color": "green" }Payload
"jinaai/jina-embeddings-v2-base-en"Document.model
256Bm25Config.avg_len
0.75Bm25Config.b
1.2Bm25Config.k
"This is a document text"Document.text
"https://example.com/image.jpg"Image.image
"Qdrant/clip-ViT-B-32-vision"Image.model
"jinaai/jina-embeddings-v2-base-en"InferenceObject.model
"region_1"ShardKey
12ShardKey
[ 0.875, 0.140625, 0.897599995136261 ]VectorStruct
[ [ 0.875, 0.140625, 0.11020000278949738 ], [ 0.7580000162124634, 0.28126001358032227, 0.9687100052833557 ], [ 0.6209999918937683, 0.42187801003456116, 0.9375 ] ]VectorStruct
{ "image-embeddings": [ 0.8730000257492065, 0.140625, 0.897599995136261 ] }VectorStruct
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
11814n/a{
21814n/a "type": "string"
31814n/a}
Query Parameters8 of 9 keywords covered
consistency6 / 7
ReadConsistency
115951635{
215951635 "anyOf": [
315741656 {
400 "format": "uint",
515747 "minimum": 1,
615811649 "type": "integer"
715741656 },
8213209 {
9213209 "$ref": "#/components/schemas/ReadConsistencyType"
10213209 }
1115951635 ],
1215951635}
Referenced Components (1)3 of 3 keywords
ReadConsistencyType3 of 3 keywords
1213209{
2213209 "enum": [
34n/a "majority",
47n/a "quorum",
510n/a "all"
6213209 ],
71649n/a "type": "string"
8213209}
timeout2 / 2
1158549{
215853 "minimum": 1,
3158846 "type": "integer"
4158549}
Body164 of 270 keywords covered
application/json164 / 270
CountRequest
1175410{
216515 "properties": {
316495 "exact": {
416495 "type": "boolean"
516495 },
61576n/a "filter": {
71576n/a "anyOf": [
8150670 {
9150670 "$ref": "#/components/schemas/Filter"
10150670 },
111576n/a {
121576n/a "nullable": true
131576n/a }
141576n/a ],
151576n/a },
161575n/a "shard_key": {
171575n/a "anyOf": [
18251550 {
19251550 "$ref": "#/components/schemas/ShardKeySelector"
20251550 },
211575n/a {
221575n/a "nullable": true
231575n/a }
241575n/a ],
251575n/a }
2616515 },
2717595 "type": "object"
28175410}
Referenced Components (37)195 of 333 keywords
AnyVariants3 of 9 keywords
1840{
2840 "anyOf": [
32856 {
42856 "items": {
51456 "type": "string"
62856 },
7840 "type": "array",
8840 "uniqueItems": true
92856 },
107014 {
117014 "items": {
125614 "format": "int64",
135614 "type": "integer"
147014 },
15840 "type": "array",
16840 "uniqueItems": true
177014 }
18840 ]
19840}
Condition10 of 10 keywords
115325241{
215325241 "anyOf": [
38755898 {
48755898 "$ref": "#/components/schemas/FieldCondition"
58755898 },
676766 {
776766 "$ref": "#/components/schemas/IsEmptyCondition"
876766 },
976766 {
1076766 "$ref": "#/components/schemas/IsNullCondition"
1176766 },
12596714 {
13596714 "$ref": "#/components/schemas/HasIdCondition"
14596714 },
1576766 {
1676766 "$ref": "#/components/schemas/HasVectorCondition"
1776766 },
18216752 {
19216752 "$ref": "#/components/schemas/SliceCondition"
20216752 },
212576516 {
222576516 "$ref": "#/components/schemas/NestedCondition"
232576516 },
242996474 {
252996474 "$ref": "#/components/schemas/Filter"
262996474 }
2715325241 ]
2815325241}
DatetimeRange11 of 15 keywords
1133651{
212628 "properties": {
31057 "gt": {
4490 "format": "date-time",
5112n/a "nullable": true,
61057 "type": "string"
71057 },
81057 "gte": {
9490 "format": "date-time",
10112n/a "nullable": true,
111057 "type": "string"
121057 },
13917 "lt": {
14420 "format": "date-time",
1598n/a "nullable": true,
16917 "type": "string"
17917 },
18777 "lte": {
19350 "format": "date-time",
2084n/a "nullable": true,
21777 "type": "string"
22777 }
2312628 },
24161623 "type": "object"
25133651}
ExtendedPointId2 of 7 keywords
1520{
2520 "anyOf": [
33319 {
400 "format": "uint64",
5330 "minimum": 0,
63319 "type": "integer"
73319 },
81933 {
9190 "format": "uuid",
101933 "type": "string"
111933 }
12520 ],
13520}
FieldCondition33 of 34 keywords
18755898{
287514 "properties": {
3819n/a "geo_bounding_box": {
4819n/a "anyOf": [
57812 {
67812 "$ref": "#/components/schemas/GeoBoundingBox"
77812 },
8819n/a {
9819n/a "nullable": true
10819n/a }
11819n/a ],
12819n/a },
13819n/a "geo_polygon": {
14819n/a "anyOf": [
1542777 {
1642777 "$ref": "#/components/schemas/GeoPolygon"
1742777 },
18819n/a {
19819n/a "nullable": true
20819n/a }
21819n/a ],
22819n/a },
23812n/a "geo_radius": {
24812n/a "anyOf": [
257805 {
267805 "$ref": "#/components/schemas/GeoRadius"
277805 },
28812n/a {
29812n/a "nullable": true
30812n/a }
31812n/a ],
32812n/a },
338057 "is_empty": {
34812n/a "nullable": true,
358057 "type": "boolean"
368057 },
377987 "is_null": {
38805n/a "nullable": true,
397987 "type": "boolean"
407987 },
418750 "key": {
428750 "type": "string"
438750 },
44791n/a "match": {
45791n/a "anyOf": [
46168623 {
47168623 "$ref": "#/components/schemas/Match"
48168623 },
49791n/a {
50791n/a "nullable": true
51791n/a }
52791n/a ],
53791n/a },
54784n/a "range": {
55784n/a "anyOf": [
56133651 {
57133651 "$ref": "#/components/schemas/RangeInterface"
58133651 },
59784n/a {
60784n/a "nullable": true
61784n/a }
62784n/a ],
63784n/a },
64777n/a "values_count": {
65777n/a "anyOf": [
66112665 {
67112665 "$ref": "#/components/schemas/ValuesCount"
68112665 },
69777n/a {
70777n/a "nullable": true
71777n/a }
72777n/a ],
73777n/a }
7487514 },
75875657 "required": [
76875657 "key"
77875657 ],
7815325241 "type": "object"
798755898}
Filter25 of 25 keywords
120626544{
2n/a1233 "additionalProperties": false,
32005n/a "properties": {
41960n/a "min_should": {
51960n/a "anyOf": [
62381722 {
72381722 "$ref": "#/components/schemas/MinShould"
82381722 },
91960n/a {
101960n/a "nullable": true
111960n/a }
121960n/a ],
131960n/a },
141960n/a "must": {
151960n/a "anyOf": [
162281732 {
172281732 "$ref": "#/components/schemas/Condition"
182281732 },
192271733 {
2022715 "items": {
2121230 "$ref": "#/components/schemas/Condition"
2222715 },
232421718 "type": "array"
242271733 },
251960n/a {
261960n/a "nullable": true
271960n/a }
281960n/a ],
291960n/a },
301945n/a "must_not": {
311945n/a "anyOf": [
322281717 {
332281717 "$ref": "#/components/schemas/Condition"
342281717 },
352271718 {
3622715 "items": {
3721230 "$ref": "#/components/schemas/Condition"
3822715 },
392421703 "type": "array"
402271718 },
411945n/a {
421945n/a "nullable": true
431945n/a }
441945n/a ],
451945n/a },
461930n/a "should": {
471930n/a "anyOf": [
482281702 {
492281702 "$ref": "#/components/schemas/Condition"
502281702 },
512271703 {
5222715 "items": {
5321230 "$ref": "#/components/schemas/Condition"
5422715 },
552421688 "type": "array"
562271703 },
571930n/a {
581930n/a "nullable": true
591930n/a }
601930n/a ],
611930n/a }
622005n/a },
6332955311 "type": "object"
6420626544}
GeoBoundingBox3 of 7 keywords
17812{
270 "properties": {
370 "bottom_right": {
470 "$ref": "#/components/schemas/GeoPoint"
570 },
670 "top_left": {
770 "$ref": "#/components/schemas/GeoPoint"
870 }
970 },
1077 "required": [
1177 "bottom_right",
1277 "top_left"
1377 ],
1414805 "type": "object"
157812}
GeoLineString0 of 7 keywords
1560{
2560 "properties": {
3560 "points": {
4560 "items": {
5140 "$ref": "#/components/schemas/GeoPoint"
6560 },
7560 "type": "array"
8560 }
9560 },
10560 "required": [
11560 "points"
12560 ],
13560 "type": "object"
14560}
GeoPoint0 of 9 keywords
1350{
2350 "properties": {
3350 "lat": {
4350 "format": "double",
5350 "type": "number"
6350 },
7350 "lon": {
8350 "format": "double",
9350 "type": "number"
10350 }
11350 },
12350 "required": [
13350 "lat",
14350 "lon"
15350 ],
16350 "type": "object"
17350}
GeoPolygon4 of 9 keywords
142777{
2420 "properties": {
3420 "exterior": {
4420 "$ref": "#/components/schemas/GeoLineString"
5420 },
6350 "interiors": {
7280 "items": {
8140 "$ref": "#/components/schemas/GeoLineString"
9280 },
1035n/a "nullable": true,
11350 "type": "array"
12350 }
13420 },
14427 "required": [
15427 "exterior"
16427 ],
1749770 "type": "object"
1842777}
GeoRadius3 of 8 keywords
17805{
270 "properties": {
370 "center": {
470 "$ref": "#/components/schemas/GeoPoint"
570 },
670 "radius": {
770 "format": "double",
870 "type": "number"
970 }
1070 },
1177 "required": [
1277 "center",
1377 "radius"
1477 ],
1514798 "type": "object"
167805}
HasIdCondition3 of 8 keywords
1596714{
2590 "properties": {
3590 "has_id": {
4590 "items": {
5520 "$ref": "#/components/schemas/ExtendedPointId"
6590 },
7590 "type": "array",
8590 "uniqueItems": true
9590 }
10590 },
11591473 "required": [
12591473 "has_id"
13591473 ],
1415325241 "type": "object"
15596714}
HasVectorCondition3 of 6 keywords
176766{
270 "properties": {
370 "has_vector": {
470 "type": "string"
570 }
670 },
771525 "required": [
871525 "has_vector"
971525 ],
1015325241 "type": "object"
1176766}
IsEmptyCondition6 of 6 keywords
176766{
27805 "properties": {
37805 "is_empty": {
47805 "$ref": "#/components/schemas/PayloadField"
57805 }
67805 },
7812720 "required": [
8812720 "is_empty"
9812720 ],
1015325241 "type": "object"
1176766}
IsNullCondition6 of 6 keywords
176766{
27798 "properties": {
37798 "is_null": {
47798 "$ref": "#/components/schemas/PayloadField"
57798 }
67798 },
7805727 "required": [
8805727 "is_null"
9805727 ],
1015325241 "type": "object"
1176766}
Match10 of 10 keywords
1168623{
2168623 "anyOf": [
349742 {
449742 "$ref": "#/components/schemas/MatchValue"
549742 },
67784 {
77784 "$ref": "#/components/schemas/MatchText"
87784 },
97784 {
107784 "$ref": "#/components/schemas/MatchTextAny"
117784 },
127784 {
137784 "$ref": "#/components/schemas/MatchPhrase"
147784 },
157784 {
167784 "$ref": "#/components/schemas/MatchPrefix"
177784 },
187784 {
197784 "$ref": "#/components/schemas/MatchSubstring"
207784 },
2142749 {
2242749 "$ref": "#/components/schemas/MatchAny"
2342749 },
2442749 {
2542749 "$ref": "#/components/schemas/MatchExcept"
2642749 }
27168623 ],
28168623}
MatchAny3 of 6 keywords
142749{
2420 "properties": {
3420 "any": {
4420 "$ref": "#/components/schemas/AnyVariants"
5420 }
6420 },
742133 "required": [
842133 "any"
942133 ],
10175616 "type": "object"
1142749}
MatchExcept3 of 6 keywords
142749{
2420 "properties": {
3420 "except": {
4420 "$ref": "#/components/schemas/AnyVariants"
5420 }
6420 },
742133 "required": [
842133 "except"
942133 ],
10175616 "type": "object"
1142749}
MatchPhrase3 of 6 keywords
17784{
270 "properties": {
370 "phrase": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "phrase"
97168 ],
10175616 "type": "object"
117784}
MatchPrefix3 of 6 keywords
17784{
270 "properties": {
370 "prefix": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "prefix"
97168 ],
10175616 "type": "object"
117784}
MatchSubstring3 of 6 keywords
17784{
270 "properties": {
370 "substring": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "substring"
97168 ],
10175616 "type": "object"
117784}
MatchText3 of 6 keywords
17784{
270 "properties": {
370 "text": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "text"
97168 ],
10175616 "type": "object"
117784}
MatchTextAny3 of 6 keywords
17784{
270 "properties": {
370 "text_any": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "text_any"
97168 ],
10175616 "type": "object"
117784}
MatchValue3 of 6 keywords
149742{
2490 "properties": {
3490 "value": {
4490 "$ref": "#/components/schemas/ValueVariants"
5490 }
6490 },
749126 "required": [
849126 "value"
949126 ],
10175616 "type": "object"
1149742}
MinShould3 of 10 keywords
12381722{
22380 "properties": {
32380 "conditions": {
42380 "items": {
52120 "$ref": "#/components/schemas/Condition"
62380 },
72380 "type": "array"
82380 },
92380 "min_count": {
1000 "format": "uint",
112380 "minimum": 1,
122380 "type": "integer"
132380 }
142380 },
1523815 "required": [
1623815 "conditions",
1723815 "min_count"
1823815 ],
192531707 "type": "object"
202381722}
Nested0 of 7 keywords
12570{
22570 "properties": {
32570 "filter": {
42570 "$ref": "#/components/schemas/Filter"
52570 },
62570 "key": {
72570 "type": "string"
82570 }
92570 },
102570 "required": [
112570 "filter",
122570 "key"
132570 ],
142570 "type": "object"
152570}
NestedCondition3 of 6 keywords
12576516{
22570 "properties": {
32570 "nested": {
42570 "$ref": "#/components/schemas/Nested"
52570 }
62570 },
72571275 "required": [
82571275 "nested"
92571275 ],
1015325241 "type": "object"
112576516}
PayloadField1 of 6 keywords
1141603{
2140 "properties": {
3140 "key": {
4140 "type": "string"
5140 }
6140 },
7140 "required": [
8140 "key"
9140 ],
10141603 "type": "object"
11141603}
Range13 of 15 keywords
17777{
20154 "properties": {
37105 "gt": {
47105 "format": "double",
5112n/a "nullable": true,
66349 "type": "number"
77105 },
87105 "gte": {
97105 "format": "double",
10112n/a "nullable": true,
116349 "type": "number"
127105 },
13791 "lt": {
14791 "format": "double",
1598n/a "nullable": true,
165642 "type": "number"
17791 },
18777 "lte": {
19777 "format": "double",
2084n/a "nullable": true,
214935 "type": "number"
22777 }
230154 },
24161623 "type": "object"
257777}
RangeInterface4 of 4 keywords
1133651{
2133651 "anyOf": [
37777 {
47777 "$ref": "#/components/schemas/Range"
57777 },
6133651 {
7133651 "$ref": "#/components/schemas/DatetimeRange"
8133651 }
9133651 ]
10133651}
ShardKey4 of 6 keywords
1351570{
2351570 "anyOf": [
3191586 {
4191586 "type": "string"
5191586 },
6161589 {
700 "format": "uint64",
8160 "minimum": 0,
9161589 "type": "integer"
10161589 }
11351570 ]
12351570}
ShardKeySelector6 of 6 keywords
1251550{
2251550 "anyOf": [
371568 {
471568 "$ref": "#/components/schemas/ShardKey"
571568 },
671568 {
771 "items": {
862 "$ref": "#/components/schemas/ShardKey"
971 },
1081567 "type": "array"
1171568 },
12111564 {
13111564 "$ref": "#/components/schemas/ShardKeyWithFallback"
14111564 }
15251550 ]
16251550}
ShardKeyWithFallback3 of 7 keywords
1111564{
2110 "properties": {
3110 "fallback": {
4110 "$ref": "#/components/schemas/ShardKey"
5110 },
6110 "target": {
7110 "$ref": "#/components/schemas/ShardKey"
8110 }
9110 },
10111 "required": [
11111 "fallback",
12111 "target"
13111 ],
14121563 "type": "object"
15111564}
Slice0 of 11 keywords
1210{
2210 "properties": {
3210 "index": {
400 "format": "uint32",
5210 "minimum": 0,
6210 "type": "integer"
7210 },
8210 "total": {
900 "format": "uint32",
10210 "minimum": 1,
11210 "type": "integer"
12210 }
13210 },
14210 "required": [
15210 "index",
16210 "total"
17210 ],
18210 "type": "object"
19210}
SliceCondition3 of 6 keywords
1216752{
2210 "properties": {
3210 "slice": {
4210 "$ref": "#/components/schemas/Slice"
5210 }
6210 },
7211511 "required": [
8211511 "slice"
9211511 ],
1015325241 "type": "object"
11216752}
ValueVariants4 of 6 keywords
1490{
2490 "anyOf": [
3742 {
4742 "type": "string"
5742 },
62821 {
72821 "format": "int64",
82821 "type": "integer"
92821 },
101435 {
111435 "type": "boolean"
121435 }
13490 ]
14490}
ValuesCount5 of 19 keywords
1112665{
21050 "properties": {
3840 "gt": {
400 "format": "uint",
5770 "minimum": 0,
684n/a "nullable": true,
7840 "type": "integer"
8840 },
9840 "gte": {
1000 "format": "uint",
11770 "minimum": 0,
1284n/a "nullable": true,
13840 "type": "integer"
14840 },
15770 "lt": {
1600 "format": "uint",
17700 "minimum": 0,
1877n/a "nullable": true,
19770 "type": "integer"
20770 },
21700 "lte": {
2200 "format": "uint",
23630 "minimum": 0,
2470n/a "nullable": true,
25700 "type": "integer"
26700 }
271050 },
28112665 "type": "object"
29112665}
Responses2 of 3 documented received
codedescriptionhitsavg
200successful operation3220ms
4XXerror14920ms
defaulterror0-
Examples5 / 5 used
Body: application/json
trueCountRequest.exact
42ExtendedPointId
"550e8400-e29b-41d4-a716-446655440000"ExtendedPointId
"region_1"ShardKey
12ShardKey
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
11846n/a{
21846n/a "type": "string"
31846n/a}
Query Parameters5 of 5 keywords covered
wait1 / 1
1169733{
2169733 "type": "boolean"
3169733}
ordering2 / 2
WriteOrdering
1167930{
2167930 "enum": [
31643n/a "weak",
412n/a "medium",
524n/a "strong"
6167930 ],
71709n/a "type": "string"
8167930}
timeout2 / 2
1164343{
2164323 "minimum": 1,
3166620 "type": "integer"
4164343}
Body176 of 279 keywords covered
application/json176 / 279
PointsSelector
1178824{
2178824 "anyOf": [
31561656 {
41561656 "$ref": "#/components/schemas/PointIdsList"
51561656 },
61632180 {
71632180 "$ref": "#/components/schemas/FilterSelector"
81632180 }
9178824 ]
10178824}
Referenced Components (39)220 of 354 keywords
AnyVariants3 of 9 keywords
1840{
2840 "anyOf": [
32856 {
42856 "items": {
51456 "type": "string"
62856 },
7840 "type": "array",
8840 "uniqueItems": true
92856 },
107014 {
117014 "items": {
125614 "format": "int64",
135614 "type": "integer"
147014 },
15840 "type": "array",
16840 "uniqueItems": true
177014 }
18840 ]
19840}
Condition10 of 10 keywords
115475506{
215475506 "anyOf": [
38756178 {
48756178 "$ref": "#/components/schemas/FieldCondition"
58756178 },
677046 {
777046 "$ref": "#/components/schemas/IsEmptyCondition"
877046 },
977046 {
1077046 "$ref": "#/components/schemas/IsNullCondition"
1177046 },
12596994 {
13596994 "$ref": "#/components/schemas/HasIdCondition"
14596994 },
1577046 {
1677046 "$ref": "#/components/schemas/HasVectorCondition"
1777046 },
18217032 {
19217032 "$ref": "#/components/schemas/SliceCondition"
20217032 },
212576796 {
222576796 "$ref": "#/components/schemas/NestedCondition"
232576796 },
243146739 {
253146739 "$ref": "#/components/schemas/Filter"
263146739 }
2715475506 ]
2815475506}
DatetimeRange11 of 15 keywords
1133651{
212628 "properties": {
31057 "gt": {
4490 "format": "date-time",
5112n/a "nullable": true,
61057 "type": "string"
71057 },
81057 "gte": {
9490 "format": "date-time",
10112n/a "nullable": true,
111057 "type": "string"
121057 },
13917 "lt": {
14420 "format": "date-time",
1598n/a "nullable": true,
16917 "type": "string"
17917 },
18777 "lte": {
19350 "format": "date-time",
2084n/a "nullable": true,
21777 "type": "string"
22777 }
2312628 },
24161623 "type": "object"
25133651}
ExtendedPointId6 of 7 keywords
11988{
21988 "anyOf": [
312284 {
400 "format": "uint64",
51231 "minimum": 0,
612383 "type": "integer"
712284 },
876130 {
9762 "format": "uuid",
1078128 "type": "string"
1176130 }
121988 ],
131988}
FieldCondition33 of 34 keywords
18756178{
287514 "properties": {
3819n/a "geo_bounding_box": {
4819n/a "anyOf": [
57812 {
67812 "$ref": "#/components/schemas/GeoBoundingBox"
77812 },
8819n/a {
9819n/a "nullable": true
10819n/a }
11819n/a ],
12819n/a },
13819n/a "geo_polygon": {
14819n/a "anyOf": [
1542777 {
1642777 "$ref": "#/components/schemas/GeoPolygon"
1742777 },
18819n/a {
19819n/a "nullable": true
20819n/a }
21819n/a ],
22819n/a },
23812n/a "geo_radius": {
24812n/a "anyOf": [
257805 {
267805 "$ref": "#/components/schemas/GeoRadius"
277805 },
28812n/a {
29812n/a "nullable": true
30812n/a }
31812n/a ],
32812n/a },
338057 "is_empty": {
34812n/a "nullable": true,
358057 "type": "boolean"
368057 },
377987 "is_null": {
38805n/a "nullable": true,
397987 "type": "boolean"
407987 },
418750 "key": {
428750 "type": "string"
438750 },
44791n/a "match": {
45791n/a "anyOf": [
46168623 {
47168623 "$ref": "#/components/schemas/Match"
48168623 },
49791n/a {
50791n/a "nullable": true
51791n/a }
52791n/a ],
53791n/a },
54784n/a "range": {
55784n/a "anyOf": [
56133651 {
57133651 "$ref": "#/components/schemas/RangeInterface"
58133651 },
59784n/a {
60784n/a "nullable": true
61784n/a }
62784n/a ],
63784n/a },
64777n/a "values_count": {
65777n/a "anyOf": [
66112665 {
67112665 "$ref": "#/components/schemas/ValuesCount"
68112665 },
69777n/a {
70777n/a "nullable": true
71777n/a }
72777n/a ],
73777n/a }
7487514 },
75875736 "required": [
76875736 "key"
77875736 ],
7816115442 "type": "object"
798756178}
Filter25 of 25 keywords
122036744{
2n/a1297 "additionalProperties": false,
32096n/a "properties": {
42034n/a "min_should": {
52034n/a "anyOf": [
62381796 {
72381796 "$ref": "#/components/schemas/MinShould"
82381796 },
92034n/a {
102034n/a "nullable": true
112034n/a }
122034n/a ],
132034n/a },
142047n/a "must": {
152047n/a "anyOf": [
162341813 {
172341813 "$ref": "#/components/schemas/Condition"
182341813 },
192291818 {
2022931 "items": {
2121266 "$ref": "#/components/schemas/Condition"
2222931 },
232601787 "type": "array"
242291818 },
252047n/a {
262047n/a "nullable": true
272047n/a }
282047n/a ],
292047n/a },
302015n/a "must_not": {
312015n/a "anyOf": [
322341781 {
332341781 "$ref": "#/components/schemas/Condition"
342341781 },
352281787 {
3622825 "items": {
3721251 "$ref": "#/components/schemas/Condition"
3822825 },
392531762 "type": "array"
402281787 },
412015n/a {
422015n/a "nullable": true
432015n/a }
442015n/a ],
452015n/a },
461980n/a "should": {
471980n/a "anyOf": [
482311749 {
492311749 "$ref": "#/components/schemas/Condition"
502311749 },
512291751 {
5222924 "items": {
5321246 "$ref": "#/components/schemas/Condition"
5422924 },
552531727 "type": "array"
562291751 },
571980n/a {
581980n/a "nullable": true
591980n/a }
601980n/a ],
611980n/a }
622096n/a },
6335005447 "type": "object"
6422036744}
FilterSelector10 of 10 keywords
11632180{
217225 "properties": {
316325 "filter": {
416325 "$ref": "#/components/schemas/Filter"
516325 },
61624n/a "shard_key": {
71624n/a "anyOf": [
8501574 {
9501574 "$ref": "#/components/schemas/ShardKeySelector"
10501574 },
111624n/a {
121624n/a "nullable": true
131624n/a }
141624n/a ]
151624n/a }
1617225 },
171637170 "required": [
181637170 "filter"
191637170 ],
2018075 "type": "object"
211632180}
GeoBoundingBox3 of 7 keywords
17812{
270 "properties": {
370 "bottom_right": {
470 "$ref": "#/components/schemas/GeoPoint"
570 },
670 "top_left": {
770 "$ref": "#/components/schemas/GeoPoint"
870 }
970 },
1077 "required": [
1177 "bottom_right",
1277 "top_left"
1377 ],
1414805 "type": "object"
157812}
GeoLineString0 of 7 keywords
1560{
2560 "properties": {
3560 "points": {
4560 "items": {
5140 "$ref": "#/components/schemas/GeoPoint"
6560 },
7560 "type": "array"
8560 }
9560 },
10560 "required": [
11560 "points"
12560 ],
13560 "type": "object"
14560}
GeoPoint0 of 9 keywords
1350{
2350 "properties": {
3350 "lat": {
4350 "format": "double",
5350 "type": "number"
6350 },
7350 "lon": {
8350 "format": "double",
9350 "type": "number"
10350 }
11350 },
12350 "required": [
13350 "lat",
14350 "lon"
15350 ],
16350 "type": "object"
17350}
GeoPolygon4 of 9 keywords
142777{
2420 "properties": {
3420 "exterior": {
4420 "$ref": "#/components/schemas/GeoLineString"
5420 },
6350 "interiors": {
7280 "items": {
8140 "$ref": "#/components/schemas/GeoLineString"
9280 },
1035n/a "nullable": true,
11350 "type": "array"
12350 }
13420 },
14427 "required": [
15427 "exterior"
16427 ],
1749770 "type": "object"
1842777}
GeoRadius3 of 8 keywords
17805{
270 "properties": {
370 "center": {
470 "$ref": "#/components/schemas/GeoPoint"
570 },
670 "radius": {
770 "format": "double",
870 "type": "number"
970 }
1070 },
1177 "required": [
1277 "center",
1377 "radius"
1477 ],
1514798 "type": "object"
167805}
HasIdCondition3 of 8 keywords
1596994{
2590 "properties": {
3590 "has_id": {
4590 "items": {
5520 "$ref": "#/components/schemas/ExtendedPointId"
6590 },
7590 "type": "array",
8590 "uniqueItems": true
9590 }
10590 },
11591552 "required": [
12591552 "has_id"
13591552 ],
1416115442 "type": "object"
15596994}
HasVectorCondition3 of 6 keywords
177046{
270 "properties": {
370 "has_vector": {
470 "type": "string"
570 }
670 },
771604 "required": [
871604 "has_vector"
971604 ],
1016115442 "type": "object"
1177046}
IsEmptyCondition6 of 6 keywords
177046{
27805 "properties": {
37805 "is_empty": {
47805 "$ref": "#/components/schemas/PayloadField"
57805 }
67805 },
7812799 "required": [
8812799 "is_empty"
9812799 ],
1016115442 "type": "object"
1177046}
IsNullCondition6 of 6 keywords
177046{
27798 "properties": {
37798 "is_null": {
47798 "$ref": "#/components/schemas/PayloadField"
57798 }
67798 },
7805806 "required": [
8805806 "is_null"
9805806 ],
1016115442 "type": "object"
1177046}
Match10 of 10 keywords
1168623{
2168623 "anyOf": [
349742 {
449742 "$ref": "#/components/schemas/MatchValue"
549742 },
67784 {
77784 "$ref": "#/components/schemas/MatchText"
87784 },
97784 {
107784 "$ref": "#/components/schemas/MatchTextAny"
117784 },
127784 {
137784 "$ref": "#/components/schemas/MatchPhrase"
147784 },
157784 {
167784 "$ref": "#/components/schemas/MatchPrefix"
177784 },
187784 {
197784 "$ref": "#/components/schemas/MatchSubstring"
207784 },
2142749 {
2242749 "$ref": "#/components/schemas/MatchAny"
2342749 },
2442749 {
2542749 "$ref": "#/components/schemas/MatchExcept"
2642749 }
27168623 ],
28168623}
MatchAny3 of 6 keywords
142749{
2420 "properties": {
3420 "any": {
4420 "$ref": "#/components/schemas/AnyVariants"
5420 }
6420 },
742133 "required": [
842133 "any"
942133 ],
10175616 "type": "object"
1142749}
MatchExcept3 of 6 keywords
142749{
2420 "properties": {
3420 "except": {
4420 "$ref": "#/components/schemas/AnyVariants"
5420 }
6420 },
742133 "required": [
842133 "except"
942133 ],
10175616 "type": "object"
1142749}
MatchPhrase3 of 6 keywords
17784{
270 "properties": {
370 "phrase": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "phrase"
97168 ],
10175616 "type": "object"
117784}
MatchPrefix3 of 6 keywords
17784{
270 "properties": {
370 "prefix": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "prefix"
97168 ],
10175616 "type": "object"
117784}
MatchSubstring3 of 6 keywords
17784{
270 "properties": {
370 "substring": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "substring"
97168 ],
10175616 "type": "object"
117784}
MatchText3 of 6 keywords
17784{
270 "properties": {
370 "text": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "text"
97168 ],
10175616 "type": "object"
117784}
MatchTextAny3 of 6 keywords
17784{
270 "properties": {
370 "text_any": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "text_any"
97168 ],
10175616 "type": "object"
117784}
MatchValue3 of 6 keywords
149742{
2490 "properties": {
3490 "value": {
4490 "$ref": "#/components/schemas/ValueVariants"
5490 }
6490 },
749126 "required": [
849126 "value"
949126 ],
10175616 "type": "object"
1149742}
MinShould3 of 10 keywords
12381796{
22380 "properties": {
32380 "conditions": {
42380 "items": {
52120 "$ref": "#/components/schemas/Condition"
62380 },
72380 "type": "array"
82380 },
92380 "min_count": {
1000 "format": "uint",
112380 "minimum": 1,
122380 "type": "integer"
132380 }
142380 },
1523833 "required": [
1623833 "conditions",
1723833 "min_count"
1823833 ],
192711763 "type": "object"
202381796}
Nested0 of 7 keywords
12570{
22570 "properties": {
32570 "filter": {
42570 "$ref": "#/components/schemas/Filter"
52570 },
62570 "key": {
72570 "type": "string"
82570 }
92570 },
102570 "required": [
112570 "filter",
122570 "key"
132570 ],
142570 "type": "object"
152570}
NestedCondition3 of 6 keywords
12576796{
22570 "properties": {
32570 "nested": {
42570 "$ref": "#/components/schemas/Nested"
52570 }
62570 },
72571354 "required": [
82571354 "nested"
92571354 ],
1016115442 "type": "object"
112576796}
PayloadField1 of 6 keywords
1141603{
2140 "properties": {
3140 "key": {
4140 "type": "string"
5140 }
6140 },
7140 "required": [
8140 "key"
9140 ],
10141603 "type": "object"
11141603}
PointIdsList11 of 11 keywords
11561656{
2169113 "properties": {
315613 "points": {
41568 "items": {
51468 "$ref": "#/components/schemas/ExtendedPointId"
61568 },
71645 "type": "array"
815613 },
91624n/a "shard_key": {
101624n/a "anyOf": [
11501574 {
12501574 "$ref": "#/components/schemas/ShardKeySelector"
13501574 },
141624n/a {
151624n/a "nullable": true
161624n/a }
171624n/a ]
181624n/a }
19169113 },
201691638 "required": [
211691638 "points"
221691638 ],
2318075 "type": "object"
241561656}
Range13 of 15 keywords
17777{
20154 "properties": {
37105 "gt": {
47105 "format": "double",
5112n/a "nullable": true,
66349 "type": "number"
77105 },
87105 "gte": {
97105 "format": "double",
10112n/a "nullable": true,
116349 "type": "number"
127105 },
13791 "lt": {
14791 "format": "double",
1598n/a "nullable": true,
165642 "type": "number"
17791 },
18777 "lte": {
19777 "format": "double",
2084n/a "nullable": true,
214935 "type": "number"
22777 }
230154 },
24161623 "type": "object"
257777}
RangeInterface4 of 4 keywords
1133651{
2133651 "anyOf": [
37777 {
47777 "$ref": "#/components/schemas/Range"
57777 },
6133651 {
7133651 "$ref": "#/components/schemas/DatetimeRange"
8133651 }
9133651 ]
10133651}
ShardKey4 of 6 keywords
11403228{
21403228 "anyOf": [
3763292 {
4763292 "type": "string"
5763292 },
6643304 {
700 "format": "uint64",
8640 "minimum": 0,
9643304 "type": "integer"
10643304 }
111403228 ]
121403228}
ShardKeySelector6 of 6 keywords
11003148{
21003148 "anyOf": [
3283220 {
4283220 "$ref": "#/components/schemas/ShardKey"
5283220 },
6283220 {
7284 "items": {
8248 "$ref": "#/components/schemas/ShardKey"
9284 },
10323216 "type": "array"
11283220 },
12443204 {
13443204 "$ref": "#/components/schemas/ShardKeyWithFallback"
14443204 }
151003148 ]
161003148}
ShardKeyWithFallback3 of 7 keywords
1443204{
2440 "properties": {
3440 "fallback": {
4440 "$ref": "#/components/schemas/ShardKey"
5440 },
6440 "target": {
7440 "$ref": "#/components/schemas/ShardKey"
8440 }
9440 },
10444 "required": [
11444 "fallback",
12444 "target"
13444 ],
14483200 "type": "object"
15443204}
Slice0 of 11 keywords
1210{
2210 "properties": {
3210 "index": {
400 "format": "uint32",
5210 "minimum": 0,
6210 "type": "integer"
7210 },
8210 "total": {
900 "format": "uint32",
10210 "minimum": 1,
11210 "type": "integer"
12210 }
13210 },
14210 "required": [
15210 "index",
16210 "total"
17210 ],
18210 "type": "object"
19210}
SliceCondition3 of 6 keywords
1217032{
2210 "properties": {
3210 "slice": {
4210 "$ref": "#/components/schemas/Slice"
5210 }
6210 },
7211590 "required": [
8211590 "slice"
9211590 ],
1016115442 "type": "object"
11217032}
ValueVariants4 of 6 keywords
1490{
2490 "anyOf": [
3742 {
4742 "type": "string"
5742 },
62821 {
72821 "format": "int64",
82821 "type": "integer"
92821 },
101435 {
111435 "type": "boolean"
121435 }
13490 ]
14490}
ValuesCount5 of 19 keywords
1112665{
21050 "properties": {
3840 "gt": {
400 "format": "uint",
5770 "minimum": 0,
684n/a "nullable": true,
7840 "type": "integer"
8840 },
9840 "gte": {
1000 "format": "uint",
11770 "minimum": 0,
1284n/a "nullable": true,
13840 "type": "integer"
14840 },
15770 "lt": {
1600 "format": "uint",
17700 "minimum": 0,
1877n/a "nullable": true,
19770 "type": "integer"
20770 },
21700 "lte": {
2200 "format": "uint",
23630 "minimum": 0,
2470n/a "nullable": true,
25700 "type": "integer"
26700 }
271050 },
28112665 "type": "object"
29112665}
Responses2 of 3 documented received
codedescriptionhitsavg
200successful operation2492ms
4XXerror15971ms
defaulterror0-
Examples4 / 4 used
Body: application/json
42ExtendedPointId
"550e8400-e29b-41d4-a716-446655440000"ExtendedPointId
"region_1"ShardKey
12ShardKey
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
11835n/a{
21835n/a "type": "string"
31835n/a}
Query Parameters5 of 5 keywords covered
wait1 / 1
1160924{
2160924 "type": "boolean"
3160924}
ordering2 / 2
WriteOrdering
1163219{
2163219 "enum": [
31606n/a "weak",
412n/a "medium",
514n/a "strong"
6163219 ],
71651n/a "type": "string"
8163219}
timeout2 / 2
1162822{
216288 "minimum": 1,
3163614 "type": "integer"
4162822}
Body175 of 278 keywords covered
application/json175 / 278
SetPayload
1173333{
2173922 "properties": {
31609n/a "filter": {
41609n/a "anyOf": [
51506103 {
61506103 "$ref": "#/components/schemas/Filter"
71506103 },
81609n/a {
91609n/a "nullable": true
101609n/a }
111609n/a ],
121609n/a },
1316454 "key": {
141649n/a "nullable": true,
1516454 "type": "string"
1616454 },
1717505 "payload": {
1817505 "$ref": "#/components/schemas/Payload"
1917505 },
20168013 "points": {
2116599 "items": {
2218210 "$ref": "#/components/schemas/ExtendedPointId"
2316599 },
241693n/a "nullable": true,
2516894 "type": "array"
26168013 },
271607n/a "shard_key": {
281607n/a "anyOf": [
29251582 {
30251582 "$ref": "#/components/schemas/ShardKeySelector"
31251582 },
321607n/a {
331607n/a "nullable": true
341607n/a }
351607n/a ]
361607n/a }
37173922 },
3817556 "required": [
3917556 "payload"
4017556 ],
4117615 "type": "object"
42173333}
Referenced Components (38)201 of 335 keywords
AnyVariants3 of 9 keywords
1840{
2840 "anyOf": [
32856 {
42856 "items": {
51456 "type": "string"
62856 },
7840 "type": "array",
8840 "uniqueItems": true
92856 },
107014 {
117014 "items": {
125614 "format": "int64",
135614 "type": "integer"
147014 },
15840 "type": "array",
16840 "uniqueItems": true
177014 }
18840 ]
19840}
Condition10 of 10 keywords
115325241{
215325241 "anyOf": [
38755898 {
48755898 "$ref": "#/components/schemas/FieldCondition"
58755898 },
676766 {
776766 "$ref": "#/components/schemas/IsEmptyCondition"
876766 },
976766 {
1076766 "$ref": "#/components/schemas/IsNullCondition"
1176766 },
12596714 {
13596714 "$ref": "#/components/schemas/HasIdCondition"
14596714 },
1576766 {
1676766 "$ref": "#/components/schemas/HasVectorCondition"
1776766 },
18216752 {
19216752 "$ref": "#/components/schemas/SliceCondition"
20216752 },
212576516 {
222576516 "$ref": "#/components/schemas/NestedCondition"
232576516 },
242996474 {
252996474 "$ref": "#/components/schemas/Filter"
262996474 }
2715325241 ]
2815325241}
DatetimeRange11 of 15 keywords
1133651{
212628 "properties": {
31057 "gt": {
4490 "format": "date-time",
5112n/a "nullable": true,
61057 "type": "string"
71057 },
81057 "gte": {
9490 "format": "date-time",
10112n/a "nullable": true,
111057 "type": "string"
121057 },
13917 "lt": {
14420 "format": "date-time",
1598n/a "nullable": true,
16917 "type": "string"
17917 },
18777 "lte": {
19350 "format": "date-time",
2084n/a "nullable": true,
21777 "type": "string"
22777 }
2312628 },
24161623 "type": "object"
25133651}
ExtendedPointId6 of 7 keywords
123410{
223410 "anyOf": [
383161 {
400 "format": "uint64",
5841 "minimum": 0,
684160 "type": "integer"
783161 },
815193 {
91512 "format": "uuid",
1015391 "type": "string"
1115193 }
1223410 ],
1323410}
FieldCondition33 of 34 keywords
18755898{
287514 "properties": {
3819n/a "geo_bounding_box": {
4819n/a "anyOf": [
57812 {
67812 "$ref": "#/components/schemas/GeoBoundingBox"
77812 },
8819n/a {
9819n/a "nullable": true
10819n/a }
11819n/a ],
12819n/a },
13819n/a "geo_polygon": {
14819n/a "anyOf": [
1542777 {
1642777 "$ref": "#/components/schemas/GeoPolygon"
1742777 },
18819n/a {
19819n/a "nullable": true
20819n/a }
21819n/a ],
22819n/a },
23812n/a "geo_radius": {
24812n/a "anyOf": [
257805 {
267805 "$ref": "#/components/schemas/GeoRadius"
277805 },
28812n/a {
29812n/a "nullable": true
30812n/a }
31812n/a ],
32812n/a },
338057 "is_empty": {
34812n/a "nullable": true,
358057 "type": "boolean"
368057 },
377987 "is_null": {
38805n/a "nullable": true,
397987 "type": "boolean"
407987 },
418750 "key": {
428750 "type": "string"
438750 },
44791n/a "match": {
45791n/a "anyOf": [
46168623 {
47168623 "$ref": "#/components/schemas/Match"
48168623 },
49791n/a {
50791n/a "nullable": true
51791n/a }
52791n/a ],
53791n/a },
54784n/a "range": {
55784n/a "anyOf": [
56133651 {
57133651 "$ref": "#/components/schemas/RangeInterface"
58133651 },
59784n/a {
60784n/a "nullable": true
61784n/a }
62784n/a ],
63784n/a },
64777n/a "values_count": {
65777n/a "anyOf": [
66112665 {
67112665 "$ref": "#/components/schemas/ValuesCount"
68112665 },
69777n/a {
70777n/a "nullable": true
71777n/a }
72777n/a ],
73777n/a }
7487514 },
75875657 "required": [
76875657 "key"
77875657 ],
7815325241 "type": "object"
798755898}
Filter25 of 25 keywords
120626577{
2n/a1233 "additionalProperties": false,
32005n/a "properties": {
41960n/a "min_should": {
51960n/a "anyOf": [
62381722 {
72381722 "$ref": "#/components/schemas/MinShould"
82381722 },
91960n/a {
101960n/a "nullable": true
111960n/a }
121960n/a ],
131960n/a },
141960n/a "must": {
151960n/a "anyOf": [
162281732 {
172281732 "$ref": "#/components/schemas/Condition"
182281732 },
192271733 {
2022715 "items": {
2121230 "$ref": "#/components/schemas/Condition"
2222715 },
232421718 "type": "array"
242271733 },
251960n/a {
261960n/a "nullable": true
271960n/a }
281960n/a ],
291960n/a },
301945n/a "must_not": {
311945n/a "anyOf": [
322281717 {
332281717 "$ref": "#/components/schemas/Condition"
342281717 },
352271718 {
3622715 "items": {
3721230 "$ref": "#/components/schemas/Condition"
3822715 },
392421703 "type": "array"
402271718 },
411945n/a {
421945n/a "nullable": true
431945n/a }
441945n/a ],
451945n/a },
461930n/a "should": {
471930n/a "anyOf": [
482281702 {
492281702 "$ref": "#/components/schemas/Condition"
502281702 },
512271703 {
5222715 "items": {
5321230 "$ref": "#/components/schemas/Condition"
5422715 },
552421688 "type": "array"
562271703 },
571930n/a {
581930n/a "nullable": true
591930n/a }
601930n/a ],
611930n/a }
622005n/a },
6332955344 "type": "object"
6420626577}
GeoBoundingBox3 of 7 keywords
17812{
270 "properties": {
370 "bottom_right": {
470 "$ref": "#/components/schemas/GeoPoint"
570 },
670 "top_left": {
770 "$ref": "#/components/schemas/GeoPoint"
870 }
970 },
1077 "required": [
1177 "bottom_right",
1277 "top_left"
1377 ],
1414805 "type": "object"
157812}
GeoLineString0 of 7 keywords
1560{
2560 "properties": {
3560 "points": {
4560 "items": {
5140 "$ref": "#/components/schemas/GeoPoint"
6560 },
7560 "type": "array"
8560 }
9560 },
10560 "required": [
11560 "points"
12560 ],
13560 "type": "object"
14560}
GeoPoint0 of 9 keywords
1350{
2350 "properties": {
3350 "lat": {
4350 "format": "double",
5350 "type": "number"
6350 },
7350 "lon": {
8350 "format": "double",
9350 "type": "number"
10350 }
11350 },
12350 "required": [
13350 "lat",
14350 "lon"
15350 ],
16350 "type": "object"
17350}
GeoPolygon4 of 9 keywords
142777{
2420 "properties": {
3420 "exterior": {
4420 "$ref": "#/components/schemas/GeoLineString"
5420 },
6350 "interiors": {
7280 "items": {
8140 "$ref": "#/components/schemas/GeoLineString"
9280 },
1035n/a "nullable": true,
11350 "type": "array"
12350 }
13420 },
14427 "required": [
15427 "exterior"
16427 ],
1749770 "type": "object"
1842777}
GeoRadius3 of 8 keywords
17805{
270 "properties": {
370 "center": {
470 "$ref": "#/components/schemas/GeoPoint"
570 },
670 "radius": {
770 "format": "double",
870 "type": "number"
970 }
1070 },
1177 "required": [
1277 "center",
1377 "radius"
1477 ],
1514798 "type": "object"
167805}
HasIdCondition3 of 8 keywords
1596714{
2590 "properties": {
3590 "has_id": {
4590 "items": {
5520 "$ref": "#/components/schemas/ExtendedPointId"
6590 },
7590 "type": "array",
8590 "uniqueItems": true
9590 }
10590 },
11591473 "required": [
12591473 "has_id"
13591473 ],
1415325241 "type": "object"
15596714}
HasVectorCondition3 of 6 keywords
176766{
270 "properties": {
370 "has_vector": {
470 "type": "string"
570 }
670 },
771525 "required": [
871525 "has_vector"
971525 ],
1015325241 "type": "object"
1176766}
IsEmptyCondition6 of 6 keywords
176766{
27805 "properties": {
37805 "is_empty": {
47805 "$ref": "#/components/schemas/PayloadField"
57805 }
67805 },
7812720 "required": [
8812720 "is_empty"
9812720 ],
1015325241 "type": "object"
1176766}
IsNullCondition6 of 6 keywords
176766{
27798 "properties": {
37798 "is_null": {
47798 "$ref": "#/components/schemas/PayloadField"
57798 }
67798 },
7805727 "required": [
8805727 "is_null"
9805727 ],
1015325241 "type": "object"
1176766}
Match10 of 10 keywords
1168623{
2168623 "anyOf": [
349742 {
449742 "$ref": "#/components/schemas/MatchValue"
549742 },
67784 {
77784 "$ref": "#/components/schemas/MatchText"
87784 },
97784 {
107784 "$ref": "#/components/schemas/MatchTextAny"
117784 },
127784 {
137784 "$ref": "#/components/schemas/MatchPhrase"
147784 },
157784 {
167784 "$ref": "#/components/schemas/MatchPrefix"
177784 },
187784 {
197784 "$ref": "#/components/schemas/MatchSubstring"
207784 },
2142749 {
2242749 "$ref": "#/components/schemas/MatchAny"
2342749 },
2442749 {
2542749 "$ref": "#/components/schemas/MatchExcept"
2642749 }
27168623 ],
28168623}
MatchAny3 of 6 keywords
142749{
2420 "properties": {
3420 "any": {
4420 "$ref": "#/components/schemas/AnyVariants"
5420 }
6420 },
742133 "required": [
842133 "any"
942133 ],
10175616 "type": "object"
1142749}
MatchExcept3 of 6 keywords
142749{
2420 "properties": {
3420 "except": {
4420 "$ref": "#/components/schemas/AnyVariants"
5420 }
6420 },
742133 "required": [
842133 "except"
942133 ],
10175616 "type": "object"
1142749}
MatchPhrase3 of 6 keywords
17784{
270 "properties": {
370 "phrase": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "phrase"
97168 ],
10175616 "type": "object"
117784}
MatchPrefix3 of 6 keywords
17784{
270 "properties": {
370 "prefix": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "prefix"
97168 ],
10175616 "type": "object"
117784}
MatchSubstring3 of 6 keywords
17784{
270 "properties": {
370 "substring": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "substring"
97168 ],
10175616 "type": "object"
117784}
MatchText3 of 6 keywords
17784{
270 "properties": {
370 "text": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "text"
97168 ],
10175616 "type": "object"
117784}
MatchTextAny3 of 6 keywords
17784{
270 "properties": {
370 "text_any": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "text_any"
97168 ],
10175616 "type": "object"
117784}
MatchValue3 of 6 keywords
149742{
2490 "properties": {
3490 "value": {
4490 "$ref": "#/components/schemas/ValueVariants"
5490 }
6490 },
749126 "required": [
849126 "value"
949126 ],
10175616 "type": "object"
1149742}
MinShould3 of 10 keywords
12381722{
22380 "properties": {
32380 "conditions": {
42380 "items": {
52120 "$ref": "#/components/schemas/Condition"
62380 },
72380 "type": "array"
82380 },
92380 "min_count": {
1000 "format": "uint",
112380 "minimum": 1,
122380 "type": "integer"
132380 }
142380 },
1523815 "required": [
1623815 "conditions",
1723815 "min_count"
1823815 ],
192531707 "type": "object"
202381722}
Nested0 of 7 keywords
12570{
22570 "properties": {
32570 "filter": {
42570 "$ref": "#/components/schemas/Filter"
52570 },
62570 "key": {
72570 "type": "string"
82570 }
92570 },
102570 "required": [
112570 "filter",
122570 "key"
132570 ],
142570 "type": "object"
152570}
NestedCondition3 of 6 keywords
12576516{
22570 "properties": {
32570 "nested": {
42570 "$ref": "#/components/schemas/Nested"
52570 }
62570 },
72571275 "required": [
82571275 "nested"
92571275 ],
1015325241 "type": "object"
112576516}
Payload2 of 2 keywords
117505{
21n/a "additionalProperties": true,
317505 "type": "object"
417505}
PayloadField1 of 6 keywords
1141603{
2140 "properties": {
3140 "key": {
4140 "type": "string"
5140 }
6140 },
7140 "required": [
8140 "key"
9140 ],
10141603 "type": "object"
11141603}
Range13 of 15 keywords
17777{
20154 "properties": {
37105 "gt": {
47105 "format": "double",
5112n/a "nullable": true,
66349 "type": "number"
77105 },
87105 "gte": {
97105 "format": "double",
10112n/a "nullable": true,
116349 "type": "number"
127105 },
13791 "lt": {
14791 "format": "double",
1598n/a "nullable": true,
165642 "type": "number"
17791 },
18777 "lte": {
19777 "format": "double",
2084n/a "nullable": true,
214935 "type": "number"
22777 }
230154 },
24161623 "type": "object"
257777}
RangeInterface4 of 4 keywords
1133651{
2133651 "anyOf": [
37777 {
47777 "$ref": "#/components/schemas/Range"
57777 },
6133651 {
7133651 "$ref": "#/components/schemas/DatetimeRange"
8133651 }
9133651 ]
10133651}
ShardKey4 of 6 keywords
1351602{
2351602 "anyOf": [
3191618 {
4191618 "type": "string"
5191618 },
6161621 {
700 "format": "uint64",
8160 "minimum": 0,
9161621 "type": "integer"
10161621 }
11351602 ]
12351602}
ShardKeySelector6 of 6 keywords
1251582{
2251582 "anyOf": [
371600 {
471600 "$ref": "#/components/schemas/ShardKey"
571600 },
671600 {
771 "items": {
862 "$ref": "#/components/schemas/ShardKey"
971 },
1081599 "type": "array"
1171600 },
12111596 {
13111596 "$ref": "#/components/schemas/ShardKeyWithFallback"
14111596 }
15251582 ]
16251582}
ShardKeyWithFallback3 of 7 keywords
1111596{
2110 "properties": {
3110 "fallback": {
4110 "$ref": "#/components/schemas/ShardKey"
5110 },
6110 "target": {
7110 "$ref": "#/components/schemas/ShardKey"
8110 }
9110 },
10111 "required": [
11111 "fallback",
12111 "target"
13111 ],
14121595 "type": "object"
15111596}
Slice0 of 11 keywords
1210{
2210 "properties": {
3210 "index": {
400 "format": "uint32",
5210 "minimum": 0,
6210 "type": "integer"
7210 },
8210 "total": {
900 "format": "uint32",
10210 "minimum": 1,
11210 "type": "integer"
12210 }
13210 },
14210 "required": [
15210 "index",
16210 "total"
17210 ],
18210 "type": "object"
19210}
SliceCondition3 of 6 keywords
1216752{
2210 "properties": {
3210 "slice": {
4210 "$ref": "#/components/schemas/Slice"
5210 }
6210 },
7211511 "required": [
8211511 "slice"
9211511 ],
1015325241 "type": "object"
11216752}
ValueVariants4 of 6 keywords
1490{
2490 "anyOf": [
3742 {
4742 "type": "string"
5742 },
62821 {
72821 "format": "int64",
82821 "type": "integer"
92821 },
101435 {
111435 "type": "boolean"
121435 }
13490 ]
14490}
ValuesCount5 of 19 keywords
1112665{
21050 "properties": {
3840 "gt": {
400 "format": "uint",
5770 "minimum": 0,
684n/a "nullable": true,
7840 "type": "integer"
8840 },
9840 "gte": {
1000 "format": "uint",
11770 "minimum": 0,
1284n/a "nullable": true,
13840 "type": "integer"
14840 },
15770 "lt": {
1600 "format": "uint",
17700 "minimum": 0,
1877n/a "nullable": true,
19770 "type": "integer"
20770 },
21700 "lte": {
2200 "format": "uint",
23630 "minimum": 0,
2470n/a "nullable": true,
25700 "type": "integer"
26700 }
271050 },
28112665 "type": "object"
29112665}
Responses2 of 3 documented received
codedescriptionhitsavg
200successful operation531ms
4XXerror17820ms
defaulterror0-
Examples5 / 5 used
Body: application/json
42ExtendedPointId
"550e8400-e29b-41d4-a716-446655440000"ExtendedPointId
{ "city": "London", "color": "green" }Payload
"region_1"ShardKey
12ShardKey
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
11835n/a{
21835n/a "type": "string"
31835n/a}
Query Parameters5 of 5 keywords covered
wait1 / 1
1162323{
2162323 "type": "boolean"
3162323}
ordering2 / 2
WriteOrdering
1162328{
2162328 "enum": [
31602n/a "weak",
49n/a "medium",
512n/a "strong"
6162328 ],
71651n/a "type": "string"
8162328}
timeout2 / 2
1162924{
216295 "minimum": 1,
3163419 "type": "integer"
4162924}
Body175 of 278 keywords covered
application/json175 / 278
SetPayload
1177129{
2177322 "properties": {
31609n/a "filter": {
41609n/a "anyOf": [
51506103 {
61506103 "$ref": "#/components/schemas/Filter"
71506103 },
81609n/a {
91609n/a "nullable": true
101609n/a }
111609n/a ],
121609n/a },
1317414 "key": {
141745n/a "nullable": true,
1517414 "type": "string"
1617414 },
1717885 "payload": {
1817885 "$ref": "#/components/schemas/Payload"
1917885 },
20173413 "points": {
2117219 "items": {
2279810 "$ref": "#/components/schemas/ExtendedPointId"
2317219 },
241747n/a "nullable": true,
2517434 "type": "array"
26173413 },
271607n/a "shard_key": {
281607n/a "anyOf": [
29251582 {
30251582 "$ref": "#/components/schemas/ShardKeySelector"
31251582 },
321607n/a {
331607n/a "nullable": true
341607n/a }
351607n/a ]
361607n/a }
37177322 },
3817932 "required": [
3917932 "payload"
4017932 ],
4117955 "type": "object"
42177129}
Referenced Components (38)201 of 335 keywords
AnyVariants3 of 9 keywords
1840{
2840 "anyOf": [
32856 {
42856 "items": {
51456 "type": "string"
62856 },
7840 "type": "array",
8840 "uniqueItems": true
92856 },
107014 {
117014 "items": {
125614 "format": "int64",
135614 "type": "integer"
147014 },
15840 "type": "array",
16840 "uniqueItems": true
177014 }
18840 ]
19840}
Condition10 of 10 keywords
115325241{
215325241 "anyOf": [
38755898 {
48755898 "$ref": "#/components/schemas/FieldCondition"
58755898 },
676766 {
776766 "$ref": "#/components/schemas/IsEmptyCondition"
876766 },
976766 {
1076766 "$ref": "#/components/schemas/IsNullCondition"
1176766 },
12596714 {
13596714 "$ref": "#/components/schemas/HasIdCondition"
14596714 },
1576766 {
1676766 "$ref": "#/components/schemas/HasVectorCondition"
1776766 },
18216752 {
19216752 "$ref": "#/components/schemas/SliceCondition"
20216752 },
212576516 {
222576516 "$ref": "#/components/schemas/NestedCondition"
232576516 },
242996474 {
252996474 "$ref": "#/components/schemas/Filter"
262996474 }
2715325241 ]
2815325241}
DatetimeRange11 of 15 keywords
1133651{
212628 "properties": {
31057 "gt": {
4490 "format": "date-time",
5112n/a "nullable": true,
61057 "type": "string"
71057 },
81057 "gte": {
9490 "format": "date-time",
10112n/a "nullable": true,
111057 "type": "string"
121057 },
13917 "lt": {
14420 "format": "date-time",
1598n/a "nullable": true,
16917 "type": "string"
17917 },
18777 "lte": {
19350 "format": "date-time",
2084n/a "nullable": true,
21777 "type": "string"
22777 }
2312628 },
24161623 "type": "object"
25133651}
ExtendedPointId6 of 7 keywords
185010{
285010 "anyOf": [
3508352 {
400 "format": "uint64",
55091 "minimum": 0,
6509351 "type": "integer"
7508352 },
8342518 {
93422 "format": "uuid",
10344516 "type": "string"
11342518 }
1285010 ],
1385010}
FieldCondition33 of 34 keywords
18755898{
287514 "properties": {
3819n/a "geo_bounding_box": {
4819n/a "anyOf": [
57812 {
67812 "$ref": "#/components/schemas/GeoBoundingBox"
77812 },
8819n/a {
9819n/a "nullable": true
10819n/a }
11819n/a ],
12819n/a },
13819n/a "geo_polygon": {
14819n/a "anyOf": [
1542777 {
1642777 "$ref": "#/components/schemas/GeoPolygon"
1742777 },
18819n/a {
19819n/a "nullable": true
20819n/a }
21819n/a ],
22819n/a },
23812n/a "geo_radius": {
24812n/a "anyOf": [
257805 {
267805 "$ref": "#/components/schemas/GeoRadius"
277805 },
28812n/a {
29812n/a "nullable": true
30812n/a }
31812n/a ],
32812n/a },
338057 "is_empty": {
34812n/a "nullable": true,
358057 "type": "boolean"
368057 },
377987 "is_null": {
38805n/a "nullable": true,
397987 "type": "boolean"
407987 },
418750 "key": {
428750 "type": "string"
438750 },
44791n/a "match": {
45791n/a "anyOf": [
46168623 {
47168623 "$ref": "#/components/schemas/Match"
48168623 },
49791n/a {
50791n/a "nullable": true
51791n/a }
52791n/a ],
53791n/a },
54784n/a "range": {
55784n/a "anyOf": [
56133651 {
57133651 "$ref": "#/components/schemas/RangeInterface"
58133651 },
59784n/a {
60784n/a "nullable": true
61784n/a }
62784n/a ],
63784n/a },
64777n/a "values_count": {
65777n/a "anyOf": [
66112665 {
67112665 "$ref": "#/components/schemas/ValuesCount"
68112665 },
69777n/a {
70777n/a "nullable": true
71777n/a }
72777n/a ],
73777n/a }
7487514 },
75875657 "required": [
76875657 "key"
77875657 ],
7815325241 "type": "object"
798755898}
Filter25 of 25 keywords
120626577{
2n/a1233 "additionalProperties": false,
32005n/a "properties": {
41960n/a "min_should": {
51960n/a "anyOf": [
62381722 {
72381722 "$ref": "#/components/schemas/MinShould"
82381722 },
91960n/a {
101960n/a "nullable": true
111960n/a }
121960n/a ],
131960n/a },
141960n/a "must": {
151960n/a "anyOf": [
162281732 {
172281732 "$ref": "#/components/schemas/Condition"
182281732 },
192271733 {
2022715 "items": {
2121230 "$ref": "#/components/schemas/Condition"
2222715 },
232421718 "type": "array"
242271733 },
251960n/a {
261960n/a "nullable": true
271960n/a }
281960n/a ],
291960n/a },
301945n/a "must_not": {
311945n/a "anyOf": [
322281717 {
332281717 "$ref": "#/components/schemas/Condition"
342281717 },
352271718 {
3622715 "items": {
3721230 "$ref": "#/components/schemas/Condition"
3822715 },
392421703 "type": "array"
402271718 },
411945n/a {
421945n/a "nullable": true
431945n/a }
441945n/a ],
451945n/a },
461930n/a "should": {
471930n/a "anyOf": [
482281702 {
492281702 "$ref": "#/components/schemas/Condition"
502281702 },
512271703 {
5222715 "items": {
5321230 "$ref": "#/components/schemas/Condition"
5422715 },
552421688 "type": "array"
562271703 },
571930n/a {
581930n/a "nullable": true
591930n/a }
601930n/a ],
611930n/a }
622005n/a },
6332955344 "type": "object"
6420626577}
GeoBoundingBox3 of 7 keywords
17812{
270 "properties": {
370 "bottom_right": {
470 "$ref": "#/components/schemas/GeoPoint"
570 },
670 "top_left": {
770 "$ref": "#/components/schemas/GeoPoint"
870 }
970 },
1077 "required": [
1177 "bottom_right",
1277 "top_left"
1377 ],
1414805 "type": "object"
157812}
GeoLineString0 of 7 keywords
1560{
2560 "properties": {
3560 "points": {
4560 "items": {
5140 "$ref": "#/components/schemas/GeoPoint"
6560 },
7560 "type": "array"
8560 }
9560 },
10560 "required": [
11560 "points"
12560 ],
13560 "type": "object"
14560}
GeoPoint0 of 9 keywords
1350{
2350 "properties": {
3350 "lat": {
4350 "format": "double",
5350 "type": "number"
6350 },
7350 "lon": {
8350 "format": "double",
9350 "type": "number"
10350 }
11350 },
12350 "required": [
13350 "lat",
14350 "lon"
15350 ],
16350 "type": "object"
17350}
GeoPolygon4 of 9 keywords
142777{
2420 "properties": {
3420 "exterior": {
4420 "$ref": "#/components/schemas/GeoLineString"
5420 },
6350 "interiors": {
7280 "items": {
8140 "$ref": "#/components/schemas/GeoLineString"
9280 },
1035n/a "nullable": true,
11350 "type": "array"
12350 }
13420 },
14427 "required": [
15427 "exterior"
16427 ],
1749770 "type": "object"
1842777}
GeoRadius3 of 8 keywords
17805{
270 "properties": {
370 "center": {
470 "$ref": "#/components/schemas/GeoPoint"
570 },
670 "radius": {
770 "format": "double",
870 "type": "number"
970 }
1070 },
1177 "required": [
1277 "center",
1377 "radius"
1477 ],
1514798 "type": "object"
167805}
HasIdCondition3 of 8 keywords
1596714{
2590 "properties": {
3590 "has_id": {
4590 "items": {
5520 "$ref": "#/components/schemas/ExtendedPointId"
6590 },
7590 "type": "array",
8590 "uniqueItems": true
9590 }
10590 },
11591473 "required": [
12591473 "has_id"
13591473 ],
1415325241 "type": "object"
15596714}
HasVectorCondition3 of 6 keywords
176766{
270 "properties": {
370 "has_vector": {
470 "type": "string"
570 }
670 },
771525 "required": [
871525 "has_vector"
971525 ],
1015325241 "type": "object"
1176766}
IsEmptyCondition6 of 6 keywords
176766{
27805 "properties": {
37805 "is_empty": {
47805 "$ref": "#/components/schemas/PayloadField"
57805 }
67805 },
7812720 "required": [
8812720 "is_empty"
9812720 ],
1015325241 "type": "object"
1176766}
IsNullCondition6 of 6 keywords
176766{
27798 "properties": {
37798 "is_null": {
47798 "$ref": "#/components/schemas/PayloadField"
57798 }
67798 },
7805727 "required": [
8805727 "is_null"
9805727 ],
1015325241 "type": "object"
1176766}
Match10 of 10 keywords
1168623{
2168623 "anyOf": [
349742 {
449742 "$ref": "#/components/schemas/MatchValue"
549742 },
67784 {
77784 "$ref": "#/components/schemas/MatchText"
87784 },
97784 {
107784 "$ref": "#/components/schemas/MatchTextAny"
117784 },
127784 {
137784 "$ref": "#/components/schemas/MatchPhrase"
147784 },
157784 {
167784 "$ref": "#/components/schemas/MatchPrefix"
177784 },
187784 {
197784 "$ref": "#/components/schemas/MatchSubstring"
207784 },
2142749 {
2242749 "$ref": "#/components/schemas/MatchAny"
2342749 },
2442749 {
2542749 "$ref": "#/components/schemas/MatchExcept"
2642749 }
27168623 ],
28168623}
MatchAny3 of 6 keywords
142749{
2420 "properties": {
3420 "any": {
4420 "$ref": "#/components/schemas/AnyVariants"
5420 }
6420 },
742133 "required": [
842133 "any"
942133 ],
10175616 "type": "object"
1142749}
MatchExcept3 of 6 keywords
142749{
2420 "properties": {
3420 "except": {
4420 "$ref": "#/components/schemas/AnyVariants"
5420 }
6420 },
742133 "required": [
842133 "except"
942133 ],
10175616 "type": "object"
1142749}
MatchPhrase3 of 6 keywords
17784{
270 "properties": {
370 "phrase": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "phrase"
97168 ],
10175616 "type": "object"
117784}
MatchPrefix3 of 6 keywords
17784{
270 "properties": {
370 "prefix": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "prefix"
97168 ],
10175616 "type": "object"
117784}
MatchSubstring3 of 6 keywords
17784{
270 "properties": {
370 "substring": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "substring"
97168 ],
10175616 "type": "object"
117784}
MatchText3 of 6 keywords
17784{
270 "properties": {
370 "text": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "text"
97168 ],
10175616 "type": "object"
117784}
MatchTextAny3 of 6 keywords
17784{
270 "properties": {
370 "text_any": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "text_any"
97168 ],
10175616 "type": "object"
117784}
MatchValue3 of 6 keywords
149742{
2490 "properties": {
3490 "value": {
4490 "$ref": "#/components/schemas/ValueVariants"
5490 }
6490 },
749126 "required": [
849126 "value"
949126 ],
10175616 "type": "object"
1149742}
MinShould3 of 10 keywords
12381722{
22380 "properties": {
32380 "conditions": {
42380 "items": {
52120 "$ref": "#/components/schemas/Condition"
62380 },
72380 "type": "array"
82380 },
92380 "min_count": {
1000 "format": "uint",
112380 "minimum": 1,
122380 "type": "integer"
132380 }
142380 },
1523815 "required": [
1623815 "conditions",
1723815 "min_count"
1823815 ],
192531707 "type": "object"
202381722}
Nested0 of 7 keywords
12570{
22570 "properties": {
32570 "filter": {
42570 "$ref": "#/components/schemas/Filter"
52570 },
62570 "key": {
72570 "type": "string"
82570 }
92570 },
102570 "required": [
112570 "filter",
122570 "key"
132570 ],
142570 "type": "object"
152570}
NestedCondition3 of 6 keywords
12576516{
22570 "properties": {
32570 "nested": {
42570 "$ref": "#/components/schemas/Nested"
52570 }
62570 },
72571275 "required": [
82571275 "nested"
92571275 ],
1015325241 "type": "object"
112576516}
Payload2 of 2 keywords
117885{
21n/a "additionalProperties": true,
317885 "type": "object"
417885}
PayloadField1 of 6 keywords
1141603{
2140 "properties": {
3140 "key": {
4140 "type": "string"
5140 }
6140 },
7140 "required": [
8140 "key"
9140 ],
10141603 "type": "object"
11141603}
Range13 of 15 keywords
17777{
20154 "properties": {
37105 "gt": {
47105 "format": "double",
5112n/a "nullable": true,
66349 "type": "number"
77105 },
87105 "gte": {
97105 "format": "double",
10112n/a "nullable": true,
116349 "type": "number"
127105 },
13791 "lt": {
14791 "format": "double",
1598n/a "nullable": true,
165642 "type": "number"
17791 },
18777 "lte": {
19777 "format": "double",
2084n/a "nullable": true,
214935 "type": "number"
22777 }
230154 },
24161623 "type": "object"
257777}
RangeInterface4 of 4 keywords
1133651{
2133651 "anyOf": [
37777 {
47777 "$ref": "#/components/schemas/Range"
57777 },
6133651 {
7133651 "$ref": "#/components/schemas/DatetimeRange"
8133651 }
9133651 ]
10133651}
ShardKey4 of 6 keywords
1351602{
2351602 "anyOf": [
3191618 {
4191618 "type": "string"
5191618 },
6161621 {
700 "format": "uint64",
8160 "minimum": 0,
9161621 "type": "integer"
10161621 }
11351602 ]
12351602}
ShardKeySelector6 of 6 keywords
1251582{
2251582 "anyOf": [
371600 {
471600 "$ref": "#/components/schemas/ShardKey"
571600 },
671600 {
771 "items": {
862 "$ref": "#/components/schemas/ShardKey"
971 },
1081599 "type": "array"
1171600 },
12111596 {
13111596 "$ref": "#/components/schemas/ShardKeyWithFallback"
14111596 }
15251582 ]
16251582}
ShardKeyWithFallback3 of 7 keywords
1111596{
2110 "properties": {
3110 "fallback": {
4110 "$ref": "#/components/schemas/ShardKey"
5110 },
6110 "target": {
7110 "$ref": "#/components/schemas/ShardKey"
8110 }
9110 },
10111 "required": [
11111 "fallback",
12111 "target"
13111 ],
14121595 "type": "object"
15111596}
Slice0 of 11 keywords
1210{
2210 "properties": {
3210 "index": {
400 "format": "uint32",
5210 "minimum": 0,
6210 "type": "integer"
7210 },
8210 "total": {
900 "format": "uint32",
10210 "minimum": 1,
11210 "type": "integer"
12210 }
13210 },
14210 "required": [
15210 "index",
16210 "total"
17210 ],
18210 "type": "object"
19210}
SliceCondition3 of 6 keywords
1216752{
2210 "properties": {
3210 "slice": {
4210 "$ref": "#/components/schemas/Slice"
5210 }
6210 },
7211511 "required": [
8211511 "slice"
9211511 ],
1015325241 "type": "object"
11216752}
ValueVariants4 of 6 keywords
1490{
2490 "anyOf": [
3742 {
4742 "type": "string"
5742 },
62821 {
72821 "format": "int64",
82821 "type": "integer"
92821 },
101435 {
111435 "type": "boolean"
121435 }
13490 ]
14490}
ValuesCount5 of 19 keywords
1112665{
21050 "properties": {
3840 "gt": {
400 "format": "uint",
5770 "minimum": 0,
684n/a "nullable": true,
7840 "type": "integer"
8840 },
9840 "gte": {
1000 "format": "uint",
11770 "minimum": 0,
1284n/a "nullable": true,
13840 "type": "integer"
14840 },
15770 "lt": {
1600 "format": "uint",
17700 "minimum": 0,
1877n/a "nullable": true,
19770 "type": "integer"
20770 },
21700 "lte": {
2200 "format": "uint",
23630 "minimum": 0,
2470n/a "nullable": true,
25700 "type": "integer"
26700 }
271050 },
28112665 "type": "object"
29112665}
Responses2 of 3 documented received
codedescriptionhitsavg
200successful operation1110ms
4XXerror17240ms
defaulterror0-
Examples5 / 5 used
Body: application/json
42ExtendedPointId
"550e8400-e29b-41d4-a716-446655440000"ExtendedPointId
{ "city": "London", "color": "green" }Payload
"region_1"ShardKey
12ShardKey
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
11851n/a{
21851n/a "type": "string"
31851n/a}
Query Parameters5 of 5 keywords covered
wait1 / 1
1169723{
2169723 "type": "boolean"
3169723}
ordering2 / 2
WriteOrdering
1171116{
2171116 "enum": [
31674n/a "weak",
427n/a "medium",
510n/a "strong"
6171116 ],
71727n/a "type": "string"
8171116}
timeout2 / 2
1169821{
216985 "minimum": 1,
3170316 "type": "integer"
4169821}
Body176 of 279 keywords covered
application/json176 / 279
PointsSelector
1180127{
2180127 "anyOf": [
31931635 {
41931635 "$ref": "#/components/schemas/PointIdsList"
51931635 },
61608220 {
71608220 "$ref": "#/components/schemas/FilterSelector"
81608220 }
9180127 ]
10180127}
Referenced Components (39)220 of 354 keywords
AnyVariants3 of 9 keywords
1840{
2840 "anyOf": [
32856 {
42856 "items": {
51456 "type": "string"
62856 },
7840 "type": "array",
8840 "uniqueItems": true
92856 },
107014 {
117014 "items": {
125614 "format": "int64",
135614 "type": "integer"
147014 },
15840 "type": "array",
16840 "uniqueItems": true
177014 }
18840 ]
19840}
Condition10 of 10 keywords
115385363{
215385363 "anyOf": [
38756026 {
48756026 "$ref": "#/components/schemas/FieldCondition"
58756026 },
676894 {
776894 "$ref": "#/components/schemas/IsEmptyCondition"
876894 },
976894 {
1076894 "$ref": "#/components/schemas/IsNullCondition"
1176894 },
12596842 {
13596842 "$ref": "#/components/schemas/HasIdCondition"
14596842 },
1576894 {
1676894 "$ref": "#/components/schemas/HasVectorCondition"
1776894 },
18216880 {
19216880 "$ref": "#/components/schemas/SliceCondition"
20216880 },
212576644 {
222576644 "$ref": "#/components/schemas/NestedCondition"
232576644 },
243056596 {
253056596 "$ref": "#/components/schemas/Filter"
263056596 }
2715385363 ]
2815385363}
DatetimeRange11 of 15 keywords
1133651{
212628 "properties": {
31057 "gt": {
4490 "format": "date-time",
5112n/a "nullable": true,
61057 "type": "string"
71057 },
81057 "gte": {
9490 "format": "date-time",
10112n/a "nullable": true,
111057 "type": "string"
121057 },
13917 "lt": {
14420 "format": "date-time",
1598n/a "nullable": true,
16917 "type": "string"
17917 },
18777 "lte": {
19350 "format": "date-time",
2084n/a "nullable": true,
21777 "type": "string"
22777 }
2312628 },
24161623 "type": "object"
25133651}
ExtendedPointId6 of 7 keywords
13698{
23698 "anyOf": [
3187190 {
400 "format": "uint64",
51881 "minimum": 0,
6188189 "type": "integer"
7187190 },
8182195 {
91822 "format": "uuid",
10184193 "type": "string"
11182195 }
123698 ],
133698}
FieldCondition33 of 34 keywords
18756026{
287514 "properties": {
3819n/a "geo_bounding_box": {
4819n/a "anyOf": [
57812 {
67812 "$ref": "#/components/schemas/GeoBoundingBox"
77812 },
8819n/a {
9819n/a "nullable": true
10819n/a }
11819n/a ],
12819n/a },
13819n/a "geo_polygon": {
14819n/a "anyOf": [
1542777 {
1642777 "$ref": "#/components/schemas/GeoPolygon"
1742777 },
18819n/a {
19819n/a "nullable": true
20819n/a }
21819n/a ],
22819n/a },
23812n/a "geo_radius": {
24812n/a "anyOf": [
257805 {
267805 "$ref": "#/components/schemas/GeoRadius"
277805 },
28812n/a {
29812n/a "nullable": true
30812n/a }
31812n/a ],
32812n/a },
338057 "is_empty": {
34812n/a "nullable": true,
358057 "type": "boolean"
368057 },
377987 "is_null": {
38805n/a "nullable": true,
397987 "type": "boolean"
407987 },
418750 "key": {
428750 "type": "string"
438750 },
44791n/a "match": {
45791n/a "anyOf": [
46168623 {
47168623 "$ref": "#/components/schemas/Match"
48168623 },
49791n/a {
50791n/a "nullable": true
51791n/a }
52791n/a ],
53791n/a },
54784n/a "range": {
55784n/a "anyOf": [
56133651 {
57133651 "$ref": "#/components/schemas/RangeInterface"
58133651 },
59784n/a {
60784n/a "nullable": true
61784n/a }
62784n/a ],
63784n/a },
64777n/a "values_count": {
65777n/a "anyOf": [
66112665 {
67112665 "$ref": "#/components/schemas/ValuesCount"
68112665 },
69777n/a {
70777n/a "nullable": true
71777n/a }
72777n/a ],
73777n/a }
7487514 },
75875675 "required": [
76875675 "key"
77875675 ],
7815505351 "type": "object"
798756026}
Filter25 of 25 keywords
121706601{
2n/a1245 "additionalProperties": false,
32053n/a "properties": {
42000n/a "min_should": {
52000n/a "anyOf": [
62381762 {
72381762 "$ref": "#/components/schemas/MinShould"
82381762 },
92000n/a {
102000n/a "nullable": true
112000n/a }
122000n/a ],
132000n/a },
141998n/a "must": {
151998n/a "anyOf": [
162281770 {
172281770 "$ref": "#/components/schemas/Condition"
182281770 },
192281770 {
2022817 "items": {
2121433 "$ref": "#/components/schemas/Condition"
2222817 },
232451753 "type": "array"
242281770 },
251998n/a {
261998n/a "nullable": true
271998n/a }
281998n/a ],
291998n/a },
301981n/a "must_not": {
311981n/a "anyOf": [
322311750 {
332311750 "$ref": "#/components/schemas/Condition"
342311750 },
352271754 {
3622722 "items": {
3721237 "$ref": "#/components/schemas/Condition"
3822722 },
392491732 "type": "array"
402271754 },
411981n/a {
421981n/a "nullable": true
431981n/a }
441981n/a ],
451981n/a },
461968n/a "should": {
471968n/a "anyOf": [
482291739 {
492291739 "$ref": "#/components/schemas/Condition"
502291739 },
512281740 {
5222817 "items": {
5321234 "$ref": "#/components/schemas/Condition"
5422817 },
552451723 "type": "array"
562281740 },
571968n/a {
581968n/a "nullable": true
591968n/a }
601968n/a ],
611968n/a }
622053n/a },
6334155356 "type": "object"
6421706601}
FilterSelector10 of 10 keywords
11608220{
216995 "properties": {
316085 "filter": {
416085 "$ref": "#/components/schemas/Filter"
516085 },
61625n/a "shard_key": {
71625n/a "anyOf": [
8501575 {
9501575 "$ref": "#/components/schemas/ShardKeySelector"
10501575 },
111625n/a {
121625n/a "nullable": true
131625n/a }
141625n/a ]
151625n/a }
1616995 },
171613208 "required": [
181613208 "filter"
191613208 ],
2018217 "type": "object"
211608220}
GeoBoundingBox3 of 7 keywords
17812{
270 "properties": {
370 "bottom_right": {
470 "$ref": "#/components/schemas/GeoPoint"
570 },
670 "top_left": {
770 "$ref": "#/components/schemas/GeoPoint"
870 }
970 },
1077 "required": [
1177 "bottom_right",
1277 "top_left"
1377 ],
1414805 "type": "object"
157812}
GeoLineString0 of 7 keywords
1560{
2560 "properties": {
3560 "points": {
4560 "items": {
5140 "$ref": "#/components/schemas/GeoPoint"
6560 },
7560 "type": "array"
8560 }
9560 },
10560 "required": [
11560 "points"
12560 ],
13560 "type": "object"
14560}
GeoPoint0 of 9 keywords
1350{
2350 "properties": {
3350 "lat": {
4350 "format": "double",
5350 "type": "number"
6350 },
7350 "lon": {
8350 "format": "double",
9350 "type": "number"
10350 }
11350 },
12350 "required": [
13350 "lat",
14350 "lon"
15350 ],
16350 "type": "object"
17350}
GeoPolygon4 of 9 keywords
142777{
2420 "properties": {
3420 "exterior": {
4420 "$ref": "#/components/schemas/GeoLineString"
5420 },
6350 "interiors": {
7280 "items": {
8140 "$ref": "#/components/schemas/GeoLineString"
9280 },
1035n/a "nullable": true,
11350 "type": "array"
12350 }
13420 },
14427 "required": [
15427 "exterior"
16427 ],
1749770 "type": "object"
1842777}
GeoRadius3 of 8 keywords
17805{
270 "properties": {
370 "center": {
470 "$ref": "#/components/schemas/GeoPoint"
570 },
670 "radius": {
770 "format": "double",
870 "type": "number"
970 }
1070 },
1177 "required": [
1277 "center",
1377 "radius"
1477 ],
1514798 "type": "object"
167805}
HasIdCondition3 of 8 keywords
1596842{
2590 "properties": {
3590 "has_id": {
4590 "items": {
5520 "$ref": "#/components/schemas/ExtendedPointId"
6590 },
7590 "type": "array",
8590 "uniqueItems": true
9590 }
10590 },
11591491 "required": [
12591491 "has_id"
13591491 ],
1415505351 "type": "object"
15596842}
HasVectorCondition3 of 6 keywords
176894{
270 "properties": {
370 "has_vector": {
470 "type": "string"
570 }
670 },
771543 "required": [
871543 "has_vector"
971543 ],
1015505351 "type": "object"
1176894}
IsEmptyCondition6 of 6 keywords
176894{
27805 "properties": {
37805 "is_empty": {
47805 "$ref": "#/components/schemas/PayloadField"
57805 }
67805 },
7812738 "required": [
8812738 "is_empty"
9812738 ],
1015505351 "type": "object"
1176894}
IsNullCondition6 of 6 keywords
176894{
27798 "properties": {
37798 "is_null": {
47798 "$ref": "#/components/schemas/PayloadField"
57798 }
67798 },
7805745 "required": [
8805745 "is_null"
9805745 ],
1015505351 "type": "object"
1176894}
Match10 of 10 keywords
1168623{
2168623 "anyOf": [
349742 {
449742 "$ref": "#/components/schemas/MatchValue"
549742 },
67784 {
77784 "$ref": "#/components/schemas/MatchText"
87784 },
97784 {
107784 "$ref": "#/components/schemas/MatchTextAny"
117784 },
127784 {
137784 "$ref": "#/components/schemas/MatchPhrase"
147784 },
157784 {
167784 "$ref": "#/components/schemas/MatchPrefix"
177784 },
187784 {
197784 "$ref": "#/components/schemas/MatchSubstring"
207784 },
2142749 {
2242749 "$ref": "#/components/schemas/MatchAny"
2342749 },
2442749 {
2542749 "$ref": "#/components/schemas/MatchExcept"
2642749 }
27168623 ],
28168623}
MatchAny3 of 6 keywords
142749{
2420 "properties": {
3420 "any": {
4420 "$ref": "#/components/schemas/AnyVariants"
5420 }
6420 },
742133 "required": [
842133 "any"
942133 ],
10175616 "type": "object"
1142749}
MatchExcept3 of 6 keywords
142749{
2420 "properties": {
3420 "except": {
4420 "$ref": "#/components/schemas/AnyVariants"
5420 }
6420 },
742133 "required": [
842133 "except"
942133 ],
10175616 "type": "object"
1142749}
MatchPhrase3 of 6 keywords
17784{
270 "properties": {
370 "phrase": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "phrase"
97168 ],
10175616 "type": "object"
117784}
MatchPrefix3 of 6 keywords
17784{
270 "properties": {
370 "prefix": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "prefix"
97168 ],
10175616 "type": "object"
117784}
MatchSubstring3 of 6 keywords
17784{
270 "properties": {
370 "substring": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "substring"
97168 ],
10175616 "type": "object"
117784}
MatchText3 of 6 keywords
17784{
270 "properties": {
370 "text": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "text"
97168 ],
10175616 "type": "object"
117784}
MatchTextAny3 of 6 keywords
17784{
270 "properties": {
370 "text_any": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "text_any"
97168 ],
10175616 "type": "object"
117784}
MatchValue3 of 6 keywords
149742{
2490 "properties": {
3490 "value": {
4490 "$ref": "#/components/schemas/ValueVariants"
5490 }
6490 },
749126 "required": [
849126 "value"
949126 ],
10175616 "type": "object"
1149742}
MinShould3 of 10 keywords
12381762{
22380 "properties": {
32380 "conditions": {
42380 "items": {
52120 "$ref": "#/components/schemas/Condition"
62380 },
72380 "type": "array"
82380 },
92380 "min_count": {
1000 "format": "uint",
112380 "minimum": 1,
122380 "type": "integer"
132380 }
142380 },
1523821 "required": [
1623821 "conditions",
1723821 "min_count"
1823821 ],
192591741 "type": "object"
202381762}
Nested0 of 7 keywords
12570{
22570 "properties": {
32570 "filter": {
42570 "$ref": "#/components/schemas/Filter"
52570 },
62570 "key": {
72570 "type": "string"
82570 }
92570 },
102570 "required": [
112570 "filter",
122570 "key"
132570 ],
142570 "type": "object"
152570}
NestedCondition3 of 6 keywords
12576644{
22570 "properties": {
32570 "nested": {
42570 "$ref": "#/components/schemas/Nested"
52570 }
62570 },
72571293 "required": [
82571293 "nested"
92571293 ],
1015505351 "type": "object"
112576644}
PayloadField1 of 6 keywords
1141603{
2140 "properties": {
3140 "key": {
4140 "type": "string"
5140 }
6140 },
7140 "required": [
8140 "key"
9140 ],
10141603 "type": "object"
11141603}
PointIdsList11 of 11 keywords
11931635{
2172814 "properties": {
319314 "points": {
41938 "items": {
53178 "$ref": "#/components/schemas/ExtendedPointId"
61938 },
72016 "type": "array"
819314 },
91625n/a "shard_key": {
101625n/a "anyOf": [
11501575 {
12501575 "$ref": "#/components/schemas/ShardKeySelector"
13501575 },
141625n/a {
151625n/a "nullable": true
161625n/a }
171625n/a ]
181625n/a }
19172814 },
202071614 "required": [
212071614 "points"
222071614 ],
2318217 "type": "object"
241931635}
Range13 of 15 keywords
17777{
20154 "properties": {
37105 "gt": {
47105 "format": "double",
5112n/a "nullable": true,
66349 "type": "number"
77105 },
87105 "gte": {
97105 "format": "double",
10112n/a "nullable": true,
116349 "type": "number"
127105 },
13791 "lt": {
14791 "format": "double",
1598n/a "nullable": true,
165642 "type": "number"
17791 },
18777 "lte": {
19777 "format": "double",
2084n/a "nullable": true,
214935 "type": "number"
22777 }
230154 },
24161623 "type": "object"
257777}
RangeInterface4 of 4 keywords
1133651{
2133651 "anyOf": [
37777 {
47777 "$ref": "#/components/schemas/Range"
57777 },
6133651 {
7133651 "$ref": "#/components/schemas/DatetimeRange"
8133651 }
9133651 ]
10133651}
ShardKey4 of 6 keywords
11403230{
21403230 "anyOf": [
3763294 {
4763294 "type": "string"
5763294 },
6643306 {
700 "format": "uint64",
8660 "minimum": 0,
9643306 "type": "integer"
10643306 }
111403230 ]
121403230}
ShardKeySelector6 of 6 keywords
11003150{
21003150 "anyOf": [
3283222 {
4283222 "$ref": "#/components/schemas/ShardKey"
5283222 },
6283222 {
7284 "items": {
8248 "$ref": "#/components/schemas/ShardKey"
9284 },
10323218 "type": "array"
11283222 },
12443206 {
13443206 "$ref": "#/components/schemas/ShardKeyWithFallback"
14443206 }
151003150 ]
161003150}
ShardKeyWithFallback3 of 7 keywords
1443206{
2440 "properties": {
3440 "fallback": {
4440 "$ref": "#/components/schemas/ShardKey"
5440 },
6440 "target": {
7440 "$ref": "#/components/schemas/ShardKey"
8440 }
9440 },
10444 "required": [
11444 "fallback",
12444 "target"
13444 ],
14483202 "type": "object"
15443206}
Slice0 of 11 keywords
1210{
2210 "properties": {
3210 "index": {
400 "format": "uint32",
5210 "minimum": 0,
6210 "type": "integer"
7210 },
8210 "total": {
900 "format": "uint32",
10210 "minimum": 1,
11210 "type": "integer"
12210 }
13210 },
14210 "required": [
15210 "index",
16210 "total"
17210 ],
18210 "type": "object"
19210}
SliceCondition3 of 6 keywords
1216880{
2210 "properties": {
3210 "slice": {
4210 "$ref": "#/components/schemas/Slice"
5210 }
6210 },
7211529 "required": [
8211529 "slice"
9211529 ],
1015505351 "type": "object"
11216880}
ValueVariants4 of 6 keywords
1490{
2490 "anyOf": [
3742 {
4742 "type": "string"
5742 },
62821 {
72821 "format": "int64",
82821 "type": "integer"
92821 },
101435 {
111435 "type": "boolean"
121435 }
13490 ]
14490}
ValuesCount5 of 19 keywords
1112665{
21050 "properties": {
3840 "gt": {
400 "format": "uint",
5770 "minimum": 0,
684n/a "nullable": true,
7840 "type": "integer"
8840 },
9840 "gte": {
1000 "format": "uint",
11770 "minimum": 0,
1284n/a "nullable": true,
13840 "type": "integer"
14840 },
15770 "lt": {
1600 "format": "uint",
17700 "minimum": 0,
1877n/a "nullable": true,
19770 "type": "integer"
20770 },
21700 "lte": {
2200 "format": "uint",
23630 "minimum": 0,
2470n/a "nullable": true,
25700 "type": "integer"
26700 }
271050 },
28112665 "type": "object"
29112665}
Responses2 of 3 documented received
codedescriptionhitsavg
200successful operation2832ms
4XXerror15680ms
defaulterror0-
Examples4 / 4 used
Body: application/json
42ExtendedPointId
"550e8400-e29b-41d4-a716-446655440000"ExtendedPointId
"region_1"ShardKey
12ShardKey
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
11855n/a{
21855n/a "type": "string"
31855n/a}
Query Parameters5 of 5 keywords covered
wait1 / 1
1161735{
2161735 "type": "boolean"
3161735}
ordering2 / 2
WriteOrdering
1163834{
2163834 "enum": [
31609n/a "weak",
49n/a "medium",
520n/a "strong"
6163834 ],
71672n/a "type": "string"
8163834}
timeout2 / 2
1162242{
2162215 "minimum": 1,
3163727 "type": "integer"
4162242}
Body172 of 275 keywords covered
application/json172 / 275
DeletePayload
1177834{
2178223 "properties": {
31609n/a "filter": {
41609n/a "anyOf": [
51506103 {
61506103 "$ref": "#/components/schemas/Filter"
71506103 },
81609n/a {
91609n/a "nullable": true
101609n/a }
111609n/a ],
121609n/a },
13179110 "keys": {
1417915 "items": {
155655 "type": "string"
1617915 },
1717965 "type": "array"
18179110 },
19168413 "points": {
2016719 "items": {
2121710 "$ref": "#/components/schemas/ExtendedPointId"
2216719 },
231697n/a "nullable": true,
2416934 "type": "array"
25168413 },
261608n/a "shard_key": {
271608n/a "anyOf": [
28251583 {
29251583 "$ref": "#/components/schemas/ShardKeySelector"
30251583 },
311608n/a {
321608n/a "nullable": true
331608n/a }
341608n/a ]
351608n/a }
36178223 },
3718016 "required": [
3818016 "keys"
3918016 ],
4018075 "type": "object"
41177834}
Referenced Components (37)199 of 333 keywords
AnyVariants3 of 9 keywords
1840{
2840 "anyOf": [
32856 {
42856 "items": {
51456 "type": "string"
62856 },
7840 "type": "array",
8840 "uniqueItems": true
92856 },
107014 {
117014 "items": {
125614 "format": "int64",
135614 "type": "integer"
147014 },
15840 "type": "array",
16840 "uniqueItems": true
177014 }
18840 ]
19840}
Condition10 of 10 keywords
115325241{
215325241 "anyOf": [
38755898 {
48755898 "$ref": "#/components/schemas/FieldCondition"
58755898 },
676766 {
776766 "$ref": "#/components/schemas/IsEmptyCondition"
876766 },
976766 {
1076766 "$ref": "#/components/schemas/IsNullCondition"
1176766 },
12596714 {
13596714 "$ref": "#/components/schemas/HasIdCondition"
14596714 },
1576766 {
1676766 "$ref": "#/components/schemas/HasVectorCondition"
1776766 },
18216752 {
19216752 "$ref": "#/components/schemas/SliceCondition"
20216752 },
212576516 {
222576516 "$ref": "#/components/schemas/NestedCondition"
232576516 },
242996474 {
252996474 "$ref": "#/components/schemas/Filter"
262996474 }
2715325241 ]
2815325241}
DatetimeRange11 of 15 keywords
1133651{
212628 "properties": {
31057 "gt": {
4490 "format": "date-time",
5112n/a "nullable": true,
61057 "type": "string"
71057 },
81057 "gte": {
9490 "format": "date-time",
10112n/a "nullable": true,
111057 "type": "string"
121057 },
13917 "lt": {
14420 "format": "date-time",
1598n/a "nullable": true,
16917 "type": "string"
17917 },
18777 "lte": {
19350 "format": "date-time",
2084n/a "nullable": true,
21777 "type": "string"
22777 }
2312628 },
24161623 "type": "object"
25133651}
ExtendedPointId6 of 7 keywords
126910{
226910 "anyOf": [
3111168 {
400 "format": "uint64",
51121 "minimum": 0,
6112167 "type": "integer"
7111168 },
8158121 {
91582 "format": "uuid",
10160119 "type": "string"
11158121 }
1226910 ],
1326910}
FieldCondition33 of 34 keywords
18755898{
287514 "properties": {
3819n/a "geo_bounding_box": {
4819n/a "anyOf": [
57812 {
67812 "$ref": "#/components/schemas/GeoBoundingBox"
77812 },
8819n/a {
9819n/a "nullable": true
10819n/a }
11819n/a ],
12819n/a },
13819n/a "geo_polygon": {
14819n/a "anyOf": [
1542777 {
1642777 "$ref": "#/components/schemas/GeoPolygon"
1742777 },
18819n/a {
19819n/a "nullable": true
20819n/a }
21819n/a ],
22819n/a },
23812n/a "geo_radius": {
24812n/a "anyOf": [
257805 {
267805 "$ref": "#/components/schemas/GeoRadius"
277805 },
28812n/a {
29812n/a "nullable": true
30812n/a }
31812n/a ],
32812n/a },
338057 "is_empty": {
34812n/a "nullable": true,
358057 "type": "boolean"
368057 },
377987 "is_null": {
38805n/a "nullable": true,
397987 "type": "boolean"
407987 },
418750 "key": {
428750 "type": "string"
438750 },
44791n/a "match": {
45791n/a "anyOf": [
46168623 {
47168623 "$ref": "#/components/schemas/Match"
48168623 },
49791n/a {
50791n/a "nullable": true
51791n/a }
52791n/a ],
53791n/a },
54784n/a "range": {
55784n/a "anyOf": [
56133651 {
57133651 "$ref": "#/components/schemas/RangeInterface"
58133651 },
59784n/a {
60784n/a "nullable": true
61784n/a }
62784n/a ],
63784n/a },
64777n/a "values_count": {
65777n/a "anyOf": [
66112665 {
67112665 "$ref": "#/components/schemas/ValuesCount"
68112665 },
69777n/a {
70777n/a "nullable": true
71777n/a }
72777n/a ],
73777n/a }
7487514 },
75875657 "required": [
76875657 "key"
77875657 ],
7815325241 "type": "object"
798755898}
Filter25 of 25 keywords
120626577{
2n/a1233 "additionalProperties": false,
32005n/a "properties": {
41960n/a "min_should": {
51960n/a "anyOf": [
62381722 {
72381722 "$ref": "#/components/schemas/MinShould"
82381722 },
91960n/a {
101960n/a "nullable": true
111960n/a }
121960n/a ],
131960n/a },
141960n/a "must": {
151960n/a "anyOf": [
162281732 {
172281732 "$ref": "#/components/schemas/Condition"
182281732 },
192271733 {
2022715 "items": {
2121230 "$ref": "#/components/schemas/Condition"
2222715 },
232421718 "type": "array"
242271733 },
251960n/a {
261960n/a "nullable": true
271960n/a }
281960n/a ],
291960n/a },
301945n/a "must_not": {
311945n/a "anyOf": [
322281717 {
332281717 "$ref": "#/components/schemas/Condition"
342281717 },
352271718 {
3622715 "items": {
3721230 "$ref": "#/components/schemas/Condition"
3822715 },
392421703 "type": "array"
402271718 },
411945n/a {
421945n/a "nullable": true
431945n/a }
441945n/a ],
451945n/a },
461930n/a "should": {
471930n/a "anyOf": [
482281702 {
492281702 "$ref": "#/components/schemas/Condition"
502281702 },
512271703 {
5222715 "items": {
5321230 "$ref": "#/components/schemas/Condition"
5422715 },
552421688 "type": "array"
562271703 },
571930n/a {
581930n/a "nullable": true
591930n/a }
601930n/a ],
611930n/a }
622005n/a },
6332955344 "type": "object"
6420626577}
GeoBoundingBox3 of 7 keywords
17812{
270 "properties": {
370 "bottom_right": {
470 "$ref": "#/components/schemas/GeoPoint"
570 },
670 "top_left": {
770 "$ref": "#/components/schemas/GeoPoint"
870 }
970 },
1077 "required": [
1177 "bottom_right",
1277 "top_left"
1377 ],
1414805 "type": "object"
157812}
GeoLineString0 of 7 keywords
1560{
2560 "properties": {
3560 "points": {
4560 "items": {
5140 "$ref": "#/components/schemas/GeoPoint"
6560 },
7560 "type": "array"
8560 }
9560 },
10560 "required": [
11560 "points"
12560 ],
13560 "type": "object"
14560}
GeoPoint0 of 9 keywords
1350{
2350 "properties": {
3350 "lat": {
4350 "format": "double",
5350 "type": "number"
6350 },
7350 "lon": {
8350 "format": "double",
9350 "type": "number"
10350 }
11350 },
12350 "required": [
13350 "lat",
14350 "lon"
15350 ],
16350 "type": "object"
17350}
GeoPolygon4 of 9 keywords
142777{
2420 "properties": {
3420 "exterior": {
4420 "$ref": "#/components/schemas/GeoLineString"
5420 },
6350 "interiors": {
7280 "items": {
8140 "$ref": "#/components/schemas/GeoLineString"
9280 },
1035n/a "nullable": true,
11350 "type": "array"
12350 }
13420 },
14427 "required": [
15427 "exterior"
16427 ],
1749770 "type": "object"
1842777}
GeoRadius3 of 8 keywords
17805{
270 "properties": {
370 "center": {
470 "$ref": "#/components/schemas/GeoPoint"
570 },
670 "radius": {
770 "format": "double",
870 "type": "number"
970 }
1070 },
1177 "required": [
1277 "center",
1377 "radius"
1477 ],
1514798 "type": "object"
167805}
HasIdCondition3 of 8 keywords
1596714{
2590 "properties": {
3590 "has_id": {
4590 "items": {
5520 "$ref": "#/components/schemas/ExtendedPointId"
6590 },
7590 "type": "array",
8590 "uniqueItems": true
9590 }
10590 },
11591473 "required": [
12591473 "has_id"
13591473 ],
1415325241 "type": "object"
15596714}
HasVectorCondition3 of 6 keywords
176766{
270 "properties": {
370 "has_vector": {
470 "type": "string"
570 }
670 },
771525 "required": [
871525 "has_vector"
971525 ],
1015325241 "type": "object"
1176766}
IsEmptyCondition6 of 6 keywords
176766{
27805 "properties": {
37805 "is_empty": {
47805 "$ref": "#/components/schemas/PayloadField"
57805 }
67805 },
7812720 "required": [
8812720 "is_empty"
9812720 ],
1015325241 "type": "object"
1176766}
IsNullCondition6 of 6 keywords
176766{
27798 "properties": {
37798 "is_null": {
47798 "$ref": "#/components/schemas/PayloadField"
57798 }
67798 },
7805727 "required": [
8805727 "is_null"
9805727 ],
1015325241 "type": "object"
1176766}
Match10 of 10 keywords
1168623{
2168623 "anyOf": [
349742 {
449742 "$ref": "#/components/schemas/MatchValue"
549742 },
67784 {
77784 "$ref": "#/components/schemas/MatchText"
87784 },
97784 {
107784 "$ref": "#/components/schemas/MatchTextAny"
117784 },
127784 {
137784 "$ref": "#/components/schemas/MatchPhrase"
147784 },
157784 {
167784 "$ref": "#/components/schemas/MatchPrefix"
177784 },
187784 {
197784 "$ref": "#/components/schemas/MatchSubstring"
207784 },
2142749 {
2242749 "$ref": "#/components/schemas/MatchAny"
2342749 },
2442749 {
2542749 "$ref": "#/components/schemas/MatchExcept"
2642749 }
27168623 ],
28168623}
MatchAny3 of 6 keywords
142749{
2420 "properties": {
3420 "any": {
4420 "$ref": "#/components/schemas/AnyVariants"
5420 }
6420 },
742133 "required": [
842133 "any"
942133 ],
10175616 "type": "object"
1142749}
MatchExcept3 of 6 keywords
142749{
2420 "properties": {
3420 "except": {
4420 "$ref": "#/components/schemas/AnyVariants"
5420 }
6420 },
742133 "required": [
842133 "except"
942133 ],
10175616 "type": "object"
1142749}
MatchPhrase3 of 6 keywords
17784{
270 "properties": {
370 "phrase": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "phrase"
97168 ],
10175616 "type": "object"
117784}
MatchPrefix3 of 6 keywords
17784{
270 "properties": {
370 "prefix": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "prefix"
97168 ],
10175616 "type": "object"
117784}
MatchSubstring3 of 6 keywords
17784{
270 "properties": {
370 "substring": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "substring"
97168 ],
10175616 "type": "object"
117784}
MatchText3 of 6 keywords
17784{
270 "properties": {
370 "text": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "text"
97168 ],
10175616 "type": "object"
117784}
MatchTextAny3 of 6 keywords
17784{
270 "properties": {
370 "text_any": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "text_any"
97168 ],
10175616 "type": "object"
117784}
MatchValue3 of 6 keywords
149742{
2490 "properties": {
3490 "value": {
4490 "$ref": "#/components/schemas/ValueVariants"
5490 }
6490 },
749126 "required": [
849126 "value"
949126 ],
10175616 "type": "object"
1149742}
MinShould3 of 10 keywords
12381722{
22380 "properties": {
32380 "conditions": {
42380 "items": {
52120 "$ref": "#/components/schemas/Condition"
62380 },
72380 "type": "array"
82380 },
92380 "min_count": {
1000 "format": "uint",
112380 "minimum": 1,
122380 "type": "integer"
132380 }
142380 },
1523815 "required": [
1623815 "conditions",
1723815 "min_count"
1823815 ],
192531707 "type": "object"
202381722}
Nested0 of 7 keywords
12570{
22570 "properties": {
32570 "filter": {
42570 "$ref": "#/components/schemas/Filter"
52570 },
62570 "key": {
72570 "type": "string"
82570 }
92570 },
102570 "required": [
112570 "filter",
122570 "key"
132570 ],
142570 "type": "object"
152570}
NestedCondition3 of 6 keywords
12576516{
22570 "properties": {
32570 "nested": {
42570 "$ref": "#/components/schemas/Nested"
52570 }
62570 },
72571275 "required": [
82571275 "nested"
92571275 ],
1015325241 "type": "object"
112576516}
PayloadField1 of 6 keywords
1141603{
2140 "properties": {
3140 "key": {
4140 "type": "string"
5140 }
6140 },
7140 "required": [
8140 "key"
9140 ],
10141603 "type": "object"
11141603}
Range13 of 15 keywords
17777{
20154 "properties": {
37105 "gt": {
47105 "format": "double",
5112n/a "nullable": true,
66349 "type": "number"
77105 },
87105 "gte": {
97105 "format": "double",
10112n/a "nullable": true,
116349 "type": "number"
127105 },
13791 "lt": {
14791 "format": "double",
1598n/a "nullable": true,
165642 "type": "number"
17791 },
18777 "lte": {
19777 "format": "double",
2084n/a "nullable": true,
214935 "type": "number"
22777 }
230154 },
24161623 "type": "object"
257777}
RangeInterface4 of 4 keywords
1133651{
2133651 "anyOf": [
37777 {
47777 "$ref": "#/components/schemas/Range"
57777 },
6133651 {
7133651 "$ref": "#/components/schemas/DatetimeRange"
8133651 }
9133651 ]
10133651}
ShardKey4 of 6 keywords
1351603{
2351603 "anyOf": [
3191619 {
4191619 "type": "string"
5191619 },
6161622 {
700 "format": "uint64",
8160 "minimum": 0,
9161622 "type": "integer"
10161622 }
11351603 ]
12351603}
ShardKeySelector6 of 6 keywords
1251583{
2251583 "anyOf": [
371601 {
471601 "$ref": "#/components/schemas/ShardKey"
571601 },
671601 {
771 "items": {
862 "$ref": "#/components/schemas/ShardKey"
971 },
1081600 "type": "array"
1171601 },
12111597 {
13111597 "$ref": "#/components/schemas/ShardKeyWithFallback"
14111597 }
15251583 ]
16251583}
ShardKeyWithFallback3 of 7 keywords
1111597{
2110 "properties": {
3110 "fallback": {
4110 "$ref": "#/components/schemas/ShardKey"
5110 },
6110 "target": {
7110 "$ref": "#/components/schemas/ShardKey"
8110 }
9110 },
10111 "required": [
11111 "fallback",
12111 "target"
13111 ],
14121596 "type": "object"
15111597}
Slice0 of 11 keywords
1210{
2210 "properties": {
3210 "index": {
400 "format": "uint32",
5210 "minimum": 0,
6210 "type": "integer"
7210 },
8210 "total": {
900 "format": "uint32",
10210 "minimum": 1,
11210 "type": "integer"
12210 }
13210 },
14210 "required": [
15210 "index",
16210 "total"
17210 ],
18210 "type": "object"
19210}
SliceCondition3 of 6 keywords
1216752{
2210 "properties": {
3210 "slice": {
4210 "$ref": "#/components/schemas/Slice"
5210 }
6210 },
7211511 "required": [
8211511 "slice"
9211511 ],
1015325241 "type": "object"
11216752}
ValueVariants4 of 6 keywords
1490{
2490 "anyOf": [
3742 {
4742 "type": "string"
5742 },
62821 {
72821 "format": "int64",
82821 "type": "integer"
92821 },
101435 {
111435 "type": "boolean"
121435 }
13490 ]
14490}
ValuesCount5 of 19 keywords
1112665{
21050 "properties": {
3840 "gt": {
400 "format": "uint",
5770 "minimum": 0,
684n/a "nullable": true,
7840 "type": "integer"
8840 },
9840 "gte": {
1000 "format": "uint",
11770 "minimum": 0,
1284n/a "nullable": true,
13840 "type": "integer"
14840 },
15770 "lt": {
1600 "format": "uint",
17700 "minimum": 0,
1877n/a "nullable": true,
19770 "type": "integer"
20770 },
21700 "lte": {
2200 "format": "uint",
23630 "minimum": 0,
2470n/a "nullable": true,
25700 "type": "integer"
26700 }
271050 },
28112665 "type": "object"
29112665}
Responses2 of 3 documented received
codedescriptionhitsavg
200successful operation510ms
4XXerror18040ms
defaulterror0-
Examples4 / 4 used
Body: application/json
42ExtendedPointId
"550e8400-e29b-41d4-a716-446655440000"ExtendedPointId
"region_1"ShardKey
12ShardKey
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
12371n/a{
22371n/a "type": "string"
32371n/a}
Query Parameters8 of 9 keywords covered
consistency6 / 7
ReadConsistency
119141886{
219141886 "anyOf": [
317832017 {
400 "format": "uint",
5178323 "minimum": 1,
618061994 "type": "integer"
717832017 },
81313669 {
91313669 "$ref": "#/components/schemas/ReadConsistencyType"
101313669 }
1119141886 ],
1219141886}
Referenced Components (1)3 of 3 keywords
ReadConsistencyType3 of 3 keywords
11313669{
21313669 "enum": [
332n/a "majority",
447n/a "quorum",
552n/a "all"
61313669 ],
71994n/a "type": "string"
81313669}
timeout2 / 2
11887119{
2188723 "minimum": 1,
3191096 "type": "integer"
41887119}
Body214 of 327 keywords covered
application/json214 / 327
ScrollRequest
1226521{
2193916 "properties": {
31645n/a "filter": {
41645n/a "anyOf": [
51506139 {
61506139 "$ref": "#/components/schemas/Filter"
71506139 },
81645n/a {
91645n/a "nullable": true
101645n/a }
111645n/a ],
121645n/a },
1318886 "limit": {
1400 "format": "uint",
1517722 "minimum": 1,
161894n/a "nullable": true,
1718895 "type": "integer"
1818886 },
191644n/a "offset": {
201644n/a "anyOf": [
21101634 {
22101634 "$ref": "#/components/schemas/ExtendedPointId"
23101634 },
241644n/a {
251644n/a "nullable": true
261644n/a }
271644n/a ],
281644n/a },
291643n/a "order_by": {
301643n/a "anyOf": [
31241619 {
32241619 "$ref": "#/components/schemas/OrderByInterface"
33241619 },
341643n/a {
351643n/a "nullable": true
361643n/a }
371643n/a ],
381643n/a },
391642n/a "shard_key": {
401642n/a "anyOf": [
41251617 {
42251617 "$ref": "#/components/schemas/ShardKeySelector"
43251617 },
441642n/a {
451642n/a "nullable": true
461642n/a }
471642n/a ],
481642n/a },
491641n/a "with_payload": {
501641n/a "anyOf": [
5181633 {
5281633 "$ref": "#/components/schemas/WithPayloadInterface"
5381633 },
541641n/a {
551641n/a "nullable": true
561641n/a }
571641n/a ],
581641n/a },
59186810 "with_vector": {
60186810 "$ref": "#/components/schemas/WithVector"
61186810 }
62193916 },
6322815 "type": "object"
64226521}
Referenced Components (46)245 of 391 keywords
AnyVariants3 of 9 keywords
1840{
2840 "anyOf": [
32856 {
42856 "items": {
51456 "type": "string"
62856 },
7840 "type": "array",
8840 "uniqueItems": true
92856 },
107014 {
117014 "items": {
125614 "format": "int64",
135614 "type": "integer"
147014 },
15840 "type": "array",
16840 "uniqueItems": true
177014 }
18840 ]
19840}
Condition10 of 10 keywords
115325241{
215325241 "anyOf": [
38755898 {
48755898 "$ref": "#/components/schemas/FieldCondition"
58755898 },
676766 {
776766 "$ref": "#/components/schemas/IsEmptyCondition"
876766 },
976766 {
1076766 "$ref": "#/components/schemas/IsNullCondition"
1176766 },
12596714 {
13596714 "$ref": "#/components/schemas/HasIdCondition"
14596714 },
1576766 {
1676766 "$ref": "#/components/schemas/HasVectorCondition"
1776766 },
18216752 {
19216752 "$ref": "#/components/schemas/SliceCondition"
20216752 },
212576516 {
222576516 "$ref": "#/components/schemas/NestedCondition"
232576516 },
242996474 {
252996474 "$ref": "#/components/schemas/Filter"
262996474 }
2715325241 ]
2815325241}
DatetimeRange11 of 15 keywords
1133651{
212628 "properties": {
31057 "gt": {
4490 "format": "date-time",
5112n/a "nullable": true,
61057 "type": "string"
71057 },
81057 "gte": {
9490 "format": "date-time",
10112n/a "nullable": true,
111057 "type": "string"
121057 },
13917 "lt": {
14420 "format": "date-time",
1598n/a "nullable": true,
16917 "type": "string"
17917 },
18777 "lte": {
19350 "format": "date-time",
2084n/a "nullable": true,
21777 "type": "string"
22777 }
2312628 },
24161623 "type": "object"
25133651}
Direction3 of 3 keywords
1219{
2219 "enum": [
31n/a "asc",
41n/a "desc"
5219 ],
6318 "type": "string"
7219}
ExtendedPointId5 of 7 keywords
1621634{
2621634 "anyOf": [
3391657 {
400 "format": "uint64",
5390 "minimum": 0,
6391657 "type": "integer"
7391657 },
8231673 {
9231 "format": "uuid",
10241672 "type": "string"
11231673 }
12621634 ],
13621634}
FieldCondition33 of 34 keywords
18755898{
287514 "properties": {
3819n/a "geo_bounding_box": {
4819n/a "anyOf": [
57812 {
67812 "$ref": "#/components/schemas/GeoBoundingBox"
77812 },
8819n/a {
9819n/a "nullable": true
10819n/a }
11819n/a ],
12819n/a },
13819n/a "geo_polygon": {
14819n/a "anyOf": [
1542777 {
1642777 "$ref": "#/components/schemas/GeoPolygon"
1742777 },
18819n/a {
19819n/a "nullable": true
20819n/a }
21819n/a ],
22819n/a },
23812n/a "geo_radius": {
24812n/a "anyOf": [
257805 {
267805 "$ref": "#/components/schemas/GeoRadius"
277805 },
28812n/a {
29812n/a "nullable": true
30812n/a }
31812n/a ],
32812n/a },
338057 "is_empty": {
34812n/a "nullable": true,
358057 "type": "boolean"
368057 },
377987 "is_null": {
38805n/a "nullable": true,
397987 "type": "boolean"
407987 },
418750 "key": {
428750 "type": "string"
438750 },
44791n/a "match": {
45791n/a "anyOf": [
46168623 {
47168623 "$ref": "#/components/schemas/Match"
48168623 },
49791n/a {
50791n/a "nullable": true
51791n/a }
52791n/a ],
53791n/a },
54784n/a "range": {
55784n/a "anyOf": [
56133651 {
57133651 "$ref": "#/components/schemas/RangeInterface"
58133651 },
59784n/a {
60784n/a "nullable": true
61784n/a }
62784n/a ],
63784n/a },
64777n/a "values_count": {
65777n/a "anyOf": [
66112665 {
67112665 "$ref": "#/components/schemas/ValuesCount"
68112665 },
69777n/a {
70777n/a "nullable": true
71777n/a }
72777n/a ],
73777n/a }
7487514 },
75875657 "required": [
76875657 "key"
77875657 ],
7815325241 "type": "object"
798755898}
Filter25 of 25 keywords
120626613{
2n/a1233 "additionalProperties": false,
32005n/a "properties": {
41960n/a "min_should": {
51960n/a "anyOf": [
62381722 {
72381722 "$ref": "#/components/schemas/MinShould"
82381722 },
91960n/a {
101960n/a "nullable": true
111960n/a }
121960n/a ],
131960n/a },
141960n/a "must": {
151960n/a "anyOf": [
162281732 {
172281732 "$ref": "#/components/schemas/Condition"
182281732 },
192271733 {
2022715 "items": {
2121230 "$ref": "#/components/schemas/Condition"
2222715 },
232421718 "type": "array"
242271733 },
251960n/a {
261960n/a "nullable": true
271960n/a }
281960n/a ],
291960n/a },
301945n/a "must_not": {
311945n/a "anyOf": [
322281717 {
332281717 "$ref": "#/components/schemas/Condition"
342281717 },
352271718 {
3622715 "items": {
3721230 "$ref": "#/components/schemas/Condition"
3822715 },
392421703 "type": "array"
402271718 },
411945n/a {
421945n/a "nullable": true
431945n/a }
441945n/a ],
451945n/a },
461930n/a "should": {
471930n/a "anyOf": [
482281702 {
492281702 "$ref": "#/components/schemas/Condition"
502281702 },
512271703 {
5222715 "items": {
5321230 "$ref": "#/components/schemas/Condition"
5422715 },
552421688 "type": "array"
562271703 },
571930n/a {
581930n/a "nullable": true
591930n/a }
601930n/a ],
611930n/a }
622005n/a },
6332955380 "type": "object"
6420626613}
GeoBoundingBox3 of 7 keywords
17812{
270 "properties": {
370 "bottom_right": {
470 "$ref": "#/components/schemas/GeoPoint"
570 },
670 "top_left": {
770 "$ref": "#/components/schemas/GeoPoint"
870 }
970 },
1077 "required": [
1177 "bottom_right",
1277 "top_left"
1377 ],
1414805 "type": "object"
157812}
GeoLineString0 of 7 keywords
1560{
2560 "properties": {
3560 "points": {
4560 "items": {
5140 "$ref": "#/components/schemas/GeoPoint"
6560 },
7560 "type": "array"
8560 }
9560 },
10560 "required": [
11560 "points"
12560 ],
13560 "type": "object"
14560}
GeoPoint0 of 9 keywords
1350{
2350 "properties": {
3350 "lat": {
4350 "format": "double",
5350 "type": "number"
6350 },
7350 "lon": {
8350 "format": "double",
9350 "type": "number"
10350 }
11350 },
12350 "required": [
13350 "lat",
14350 "lon"
15350 ],
16350 "type": "object"
17350}
GeoPolygon4 of 9 keywords
142777{
2420 "properties": {
3420 "exterior": {
4420 "$ref": "#/components/schemas/GeoLineString"
5420 },
6350 "interiors": {
7280 "items": {
8140 "$ref": "#/components/schemas/GeoLineString"
9280 },
1035n/a "nullable": true,
11350 "type": "array"
12350 }
13420 },
14427 "required": [
15427 "exterior"
16427 ],
1749770 "type": "object"
1842777}
GeoRadius3 of 8 keywords
17805{
270 "properties": {
370 "center": {
470 "$ref": "#/components/schemas/GeoPoint"
570 },
670 "radius": {
770 "format": "double",
870 "type": "number"
970 }
1070 },
1177 "required": [
1277 "center",
1377 "radius"
1477 ],
1514798 "type": "object"
167805}
HasIdCondition3 of 8 keywords
1596714{
2590 "properties": {
3590 "has_id": {
4590 "items": {
5520 "$ref": "#/components/schemas/ExtendedPointId"
6590 },
7590 "type": "array",
8590 "uniqueItems": true
9590 }
10590 },
11591473 "required": [
12591473 "has_id"
13591473 ],
1415325241 "type": "object"
15596714}
HasVectorCondition3 of 6 keywords
176766{
270 "properties": {
370 "has_vector": {
470 "type": "string"
570 }
670 },
771525 "required": [
871525 "has_vector"
971525 ],
1015325241 "type": "object"
1176766}
IsEmptyCondition6 of 6 keywords
176766{
27805 "properties": {
37805 "is_empty": {
47805 "$ref": "#/components/schemas/PayloadField"
57805 }
67805 },
7812720 "required": [
8812720 "is_empty"
9812720 ],
1015325241 "type": "object"
1176766}
IsNullCondition6 of 6 keywords
176766{
27798 "properties": {
37798 "is_null": {
47798 "$ref": "#/components/schemas/PayloadField"
57798 }
67798 },
7805727 "required": [
8805727 "is_null"
9805727 ],
1015325241 "type": "object"
1176766}
Match10 of 10 keywords
1168623{
2168623 "anyOf": [
349742 {
449742 "$ref": "#/components/schemas/MatchValue"
549742 },
67784 {
77784 "$ref": "#/components/schemas/MatchText"
87784 },
97784 {
107784 "$ref": "#/components/schemas/MatchTextAny"
117784 },
127784 {
137784 "$ref": "#/components/schemas/MatchPhrase"
147784 },
157784 {
167784 "$ref": "#/components/schemas/MatchPrefix"
177784 },
187784 {
197784 "$ref": "#/components/schemas/MatchSubstring"
207784 },
2142749 {
2242749 "$ref": "#/components/schemas/MatchAny"
2342749 },
2442749 {
2542749 "$ref": "#/components/schemas/MatchExcept"
2642749 }
27168623 ],
28168623}
MatchAny3 of 6 keywords
142749{
2420 "properties": {
3420 "any": {
4420 "$ref": "#/components/schemas/AnyVariants"
5420 }
6420 },
742133 "required": [
842133 "any"
942133 ],
10175616 "type": "object"
1142749}
MatchExcept3 of 6 keywords
142749{
2420 "properties": {
3420 "except": {
4420 "$ref": "#/components/schemas/AnyVariants"
5420 }
6420 },
742133 "required": [
842133 "except"
942133 ],
10175616 "type": "object"
1142749}
MatchPhrase3 of 6 keywords
17784{
270 "properties": {
370 "phrase": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "phrase"
97168 ],
10175616 "type": "object"
117784}
MatchPrefix3 of 6 keywords
17784{
270 "properties": {
370 "prefix": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "prefix"
97168 ],
10175616 "type": "object"
117784}
MatchSubstring3 of 6 keywords
17784{
270 "properties": {
370 "substring": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "substring"
97168 ],
10175616 "type": "object"
117784}
MatchText3 of 6 keywords
17784{
270 "properties": {
370 "text": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "text"
97168 ],
10175616 "type": "object"
117784}
MatchTextAny3 of 6 keywords
17784{
270 "properties": {
370 "text_any": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "text_any"
97168 ],
10175616 "type": "object"
117784}
MatchValue3 of 6 keywords
149742{
2490 "properties": {
3490 "value": {
4490 "$ref": "#/components/schemas/ValueVariants"
5490 }
6490 },
749126 "required": [
849126 "value"
949126 ],
10175616 "type": "object"
1149742}
MinShould3 of 10 keywords
12381722{
22380 "properties": {
32380 "conditions": {
42380 "items": {
52120 "$ref": "#/components/schemas/Condition"
62380 },
72380 "type": "array"
82380 },
92380 "min_count": {
1000 "format": "uint",
112380 "minimum": 1,
122380 "type": "integer"
132380 }
142380 },
1523815 "required": [
1623815 "conditions",
1723815 "min_count"
1823815 ],
192531707 "type": "object"
202381722}
Nested0 of 7 keywords
12570{
22570 "properties": {
32570 "filter": {
42570 "$ref": "#/components/schemas/Filter"
52570 },
62570 "key": {
72570 "type": "string"
82570 }
92570 },
102570 "required": [
112570 "filter",
122570 "key"
132570 ],
142570 "type": "object"
152570}
NestedCondition3 of 6 keywords
12576516{
22570 "properties": {
32570 "nested": {
42570 "$ref": "#/components/schemas/Nested"
52570 }
62570 },
72571275 "required": [
82571275 "nested"
92571275 ],
1015325241 "type": "object"
112576516}
OrderBy11 of 14 keywords
1231620{
2230 "properties": {
321n/a "direction": {
421n/a "anyOf": [
5219 {
6219 "$ref": "#/components/schemas/Direction"
7219 },
821n/a {
921n/a "nullable": true
1021n/a }
1121n/a ],
1221n/a },
13230 "key": {
14230 "type": "string"
15230 },
1621n/a "start_from": {
1721n/a "anyOf": [
18615 {
19615 "$ref": "#/components/schemas/StartFrom"
20615 },
2121n/a {
2221n/a "nullable": true
2321n/a }
2421n/a ],
2521n/a }
26230 },
27231 "required": [
28231 "key"
29231 ],
30241619 "type": "object"
31231620}
OrderByInterface4 of 4 keywords
1241619{
2241619 "anyOf": [
311642 {
411642 "type": "string"
511642 },
6231620 {
7231620 "$ref": "#/components/schemas/OrderBy"
8231620 }
9241619 ]
10241619}
PayloadField1 of 6 keywords
1141603{
2140 "properties": {
3140 "key": {
4140 "type": "string"
5140 }
6140 },
7140 "required": [
8140 "key"
9140 ],
10141603 "type": "object"
11141603}
PayloadSelector4 of 4 keywords
141637{
241637 "anyOf": [
321639 {
421639 "$ref": "#/components/schemas/PayloadSelectorInclude"
521639 },
621639 {
721639 "$ref": "#/components/schemas/PayloadSelectorExclude"
821639 }
941637 ],
1041637}
PayloadSelectorExclude3 of 7 keywords
121639{
2n/a2 "additionalProperties": false,
320 "properties": {
420 "exclude": {
520 "items": {
610 "type": "string"
720 },
820 "type": "array"
920 }
1020 },
1123 "required": [
1223 "exclude"
1323 ],
1451636 "type": "object"
1521639}
PayloadSelectorInclude3 of 7 keywords
121639{
2n/a2 "additionalProperties": false,
320 "properties": {
420 "include": {
520 "items": {
610 "type": "string"
720 },
820 "type": "array"
920 }
1020 },
1123 "required": [
1223 "include"
1323 ],
1451636 "type": "object"
1521639}
Range13 of 15 keywords
17777{
20154 "properties": {
37105 "gt": {
47105 "format": "double",
5112n/a "nullable": true,
66349 "type": "number"
77105 },
87105 "gte": {
97105 "format": "double",
10112n/a "nullable": true,
116349 "type": "number"
127105 },
13791 "lt": {
14791 "format": "double",
1598n/a "nullable": true,
165642 "type": "number"
17791 },
18777 "lte": {
19777 "format": "double",
2084n/a "nullable": true,
214935 "type": "number"
22777 }
230154 },
24161623 "type": "object"
257777}
RangeInterface4 of 4 keywords
1133651{
2133651 "anyOf": [
37777 {
47777 "$ref": "#/components/schemas/Range"
57777 },
6133651 {
7133651 "$ref": "#/components/schemas/DatetimeRange"
8133651 }
9133651 ]
10133651}
ShardKey4 of 6 keywords
1351637{
2351637 "anyOf": [
3191653 {
4191653 "type": "string"
5191653 },
6161656 {
700 "format": "uint64",
8160 "minimum": 0,
9161656 "type": "integer"
10161656 }
11351637 ]
12351637}
ShardKeySelector6 of 6 keywords
1251617{
2251617 "anyOf": [
371635 {
471635 "$ref": "#/components/schemas/ShardKey"
571635 },
671635 {
771 "items": {
862 "$ref": "#/components/schemas/ShardKey"
971 },
1081634 "type": "array"
1171635 },
12111631 {
13111631 "$ref": "#/components/schemas/ShardKeyWithFallback"
14111631 }
15251617 ]
16251617}
ShardKeyWithFallback3 of 7 keywords
1111631{
2110 "properties": {
3110 "fallback": {
4110 "$ref": "#/components/schemas/ShardKey"
5110 },
6110 "target": {
7110 "$ref": "#/components/schemas/ShardKey"
8110 }
9110 },
10111 "required": [
11111 "fallback",
12111 "target"
13111 ],
14121630 "type": "object"
15111631}
Slice0 of 11 keywords
1210{
2210 "properties": {
3210 "index": {
400 "format": "uint32",
5210 "minimum": 0,
6210 "type": "integer"
7210 },
8210 "total": {
900 "format": "uint32",
10210 "minimum": 1,
11210 "type": "integer"
12210 }
13210 },
14210 "required": [
15210 "index",
16210 "total"
17210 ],
18210 "type": "object"
19210}
SliceCondition3 of 6 keywords
1216752{
2210 "properties": {
3210 "slice": {
4210 "$ref": "#/components/schemas/Slice"
5210 }
6210 },
7211511 "required": [
8211511 "slice"
9211511 ],
1015325241 "type": "object"
11216752}
StartFrom8 of 8 keywords
1615{
2615 "anyOf": [
3516 {
4516 "format": "int64",
5516 "type": "integer"
6516 },
7516 {
8516 "format": "double",
9516 "type": "number"
10516 },
11120 {
1211 "format": "date-time",
13219 "type": "string"
14120 }
15615 ]
16615}
ValueVariants4 of 6 keywords
1490{
2490 "anyOf": [
3742 {
4742 "type": "string"
5742 },
62821 {
72821 "format": "int64",
82821 "type": "integer"
92821 },
101435 {
111435 "type": "boolean"
121435 }
13490 ]
14490}
ValuesCount5 of 19 keywords
1112665{
21050 "properties": {
3840 "gt": {
400 "format": "uint",
5770 "minimum": 0,
684n/a "nullable": true,
7840 "type": "integer"
8840 },
9840 "gte": {
1000 "format": "uint",
11770 "minimum": 0,
1284n/a "nullable": true,
13840 "type": "integer"
14840 },
15770 "lt": {
1600 "format": "uint",
17700 "minimum": 0,
1877n/a "nullable": true,
19770 "type": "integer"
20770 },
21700 "lte": {
2200 "format": "uint",
23630 "minimum": 0,
2470n/a "nullable": true,
25700 "type": "integer"
26700 }
271050 },
28112665 "type": "object"
29112665}
WithPayloadInterface6 of 6 keywords
181633{
281633 "anyOf": [
321639 {
421639 "type": "boolean"
521639 },
621639 {
721 "items": {
812 "type": "string"
921 },
1031638 "type": "array"
1121639 },
1241637 {
1341637 "$ref": "#/components/schemas/PayloadSelector"
1441637 }
1581633 ],
1681633}
WithVector5 of 5 keywords
1186810{
2186810 "anyOf": [
31251753 {
41251753 "type": "boolean"
51251753 },
61743135 {
717436 "items": {
85037 "type": "string"
917436 },
101749129 "type": "array"
111743135 }
12186810 ],
13186810}
Responses2 of 3 documented received
codedescriptionhitsavg
200successful operation3971ms
4XXerror19740ms
defaulterror0-
Examples4 / 4 used
Body: application/json
42ExtendedPointId
"550e8400-e29b-41d4-a716-446655440000"ExtendedPointId
"region_1"ShardKey
12ShardKey
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
12304n/a{
22304n/a "type": "string"
32304n/a}
Query Parameters5 of 5 keywords covered
wait1 / 1
1209418{
2209418 "type": "boolean"
3209418}
ordering2 / 2
WriteOrdering
1208616{
2208616 "enum": [
32052n/a "weak",
412n/a "medium",
522n/a "strong"
6208616 ],
72102n/a "type": "string"
8208616}
timeout2 / 2
1207980{
2207962 "minimum": 1,
3214118 "type": "integer"
4207980}
Body271 of 406 keywords covered
application/json271 / 406
UpdateVectors
12120163{
22121156 "properties": {
32120156 "points": {
42121150 "items": {
52532150 "$ref": "#/components/schemas/PointVectors"
62121150 },
722701 "minItems": 1,
822715 "type": "array"
92120156 },
102068n/a "shard_key": {
112068n/a "anyOf": [
12252043 {
13252043 "$ref": "#/components/schemas/ShardKeySelector"
14252043 },
152068n/a {
162068n/a "nullable": true
172068n/a }
182068n/a ]
192068n/a },
202068n/a "update_filter": {
212068n/a "anyOf": [
221506562 {
231506562 "$ref": "#/components/schemas/Filter"
241506562 },
252068n/a {
262068n/a "nullable": true
272068n/a }
282068n/a ]
292068n/a }
302121156 },
3122762 "required": [
3222762 "points"
3322762 ],
3422785 "type": "object"
352120163}
Referenced Components (56)325 of 495 keywords
AnyVariants3 of 9 keywords
1840{
2840 "anyOf": [
32856 {
42856 "items": {
51456 "type": "string"
62856 },
7840 "type": "array",
8840 "uniqueItems": true
92856 },
107014 {
117014 "items": {
125614 "format": "int64",
135614 "type": "integer"
147014 },
15840 "type": "array",
16840 "uniqueItems": true
177014 }
18840 ]
19840}
Bm25Config14 of 32 keywords
1316192{
22620 "properties": {
32420 "ascii_folding": {
4242n/a "nullable": true,
52420 "type": "boolean"
62420 },
72420 "avg_len": {
82420 "format": "double",
92420 "type": "number"
102420 },
112400 "b": {
122400 "format": "double",
132400 "type": "number"
142400 },
152380 "k": {
162380 "format": "double",
172380 "type": "number"
182380 },
192360 "language": {
20236n/a "nullable": true,
212360 "type": "string"
222360 },
232340 "lowercase": {
24234n/a "nullable": true,
252340 "type": "boolean"
262340 },
272320 "max_token_len": {
2800 "format": "uint",
292300 "minimum": 0,
30232n/a "nullable": true,
312320 "type": "integer"
322320 },
332300 "min_token_len": {
3400 "format": "uint",
352280 "minimum": 0,
36230n/a "nullable": true,
372300 "type": "integer"
382300 },
39228n/a "stemmer": {
40228n/a "anyOf": [
4140188 {
4240188 "$ref": "#/components/schemas/StemmingAlgorithm"
4340188 },
44228n/a {
45228n/a "nullable": true
46228n/a }
47228n/a ],
48228n/a },
49226n/a "stopwords": {
50226n/a "anyOf": [
5113492 {
5213492 "$ref": "#/components/schemas/StopwordsInterface"
5313492 },
54226n/a {
55226n/a "nullable": true
56226n/a }
57226n/a ],
58226n/a },
592240 "tokenizer": {
602240 "$ref": "#/components/schemas/TokenizerType"
612240 }
622620 },
63316192 "type": "object"
64316192}
Condition10 of 10 keywords
115325241{
215325241 "anyOf": [
38755898 {
48755898 "$ref": "#/components/schemas/FieldCondition"
58755898 },
676766 {
776766 "$ref": "#/components/schemas/IsEmptyCondition"
876766 },
976766 {
1076766 "$ref": "#/components/schemas/IsNullCondition"
1176766 },
12596714 {
13596714 "$ref": "#/components/schemas/HasIdCondition"
14596714 },
1576766 {
1676766 "$ref": "#/components/schemas/HasVectorCondition"
1776766 },
18216752 {
19216752 "$ref": "#/components/schemas/SliceCondition"
20216752 },
212576516 {
222576516 "$ref": "#/components/schemas/NestedCondition"
232576516 },
242996474 {
252996474 "$ref": "#/components/schemas/Filter"
262996474 }
2715325241 ]
2815325241}
DatetimeRange11 of 15 keywords
1133651{
212628 "properties": {
31057 "gt": {
4490 "format": "date-time",
5112n/a "nullable": true,
61057 "type": "string"
71057 },
81057 "gte": {
9490 "format": "date-time",
10112n/a "nullable": true,
111057 "type": "string"
121057 },
13917 "lt": {
14420 "format": "date-time",
1598n/a "nullable": true,
16917 "type": "string"
17917 },
18777 "lte": {
19350 "format": "date-time",
2084n/a "nullable": true,
21777 "type": "string"
22777 }
2312628 },
24161623 "type": "object"
25133651}
DisabledStemmerParams6 of 6 keywords
12226{
2238 "properties": {
3238 "type": {
4238 "$ref": "#/components/schemas/NoStemmer"
5238 }
6238 },
7402 "required": [
8402 "type"
9402 ],
1042186 "type": "object"
112226}
Document12 of 12 keywords
13964662{
266946 "properties": {
367336 "model": {
46736 "minLength": 1,
567930 "type": "string"
667336 },
7508n/a "options": {
8508n/a "anyOf": [
9316192 {
10316192 "$ref": "#/components/schemas/DocumentOptions"
11316192 },
12508n/a {
13508n/a "nullable": true
14508n/a }
15508n/a ],
16508n/a },
1741010 "text": {
1841010 "type": "string"
1941010 }
2066946 },
214181155 "required": [
22709864 "model",
234201153 "text"
244181155 ],
2515733485 "type": "object"
263964662}
DocumentOptions5 of 5 keywords
1316192{
2316192 "anyOf": [
3316192 {
41n/a "additionalProperties": true,
5316192 "type": "object"
6316192 },
7316192 {
8316192 "$ref": "#/components/schemas/Bm25Config"
9316192 }
10316192 ],
11316192}
ExtendedPointId6 of 7 keywords
127128{
227128 "anyOf": [
32892431 {
400 "format": "uint64",
52901 "minimum": 0,
62902430 "type": "integer"
72892431 },
82423297 {
924232 "format": "uuid",
102425295 "type": "string"
112423297 }
1227128 ],
1327128}
FieldCondition33 of 34 keywords
18755898{
287514 "properties": {
3819n/a "geo_bounding_box": {
4819n/a "anyOf": [
57812 {
67812 "$ref": "#/components/schemas/GeoBoundingBox"
77812 },
8819n/a {
9819n/a "nullable": true
10819n/a }
11819n/a ],
12819n/a },
13819n/a "geo_polygon": {
14819n/a "anyOf": [
1542777 {
1642777 "$ref": "#/components/schemas/GeoPolygon"
1742777 },
18819n/a {
19819n/a "nullable": true
20819n/a }
21819n/a ],
22819n/a },
23812n/a "geo_radius": {
24812n/a "anyOf": [
257805 {
267805 "$ref": "#/components/schemas/GeoRadius"
277805 },
28812n/a {
29812n/a "nullable": true
30812n/a }
31812n/a ],
32812n/a },
338057 "is_empty": {
34812n/a "nullable": true,
358057 "type": "boolean"
368057 },
377987 "is_null": {
38805n/a "nullable": true,
397987 "type": "boolean"
407987 },
418750 "key": {
428750 "type": "string"
438750 },
44791n/a "match": {
45791n/a "anyOf": [
46168623 {
47168623 "$ref": "#/components/schemas/Match"
48168623 },
49791n/a {
50791n/a "nullable": true
51791n/a }
52791n/a ],
53791n/a },
54784n/a "range": {
55784n/a "anyOf": [
56133651 {
57133651 "$ref": "#/components/schemas/RangeInterface"
58133651 },
59784n/a {
60784n/a "nullable": true
61784n/a }
62784n/a ],
63784n/a },
64777n/a "values_count": {
65777n/a "anyOf": [
66112665 {
67112665 "$ref": "#/components/schemas/ValuesCount"
68112665 },
69777n/a {
70777n/a "nullable": true
71777n/a }
72777n/a ],
73777n/a }
7487514 },
75875657 "required": [
76875657 "key"
77875657 ],
7815325241 "type": "object"
798755898}
Filter25 of 25 keywords
120627036{
2n/a1233 "additionalProperties": false,
32005n/a "properties": {
41960n/a "min_should": {
51960n/a "anyOf": [
62381722 {
72381722 "$ref": "#/components/schemas/MinShould"
82381722 },
91960n/a {
101960n/a "nullable": true
111960n/a }
121960n/a ],
131960n/a },
141960n/a "must": {
151960n/a "anyOf": [
162281732 {
172281732 "$ref": "#/components/schemas/Condition"
182281732 },
192271733 {
2022715 "items": {
2121230 "$ref": "#/components/schemas/Condition"
2222715 },
232421718 "type": "array"
242271733 },
251960n/a {
261960n/a "nullable": true
271960n/a }
281960n/a ],
291960n/a },
301945n/a "must_not": {
311945n/a "anyOf": [
322281717 {
332281717 "$ref": "#/components/schemas/Condition"
342281717 },
352271718 {
3622715 "items": {
3721230 "$ref": "#/components/schemas/Condition"
3822715 },
392421703 "type": "array"
402271718 },
411945n/a {
421945n/a "nullable": true
431945n/a }
441945n/a ],
451945n/a },
461930n/a "should": {
471930n/a "anyOf": [
482281702 {
492281702 "$ref": "#/components/schemas/Condition"
502281702 },
512271703 {
5222715 "items": {
5321230 "$ref": "#/components/schemas/Condition"
5422715 },
552421688 "type": "array"
562271703 },
571930n/a {
581930n/a "nullable": true
591930n/a }
601930n/a ],
611930n/a }
622005n/a },
6332955803 "type": "object"
6420627036}
GeoBoundingBox3 of 7 keywords
17812{
270 "properties": {
370 "bottom_right": {
470 "$ref": "#/components/schemas/GeoPoint"
570 },
670 "top_left": {
770 "$ref": "#/components/schemas/GeoPoint"
870 }
970 },
1077 "required": [
1177 "bottom_right",
1277 "top_left"
1377 ],
1414805 "type": "object"
157812}
GeoLineString0 of 7 keywords
1560{
2560 "properties": {
3560 "points": {
4560 "items": {
5140 "$ref": "#/components/schemas/GeoPoint"
6560 },
7560 "type": "array"
8560 }
9560 },
10560 "required": [
11560 "points"
12560 ],
13560 "type": "object"
14560}
GeoPoint0 of 9 keywords
1350{
2350 "properties": {
3350 "lat": {
4350 "format": "double",
5350 "type": "number"
6350 },
7350 "lon": {
8350 "format": "double",
9350 "type": "number"
10350 }
11350 },
12350 "required": [
13350 "lat",
14350 "lon"
15350 ],
16350 "type": "object"
17350}
GeoPolygon4 of 9 keywords
142777{
2420 "properties": {
3420 "exterior": {
4420 "$ref": "#/components/schemas/GeoLineString"
5420 },
6350 "interiors": {
7280 "items": {
8140 "$ref": "#/components/schemas/GeoLineString"
9280 },
1035n/a "nullable": true,
11350 "type": "array"
12350 }
13420 },
14427 "required": [
15427 "exterior"
16427 ],
1749770 "type": "object"
1842777}
GeoRadius3 of 8 keywords
17805{
270 "properties": {
370 "center": {
470 "$ref": "#/components/schemas/GeoPoint"
570 },
670 "radius": {
770 "format": "double",
870 "type": "number"
970 }
1070 },
1177 "required": [
1277 "center",
1377 "radius"
1477 ],
1514798 "type": "object"
167805}
HasIdCondition3 of 8 keywords
1596714{
2590 "properties": {
3590 "has_id": {
4590 "items": {
5520 "$ref": "#/components/schemas/ExtendedPointId"
6590 },
7590 "type": "array",
8590 "uniqueItems": true
9590 }
10590 },
11591473 "required": [
12591473 "has_id"
13591473 ],
1415325241 "type": "object"
15596714}
HasVectorCondition3 of 6 keywords
176766{
270 "properties": {
370 "has_vector": {
470 "type": "string"
570 }
670 },
771525 "required": [
871525 "has_vector"
971525 ],
1015325241 "type": "object"
1176766}
Image10 of 10 keywords
11214937{
265362 "properties": {
3143n/a "image": {
4143n/a },
567336 "model": {
66736 "minLength": 1,
767930 "type": "string"
867336 },
948226 "options": {
101n/a "additionalProperties": true,
11508n/a "nullable": true,
1248226 "type": "object"
1348226 }
1465362 },
151411432 "required": [
161431430 "image",
17709864 "model"
181411432 ],
1915733485 "type": "object"
201214937}
InferenceObject10 of 10 keywords
11264932{
265362 "properties": {
367336 "model": {
46736 "minLength": 1,
567930 "type": "string"
667336 },
7148n/a "object": {
8148n/a },
948226 "options": {
101n/a "additionalProperties": true,
11508n/a "nullable": true,
1248226 "type": "object"
1348226 }
1465362 },
151461427 "required": [
16709864 "model",
171481425 "object"
181461427 ],
1915733485 "type": "object"
201264932}
IsEmptyCondition6 of 6 keywords
176766{
27805 "properties": {
37805 "is_empty": {
47805 "$ref": "#/components/schemas/PayloadField"
57805 }
67805 },
7812720 "required": [
8812720 "is_empty"
9812720 ],
1015325241 "type": "object"
1176766}
IsNullCondition6 of 6 keywords
176766{
27798 "properties": {
37798 "is_null": {
47798 "$ref": "#/components/schemas/PayloadField"
57798 }
67798 },
7805727 "required": [
8805727 "is_null"
9805727 ],
1015325241 "type": "object"
1176766}
Language3 of 3 keywords
1120166{
2120166 "enum": [
34n/a "arabic",
44n/a "azerbaijani",
54n/a "basque",
64n/a "bengali",
74n/a "catalan",
84n/a "chinese",
94n/a "danish",
104n/a "dutch",
114n/a "english",
124n/a "finnish",
134n/a "french",
144n/a "german",
154n/a "greek",
164n/a "hebrew",
174n/a "hinglish",
184n/a "hungarian",
194n/a "indonesian",
204n/a "italian",
214n/a "japanese",
224n/a "kazakh",
234n/a "nepali",
244n/a "norwegian",
254n/a "portuguese",
264n/a "romanian",
274n/a "russian",
284n/a "slovene",
294n/a "spanish",
304n/a "swedish",
314n/a "tajik",
324n/a "turkish"
33120166 ],
34122164 "type": "string"
35120166}
Match10 of 10 keywords
1168623{
2168623 "anyOf": [
349742 {
449742 "$ref": "#/components/schemas/MatchValue"
549742 },
67784 {
77784 "$ref": "#/components/schemas/MatchText"
87784 },
97784 {
107784 "$ref": "#/components/schemas/MatchTextAny"
117784 },
127784 {
137784 "$ref": "#/components/schemas/MatchPhrase"
147784 },
157784 {
167784 "$ref": "#/components/schemas/MatchPrefix"
177784 },
187784 {
197784 "$ref": "#/components/schemas/MatchSubstring"
207784 },
2142749 {
2242749 "$ref": "#/components/schemas/MatchAny"
2342749 },
2442749 {
2542749 "$ref": "#/components/schemas/MatchExcept"
2642749 }
27168623 ],
28168623}
MatchAny3 of 6 keywords
142749{
2420 "properties": {
3420 "any": {
4420 "$ref": "#/components/schemas/AnyVariants"
5420 }
6420 },
742133 "required": [
842133 "any"
942133 ],
10175616 "type": "object"
1142749}
MatchExcept3 of 6 keywords
142749{
2420 "properties": {
3420 "except": {
4420 "$ref": "#/components/schemas/AnyVariants"
5420 }
6420 },
742133 "required": [
842133 "except"
942133 ],
10175616 "type": "object"
1142749}
MatchPhrase3 of 6 keywords
17784{
270 "properties": {
370 "phrase": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "phrase"
97168 ],
10175616 "type": "object"
117784}
MatchPrefix3 of 6 keywords
17784{
270 "properties": {
370 "prefix": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "prefix"
97168 ],
10175616 "type": "object"
117784}
MatchSubstring3 of 6 keywords
17784{
270 "properties": {
370 "substring": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "substring"
97168 ],
10175616 "type": "object"
117784}
MatchText3 of 6 keywords
17784{
270 "properties": {
370 "text": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "text"
97168 ],
10175616 "type": "object"
117784}
MatchTextAny3 of 6 keywords
17784{
270 "properties": {
370 "text_any": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "text_any"
97168 ],
10175616 "type": "object"
117784}
MatchValue3 of 6 keywords
149742{
2490 "properties": {
3490 "value": {
4490 "$ref": "#/components/schemas/ValueVariants"
5490 }
6490 },
749126 "required": [
849126 "value"
949126 ],
10175616 "type": "object"
1149742}
MinShould3 of 10 keywords
12381722{
22380 "properties": {
32380 "conditions": {
42380 "items": {
52120 "$ref": "#/components/schemas/Condition"
62380 },
72380 "type": "array"
82380 },
92380 "min_count": {
1000 "format": "uint",
112380 "minimum": 1,
122380 "type": "integer"
132380 }
142380 },
1523815 "required": [
1623815 "conditions",
1723815 "min_count"
1823815 ],
192531707 "type": "object"
202381722}
Nested0 of 7 keywords
12570{
22570 "properties": {
32570 "filter": {
42570 "$ref": "#/components/schemas/Filter"
52570 },
62570 "key": {
72570 "type": "string"
82570 }
92570 },
102570 "required": [
112570 "filter",
122570 "key"
132570 ],
142570 "type": "object"
152570}
NestedCondition3 of 6 keywords
12576516{
22570 "properties": {
32570 "nested": {
42570 "$ref": "#/components/schemas/Nested"
52570 }
62570 },
72571275 "required": [
82571275 "nested"
92571275 ],
1015325241 "type": "object"
112576516}
NoStemmer2 of 3 keywords
1238{
2238 "enum": [
32n/a "none"
4238 ],
5400 "type": "string"
6238}
PayloadField1 of 6 keywords
1141603{
2140 "properties": {
3140 "key": {
4140 "type": "string"
5140 }
6140 },
7140 "required": [
8140 "key"
9140 ],
10141603 "type": "object"
11141603}
PointVectors7 of 7 keywords
12532150{
22542135 "properties": {
326608 "id": {
426608 "$ref": "#/components/schemas/ExtendedPointId"
526608 },
62549127 "vector": {
72549127 "$ref": "#/components/schemas/VectorStruct"
82549127 }
92542135 },
10266710 "required": [
1126689 "id",
1226761 "vector"
13266710 ],
1426775 "type": "object"
152532150}
Range13 of 15 keywords
17777{
20154 "properties": {
37105 "gt": {
47105 "format": "double",
5112n/a "nullable": true,
66349 "type": "number"
77105 },
87105 "gte": {
97105 "format": "double",
10112n/a "nullable": true,
116349 "type": "number"
127105 },
13791 "lt": {
14791 "format": "double",
1598n/a "nullable": true,
165642 "type": "number"
17791 },
18777 "lte": {
19777 "format": "double",
2084n/a "nullable": true,
214935 "type": "number"
22777 }
230154 },
24161623 "type": "object"
257777}
RangeInterface4 of 4 keywords
1133651{
2133651 "anyOf": [
37777 {
47777 "$ref": "#/components/schemas/Range"
57777 },
6133651 {
7133651 "$ref": "#/components/schemas/DatetimeRange"
8133651 }
9133651 ]
10133651}
ShardKey4 of 6 keywords
1352063{
2352063 "anyOf": [
3192079 {
4192079 "type": "string"
5192079 },
6162082 {
700 "format": "uint64",
8160 "minimum": 0,
9162082 "type": "integer"
10162082 }
11352063 ]
12352063}
ShardKeySelector6 of 6 keywords
1252043{
2252043 "anyOf": [
372061 {
472061 "$ref": "#/components/schemas/ShardKey"
572061 },
672061 {
771 "items": {
862 "$ref": "#/components/schemas/ShardKey"
971 },
1082060 "type": "array"
1172061 },
12112057 {
13112057 "$ref": "#/components/schemas/ShardKeyWithFallback"
14112057 }
15252043 ]
16252043}
ShardKeyWithFallback3 of 7 keywords
1112057{
2110 "properties": {
3110 "fallback": {
4110 "$ref": "#/components/schemas/ShardKey"
5110 },
6110 "target": {
7110 "$ref": "#/components/schemas/ShardKey"
8110 }
9110 },
10111 "required": [
11111 "fallback",
12111 "target"
13111 ],
14122056 "type": "object"
15112057}
Slice0 of 11 keywords
1210{
2210 "properties": {
3210 "index": {
400 "format": "uint32",
5210 "minimum": 0,
6210 "type": "integer"
7210 },
8210 "total": {
900 "format": "uint32",
10210 "minimum": 1,
11210 "type": "integer"
12210 }
13210 },
14210 "required": [
15210 "index",
16210 "total"
17210 ],
18210 "type": "object"
19210}
SliceCondition3 of 6 keywords
1216752{
2210 "properties": {
3210 "slice": {
4210 "$ref": "#/components/schemas/Slice"
5210 }
6210 },
7211511 "required": [
8211511 "slice"
9211511 ],
1015325241 "type": "object"
11216752}
Snowball2 of 3 keywords
1382{
2382 "enum": [
338n/a "snowball"
4382 ],
5400 "type": "string"
6382}
SnowballLanguage0 of 3 keywords
1380{
2380 "enum": [
32n/a "arabic",
42n/a "armenian",
52n/a "danish",
62n/a "dutch",
72n/a "english",
82n/a "finnish",
92n/a "french",
102n/a "german",
112n/a "greek",
122n/a "hungarian",
132n/a "italian",
142n/a "norwegian",
152n/a "portuguese",
162n/a "romanian",
172n/a "russian",
182n/a "spanish",
192n/a "swedish",
202n/a "tamil",
212n/a "turkish"
22380 ],
23380 "type": "string"
24380}
SnowballParams6 of 7 keywords
138190{
2382 "properties": {
3380 "language": {
4380 "$ref": "#/components/schemas/SnowballLanguage"
5380 },
6382 "type": {
7382 "$ref": "#/components/schemas/Snowball"
8382 }
9382 },
10384 "required": [
11384 "language",
12402 "type"
13384 ],
1442186 "type": "object"
1538190}
SparseVector11 of 12 keywords
1162366{
21822 "properties": {
32712 "indices": {
4277 "items": {
500 "format": "uint32",
6731 "minimum": 0,
7736 "type": "integer"
8277 },
9345 "type": "array"
102712 },
112910 "values": {
12295 "items": {
13615 "format": "float",
14615 "type": "number"
15295 },
16345 "type": "array"
172910 }
181822 },
1938783 "required": [
2039782 "indices",
2139782 "values"
2238783 ],
238211561 "type": "object"
24162366}
StemmingAlgorithm4 of 4 keywords
140188{
240188 "anyOf": [
338190 {
438190 "$ref": "#/components/schemas/SnowballParams"
538190 },
62226 {
72226 "$ref": "#/components/schemas/DisabledStemmerParams"
82226 }
940188 ],
1040188}
StopwordsInterface4 of 4 keywords
113492{
213492 "anyOf": [
360166 {
460166 "$ref": "#/components/schemas/Language"
560166 },
674152 {
774152 "$ref": "#/components/schemas/StopwordsSet"
874152 }
913492 ]
1013492}
StopwordsSet3 of 11 keywords
174152{
2720 "properties": {
3700 "custom": {
4680 "items": {
520 "type": "string"
6680 },
770n/a "nullable": true,
8700 "type": "array",
9680 "uniqueItems": true
10700 },
11700 "languages": {
12680 "items": {
13600 "$ref": "#/components/schemas/Language"
14680 },
1570n/a "nullable": true,
16700 "type": "array",
17680 "uniqueItems": true
18700 }
19720 },
2074152 "type": "object"
2174152}
TokenizerType0 of 3 keywords
12240{
22240 "enum": [
3218n/a "prefix",
42n/a "whitespace",
52n/a "word",
62n/a "multilingual"
72240 ],
82240 "type": "string"
92240}
ValueVariants4 of 6 keywords
1490{
2490 "anyOf": [
3742 {
4742 "type": "string"
5742 },
62821 {
72821 "format": "int64",
82821 "type": "integer"
92821 },
101435 {
111435 "type": "boolean"
121435 }
13490 ]
14490}
ValuesCount5 of 19 keywords
1112665{
21050 "properties": {
3840 "gt": {
400 "format": "uint",
5770 "minimum": 0,
684n/a "nullable": true,
7840 "type": "integer"
8840 },
9840 "gte": {
1000 "format": "uint",
11770 "minimum": 0,
1284n/a "nullable": true,
13840 "type": "integer"
14840 },
15770 "lt": {
1600 "format": "uint",
17700 "minimum": 0,
1877n/a "nullable": true,
19770 "type": "integer"
20770 },
21700 "lte": {
2200 "format": "uint",
23630 "minimum": 0,
2470n/a "nullable": true,
25700 "type": "integer"
26700 }
271050 },
28112665 "type": "object"
29112665}
Vector13 of 13 keywords
17341648{
27341648 "anyOf": [
34251957 {
4425246 "items": {
51047614 "format": "float",
61047614 "type": "number"
7425246 },
86711711 "type": "array"
94251957 },
10162366 {
11162366 "$ref": "#/components/schemas/SparseVector"
12162366 },
131592223 {
14159512 "items": {
1528446 "items": {
16118562 "format": "float",
17118562 "type": "number"
1828446 },
193301331 "type": "array"
20159512 },
216711711 "type": "array"
221592223 },
231772205 {
241772205 "$ref": "#/components/schemas/Document"
251772205 },
26312351 {
27312351 "$ref": "#/components/schemas/Image"
28312351 },
29452337 {
30452337 "$ref": "#/components/schemas/InferenceObject"
31452337 }
327341648 ],
337341648}
VectorStruct14 of 14 keywords
12549127{
22549127 "anyOf": [
31838838 {
4183882 "items": {
5591400 "format": "float",
6591400 "type": "number"
7183882 },
81920756 "type": "array"
91838838 },
101716960 {
111716204 "items": {
123886 "items": {
1318027 "format": "float",
1418027 "type": "number"
153886 },
16394597 "type": "array"
171716204 },
181920756 "type": "array"
191716960 },
202502426 {
21221502 "additionalProperties": {
227341648 "$ref": "#/components/schemas/Vector"
23221502 },
247521924 "type": "object"
252502426 },
262192457 {
272192457 "$ref": "#/components/schemas/Document"
282192457 },
29902586 {
30902586 "$ref": "#/components/schemas/Image"
31902586 },
32812595 {
33812595 "$ref": "#/components/schemas/InferenceObject"
34812595 }
352549127 ],
362549127}
Responses3 of 3 documented received
codedescriptionhitsavg
200successful operation1010ms
4XXerror20430ms
defaulterror1600ms
Examples15 / 15 used
Body: application/json
42ExtendedPointId
"550e8400-e29b-41d4-a716-446655440000"ExtendedPointId
[ 0.875, 0.140625, 0.897599995136261 ]VectorStruct
[ [ 0.875, 0.140625, 0.11020000278949738 ], [ 0.7580000162124634, 0.28126001358032227, 0.9687100052833557 ], [ 0.6209999918937683, 0.42187801003456116, 0.9375 ] ]VectorStruct
"jinaai/jina-embeddings-v2-base-en"Document.model
256Bm25Config.avg_len
0.75Bm25Config.b
1.2Bm25Config.k
"This is a document text"Document.text
"https://example.com/image.jpg"Image.image
"Qdrant/clip-ViT-B-32-vision"Image.model
"jinaai/jina-embeddings-v2-base-en"InferenceObject.model
{ "image-embeddings": [ 0.8730000257492065, 0.140625, 0.897599995136261 ] }VectorStruct
"region_1"ShardKey
12ShardKey
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
11849n/a{
21849n/a "type": "string"
31849n/a}
Query Parameters5 of 5 keywords covered
wait1 / 1
1161920{
2161920 "type": "boolean"
3161920}
ordering2 / 2
WriteOrdering
1161824{
2161824 "enum": [
31605n/a "weak",
43n/a "medium",
510n/a "strong"
6161824 ],
71642n/a "type": "string"
8161824}
timeout2 / 2
1161826{
2161815 "minimum": 1,
3163311 "type": "integer"
4161826}
Body174 of 277 keywords covered
application/json174 / 277
DeleteVectors
1177435{
2177625 "properties": {
31611n/a "filter": {
41611n/a "anyOf": [
51506105 {
61506105 "$ref": "#/components/schemas/Filter"
71506105 },
81611n/a {
91611n/a "nullable": true
101611n/a }
111611n/a ],
121611n/a },
13173313 "points": {
1417249 "items": {
1525610 "$ref": "#/components/schemas/ExtendedPointId"
1617249 },
171746n/a "nullable": true,
1817424 "type": "array"
19173313 },
201610n/a "shard_key": {
211610n/a "anyOf": [
22251585 {
23251585 "$ref": "#/components/schemas/ShardKeySelector"
24251585 },
251610n/a {
261610n/a "nullable": true
271610n/a }
281610n/a ]
291610n/a },
30178712 "vector": {
3117895 "items": {
3222705 "type": "string"
3317895 },
3417931 "minItems": 1,
3517945 "type": "array",
3617931 "uniqueItems": true
37178712 }
38177625 },
3917995 "required": [
4017995 "vector"
4117995 ],
4218045 "type": "object"
43177435}
Referenced Components (37)199 of 333 keywords
AnyVariants3 of 9 keywords
1840{
2840 "anyOf": [
32856 {
42856 "items": {
51456 "type": "string"
62856 },
7840 "type": "array",
8840 "uniqueItems": true
92856 },
107014 {
117014 "items": {
125614 "format": "int64",
135614 "type": "integer"
147014 },
15840 "type": "array",
16840 "uniqueItems": true
177014 }
18840 ]
19840}
Condition10 of 10 keywords
115325241{
215325241 "anyOf": [
38755898 {
48755898 "$ref": "#/components/schemas/FieldCondition"
58755898 },
676766 {
776766 "$ref": "#/components/schemas/IsEmptyCondition"
876766 },
976766 {
1076766 "$ref": "#/components/schemas/IsNullCondition"
1176766 },
12596714 {
13596714 "$ref": "#/components/schemas/HasIdCondition"
14596714 },
1576766 {
1676766 "$ref": "#/components/schemas/HasVectorCondition"
1776766 },
18216752 {
19216752 "$ref": "#/components/schemas/SliceCondition"
20216752 },
212576516 {
222576516 "$ref": "#/components/schemas/NestedCondition"
232576516 },
242996474 {
252996474 "$ref": "#/components/schemas/Filter"
262996474 }
2715325241 ]
2815325241}
DatetimeRange11 of 15 keywords
1133651{
212628 "properties": {
31057 "gt": {
4490 "format": "date-time",
5112n/a "nullable": true,
61057 "type": "string"
71057 },
81057 "gte": {
9490 "format": "date-time",
10112n/a "nullable": true,
111057 "type": "string"
121057 },
13917 "lt": {
14420 "format": "date-time",
1598n/a "nullable": true,
16917 "type": "string"
17917 },
18777 "lte": {
19350 "format": "date-time",
2084n/a "nullable": true,
21777 "type": "string"
22777 }
2312628 },
24161623 "type": "object"
25133651}
ExtendedPointId6 of 7 keywords
130810{
230810 "anyOf": [
3115203 {
400 "format": "uint64",
51161 "minimum": 0,
6116202 "type": "integer"
7115203 },
8193125 {
91932 "format": "uuid",
10195123 "type": "string"
11193125 }
1230810 ],
1330810}
FieldCondition33 of 34 keywords
18755898{
287514 "properties": {
3819n/a "geo_bounding_box": {
4819n/a "anyOf": [
57812 {
67812 "$ref": "#/components/schemas/GeoBoundingBox"
77812 },
8819n/a {
9819n/a "nullable": true
10819n/a }
11819n/a ],
12819n/a },
13819n/a "geo_polygon": {
14819n/a "anyOf": [
1542777 {
1642777 "$ref": "#/components/schemas/GeoPolygon"
1742777 },
18819n/a {
19819n/a "nullable": true
20819n/a }
21819n/a ],
22819n/a },
23812n/a "geo_radius": {
24812n/a "anyOf": [
257805 {
267805 "$ref": "#/components/schemas/GeoRadius"
277805 },
28812n/a {
29812n/a "nullable": true
30812n/a }
31812n/a ],
32812n/a },
338057 "is_empty": {
34812n/a "nullable": true,
358057 "type": "boolean"
368057 },
377987 "is_null": {
38805n/a "nullable": true,
397987 "type": "boolean"
407987 },
418750 "key": {
428750 "type": "string"
438750 },
44791n/a "match": {
45791n/a "anyOf": [
46168623 {
47168623 "$ref": "#/components/schemas/Match"
48168623 },
49791n/a {
50791n/a "nullable": true
51791n/a }
52791n/a ],
53791n/a },
54784n/a "range": {
55784n/a "anyOf": [
56133651 {
57133651 "$ref": "#/components/schemas/RangeInterface"
58133651 },
59784n/a {
60784n/a "nullable": true
61784n/a }
62784n/a ],
63784n/a },
64777n/a "values_count": {
65777n/a "anyOf": [
66112665 {
67112665 "$ref": "#/components/schemas/ValuesCount"
68112665 },
69777n/a {
70777n/a "nullable": true
71777n/a }
72777n/a ],
73777n/a }
7487514 },
75875657 "required": [
76875657 "key"
77875657 ],
7815325241 "type": "object"
798755898}
Filter25 of 25 keywords
120626579{
2n/a1233 "additionalProperties": false,
32005n/a "properties": {
41960n/a "min_should": {
51960n/a "anyOf": [
62381722 {
72381722 "$ref": "#/components/schemas/MinShould"
82381722 },
91960n/a {
101960n/a "nullable": true
111960n/a }
121960n/a ],
131960n/a },
141960n/a "must": {
151960n/a "anyOf": [
162281732 {
172281732 "$ref": "#/components/schemas/Condition"
182281732 },
192271733 {
2022715 "items": {
2121230 "$ref": "#/components/schemas/Condition"
2222715 },
232421718 "type": "array"
242271733 },
251960n/a {
261960n/a "nullable": true
271960n/a }
281960n/a ],
291960n/a },
301945n/a "must_not": {
311945n/a "anyOf": [
322281717 {
332281717 "$ref": "#/components/schemas/Condition"
342281717 },
352271718 {
3622715 "items": {
3721230 "$ref": "#/components/schemas/Condition"
3822715 },
392421703 "type": "array"
402271718 },
411945n/a {
421945n/a "nullable": true
431945n/a }
441945n/a ],
451945n/a },
461930n/a "should": {
471930n/a "anyOf": [
482281702 {
492281702 "$ref": "#/components/schemas/Condition"
502281702 },
512271703 {
5222715 "items": {
5321230 "$ref": "#/components/schemas/Condition"
5422715 },
552421688 "type": "array"
562271703 },
571930n/a {
581930n/a "nullable": true
591930n/a }
601930n/a ],
611930n/a }
622005n/a },
6332955346 "type": "object"
6420626579}
GeoBoundingBox3 of 7 keywords
17812{
270 "properties": {
370 "bottom_right": {
470 "$ref": "#/components/schemas/GeoPoint"
570 },
670 "top_left": {
770 "$ref": "#/components/schemas/GeoPoint"
870 }
970 },
1077 "required": [
1177 "bottom_right",
1277 "top_left"
1377 ],
1414805 "type": "object"
157812}
GeoLineString0 of 7 keywords
1560{
2560 "properties": {
3560 "points": {
4560 "items": {
5140 "$ref": "#/components/schemas/GeoPoint"
6560 },
7560 "type": "array"
8560 }
9560 },
10560 "required": [
11560 "points"
12560 ],
13560 "type": "object"
14560}
GeoPoint0 of 9 keywords
1350{
2350 "properties": {
3350 "lat": {
4350 "format": "double",
5350 "type": "number"
6350 },
7350 "lon": {
8350 "format": "double",
9350 "type": "number"
10350 }
11350 },
12350 "required": [
13350 "lat",
14350 "lon"
15350 ],
16350 "type": "object"
17350}
GeoPolygon4 of 9 keywords
142777{
2420 "properties": {
3420 "exterior": {
4420 "$ref": "#/components/schemas/GeoLineString"
5420 },
6350 "interiors": {
7280 "items": {
8140 "$ref": "#/components/schemas/GeoLineString"
9280 },
1035n/a "nullable": true,
11350 "type": "array"
12350 }
13420 },
14427 "required": [
15427 "exterior"
16427 ],
1749770 "type": "object"
1842777}
GeoRadius3 of 8 keywords
17805{
270 "properties": {
370 "center": {
470 "$ref": "#/components/schemas/GeoPoint"
570 },
670 "radius": {
770 "format": "double",
870 "type": "number"
970 }
1070 },
1177 "required": [
1277 "center",
1377 "radius"
1477 ],
1514798 "type": "object"
167805}
HasIdCondition3 of 8 keywords
1596714{
2590 "properties": {
3590 "has_id": {
4590 "items": {
5520 "$ref": "#/components/schemas/ExtendedPointId"
6590 },
7590 "type": "array",
8590 "uniqueItems": true
9590 }
10590 },
11591473 "required": [
12591473 "has_id"
13591473 ],
1415325241 "type": "object"
15596714}
HasVectorCondition3 of 6 keywords
176766{
270 "properties": {
370 "has_vector": {
470 "type": "string"
570 }
670 },
771525 "required": [
871525 "has_vector"
971525 ],
1015325241 "type": "object"
1176766}
IsEmptyCondition6 of 6 keywords
176766{
27805 "properties": {
37805 "is_empty": {
47805 "$ref": "#/components/schemas/PayloadField"
57805 }
67805 },
7812720 "required": [
8812720 "is_empty"
9812720 ],
1015325241 "type": "object"
1176766}
IsNullCondition6 of 6 keywords
176766{
27798 "properties": {
37798 "is_null": {
47798 "$ref": "#/components/schemas/PayloadField"
57798 }
67798 },
7805727 "required": [
8805727 "is_null"
9805727 ],
1015325241 "type": "object"
1176766}
Match10 of 10 keywords
1168623{
2168623 "anyOf": [
349742 {
449742 "$ref": "#/components/schemas/MatchValue"
549742 },
67784 {
77784 "$ref": "#/components/schemas/MatchText"
87784 },
97784 {
107784 "$ref": "#/components/schemas/MatchTextAny"
117784 },
127784 {
137784 "$ref": "#/components/schemas/MatchPhrase"
147784 },
157784 {
167784 "$ref": "#/components/schemas/MatchPrefix"
177784 },
187784 {
197784 "$ref": "#/components/schemas/MatchSubstring"
207784 },
2142749 {
2242749 "$ref": "#/components/schemas/MatchAny"
2342749 },
2442749 {
2542749 "$ref": "#/components/schemas/MatchExcept"
2642749 }
27168623 ],
28168623}
MatchAny3 of 6 keywords
142749{
2420 "properties": {
3420 "any": {
4420 "$ref": "#/components/schemas/AnyVariants"
5420 }
6420 },
742133 "required": [
842133 "any"
942133 ],
10175616 "type": "object"
1142749}
MatchExcept3 of 6 keywords
142749{
2420 "properties": {
3420 "except": {
4420 "$ref": "#/components/schemas/AnyVariants"
5420 }
6420 },
742133 "required": [
842133 "except"
942133 ],
10175616 "type": "object"
1142749}
MatchPhrase3 of 6 keywords
17784{
270 "properties": {
370 "phrase": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "phrase"
97168 ],
10175616 "type": "object"
117784}
MatchPrefix3 of 6 keywords
17784{
270 "properties": {
370 "prefix": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "prefix"
97168 ],
10175616 "type": "object"
117784}
MatchSubstring3 of 6 keywords
17784{
270 "properties": {
370 "substring": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "substring"
97168 ],
10175616 "type": "object"
117784}
MatchText3 of 6 keywords
17784{
270 "properties": {
370 "text": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "text"
97168 ],
10175616 "type": "object"
117784}
MatchTextAny3 of 6 keywords
17784{
270 "properties": {
370 "text_any": {
470 "type": "string"
570 }
670 },
77168 "required": [
87168 "text_any"
97168 ],
10175616 "type": "object"
117784}
MatchValue3 of 6 keywords
149742{
2490 "properties": {
3490 "value": {
4490 "$ref": "#/components/schemas/ValueVariants"
5490 }
6490 },
749126 "required": [
849126 "value"
949126 ],
10175616 "type": "object"
1149742}
MinShould3 of 10 keywords
12381722{
22380 "properties": {
32380 "conditions": {
42380 "items": {
52120 "$ref": "#/components/schemas/Condition"
62380 },
72380 "type": "array"
82380 },
92380 "min_count": {
1000 "format": "uint",
112380 "minimum": 1,
122380 "type": "integer"
132380 }
142380 },
1523815 "required": [
1623815 "conditions",
1723815 "min_count"
1823815 ],
192531707 "type": "object"
202381722}
Nested0 of 7 keywords
12570{
22570 "properties": {
32570 "filter": {
42570 "$ref": "#/components/schemas/Filter"
52570 },
62570 "key": {
72570 "type": "string"
82570 }
92570 },
102570 "required": [
112570 "filter",
122570 "key"
132570 ],
142570 "type": "object"
152570}
NestedCondition3 of 6 keywords
12576516{
22570 "properties": {
32570 "nested": {
42570 "$ref": "#/components/schemas/Nested"
52570 }
62570 },
72571275 "required": [
82571275 "nested"
92571275 ],
1015325241 "type": "object"
112576516}
PayloadField1 of 6 keywords
1141603{
2140 "properties": {
3140 "key": {
4140 "type": "string"
5140 }
6140 },
7140 "required": [
8140 "key"
9140 ],
10141603 "type": "object"
11141603}
Range13 of 15 keywords
17777{
20154 "properties": {
37105 "gt": {
47105 "format": "double",
5112n/a "nullable": true,
66349 "type": "number"
77105 },
87105 "gte": {
97105 "format": "double",
10112n/a "nullable": true,
116349 "type": "number"
127105 },
13791 "lt": {
14791 "format": "double",
1598n/a "nullable": true,
165642 "type": "number"
17791 },
18777 "lte": {
19777 "format": "double",
2084n/a "nullable": true,
214935 "type": "number"
22777 }
230154 },
24161623 "type": "object"
257777}
RangeInterface4 of 4 keywords
1133651{
2133651 "anyOf": [
37777 {
47777 "$ref": "#/components/schemas/Range"
57777 },
6133651 {
7133651 "$ref": "#/components/schemas/DatetimeRange"
8133651 }
9133651 ]
10133651}
ShardKey4 of 6 keywords
1351605{
2351605 "anyOf": [
3191621 {
4191621 "type": "string"
5191621 },
6161624 {
700 "format": "uint64",
8160 "minimum": 0,
9161624 "type": "integer"
10161624 }
11351605 ]
12351605}
ShardKeySelector6 of 6 keywords
1251585{
2251585 "anyOf": [
371603 {
471603 "$ref": "#/components/schemas/ShardKey"
571603 },
671603 {
771 "items": {
862 "$ref": "#/components/schemas/ShardKey"
971 },
1081602 "type": "array"
1171603 },
12111599 {
13111599 "$ref": "#/components/schemas/ShardKeyWithFallback"
14111599 }
15251585 ]
16251585}
ShardKeyWithFallback3 of 7 keywords
1111599{
2110 "properties": {
3110 "fallback": {
4110 "$ref": "#/components/schemas/ShardKey"
5110 },
6110 "target": {
7110 "$ref": "#/components/schemas/ShardKey"
8110 }
9110 },
10111 "required": [
11111 "fallback",
12111 "target"
13111 ],
14121598 "type": "object"
15111599}
Slice0 of 11 keywords
1210{
2210 "properties": {
3210 "index": {
400 "format": "uint32",
5210 "minimum": 0,
6210 "type": "integer"
7210 },
8210 "total": {
900 "format": "uint32",
10210 "minimum": 1,
11210 "type": "integer"
12210 }
13210 },
14210 "required": [
15210 "index",
16210 "total"
17210 ],
18210 "type": "object"
19210}
SliceCondition3 of 6 keywords
1216752{
2210 "properties": {
3210 "slice": {
4210 "$ref": "#/components/schemas/Slice"
5210 }
6210 },
7211511 "required": [
8211511 "slice"
9211511 ],
1015325241 "type": "object"
11216752}
ValueVariants4 of 6 keywords
1490{
2490 "anyOf": [
3742 {
4742 "type": "string"
5742 },
62821 {
72821 "format": "int64",
82821 "type": "integer"
92821 },
101435 {
111435 "type": "boolean"
121435 }
13490 ]
14490}
ValuesCount5 of 19 keywords
1112665{
21050 "properties": {
3840 "gt": {
400 "format": "uint",
5770 "minimum": 0,
684n/a "nullable": true,
7840 "type": "integer"
8840 },
9840 "gte": {
1000 "format": "uint",
11770 "minimum": 0,
1284n/a "nullable": true,
13840 "type": "integer"
14840 },
15770 "lt": {
1600 "format": "uint",
17700 "minimum": 0,
1877n/a "nullable": true,
19770 "type": "integer"
20770 },
21700 "lte": {
2200 "format": "uint",
23630 "minimum": 0,
2470n/a "nullable": true,
25700 "type": "integer"
26700 }
271050 },
28112665 "type": "object"
29112665}
Responses2 of 3 documented received
codedescriptionhitsavg
200successful operation1180ms
4XXerror17311ms
defaulterror0-
Examples4 / 4 used
Body: application/json
42ExtendedPointId
"550e8400-e29b-41d4-a716-446655440000"ExtendedPointId
"region_1"ShardKey
12ShardKey
Path Parameters6 of 7 keywords covered
collection_name1 / 1
#validinvalidschema
1293n/a{
2293n/a "type": "string"
3293n/a}
id5 / 6
ExtendedPointId
1282256{
2282256 "anyOf": [
3240298 {
400 "format": "uint64",
52405 "minimum": 0,
6245293 "type": "integer"
7240298 },
842496 {
942251 "format": "uuid",
10293n/a "type": "string"
1142496 }
12282256 ],
13282256}
Query Parameters8 of 9 keywords covered
consistency6 / 7
ReadConsistency
16494{
26494 "anyOf": [
348110 {
400 "format": "uint",
5486 "minimum": 1,
654104 "type": "integer"
748110 },
816142 {
916142 "$ref": "#/components/schemas/ReadConsistencyType"
1016142 }
116494 ],
126494}
Referenced Components (1)3 of 3 keywords
ReadConsistencyType3 of 3 keywords
116142{
216142 "enum": [
36n/a "majority",
45n/a "quorum",
55n/a "all"
616142 ],
7104n/a "type": "string"
816142}
timeout2 / 2
15937{
2598 "minimum": 1,
36729 "type": "integer"
45937}
Responses1 of 3 documented received
codedescriptionhitsavg
200successful operation0never seen
4XXerror2930ms
defaulterror0-
Examples2 / 2 used
Path
42id
"550e8400-e29b-41d4-a716-446655440000"id
Quotas 2 operations 1 covered 1 partial 0 uncovered 0 not measured 84% #
Responses1 of 3 documented received
codedescriptionhitsavg
200successful operation51ms
4XXerror0never seen
defaulterror0-
Query Parameters1 of 1 keywords covered
wait1 / 1
#validinvalidschema
121918{
221918 "type": "boolean"
321918}
Body15 of 18 keywords covered
application/json15 / 18
QuotaConfig
128852{
215942 "properties": {
31698 "enabled": {
41698 "type": "boolean"
51698 },
615912 "max_disk_usage_percent": {
700 "format": "uint8",
8761 "maximum": 100,
9707 "minimum": 1,
10171n/a "nullable": true,
111638 "type": "integer"
1215912 },
1312110 "max_resident_memory_percent": {
1400 "format": "uint8",
151071 "maximum": 100,
161062 "minimum": 1,
17131n/a "nullable": true,
181238 "type": "integer"
1912110 },
2011018 "release_margin_percent": {
2100 "format": "uint8",
22732 "maximum": 100,
23741 "minimum": 0,
24128n/a "nullable": true,
2511216 "type": "integer"
2611018 }
2715942 },
2833010 "type": "object"
2928852}
Responses2 of 3 documented received
codedescriptionhitsavg
200successful operation27510ms
4XXerror850ms
defaulterror0-
Examples2 / 2 used
Body: application/json
falseQuotaConfig.enabled
Query
falsewait
Service 6 operations 6 covered 0 partial 0 uncovered 0 not measured 100% #
Responses1 of 2 documented received
codedescriptionhitsavg
200Qdrant server version information50ms
4XXerror0never seen
Responses1 of 2 documented received
codedescriptionhitsavg
200Healthz response50ms
4XXerror0never seen
Responses1 of 2 documented received
codedescriptionhitsavg
200Healthz response50ms
4XXerror0never seen
Query Parameters4 of 4 keywords covered
anonymize1 / 1
#validinvalidschema
117974{
217974 "type": "boolean"
317974}
per_collection1 / 1
162209{
262209 "type": "boolean"
362209}
timeout2 / 2
163201{
26334 "minimum": 1,
397167 "type": "integer"
463201}
Responses2 of 2 documented received
codedescriptionhitsavg
200Metrics data in Prometheus format843ms
4XXerror2580ms
Examples1 / 1 used
Query
60timeout
Responses1 of 3 documented received
codedescriptionhitsavg
200The instance is ready to accept traffic50ms
503The instance is not ready to accept traffic yet0never seen
4XXerror0never seen
Query Parameters6 of 6 keywords covered
anonymize1 / 1
#validinvalidschema
19392{
29392 "type": "boolean"
39392}
details_level2 / 2
185116{
28538 "minimum": 0,
312378 "type": "integer"
485116}
per_collection1 / 1
190115{
290115 "type": "boolean"
390115}
timeout2 / 2
184142{
28435 "minimum": 1,
3119107 "type": "integer"
484142}
Responses2 of 3 documented received
codedescriptionhitsavg
200successful operation981ms
4XXerror2590ms
defaulterror0-
Examples1 / 1 used
Query
60timeout
Snapshots 17 operations 17 covered 0 partial 0 uncovered 0 not measured 100% #
Path Parameters2 of 2 keywords covered
collection_name1 / 1
#validinvalidschema
1226n/a{
2226n/a "type": "string"
3226n/a}
shard_id1 / 1
120818{
220818 "type": "integer"
320818}
Responses1 of 3 documented received
codedescriptionhitsavg
200Snapshot file0never seen
4XXerror2260ms
defaulterror0-
Path Parameters2 of 2 keywords covered
collection_name1 / 1
#validinvalidschema
1239n/a{
2239n/a "type": "string"
3239n/a}
shard_id1 / 1
121920{
221920 "type": "integer"
321920}
Responses1 of 3 documented received
codedescriptionhitsavg
200successful operation0never seen
4XXerror2390ms
defaulterror0-
Path Parameters2 of 2 keywords covered
collection_name1 / 1
#validinvalidschema
1792n/a{
2792n/a "type": "string"
3792n/a}
shard_id1 / 1
173062{
273062 "type": "integer"
373062}
Query Parameters1 of 1 keywords covered
wait1 / 1
139035{
239035 "type": "boolean"
339035}
Responses2 of 4 documented received
codedescriptionhitsavg
200successful operation0never seen
202operation is accepted2290ms
4XXerror5631ms
defaulterror0-
Path Parameters2 of 2 keywords covered
collection_name1 / 1
#validinvalidschema
1270n/a{
2270n/a "type": "string"
3270n/a}
shard_id1 / 1
125812{
225812 "type": "integer"
325812}
Query Parameters1 of 1 keywords covered
wait1 / 1
116535{
216535 "type": "boolean"
316535}
Body17 of 17 keywords covered
application/json17 / 17
ShardSnapshotRecover
119242{
219826 "properties": {
3866 "api_key": {
492n/a "nullable": true,
5866 "type": "string"
6866 },
7818 "checksum": {
889n/a "nullable": true,
9818 "type": "string"
10818 },
1120612 "location": {
1220612 "$ref": "#/components/schemas/ShardSnapshotLocation"
1320612 },
1439n/a "priority": {
1539n/a "anyOf": [
16336 {
17336 "$ref": "#/components/schemas/SnapshotPriority"
18336 },
1939n/a {
2039n/a "nullable": true
2139n/a }
2239n/a ],
2339n/a }
2419826 },
252186 "required": [
262186 "location"
272186 ],
2822410 "type": "object"
2919242}
Referenced Components (2)8 of 8 keywords
ShardSnapshotLocation5 of 5 keywords
120612{
220612 "anyOf": [
31217 {
41205 "format": "uri",
520612 "type": "string"
61217 },
720612 {
820612 "type": "string"
920612 }
1020612 ]
1120612}
SnapshotPriority3 of 3 keywords
1336{
2336 "enum": [
31n/a "no_sync",
41n/a "snapshot",
51n/a "replica"
6336 ],
7435 "type": "string"
8336}
Responses2 of 4 documented received
codedescriptionhitsavg
200successful operation0never seen
202operation is accepted980ms
4XXerror1720ms
defaulterror0-
Examples3 / 3 used
Body: application/json
nullShardSnapshotRecover.api_key
nullShardSnapshotRecover.checksum
nullShardSnapshotRecover.priority
Path Parameters2 of 2 keywords covered
collection_name1 / 1
#validinvalidschema
1264n/a{
2264n/a "type": "string"
3264n/a}
shard_id1 / 1
125311{
225311 "type": "integer"
325311}
Query Parameters4 of 4 keywords covered
wait1 / 1
115327{
215327 "type": "boolean"
315327}
priority2 / 2
SnapshotPriority
115521{
215521 "enum": [
3131n/a "no_sync",
411n/a "snapshot",
513n/a "replica"
615521 ],
7176n/a "type": "string"
815521}
checksum1 / 1
1177n/a{
2177n/a "type": "string"
3177n/a}
Body4 of 4 keywords covered
multipart/form-data4 / 4
1212n/a{
2159n/a "properties": {
3159n/a "snapshot": {
4159n/a "format": "binary",
5159n/a "type": "string"
6159n/a }
7159n/a },
8212n/a "type": "object"
9212n/a}
Responses2 of 4 documented received
codedescriptionhitsavg
200successful operation0never seen
202operation is accepted980ms
4XXerror1660ms
defaulterror0-
Path Parameters3 of 3 keywords covered
collection_name1 / 1
#validinvalidschema
1438n/a{
2438n/a "type": "string"
3438n/a}
shard_id1 / 1
140335{
240335 "type": "integer"
340335}
snapshot_name1 / 1
1438n/a{
2438n/a "type": "string"
3438n/a}
Query Parameters1 of 1 keywords covered
wait1 / 1
120327{
220327 "type": "boolean"
320327}
Responses2 of 4 documented received
codedescriptionhitsavg
200successful operation0never seen
202operation is accepted1330ms
4XXerror3050ms
defaulterror0-
Path Parameters3 of 3 keywords covered
collection_name1 / 1
#validinvalidschema
1385n/a{
2385n/a "type": "string"
3385n/a}
shard_id1 / 1
135629{
235629 "type": "integer"
335629}
snapshot_name1 / 1
1385n/a{
2385n/a "type": "string"
3385n/a}
Responses1 of 3 documented received
codedescriptionhitsavg
200Snapshot file0never seen
4XXerror3850ms
defaulterror0-
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
1242n/a{
2242n/a "type": "string"
3242n/a}
Responses2 of 3 documented received
codedescriptionhitsavg
200successful operation2171ms
4XXerror250ms
defaulterror0-
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
1696n/a{
2696n/a "type": "string"
3696n/a}
Query Parameters1 of 1 keywords covered
wait1 / 1
1260159{
2260159 "type": "boolean"
3260159}
Responses3 of 4 documented received
codedescriptionhitsavg
200successful operation112164ms
202operation is accepted1560ms
4XXerror4280ms
defaulterror0-
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
1257n/a{
2257n/a "type": "string"
3257n/a}
Query Parameters1 of 1 keywords covered
wait1 / 1
113216{
213216 "type": "boolean"
313216}
Body14 of 14 keywords covered
application/json14 / 14
SnapshotRecover
118245{
218733 "properties": {
31075 "api_key": {
4112n/a "nullable": true,
51075 "type": "string"
61075 },
77223 "checksum": {
895n/a "nullable": true,
97223 "type": "string"
107223 },
112096 "location": {
122091 "format": "uri",
132105 "type": "string"
142096 },
1544n/a "priority": {
1644n/a "anyOf": [
17341 {
18341 "$ref": "#/components/schemas/SnapshotPriority"
19341 },
2044n/a {
2144n/a "nullable": true
2244n/a }
2344n/a ],
2444n/a }
2518733 },
262157 "required": [
272157 "location"
282157 ],
292225 "type": "object"
3018245}
Referenced Components (1)3 of 3 keywords
SnapshotPriority3 of 3 keywords
1341{
2341 "enum": [
31n/a "no_sync",
41n/a "snapshot",
51n/a "replica"
6341 ],
7539 "type": "string"
8341}
Responses3 of 4 documented received
codedescriptionhitsavg
200successful operation0never seen
202operation is accepted760ms
4XXerror960ms
defaulterror85102ms
Examples3 / 3 used
Body: application/json
nullSnapshotRecover.api_key
nullSnapshotRecover.checksum
nullSnapshotRecover.priority
Path Parameters1 of 1 keywords covered
collection_name1 / 1
#validinvalidschema
1255n/a{
2255n/a "type": "string"
3255n/a}
Query Parameters4 of 4 keywords covered
wait1 / 1
17241{
27241 "type": "boolean"
37241}
priority2 / 2
SnapshotPriority
110317{
210317 "enum": [
359n/a "no_sync",
421n/a "snapshot",
523n/a "replica"
610317 ],
7120n/a "type": "string"
810317}
checksum1 / 1
1113n/a{
2113n/a "type": "string"
3113n/a}
Body4 of 4 keywords covered
multipart/form-data4 / 4
1158n/a{
282n/a "properties": {
382n/a "snapshot": {
482n/a "format": "binary",
582n/a "type": "string"
682n/a }
782n/a },
8158n/a "type": "object"
9158n/a}
Responses3 of 4 documented received
codedescriptionhitsavg
200successful operation0never seen
202operation is accepted260ms
4XXerror2140ms
defaulterror155ms
Path Parameters2 of 2 keywords covered
collection_name1 / 1
#validinvalidschema
1372n/a{
2372n/a "type": "string"
3372n/a}
snapshot_name1 / 1
1372n/a{
2372n/a "type": "string"
3372n/a}
Query Parameters1 of 1 keywords covered
wait1 / 1
1123137{
2123137 "type": "boolean"
3123137}
Responses2 of 4 documented received
codedescriptionhitsavg
200successful operation0never seen
202operation is accepted740ms
4XXerror2980ms
defaulterror0-
Path Parameters2 of 2 keywords covered
collection_name1 / 1
#validinvalidschema
1421n/a{
2421n/a "type": "string"
3421n/a}
snapshot_name1 / 1
1421n/a{
2421n/a "type": "string"
3421n/a}
Responses1 of 3 documented received
codedescriptionhitsavg
200Snapshot file0never seen
4XXerror4210ms
defaulterror0-
Responses1 of 3 documented received
codedescriptionhitsavg
200successful operation4571ms
4XXerror0never seen
defaulterror0-
Query Parameters1 of 1 keywords covered
wait1 / 1
#validinvalidschema
1269318{
2269318 "type": "boolean"
3269318}
Responses4 of 4 documented received
codedescriptionhitsavg
200successful operation44591ms
202operation is accepted1140ms
4XXerror3180ms
defaulterror10ms
Path Parameters1 of 1 keywords covered
snapshot_name1 / 1
#validinvalidschema
1208n/a{
2208n/a "type": "string"
3208n/a}
Query Parameters1 of 1 keywords covered
wait1 / 1
130132{
230132 "type": "boolean"
330132}
Responses2 of 4 documented received
codedescriptionhitsavg
200successful operation0never seen
202operation is accepted80ms
4XXerror2000ms
defaulterror0-
Path Parameters1 of 1 keywords covered
snapshot_name1 / 1
#validinvalidschema
1202n/a{
2202n/a "type": "string"
3202n/a}
Responses1 of 3 documented received
codedescriptionhitsavg
200Snapshot file0never seen
4XXerror2020ms
defaulterror0-
237 unmatched requests Not counted in coverage above
MethodHostPathReasonCount
DELETE0.0.0.0:42203/method not documented1
DELETE0.0.0.0:42203/aliasesmethod not documented1
DELETE0.0.0.0:42203/clustermethod not documented1
DELETE0.0.0.0:42203/cluster/recovermethod not documented1
DELETE0.0.0.0:42203/cluster/telemetrymethod not documented1
DELETE0.0.0.0:42203/collectionsmethod not documented1
DELETE0.0.0.0:42203/collections/{collection_name}/aliasesmethod not documented1
DELETE0.0.0.0:42203/collections/{collection_name}/clustermethod not documented1
DELETE0.0.0.0:42203/collections/{collection_name}/existsmethod not documented1
DELETE0.0.0.0:42203/collections/{collection_name}/facetmethod not documented1

... and 227 more groups